Simon Ford / NetServices

Version of http://mbed.org/cookbook/NetServicesTribute with setting set the same for LPC2368

Dependents:   UDPSocketExample 24LCxx_I2CApp WeatherPlatform_pachube HvZServerLib ... more

if/umtsstick/UMTSStickNetIf.h@0:350011bf8be7, 2010-11-23 (annotated)

Committer:
simon
Date:
Tue Nov 23 14:15:36 2010 +0000
Revision:
0:350011bf8be7
Experimental version for testing UDP

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon 0:350011bf8be7 1
simon 0:350011bf8be7 2 /*
simon 0:350011bf8be7 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
simon 0:350011bf8be7 4
simon 0:350011bf8be7 5 Permission is hereby granted, free of charge, to any person obtaining a copy
simon 0:350011bf8be7 6 of this software and associated documentation files (the "Software"), to deal
simon 0:350011bf8be7 7 in the Software without restriction, including without limitation the rights
simon 0:350011bf8be7 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
simon 0:350011bf8be7 9 copies of the Software, and to permit persons to whom the Software is
simon 0:350011bf8be7 10 furnished to do so, subject to the following conditions:
simon 0:350011bf8be7 11
simon 0:350011bf8be7 12 The above copyright notice and this permission notice shall be included in
simon 0:350011bf8be7 13 all copies or substantial portions of the Software.
simon 0:350011bf8be7 14
simon 0:350011bf8be7 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
simon 0:350011bf8be7 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
simon 0:350011bf8be7 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
simon 0:350011bf8be7 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
simon 0:350011bf8be7 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
simon 0:350011bf8be7 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
simon 0:350011bf8be7 21 THE SOFTWARE.
simon 0:350011bf8be7 22 */
simon 0:350011bf8be7 23
simon 0:350011bf8be7 24 /** \file
simon 0:350011bf8be7 25 UMTS Stick network interface header file
simon 0:350011bf8be7 26 */
simon 0:350011bf8be7 27
simon 0:350011bf8be7 28 #ifndef UMTSSTICKNETIF_H
simon 0:350011bf8be7 29 #define UMTSSTICKNETIF_H
simon 0:350011bf8be7 30
simon 0:350011bf8be7 31 #include "mbed.h"
simon 0:350011bf8be7 32
simon 0:350011bf8be7 33 #include "core/net.h"
simon 0:350011bf8be7 34 #include "if/ppp/PPPNetIf.h"
simon 0:350011bf8be7 35
simon 0:350011bf8be7 36 #include "drv/umtsstick/UMTSStick.h"
simon 0:350011bf8be7 37
simon 0:350011bf8be7 38 ///UMTS Stick network interface
simon 0:350011bf8be7 39 /**
simon 0:350011bf8be7 40 This class provides connectivity to the stack using a 3G (or LTE etc...) stick
simon 0:350011bf8be7 41 Plug it to your USB host using two Pull-down resistors on the D+/D- lines
simon 0:350011bf8be7 42 */
simon 0:350011bf8be7 43 class UMTSStickNetIf : public LwipNetIf, protected PPPNetIf
simon 0:350011bf8be7 44 {
simon 0:350011bf8be7 45 public:
simon 0:350011bf8be7 46 ///Instantiates the Interface and register it against the stack
simon 0:350011bf8be7 47 UMTSStickNetIf();
simon 0:350011bf8be7 48 virtual ~UMTSStickNetIf();
simon 0:350011bf8be7 49
simon 0:350011bf8be7 50 ///Tries to connect to the stick
simon 0:350011bf8be7 51 /**
simon 0:350011bf8be7 52 This method tries to obtain a virtual serial port interface from the stick
simon 0:350011bf8be7 53 It waits for a stick to be connected, switches it from CDFS to virtual serial port mode if needed,
simon 0:350011bf8be7 54 and obtains a virtual serial port from it
simon 0:350011bf8be7 55 @return : A negative error code on error or 0 on success
simon 0:350011bf8be7 56 */
simon 0:350011bf8be7 57 UMTSStickErr setup(); //UMTSStickErr is from /drv/umtsstick/UMTSStick.h
simon 0:350011bf8be7 58
simon 0:350011bf8be7 59 ///Establishes a PPP connection
simon 0:350011bf8be7 60 /**
simon 0:350011bf8be7 61 This method opens an AT interface on the serial interface, initializes and configures the stick,
simon 0:350011bf8be7 62 then opens a PPP connection and authenticates with the parameters
simon 0:350011bf8be7 63 \param apn : APN of the interface, if NULL uses the SIM default value
simon 0:350011bf8be7 64 \param userId : user with which to authenticate during the PPP connection, if NULL does not authenticate
simon 0:350011bf8be7 65 \param password : associated password
simon 0:350011bf8be7 66 @return : A negative error code on error or 0 on success
simon 0:350011bf8be7 67 */
simon 0:350011bf8be7 68 PPPErr connect(const char* apn = NULL, const char* userId = NULL, const char* password = NULL); //Connect using GPRS
simon 0:350011bf8be7 69
simon 0:350011bf8be7 70 ///Disconnects the PPP connection
simon 0:350011bf8be7 71 PPPErr disconnect();
simon 0:350011bf8be7 72
simon 0:350011bf8be7 73 private:
simon 0:350011bf8be7 74 UMTSStick m_umtsStick;
simon 0:350011bf8be7 75 UsbSerial* m_pUsbSerial;
simon 0:350011bf8be7 76
simon 0:350011bf8be7 77 };
simon 0:350011bf8be7 78
simon 0:350011bf8be7 79 #endif
simon 0:350011bf8be7 80