mbed official / USBHostWANDongle

USB Host WAN Dongle library

Fork of USBHostWANDongle_bleedingedge by Donatien Garnier

USB3GModule/WANDongle.cpp@27:980fe31c14f7, 2013-09-20 (annotated)

Committer:
ashleymills
Date:
Fri Sep 20 10:40:15 2013 +0000
Revision:
27:980fe31c14f7
Parent:
25:3184f71557bf 
Added support for Ublox LISA U200 module

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
donatien 19:6526d83aab9f 19 #define __DEBUG__ 0
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);
ashleymills 24:f4b676f61906 73
donatien 11:a0841fba0599 74 if(ret)
donatien 11:a0841fba0599 75 {
donatien 11:a0841fba0599 76 host->unlock();
donatien 11:a0841fba0599 77 return false;
donatien 11:a0841fba0599 78 }
donatien 2:a8b2d0cd9bbd 79
donatien 8:0d1ec493842c 80 DBG("Device has VID:%04x PID:%04x", dev->getVid(), dev->getPid());
donatien 6:075e36a3463e 81
donatien 6:075e36a3463e 82 if(m_pInitializer) //If an initializer has been found
donatien 2:a8b2d0cd9bbd 83 {
donatien 6:075e36a3463e 84 DBG("m_pInitializer=%p", m_pInitializer);
donatien 6:075e36a3463e 85 DBG("m_pInitializer->getSerialVid()=%04x", m_pInitializer->getSerialVid());
donatien 6:075e36a3463e 86 DBG("m_pInitializer->getSerialPid()=%04x", m_pInitializer->getSerialPid());
donatien 6:075e36a3463e 87 if ((dev->getVid() == m_pInitializer->getSerialVid()) && (dev->getPid() == m_pInitializer->getSerialPid()))
donatien 2:a8b2d0cd9bbd 88 {
donatien 3:4394986752db 89 DBG("The dongle is in virtual serial mode");
donatien 2:a8b2d0cd9bbd 90 host->registerDriver(dev, 0, this, &WANDongle::init);
donatien 6:075e36a3463e 91 m_serialCount = m_pInitializer->getSerialPortCount();
ashleymills 21:dcc8c866ccbb 92 DBG("Num serial ports: %d",m_serialCount);
donatien 3:4394986752db 93 if( m_serialCount > WANDONGLE_MAX_SERIAL_PORTS )
donatien 3:4394986752db 94 {
ashleymills 21:dcc8c866ccbb 95 DBG("setting serial count %d to %d",m_serialCount,WANDONGLE_MAX_SERIAL_PORTS);
donatien 3:4394986752db 96 m_serialCount = WANDONGLE_MAX_SERIAL_PORTS;
donatien 3:4394986752db 97 }
donatien 2:a8b2d0cd9bbd 98 for(int j = 0; j < m_serialCount; j++)
donatien 2:a8b2d0cd9bbd 99 {
donatien 3:4394986752db 100 DBG("Connecting serial port #%d", j+1);
donatien 6:075e36a3463e 101 DBG("Ep %p", m_pInitializer->getEp(dev, j, false));
donatien 6:075e36a3463e 102 DBG("Ep %p", m_pInitializer->getEp(dev, j, true));
donatien 6:075e36a3463e 103 m_serial[j].connect( dev, m_pInitializer->getEp(dev, j, false), m_pInitializer->getEp(dev, j, true) );
donatien 2:a8b2d0cd9bbd 104 }
donatien 3:4394986752db 105
donatien 3:4394986752db 106 DBG("Device connected");
donatien 3:4394986752db 107
donatien 2:a8b2d0cd9bbd 108 dev_connected = true;
donatien 2:a8b2d0cd9bbd 109 host->unlock();
donatien 3:4394986752db 110
donatien 2:a8b2d0cd9bbd 111 return true;
donatien 2:a8b2d0cd9bbd 112 }
donatien 6:075e36a3463e 113 else if ((dev->getVid() == m_pInitializer->getMSDVid()) && (dev->getPid() == m_pInitializer->getMSDPid()))
donatien 2:a8b2d0cd9bbd 114 {
donatien 1:49df46e3295c 115 DBG("Vodafone K3370 dongle detected in MSD mode");
donatien 2:a8b2d0cd9bbd 116 //Try to switch
donatien 6:075e36a3463e 117 if( m_pInitializer->switchMode(dev) )
donatien 2:a8b2d0cd9bbd 118 {
donatien 2:a8b2d0cd9bbd 119 DBG("Switched OK");
donatien 2:a8b2d0cd9bbd 120 host->unlock();
donatien 2:a8b2d0cd9bbd 121 return false; //Will be connected on a next iteration
donatien 0:ae46a0638b2c 122 }
donatien 2:a8b2d0cd9bbd 123 else
donatien 2:a8b2d0cd9bbd 124 {
donatien 2:a8b2d0cd9bbd 125 ERR("Could not switch mode");
donatien 0:ae46a0638b2c 126 host->unlock();
donatien 2:a8b2d0cd9bbd 127 return false;
donatien 0:ae46a0638b2c 128 }
donatien 2:a8b2d0cd9bbd 129 }
donatien 6:075e36a3463e 130 } //if()
donatien 2:a8b2d0cd9bbd 131 } //if()
nherriot 17:b8739fd10faf 132 /*else
nherriot 16:e1f5ba831485 133 {
nherriot 16:e1f5ba831485 134 // 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 135 // Lets run the initilise routine again. Next time round the loop we might have a handle to an end point!
nherriot 17:b8739fd10faf 136 DBG("Trying to initialise the USB stack since the getDevice method has returned a null pointer");
nherriot 16:e1f5ba831485 137 init();
nherriot 17:b8739fd10faf 138 }*/
donatien 2:a8b2d0cd9bbd 139 } //for()
donatien 0:ae46a0638b2c 140 host->unlock();
donatien 0:ae46a0638b2c 141 return false;
donatien 0:ae46a0638b2c 142 }
donatien 0:ae46a0638b2c 143
donatien 10:08bce4cd973a 144 bool WANDongle::disconnect()
donatien 10:08bce4cd973a 145 {
donatien 10:08bce4cd973a 146 dev_connected = false;
donatien 10:08bce4cd973a 147 for(int i = 0; i < WANDONGLE_MAX_SERIAL_PORTS; i++)
donatien 10:08bce4cd973a 148 {
donatien 10:08bce4cd973a 149 m_serial[i].disconnect();
donatien 10:08bce4cd973a 150 }
donatien 10:08bce4cd973a 151 return true;
donatien 10:08bce4cd973a 152 }
donatien 10:08bce4cd973a 153
donatien 8:0d1ec493842c 154 WAN_DONGLE_TYPE WANDongle::getDongleType()
donatien 8:0d1ec493842c 155 {
donatien 8:0d1ec493842c 156 if( m_pInitializer != NULL )
donatien 8:0d1ec493842c 157 {
donatien 8:0d1ec493842c 158 return m_pInitializer->getType();
donatien 8:0d1ec493842c 159 }
donatien 8:0d1ec493842c 160 else
donatien 8:0d1ec493842c 161 {
donatien 8:0d1ec493842c 162 return WAN_DONGLE_TYPE_UNKNOWN;
donatien 8:0d1ec493842c 163 }
donatien 8:0d1ec493842c 164 }
donatien 8:0d1ec493842c 165
donatien 3:4394986752db 166 IUSBHostSerial& WANDongle::getSerial(int index)
donatien 0:ae46a0638b2c 167 {
donatien 2:a8b2d0cd9bbd 168 return m_serial[index];
donatien 0:ae46a0638b2c 169 }
donatien 0:ae46a0638b2c 170
donatien 2:a8b2d0cd9bbd 171 int WANDongle::getSerialCount()
donatien 0:ae46a0638b2c 172 {
donatien 2:a8b2d0cd9bbd 173 return m_serialCount;
donatien 0:ae46a0638b2c 174 }
donatien 0:ae46a0638b2c 175
donatien 0:ae46a0638b2c 176 //Private methods
donatien 0:ae46a0638b2c 177 void WANDongle::init()
donatien 0:ae46a0638b2c 178 {
donatien 10:08bce4cd973a 179 m_pInitializer = NULL;
donatien 0:ae46a0638b2c 180 dev_connected = false;
donatien 3:4394986752db 181 for(int i = 0; i < WANDONGLE_MAX_SERIAL_PORTS; i++)
donatien 3:4394986752db 182 {
donatien 3:4394986752db 183 m_serial[i].init(host);
donatien 3:4394986752db 184 }
donatien 0:ae46a0638b2c 185 }
donatien 6:075e36a3463e 186
donatien 6:075e36a3463e 187
donatien 6:075e36a3463e 188 /*virtual*/ void WANDongle::setVidPid(uint16_t vid, uint16_t pid)
donatien 6:075e36a3463e 189 {
donatien 6:075e36a3463e 190 //Load right initializer
donatien 10:08bce4cd973a 191 WANDongleInitializer** initializer = WANDongleInitializer::getInitializers(host);
donatien 10:08bce4cd973a 192
donatien 10:08bce4cd973a 193 while(*initializer)
donatien 10:08bce4cd973a 194 {
donatien 10:08bce4cd973a 195 DBG("*initializer=%p", *initializer);
donatien 10:08bce4cd973a 196 DBG("(*initializer)->getSerialVid()=%04x", (*initializer)->getSerialVid());
donatien 10:08bce4cd973a 197 DBG("(*initializer)->getSerialPid()=%04x", (*initializer)->getSerialPid());
donatien 10:08bce4cd973a 198 if ((dev->getVid() == (*initializer)->getSerialVid()) && (dev->getPid() == (*initializer)->getSerialPid()))
donatien 10:08bce4cd973a 199 {
donatien 10:08bce4cd973a 200 DBG("The dongle is in virtual serial mode");
donatien 10:08bce4cd973a 201 m_pInitializer = *initializer;
donatien 10:08bce4cd973a 202 break;
donatien 10:08bce4cd973a 203 }
donatien 10:08bce4cd973a 204 else if ((dev->getVid() == (*initializer)->getMSDVid()) && (dev->getPid() == (*initializer)->getMSDPid()))
donatien 10:08bce4cd973a 205 {
donatien 10:08bce4cd973a 206 DBG("Vodafone K3370 dongle detected in MSD mode");
donatien 10:08bce4cd973a 207 m_pInitializer = *initializer;
donatien 10:08bce4cd973a 208 break;
donatien 10:08bce4cd973a 209 }
donatien 10:08bce4cd973a 210 initializer++;
donatien 10:08bce4cd973a 211 } //while()
donatien 10:08bce4cd973a 212 if(m_pInitializer)
donatien 10:08bce4cd973a 213 {
donatien 10:08bce4cd973a 214 m_pInitializer->setVidPid(vid, pid);
donatien 10:08bce4cd973a 215 }
donatien 6:075e36a3463e 216 }
donatien 6:075e36a3463e 217
donatien 6:075e36a3463e 218 /*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 219 {
donatien 6:075e36a3463e 220 if(m_pInitializer)
donatien 6:075e36a3463e 221 {
donatien 6:075e36a3463e 222 return m_pInitializer->parseInterface(intf_nb, intf_class, intf_subclass, intf_protocol);
donatien 6:075e36a3463e 223 }
donatien 6:075e36a3463e 224 else
donatien 6:075e36a3463e 225 {
donatien 6:075e36a3463e 226 return false;
donatien 6:075e36a3463e 227 }
donatien 6:075e36a3463e 228 }
donatien 6:075e36a3463e 229
donatien 6:075e36a3463e 230 /*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 231 {
donatien 6:075e36a3463e 232 if(m_pInitializer)
donatien 6:075e36a3463e 233 {
donatien 6:075e36a3463e 234 return m_pInitializer->useEndpoint(intf_nb, type, dir);
donatien 6:075e36a3463e 235 }
donatien 6:075e36a3463e 236 else
donatien 6:075e36a3463e 237 {
donatien 6:075e36a3463e 238 return false;
donatien 6:075e36a3463e 239 }
donatien 6:075e36a3463e 240 }