Dylan Saada / Mbed 2 deprecated telemetre2

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.

Dependencies:   mbed

USBHost/USBHost3GModule/IUSBHostSerial.h@0:6ce9c65992e5, 2015-04-15 (annotated)

Committer:
dylancachan
Date:
Wed Apr 15 06:23:18 2015 +0000
Revision:
0:6ce9c65992e5
telemetre

Who changed what in which revision?

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