mbed official / USBHostWANDongle

USB Host WAN Dongle library

Fork of USBHostWANDongle_bleedingedge by Donatien Garnier

USB3GModule/IUSBHostSerial.h@27:980fe31c14f7, 2013-09-20 (annotated)

Committer:
ashleymills
Date:
Fri Sep 20 10:40:15 2013 +0000
Revision:
27:980fe31c14f7
Parent:
10:08bce4cd973a 
Added support for Ublox LISA U200 module

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:ae46a0638b2c 1 /* IUSBHostSerial.h */
donatien 10:08bce4cd973a 2 /* Copyright (c) 2010-2012 mbed.org, MIT License
donatien 10:08bce4cd973a 3 *
donatien 10:08bce4cd973a 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 10:08bce4cd973a 5 * and associated documentation files (the "Software"), to deal in the Software without
donatien 10:08bce4cd973a 6 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
donatien 10:08bce4cd973a 7 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
donatien 10:08bce4cd973a 8 * Software is furnished to do so, subject to the following conditions:
donatien 10:08bce4cd973a 9 *
donatien 10:08bce4cd973a 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 10:08bce4cd973a 11 * substantial portions of the Software.
donatien 10:08bce4cd973a 12 *
donatien 10:08bce4cd973a 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 10:08bce4cd973a 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 10:08bce4cd973a 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 10:08bce4cd973a 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 10:08bce4cd973a 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 0:ae46a0638b2c 18 */
donatien 0:ae46a0638b2c 19
donatien 0:ae46a0638b2c 20 #ifndef IUSBHOSTSERIAL_H_
donatien 0:ae46a0638b2c 21 #define IUSBHOSTSERIAL_H_
donatien 0:ae46a0638b2c 22
donatien 0:ae46a0638b2c 23 /**
donatien 0:ae46a0638b2c 24 * Generic interface to abstract 3G dongles' impl
donatien 0:ae46a0638b2c 25 */
donatien 0:ae46a0638b2c 26
donatien 0:ae46a0638b2c 27 #include "IUSBHostSerialListener.h"
donatien 0:ae46a0638b2c 28
donatien 0:ae46a0638b2c 29 class IUSBHostSerial {
donatien 0:ae46a0638b2c 30 public:
donatien 0:ae46a0638b2c 31
donatien 0:ae46a0638b2c 32 enum IrqType {
donatien 0:ae46a0638b2c 33 RxIrq,
donatien 0:ae46a0638b2c 34 TxIrq
donatien 0:ae46a0638b2c 35 };
donatien 0:ae46a0638b2c 36
donatien 0:ae46a0638b2c 37 /*
donatien 0:ae46a0638b2c 38 * Get a char from the dongle's serial interface
donatien 0:ae46a0638b2c 39 */
donatien 0:ae46a0638b2c 40 virtual int getc() = 0;
donatien 0:ae46a0638b2c 41
donatien 0:ae46a0638b2c 42 /*
donatien 0:ae46a0638b2c 43 * Put a char to the dongle's serial interface
donatien 0:ae46a0638b2c 44 */
donatien 0:ae46a0638b2c 45 virtual int putc(int c) = 0;
donatien 0:ae46a0638b2c 46
donatien 0:ae46a0638b2c 47 /*
donatien 0:ae46a0638b2c 48 * Read a packet from the dongle's serial interface, to be called after multiple getc() calls
donatien 0:ae46a0638b2c 49 */
donatien 0:ae46a0638b2c 50 virtual int readPacket() = 0;
donatien 0:ae46a0638b2c 51
donatien 0:ae46a0638b2c 52 /*
donatien 0:ae46a0638b2c 53 * Write a packet to the dongle's serial interface, to be called after multiple putc() calls
donatien 0:ae46a0638b2c 54 */
donatien 0:ae46a0638b2c 55 virtual int writePacket() = 0;
donatien 0:ae46a0638b2c 56
donatien 0:ae46a0638b2c 57 /**
donatien 0:ae46a0638b2c 58 * Check the number of bytes available.
donatien 0:ae46a0638b2c 59 *
donatien 0:ae46a0638b2c 60 * @returns the number of bytes available
donatien 0:ae46a0638b2c 61 */
donatien 0:ae46a0638b2c 62 virtual int readable() = 0;
donatien 0:ae46a0638b2c 63
donatien 0:ae46a0638b2c 64 /**
donatien 0:ae46a0638b2c 65 * Check the free space in output.
donatien 0:ae46a0638b2c 66 *
donatien 0:ae46a0638b2c 67 * @returns the number of bytes available
donatien 0:ae46a0638b2c 68 */
donatien 0:ae46a0638b2c 69 virtual int writeable() = 0;
donatien 0:ae46a0638b2c 70
donatien 0:ae46a0638b2c 71 /**
donatien 0:ae46a0638b2c 72 * Attach a handler to call when a packet is received / when a packet has been transmitted.
donatien 0:ae46a0638b2c 73 *
donatien 0:ae46a0638b2c 74 * @param pListener instance of the listener deriving from the IUSBHostSerialListener
donatien 0:ae46a0638b2c 75 */
donatien 0:ae46a0638b2c 76 virtual void attach(IUSBHostSerialListener* pListener) = 0;
donatien 0:ae46a0638b2c 77
donatien 0:ae46a0638b2c 78 /**
donatien 0:ae46a0638b2c 79 * Enable or disable readable/writeable callbacks
donatien 0:ae46a0638b2c 80 */
donatien 0:ae46a0638b2c 81 virtual void setupIrq(bool en, IrqType irq = RxIrq) = 0;
donatien 0:ae46a0638b2c 82
donatien 0:ae46a0638b2c 83 };
donatien 0:ae46a0638b2c 84
donatien 0:ae46a0638b2c 85 #endif /* IUSBHOSTSERIAL_H_ */