Dmitry Pakhomenko / USBHostWANDongle

Changes to support Vodafone K4606

Dependents:   VodafoneUSBModem

Fork of USBHostWANDongle by mbed official

USB3GModule/WANDongleInitializer.h@28:34cdecfff9f4, 2015-01-28 (annotated)

Committer:
dmitryp
Date:
Wed Jan 28 11:38:44 2015 +0000
Revision:
28:34cdecfff9f4
Parent:
27:980fe31c14f7 
Added support for Vodafone K4606, for more details refer to ; http://atmega.magictale.com/2215/hacking-vodafone-k4606-3g-hsdpa-usb-modem/

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 {
ashleymills 27:980fe31c14f7 31 WAN_DONGLE_TYPE_UNKNOWN = -1,
ashleymills 27:980fe31c14f7 32 WAN_DONGLE_TYPE_VODAFONE_K3770 = 0,
ashleymills 27:980fe31c14f7 33 WAN_DONGLE_TYPE_VODAFONE_K3772Z = 1,
ashleymills 27:980fe31c14f7 34 WAN_DONGLE_TYPE_VODAFONE_K3772 = 2,
ashleymills 27:980fe31c14f7 35 WAN_DONGLE_TYPE_VODAFONE_K3773 = 3,
ashleymills 27:980fe31c14f7 36 WAN_DONGLE_TYPE_HUAWEI_MU509 = 4,
dmitryp 28:34cdecfff9f4 37 WAN_DONGLE_TYPE_UBLOX_LISAU200 = 5,
dmitryp 28:34cdecfff9f4 38 WAN_DONGLE_TYPE_VODAFONE_K4606 = 6
donatien 8:0d1ec493842c 39 };
donatien 8:0d1ec493842c 40
donatien 8:0d1ec493842c 41 class WANDongleInitializer : public IUSBEnumerator
donatien 8:0d1ec493842c 42 {
donatien 8:0d1ec493842c 43 protected:
donatien 8:0d1ec493842c 44 WANDongleInitializer(USBHost* pHost);
donatien 8:0d1ec493842c 45 USBHost* m_pHost;
donatien 8:0d1ec493842c 46
donatien 8:0d1ec493842c 47 public:
donatien 8:0d1ec493842c 48 virtual uint16_t getMSDVid() = 0;
donatien 8:0d1ec493842c 49 virtual uint16_t getMSDPid() = 0;
donatien 8:0d1ec493842c 50
donatien 8:0d1ec493842c 51 virtual uint16_t getSerialVid() = 0;
donatien 8:0d1ec493842c 52 virtual uint16_t getSerialPid() = 0;
donatien 8:0d1ec493842c 53
donatien 8:0d1ec493842c 54 virtual bool switchMode(USBDeviceConnected* pDev) = 0;
donatien 8:0d1ec493842c 55
donatien 9:c9e9817c398c 56 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx) = 0;
donatien 8:0d1ec493842c 57
donatien 8:0d1ec493842c 58 virtual int getSerialPortCount() = 0;
donatien 8:0d1ec493842c 59
donatien 8:0d1ec493842c 60 virtual void setVidPid(uint16_t vid, uint16_t pid) = 0;
donatien 8:0d1ec493842c 61
donatien 8:0d1ec493842c 62 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 63
donatien 8:0d1ec493842c 64 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 65
donatien 8:0d1ec493842c 66 virtual WAN_DONGLE_TYPE getType() = 0;
donatien 8:0d1ec493842c 67
donatien 8:0d1ec493842c 68 static WANDongleInitializer** getInitializers(USBHost* pHost);
donatien 8:0d1ec493842c 69 };
donatien 8:0d1ec493842c 70
donatien 8:0d1ec493842c 71 class VodafoneK3770Initializer : public WANDongleInitializer
donatien 8:0d1ec493842c 72 {
donatien 8:0d1ec493842c 73 public:
donatien 8:0d1ec493842c 74 VodafoneK3770Initializer(USBHost* pHost);
donatien 8:0d1ec493842c 75
donatien 8:0d1ec493842c 76 virtual uint16_t getMSDVid();
donatien 8:0d1ec493842c 77 virtual uint16_t getMSDPid();
donatien 8:0d1ec493842c 78
donatien 8:0d1ec493842c 79 virtual uint16_t getSerialVid();
donatien 8:0d1ec493842c 80 virtual uint16_t getSerialPid();
donatien 8:0d1ec493842c 81
donatien 8:0d1ec493842c 82 virtual bool switchMode(USBDeviceConnected* pDev);
donatien 8:0d1ec493842c 83
donatien 9:c9e9817c398c 84 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
donatien 8:0d1ec493842c 85
donatien 8:0d1ec493842c 86 virtual int getSerialPortCount();
donatien 8:0d1ec493842c 87
donatien 8:0d1ec493842c 88 virtual void setVidPid(uint16_t vid, uint16_t pid);
donatien 8:0d1ec493842c 89
donatien 8:0d1ec493842c 90 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 91
donatien 8:0d1ec493842c 92 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 93
donatien 8:0d1ec493842c 94 virtual WAN_DONGLE_TYPE getType();
donatien 8:0d1ec493842c 95
donatien 8:0d1ec493842c 96 private:
donatien 8:0d1ec493842c 97
donatien 8:0d1ec493842c 98 bool m_hasSwitched;
donatien 8:0d1ec493842c 99 int m_currentSerialIntf;
donatien 8:0d1ec493842c 100 int m_endpointsToFetch;
donatien 8:0d1ec493842c 101 };
donatien 8:0d1ec493842c 102
ashleymills 20:3abcf818be31 103 class VodafoneK3773Initializer : public WANDongleInitializer
donatien 18:7d5242aa7b95 104 {
donatien 18:7d5242aa7b95 105 public:
ashleymills 20:3abcf818be31 106 VodafoneK3773Initializer(USBHost* pHost);
donatien 18:7d5242aa7b95 107
donatien 18:7d5242aa7b95 108 virtual uint16_t getMSDVid();
donatien 18:7d5242aa7b95 109 virtual uint16_t getMSDPid();
donatien 18:7d5242aa7b95 110
donatien 18:7d5242aa7b95 111 virtual uint16_t getSerialVid();
donatien 18:7d5242aa7b95 112 virtual uint16_t getSerialPid();
donatien 18:7d5242aa7b95 113
donatien 18:7d5242aa7b95 114 virtual bool switchMode(USBDeviceConnected* pDev);
donatien 18:7d5242aa7b95 115
donatien 18:7d5242aa7b95 116 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
donatien 18:7d5242aa7b95 117
donatien 18:7d5242aa7b95 118 virtual int getSerialPortCount();
donatien 18:7d5242aa7b95 119
donatien 18:7d5242aa7b95 120 virtual void setVidPid(uint16_t vid, uint16_t pid);
donatien 18:7d5242aa7b95 121
donatien 18:7d5242aa7b95 122 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 18:7d5242aa7b95 123
donatien 18:7d5242aa7b95 124 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
donatien 18:7d5242aa7b95 125
donatien 18:7d5242aa7b95 126 virtual WAN_DONGLE_TYPE getType();
donatien 18:7d5242aa7b95 127
donatien 18:7d5242aa7b95 128 private:
donatien 18:7d5242aa7b95 129
donatien 18:7d5242aa7b95 130 bool m_hasSwitched;
donatien 18:7d5242aa7b95 131 int m_currentSerialIntf;
donatien 18:7d5242aa7b95 132 int m_endpointsToFetch;
donatien 18:7d5242aa7b95 133 };
donatien 18:7d5242aa7b95 134
donatien 8:0d1ec493842c 135 class VodafoneK3772ZInitializer : public WANDongleInitializer
donatien 8:0d1ec493842c 136 {
donatien 8:0d1ec493842c 137 public:
donatien 8:0d1ec493842c 138 VodafoneK3772ZInitializer(USBHost* pHost);
donatien 8:0d1ec493842c 139
donatien 8:0d1ec493842c 140 virtual uint16_t getMSDVid();
donatien 8:0d1ec493842c 141 virtual uint16_t getMSDPid();
donatien 8:0d1ec493842c 142
donatien 8:0d1ec493842c 143 virtual uint16_t getSerialVid();
donatien 8:0d1ec493842c 144 virtual uint16_t getSerialPid();
donatien 8:0d1ec493842c 145
donatien 8:0d1ec493842c 146 virtual bool switchMode(USBDeviceConnected* pDev);
donatien 8:0d1ec493842c 147
donatien 9:c9e9817c398c 148 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
donatien 8:0d1ec493842c 149
donatien 8:0d1ec493842c 150 virtual int getSerialPortCount();
donatien 8:0d1ec493842c 151
donatien 8:0d1ec493842c 152 virtual void setVidPid(uint16_t vid, uint16_t pid);
donatien 8:0d1ec493842c 153
donatien 8:0d1ec493842c 154 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 155
donatien 8:0d1ec493842c 156 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 157
donatien 8:0d1ec493842c 158 virtual WAN_DONGLE_TYPE getType();
donatien 8:0d1ec493842c 159
donatien 8:0d1ec493842c 160 private:
donatien 8:0d1ec493842c 161
donatien 8:0d1ec493842c 162 bool m_hasSwitched;
donatien 8:0d1ec493842c 163 int m_currentSerialIntf;
donatien 8:0d1ec493842c 164 int m_endpointsToFetch;
donatien 8:0d1ec493842c 165 };
donatien 8:0d1ec493842c 166
ashleymills 27:980fe31c14f7 167 class HuaweiMU509Initializer : public WANDongleInitializer
ashleymills 21:dcc8c866ccbb 168 {
ashleymills 21:dcc8c866ccbb 169 public:
ashleymills 27:980fe31c14f7 170 HuaweiMU509Initializer(USBHost* pHost);
ashleymills 21:dcc8c866ccbb 171
ashleymills 21:dcc8c866ccbb 172 virtual uint16_t getMSDVid();
ashleymills 21:dcc8c866ccbb 173 virtual uint16_t getMSDPid();
ashleymills 21:dcc8c866ccbb 174
ashleymills 21:dcc8c866ccbb 175 virtual uint16_t getSerialVid();
ashleymills 21:dcc8c866ccbb 176 virtual uint16_t getSerialPid();
ashleymills 21:dcc8c866ccbb 177
ashleymills 21:dcc8c866ccbb 178 virtual bool switchMode(USBDeviceConnected* pDev);
ashleymills 21:dcc8c866ccbb 179
ashleymills 21:dcc8c866ccbb 180 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
ashleymills 21:dcc8c866ccbb 181
ashleymills 21:dcc8c866ccbb 182 virtual int getSerialPortCount();
ashleymills 21:dcc8c866ccbb 183
ashleymills 21:dcc8c866ccbb 184 virtual void setVidPid(uint16_t vid, uint16_t pid);
ashleymills 21:dcc8c866ccbb 185
ashleymills 21:dcc8c866ccbb 186 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 187
ashleymills 21:dcc8c866ccbb 188 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 189
ashleymills 21:dcc8c866ccbb 190 virtual WAN_DONGLE_TYPE getType();
ashleymills 21:dcc8c866ccbb 191
ashleymills 21:dcc8c866ccbb 192 private:
ashleymills 21:dcc8c866ccbb 193
ashleymills 21:dcc8c866ccbb 194 int m_currentSerialIntf;
ashleymills 21:dcc8c866ccbb 195 int m_endpointsToFetch;
ashleymills 21:dcc8c866ccbb 196 };
ashleymills 21:dcc8c866ccbb 197
ashleymills 25:3184f71557bf 198 class VodafoneK3772Initializer : public WANDongleInitializer
ashleymills 25:3184f71557bf 199 {
ashleymills 25:3184f71557bf 200 public:
ashleymills 25:3184f71557bf 201 VodafoneK3772Initializer(USBHost* pHost);
ashleymills 25:3184f71557bf 202
ashleymills 25:3184f71557bf 203 virtual uint16_t getMSDVid();
ashleymills 25:3184f71557bf 204 virtual uint16_t getMSDPid();
ashleymills 25:3184f71557bf 205
ashleymills 25:3184f71557bf 206 virtual uint16_t getSerialVid();
ashleymills 25:3184f71557bf 207 virtual uint16_t getSerialPid();
ashleymills 25:3184f71557bf 208
ashleymills 25:3184f71557bf 209 virtual bool switchMode(USBDeviceConnected* pDev);
ashleymills 25:3184f71557bf 210
ashleymills 25:3184f71557bf 211 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
ashleymills 25:3184f71557bf 212
ashleymills 25:3184f71557bf 213 virtual int getSerialPortCount();
ashleymills 25:3184f71557bf 214
ashleymills 25:3184f71557bf 215 virtual void setVidPid(uint16_t vid, uint16_t pid);
ashleymills 25:3184f71557bf 216
ashleymills 25:3184f71557bf 217 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 25:3184f71557bf 218
ashleymills 25:3184f71557bf 219 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
ashleymills 25:3184f71557bf 220
ashleymills 25:3184f71557bf 221 virtual WAN_DONGLE_TYPE getType();
ashleymills 25:3184f71557bf 222
ashleymills 25:3184f71557bf 223 private:
ashleymills 25:3184f71557bf 224
ashleymills 25:3184f71557bf 225 bool m_hasSwitched;
ashleymills 25:3184f71557bf 226 int m_currentSerialIntf;
ashleymills 25:3184f71557bf 227 int m_endpointsToFetch;
ashleymills 25:3184f71557bf 228 };
ashleymills 25:3184f71557bf 229
ashleymills 27:980fe31c14f7 230 //-----------------------------------------------------------------------
ashleymills 27:980fe31c14f7 231 // mamm, u-blox Modem
ashleymills 27:980fe31c14f7 232 //-----------------------------------------------------------------------
ashleymills 27:980fe31c14f7 233
ashleymills 27:980fe31c14f7 234 class UbloxLISAU200Initializer : public WANDongleInitializer
ashleymills 27:980fe31c14f7 235 {
ashleymills 27:980fe31c14f7 236 public:
ashleymills 27:980fe31c14f7 237 UbloxLISAU200Initializer(USBHost* pHost);
ashleymills 27:980fe31c14f7 238
ashleymills 27:980fe31c14f7 239 virtual uint16_t getMSDVid();
ashleymills 27:980fe31c14f7 240 virtual uint16_t getMSDPid();
ashleymills 27:980fe31c14f7 241
ashleymills 27:980fe31c14f7 242 virtual uint16_t getSerialVid();
ashleymills 27:980fe31c14f7 243 virtual uint16_t getSerialPid();
ashleymills 27:980fe31c14f7 244
ashleymills 27:980fe31c14f7 245 virtual bool switchMode(USBDeviceConnected* pDev);
ashleymills 27:980fe31c14f7 246
ashleymills 27:980fe31c14f7 247 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
ashleymills 27:980fe31c14f7 248
ashleymills 27:980fe31c14f7 249 virtual int getSerialPortCount();
ashleymills 27:980fe31c14f7 250
ashleymills 27:980fe31c14f7 251 virtual void setVidPid(uint16_t vid, uint16_t pid);
ashleymills 27:980fe31c14f7 252
ashleymills 27:980fe31c14f7 253 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 27:980fe31c14f7 254
ashleymills 27:980fe31c14f7 255 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
ashleymills 27:980fe31c14f7 256
ashleymills 27:980fe31c14f7 257 virtual WAN_DONGLE_TYPE getType();
ashleymills 27:980fe31c14f7 258
ashleymills 27:980fe31c14f7 259 private:
ashleymills 27:980fe31c14f7 260
ashleymills 27:980fe31c14f7 261 bool m_hasSwitched;
ashleymills 27:980fe31c14f7 262 int m_currentSerialIntf;
ashleymills 27:980fe31c14f7 263 int m_endpointsToFetch;
ashleymills 27:980fe31c14f7 264 };
ashleymills 27:980fe31c14f7 265
dmitryp 28:34cdecfff9f4 266
dmitryp 28:34cdecfff9f4 267 class VodafoneK4606Initializer : public WANDongleInitializer
dmitryp 28:34cdecfff9f4 268 {
dmitryp 28:34cdecfff9f4 269 public:
dmitryp 28:34cdecfff9f4 270 VodafoneK4606Initializer(USBHost* pHost);
dmitryp 28:34cdecfff9f4 271
dmitryp 28:34cdecfff9f4 272 virtual uint16_t getMSDVid();
dmitryp 28:34cdecfff9f4 273 virtual uint16_t getMSDPid();
dmitryp 28:34cdecfff9f4 274
dmitryp 28:34cdecfff9f4 275 virtual uint16_t getSerialVid();
dmitryp 28:34cdecfff9f4 276 virtual uint16_t getSerialPid();
dmitryp 28:34cdecfff9f4 277
dmitryp 28:34cdecfff9f4 278 virtual bool switchMode(USBDeviceConnected* pDev);
dmitryp 28:34cdecfff9f4 279
dmitryp 28:34cdecfff9f4 280 virtual USBEndpoint* getEp(USBDeviceConnected* pDev, int serialPortNumber, bool tx);
dmitryp 28:34cdecfff9f4 281
dmitryp 28:34cdecfff9f4 282 virtual int getSerialPortCount();
dmitryp 28:34cdecfff9f4 283
dmitryp 28:34cdecfff9f4 284 virtual void setVidPid(uint16_t vid, uint16_t pid);
dmitryp 28:34cdecfff9f4 285
dmitryp 28:34cdecfff9f4 286 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
dmitryp 28:34cdecfff9f4 287
dmitryp 28:34cdecfff9f4 288 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
dmitryp 28:34cdecfff9f4 289
dmitryp 28:34cdecfff9f4 290 virtual WAN_DONGLE_TYPE getType();
dmitryp 28:34cdecfff9f4 291
dmitryp 28:34cdecfff9f4 292 private:
dmitryp 28:34cdecfff9f4 293
dmitryp 28:34cdecfff9f4 294 bool m_hasSwitched;
dmitryp 28:34cdecfff9f4 295 int m_currentSerialIntf;
dmitryp 28:34cdecfff9f4 296 int m_endpointsToFetch;
dmitryp 28:34cdecfff9f4 297 };
dmitryp 28:34cdecfff9f4 298
dmitryp 28:34cdecfff9f4 299
donatien 8:0d1ec493842c 300 #endif
ashleymills 25:3184f71557bf 301