Ashley Mills / VodafoneUSBModem_bleedingedge2

local fork

Dependencies:   Socket USBHostWANDongle_bleedingedge lwip-sys lwip

Dependents:   Encrypted

Fork of VodafoneUSBModem_bleedingedge by Donatien Garnier

serial/io/IOSerialStream.cpp@8:04b6a042595f, 2012-06-26 (annotated)

Committer:
donatien
Date:
Tue Jun 26 13:44:59 2012 +0000
Revision:
8:04b6a042595f
Parent:
main/drv/serial/io/IOSerialStream.cpp@0:3b2f052c333b
Child:
10:21a6f09d5631
Bleeding edge - test with two different interfaces

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:3b2f052c333b 1 /* IOSerialStream.cpp */
donatien 0:3b2f052c333b 2 /*
donatien 0:3b2f052c333b 3 Copyright (C) 2012 ARM Limited.
donatien 0:3b2f052c333b 4
donatien 0:3b2f052c333b 5 Permission is hereby granted, free of charge, to any person obtaining a copy of
donatien 0:3b2f052c333b 6 this software and associated documentation files (the "Software"), to deal in
donatien 0:3b2f052c333b 7 the Software without restriction, including without limitation the rights to
donatien 0:3b2f052c333b 8 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
donatien 0:3b2f052c333b 9 of the Software, and to permit persons to whom the Software is furnished to do
donatien 0:3b2f052c333b 10 so, subject to the following conditions:
donatien 0:3b2f052c333b 11
donatien 0:3b2f052c333b 12 The above copyright notice and this permission notice shall be included in all
donatien 0:3b2f052c333b 13 copies or substantial portions of the Software.
donatien 0:3b2f052c333b 14
donatien 0:3b2f052c333b 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
donatien 0:3b2f052c333b 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
donatien 0:3b2f052c333b 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
donatien 0:3b2f052c333b 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
donatien 0:3b2f052c333b 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:3b2f052c333b 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
donatien 0:3b2f052c333b 21 SOFTWARE.
donatien 0:3b2f052c333b 22 */
donatien 0:3b2f052c333b 23
donatien 0:3b2f052c333b 24 #define __DEBUG__ 0 //Maximum verbosity
donatien 0:3b2f052c333b 25 #ifndef __MODULE__
donatien 0:3b2f052c333b 26 #define __MODULE__ "IOSerialStream.cpp"
donatien 0:3b2f052c333b 27 #endif
donatien 0:3b2f052c333b 28
donatien 0:3b2f052c333b 29 #include "core/fwk.h"
donatien 0:3b2f052c333b 30
donatien 0:3b2f052c333b 31 #include <stdio.h>
donatien 0:3b2f052c333b 32
donatien 0:3b2f052c333b 33 #include "IOSerialStream.h"
donatien 0:3b2f052c333b 34
donatien 0:3b2f052c333b 35 IOSerialStream::IOSerialStream(mbed::Serial& serial) : m_serial(serial), m_serialTxFifoEmpty(true),
donatien 0:3b2f052c333b 36 m_availableSphre(1), m_spaceSphre(1), m_inBuf(), m_outBuf()
donatien 0:3b2f052c333b 37 {
donatien 0:3b2f052c333b 38 m_availableSphre.wait();
donatien 0:3b2f052c333b 39 m_spaceSphre.wait();
donatien 0:3b2f052c333b 40 //Attach interrupts
donatien 0:3b2f052c333b 41 m_serial.attach(this, &IOSerialStream::readable, mbed::Serial::RxIrq);
donatien 0:3b2f052c333b 42 m_serial.attach(this, &IOSerialStream::writeable, mbed::Serial::TxIrq);
donatien 0:3b2f052c333b 43 }
donatien 0:3b2f052c333b 44
donatien 0:3b2f052c333b 45 /*virtual*/ IOSerialStream::~IOSerialStream()
donatien 0:3b2f052c333b 46 {
donatien 0:3b2f052c333b 47 m_serial.attach(NULL, mbed::Serial::RxIrq);
donatien 0:3b2f052c333b 48 m_serial.attach(NULL, mbed::Serial::TxIrq);
donatien 0:3b2f052c333b 49 }
donatien 0:3b2f052c333b 50
donatien 0:3b2f052c333b 51 //0 for non-blocking (returns immediately), osWaitForever for infinite blocking
donatien 0:3b2f052c333b 52 /*virtual*/ int IOSerialStream::read(uint8_t* buf, size_t* pLength, size_t maxLength, uint32_t timeout/*=osWaitForever*/)
donatien 0:3b2f052c333b 53 {
donatien 0:3b2f052c333b 54 DBG("Trying to read at most %d chars", maxLength);
donatien 0:3b2f052c333b 55 int ret = waitAvailable(timeout);
donatien 0:3b2f052c333b 56 if(ret)
donatien 0:3b2f052c333b 57 {
donatien 0:3b2f052c333b 58 WARN("Error %d while waiting for incoming data");
donatien 0:3b2f052c333b 59 return ret;
donatien 0:3b2f052c333b 60 }
donatien 0:3b2f052c333b 61 int readLen = MIN( available(), maxLength );
donatien 0:3b2f052c333b 62 *pLength = readLen;
donatien 0:3b2f052c333b 63 setupReadableISR(false);
donatien 0:3b2f052c333b 64 while(readLen--)
donatien 0:3b2f052c333b 65 {
donatien 0:3b2f052c333b 66 m_inBuf.dequeue(buf);
donatien 0:3b2f052c333b 67 buf++;
donatien 0:3b2f052c333b 68 }
donatien 0:3b2f052c333b 69 setupReadableISR(true);
donatien 0:3b2f052c333b 70 DBG("Read %d chars successfully", *pLength);
donatien 0:3b2f052c333b 71 return OK;
donatien 0:3b2f052c333b 72 }
donatien 0:3b2f052c333b 73
donatien 0:3b2f052c333b 74 /*virtual*/ size_t IOSerialStream::available()
donatien 0:3b2f052c333b 75 {
donatien 0:3b2f052c333b 76 setupReadableISR(false); //m_inBuf.available() is not reentrant
donatien 0:3b2f052c333b 77 size_t len = m_inBuf.available();
donatien 0:3b2f052c333b 78 setupReadableISR(true);
donatien 0:3b2f052c333b 79 return len;
donatien 0:3b2f052c333b 80 }
donatien 0:3b2f052c333b 81
donatien 0:3b2f052c333b 82 /*virtual*/ int IOSerialStream::waitAvailable(uint32_t timeout/*=osWaitForever*/) //Wait for data to be available
donatien 0:3b2f052c333b 83 {
donatien 0:3b2f052c333b 84 int ret;
donatien 0:3b2f052c333b 85 if(available()) //Is data already available?
donatien 0:3b2f052c333b 86 {
donatien 0:3b2f052c333b 87 m_availableSphre.wait(0); //Clear the queue as data is available
donatien 0:3b2f052c333b 88 return OK;
donatien 0:3b2f052c333b 89 }
donatien 0:3b2f052c333b 90
donatien 0:3b2f052c333b 91 DBG("Waiting for data availability %d ms (-1 is infinite)", timeout);
donatien 0:3b2f052c333b 92 ret = m_availableSphre.wait(timeout); //Wait for data to arrive or for abort
donatien 0:3b2f052c333b 93 if(ret <= 0)
donatien 0:3b2f052c333b 94 {
donatien 0:3b2f052c333b 95 DBG("Timeout");
donatien 0:3b2f052c333b 96 return NET_TIMEOUT;
donatien 0:3b2f052c333b 97 }
donatien 0:3b2f052c333b 98 if(!available()) //Even if abort has been called, return that data is available
donatien 0:3b2f052c333b 99 {
donatien 0:3b2f052c333b 100 DBG("Aborted");
donatien 0:3b2f052c333b 101 return NET_INTERRUPTED;
donatien 0:3b2f052c333b 102 }
donatien 0:3b2f052c333b 103 DBG("Finished waiting");
donatien 0:3b2f052c333b 104 m_availableSphre.wait(0); //Clear the queue as data is available
donatien 0:3b2f052c333b 105 return OK;
donatien 0:3b2f052c333b 106 }
donatien 0:3b2f052c333b 107
donatien 0:3b2f052c333b 108 /*virtual*/ int IOSerialStream::abortRead() //Abort current reading (or waiting) operation
donatien 0:3b2f052c333b 109 {
donatien 0:3b2f052c333b 110 if( !available() ) //If there is data pending, no need to abort
donatien 0:3b2f052c333b 111 {
donatien 0:3b2f052c333b 112 m_availableSphre.release(); //Force exiting the waiting state; kludge to pass a RC directly
donatien 0:3b2f052c333b 113 }
donatien 0:3b2f052c333b 114 else
donatien 0:3b2f052c333b 115 {
donatien 0:3b2f052c333b 116 DBG("Serial is readable"); ;
donatien 0:3b2f052c333b 117 }
donatien 0:3b2f052c333b 118 return OK;
donatien 0:3b2f052c333b 119 }
donatien 0:3b2f052c333b 120
donatien 0:3b2f052c333b 121 void IOSerialStream::setupReadableISR(bool en)
donatien 0:3b2f052c333b 122 {
donatien 0:3b2f052c333b 123 if(en)
donatien 0:3b2f052c333b 124 {
donatien 0:3b2f052c333b 125 ((LPC_UART_TypeDef *)(UART_3))->IER |= 1 << 0;
donatien 0:3b2f052c333b 126 }
donatien 0:3b2f052c333b 127 else
donatien 0:3b2f052c333b 128 {
donatien 0:3b2f052c333b 129 ((LPC_UART_TypeDef *)(UART_3))->IER &= ~(1 << 0);
donatien 0:3b2f052c333b 130 }
donatien 0:3b2f052c333b 131 }
donatien 0:3b2f052c333b 132
donatien 0:3b2f052c333b 133 void IOSerialStream::readable() //Callback from m_serial when new data is available
donatien 0:3b2f052c333b 134 {
donatien 0:3b2f052c333b 135 do
donatien 0:3b2f052c333b 136 {
donatien 0:3b2f052c333b 137 m_inBuf.queue(((LPC_UART_TypeDef *)UART_3)->RBR); //FIXME mbed libraries this is an awful kludge
donatien 0:3b2f052c333b 138 } while(m_serial.readable());
donatien 0:3b2f052c333b 139 m_availableSphre.release(); //Force exiting the waiting state
donatien 0:3b2f052c333b 140 }
donatien 0:3b2f052c333b 141
donatien 0:3b2f052c333b 142 //0 for non-blocking (returns immediately), osWaitForever for infinite blocking
donatien 0:3b2f052c333b 143 /*virtual*/ int IOSerialStream::write(uint8_t* buf, size_t length, uint32_t timeout/*=osWaitForever*/)
donatien 0:3b2f052c333b 144 {
donatien 0:3b2f052c333b 145 DBG("Trying to write %d chars", length);
donatien 0:3b2f052c333b 146 int ret = waitSpace(timeout);
donatien 0:3b2f052c333b 147 if(ret)
donatien 0:3b2f052c333b 148 {
donatien 0:3b2f052c333b 149 WARN("Error %d while waiting for space");
donatien 0:3b2f052c333b 150 return ret;
donatien 0:3b2f052c333b 151 }
donatien 0:3b2f052c333b 152 DBG("Writing %d chars", length);
donatien 0:3b2f052c333b 153 setupWriteableISR(false);
donatien 0:3b2f052c333b 154 while(length)
donatien 0:3b2f052c333b 155 {
donatien 0:3b2f052c333b 156 m_outBuf.queue(*buf);
donatien 0:3b2f052c333b 157 buf++;
donatien 0:3b2f052c333b 158 length--;
donatien 0:3b2f052c333b 159 if(length && !space())
donatien 0:3b2f052c333b 160 {
donatien 0:3b2f052c333b 161 DBG("Waiting to write remaining %d chars", length);
donatien 0:3b2f052c333b 162 setupWriteableISR(true);
donatien 0:3b2f052c333b 163 ret = waitSpace(timeout);
donatien 0:3b2f052c333b 164 if(ret)
donatien 0:3b2f052c333b 165 {
donatien 0:3b2f052c333b 166 WARN("Error %d while waiting for space");
donatien 0:3b2f052c333b 167 return ret;
donatien 0:3b2f052c333b 168 }
donatien 0:3b2f052c333b 169 setupWriteableISR(false);
donatien 0:3b2f052c333b 170 }
donatien 0:3b2f052c333b 171 }
donatien 0:3b2f052c333b 172 //If m_serial tx fifo is empty we need to manually tx a byte in order to trigger the interrupt
donatien 0:3b2f052c333b 173 if( m_outBuf.available() && m_serialTxFifoEmpty )
donatien 0:3b2f052c333b 174 {
donatien 0:3b2f052c333b 175 m_serialTxFifoEmpty = false;
donatien 0:3b2f052c333b 176 uint8_t c;
donatien 0:3b2f052c333b 177 m_outBuf.dequeue(&c);
donatien 0:3b2f052c333b 178 //m_serial.putc((char)c);
donatien 0:3b2f052c333b 179 ((LPC_UART_TypeDef *)UART_3)->THR = c; //FIXME awful kludge
donatien 0:3b2f052c333b 180 }
donatien 0:3b2f052c333b 181 setupWriteableISR(true);
donatien 0:3b2f052c333b 182 DBG("Write successful");
donatien 0:3b2f052c333b 183 return OK;
donatien 0:3b2f052c333b 184 }
donatien 0:3b2f052c333b 185
donatien 0:3b2f052c333b 186 /*virtual*/ size_t IOSerialStream::space()
donatien 0:3b2f052c333b 187 {
donatien 0:3b2f052c333b 188 setupWriteableISR(false); //m_outBuf.available() is not reentrant
donatien 0:3b2f052c333b 189 size_t len = CIRCBUF_SIZE - m_outBuf.available();
donatien 0:3b2f052c333b 190 setupWriteableISR(true);
donatien 0:3b2f052c333b 191 return len;
donatien 0:3b2f052c333b 192 }
donatien 0:3b2f052c333b 193
donatien 0:3b2f052c333b 194 /*virtual*/ int IOSerialStream::waitSpace(uint32_t timeout/*=osWaitForever*/) //Wait for space to be available
donatien 0:3b2f052c333b 195 {
donatien 0:3b2f052c333b 196 int ret;
donatien 0:3b2f052c333b 197 if(space()) //Is still space already left?
donatien 0:3b2f052c333b 198 {
donatien 0:3b2f052c333b 199 m_spaceSphre.wait(0); //Clear the queue as space is available
donatien 0:3b2f052c333b 200 return OK;
donatien 0:3b2f052c333b 201 }
donatien 0:3b2f052c333b 202
donatien 0:3b2f052c333b 203 DBG("Waiting for data space %d ms (-1 is infinite)", timeout);
donatien 0:3b2f052c333b 204 ret = m_spaceSphre.wait(timeout); //Wait for space to be made or for abort
donatien 0:3b2f052c333b 205 if(ret <= 0)
donatien 0:3b2f052c333b 206 {
donatien 0:3b2f052c333b 207 DBG("Timeout");
donatien 0:3b2f052c333b 208 return NET_TIMEOUT;
donatien 0:3b2f052c333b 209 }
donatien 0:3b2f052c333b 210 if(!space()) //Even if abort has been called, return that space is available
donatien 0:3b2f052c333b 211 {
donatien 0:3b2f052c333b 212 DBG("Aborted");
donatien 0:3b2f052c333b 213 return NET_INTERRUPTED;
donatien 0:3b2f052c333b 214 }
donatien 0:3b2f052c333b 215 m_spaceSphre.wait(0); //Clear the queue as space is available
donatien 0:3b2f052c333b 216 return OK;
donatien 0:3b2f052c333b 217 }
donatien 0:3b2f052c333b 218
donatien 0:3b2f052c333b 219 /*virtual*/ int IOSerialStream::abortWrite() //Abort current writing (or waiting) operation
donatien 0:3b2f052c333b 220 {
donatien 0:3b2f052c333b 221 if( !space() ) //If there is space left, no need to abort
donatien 0:3b2f052c333b 222 {
donatien 0:3b2f052c333b 223 m_spaceSphre.release(); //Force exiting the waiting state
donatien 0:3b2f052c333b 224 }
donatien 0:3b2f052c333b 225 return OK;
donatien 0:3b2f052c333b 226 }
donatien 0:3b2f052c333b 227
donatien 0:3b2f052c333b 228 void IOSerialStream::setupWriteableISR(bool en)
donatien 0:3b2f052c333b 229 {
donatien 0:3b2f052c333b 230 if(en)
donatien 0:3b2f052c333b 231 {
donatien 0:3b2f052c333b 232 ((LPC_UART_TypeDef *)(UART_3))->IER |= 1 << 1;
donatien 0:3b2f052c333b 233 }
donatien 0:3b2f052c333b 234 else
donatien 0:3b2f052c333b 235 {
donatien 0:3b2f052c333b 236 ((LPC_UART_TypeDef *)(UART_3))->IER &= ~(1 << 1);
donatien 0:3b2f052c333b 237 }
donatien 0:3b2f052c333b 238 }
donatien 0:3b2f052c333b 239
donatien 0:3b2f052c333b 240 void IOSerialStream::writeable() //Callback from m_serial when new space is available
donatien 0:3b2f052c333b 241 {
donatien 0:3b2f052c333b 242 if(m_outBuf.isEmpty())
donatien 0:3b2f052c333b 243 {
donatien 0:3b2f052c333b 244 m_serialTxFifoEmpty = true;
donatien 0:3b2f052c333b 245 }
donatien 0:3b2f052c333b 246 else
donatien 0:3b2f052c333b 247 {
donatien 0:3b2f052c333b 248 while(m_serial.writeable() && !m_outBuf.isEmpty())
donatien 0:3b2f052c333b 249 {
donatien 0:3b2f052c333b 250 uint8_t c;
donatien 0:3b2f052c333b 251 m_outBuf.dequeue(&c);
donatien 0:3b2f052c333b 252 //m_serial.putc((char)c);
donatien 0:3b2f052c333b 253 ((LPC_UART_TypeDef *)UART_3)->THR = c; //FIXME awful kludge
donatien 0:3b2f052c333b 254 }
donatien 0:3b2f052c333b 255 }
donatien 0:3b2f052c333b 256 m_spaceSphre.release(); //Force exiting the waiting state
donatien 0:3b2f052c333b 257 }