Alex Kiernan / VodafoneUSBModem

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.

Fork of VodafoneUSBModem by mbed official

serial/usb/USBSerialStream.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/usb/USBSerialStream.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 /* USBSerialStream.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__ "USBSerialStream.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 "USBSerialStream.h"
donatien 0:3b2f052c333b 34
donatien 0:3b2f052c333b 35
donatien 0:3b2f052c333b 36 USBSerialStream::USBSerialStream(IUSBHostSerial& serial) : m_serial(serial), m_serialTxFifoEmpty(true),
donatien 0:3b2f052c333b 37 m_availableSphre(1), m_spaceSphre(1), m_inBuf()
donatien 0:3b2f052c333b 38 {
donatien 0:3b2f052c333b 39 m_availableSphre.wait();
donatien 0:3b2f052c333b 40 m_spaceSphre.wait();
donatien 0:3b2f052c333b 41 //Attach interrupts
donatien 0:3b2f052c333b 42 m_serial.attach(this);
donatien 0:3b2f052c333b 43 }
donatien 0:3b2f052c333b 44
donatien 0:3b2f052c333b 45 /*virtual*/ USBSerialStream::~USBSerialStream()
donatien 0:3b2f052c333b 46 {
donatien 0:3b2f052c333b 47 m_serial.attach(NULL);
donatien 0:3b2f052c333b 48 }
donatien 0:3b2f052c333b 49
donatien 0:3b2f052c333b 50 //0 for non-blocking (returns immediately), -1 for infinite blocking
donatien 0:3b2f052c333b 51 /*virtual*/ int USBSerialStream::read(uint8_t* buf, size_t* pLength, size_t maxLength, uint32_t timeout/*=osWaitForever*/)
donatien 0:3b2f052c333b 52 {
donatien 0:3b2f052c333b 53 DBG("Trying to read at most %d chars", maxLength);
donatien 0:3b2f052c333b 54 int ret = waitAvailable(timeout);
donatien 0:3b2f052c333b 55 if(ret)
donatien 0:3b2f052c333b 56 {
donatien 0:3b2f052c333b 57 WARN("Error %d while waiting for incoming data", ret);
donatien 0:3b2f052c333b 58 return ret;
donatien 0:3b2f052c333b 59 }
donatien 0:3b2f052c333b 60 int readLen = MIN( available(), maxLength );
donatien 0:3b2f052c333b 61 *pLength = readLen;
donatien 0:3b2f052c333b 62
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 USBSerialStream::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 USBSerialStream::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(!m_inBuf.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 USBSerialStream::abortRead() //Abort current reading (or waiting) operation
donatien 0:3b2f052c333b 109 {
donatien 0:3b2f052c333b 110 if( /*!available()*/true ) //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
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 USBSerialStream::setupReadableISR(bool en)
donatien 0:3b2f052c333b 122 {
donatien 0:3b2f052c333b 123 m_serial.setupIrq(en, IUSBHostSerial::RxIrq);
donatien 0:3b2f052c333b 124 }
donatien 0:3b2f052c333b 125
donatien 0:3b2f052c333b 126 void USBSerialStream::readable() //Callback from m_serial when new data is available
donatien 0:3b2f052c333b 127 {
donatien 0:3b2f052c333b 128 while(m_serial.readable())
donatien 0:3b2f052c333b 129 {
donatien 0:3b2f052c333b 130 m_inBuf.queue(m_serial.getc());
donatien 0:3b2f052c333b 131 }
donatien 0:3b2f052c333b 132 m_serial.readPacket(); //Start read of next packet
donatien 0:3b2f052c333b 133 m_availableSphre.release(); //Force exiting the waiting state
donatien 0:3b2f052c333b 134 }
donatien 0:3b2f052c333b 135
donatien 0:3b2f052c333b 136 //0 for non-blocking (returns immediately), -1 for infinite blocking
donatien 0:3b2f052c333b 137 /*virtual*/ int USBSerialStream::write(uint8_t* buf, size_t length, uint32_t timeout/*=-1*/)
donatien 0:3b2f052c333b 138 {
donatien 0:3b2f052c333b 139 DBG("Trying to write %d chars", length);
donatien 0:3b2f052c333b 140 do
donatien 0:3b2f052c333b 141 {
donatien 0:3b2f052c333b 142 int ret = waitSpace(timeout);
donatien 0:3b2f052c333b 143 if(ret)
donatien 0:3b2f052c333b 144 {
donatien 0:3b2f052c333b 145 WARN("Error %d while waiting for space");
donatien 0:3b2f052c333b 146 return ret;
donatien 0:3b2f052c333b 147 }
donatien 0:3b2f052c333b 148 int writeLen = MIN( space(), length );
donatien 0:3b2f052c333b 149 DBG("Writing %d chars", length);
donatien 0:3b2f052c333b 150 setupWriteableISR(false);
donatien 0:3b2f052c333b 151 while(writeLen)
donatien 0:3b2f052c333b 152 {
donatien 0:3b2f052c333b 153 m_outBuf.queue(*buf);
donatien 0:3b2f052c333b 154 buf++;
donatien 0:3b2f052c333b 155 length--;
donatien 0:3b2f052c333b 156 writeLen--;
donatien 0:3b2f052c333b 157 }
donatien 0:3b2f052c333b 158 setupWriteableISR(true);
donatien 0:3b2f052c333b 159 } while(length);
donatien 0:3b2f052c333b 160 //If m_serial tx fifo is empty we need to start the packet write
donatien 0:3b2f052c333b 161 setupWriteableISR(false);
donatien 0:3b2f052c333b 162 if( m_outBuf.available() && m_serialTxFifoEmpty )
donatien 0:3b2f052c333b 163 {
donatien 0:3b2f052c333b 164 writeable();
donatien 0:3b2f052c333b 165 }
donatien 0:3b2f052c333b 166 setupWriteableISR(true);
donatien 0:3b2f052c333b 167 DBG("Write successful");
donatien 0:3b2f052c333b 168 return OK;
donatien 0:3b2f052c333b 169 }
donatien 0:3b2f052c333b 170
donatien 0:3b2f052c333b 171 /*virtual*/ size_t USBSerialStream::space()
donatien 0:3b2f052c333b 172 {
donatien 0:3b2f052c333b 173 setupWriteableISR(false); //m_outBuf.available() is not reentrant
donatien 0:3b2f052c333b 174 size_t len = CIRCBUF_SIZE - m_outBuf.available();
donatien 0:3b2f052c333b 175 setupWriteableISR(true);
donatien 0:3b2f052c333b 176 return len;
donatien 0:3b2f052c333b 177 }
donatien 0:3b2f052c333b 178
donatien 0:3b2f052c333b 179 /*virtual*/ int USBSerialStream::waitSpace(uint32_t timeout/*=-1*/) //Wait for space to be available
donatien 0:3b2f052c333b 180 {
donatien 0:3b2f052c333b 181 int ret;
donatien 0:3b2f052c333b 182 if(space()) //Is still space already left?
donatien 0:3b2f052c333b 183 {
donatien 0:3b2f052c333b 184 m_spaceSphre.wait(0); //Clear the queue as space is available
donatien 0:3b2f052c333b 185 return OK;
donatien 0:3b2f052c333b 186 }
donatien 0:3b2f052c333b 187
donatien 0:3b2f052c333b 188 DBG("Waiting for data space %d ms (-1 is infinite)", timeout);
donatien 0:3b2f052c333b 189 ret = m_spaceSphre.wait(timeout); //Wait for space to be made or for abort
donatien 0:3b2f052c333b 190 if(ret <= 0)
donatien 0:3b2f052c333b 191 {
donatien 0:3b2f052c333b 192 DBG("Timeout");
donatien 0:3b2f052c333b 193 return NET_TIMEOUT;
donatien 0:3b2f052c333b 194 }
donatien 0:3b2f052c333b 195 if(!space()) //Even if abort has been called, return that space is available
donatien 0:3b2f052c333b 196 {
donatien 0:3b2f052c333b 197 DBG("Aborted");
donatien 0:3b2f052c333b 198 return NET_INTERRUPTED;
donatien 0:3b2f052c333b 199 }
donatien 0:3b2f052c333b 200 m_spaceSphre.wait(0); //Clear the queue as space is available
donatien 0:3b2f052c333b 201 return OK;
donatien 0:3b2f052c333b 202 }
donatien 0:3b2f052c333b 203
donatien 0:3b2f052c333b 204 /*virtual*/ int USBSerialStream::abortWrite() //Abort current writing (or waiting) operation
donatien 0:3b2f052c333b 205 {
donatien 0:3b2f052c333b 206 if( !space() ) //If there is space left, no need to abort
donatien 0:3b2f052c333b 207 {
donatien 0:3b2f052c333b 208 m_spaceSphre.release(); //Force exiting the waiting state
donatien 0:3b2f052c333b 209 }
donatien 0:3b2f052c333b 210 return OK;
donatien 0:3b2f052c333b 211 }
donatien 0:3b2f052c333b 212
donatien 0:3b2f052c333b 213 void USBSerialStream::setupWriteableISR(bool en)
donatien 0:3b2f052c333b 214 {
donatien 0:3b2f052c333b 215 m_serial.setupIrq(en, IUSBHostSerial::TxIrq);
donatien 0:3b2f052c333b 216 }
donatien 0:3b2f052c333b 217
donatien 0:3b2f052c333b 218 void USBSerialStream::writeable() //Callback from m_serial when new space is available
donatien 0:3b2f052c333b 219 {
donatien 0:3b2f052c333b 220 if(m_outBuf.isEmpty())
donatien 0:3b2f052c333b 221 {
donatien 0:3b2f052c333b 222 m_serialTxFifoEmpty = true;
donatien 0:3b2f052c333b 223 }
donatien 0:3b2f052c333b 224 else
donatien 0:3b2f052c333b 225 {
donatien 0:3b2f052c333b 226 m_serialTxFifoEmpty = false;
donatien 0:3b2f052c333b 227 while(m_serial.writeable() && !m_outBuf.isEmpty())
donatien 0:3b2f052c333b 228 {
donatien 0:3b2f052c333b 229 uint8_t c;
donatien 0:3b2f052c333b 230 m_outBuf.dequeue(&c);
donatien 0:3b2f052c333b 231 m_serial.putc((char)c);
donatien 0:3b2f052c333b 232 }
donatien 0:3b2f052c333b 233 static volatile int i=0;
donatien 0:3b2f052c333b 234 m_serial.writePacket(); //Start packet write
donatien 0:3b2f052c333b 235 }
donatien 0:3b2f052c333b 236 m_spaceSphre.release(); //Force exiting the waiting state
donatien 0:3b2f052c333b 237 }