u-blox / C027_Support

support library for C027 helper functions for Buffer Pipes, Buffered Serial Port (rtos capable) and GPS parsing. It includes modem APIs for USSD, SMS and Sockets.

Dependents:   HTTPClient_Cellular_HelloWorld Cellular_HelloMQTT MbedSmartRestMain Car_Bon_car_module ... more

This library is intended to be used with u-blox products such as the C027 or a shield with u-blox cellular and GPS modules like the cellular and positioning shield from Embedded Artist.

For 2G/GSM and 3G/UMTS you need to:

  • have a SIM card and know its PIN number
  • need to know you network operators APN setting These setting should be passed to the connect or init and join functions. You can also extend the APN database in MDMAPN.h.

For CDMA products you need to make sure that you have provisioned and activated the modem with either Sprint or Verizon.

MDM.h@132:de505da3aadf, 2015-11-11 (annotated)

Committer:
mazgch
Date:
Wed Nov 11 16:26:19 2015 +0000
Revision:
132:de505da3aadf
Parent:
131:965a7cbc1e58
Child:
133:57b208dd96fb
.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mazgch 17:296d94a006b4 1 #pragma once
mazgch 17:296d94a006b4 2
mazgch 17:296d94a006b4 3 #include "mbed.h"
mazgch 21:c4d64830bf02 4 #include <stdarg.h>
mazgch 21:c4d64830bf02 5
mazgch 18:e5697801df29 6 #include "Pipe.h"
mazgch 18:e5697801df29 7 #include "SerialPipe.h"
mazgch 17:296d94a006b4 8
mazgch 130:3189949981ec 9 #ifdef TARGET_UBLOX_C027
mazgch 130:3189949981ec 10 // you can change this is you like to use a shield even on the C027
mazgch 75:ce6e12067d0c 11 #define MDM_IF(onboard,shield) onboard
mazgch 19:2b5d097ca15d 12 #else
mazgch 75:ce6e12067d0c 13 #define MDM_IF(onboard,shield) shield
mazgch 19:2b5d097ca15d 14 #endif
mazgch 18:e5697801df29 15
mazgch 74:208e3e32d263 16 //! include debug capabilty on more powerful targets with a dedicated debug port
mazgch 74:208e3e32d263 17 #if defined(TARGET_LPC1768) || defined(TARGET_LPC4088) || defined(TARGET_K64F)
mazgch 74:208e3e32d263 18 #define MDM_DEBUG
mazgch 74:208e3e32d263 19 #endif
mazgch 74:208e3e32d263 20
mazgch 38:e6cab4632d84 21 /** basic modem parser class
mazgch 38:e6cab4632d84 22 */
mazgch 18:e5697801df29 23 class MDMParser
mazgch 18:e5697801df29 24 {
mazgch 18:e5697801df29 25 public:
mazgch 31:a0bed6c1e05d 26 //! Constructor
mazgch 76:f7c3dd568dae 27 MDMParser(void);
mazgch 44:9d12223b78ff 28 //! get static instance
mazgch 44:9d12223b78ff 29 static MDMParser* getInstance() { return inst; };
mazgch 31:a0bed6c1e05d 30
mazgch 31:a0bed6c1e05d 31 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 32 // Types
mazgch 31:a0bed6c1e05d 33 // ----------------------------------------------------------------
mazgch 38:e6cab4632d84 34 //! MT Device Types
mazgch 123:66cef6353b13 35 typedef enum { DEV_UNKNOWN,
mazgch 125:25a292afbac6 36 DEV_SARA_G35, DEV_LISA_U2, DEV_LISA_C2,
mazgch 125:25a292afbac6 37 DEV_SARA_U2, DEV_LEON_G2, DEV_TOBY_L2, DEV_MPCI_L2 } Dev;
mazgch 38:e6cab4632d84 38 //! SIM Status
mazgch 75:ce6e12067d0c 39 typedef enum { SIM_UNKNOWN, SIM_MISSING, SIM_PIN, SIM_READY } Sim;
mazgch 38:e6cab4632d84 40 //! SIM Status
mazgch 76:f7c3dd568dae 41 typedef enum { LPM_DISABLED, LPM_ENABLED, LPM_ACTIVE } Lpm;
mazgch 38:e6cab4632d84 42 //! Device status
mazgch 33:fb8fb5021b09 43 typedef struct {
mazgch 34:3b3b7807c0c3 44 Dev dev; //!< Device Type
mazgch 35:9275215a3a5b 45 Lpm lpm; //!< Power Saving
mazgch 34:3b3b7807c0c3 46 Sim sim; //!< SIM Card Status
mazgch 34:3b3b7807c0c3 47 char ccid[20+1]; //!< Integrated Circuit Card ID
mazgch 34:3b3b7807c0c3 48 char imsi[15+1]; //!< International Mobile Station Identity
mazgch 34:3b3b7807c0c3 49 char imei[15+1]; //!< International Mobile Equipment Identity
mazgch 34:3b3b7807c0c3 50 char meid[18+1]; //!< Mobile Equipment IDentifier
mazgch 34:3b3b7807c0c3 51 char manu[16]; //!< Manufacturer (u-blox)
mazgch 34:3b3b7807c0c3 52 char model[16]; //!< Model Name (LISA-U200, LISA-C200 or SARA-G350)
mazgch 34:3b3b7807c0c3 53 char ver[16]; //!< Software Version
mazgch 38:e6cab4632d84 54 } DevStatus;
mazgch 38:e6cab4632d84 55 //! Registration Status
mazgch 38:e6cab4632d84 56 typedef enum { REG_UNKNOWN, REG_DENIED, REG_NONE, REG_HOME, REG_ROAMING } Reg;
mazgch 38:e6cab4632d84 57 //! Access Technology
mazgch 123:66cef6353b13 58 typedef enum { ACT_UNKNOWN, ACT_GSM, ACT_EDGE, ACT_UTRAN, ACT_CDMA, ACT_LTE } AcT;
mazgch 38:e6cab4632d84 59 //! Network Status
mazgch 33:fb8fb5021b09 60 typedef struct {
mazgch 79:291df065e345 61 Reg csd; //!< CSD Registration Status (Circuit Switched Data)
mazgch 79:291df065e345 62 Reg psd; //!< PSD Registration status (Packet Switched Data)
mazgch 123:66cef6353b13 63 Reg eps; //!< EPS Registration status
mazgch 34:3b3b7807c0c3 64 AcT act; //!< Access Technology
mazgch 121:8da935c2c08c 65 int rssi; //!< Received Signal Strength Indication (in dBm, range -113..-51)
mazgch 54:7ba8e4c218e2 66 int ber; //!< Bit Error Rate (BER), see 3GPP TS 45.008 [20] subclause 8.2.4
mazgch 34:3b3b7807c0c3 67 char opr[16+1]; //!< Operator Name
mazgch 34:3b3b7807c0c3 68 char num[32]; //!< Mobile Directory Number
mazgch 54:7ba8e4c218e2 69 unsigned short lac; //!< location area code in hexadecimal format (2 bytes in hex)
mazgch 54:7ba8e4c218e2 70 unsigned int ci; //!< Cell ID in hexadecimal format (2 to 4 bytes in hex)
mazgch 38:e6cab4632d84 71 } NetStatus;
mazgch 38:e6cab4632d84 72 //! An IP v4 address
mazgch 38:e6cab4632d84 73 typedef uint32_t IP;
mazgch 33:fb8fb5021b09 74 #define NOIP ((MDMParser::IP)0) //!< No IP address
mazgch 31:a0bed6c1e05d 75 // ip number formating and conversion
mazgch 31:a0bed6c1e05d 76 #define IPSTR "%d.%d.%d.%d"
mazgch 31:a0bed6c1e05d 77 #define IPNUM(ip) ((ip)>>24)&0xff, \
mazgch 31:a0bed6c1e05d 78 ((ip)>>16)&0xff, \
mazgch 31:a0bed6c1e05d 79 ((ip)>> 8)&0xff, \
mazgch 31:a0bed6c1e05d 80 ((ip)>> 0)&0xff
mazgch 31:a0bed6c1e05d 81 #define IPADR(a,b,c,d) ((((IP)(a))<<24) | \
mazgch 31:a0bed6c1e05d 82 (((IP)(b))<<16) | \
mazgch 31:a0bed6c1e05d 83 (((IP)(c))<< 8) | \
mazgch 31:a0bed6c1e05d 84 (((IP)(d))<< 0))
mazgch 31:a0bed6c1e05d 85
mazgch 31:a0bed6c1e05d 86
mazgch 31:a0bed6c1e05d 87 // ----------------------------------------------------------------
mazgch 57:869bd35f44cc 88 // Device
mazgch 31:a0bed6c1e05d 89 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 90
mazgch 80:34985b4d821e 91 typedef enum { AUTH_NONE, AUTH_PAP, AUTH_CHAP, AUTH_DETECT } Auth;
mazgch 80:34985b4d821e 92
mazgch 57:869bd35f44cc 93 /** Combined Init, checkNetStatus, join suitable for simple applications
mazgch 57:869bd35f44cc 94 \param simpin a optional pin of the SIM card
mazgch 57:869bd35f44cc 95 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 96 \param username is the user name text string for the authentication phase
mazgch 57:869bd35f44cc 97 \param password is the password text string for the authentication phase
mazgch 80:34985b4d821e 98 \param auth is the authentication mode (CHAP,PAP,NONE or DETECT)
mazgch 57:869bd35f44cc 99 \return true if successful, false otherwise
mazgch 57:869bd35f44cc 100 */
mazgch 94:d697fe11f3e5 101 bool connect(const char* simpin = NULL,
mazgch 94:d697fe11f3e5 102 const char* apn = NULL, const char* username = NULL,
mazgch 94:d697fe11f3e5 103 const char* password = NULL, Auth auth = AUTH_DETECT,
mazgch 75:ce6e12067d0c 104 PinName pn MDM_IF( = MDMPWRON, = D4));
mazgch 57:869bd35f44cc 105
mazgch 31:a0bed6c1e05d 106 /** register (Attach) the MT to the GPRS service.
mazgch 57:869bd35f44cc 107 \param simpin a optional pin of the SIM card
mazgch 31:a0bed6c1e05d 108 \param status an optional struture to with device information
mazgch 31:a0bed6c1e05d 109 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 110 */
mazgch 123:66cef6353b13 111 virtual bool init(const char* simpin = NULL, DevStatus* status = NULL,
mazgch 75:ce6e12067d0c 112 PinName pn MDM_IF( = MDMPWRON, = D4));
mazgch 123:66cef6353b13 113
mazgch 120:0e718a4ea25e 114 /** get the current device status
mazgch 120:0e718a4ea25e 115 \param strocture holding the device information.
mazgch 120:0e718a4ea25e 116 */
mazgch 123:66cef6353b13 117 void getDevStatus(MDMParser::DevStatus* dev) { memcpy(dev, &_dev, sizeof(DevStatus)); }
mazgch 75:ce6e12067d0c 118
mazgch 75:ce6e12067d0c 119 /** register to the network
mazgch 75:ce6e12067d0c 120 \param status an optional structure to with network information
mazgch 75:ce6e12067d0c 121 \param timeout_ms -1 blocking, else non blocking timeout in ms
mazgch 75:ce6e12067d0c 122 \return true if successful and connected to network, false otherwise
mazgch 75:ce6e12067d0c 123 */
mazgch 75:ce6e12067d0c 124 bool registerNet(NetStatus* status = NULL, int timeout_ms = 180000);
mazgch 31:a0bed6c1e05d 125
mazgch 31:a0bed6c1e05d 126 /** check if the network is available
mazgch 31:a0bed6c1e05d 127 \param status an optional structure to with network information
mazgch 31:a0bed6c1e05d 128 \return true if successful and connected to network, false otherwise
mazgch 31:a0bed6c1e05d 129 */
mazgch 31:a0bed6c1e05d 130 bool checkNetStatus(NetStatus* status = NULL);
mazgch 31:a0bed6c1e05d 131
mazgch 31:a0bed6c1e05d 132 /** Power off the MT, This function has to be called prior to
mazgch 31:a0bed6c1e05d 133 switching off the supply.
mazgch 31:a0bed6c1e05d 134 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 135 */
mazgch 31:a0bed6c1e05d 136 bool powerOff(void);
mazgch 31:a0bed6c1e05d 137
mazgch 31:a0bed6c1e05d 138 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 139 // Data Connection (GPRS)
mazgch 31:a0bed6c1e05d 140 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 141
mazgch 31:a0bed6c1e05d 142 /** register (Attach) the MT to the GPRS service.
mazgch 31:a0bed6c1e05d 143 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 144 \param username is the user name text string for the authentication phase
mazgch 31:a0bed6c1e05d 145 \param password is the password text string for the authentication phase
mazgch 80:34985b4d821e 146 \param auth is the authentication mode (CHAP,PAP,NONE or DETECT)
mazgch 31:a0bed6c1e05d 147 \return the ip that is assigned
mazgch 31:a0bed6c1e05d 148 */
mazgch 79:291df065e345 149 MDMParser::IP join(const char* apn = NULL, const char* username = NULL,
mazgch 79:291df065e345 150 const char* password = NULL, Auth auth = AUTH_DETECT);
mazgch 31:a0bed6c1e05d 151
mazgch 31:a0bed6c1e05d 152 /** deregister (detach) the MT from the GPRS service.
mazgch 31:a0bed6c1e05d 153 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 154 */
mazgch 31:a0bed6c1e05d 155 bool disconnect(void);
mazgch 31:a0bed6c1e05d 156
mazgch 31:a0bed6c1e05d 157 /** Translates a domain name to an IP address
mazgch 31:a0bed6c1e05d 158 \param host the domain name to translate e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 159 \return the IP if successful, 0 otherwise
mazgch 31:a0bed6c1e05d 160 */
mazgch 31:a0bed6c1e05d 161 MDMParser::IP gethostbyname(const char* host);
mazgch 31:a0bed6c1e05d 162
mazgch 120:0e718a4ea25e 163 /** get the current assigned IP address
mazgch 120:0e718a4ea25e 164 \return the ip that is assigned
mazgch 120:0e718a4ea25e 165 */
mazgch 123:66cef6353b13 166 MDMParser::IP getIpAddress(void) { return _ip; }
mazgch 123:66cef6353b13 167
mazgch 31:a0bed6c1e05d 168 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 169 // Sockets
mazgch 31:a0bed6c1e05d 170 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 171
mazgch 31:a0bed6c1e05d 172 //! Type of IP protocol
mazgch 31:a0bed6c1e05d 173 typedef enum { IPPROTO_TCP, IPPROTO_UDP } IpProtocol;
mazgch 31:a0bed6c1e05d 174
mazgch 31:a0bed6c1e05d 175 //! Socket error return codes
mazgch 31:a0bed6c1e05d 176 #define SOCKET_ERROR -1
mazgch 31:a0bed6c1e05d 177
mazgch 63:42cb563a25bc 178 /** Create a socket for a ip protocol (and optionaly bind)
mazgch 31:a0bed6c1e05d 179 \param ipproto the protocol (UDP or TCP)
mazgch 63:42cb563a25bc 180 \param port in case of UDP, this optional port where it is bind
mazgch 31:a0bed6c1e05d 181 \return the socket handle if successful or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 182 */
mazgch 63:42cb563a25bc 183 int socketSocket(IpProtocol ipproto, int port = -1);
mazgch 31:a0bed6c1e05d 184
mazgch 31:a0bed6c1e05d 185 /** make a socket connection
mazgch 31:a0bed6c1e05d 186 \param socket the socket handle
mazgch 31:a0bed6c1e05d 187 \param host the domain name to connect e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 188 \param port the port to connect
mazgch 31:a0bed6c1e05d 189 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 190 */
mazgch 31:a0bed6c1e05d 191 bool socketConnect(int socket, const char* host, int port);
mazgch 31:a0bed6c1e05d 192
mazgch 44:9d12223b78ff 193 /** make a socket connection
mazgch 44:9d12223b78ff 194 \param socket the socket handle
mazgch 44:9d12223b78ff 195 \return true if connected, false otherwise
mazgch 44:9d12223b78ff 196 */
mazgch 44:9d12223b78ff 197 bool socketIsConnected(int socket);
mazgch 44:9d12223b78ff 198
mazgch 44:9d12223b78ff 199 /** Get the number of bytes pending for reading for this socket
mazgch 44:9d12223b78ff 200 \param socket the socket handle
mazgch 44:9d12223b78ff 201 \param timeout_ms -1 blocking, else non blocking timeout in ms
mazgch 44:9d12223b78ff 202 \return 0 if successful or SOCKET_ERROR on failure
mazgch 44:9d12223b78ff 203 */
mazgch 66:69072b3c5bca 204 bool socketSetBlocking(int socket, int timeout_ms);
mazgch 44:9d12223b78ff 205
mazgch 31:a0bed6c1e05d 206 /** Write socket data
mazgch 31:a0bed6c1e05d 207 \param socket the socket handle
mazgch 31:a0bed6c1e05d 208 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 209 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 210 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 211 */
mazgch 31:a0bed6c1e05d 212 int socketSend(int socket, const char * buf, int len);
mazgch 31:a0bed6c1e05d 213
mazgch 31:a0bed6c1e05d 214 /** Write socket data to a IP
mazgch 31:a0bed6c1e05d 215 \param socket the socket handle
mazgch 31:a0bed6c1e05d 216 \param ip the ip to send to
mazgch 31:a0bed6c1e05d 217 \param port the port to send to
mazgch 31:a0bed6c1e05d 218 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 219 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 220 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 221 */
mazgch 31:a0bed6c1e05d 222 int socketSendTo(int socket, IP ip, int port, const char * buf, int len);
mazgch 31:a0bed6c1e05d 223
mazgch 31:a0bed6c1e05d 224 /** Get the number of bytes pending for reading for this socket
mazgch 31:a0bed6c1e05d 225 \param socket the socket handle
mazgch 31:a0bed6c1e05d 226 \return the number of bytes pending or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 227 */
mazgch 31:a0bed6c1e05d 228 int socketReadable(int socket);
mazgch 31:a0bed6c1e05d 229
mazgch 31:a0bed6c1e05d 230 /** Read this socket
mazgch 31:a0bed6c1e05d 231 \param socket the socket handle
mazgch 31:a0bed6c1e05d 232 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 233 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 234 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 235 */
mazgch 31:a0bed6c1e05d 236 int socketRecv(int socket, char* buf, int len);
mazgch 31:a0bed6c1e05d 237
mazgch 31:a0bed6c1e05d 238 /** Read from this socket
mazgch 31:a0bed6c1e05d 239 \param socket the socket handle
mazgch 63:42cb563a25bc 240 \param ip the ip of host where the data originates from
mazgch 63:42cb563a25bc 241 \param port the port where the data originates from
mazgch 31:a0bed6c1e05d 242 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 243 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 244 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 245 */
mazgch 63:42cb563a25bc 246 int socketRecvFrom(int socket, IP* ip, int* port, char* buf, int len);
mazgch 31:a0bed6c1e05d 247
mazgch 31:a0bed6c1e05d 248 /** Close a connectied socket (that was connected with #socketConnect)
mazgch 31:a0bed6c1e05d 249 \param socket the socket handle
mazgch 31:a0bed6c1e05d 250 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 251 */
mazgch 31:a0bed6c1e05d 252 bool socketClose(int socket);
mazgch 31:a0bed6c1e05d 253
mazgch 31:a0bed6c1e05d 254 /** Free the socket (that was allocated before by #socketSocket)
mazgch 31:a0bed6c1e05d 255 \param socket the socket handle
mazgch 31:a0bed6c1e05d 256 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 257 */
mazgch 31:a0bed6c1e05d 258 bool socketFree(int socket);
mazgch 31:a0bed6c1e05d 259
mazgch 31:a0bed6c1e05d 260 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 261 // SMS Short Message Service
mazgch 31:a0bed6c1e05d 262 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 263
mazgch 31:a0bed6c1e05d 264 /** count the number of sms in the device and optionally return a
mazgch 31:a0bed6c1e05d 265 list with indexes from the storage locations in the device.
mazgch 31:a0bed6c1e05d 266 \param stat what type of messages you can use use
mazgch 31:a0bed6c1e05d 267 "REC UNREAD", "REC READ", "STO UNSENT", "STO SENT", "ALL"
mazgch 31:a0bed6c1e05d 268 \param ix list where to save the storage positions
mazgch 31:a0bed6c1e05d 269 \param num number of elements in the list
mazgch 31:a0bed6c1e05d 270 \return the number of messages, this can be bigger than num, -1 on failure
mazgch 31:a0bed6c1e05d 271 */
mazgch 31:a0bed6c1e05d 272 int smsList(const char* stat = "ALL", int* ix = NULL, int num = 0);
mazgch 31:a0bed6c1e05d 273
mazgch 31:a0bed6c1e05d 274 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 275 \param ix the storage position to read
mazgch 31:a0bed6c1e05d 276 \param num the originator address (~16 chars)
mazgch 31:a0bed6c1e05d 277 \param buf a buffer where to save the sm
mazgch 31:a0bed6c1e05d 278 \param len the length of the sm
mazgch 31:a0bed6c1e05d 279 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 280 */
mazgch 31:a0bed6c1e05d 281 bool smsRead(int ix, char* num, char* buf, int len);
mazgch 31:a0bed6c1e05d 282
mazgch 31:a0bed6c1e05d 283 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 284 \param ix the storage position to delete
mazgch 31:a0bed6c1e05d 285 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 286 */
mazgch 31:a0bed6c1e05d 287 bool smsDelete(int ix);
mazgch 31:a0bed6c1e05d 288
mazgch 31:a0bed6c1e05d 289 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 290 \param num the phone number of the recipient
mazgch 31:a0bed6c1e05d 291 \param buf the content of the message to sent
mazgch 31:a0bed6c1e05d 292 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 293 */
mazgch 31:a0bed6c1e05d 294 bool smsSend(const char* num, const char* buf);
mazgch 31:a0bed6c1e05d 295
mazgch 31:a0bed6c1e05d 296 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 297 // USSD Unstructured Supplementary Service Data
mazgch 31:a0bed6c1e05d 298 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 299
mazgch 31:a0bed6c1e05d 300 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 301 \param cmd the ussd command to send e.g "*#06#"
mazgch 31:a0bed6c1e05d 302 \param buf a buffer where to save the reply
mazgch 31:a0bed6c1e05d 303 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 304 */
mazgch 31:a0bed6c1e05d 305 bool ussdCommand(const char* cmd, char* buf);
mazgch 31:a0bed6c1e05d 306
mazgch 38:e6cab4632d84 307 // ----------------------------------------------------------------
mazgch 80:34985b4d821e 308 // FILE
mazgch 80:34985b4d821e 309 // ----------------------------------------------------------------
mazgch 80:34985b4d821e 310
mazgch 80:34985b4d821e 311 /** Delete a file in the local file system
mazgch 80:34985b4d821e 312 \param filename the name of the file
mazgch 80:34985b4d821e 313 \return true if successful, false otherwise
mazgch 80:34985b4d821e 314 */
mazgch 80:34985b4d821e 315 bool delFile(const char* filename);
mazgch 80:34985b4d821e 316
mazgch 80:34985b4d821e 317 /** Write some data to a file in the local file system
mazgch 80:34985b4d821e 318 \param filename the name of the file
mazgch 80:34985b4d821e 319 \param buf the data to write
mazgch 80:34985b4d821e 320 \param len the size of the data to write
mazgch 80:34985b4d821e 321 \return the number of bytes written
mazgch 80:34985b4d821e 322 */
mazgch 80:34985b4d821e 323 int writeFile(const char* filename, const char* buf, int len);
mazgch 80:34985b4d821e 324
mazgch 80:34985b4d821e 325 /** REad a file from the local file system
mazgch 80:34985b4d821e 326 \param filename the name of the file
mazgch 80:34985b4d821e 327 \param buf a buffer to hold the data
mazgch 80:34985b4d821e 328 \param len the size to read
mazgch 80:34985b4d821e 329 \return the number of bytes read
mazgch 80:34985b4d821e 330 */
mazgch 80:34985b4d821e 331 int readFile(const char* filename, char* buf, int len);
mazgch 80:34985b4d821e 332
mazgch 80:34985b4d821e 333 // ----------------------------------------------------------------
mazgch 74:208e3e32d263 334 // DEBUG/DUMP status to standard out (printf)
mazgch 54:7ba8e4c218e2 335 // ----------------------------------------------------------------
mazgch 54:7ba8e4c218e2 336
mazgch 74:208e3e32d263 337 /*! Set the debug level
mazgch 117:74e4e0109a9e 338 \param level -1 = OFF, 0 = ERROR, 1 = INFO(default), 2 = TRACE, 3 = ATCMD,TEST
mazgch 74:208e3e32d263 339 \return true if successful, false not possible
mazgch 74:208e3e32d263 340 */
mazgch 74:208e3e32d263 341 bool setDebug(int level);
mazgch 74:208e3e32d263 342
mazgch 73:2b32e0a21df2 343 //! helper type for DPRINT
mazgch 73:2b32e0a21df2 344 typedef int (*_DPRINT)(void* param, char const * format, ...);
mazgch 73:2b32e0a21df2 345
mazgch 73:2b32e0a21df2 346 //! helper to declate templates and void versions
mazgch 73:2b32e0a21df2 347 #define _DUMP_TEMPLATE(func, type, arg) \
mazgch 73:2b32e0a21df2 348 template<class T> \
mazgch 73:2b32e0a21df2 349 inline void func(type arg, \
mazgch 73:2b32e0a21df2 350 int (*dprint)( T* param, char const * format, ...), \
mazgch 73:2b32e0a21df2 351 T* param) { func(arg, (_DPRINT)dprint, (void*)param); } \
mazgch 73:2b32e0a21df2 352 static void func(type arg, \
mazgch 73:2b32e0a21df2 353 _DPRINT dprint = (_DPRINT)fprintf, \
mazgch 73:2b32e0a21df2 354 void* param = (void*)stdout);
mazgch 74:208e3e32d263 355
mazgch 54:7ba8e4c218e2 356 /** dump the device status to stdout using printf
mazgch 54:7ba8e4c218e2 357 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 358 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 359 \param dprint a function pointer
mazgch 73:2b32e0a21df2 360 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 361 */
mazgch 73:2b32e0a21df2 362 _DUMP_TEMPLATE(dumpDevStatus, MDMParser::DevStatus*, status)
mazgch 54:7ba8e4c218e2 363
mazgch 54:7ba8e4c218e2 364 /** dump the network status to stdout using printf
mazgch 54:7ba8e4c218e2 365 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 366 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 367 \param dprint a function pointer
mazgch 73:2b32e0a21df2 368 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 369 */
mazgch 73:2b32e0a21df2 370 _DUMP_TEMPLATE(dumpNetStatus, MDMParser::NetStatus*, status)
mazgch 73:2b32e0a21df2 371
mazgch 54:7ba8e4c218e2 372 /** dump the ip address to stdout using printf
mazgch 54:7ba8e4c218e2 373 \param ip the ip to convert to textual form,
mazgch 54:7ba8e4c218e2 374 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 375 \param dprint a function pointer
mazgch 73:2b32e0a21df2 376 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 377 */
mazgch 73:2b32e0a21df2 378 _DUMP_TEMPLATE(dumpIp, MDMParser::IP, ip)
mazgch 73:2b32e0a21df2 379
mazgch 54:7ba8e4c218e2 380 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 381 // Parseing
mazgch 31:a0bed6c1e05d 382 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 383
mazgch 51:e7b81c31baec 384 enum {
mazgch 51:e7b81c31baec 385 // waitFinalResp Responses
mazgch 52:8071747a7cb3 386 NOT_FOUND = 0,
mazgch 52:8071747a7cb3 387 WAIT = -1, // TIMEOUT
mazgch 52:8071747a7cb3 388 RESP_OK = -2,
mazgch 52:8071747a7cb3 389 RESP_ERROR = -3,
mazgch 52:8071747a7cb3 390 RESP_PROMPT = -4,
mazgch 31:a0bed6c1e05d 391
mazgch 51:e7b81c31baec 392 // getLine Responses
mazgch 51:e7b81c31baec 393 #define LENGTH(x) (x & 0x00FFFF) //!< extract/mask the length
mazgch 51:e7b81c31baec 394 #define TYPE(x) (x & 0xFF0000) //!< extract/mask the type
mazgch 51:e7b81c31baec 395
mazgch 51:e7b81c31baec 396 TYPE_UNKNOWN = 0x000000,
mazgch 51:e7b81c31baec 397 TYPE_OK = 0x110000,
mazgch 51:e7b81c31baec 398 TYPE_ERROR = 0x120000,
mazgch 51:e7b81c31baec 399 TYPE_RING = 0x210000,
mazgch 51:e7b81c31baec 400 TYPE_CONNECT = 0x220000,
mazgch 51:e7b81c31baec 401 TYPE_NOCARRIER = 0x230000,
mazgch 51:e7b81c31baec 402 TYPE_NODIALTONE = 0x240000,
mazgch 51:e7b81c31baec 403 TYPE_BUSY = 0x250000,
mazgch 51:e7b81c31baec 404 TYPE_NOANSWER = 0x260000,
mazgch 51:e7b81c31baec 405 TYPE_PROMPT = 0x300000,
mazgch 51:e7b81c31baec 406 TYPE_PLUS = 0x400000,
mazgch 66:69072b3c5bca 407 TYPE_TEXT = 0x500000,
mazgch 66:69072b3c5bca 408
mazgch 66:69072b3c5bca 409 // special timout constant
mazgch 66:69072b3c5bca 410 TIMEOUT_BLOCKING = -1
mazgch 51:e7b81c31baec 411 };
mazgch 31:a0bed6c1e05d 412
mazgch 31:a0bed6c1e05d 413 /** Get a line from the physical interface. This function need
mazgch 31:a0bed6c1e05d 414 to be implemented in a inherited class. Usually just calls
mazgch 31:a0bed6c1e05d 415 #_getLine on the rx buffer pipe.
mazgch 31:a0bed6c1e05d 416
mazgch 31:a0bed6c1e05d 417 \param buf the buffer to store it
mazgch 31:a0bed6c1e05d 418 \param buf size of the buffer
mazgch 31:a0bed6c1e05d 419 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 420 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 421 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 422 */
mazgch 31:a0bed6c1e05d 423 virtual int getLine(char* buf, int len) = 0;
mazgch 28:4d9509e3b1cf 424
mazgch 101:edfeb8af206e 425 /* clear the pending input data
mazgch 101:edfeb8af206e 426 */
mazgch 101:edfeb8af206e 427 virtual void purge(void) = 0;
mazgch 101:edfeb8af206e 428
mazgch 31:a0bed6c1e05d 429 /** Write data to the device
mazgch 31:a0bed6c1e05d 430 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 431 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 432 \return bytes written
mazgch 31:a0bed6c1e05d 433 */
mazgch 31:a0bed6c1e05d 434 virtual int send(const char* buf, int len);
mazgch 21:c4d64830bf02 435
mazgch 31:a0bed6c1e05d 436 /** Write formated date to the physical interface (printf style)
mazgch 31:a0bed6c1e05d 437 \param fmt the format string
mazgch 31:a0bed6c1e05d 438 \param .. variable arguments to be formated
mazgch 31:a0bed6c1e05d 439 \return bytes written
mazgch 31:a0bed6c1e05d 440 */
mazgch 21:c4d64830bf02 441 int sendFormated(const char* format, ...);
mazgch 26:07be5faf8925 442
mazgch 31:a0bed6c1e05d 443 /** callback function for #waitFinalResp with void* as argument
mazgch 31:a0bed6c1e05d 444 \param type the #getLine response
mazgch 31:a0bed6c1e05d 445 \param buf the parsed line
mazgch 31:a0bed6c1e05d 446 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 447 \param param the optional argument passed to #waitFinalResp
mazgch 31:a0bed6c1e05d 448 \return WAIT if processing should continue,
mazgch 31:a0bed6c1e05d 449 any other value aborts #waitFinalResp and this retunr value retuned
mazgch 31:a0bed6c1e05d 450 */
mazgch 26:07be5faf8925 451 typedef int (*_CALLBACKPTR)(int type, const char* buf, int len, void* param);
mazgch 31:a0bed6c1e05d 452
mazgch 31:a0bed6c1e05d 453 /** Wait for a final respons
mazgch 31:a0bed6c1e05d 454 \param cb the optional callback function
mazgch 31:a0bed6c1e05d 455 \param param the optional callback function parameter
mazgch 58:e38a2e942fbb 456 \param timeout_ms the timeout to wait (See Estimated command
mazgch 58:e38a2e942fbb 457 response time of AT manual)
mazgch 31:a0bed6c1e05d 458 */
mazgch 31:a0bed6c1e05d 459 int waitFinalResp(_CALLBACKPTR cb = NULL,
mazgch 26:07be5faf8925 460 void* param = NULL,
mazgch 58:e38a2e942fbb 461 int timeout_ms = 10000);
mazgch 31:a0bed6c1e05d 462
mazgch 31:a0bed6c1e05d 463 /** template version of #waitFinalResp when using callbacks,
mazgch 31:a0bed6c1e05d 464 This template will allow the compiler to do type cheking but
mazgch 31:a0bed6c1e05d 465 internally symply casts the arguments and call the (void*)
mazgch 31:a0bed6c1e05d 466 version of #waitFinalResp.
mazgch 31:a0bed6c1e05d 467 \sa waitFinalResp
mazgch 31:a0bed6c1e05d 468 */
mazgch 26:07be5faf8925 469 template<class T>
mazgch 73:2b32e0a21df2 470 inline int waitFinalResp(int (*cb)(int type, const char* buf, int len, T* param),
mazgch 73:2b32e0a21df2 471 T* param,
mazgch 73:2b32e0a21df2 472 int timeout_ms = 10000)
mazgch 26:07be5faf8925 473 {
mazgch 26:07be5faf8925 474 return waitFinalResp((_CALLBACKPTR)cb, (void*)param, timeout_ms);
mazgch 26:07be5faf8925 475 }
mazgch 31:a0bed6c1e05d 476
mazgch 18:e5697801df29 477 protected:
mazgch 31:a0bed6c1e05d 478 /** Write bytes to the physical interface. This function should be
mazgch 31:a0bed6c1e05d 479 implemented in a inherited class.
mazgch 31:a0bed6c1e05d 480 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 481 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 482 \return bytes written
mazgch 31:a0bed6c1e05d 483 */
mazgch 18:e5697801df29 484 virtual int _send(const void* buf, int len) = 0;
mazgch 31:a0bed6c1e05d 485
mazgch 31:a0bed6c1e05d 486 /** Helper: Parse a line from the receiving buffered pipe
mazgch 31:a0bed6c1e05d 487 \param pipe the receiving buffer pipe
mazgch 31:a0bed6c1e05d 488 \param buf the parsed line
mazgch 31:a0bed6c1e05d 489 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 490 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 491 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 492 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 493 */
mazgch 31:a0bed6c1e05d 494 static int _getLine(Pipe<char>* pipe, char* buffer, int length);
mazgch 31:a0bed6c1e05d 495
mazgch 31:a0bed6c1e05d 496 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 497 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 498 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 499 \param sta the starting string, NULL if none
mazgch 31:a0bed6c1e05d 500 \param end the terminating string, NULL if none
mazgch 31:a0bed6c1e05d 501 \return size of parsed match
mazgch 31:a0bed6c1e05d 502 */
mazgch 31:a0bed6c1e05d 503 static int _parseMatch(Pipe<char>* pipe, int len, const char* sta, const char* end);
mazgch 31:a0bed6c1e05d 504
mazgch 31:a0bed6c1e05d 505 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 506 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 507 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 508 \param fmt the formating string (%d any number, %c any char of last %d len)
mazgch 31:a0bed6c1e05d 509 \return size of parsed match
mazgch 31:a0bed6c1e05d 510 */
mazgch 31:a0bed6c1e05d 511 static int _parseFormated(Pipe<char>* pipe, int len, const char* fmt);
mazgch 31:a0bed6c1e05d 512
mazgch 35:9275215a3a5b 513 protected:
mazgch 95:8282dbbe1492 514 // for rtos over riding by useing Rtos<MDMxx>
mazgch 95:8282dbbe1492 515 /** override in a rtos system, you us the wait function of a Thread
mazgch 95:8282dbbe1492 516 \param ms the number of milliseconds to wait
mazgch 95:8282dbbe1492 517 */
mazgch 95:8282dbbe1492 518 virtual void wait_ms(int ms) { if (ms) ::wait_ms(ms); }
mazgch 95:8282dbbe1492 519 //! override the lock in a rtos system
mazgch 95:8282dbbe1492 520 virtual void lock(void) { }
mazgch 95:8282dbbe1492 521 //! override the unlock in a rtos system
mazgch 95:8282dbbe1492 522 virtual void unlock(void) { }
mazgch 95:8282dbbe1492 523 protected:
mazgch 128:0415646a9934 524 bool _activateProfile(const char* apn, const char* username, const char* password, Auth auth);
mazgch 131:965a7cbc1e58 525 bool _activateProfileReuseExternal(void);
mazgch 128:0415646a9934 526 bool _activateProfileByCid(int cid, const char* apn, const char* username, const char* password, Auth auth);
mazgch 31:a0bed6c1e05d 527 // parsing callbacks for different AT commands and their parameter arguments
mazgch 31:a0bed6c1e05d 528 static int _cbString(int type, const char* buf, int len, char* str);
mazgch 31:a0bed6c1e05d 529 static int _cbInt(int type, const char* buf, int len, int* val);
mazgch 31:a0bed6c1e05d 530 // device
mazgch 32:8f12ac182bbb 531 static int _cbATI(int type, const char* buf, int len, Dev* dev);
mazgch 31:a0bed6c1e05d 532 static int _cbCPIN(int type, const char* buf, int len, Sim* sim);
mazgch 31:a0bed6c1e05d 533 static int _cbCCID(int type, const char* buf, int len, char* ccid);
mazgch 31:a0bed6c1e05d 534 // network
mazgch 54:7ba8e4c218e2 535 static int _cbCSQ(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 536 static int _cbCOPS(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 537 static int _cbCNUM(int type, const char* buf, int len, char* num);
mazgch 81:3966a5c17037 538 static int _cbUACTIND(int type, const char* buf, int len, int* i);
mazgch 131:965a7cbc1e58 539 static int _cbCGDCONT(int type, const char* buf, int len, int* cid);
mazgch 84:a05edb010176 540 static int _cbUDOPN(int type, const char* buf, int len, char* mccmnc);
mazgch 31:a0bed6c1e05d 541 // sockets
mazgch 32:8f12ac182bbb 542 static int _cbCMIP(int type, const char* buf, int len, IP* ip);
mazgch 31:a0bed6c1e05d 543 static int _cbUPSND(int type, const char* buf, int len, int* act);
mazgch 31:a0bed6c1e05d 544 static int _cbUPSND(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 545 static int _cbUDNSRN(int type, const char* buf, int len, IP* ip);
mazgch 103:197fa7920ad8 546 static int _cbUSOCR(int type, const char* buf, int len, int* handle);
mazgch 21:c4d64830bf02 547 static int _cbUSORD(int type, const char* buf, int len, char* out);
mazgch 21:c4d64830bf02 548 typedef struct { char* buf; IP ip; int port; } USORFparam;
mazgch 21:c4d64830bf02 549 static int _cbUSORF(int type, const char* buf, int len, USORFparam* param);
mazgch 21:c4d64830bf02 550 typedef struct { char* buf; char* num; } CMGRparam;
mazgch 132:de505da3aadf 551 static int _cbCUSD(int type, const char* buf, int len, char* resp);
mazgch 31:a0bed6c1e05d 552 // sms
mazgch 31:a0bed6c1e05d 553 typedef struct { int* ix; int num; } CMGLparam;
mazgch 31:a0bed6c1e05d 554 static int _cbCMGL(int type, const char* buf, int len, CMGLparam* param);
mazgch 21:c4d64830bf02 555 static int _cbCMGR(int type, const char* buf, int len, CMGRparam* param);
mazgch 80:34985b4d821e 556 // file
mazgch 80:34985b4d821e 557 typedef struct { const char* filename; char* buf; int sz; int len; } URDFILEparam;
mazgch 115:d8d94b73c725 558 static int _cbUDELFILE(int type, const char* buf, int len, void*);
mazgch 80:34985b4d821e 559 static int _cbURDFILE(int type, const char* buf, int len, URDFILEparam* param);
mazgch 38:e6cab4632d84 560 // variables
mazgch 31:a0bed6c1e05d 561 DevStatus _dev; //!< collected device information
mazgch 31:a0bed6c1e05d 562 NetStatus _net; //!< collected network information
mazgch 31:a0bed6c1e05d 563 IP _ip; //!< assigned ip address
mazgch 31:a0bed6c1e05d 564 // management struture for sockets
mazgch 103:197fa7920ad8 565 typedef struct { int handle; int timeout_ms; volatile bool connected; volatile int pending; } SockCtrl;
mazgch 103:197fa7920ad8 566 // LISA-C has 6 TCP and 6 UDP sockets
mazgch 103:197fa7920ad8 567 // LISA-U and SARA-G have 7 sockets
mazgch 103:197fa7920ad8 568 SockCtrl _sockets[12];
mazgch 103:197fa7920ad8 569 int _findSocket(int handle = SOCKET_ERROR/* = CREATE*/);
mazgch 44:9d12223b78ff 570 static MDMParser* inst;
mazgch 76:f7c3dd568dae 571 bool _init;
mazgch 74:208e3e32d263 572 #ifdef TARGET_UBLOX_C027
mazgch 74:208e3e32d263 573 bool _onboard;
mazgch 74:208e3e32d263 574 #endif
mazgch 74:208e3e32d263 575 #ifdef MDM_DEBUG
mazgch 74:208e3e32d263 576 int _debugLevel;
mazgch 74:208e3e32d263 577 Timer _debugTime;
mazgch 117:74e4e0109a9e 578 void _debugPrint(int level, const char* color, const char* format, ...);
mazgch 74:208e3e32d263 579 #endif
mazgch 18:e5697801df29 580 };
mazgch 18:e5697801df29 581
mazgch 18:e5697801df29 582 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 583
mazgch 38:e6cab4632d84 584 /** modem class which uses a serial port
mazgch 38:e6cab4632d84 585 as physical interface.
mazgch 38:e6cab4632d84 586 */
mazgch 18:e5697801df29 587 class MDMSerial : public SerialPipe, public MDMParser
mazgch 17:296d94a006b4 588 {
mazgch 17:296d94a006b4 589 public:
mazgch 38:e6cab4632d84 590 /** Constructor
mazgch 38:e6cab4632d84 591
mazgch 38:e6cab4632d84 592 \param tx is the serial ports transmit pin (modem to CPU)
mazgch 38:e6cab4632d84 593 \param rx is the serial ports receive pin (CPU to modem)
mazgch 38:e6cab4632d84 594 \param baudrate the baudrate of the modem use 115200
mazgch 38:e6cab4632d84 595 \param rts is the serial ports ready to send pin (CPU to modem)
mazgch 38:e6cab4632d84 596 this pin is optional
mazgch 38:e6cab4632d84 597 \param cts is the serial ports clear to send pin (modem to CPU)
mazgch 38:e6cab4632d84 598 this pin is optional, but required for power saving to be enabled
mazgch 38:e6cab4632d84 599 \param rxSize the size of the serial rx buffer
mazgch 38:e6cab4632d84 600 \param txSize the size of the serial tx buffer
mazgch 38:e6cab4632d84 601 */
mazgch 75:ce6e12067d0c 602 MDMSerial(PinName tx MDM_IF( = MDMTXD, = D1 ),
mazgch 75:ce6e12067d0c 603 PinName rx MDM_IF( = MDMRXD, = D0 ),
mazgch 75:ce6e12067d0c 604 int baudrate MDM_IF( = MDMBAUD, = 115200 ),
mazgch 35:9275215a3a5b 605 #if DEVICE_SERIAL_FC
mazgch 75:ce6e12067d0c 606 PinName rts MDM_IF( = MDMRTS, = NC /* D2 resistor R62 on shield not mounted */ ),
mazgch 75:ce6e12067d0c 607 PinName cts MDM_IF( = MDMCTS, = NC /* D3 resistor R63 on shield not mounted */ ),
mazgch 35:9275215a3a5b 608 #endif
mazgch 19:2b5d097ca15d 609 int rxSize = 256 ,
mazgch 21:c4d64830bf02 610 int txSize = 128 );
mazgch 76:f7c3dd568dae 611 //! Destructor
mazgch 93:2b5478693c20 612 virtual ~MDMSerial(void);
mazgch 123:66cef6353b13 613
mazgch 38:e6cab4632d84 614 /** Get a line from the physical interface.
mazgch 38:e6cab4632d84 615 \param buf the buffer to store it
mazgch 38:e6cab4632d84 616 \param buf size of the buffer
mazgch 38:e6cab4632d84 617 \return type and length if something was found,
mazgch 38:e6cab4632d84 618 WAIT if not enough data is available
mazgch 38:e6cab4632d84 619 NOT_FOUND if nothing was found
mazgch 38:e6cab4632d84 620 */
mazgch 18:e5697801df29 621 virtual int getLine(char* buffer, int length);
mazgch 101:edfeb8af206e 622
mazgch 101:edfeb8af206e 623 /* clear the pending input data */
mazgch 101:edfeb8af206e 624 virtual void purge(void)
mazgch 101:edfeb8af206e 625 {
mazgch 101:edfeb8af206e 626 while (readable())
mazgch 101:edfeb8af206e 627 getc();
mazgch 101:edfeb8af206e 628 }
mazgch 18:e5697801df29 629 protected:
mazgch 38:e6cab4632d84 630 /** Write bytes to the physical interface.
mazgch 38:e6cab4632d84 631 \param buf the buffer to write
mazgch 38:e6cab4632d84 632 \param buf size of the buffer to write
mazgch 38:e6cab4632d84 633 \return bytes written
mazgch 38:e6cab4632d84 634 */
mazgch 18:e5697801df29 635 virtual int _send(const void* buf, int len);
mazgch 17:296d94a006b4 636 };
mazgch 18:e5697801df29 637
mazgch 18:e5697801df29 638 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 639
mazgch 38:e6cab4632d84 640 //#define HAVE_MDMUSB
mazgch 18:e5697801df29 641 #ifdef HAVE_MDMUSB
mazgch 18:e5697801df29 642 class MDMUsb : /*public UsbSerial,*/ public MDMParser
mazgch 18:e5697801df29 643 {
mazgch 18:e5697801df29 644 public:
mazgch 76:f7c3dd568dae 645 //! Constructor
mazgch 18:e5697801df29 646 MDMUsb(void);
mazgch 76:f7c3dd568dae 647 //! Destructor
mazgch 93:2b5478693c20 648 virtual ~MDMUsb(void);
mazgch 18:e5697801df29 649 virtual int getLine(char* buffer, int length);
mazgch 101:edfeb8af206e 650 virtual void purge(void) { }
mazgch 18:e5697801df29 651 protected:
mazgch 18:e5697801df29 652 virtual int _send(const void* buf, int len);
mazgch 18:e5697801df29 653 };
mazgch 18:e5697801df29 654 #endif
mazgch 18:e5697801df29 655
mazgch 95:8282dbbe1492 656 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 657
mazgch 95:8282dbbe1492 658 #ifdef RTOS_H
mazgch 95:8282dbbe1492 659 /** Use this template to override the lock and wait functions of the
mazgch 95:8282dbbe1492 660 modem driver in a Rtos system. For example declare it the modem
mazgch 95:8282dbbe1492 661 object as MDMRtos<MDMSerial> instead of MDMSerial.
mazgch 95:8282dbbe1492 662 */
mazgch 95:8282dbbe1492 663 template <class T>
mazgch 95:8282dbbe1492 664 class MDMRtos : public T
mazgch 95:8282dbbe1492 665 {
mazgch 95:8282dbbe1492 666 protected:
mazgch 95:8282dbbe1492 667 //! we assume that the modem runs in a thread so we yield when waiting
mazgch 95:8282dbbe1492 668 virtual void wait_ms(int ms) {
mazgch 95:8282dbbe1492 669 if (ms) Thread::wait(ms);
mazgch 95:8282dbbe1492 670 else Thread::yield();
mazgch 95:8282dbbe1492 671 }
mazgch 95:8282dbbe1492 672 //! lock a mutex when accessing the modem
mazgch 95:8282dbbe1492 673 virtual void lock(void) { _mtx.lock(); }
mazgch 95:8282dbbe1492 674 //! unlock the modem when done accessing it
mazgch 95:8282dbbe1492 675 virtual void unlock(void) { _mtx.unlock(); }
mazgch 95:8282dbbe1492 676 // the mutex resource
mazgch 95:8282dbbe1492 677 Mutex _mtx;
mazgch 95:8282dbbe1492 678 };
mazgch 95:8282dbbe1492 679 #endif