USB Host WAN Dongle library

Fork of USBHostWANDongle_bleedingedge by Donatien Garnier

Committer:
nherriot
Date:
Thu Feb 21 09:28:14 2013 +0000
Revision:
17:b8739fd10faf
Parent:
16:e1f5ba831485
Child:
19:6526d83aab9f
small debug output changes.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 10:08bce4cd973a 1 /* Copyright (c) 2010-2012 mbed.org, MIT License
donatien 0:ae46a0638b2c 2 *
donatien 0:ae46a0638b2c 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 0:ae46a0638b2c 4 * and associated documentation files (the "Software"), to deal in the Software without
donatien 0:ae46a0638b2c 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
donatien 0:ae46a0638b2c 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
donatien 0:ae46a0638b2c 7 * Software is furnished to do so, subject to the following conditions:
donatien 0:ae46a0638b2c 8 *
donatien 0:ae46a0638b2c 9 * The above copyright notice and this permission notice shall be included in all copies or
donatien 0:ae46a0638b2c 10 * substantial portions of the Software.
donatien 0:ae46a0638b2c 11 *
donatien 0:ae46a0638b2c 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 0:ae46a0638b2c 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 0:ae46a0638b2c 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 0:ae46a0638b2c 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:ae46a0638b2c 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 0:ae46a0638b2c 17 */
donatien 0:ae46a0638b2c 18
nherriot 15:25c10b07bb17 19 #define __DEBUG__ 4
donatien 0:ae46a0638b2c 20 #ifndef __MODULE__
donatien 0:ae46a0638b2c 21 #define __MODULE__ "WANDongle.cpp"
donatien 0:ae46a0638b2c 22 #endif
donatien 0:ae46a0638b2c 23
donatien 12:a712bad7a979 24 #include "core/dbg.h"
donatien 0:ae46a0638b2c 25 #include <cstdint>
donatien 0:ae46a0638b2c 26 #include "rtos.h"
donatien 0:ae46a0638b2c 27
donatien 0:ae46a0638b2c 28 #include "WANDongle.h"
donatien 2:a8b2d0cd9bbd 29 #include "WANDongleInitializer.h"
donatien 0:ae46a0638b2c 30
donatien 6:075e36a3463e 31 WANDongle::WANDongle() : m_pInitializer(NULL), m_serialCount(0)
donatien 0:ae46a0638b2c 32 {
donatien 0:ae46a0638b2c 33 host = USBHost::getHostInst();
donatien 0:ae46a0638b2c 34 init();
nherriot 16:e1f5ba831485 35 DBG("WANDongle object instantiated. getHostInst method called on USBHost.");
donatien 0:ae46a0638b2c 36 }
donatien 0:ae46a0638b2c 37
donatien 0:ae46a0638b2c 38
donatien 0:ae46a0638b2c 39 bool WANDongle::connected() {
donatien 0:ae46a0638b2c 40 return dev_connected;
donatien 0:ae46a0638b2c 41 }
donatien 0:ae46a0638b2c 42
donatien 0:ae46a0638b2c 43 bool WANDongle::tryConnect()
donatien 0:ae46a0638b2c 44 {
donatien 0:ae46a0638b2c 45 //FIXME should run on USB thread
donatien 0:ae46a0638b2c 46
donatien 0:ae46a0638b2c 47 DBG("Trying to connect device");
donatien 0:ae46a0638b2c 48
donatien 0:ae46a0638b2c 49 if (dev_connected) {
donatien 0:ae46a0638b2c 50 return true;
donatien 0:ae46a0638b2c 51 }
donatien 6:075e36a3463e 52
donatien 6:075e36a3463e 53 m_pInitializer = NULL;
donatien 0:ae46a0638b2c 54
donatien 0:ae46a0638b2c 55 host->lock();
donatien 0:ae46a0638b2c 56
donatien 2:a8b2d0cd9bbd 57 for (int i = 0; i < MAX_DEVICE_NB; i++)
donatien 2:a8b2d0cd9bbd 58 {
donatien 2:a8b2d0cd9bbd 59 if ((dev = host->getDevice(i)) != NULL)
donatien 2:a8b2d0cd9bbd 60 {
donatien 6:075e36a3463e 61 m_pInitializer = NULL; //Will be set in setVidPid callback
donatien 6:075e36a3463e 62
donatien 6:075e36a3463e 63 DBG("Found one device reset it");
donatien 11:a0841fba0599 64 int ret = host->resetDevice(dev);
donatien 11:a0841fba0599 65 if(ret)
donatien 11:a0841fba0599 66 {
donatien 11:a0841fba0599 67 host->unlock();
donatien 11:a0841fba0599 68 return false;
donatien 11:a0841fba0599 69 }
donatien 0:ae46a0638b2c 70
donatien 0:ae46a0638b2c 71 DBG("Enumerate");
donatien 11:a0841fba0599 72 ret = host->enumerate(dev, this);
donatien 11:a0841fba0599 73 if(ret)
donatien 11:a0841fba0599 74 {
donatien 11:a0841fba0599 75 host->unlock();
donatien 11:a0841fba0599 76 return false;
donatien 11:a0841fba0599 77 }
donatien 2:a8b2d0cd9bbd 78
donatien 8:0d1ec493842c 79 DBG("Device has VID:%04x PID:%04x", dev->getVid(), dev->getPid());
donatien 6:075e36a3463e 80
donatien 6:075e36a3463e 81 if(m_pInitializer) //If an initializer has been found
donatien 2:a8b2d0cd9bbd 82 {
donatien 6:075e36a3463e 83 DBG("m_pInitializer=%p", m_pInitializer);
donatien 6:075e36a3463e 84 DBG("m_pInitializer->getSerialVid()=%04x", m_pInitializer->getSerialVid());
donatien 6:075e36a3463e 85 DBG("m_pInitializer->getSerialPid()=%04x", m_pInitializer->getSerialPid());
donatien 6:075e36a3463e 86 if ((dev->getVid() == m_pInitializer->getSerialVid()) && (dev->getPid() == m_pInitializer->getSerialPid()))
donatien 2:a8b2d0cd9bbd 87 {
donatien 3:4394986752db 88 DBG("The dongle is in virtual serial mode");
donatien 2:a8b2d0cd9bbd 89 host->registerDriver(dev, 0, this, &WANDongle::init);
donatien 6:075e36a3463e 90 m_serialCount = m_pInitializer->getSerialPortCount();
donatien 3:4394986752db 91 if( m_serialCount > WANDONGLE_MAX_SERIAL_PORTS )
donatien 3:4394986752db 92 {
donatien 3:4394986752db 93 m_serialCount = WANDONGLE_MAX_SERIAL_PORTS;
donatien 3:4394986752db 94 }
donatien 2:a8b2d0cd9bbd 95 for(int j = 0; j < m_serialCount; j++)
donatien 2:a8b2d0cd9bbd 96 {
donatien 3:4394986752db 97 DBG("Connecting serial port #%d", j+1);
donatien 6:075e36a3463e 98 DBG("Ep %p", m_pInitializer->getEp(dev, j, false));
donatien 6:075e36a3463e 99 DBG("Ep %p", m_pInitializer->getEp(dev, j, true));
donatien 6:075e36a3463e 100 m_serial[j].connect( dev, m_pInitializer->getEp(dev, j, false), m_pInitializer->getEp(dev, j, true) );
donatien 2:a8b2d0cd9bbd 101 }
donatien 3:4394986752db 102
donatien 3:4394986752db 103 DBG("Device connected");
donatien 3:4394986752db 104
donatien 2:a8b2d0cd9bbd 105 dev_connected = true;
donatien 2:a8b2d0cd9bbd 106 host->unlock();
donatien 3:4394986752db 107
donatien 3:4394986752db 108
donatien 2:a8b2d0cd9bbd 109 return true;
donatien 2:a8b2d0cd9bbd 110 }
donatien 6:075e36a3463e 111 else if ((dev->getVid() == m_pInitializer->getMSDVid()) && (dev->getPid() == m_pInitializer->getMSDPid()))
donatien 2:a8b2d0cd9bbd 112 {
donatien 1:49df46e3295c 113 DBG("Vodafone K3370 dongle detected in MSD mode");
donatien 2:a8b2d0cd9bbd 114 //Try to switch
donatien 6:075e36a3463e 115 if( m_pInitializer->switchMode(dev) )
donatien 2:a8b2d0cd9bbd 116 {
donatien 2:a8b2d0cd9bbd 117 DBG("Switched OK");
donatien 2:a8b2d0cd9bbd 118 host->unlock();
donatien 2:a8b2d0cd9bbd 119 return false; //Will be connected on a next iteration
donatien 0:ae46a0638b2c 120 }
donatien 2:a8b2d0cd9bbd 121 else
donatien 2:a8b2d0cd9bbd 122 {
donatien 2:a8b2d0cd9bbd 123 ERR("Could not switch mode");
donatien 0:ae46a0638b2c 124 host->unlock();
donatien 2:a8b2d0cd9bbd 125 return false;
donatien 0:ae46a0638b2c 126 }
donatien 2:a8b2d0cd9bbd 127 }
donatien 6:075e36a3463e 128 } //if()
donatien 2:a8b2d0cd9bbd 129 } //if()
nherriot 17:b8739fd10faf 130 /*else
nherriot 16:e1f5ba831485 131 {
nherriot 16:e1f5ba831485 132 // Looks like the getDevice method failed and returned a null pointer. Maybe there has been a power cut, modem pulled or something to stop the modem.
nherriot 16:e1f5ba831485 133 // Lets run the initilise routine again. Next time round the loop we might have a handle to an end point!
nherriot 17:b8739fd10faf 134 DBG("Trying to initialise the USB stack since the getDevice method has returned a null pointer");
nherriot 16:e1f5ba831485 135 init();
nherriot 17:b8739fd10faf 136 }*/
donatien 2:a8b2d0cd9bbd 137 } //for()
donatien 0:ae46a0638b2c 138 host->unlock();
donatien 0:ae46a0638b2c 139 return false;
donatien 0:ae46a0638b2c 140 }
donatien 0:ae46a0638b2c 141
donatien 10:08bce4cd973a 142 bool WANDongle::disconnect()
donatien 10:08bce4cd973a 143 {
donatien 10:08bce4cd973a 144 dev_connected = false;
donatien 10:08bce4cd973a 145 for(int i = 0; i < WANDONGLE_MAX_SERIAL_PORTS; i++)
donatien 10:08bce4cd973a 146 {
donatien 10:08bce4cd973a 147 m_serial[i].disconnect();
donatien 10:08bce4cd973a 148 }
donatien 10:08bce4cd973a 149 return true;
donatien 10:08bce4cd973a 150 }
donatien 10:08bce4cd973a 151
donatien 8:0d1ec493842c 152 WAN_DONGLE_TYPE WANDongle::getDongleType()
donatien 8:0d1ec493842c 153 {
donatien 8:0d1ec493842c 154 if( m_pInitializer != NULL )
donatien 8:0d1ec493842c 155 {
donatien 8:0d1ec493842c 156 return m_pInitializer->getType();
donatien 8:0d1ec493842c 157 }
donatien 8:0d1ec493842c 158 else
donatien 8:0d1ec493842c 159 {
donatien 8:0d1ec493842c 160 return WAN_DONGLE_TYPE_UNKNOWN;
donatien 8:0d1ec493842c 161 }
donatien 8:0d1ec493842c 162 }
donatien 8:0d1ec493842c 163
donatien 3:4394986752db 164 IUSBHostSerial& WANDongle::getSerial(int index)
donatien 0:ae46a0638b2c 165 {
donatien 2:a8b2d0cd9bbd 166 return m_serial[index];
donatien 0:ae46a0638b2c 167 }
donatien 0:ae46a0638b2c 168
donatien 2:a8b2d0cd9bbd 169 int WANDongle::getSerialCount()
donatien 0:ae46a0638b2c 170 {
donatien 2:a8b2d0cd9bbd 171 return m_serialCount;
donatien 0:ae46a0638b2c 172 }
donatien 0:ae46a0638b2c 173
donatien 0:ae46a0638b2c 174 //Private methods
donatien 0:ae46a0638b2c 175 void WANDongle::init()
donatien 0:ae46a0638b2c 176 {
donatien 10:08bce4cd973a 177 m_pInitializer = NULL;
donatien 0:ae46a0638b2c 178 dev_connected = false;
donatien 3:4394986752db 179 for(int i = 0; i < WANDONGLE_MAX_SERIAL_PORTS; i++)
donatien 3:4394986752db 180 {
donatien 3:4394986752db 181 m_serial[i].init(host);
donatien 3:4394986752db 182 }
donatien 0:ae46a0638b2c 183 }
donatien 6:075e36a3463e 184
donatien 6:075e36a3463e 185
donatien 6:075e36a3463e 186 /*virtual*/ void WANDongle::setVidPid(uint16_t vid, uint16_t pid)
donatien 6:075e36a3463e 187 {
donatien 6:075e36a3463e 188 //Load right initializer
donatien 10:08bce4cd973a 189 WANDongleInitializer** initializer = WANDongleInitializer::getInitializers(host);
donatien 10:08bce4cd973a 190
donatien 10:08bce4cd973a 191 while(*initializer)
donatien 10:08bce4cd973a 192 {
donatien 10:08bce4cd973a 193 DBG("*initializer=%p", *initializer);
donatien 10:08bce4cd973a 194 DBG("(*initializer)->getSerialVid()=%04x", (*initializer)->getSerialVid());
donatien 10:08bce4cd973a 195 DBG("(*initializer)->getSerialPid()=%04x", (*initializer)->getSerialPid());
donatien 10:08bce4cd973a 196 if ((dev->getVid() == (*initializer)->getSerialVid()) && (dev->getPid() == (*initializer)->getSerialPid()))
donatien 10:08bce4cd973a 197 {
donatien 10:08bce4cd973a 198 DBG("The dongle is in virtual serial mode");
donatien 10:08bce4cd973a 199 m_pInitializer = *initializer;
donatien 10:08bce4cd973a 200 break;
donatien 10:08bce4cd973a 201 }
donatien 10:08bce4cd973a 202 else if ((dev->getVid() == (*initializer)->getMSDVid()) && (dev->getPid() == (*initializer)->getMSDPid()))
donatien 10:08bce4cd973a 203 {
donatien 10:08bce4cd973a 204 DBG("Vodafone K3370 dongle detected in MSD mode");
donatien 10:08bce4cd973a 205 m_pInitializer = *initializer;
donatien 10:08bce4cd973a 206 break;
donatien 10:08bce4cd973a 207 }
donatien 10:08bce4cd973a 208 initializer++;
donatien 10:08bce4cd973a 209 } //while()
donatien 10:08bce4cd973a 210 if(m_pInitializer)
donatien 10:08bce4cd973a 211 {
donatien 10:08bce4cd973a 212 m_pInitializer->setVidPid(vid, pid);
donatien 10:08bce4cd973a 213 }
donatien 6:075e36a3463e 214 }
donatien 6:075e36a3463e 215
donatien 6:075e36a3463e 216 /*virtual*/ bool WANDongle::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 6:075e36a3463e 217 {
donatien 6:075e36a3463e 218 if(m_pInitializer)
donatien 6:075e36a3463e 219 {
donatien 6:075e36a3463e 220 return m_pInitializer->parseInterface(intf_nb, intf_class, intf_subclass, intf_protocol);
donatien 6:075e36a3463e 221 }
donatien 6:075e36a3463e 222 else
donatien 6:075e36a3463e 223 {
donatien 6:075e36a3463e 224 return false;
donatien 6:075e36a3463e 225 }
donatien 6:075e36a3463e 226 }
donatien 6:075e36a3463e 227
donatien 6:075e36a3463e 228 /*virtual*/ bool WANDongle::useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir) //Must return true if the endpoint will be used
donatien 6:075e36a3463e 229 {
donatien 6:075e36a3463e 230 if(m_pInitializer)
donatien 6:075e36a3463e 231 {
donatien 6:075e36a3463e 232 return m_pInitializer->useEndpoint(intf_nb, type, dir);
donatien 6:075e36a3463e 233 }
donatien 6:075e36a3463e 234 else
donatien 6:075e36a3463e 235 {
donatien 6:075e36a3463e 236 return false;
donatien 6:075e36a3463e 237 }
donatien 6:075e36a3463e 238 }