mbed official / USBHostWANDongle

USB Host WAN Dongle library

Fork of USBHostWANDongle_bleedingedge by Donatien Garnier

USB3GModule/WANDongleInitializer.h@21:dcc8c866ccbb, 2012-12-18 (annotated)

Committer:
ashleymills
Date:
Tue Dec 18 13:56:10 2012 +0000
Revision:
21:dcc8c866ccbb
Parent:
20:3abcf818be31
Child:
22:bec61bcc9c25
Adding MU509 support;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 10:08bce4cd973a 1 /* Copyright (c) 2010-2012 mbed.org, MIT License
donatien 8:0d1ec493842c 2 *
donatien 8:0d1ec493842c 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 8:0d1ec493842c 4 * and associated documentation files (the "Software"), to deal in the Software without
donatien 8:0d1ec493842c 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
donatien 8:0d1ec493842c 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
donatien 8:0d1ec493842c 7 * Software is furnished to do so, subject to the following conditions:
donatien 8:0d1ec493842c 8 *
donatien 8:0d1ec493842c 9 * The above copyright notice and this permission notice shall be included in all copies or
donatien 8:0d1ec493842c 10 * substantial portions of the Software.
donatien 8:0d1ec493842c 11 *
donatien 8:0d1ec493842c 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 8:0d1ec493842c 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 8:0d1ec493842c 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 8:0d1ec493842c 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 8:0d1ec493842c 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 8:0d1ec493842c 17 */
donatien 8:0d1ec493842c 18
donatien 8:0d1ec493842c 19 #ifndef WANDONGLEINITIALIZER_H
donatien 8:0d1ec493842c 20 #define WANDONGLEINITIALIZER_H
donatien 8:0d1ec493842c 21
donatien 8:0d1ec493842c 22 #include <cstdint>
donatien 8:0d1ec493842c 23 using std::uint16_t;
donatien 8:0d1ec493842c 24 using std::uint32_t;
donatien 8:0d1ec493842c 25
donatien 8:0d1ec493842c 26 #include "USBHost.h"
donatien 8:0d1ec493842c 27 #include "IUSBEnumerator.h"
donatien 8:0d1ec493842c 28
donatien 8:0d1ec493842c 29 enum WAN_DONGLE_TYPE
donatien 8:0d1ec493842c 30 {
donatien 8:0d1ec493842c 31 WAN_DONGLE_TYPE_UNKNOWN = -1,
donatien 8:0d1ec493842c 32 WAN_DONGLE_TYPE_VODAFONEK3770 = 0,
donatien 8:0d1ec493842c 33 WAN_DONGLE_TYPE_VODAFONEK3772Z = 1,
ashleymills 20:3abcf818be31 34 WAN_DONGLE_TYPE_VODAFONEK3773 = 2,
ashleymills 21:dcc8c866ccbb 35 WAN_DONGLE_TYPE_VODAFONEMU509 = 3,
donatien 8:0d1ec493842c 36 };
donatien 8:0d1ec493842c 37
donatien 8:0d1ec493842c 38 class WANDongleInitializer : public IUSBEnumerator
donatien 8:0d1ec493842c 39 {
donatien 8:0d1ec493842c 40 protected:
donatien 8:0d1ec493842c 41 WANDongleInitializer(USBHost* pHost);
donatien 8:0d1ec493842c 42 USBHost* m_pHost;
donatien 8:0d1ec493842c 43
donatien 8:0d1ec493842c 44 public:
donatien 8:0d1ec493842c 45 virtual uint16_t getMSDVid() = 0;
donatien 8:0d1ec493842c 46 virtual uint16_t getMSDPid() = 0;
donatien 8:0d1ec493842c 47
donatien 8:0d1ec493842c 48 virtual uint16_t getSerialVid() = 0;
donatien 8:0d1ec493842c 49 virtual uint16_t getSerialPid() = 0;
donatien 8:0d1ec493842c 50
donatien 8:0d1ec493842c 51 virtual bool switchMode(USBDeviceConnected* pDev) = 0;
donatien 8:0d1ec493842c 52
donatien 9:c9e9817c398c 53 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx) = 0;
donatien 8:0d1ec493842c 54
donatien 8:0d1ec493842c 55 virtual int getSerialPortCount() = 0;
donatien 8:0d1ec493842c 56
donatien 8:0d1ec493842c 57 virtual void setVidPid(uint16_t vid, uint16_t pid) = 0;
donatien 8:0d1ec493842c 58
donatien 8:0d1ec493842c 59 virtual bool parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol) = 0; //Must return true if the interface should be parsed
donatien 8:0d1ec493842c 60
donatien 8:0d1ec493842c 61 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir) = 0; //Must return true if the endpoint will be used
donatien 8:0d1ec493842c 62
donatien 8:0d1ec493842c 63 virtual WAN_DONGLE_TYPE getType() = 0;
donatien 8:0d1ec493842c 64
donatien 8:0d1ec493842c 65 static WANDongleInitializer** getInitializers(USBHost* pHost);
donatien 8:0d1ec493842c 66 };
donatien 8:0d1ec493842c 67
donatien 8:0d1ec493842c 68 class VodafoneK3770Initializer : public WANDongleInitializer
donatien 8:0d1ec493842c 69 {
donatien 8:0d1ec493842c 70 public:
donatien 8:0d1ec493842c 71 VodafoneK3770Initializer(USBHost* pHost);
donatien 8:0d1ec493842c 72
donatien 8:0d1ec493842c 73 virtual uint16_t getMSDVid();
donatien 8:0d1ec493842c 74 virtual uint16_t getMSDPid();
donatien 8:0d1ec493842c 75
donatien 8:0d1ec493842c 76 virtual uint16_t getSerialVid();
donatien 8:0d1ec493842c 77 virtual uint16_t getSerialPid();
donatien 8:0d1ec493842c 78
donatien 8:0d1ec493842c 79 virtual bool switchMode(USBDeviceConnected* pDev);
donatien 8:0d1ec493842c 80
donatien 9:c9e9817c398c 81 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
donatien 8:0d1ec493842c 82
donatien 8:0d1ec493842c 83 virtual int getSerialPortCount();
donatien 8:0d1ec493842c 84
donatien 8:0d1ec493842c 85 virtual void setVidPid(uint16_t vid, uint16_t pid);
donatien 8:0d1ec493842c 86
donatien 8:0d1ec493842c 87 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
donatien 8:0d1ec493842c 88
donatien 8:0d1ec493842c 89 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
donatien 8:0d1ec493842c 90
donatien 8:0d1ec493842c 91 virtual WAN_DONGLE_TYPE getType();
donatien 8:0d1ec493842c 92
donatien 8:0d1ec493842c 93 private:
donatien 8:0d1ec493842c 94
donatien 8:0d1ec493842c 95 bool m_hasSwitched;
donatien 8:0d1ec493842c 96 int m_currentSerialIntf;
donatien 8:0d1ec493842c 97 int m_endpointsToFetch;
donatien 8:0d1ec493842c 98 };
donatien 8:0d1ec493842c 99
ashleymills 20:3abcf818be31 100 class VodafoneK3773Initializer : public WANDongleInitializer
ashleymills 20:3abcf818be31 101 {
ashleymills 20:3abcf818be31 102 public:
ashleymills 20:3abcf818be31 103 VodafoneK3773Initializer(USBHost* pHost);
ashleymills 20:3abcf818be31 104
ashleymills 20:3abcf818be31 105 virtual uint16_t getMSDVid();
ashleymills 20:3abcf818be31 106 virtual uint16_t getMSDPid();
ashleymills 20:3abcf818be31 107
ashleymills 20:3abcf818be31 108 virtual uint16_t getSerialVid();
ashleymills 20:3abcf818be31 109 virtual uint16_t getSerialPid();
ashleymills 20:3abcf818be31 110
ashleymills 20:3abcf818be31 111 virtual bool switchMode(USBDeviceConnected* pDev);
ashleymills 20:3abcf818be31 112
ashleymills 20:3abcf818be31 113 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
ashleymills 20:3abcf818be31 114
ashleymills 20:3abcf818be31 115 virtual int getSerialPortCount();
ashleymills 20:3abcf818be31 116
ashleymills 20:3abcf818be31 117 virtual void setVidPid(uint16_t vid, uint16_t pid);
ashleymills 20:3abcf818be31 118
ashleymills 20:3abcf818be31 119 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
ashleymills 20:3abcf818be31 120
ashleymills 20:3abcf818be31 121 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
ashleymills 20:3abcf818be31 122
ashleymills 20:3abcf818be31 123 virtual WAN_DONGLE_TYPE getType();
ashleymills 20:3abcf818be31 124
ashleymills 20:3abcf818be31 125 private:
ashleymills 20:3abcf818be31 126
ashleymills 20:3abcf818be31 127 bool m_hasSwitched;
ashleymills 20:3abcf818be31 128 int m_currentSerialIntf;
ashleymills 20:3abcf818be31 129 int m_endpointsToFetch;
ashleymills 20:3abcf818be31 130 };
ashleymills 20:3abcf818be31 131
donatien 8:0d1ec493842c 132 class VodafoneK3772ZInitializer : public WANDongleInitializer
donatien 8:0d1ec493842c 133 {
donatien 8:0d1ec493842c 134 public:
donatien 8:0d1ec493842c 135 VodafoneK3772ZInitializer(USBHost* pHost);
donatien 8:0d1ec493842c 136
donatien 8:0d1ec493842c 137 virtual uint16_t getMSDVid();
donatien 8:0d1ec493842c 138 virtual uint16_t getMSDPid();
donatien 8:0d1ec493842c 139
donatien 8:0d1ec493842c 140 virtual uint16_t getSerialVid();
donatien 8:0d1ec493842c 141 virtual uint16_t getSerialPid();
donatien 8:0d1ec493842c 142
donatien 8:0d1ec493842c 143 virtual bool switchMode(USBDeviceConnected* pDev);
donatien 8:0d1ec493842c 144
donatien 9:c9e9817c398c 145 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
donatien 8:0d1ec493842c 146
donatien 8:0d1ec493842c 147 virtual int getSerialPortCount();
donatien 8:0d1ec493842c 148
donatien 8:0d1ec493842c 149 virtual void setVidPid(uint16_t vid, uint16_t pid);
donatien 8:0d1ec493842c 150
donatien 8:0d1ec493842c 151 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
donatien 8:0d1ec493842c 152
donatien 8:0d1ec493842c 153 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
donatien 8:0d1ec493842c 154
donatien 8:0d1ec493842c 155 virtual WAN_DONGLE_TYPE getType();
donatien 8:0d1ec493842c 156
donatien 8:0d1ec493842c 157 private:
donatien 8:0d1ec493842c 158
donatien 8:0d1ec493842c 159 bool m_hasSwitched;
donatien 8:0d1ec493842c 160 int m_currentSerialIntf;
donatien 8:0d1ec493842c 161 int m_endpointsToFetch;
donatien 8:0d1ec493842c 162 };
donatien 8:0d1ec493842c 163
ashleymills 21:dcc8c866ccbb 164 class VodafoneMU509Initializer : public WANDongleInitializer
ashleymills 21:dcc8c866ccbb 165 {
ashleymills 21:dcc8c866ccbb 166 public:
ashleymills 21:dcc8c866ccbb 167 VodafoneMU509Initializer(USBHost* pHost);
ashleymills 21:dcc8c866ccbb 168
ashleymills 21:dcc8c866ccbb 169 virtual uint16_t getMSDVid();
ashleymills 21:dcc8c866ccbb 170 virtual uint16_t getMSDPid();
ashleymills 21:dcc8c866ccbb 171
ashleymills 21:dcc8c866ccbb 172 virtual uint16_t getSerialVid();
ashleymills 21:dcc8c866ccbb 173 virtual uint16_t getSerialPid();
ashleymills 21:dcc8c866ccbb 174
ashleymills 21:dcc8c866ccbb 175 virtual bool switchMode(USBDeviceConnected* pDev);
ashleymills 21:dcc8c866ccbb 176
ashleymills 21:dcc8c866ccbb 177 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
ashleymills 21:dcc8c866ccbb 178
ashleymills 21:dcc8c866ccbb 179 virtual int getSerialPortCount();
ashleymills 21:dcc8c866ccbb 180
ashleymills 21:dcc8c866ccbb 181 virtual void setVidPid(uint16_t vid, uint16_t pid);
ashleymills 21:dcc8c866ccbb 182
ashleymills 21:dcc8c866ccbb 183 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
ashleymills 21:dcc8c866ccbb 184
ashleymills 21:dcc8c866ccbb 185 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
ashleymills 21:dcc8c866ccbb 186
ashleymills 21:dcc8c866ccbb 187 virtual WAN_DONGLE_TYPE getType();
ashleymills 21:dcc8c866ccbb 188
ashleymills 21:dcc8c866ccbb 189 private:
ashleymills 21:dcc8c866ccbb 190
ashleymills 21:dcc8c866ccbb 191 bool m_hasSwitched;
ashleymills 21:dcc8c866ccbb 192 int m_currentSerialIntf;
ashleymills 21:dcc8c866ccbb 193 int m_endpointsToFetch;
ashleymills 21:dcc8c866ccbb 194 };
ashleymills 21:dcc8c866ccbb 195
donatien 8:0d1ec493842c 196 #endif