EL4121 Embedded System / mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/unsupported/USBHost/USBHost3GModule/WANDongle.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 WANDONGLE_H
be_bryan 0:b74591d5ab33 20 #define WANDONGLE_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 #include "WANDongleSerialPort.h"
be_bryan 0:b74591d5ab33 32 #include "WANDongleInitializer.h"
be_bryan 0:b74591d5ab33 33 #include "IUSBEnumerator.h"
be_bryan 0:b74591d5ab33 34
be_bryan 0:b74591d5ab33 35 #define WANDONGLE_MAX_OUTEP_SIZE 64
be_bryan 0:b74591d5ab33 36 #define WANDONGLE_MAX_INEP_SIZE 64
be_bryan 0:b74591d5ab33 37
be_bryan 0:b74591d5ab33 38 /** A class to use a WAN (3G/LTE) access dongle
be_bryan 0:b74591d5ab33 39 *
be_bryan 0:b74591d5ab33 40 */
be_bryan 0:b74591d5ab33 41 class WANDongle : public IUSBEnumerator {
be_bryan 0:b74591d5ab33 42 public:
be_bryan 0:b74591d5ab33 43 /*
be_bryan 0:b74591d5ab33 44 * Constructor
be_bryan 0:b74591d5ab33 45 *
be_bryan 0:b74591d5ab33 46 * @param rootdir mount name
be_bryan 0:b74591d5ab33 47 */
be_bryan 0:b74591d5ab33 48 WANDongle();
be_bryan 0:b74591d5ab33 49
be_bryan 0:b74591d5ab33 50 /*
be_bryan 0:b74591d5ab33 51 * Destructor
be_bryan 0:b74591d5ab33 52 */
be_bryan 0:b74591d5ab33 53 virtual ~WANDongle();
be_bryan 0:b74591d5ab33 54
be_bryan 0:b74591d5ab33 55 /*
be_bryan 0:b74591d5ab33 56 * Check if a serial port device is connected
be_bryan 0:b74591d5ab33 57 *
be_bryan 0:b74591d5ab33 58 * @return true if a serial device is connected
be_bryan 0:b74591d5ab33 59 */
be_bryan 0:b74591d5ab33 60 bool connected();
be_bryan 0:b74591d5ab33 61
be_bryan 0:b74591d5ab33 62 /*
be_bryan 0:b74591d5ab33 63 * Try to connect device
be_bryan 0:b74591d5ab33 64 *
be_bryan 0:b74591d5ab33 65 * * @return true if connection was successful
be_bryan 0:b74591d5ab33 66 */
be_bryan 0:b74591d5ab33 67 bool tryConnect();
be_bryan 0:b74591d5ab33 68
be_bryan 0:b74591d5ab33 69 /*
be_bryan 0:b74591d5ab33 70 * Disconnect device
be_bryan 0:b74591d5ab33 71 *
be_bryan 0:b74591d5ab33 72 * * @return true if disconnection was successful
be_bryan 0:b74591d5ab33 73 */
be_bryan 0:b74591d5ab33 74 bool disconnect();
be_bryan 0:b74591d5ab33 75
be_bryan 0:b74591d5ab33 76 int getDongleType();
be_bryan 0:b74591d5ab33 77
be_bryan 0:b74591d5ab33 78 IUSBHostSerial& getSerial(int index);
be_bryan 0:b74591d5ab33 79 int getSerialCount();
be_bryan 0:b74591d5ab33 80 bool addInitializer(WANDongleInitializer* pInitializer);
be_bryan 0:b74591d5ab33 81
be_bryan 0:b74591d5ab33 82 //From IUSBEnumerator
be_bryan 0:b74591d5ab33 83
be_bryan 0:b74591d5ab33 84 virtual void setVidPid(uint16_t vid, uint16_t pid);
be_bryan 0:b74591d5ab33 85
be_bryan 0:b74591d5ab33 86 virtual bool parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol); //Must return true if the interface should be parsed
be_bryan 0:b74591d5ab33 87
be_bryan 0:b74591d5ab33 88 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
be_bryan 0:b74591d5ab33 89
be_bryan 0:b74591d5ab33 90 protected:
be_bryan 0:b74591d5ab33 91 USBHost * host;
be_bryan 0:b74591d5ab33 92 USBDeviceConnected * dev;
be_bryan 0:b74591d5ab33 93 bool dev_connected;
be_bryan 0:b74591d5ab33 94
be_bryan 0:b74591d5ab33 95 WANDongleInitializer* m_pInitializer;
be_bryan 0:b74591d5ab33 96
be_bryan 0:b74591d5ab33 97 void init();
be_bryan 0:b74591d5ab33 98
be_bryan 0:b74591d5ab33 99 WANDongleSerialPort m_serial[WANDONGLE_MAX_SERIAL_PORTS];
be_bryan 0:b74591d5ab33 100 int m_serialCount;
be_bryan 0:b74591d5ab33 101
be_bryan 0:b74591d5ab33 102 int m_totalInitializers;
be_bryan 0:b74591d5ab33 103 WANDongleInitializer* m_Initializers[WANDONGLE_MAX_INITIALIZERS];
be_bryan 0:b74591d5ab33 104 };
be_bryan 0:b74591d5ab33 105
be_bryan 0:b74591d5ab33 106 #endif /* USBHOST_3GMODULE */
be_bryan 0:b74591d5ab33 107
be_bryan 0:b74591d5ab33 108 #endif