Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
drv/serial/lwip/sio.cpp@4:fd826cad83c0, 2010-07-09 (annotated)
- Committer:
 - donatien
 - Date:
 - Fri Jul 09 14:46:47 2010 +0000
 - Revision:
 - 4:fd826cad83c0
 - Parent:
 - 0:632c9925f013
 
Who changed what in which revision?
| User | Revision | Line number | New contents of line | 
|---|---|---|---|
| donatien | 0:632c9925f013 | 1 | |
| donatien | 0:632c9925f013 | 2 | /* | 
| donatien | 0:632c9925f013 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) | 
| donatien | 0:632c9925f013 | 4 | |
| donatien | 0:632c9925f013 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy | 
| donatien | 0:632c9925f013 | 6 | of this software and associated documentation files (the "Software"), to deal | 
| donatien | 0:632c9925f013 | 7 | in the Software without restriction, including without limitation the rights | 
| donatien | 0:632c9925f013 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | 
| donatien | 0:632c9925f013 | 9 | copies of the Software, and to permit persons to whom the Software is | 
| donatien | 0:632c9925f013 | 10 | furnished to do so, subject to the following conditions: | 
| donatien | 0:632c9925f013 | 11 | |
| donatien | 0:632c9925f013 | 12 | The above copyright notice and this permission notice shall be included in | 
| donatien | 0:632c9925f013 | 13 | all copies or substantial portions of the Software. | 
| donatien | 0:632c9925f013 | 14 | |
| donatien | 0:632c9925f013 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | 
| donatien | 0:632c9925f013 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | 
| donatien | 0:632c9925f013 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | 
| donatien | 0:632c9925f013 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | 
| donatien | 0:632c9925f013 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | 
| donatien | 0:632c9925f013 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | 
| donatien | 0:632c9925f013 | 21 | THE SOFTWARE. | 
| donatien | 0:632c9925f013 | 22 | */ | 
| donatien | 0:632c9925f013 | 23 | |
| donatien | 0:632c9925f013 | 24 | /* | 
| donatien | 0:632c9925f013 | 25 | |
| donatien | 0:632c9925f013 | 26 | This is a wrapper around Serial if for lwIP (acts as a serial driver) | 
| donatien | 0:632c9925f013 | 27 | |
| donatien | 0:632c9925f013 | 28 | See sio.h for functions to be implemented | 
| donatien | 0:632c9925f013 | 29 | |
| donatien | 0:632c9925f013 | 30 | sio_fd_t is a void* defined type, we use it as a SerialBuf ptr | 
| donatien | 0:632c9925f013 | 31 | |
| donatien | 0:632c9925f013 | 32 | |
| donatien | 0:632c9925f013 | 33 | |
| donatien | 0:632c9925f013 | 34 | */ | 
| donatien | 0:632c9925f013 | 35 | |
| donatien | 0:632c9925f013 | 36 | |
| donatien | 0:632c9925f013 | 37 | #include "netCfg.h" | 
| donatien | 0:632c9925f013 | 38 | #if NET_PPP | 
| donatien | 0:632c9925f013 | 39 | |
| donatien | 4:fd826cad83c0 | 40 | //#define MAX_SERIAL_PORTS 8 | 
| donatien | 0:632c9925f013 | 41 | |
| donatien | 0:632c9925f013 | 42 | #include "lwip/sio.h" | 
| donatien | 0:632c9925f013 | 43 | #include "mbed.h" | 
| donatien | 4:fd826cad83c0 | 44 | //#include "sioMgr.h" | 
| donatien | 4:fd826cad83c0 | 45 | #include "drv/serial/buf/SerialBuf.h" | 
| donatien | 4:fd826cad83c0 | 46 | |
| donatien | 4:fd826cad83c0 | 47 | //#define __DEBUG | 
| donatien | 4:fd826cad83c0 | 48 | #include "dbg/dbg.h" | 
| donatien | 0:632c9925f013 | 49 | |
| donatien | 0:632c9925f013 | 50 | //extern "C" { | 
| donatien | 0:632c9925f013 | 51 | |
| donatien | 0:632c9925f013 | 52 | /** | 
| donatien | 0:632c9925f013 | 53 | * Opens a serial device for communication. | 
| donatien | 0:632c9925f013 | 54 | * | 
| donatien | 0:632c9925f013 | 55 | * @param devnum device number | 
| donatien | 0:632c9925f013 | 56 | * @return handle to serial device if successful, NULL otherwise | 
| donatien | 0:632c9925f013 | 57 | */ | 
| donatien | 0:632c9925f013 | 58 | sio_fd_t sio_open(u8_t devnum) | 
| donatien | 0:632c9925f013 | 59 | { | 
| donatien | 4:fd826cad83c0 | 60 | #if 0 | 
| donatien | 0:632c9925f013 | 61 | SerialBuf* pIf = SioMgr::getIf(devnum); | 
| donatien | 0:632c9925f013 | 62 | if(pIf == NULL) | 
| donatien | 0:632c9925f013 | 63 | return NULL; | 
| donatien | 0:632c9925f013 | 64 | |
| donatien | 0:632c9925f013 | 65 | //Got a SerialBuf* object | 
| donatien | 0:632c9925f013 | 66 | //WARN: It HAS to be initialised (instanciated + attached to a Serial obj) | 
| donatien | 0:632c9925f013 | 67 | |
| donatien | 4:fd826cad83c0 | 68 | return (sio_fd_t) pIf; | 
| donatien | 4:fd826cad83c0 | 69 | #endif | 
| donatien | 4:fd826cad83c0 | 70 | return NULL; | 
| donatien | 0:632c9925f013 | 71 | } | 
| donatien | 0:632c9925f013 | 72 | |
| donatien | 0:632c9925f013 | 73 | /** | 
| donatien | 0:632c9925f013 | 74 | * Sends a single character to the serial device. | 
| donatien | 0:632c9925f013 | 75 | * | 
| donatien | 0:632c9925f013 | 76 | * @param c character to send | 
| donatien | 0:632c9925f013 | 77 | * @param fd serial device handle | 
| donatien | 0:632c9925f013 | 78 | * | 
| donatien | 0:632c9925f013 | 79 | * @note This function will block until the character can be sent. | 
| donatien | 0:632c9925f013 | 80 | */ | 
| donatien | 0:632c9925f013 | 81 | void sio_send(u8_t c, sio_fd_t fd) | 
| donatien | 0:632c9925f013 | 82 | { | 
| donatien | 0:632c9925f013 | 83 | SerialBuf* pIf = (SerialBuf*) fd; | 
| donatien | 0:632c9925f013 | 84 | //while(!pIf->writeable()); | 
| donatien | 0:632c9925f013 | 85 | pIf->putc( (char) c ); | 
| donatien | 0:632c9925f013 | 86 | } | 
| donatien | 0:632c9925f013 | 87 | |
| donatien | 0:632c9925f013 | 88 | /** | 
| donatien | 0:632c9925f013 | 89 | * Receives a single character from the serial device. | 
| donatien | 0:632c9925f013 | 90 | * | 
| donatien | 0:632c9925f013 | 91 | * @param fd serial device handle | 
| donatien | 0:632c9925f013 | 92 | * | 
| donatien | 0:632c9925f013 | 93 | * @note This function will block until a character is received. | 
| donatien | 0:632c9925f013 | 94 | */ | 
| donatien | 0:632c9925f013 | 95 | u8_t sio_recv(sio_fd_t fd) | 
| donatien | 0:632c9925f013 | 96 | { | 
| donatien | 0:632c9925f013 | 97 | SerialBuf* pIf = (SerialBuf*) fd; | 
| donatien | 0:632c9925f013 | 98 | pIf->setReadMode(false); | 
| donatien | 0:632c9925f013 | 99 | while(!pIf->readable()); | 
| donatien | 0:632c9925f013 | 100 | return (u8_t) pIf->getc(); | 
| donatien | 0:632c9925f013 | 101 | } | 
| donatien | 0:632c9925f013 | 102 | |
| donatien | 0:632c9925f013 | 103 | /** | 
| donatien | 0:632c9925f013 | 104 | * Reads from the serial device. | 
| donatien | 0:632c9925f013 | 105 | * | 
| donatien | 0:632c9925f013 | 106 | * @param fd serial device handle | 
| donatien | 0:632c9925f013 | 107 | * @param data pointer to data buffer for receiving | 
| donatien | 0:632c9925f013 | 108 | * @param len maximum length (in bytes) of data to receive | 
| donatien | 0:632c9925f013 | 109 | * @return number of bytes actually received - may be 0 if aborted by sio_read_abort | 
| donatien | 0:632c9925f013 | 110 | * | 
| donatien | 0:632c9925f013 | 111 | * @note This function will block until data can be received. The blocking | 
| donatien | 0:632c9925f013 | 112 | * can be cancelled by calling sio_read_abort(). | 
| donatien | 0:632c9925f013 | 113 | */ | 
| donatien | 0:632c9925f013 | 114 | static volatile bool m_abort = false; | 
| donatien | 0:632c9925f013 | 115 | u32_t sio_read(sio_fd_t fd, u8_t *data, u32_t len) | 
| donatien | 0:632c9925f013 | 116 | { | 
| donatien | 0:632c9925f013 | 117 | u32_t recvd = 0; //bytes received | 
| donatien | 0:632c9925f013 | 118 | SerialBuf* pIf = (SerialBuf*) fd; | 
| donatien | 0:632c9925f013 | 119 | pIf->setReadMode(false); | 
| donatien | 0:632c9925f013 | 120 | while(!m_abort && len) | 
| donatien | 0:632c9925f013 | 121 | { | 
| donatien | 0:632c9925f013 | 122 | while(!pIf->readable()); | 
| donatien | 0:632c9925f013 | 123 | *data = (u8_t) pIf->getc(); | 
| donatien | 0:632c9925f013 | 124 | data++; | 
| donatien | 0:632c9925f013 | 125 | len--; | 
| donatien | 0:632c9925f013 | 126 | recvd++; | 
| donatien | 0:632c9925f013 | 127 | } | 
| donatien | 0:632c9925f013 | 128 | m_abort = false; | 
| donatien | 0:632c9925f013 | 129 | return recvd; | 
| donatien | 0:632c9925f013 | 130 | } | 
| donatien | 0:632c9925f013 | 131 | |
| donatien | 0:632c9925f013 | 132 | /** | 
| donatien | 0:632c9925f013 | 133 | * Tries to read from the serial device. Same as sio_read but returns | 
| donatien | 0:632c9925f013 | 134 | * immediately if no data is available and never blocks. | 
| donatien | 0:632c9925f013 | 135 | * | 
| donatien | 0:632c9925f013 | 136 | * @param fd serial device handle | 
| donatien | 0:632c9925f013 | 137 | * @param data pointer to data buffer for receiving | 
| donatien | 0:632c9925f013 | 138 | * @param len maximum length (in bytes) of data to receive | 
| donatien | 0:632c9925f013 | 139 | * @return number of bytes actually received | 
| donatien | 0:632c9925f013 | 140 | */ | 
| donatien | 0:632c9925f013 | 141 | u32_t sio_tryread(sio_fd_t fd, u8_t *data, u32_t len) | 
| donatien | 0:632c9925f013 | 142 | { | 
| donatien | 0:632c9925f013 | 143 | u32_t recvd = 0; //bytes received | 
| donatien | 0:632c9925f013 | 144 | SerialBuf* pIf = (SerialBuf*) fd; | 
| donatien | 0:632c9925f013 | 145 | pIf->setReadMode(false); | 
| donatien | 0:632c9925f013 | 146 | while(len) | 
| donatien | 0:632c9925f013 | 147 | { | 
| donatien | 0:632c9925f013 | 148 | /* if(!pIf->readable()) | 
| donatien | 0:632c9925f013 | 149 | { | 
| donatien | 0:632c9925f013 | 150 | wait_ms(4); | 
| donatien | 0:632c9925f013 | 151 | }*/ | 
| donatien | 0:632c9925f013 | 152 | if(!pIf->readable()) | 
| donatien | 0:632c9925f013 | 153 | { | 
| donatien | 0:632c9925f013 | 154 | return recvd; | 
| donatien | 0:632c9925f013 | 155 | } | 
| donatien | 0:632c9925f013 | 156 | *data = (u8_t) pIf->getc(); | 
| donatien | 0:632c9925f013 | 157 | data++; | 
| donatien | 0:632c9925f013 | 158 | len--; | 
| donatien | 0:632c9925f013 | 159 | recvd++; | 
| donatien | 0:632c9925f013 | 160 | } | 
| donatien | 0:632c9925f013 | 161 | return recvd; | 
| donatien | 0:632c9925f013 | 162 | } | 
| donatien | 0:632c9925f013 | 163 | |
| donatien | 0:632c9925f013 | 164 | /** | 
| donatien | 0:632c9925f013 | 165 | * Writes to the serial device. | 
| donatien | 0:632c9925f013 | 166 | * | 
| donatien | 0:632c9925f013 | 167 | * @param fd serial device handle | 
| donatien | 0:632c9925f013 | 168 | * @param data pointer to data to send | 
| donatien | 0:632c9925f013 | 169 | * @param len length (in bytes) of data to send | 
| donatien | 0:632c9925f013 | 170 | * @return number of bytes actually sent | 
| donatien | 0:632c9925f013 | 171 | * | 
| donatien | 0:632c9925f013 | 172 | * @note This function will block until all data can be sent. | 
| donatien | 0:632c9925f013 | 173 | */ | 
| donatien | 0:632c9925f013 | 174 | u32_t sio_write(sio_fd_t fd, u8_t *data, u32_t len) | 
| donatien | 0:632c9925f013 | 175 | { | 
| donatien | 0:632c9925f013 | 176 | u32_t sent = 0; //bytes sent | 
| donatien | 0:632c9925f013 | 177 | SerialBuf* pIf = (SerialBuf*) fd; | 
| donatien | 0:632c9925f013 | 178 | while(len) | 
| donatien | 0:632c9925f013 | 179 | { | 
| donatien | 4:fd826cad83c0 | 180 | while(!pIf->writeable()); | 
| donatien | 0:632c9925f013 | 181 | pIf->putc(*data); | 
| donatien | 0:632c9925f013 | 182 | data++; | 
| donatien | 0:632c9925f013 | 183 | len--; | 
| donatien | 0:632c9925f013 | 184 | sent++; | 
| donatien | 0:632c9925f013 | 185 | } | 
| donatien | 0:632c9925f013 | 186 | return sent; //Well, this is bound to be len if no interrupt mechanism | 
| donatien | 0:632c9925f013 | 187 | } | 
| donatien | 0:632c9925f013 | 188 | |
| donatien | 0:632c9925f013 | 189 | /** | 
| donatien | 0:632c9925f013 | 190 | * Aborts a blocking sio_read() call. | 
| donatien | 0:632c9925f013 | 191 | * | 
| donatien | 0:632c9925f013 | 192 | * @param fd serial device handle | 
| donatien | 0:632c9925f013 | 193 | */ | 
| donatien | 0:632c9925f013 | 194 | void sio_read_abort(sio_fd_t fd) | 
| donatien | 0:632c9925f013 | 195 | { | 
| donatien | 0:632c9925f013 | 196 | m_abort = true; | 
| donatien | 0:632c9925f013 | 197 | } | 
| donatien | 0:632c9925f013 | 198 | |
| donatien | 0:632c9925f013 | 199 | //} | 
| donatien | 0:632c9925f013 | 200 | |
| donatien | 0:632c9925f013 | 201 | #endif | 
| donatien | 0:632c9925f013 | 202 |