CK Sin / Mbed 2 deprecated Ethernetwebsocket

Ethernetwebsoc

Dependencies:   C12832_lcd LM75B WebSocketClient mbed-rtos mbed Socket lwip-eth lwip-sys lwip

EthernetInterface/lwip/include/lwip/sio.h@0:0ed2a7c7190c, 2013-05-31 (annotated)

Committer:
GordonSin
Date:
Fri May 31 04:09:54 2013 +0000
Revision:
0:0ed2a7c7190c
31/5/2013;

Who changed what in which revision?

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