EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/unsupported/USBHost/USBHost3GModule/WANDongleSerialPort.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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