mbed official / USBHost

USBHost library. NOTE: This library is only officially supported on the LPC1768 platform. For more information, please see the handbook page.

Dependencies:   FATFileSystem mbed-rtos

Dependents:   BTstack WallbotWii SD to Flash Data Transfer USBHost-MSD_HelloWorld ... more

Legacy Warning

This is an mbed 2 library. To learn more about mbed OS 5, visit the docs.

Pull requests against this repository are no longer supported. Please raise against mbed OS 5 as documented above.

USBHost3GModule/WANDongle.h@24:868cbfe611a7, 2014-06-03 (annotated)

Committer:
mbed_official
Date:
Tue Jun 03 11:30:38 2014 +0100
Revision:
24:868cbfe611a7
Parent:
17:c7b1b8451598 
Synchronized with git revision bcacbb9fbf3432829227430830cca4315b57c1b9



Full URL: https://github.com/mbedmicro/mbed/commit/bcacbb9fbf3432829227430830cca4315b57c1b9/

Who changed what in which revision?

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