Donatien Garnier / VodafoneUSBModem

Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket

This library is deprecated. Please use the newest production branch of the library from https://mbed.org/users/mbed_official/code/VodafoneUSBModem/

serial/usb/USBSerialStream.h@2:50930edb6eb3, 2012-11-01 (annotated)

Committer:
donatien
Date:
Thu Nov 01 09:57:11 2012 +0000
Revision:
2:50930edb6eb3
Parent:
0:bd5343539e38 
Deprecated library, pointing out to new one

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:bd5343539e38 1 /* USBSerialStream.h */
donatien 0:bd5343539e38 2 /* Copyright (C) 2012 mbed.org, MIT License
donatien 0:bd5343539e38 3 *
donatien 0:bd5343539e38 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 0:bd5343539e38 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
donatien 0:bd5343539e38 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
donatien 0:bd5343539e38 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
donatien 0:bd5343539e38 8 * furnished to do so, subject to the following conditions:
donatien 0:bd5343539e38 9 *
donatien 0:bd5343539e38 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 0:bd5343539e38 11 * substantial portions of the Software.
donatien 0:bd5343539e38 12 *
donatien 0:bd5343539e38 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 0:bd5343539e38 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 0:bd5343539e38 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 0:bd5343539e38 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:bd5343539e38 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 0:bd5343539e38 18 */
donatien 0:bd5343539e38 19
donatien 0:bd5343539e38 20 #ifndef USBSERIALSTREAM_H_
donatien 0:bd5343539e38 21 #define USBSERIALSTREAM_H_
donatien 0:bd5343539e38 22
donatien 0:bd5343539e38 23
donatien 0:bd5343539e38 24 #include "core/fwk.h"
donatien 0:bd5343539e38 25
donatien 0:bd5343539e38 26 #include "USB3GModule/IUSBHostSerial.h"
donatien 0:bd5343539e38 27 #include "USB3GModule/IUSBHostSerialListener.h"
donatien 0:bd5343539e38 28
donatien 0:bd5343539e38 29 #include "rtos.h"
donatien 0:bd5343539e38 30 #include "core/MtxCircBuffer.h"
donatien 0:bd5343539e38 31
donatien 0:bd5343539e38 32 /* Input Serial Stream for USB virtual serial ports interfaces
donatien 0:bd5343539e38 33 This class is not thread-safe, except for the *Abort() methods that can be called by any thread/ISR
donatien 0:bd5343539e38 34 */
donatien 0:bd5343539e38 35 #define CIRCBUF_SIZE 127
donatien 0:bd5343539e38 36 class USBSerialStream : public IOStream, IUSBHostSerialListener
donatien 0:bd5343539e38 37 {
donatien 0:bd5343539e38 38 public:
donatien 0:bd5343539e38 39 USBSerialStream(IUSBHostSerial& serial);
donatien 0:bd5343539e38 40 /*virtual*/ ~USBSerialStream();
donatien 0:bd5343539e38 41
donatien 0:bd5343539e38 42 //0 for non-blocking (returns immediately), osWaitForever for infinite blocking
donatien 0:bd5343539e38 43 virtual int read(uint8_t* buf, size_t* pLength, size_t maxLength, uint32_t timeout=osWaitForever);
donatien 0:bd5343539e38 44 virtual size_t available();
donatien 0:bd5343539e38 45 virtual int waitAvailable(uint32_t timeout=osWaitForever); //Wait for data to be available
donatien 0:bd5343539e38 46 virtual int abortRead(); //Abort current reading (or waiting) operation
donatien 0:bd5343539e38 47
donatien 0:bd5343539e38 48
donatien 0:bd5343539e38 49 //0 for non-blocking (returns immediately), osWaitForever for infinite blocking
donatien 0:bd5343539e38 50 virtual int write(uint8_t* buf, size_t length, uint32_t timeout=osWaitForever);
donatien 0:bd5343539e38 51 virtual size_t space();
donatien 0:bd5343539e38 52 virtual int waitSpace(uint32_t timeout=osWaitForever); //Wait for space to be available
donatien 0:bd5343539e38 53 virtual int abortWrite(); //Abort current writing (or waiting) operation
donatien 0:bd5343539e38 54
donatien 0:bd5343539e38 55 private:
donatien 0:bd5343539e38 56 IUSBHostSerial& m_serial;
donatien 0:bd5343539e38 57 volatile bool m_serialTxFifoEmpty;
donatien 0:bd5343539e38 58
donatien 0:bd5343539e38 59 void setupReadableISR(bool en);
donatien 0:bd5343539e38 60 virtual void readable(); //Callback from m_serial when new data is available
donatien 0:bd5343539e38 61
donatien 0:bd5343539e38 62 Semaphore m_availableSphre; //Used for signalling
donatien 0:bd5343539e38 63
donatien 0:bd5343539e38 64 void setupWriteableISR(bool en);
donatien 0:bd5343539e38 65 virtual void writeable(); //Callback from m_serial when new space is available
donatien 0:bd5343539e38 66
donatien 0:bd5343539e38 67 Semaphore m_spaceSphre; //Used for signalling
donatien 0:bd5343539e38 68
donatien 0:bd5343539e38 69 MtxCircBuffer<uint8_t, CIRCBUF_SIZE + 1> m_inBuf;
donatien 0:bd5343539e38 70 MtxCircBuffer<uint8_t, CIRCBUF_SIZE + 1> m_outBuf;
donatien 0:bd5343539e38 71 };
donatien 0:bd5343539e38 72
donatien 0:bd5343539e38 73 #endif /* USBSERIALSTREAM_H_ */