Donatien Garnier
ZG2100 Network interface source
lwip/include/lwip/sio.h@0:b802fc31f1db, 2010-07-09 (annotated)
- Committer:
- donatien
- Date:
- Fri Jul 09 15:37:23 2010 +0000
- Revision:
- 0:b802fc31f1db
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:b802fc31f1db | 1 | /* |
| donatien | 0:b802fc31f1db | 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
| donatien | 0:b802fc31f1db | 3 | * All rights reserved. |
| donatien | 0:b802fc31f1db | 4 | * |
| donatien | 0:b802fc31f1db | 5 | * Redistribution and use in source and binary forms, with or without modification, |
| donatien | 0:b802fc31f1db | 6 | * are permitted provided that the following conditions are met: |
| donatien | 0:b802fc31f1db | 7 | * |
| donatien | 0:b802fc31f1db | 8 | * 1. Redistributions of source code must retain the above copyright notice, |
| donatien | 0:b802fc31f1db | 9 | * this list of conditions and the following disclaimer. |
| donatien | 0:b802fc31f1db | 10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| donatien | 0:b802fc31f1db | 11 | * this list of conditions and the following disclaimer in the documentation |
| donatien | 0:b802fc31f1db | 12 | * and/or other materials provided with the distribution. |
| donatien | 0:b802fc31f1db | 13 | * 3. The name of the author may not be used to endorse or promote products |
| donatien | 0:b802fc31f1db | 14 | * derived from this software without specific prior written permission. |
| donatien | 0:b802fc31f1db | 15 | * |
| donatien | 0:b802fc31f1db | 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| donatien | 0:b802fc31f1db | 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| donatien | 0:b802fc31f1db | 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| donatien | 0:b802fc31f1db | 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| donatien | 0:b802fc31f1db | 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| donatien | 0:b802fc31f1db | 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| donatien | 0:b802fc31f1db | 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| donatien | 0:b802fc31f1db | 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| donatien | 0:b802fc31f1db | 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| donatien | 0:b802fc31f1db | 25 | * OF SUCH DAMAGE. |
| donatien | 0:b802fc31f1db | 26 | * |
| donatien | 0:b802fc31f1db | 27 | * This file is part of the lwIP TCP/IP stack. |
| donatien | 0:b802fc31f1db | 28 | */ |
| donatien | 0:b802fc31f1db | 29 | |
| donatien | 0:b802fc31f1db | 30 | /* |
| donatien | 0:b802fc31f1db | 31 | * This is the interface to the platform specific serial IO module |
| donatien | 0:b802fc31f1db | 32 | * It needs to be implemented by those platforms which need SLIP or PPP |
| donatien | 0:b802fc31f1db | 33 | */ |
| donatien | 0:b802fc31f1db | 34 | |
| donatien | 0:b802fc31f1db | 35 | #ifndef __SIO_H__ |
| donatien | 0:b802fc31f1db | 36 | #define __SIO_H__ |
| donatien | 0:b802fc31f1db | 37 | |
| donatien | 0:b802fc31f1db | 38 | #include "lwip/arch.h" |
| donatien | 0:b802fc31f1db | 39 | |
| donatien | 0:b802fc31f1db | 40 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 41 | extern "C" { |
| donatien | 0:b802fc31f1db | 42 | #endif |
| donatien | 0:b802fc31f1db | 43 | |
| donatien | 0:b802fc31f1db | 44 | /* If you want to define sio_fd_t elsewhere or differently, |
| donatien | 0:b802fc31f1db | 45 | define this in your cc.h file. */ |
| donatien | 0:b802fc31f1db | 46 | #ifndef __sio_fd_t_defined |
| donatien | 0:b802fc31f1db | 47 | typedef void * sio_fd_t; |
| donatien | 0:b802fc31f1db | 48 | #endif |
| donatien | 0:b802fc31f1db | 49 | |
| donatien | 0:b802fc31f1db | 50 | /* The following functions can be defined to something else in your cc.h file |
| donatien | 0:b802fc31f1db | 51 | or be implemented in your custom sio.c file. */ |
| donatien | 0:b802fc31f1db | 52 | |
| donatien | 0:b802fc31f1db | 53 | #ifndef sio_open |
| donatien | 0:b802fc31f1db | 54 | /** |
| donatien | 0:b802fc31f1db | 55 | * Opens a serial device for communication. |
| donatien | 0:b802fc31f1db | 56 | * |
| donatien | 0:b802fc31f1db | 57 | * @param devnum device number |
| donatien | 0:b802fc31f1db | 58 | * @return handle to serial device if successful, NULL otherwise |
| donatien | 0:b802fc31f1db | 59 | */ |
| donatien | 0:b802fc31f1db | 60 | sio_fd_t sio_open(u8_t devnum); |
| donatien | 0:b802fc31f1db | 61 | #endif |
| donatien | 0:b802fc31f1db | 62 | |
| donatien | 0:b802fc31f1db | 63 | #ifndef sio_send |
| donatien | 0:b802fc31f1db | 64 | /** |
| donatien | 0:b802fc31f1db | 65 | * Sends a single character to the serial device. |
| donatien | 0:b802fc31f1db | 66 | * |
| donatien | 0:b802fc31f1db | 67 | * @param c character to send |
| donatien | 0:b802fc31f1db | 68 | * @param fd serial device handle |
| donatien | 0:b802fc31f1db | 69 | * |
| donatien | 0:b802fc31f1db | 70 | * @note This function will block until the character can be sent. |
| donatien | 0:b802fc31f1db | 71 | */ |
| donatien | 0:b802fc31f1db | 72 | void sio_send(u8_t c, sio_fd_t fd); |
| donatien | 0:b802fc31f1db | 73 | #endif |
| donatien | 0:b802fc31f1db | 74 | |
| donatien | 0:b802fc31f1db | 75 | #ifndef sio_recv |
| donatien | 0:b802fc31f1db | 76 | /** |
| donatien | 0:b802fc31f1db | 77 | * Receives a single character from the serial device. |
| donatien | 0:b802fc31f1db | 78 | * |
| donatien | 0:b802fc31f1db | 79 | * @param fd serial device handle |
| donatien | 0:b802fc31f1db | 80 | * |
| donatien | 0:b802fc31f1db | 81 | * @note This function will block until a character is received. |
| donatien | 0:b802fc31f1db | 82 | */ |
| donatien | 0:b802fc31f1db | 83 | u8_t sio_recv(sio_fd_t fd); |
| donatien | 0:b802fc31f1db | 84 | #endif |
| donatien | 0:b802fc31f1db | 85 | |
| donatien | 0:b802fc31f1db | 86 | #ifndef sio_read |
| donatien | 0:b802fc31f1db | 87 | /** |
| donatien | 0:b802fc31f1db | 88 | * Reads from the serial device. |
| donatien | 0:b802fc31f1db | 89 | * |
| donatien | 0:b802fc31f1db | 90 | * @param fd serial device handle |
| donatien | 0:b802fc31f1db | 91 | * @param data pointer to data buffer for receiving |
| donatien | 0:b802fc31f1db | 92 | * @param len maximum length (in bytes) of data to receive |
| donatien | 0:b802fc31f1db | 93 | * @return number of bytes actually received - may be 0 if aborted by sio_read_abort |
| donatien | 0:b802fc31f1db | 94 | * |
| donatien | 0:b802fc31f1db | 95 | * @note This function will block until data can be received. The blocking |
| donatien | 0:b802fc31f1db | 96 | * can be cancelled by calling sio_read_abort(). |
| donatien | 0:b802fc31f1db | 97 | */ |
| donatien | 0:b802fc31f1db | 98 | u32_t sio_read(sio_fd_t fd, u8_t *data, u32_t len); |
| donatien | 0:b802fc31f1db | 99 | #endif |
| donatien | 0:b802fc31f1db | 100 | |
| donatien | 0:b802fc31f1db | 101 | #ifndef sio_tryread |
| donatien | 0:b802fc31f1db | 102 | /** |
| donatien | 0:b802fc31f1db | 103 | * Tries to read from the serial device. Same as sio_read but returns |
| donatien | 0:b802fc31f1db | 104 | * immediately if no data is available and never blocks. |
| donatien | 0:b802fc31f1db | 105 | * |
| donatien | 0:b802fc31f1db | 106 | * @param fd serial device handle |
| donatien | 0:b802fc31f1db | 107 | * @param data pointer to data buffer for receiving |
| donatien | 0:b802fc31f1db | 108 | * @param len maximum length (in bytes) of data to receive |
| donatien | 0:b802fc31f1db | 109 | * @return number of bytes actually received |
| donatien | 0:b802fc31f1db | 110 | */ |
| donatien | 0:b802fc31f1db | 111 | u32_t sio_tryread(sio_fd_t fd, u8_t *data, u32_t len); |
| donatien | 0:b802fc31f1db | 112 | #endif |
| donatien | 0:b802fc31f1db | 113 | |
| donatien | 0:b802fc31f1db | 114 | #ifndef sio_write |
| donatien | 0:b802fc31f1db | 115 | /** |
| donatien | 0:b802fc31f1db | 116 | * Writes to the serial device. |
| donatien | 0:b802fc31f1db | 117 | * |
| donatien | 0:b802fc31f1db | 118 | * @param fd serial device handle |
| donatien | 0:b802fc31f1db | 119 | * @param data pointer to data to send |
| donatien | 0:b802fc31f1db | 120 | * @param len length (in bytes) of data to send |
| donatien | 0:b802fc31f1db | 121 | * @return number of bytes actually sent |
| donatien | 0:b802fc31f1db | 122 | * |
| donatien | 0:b802fc31f1db | 123 | * @note This function will block until all data can be sent. |
| donatien | 0:b802fc31f1db | 124 | */ |
| donatien | 0:b802fc31f1db | 125 | u32_t sio_write(sio_fd_t fd, u8_t *data, u32_t len); |
| donatien | 0:b802fc31f1db | 126 | #endif |
| donatien | 0:b802fc31f1db | 127 | |
| donatien | 0:b802fc31f1db | 128 | #ifndef sio_read_abort |
| donatien | 0:b802fc31f1db | 129 | /** |
| donatien | 0:b802fc31f1db | 130 | * Aborts a blocking sio_read() call. |
| donatien | 0:b802fc31f1db | 131 | * |
| donatien | 0:b802fc31f1db | 132 | * @param fd serial device handle |
| donatien | 0:b802fc31f1db | 133 | */ |
| donatien | 0:b802fc31f1db | 134 | void sio_read_abort(sio_fd_t fd); |
| donatien | 0:b802fc31f1db | 135 | #endif |
| donatien | 0:b802fc31f1db | 136 | |
| donatien | 0:b802fc31f1db | 137 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 138 | } |
| donatien | 0:b802fc31f1db | 139 | #endif |
| donatien | 0:b802fc31f1db | 140 | |
| donatien | 0:b802fc31f1db | 141 | #endif /* __SIO_H__ */ |