Suga koubou / Mbed 2 deprecated XTouch-djay-bridge

X-TOUCH to djay bridge

Dependencies:   mbed mbed-rtos FATFileSystem

USBHost/USBHost3GModule/IUSBHostSerial.h@1:0dac72ab5910, 2019-06-05 (annotated)

Committer:
okini3939
Date:
Wed Jun 05 04:54:37 2019 +0000
Revision:
1:0dac72ab5910
sample

Who changed what in which revision?

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