z ysaito / USBHost2

2018.07.26

Dependencies:   FATFileSystem2 mbed-rtos

Fork of USBHost by mbed official

USBHost3GModule/WANDongleSerialPort.h@43:78f328f311dc, 2018-07-26 (annotated)

Committer:
sayzyas
Date:
Thu Jul 26 00:19:16 2018 +0000
Revision:
43:78f328f311dc
2018.07.26

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sayzyas 43:78f328f311dc 1 /* Copyright (c) 2010-2012 mbed.org, MIT License
sayzyas 43:78f328f311dc 2 *
sayzyas 43:78f328f311dc 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
sayzyas 43:78f328f311dc 4 * and associated documentation files (the "Software"), to deal in the Software without
sayzyas 43:78f328f311dc 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
sayzyas 43:78f328f311dc 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
sayzyas 43:78f328f311dc 7 * Software is furnished to do so, subject to the following conditions:
sayzyas 43:78f328f311dc 8 *
sayzyas 43:78f328f311dc 9 * The above copyright notice and this permission notice shall be included in all copies or
sayzyas 43:78f328f311dc 10 * substantial portions of the Software.
sayzyas 43:78f328f311dc 11 *
sayzyas 43:78f328f311dc 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
sayzyas 43:78f328f311dc 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
sayzyas 43:78f328f311dc 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
sayzyas 43:78f328f311dc 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
sayzyas 43:78f328f311dc 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
sayzyas 43:78f328f311dc 17 */
sayzyas 43:78f328f311dc 18
sayzyas 43:78f328f311dc 19 #ifndef WANDONGLESERIALPORT_H
sayzyas 43:78f328f311dc 20 #define WANDONGLESERIALPORT_H
sayzyas 43:78f328f311dc 21
sayzyas 43:78f328f311dc 22 #include "USBHostConf.h"
sayzyas 43:78f328f311dc 23
sayzyas 43:78f328f311dc 24 #ifdef USBHOST_3GMODULE
sayzyas 43:78f328f311dc 25
sayzyas 43:78f328f311dc 26 #include "USBHost.h"
sayzyas 43:78f328f311dc 27 #include "IUSBHostSerial.h"
sayzyas 43:78f328f311dc 28
sayzyas 43:78f328f311dc 29 #include "rtos.h"
sayzyas 43:78f328f311dc 30
sayzyas 43:78f328f311dc 31
sayzyas 43:78f328f311dc 32 #define WANDONGLE_MAX_OUTEP_SIZE 64
sayzyas 43:78f328f311dc 33 #define WANDONGLE_MAX_INEP_SIZE 64
sayzyas 43:78f328f311dc 34
sayzyas 43:78f328f311dc 35 /** A class to use a WAN (3G/LTE) access dongle
sayzyas 43:78f328f311dc 36 *
sayzyas 43:78f328f311dc 37 */
sayzyas 43:78f328f311dc 38 class WANDongleSerialPort : public IUSBHostSerial {
sayzyas 43:78f328f311dc 39 public:
sayzyas 43:78f328f311dc 40 /*
sayzyas 43:78f328f311dc 41 * Constructor
sayzyas 43:78f328f311dc 42 *
sayzyas 43:78f328f311dc 43 */
sayzyas 43:78f328f311dc 44 WANDongleSerialPort();
sayzyas 43:78f328f311dc 45
sayzyas 43:78f328f311dc 46 void init( USBHost* pHost );
sayzyas 43:78f328f311dc 47
sayzyas 43:78f328f311dc 48 void connect( USBDeviceConnected* pDev, USBEndpoint* pInEp, USBEndpoint* pOutEp );
sayzyas 43:78f328f311dc 49
sayzyas 43:78f328f311dc 50 void disconnect( );
sayzyas 43:78f328f311dc 51
sayzyas 43:78f328f311dc 52 /*
sayzyas 43:78f328f311dc 53 * Get a char from the dongle's serial interface
sayzyas 43:78f328f311dc 54 */
sayzyas 43:78f328f311dc 55 virtual int getc();
sayzyas 43:78f328f311dc 56
sayzyas 43:78f328f311dc 57 /*
sayzyas 43:78f328f311dc 58 * Put a char to the dongle's serial interface
sayzyas 43:78f328f311dc 59 */
sayzyas 43:78f328f311dc 60 virtual int putc(int c);
sayzyas 43:78f328f311dc 61
sayzyas 43:78f328f311dc 62 /*
sayzyas 43:78f328f311dc 63 * Read a packet from the dongle's serial interface, to be called after multiple getc() calls
sayzyas 43:78f328f311dc 64 */
sayzyas 43:78f328f311dc 65 virtual int readPacket();
sayzyas 43:78f328f311dc 66
sayzyas 43:78f328f311dc 67 /*
sayzyas 43:78f328f311dc 68 * Write a packet to the dongle's serial interface, to be called after multiple putc() calls
sayzyas 43:78f328f311dc 69 */
sayzyas 43:78f328f311dc 70 virtual int writePacket();
sayzyas 43:78f328f311dc 71
sayzyas 43:78f328f311dc 72 /**
sayzyas 43:78f328f311dc 73 * Check the number of bytes available.
sayzyas 43:78f328f311dc 74 *
sayzyas 43:78f328f311dc 75 * @returns the number of bytes available
sayzyas 43:78f328f311dc 76 */
sayzyas 43:78f328f311dc 77 virtual int readable();
sayzyas 43:78f328f311dc 78
sayzyas 43:78f328f311dc 79 /**
sayzyas 43:78f328f311dc 80 * Check the free space in output.
sayzyas 43:78f328f311dc 81 *
sayzyas 43:78f328f311dc 82 * @returns the number of bytes available
sayzyas 43:78f328f311dc 83 */
sayzyas 43:78f328f311dc 84 virtual int writeable();
sayzyas 43:78f328f311dc 85
sayzyas 43:78f328f311dc 86 /**
sayzyas 43:78f328f311dc 87 * Attach a handler to call when a packet is received / when a packet has been transmitted.
sayzyas 43:78f328f311dc 88 *
sayzyas 43:78f328f311dc 89 * @param pListener instance of the listener deriving from the IUSBHostSerialListener
sayzyas 43:78f328f311dc 90 */
sayzyas 43:78f328f311dc 91 virtual void attach(IUSBHostSerialListener* pListener);
sayzyas 43:78f328f311dc 92
sayzyas 43:78f328f311dc 93 /**
sayzyas 43:78f328f311dc 94 * Enable or disable readable/writeable callbacks
sayzyas 43:78f328f311dc 95 */
sayzyas 43:78f328f311dc 96 virtual void setupIrq(bool en, IrqType irq = RxIrq);
sayzyas 43:78f328f311dc 97
sayzyas 43:78f328f311dc 98
sayzyas 43:78f328f311dc 99 protected:
sayzyas 43:78f328f311dc 100 USBEndpoint * bulk_in;
sayzyas 43:78f328f311dc 101 USBEndpoint * bulk_out;
sayzyas 43:78f328f311dc 102 USBHost * host;
sayzyas 43:78f328f311dc 103 USBDeviceConnected * dev;
sayzyas 43:78f328f311dc 104
sayzyas 43:78f328f311dc 105 uint8_t buf_out[WANDONGLE_MAX_OUTEP_SIZE];
sayzyas 43:78f328f311dc 106 volatile uint32_t buf_out_len;
sayzyas 43:78f328f311dc 107 uint32_t max_out_size;
sayzyas 43:78f328f311dc 108 volatile bool lock_tx;
sayzyas 43:78f328f311dc 109 volatile bool cb_tx_en;
sayzyas 43:78f328f311dc 110 volatile bool cb_tx_pending;
sayzyas 43:78f328f311dc 111 Mutex tx_mtx;
sayzyas 43:78f328f311dc 112
sayzyas 43:78f328f311dc 113 uint8_t buf_in[WANDONGLE_MAX_INEP_SIZE];
sayzyas 43:78f328f311dc 114 volatile uint32_t buf_in_len;
sayzyas 43:78f328f311dc 115 volatile uint32_t buf_in_read_pos;
sayzyas 43:78f328f311dc 116 volatile bool lock_rx;
sayzyas 43:78f328f311dc 117 volatile bool cb_rx_en;
sayzyas 43:78f328f311dc 118 volatile bool cb_rx_pending;
sayzyas 43:78f328f311dc 119 Mutex rx_mtx;
sayzyas 43:78f328f311dc 120
sayzyas 43:78f328f311dc 121 IUSBHostSerialListener* listener;
sayzyas 43:78f328f311dc 122
sayzyas 43:78f328f311dc 123 void reset();
sayzyas 43:78f328f311dc 124
sayzyas 43:78f328f311dc 125 void rxHandler();
sayzyas 43:78f328f311dc 126 void txHandler();
sayzyas 43:78f328f311dc 127
sayzyas 43:78f328f311dc 128 };
sayzyas 43:78f328f311dc 129
sayzyas 43:78f328f311dc 130 #endif /* USBHOST_3GMODULE */
sayzyas 43:78f328f311dc 131
sayzyas 43:78f328f311dc 132 #endif
sayzyas 43:78f328f311dc 133