ON Semiconductor / mbed-os

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.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/unsupported/USBHost/USBHost3GModule/WANDongleSerialPort.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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