ESP8266
sio.h
1 /*
2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
25  * OF SUCH DAMAGE.
26  *
27  * This file is part of the lwIP TCP/IP stack.
28  */
29 
30 /*
31  * This is the interface to the platform specific serial IO module
32  * It needs to be implemented by those platforms which need SLIP or PPP
33  */
34 
35 #ifndef __SIO_H__
36 #define __SIO_H__
37 
38 #include "lwip/arch.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /* If you want to define sio_fd_t elsewhere or differently,
45  define this in your cc.h file. */
46 #ifndef __sio_fd_t_defined
47 typedef void * sio_fd_t;
48 #endif
49 
50 /* The following functions can be defined to something else in your cc.h file
51  or be implemented in your custom sio.c file. */
52 
53 #ifndef sio_open
54 
60 sio_fd_t sio_open(u8_t devnum)ICACHE_FLASH_ATTR;
61 #endif
62 
63 #ifndef sio_send
64 
72 void sio_send(u8_t c, sio_fd_t fd)ICACHE_FLASH_ATTR;
73 #endif
74 
75 #ifndef sio_recv
76 
83 u8_t sio_recv(sio_fd_t fd)ICACHE_FLASH_ATTR;
84 #endif
85 
86 #ifndef sio_read
87 
98 u32_t sio_read(sio_fd_t fd, u8_t *data, u32_t len)ICACHE_FLASH_ATTR;
99 #endif
100 
101 #ifndef sio_tryread
102 
111 u32_t sio_tryread(sio_fd_t fd, u8_t *data, u32_t len)ICACHE_FLASH_ATTR;
112 #endif
113 
114 #ifndef sio_write
115 
125 u32_t sio_write(sio_fd_t fd, u8_t *data, u32_t len)ICACHE_FLASH_ATTR;
126 #endif
127 
128 #ifndef sio_read_abort
129 
134 void sio_read_abort(sio_fd_t fd)ICACHE_FLASH_ATTR;
135 #endif
136 
137 #ifdef __cplusplus
138 }
139 #endif
140 
141 #endif /* __SIO_H__ */