Michael Spencer / Mbed 2 deprecated LaOS

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.

Dependencies:   mbed

NetServices/drv/serial/lwip/sio.cpp@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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