Dylan Saada / Mbed 2 deprecated telemetre2

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.

Dependencies:   mbed

USBHost/USBHost3GModule/WANDongle.h@0:6ce9c65992e5, 2015-04-15 (annotated)

Committer:
dylancachan
Date:
Wed Apr 15 06:23:18 2015 +0000
Revision:
0:6ce9c65992e5
telemetre

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dylancachan 0:6ce9c65992e5 1 /* Copyright (c) 2010-2012 mbed.org, MIT License
dylancachan 0:6ce9c65992e5 2 *
dylancachan 0:6ce9c65992e5 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
dylancachan 0:6ce9c65992e5 4 * and associated documentation files (the "Software"), to deal in the Software without
dylancachan 0:6ce9c65992e5 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
dylancachan 0:6ce9c65992e5 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
dylancachan 0:6ce9c65992e5 7 * Software is furnished to do so, subject to the following conditions:
dylancachan 0:6ce9c65992e5 8 *
dylancachan 0:6ce9c65992e5 9 * The above copyright notice and this permission notice shall be included in all copies or
dylancachan 0:6ce9c65992e5 10 * substantial portions of the Software.
dylancachan 0:6ce9c65992e5 11 *
dylancachan 0:6ce9c65992e5 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
dylancachan 0:6ce9c65992e5 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
dylancachan 0:6ce9c65992e5 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
dylancachan 0:6ce9c65992e5 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
dylancachan 0:6ce9c65992e5 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
dylancachan 0:6ce9c65992e5 17 */
dylancachan 0:6ce9c65992e5 18
dylancachan 0:6ce9c65992e5 19 #ifndef WANDONGLE_H
dylancachan 0:6ce9c65992e5 20 #define WANDONGLE_H
dylancachan 0:6ce9c65992e5 21
dylancachan 0:6ce9c65992e5 22 #include "USBHostConf.h"
dylancachan 0:6ce9c65992e5 23
dylancachan 0:6ce9c65992e5 24 #ifdef USBHOST_3GMODULE
dylancachan 0:6ce9c65992e5 25
dylancachan 0:6ce9c65992e5 26 #include "USBHost.h"
dylancachan 0:6ce9c65992e5 27 #include "IUSBHostSerial.h"
dylancachan 0:6ce9c65992e5 28
dylancachan 0:6ce9c65992e5 29 #include "rtos.h"
dylancachan 0:6ce9c65992e5 30
dylancachan 0:6ce9c65992e5 31 #include "WANDongleSerialPort.h"
dylancachan 0:6ce9c65992e5 32 #include "WANDongleInitializer.h"
dylancachan 0:6ce9c65992e5 33 #include "IUSBEnumerator.h"
dylancachan 0:6ce9c65992e5 34
dylancachan 0:6ce9c65992e5 35 #define WANDONGLE_MAX_OUTEP_SIZE 64
dylancachan 0:6ce9c65992e5 36 #define WANDONGLE_MAX_INEP_SIZE 64
dylancachan 0:6ce9c65992e5 37
dylancachan 0:6ce9c65992e5 38 /** A class to use a WAN (3G/LTE) access dongle
dylancachan 0:6ce9c65992e5 39 *
dylancachan 0:6ce9c65992e5 40 */
dylancachan 0:6ce9c65992e5 41 class WANDongle : public IUSBEnumerator {
dylancachan 0:6ce9c65992e5 42 public:
dylancachan 0:6ce9c65992e5 43 /*
dylancachan 0:6ce9c65992e5 44 * Constructor
dylancachan 0:6ce9c65992e5 45 *
dylancachan 0:6ce9c65992e5 46 * @param rootdir mount name
dylancachan 0:6ce9c65992e5 47 */
dylancachan 0:6ce9c65992e5 48 WANDongle();
dylancachan 0:6ce9c65992e5 49
dylancachan 0:6ce9c65992e5 50 /*
dylancachan 0:6ce9c65992e5 51 * Destructor
dylancachan 0:6ce9c65992e5 52 */
dylancachan 0:6ce9c65992e5 53 virtual ~WANDongle();
dylancachan 0:6ce9c65992e5 54
dylancachan 0:6ce9c65992e5 55 /*
dylancachan 0:6ce9c65992e5 56 * Check if a serial port device is connected
dylancachan 0:6ce9c65992e5 57 *
dylancachan 0:6ce9c65992e5 58 * @return true if a serial device is connected
dylancachan 0:6ce9c65992e5 59 */
dylancachan 0:6ce9c65992e5 60 bool connected();
dylancachan 0:6ce9c65992e5 61
dylancachan 0:6ce9c65992e5 62 /*
dylancachan 0:6ce9c65992e5 63 * Try to connect device
dylancachan 0:6ce9c65992e5 64 *
dylancachan 0:6ce9c65992e5 65 * * @return true if connection was successful
dylancachan 0:6ce9c65992e5 66 */
dylancachan 0:6ce9c65992e5 67 bool tryConnect();
dylancachan 0:6ce9c65992e5 68
dylancachan 0:6ce9c65992e5 69 /*
dylancachan 0:6ce9c65992e5 70 * Disconnect device
dylancachan 0:6ce9c65992e5 71 *
dylancachan 0:6ce9c65992e5 72 * * @return true if disconnection was successful
dylancachan 0:6ce9c65992e5 73 */
dylancachan 0:6ce9c65992e5 74 bool disconnect();
dylancachan 0:6ce9c65992e5 75
dylancachan 0:6ce9c65992e5 76 int getDongleType();
dylancachan 0:6ce9c65992e5 77
dylancachan 0:6ce9c65992e5 78 IUSBHostSerial& getSerial(int index);
dylancachan 0:6ce9c65992e5 79 int getSerialCount();
dylancachan 0:6ce9c65992e5 80 bool addInitializer(WANDongleInitializer* pInitializer);
dylancachan 0:6ce9c65992e5 81
dylancachan 0:6ce9c65992e5 82 //From IUSBEnumerator
dylancachan 0:6ce9c65992e5 83
dylancachan 0:6ce9c65992e5 84 virtual void setVidPid(uint16_t vid, uint16_t pid);
dylancachan 0:6ce9c65992e5 85
dylancachan 0:6ce9c65992e5 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
dylancachan 0:6ce9c65992e5 87
dylancachan 0:6ce9c65992e5 88 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
dylancachan 0:6ce9c65992e5 89
dylancachan 0:6ce9c65992e5 90 protected:
dylancachan 0:6ce9c65992e5 91 USBHost * host;
dylancachan 0:6ce9c65992e5 92 USBDeviceConnected * dev;
dylancachan 0:6ce9c65992e5 93 bool dev_connected;
dylancachan 0:6ce9c65992e5 94
dylancachan 0:6ce9c65992e5 95 WANDongleInitializer* m_pInitializer;
dylancachan 0:6ce9c65992e5 96
dylancachan 0:6ce9c65992e5 97 void init();
dylancachan 0:6ce9c65992e5 98
dylancachan 0:6ce9c65992e5 99 WANDongleSerialPort m_serial[WANDONGLE_MAX_SERIAL_PORTS];
dylancachan 0:6ce9c65992e5 100 int m_serialCount;
dylancachan 0:6ce9c65992e5 101
dylancachan 0:6ce9c65992e5 102 int m_totalInitializers;
dylancachan 0:6ce9c65992e5 103 WANDongleInitializer* m_Initializers[WANDONGLE_MAX_INITIALIZERS];
dylancachan 0:6ce9c65992e5 104 };
dylancachan 0:6ce9c65992e5 105
dylancachan 0:6ce9c65992e5 106 #endif /* USBHOST_3GMODULE */
dylancachan 0:6ce9c65992e5 107
dylancachan 0:6ce9c65992e5 108 #endif