Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket USBHostWANDongle lwip-sys lwip

Dependents:   VodafoneUSBModemHTTPClientTest VodafoneUSBModemNTPClientTest VodafoneUSBModemSMSTest VodafoneUSBModemUSSDTest ... more

Fork of VodafoneUSBModem_bleedingedge by Donatien Garnier

This is the driver for the Vodafone K3700 & K3772-Z Dongles:

K3770

More details and instructions can be found here.

Committer:
donatien
Date:
Wed Jul 11 12:47:53 2012 +0000
Revision:
11:565b2ec40dea
Parent:
10:21a6f09d5631
Parent:
9:3f077dde13c9
Child:
12:66dc2c8eba2d
Merge;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 8:04b6a042595f 1 /* PPPIPInterface.cpp */
donatien 8:04b6a042595f 2 /*
donatien 8:04b6a042595f 3 Copyright (C) 2012 ARM Limited.
donatien 8:04b6a042595f 4
donatien 8:04b6a042595f 5 Permission is hereby granted, free of charge, to any person obtaining a copy of
donatien 8:04b6a042595f 6 this software and associated documentation files (the "Software"), to deal in
donatien 8:04b6a042595f 7 the Software without restriction, including without limitation the rights to
donatien 8:04b6a042595f 8 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
donatien 8:04b6a042595f 9 of the Software, and to permit persons to whom the Software is furnished to do
donatien 8:04b6a042595f 10 so, subject to the following conditions:
donatien 8:04b6a042595f 11
donatien 8:04b6a042595f 12 The above copyright notice and this permission notice shall be included in all
donatien 8:04b6a042595f 13 copies or substantial portions of the Software.
donatien 8:04b6a042595f 14
donatien 8:04b6a042595f 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
donatien 8:04b6a042595f 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
donatien 8:04b6a042595f 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
donatien 8:04b6a042595f 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
donatien 8:04b6a042595f 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 8:04b6a042595f 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
donatien 8:04b6a042595f 21 SOFTWARE.
donatien 8:04b6a042595f 22 */
donatien 8:04b6a042595f 23
donatien 8:04b6a042595f 24 #define __DEBUG__ 2 //Maximum verbosity
donatien 8:04b6a042595f 25 #ifndef __MODULE__
donatien 8:04b6a042595f 26 #define __MODULE__ "PPPIPInterface.cpp"
donatien 8:04b6a042595f 27 #endif
donatien 8:04b6a042595f 28
donatien 8:04b6a042595f 29 #include "core/fwk.h"
donatien 8:04b6a042595f 30 #include "rtos.h"
donatien 8:04b6a042595f 31
donatien 8:04b6a042595f 32 #include "PPPIPInterface.h"
donatien 8:04b6a042595f 33
donatien 8:04b6a042595f 34 extern "C" {
donatien 8:04b6a042595f 35 #include "lwip/ip_addr.h"
donatien 8:04b6a042595f 36 #include "lwip/inet.h"
donatien 8:04b6a042595f 37 #include "netif/ppp/ppp.h"
donatien 8:04b6a042595f 38 }
donatien 8:04b6a042595f 39
donatien 8:04b6a042595f 40 PPPIPInterface::PPPIPInterface(IOStream* pStream) : LwIPInterface(), m_linkStatusSphre(1), m_pppErrCode(0), m_pStream(pStream), m_streamAvail(true), m_pppd(-1)
donatien 8:04b6a042595f 41 {
donatien 8:04b6a042595f 42 m_linkStatusSphre.wait();
donatien 8:04b6a042595f 43 }
donatien 8:04b6a042595f 44
donatien 8:04b6a042595f 45 /*virtual*/ PPPIPInterface::~PPPIPInterface()
donatien 8:04b6a042595f 46 {
donatien 8:04b6a042595f 47
donatien 8:04b6a042595f 48 }
donatien 8:04b6a042595f 49
donatien 8:04b6a042595f 50 /*virtual*/ int PPPIPInterface::init() //Init PPP-specific stuff, create the right bindings, etc
donatien 8:04b6a042595f 51 {
donatien 8:04b6a042595f 52 DBG("Initializing LwIP");
donatien 8:04b6a042595f 53 LwIPInterface::init(); //Init LwIP, NOT including PPP
donatien 8:04b6a042595f 54 DBG("Initializing PPP");
donatien 8:04b6a042595f 55 pppInit();
donatien 8:04b6a042595f 56 DBG("Done");
donatien 8:04b6a042595f 57 return OK;
donatien 8:04b6a042595f 58 }
donatien 8:04b6a042595f 59
donatien 8:04b6a042595f 60 int PPPIPInterface::setup(const char* user, const char* pw)
donatien 8:04b6a042595f 61 {
donatien 8:04b6a042595f 62 DBG("Configuring PPP authentication method");
donatien 8:04b6a042595f 63 pppSetAuth(PPPAUTHTYPE_ANY, user, pw);
donatien 8:04b6a042595f 64 DBG("Done");
donatien 8:04b6a042595f 65 return OK;
donatien 8:04b6a042595f 66 }
donatien 8:04b6a042595f 67
donatien 9:3f077dde13c9 68 /*virtual*/ int PPPIPInterface::connect(const char* msisdn)
donatien 8:04b6a042595f 69 {
donatien 9:3f077dde13c9 70 int ret;
donatien 9:3f077dde13c9 71 char buf[32];
donatien 9:3f077dde13c9 72 size_t len;
donatien 8:04b6a042595f 73 DBG("Trying to connect with PPP");
donatien 9:3f077dde13c9 74
donatien 9:3f077dde13c9 75 do //Clear buf
donatien 9:3f077dde13c9 76 {
donatien 9:3f077dde13c9 77 ret = m_pStream->read(buf, &len, 32, 0) > 0
donatien 9:3f077dde13c9 78 } while( (ret == OK) && (len > 0) );
donatien 9:3f077dde13c9 79
donatien 9:3f077dde13c9 80 sprintf(buf, "ATD %16s\x0D");
donatien 9:3f077dde13c9 81
donatien 9:3f077dde13c9 82 ret = m_pStream->write(buf, strlen(buf), osWaitForever);
donatien 9:3f077dde13c9 83 if( ret != OK )
donatien 9:3f077dde13c9 84 {
donatien 9:3f077dde13c9 85 return NET_UNKNOWN;
donatien 9:3f077dde13c9 86 }
donatien 9:3f077dde13c9 87
donatien 9:3f077dde13c9 88 const char expected = "\x0D\0x0ACONNECT\x0D\0x0A";
donatien 9:3f077dde13c9 89
donatien 9:3f077dde13c9 90 ret = m_pStream->read(buf, strlen(expected), &len, 3000);
donatien 9:3f077dde13c9 91 if( ret != OK )
donatien 9:3f077dde13c9 92 {
donatien 9:3f077dde13c9 93 return NET_UNKNOWN;
donatien 9:3f077dde13c9 94 }
donatien 9:3f077dde13c9 95
donatien 9:3f077dde13c9 96 if( (len < strlen(expected)) || (memcmp(expected, buf) != 0) )
donatien 9:3f077dde13c9 97 {
donatien 9:3f077dde13c9 98 //Discard buffer
donatien 9:3f077dde13c9 99 do //Clear buf
donatien 9:3f077dde13c9 100 {
donatien 9:3f077dde13c9 101 ret = m_pStream->read(buf, &len, 32, 0) > 0
donatien 9:3f077dde13c9 102 } while( (ret == OK) && (len > 0) );
donatien 9:3f077dde13c9 103 return NET_CONN;
donatien 9:3f077dde13c9 104 }
donatien 9:3f077dde13c9 105
donatien 9:3f077dde13c9 106 DBG("Transport link open");
donatien 8:04b6a042595f 107 m_linkStatusSphre.wait(0);
donatien 8:04b6a042595f 108 if((m_pppd != -1) && (m_pppErrCode == 0)) //Already connected
donatien 8:04b6a042595f 109 {
donatien 8:04b6a042595f 110 return NET_INVALID;
donatien 8:04b6a042595f 111 }
donatien 8:04b6a042595f 112 int ret = pppOverSerialOpen(this, PPPIPInterface::linkStatusCb, this);
donatien 8:04b6a042595f 113 if(ret < 0)
donatien 8:04b6a042595f 114 {
donatien 8:04b6a042595f 115 switch(ret)
donatien 8:04b6a042595f 116 {
donatien 8:04b6a042595f 117 case PPPERR_OPEN:
donatien 8:04b6a042595f 118 default:
donatien 8:04b6a042595f 119 return NET_FULL; //All available resources are already used
donatien 8:04b6a042595f 120 }
donatien 8:04b6a042595f 121 }
donatien 8:04b6a042595f 122 m_pppd = ret; //PPP descriptor
donatien 8:04b6a042595f 123 m_linkStatusSphre.wait(); //Block indefinitely; there should be a timeout there
donatien 8:04b6a042595f 124 if(m_pppErrCode != PPPERR_NONE)
donatien 8:04b6a042595f 125 {
donatien 8:04b6a042595f 126 m_pppd = -1;
donatien 8:04b6a042595f 127 }
donatien 8:04b6a042595f 128 switch(m_pppErrCode)
donatien 8:04b6a042595f 129 {
donatien 8:04b6a042595f 130 case PPPERR_NONE: //Connected OK
donatien 8:04b6a042595f 131 return OK;
donatien 8:04b6a042595f 132 case PPPERR_CONNECT: //Connection lost
donatien 8:04b6a042595f 133 return NET_INTERRUPTED;
donatien 8:04b6a042595f 134 case PPPERR_AUTHFAIL: //Authentication failed
donatien 8:04b6a042595f 135 return NET_AUTH;
donatien 8:04b6a042595f 136 case PPPERR_PROTOCOL: //Protocol error
donatien 8:04b6a042595f 137 return NET_PROTOCOL;
donatien 8:04b6a042595f 138 default:
donatien 8:04b6a042595f 139 return NET_UNKNOWN;
donatien 8:04b6a042595f 140 }
donatien 8:04b6a042595f 141 }
donatien 8:04b6a042595f 142
donatien 8:04b6a042595f 143 /*virtual*/ int PPPIPInterface::disconnect()
donatien 8:04b6a042595f 144 {
donatien 8:04b6a042595f 145 int ret = m_linkStatusSphre.wait(0);
donatien 8:04b6a042595f 146 if(ret > 0) //Already disconnected?
donatien 8:04b6a042595f 147 {
donatien 8:04b6a042595f 148 m_pppd = -1; //Discard PPP descriptor
donatien 8:04b6a042595f 149 switch(m_pppErrCode)
donatien 8:04b6a042595f 150 {
donatien 8:04b6a042595f 151 case PPPERR_CONNECT: //Connection terminated
donatien 8:04b6a042595f 152 case PPPERR_AUTHFAIL: //Authentication failed
donatien 8:04b6a042595f 153 case PPPERR_PROTOCOL: //Protocol error
donatien 8:04b6a042595f 154 case PPPERR_USER:
donatien 8:04b6a042595f 155 return OK;
donatien 8:04b6a042595f 156 default:
donatien 8:04b6a042595f 157 return NET_UNKNOWN;
donatien 8:04b6a042595f 158 }
donatien 8:04b6a042595f 159 }
donatien 8:04b6a042595f 160 else
donatien 8:04b6a042595f 161 {
donatien 8:04b6a042595f 162 if(m_pppd == -1)
donatien 8:04b6a042595f 163 {
donatien 8:04b6a042595f 164 return NET_INVALID;
donatien 8:04b6a042595f 165 }
donatien 8:04b6a042595f 166 pppClose(m_pppd);
donatien 8:04b6a042595f 167 do
donatien 8:04b6a042595f 168 {
donatien 8:04b6a042595f 169 m_linkStatusSphre.wait(); //Block indefinitely; there should be a timeout there
donatien 8:04b6a042595f 170 DBG("Received PPP err code %d", m_pppErrCode);
donatien 8:04b6a042595f 171 } while(m_pppErrCode != PPPERR_USER);
donatien 8:04b6a042595f 172 m_pppd = -1; //Discard PPP descriptor
donatien 8:04b6a042595f 173 }
donatien 8:04b6a042595f 174 return OK;
donatien 8:04b6a042595f 175 }
donatien 8:04b6a042595f 176
donatien 8:04b6a042595f 177 /*static*/ void PPPIPInterface::linkStatusCb(void *ctx, int errCode, void *arg) //PPP link status
donatien 8:04b6a042595f 178 {
donatien 8:04b6a042595f 179 PPPIPInterface* pIf = (PPPIPInterface*)ctx;
donatien 8:04b6a042595f 180 struct ppp_addrs* addrs = (struct ppp_addrs*) arg;
donatien 8:04b6a042595f 181
donatien 8:04b6a042595f 182 switch(errCode)
donatien 8:04b6a042595f 183 {
donatien 8:04b6a042595f 184 case PPPERR_NONE:
donatien 8:04b6a042595f 185 WARN("Connected via PPP.");
donatien 8:04b6a042595f 186 DBG("Local IP address: %s", inet_ntoa(addrs->our_ipaddr));
donatien 8:04b6a042595f 187 DBG("Netmask: %s", inet_ntoa(addrs->netmask));
donatien 8:04b6a042595f 188 DBG("Remote IP address: %s", inet_ntoa(addrs->his_ipaddr));
donatien 8:04b6a042595f 189 DBG("Primary DNS: %s", inet_ntoa(addrs->dns1));
donatien 8:04b6a042595f 190 DBG("Secondary DNS: %s", inet_ntoa(addrs->dns2));
donatien 10:21a6f09d5631 191 pIf->setConnected(true);
donatien 10:21a6f09d5631 192 pIf->setIPAddress(inet_ntoa(addrs->our_ipaddr));
donatien 8:04b6a042595f 193 break;
donatien 8:04b6a042595f 194 case PPPERR_CONNECT: //Connection lost
donatien 8:04b6a042595f 195 WARN("Connection lost/terminated");
donatien 10:21a6f09d5631 196 pIf->setConnected(false);
donatien 8:04b6a042595f 197 break;
donatien 8:04b6a042595f 198 case PPPERR_AUTHFAIL: //Authentication failed
donatien 8:04b6a042595f 199 WARN("Authentication failed");
donatien 10:21a6f09d5631 200 pIf->setConnected(false);
donatien 8:04b6a042595f 201 break;
donatien 8:04b6a042595f 202 case PPPERR_PROTOCOL: //Protocol error
donatien 8:04b6a042595f 203 WARN("Protocol error");
donatien 10:21a6f09d5631 204 pIf->setConnected(false);
donatien 8:04b6a042595f 205 break;
donatien 8:04b6a042595f 206 case PPPERR_USER:
donatien 8:04b6a042595f 207 WARN("Disconnected by user");
donatien 10:21a6f09d5631 208 pIf->setConnected(false);
donatien 8:04b6a042595f 209 break;
donatien 8:04b6a042595f 210 default:
donatien 8:04b6a042595f 211 WARN("Unknown error (%d)", errCode);
donatien 10:21a6f09d5631 212 pIf->setConnected(false);
donatien 8:04b6a042595f 213 break;
donatien 8:04b6a042595f 214 }
donatien 8:04b6a042595f 215
donatien 8:04b6a042595f 216 pIf->m_linkStatusSphre.wait(0); //If previous event has not been handled, "delete" it now
donatien 8:04b6a042595f 217 pIf->m_pppErrCode = errCode;
donatien 8:04b6a042595f 218 pIf->m_linkStatusSphre.release();
donatien 8:04b6a042595f 219 }
donatien 8:04b6a042595f 220
donatien 8:04b6a042595f 221 //LwIP PPP implementation
donatien 8:04b6a042595f 222 extern "C"
donatien 8:04b6a042595f 223 {
donatien 8:04b6a042595f 224
donatien 8:04b6a042595f 225 /**
donatien 8:04b6a042595f 226 * Writes to the serial device.
donatien 8:04b6a042595f 227 *
donatien 8:04b6a042595f 228 * @param fd serial device handle
donatien 8:04b6a042595f 229 * @param data pointer to data to send
donatien 8:04b6a042595f 230 * @param len length (in bytes) of data to send
donatien 8:04b6a042595f 231 * @return number of bytes actually sent
donatien 8:04b6a042595f 232 *
donatien 8:04b6a042595f 233 * @note This function will block until all data can be sent.
donatien 8:04b6a042595f 234 */
donatien 8:04b6a042595f 235 u32_t sio_write(sio_fd_t fd, u8_t *data, u32_t len)
donatien 8:04b6a042595f 236 {
donatien 8:04b6a042595f 237 DBG("sio_write");
donatien 8:04b6a042595f 238 PPPIPInterface* pIf = (PPPIPInterface*)fd;
donatien 8:04b6a042595f 239 int ret;
donatien 8:04b6a042595f 240 if(!pIf->m_streamAvail) //If stream is not available (it is a shared resource) don't go further
donatien 8:04b6a042595f 241 {
donatien 8:04b6a042595f 242 return 0;
donatien 8:04b6a042595f 243 }
donatien 8:04b6a042595f 244 ret = pIf->m_pStream->write(data, len, osWaitForever); //Blocks until all data is sent or an error happens
donatien 8:04b6a042595f 245 if(ret != OK)
donatien 8:04b6a042595f 246 {
donatien 8:04b6a042595f 247 return 0;
donatien 8:04b6a042595f 248 }
donatien 8:04b6a042595f 249 return len;
donatien 8:04b6a042595f 250 }
donatien 8:04b6a042595f 251
donatien 8:04b6a042595f 252 /**
donatien 8:04b6a042595f 253 * Reads from the serial device.
donatien 8:04b6a042595f 254 *
donatien 8:04b6a042595f 255 * @param fd serial device handle
donatien 8:04b6a042595f 256 * @param data pointer to data buffer for receiving
donatien 8:04b6a042595f 257 * @param len maximum length (in bytes) of data to receive
donatien 8:04b6a042595f 258 * @return number of bytes actually received - may be 0 if aborted by sio_read_abort
donatien 8:04b6a042595f 259 *
donatien 8:04b6a042595f 260 * @note This function will block until data can be received. The blocking
donatien 8:04b6a042595f 261 * can be cancelled by calling sio_read_abort().
donatien 8:04b6a042595f 262 */
donatien 8:04b6a042595f 263 u32_t sio_read(sio_fd_t fd, u8_t *data, u32_t len)
donatien 8:04b6a042595f 264 {
donatien 8:04b6a042595f 265 DBG("sio_read");
donatien 8:04b6a042595f 266 PPPIPInterface* pIf = (PPPIPInterface*)fd;
donatien 8:04b6a042595f 267 int ret;
donatien 8:04b6a042595f 268 size_t readLen;
donatien 8:04b6a042595f 269 if(!pIf->m_streamAvail) //If stream is not available (it is a shared resource) don't go further
donatien 8:04b6a042595f 270 {
donatien 8:04b6a042595f 271 WARN("EXIT NOT AVAIL");
donatien 8:04b6a042595f 272 return 0;
donatien 8:04b6a042595f 273 }
donatien 8:04b6a042595f 274 ret = pIf->m_pStream->read(data, &readLen, len, osWaitForever); //Blocks until some data is received or an error happens
donatien 8:04b6a042595f 275 if(ret != OK)
donatien 8:04b6a042595f 276 {
donatien 8:04b6a042595f 277 return 0;
donatien 8:04b6a042595f 278 }
donatien 8:04b6a042595f 279 DBG("ret");
donatien 8:04b6a042595f 280 return readLen;
donatien 8:04b6a042595f 281 }
donatien 8:04b6a042595f 282
donatien 8:04b6a042595f 283 /**
donatien 8:04b6a042595f 284 * Aborts a blocking sio_read() call.
donatien 8:04b6a042595f 285 *
donatien 8:04b6a042595f 286 * @param fd serial device handle
donatien 8:04b6a042595f 287 */
donatien 8:04b6a042595f 288 void sio_read_abort(sio_fd_t fd)
donatien 8:04b6a042595f 289 {
donatien 8:04b6a042595f 290 DBG("sio_read_abort");
donatien 8:04b6a042595f 291 PPPIPInterface* pIf = (PPPIPInterface*)fd;
donatien 8:04b6a042595f 292 if(!pIf->m_streamAvail) //If stream is not available (it is a shared resource) don't go further
donatien 8:04b6a042595f 293 {
donatien 8:04b6a042595f 294 return;
donatien 8:04b6a042595f 295 }
donatien 8:04b6a042595f 296 pIf->m_pStream->abortRead();
donatien 8:04b6a042595f 297 DBG("ret");
donatien 8:04b6a042595f 298 }
donatien 8:04b6a042595f 299
donatien 8:04b6a042595f 300 }
donatien 8:04b6a042595f 301