Kentaro Sekimoto / USBHost

To support GR-PEACH

Fork of USBHost by mbed official

USBHost3GModule/IUSBHostSerial.h@17:c7b1b8451598, 2013-10-16 (annotated)

Committer:
mbed_official
Date:
Wed Oct 16 14:15:18 2013 +0100
Revision:
17:c7b1b8451598
Child:
18:37c948cf0dbf
Synchronized with git revision d8c3822c4c4e995cd7eaff0ce99f2d3284dde9cd

Who changed what in which revision?

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