Donatien Garnier / VodafoneUSBModem

Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket

This library is deprecated. Please use the newest production branch of the library from https://mbed.org/users/mbed_official/code/VodafoneUSBModem/

USBHostWANDongleLib/USB3GModule/WANDongleSerialPort.h@0:bd5343539e38, 2012-08-17 (annotated)

Committer:
donatien
Date:
Fri Aug 17 15:21:55 2012 +0000
Revision:
0:bd5343539e38
Initial public commit

Who changed what in which revision?

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