Sean McBeath / C027_Support

C027 support

Fork of C027_Support by u-blox

MDM.h@74:208e3e32d263, 2014-05-15 (annotated)

Committer:
mazgch
Date:
Thu May 15 22:20:42 2014 +0000
Revision:
74:208e3e32d263
Parent:
73:2b32e0a21df2
Child:
75:ce6e12067d0c
initial version of restructured u-blox library

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 19:2b5d097ca15d 9 #ifdef TARGET_UBLOX_C027
mazgch 74:208e3e32d263 10 #define _IF(onboard,shield) onboard
mazgch 19:2b5d097ca15d 11 #else
mazgch 74:208e3e32d263 12 #define _IF(onboard,shield) shield
mazgch 19:2b5d097ca15d 13 #endif
mazgch 18:e5697801df29 14
mazgch 74:208e3e32d263 15 //! include debug capabilty on more powerful targets with a dedicated debug port
mazgch 74:208e3e32d263 16 #if defined(TARGET_LPC1768) || defined(TARGET_LPC4088) || defined(TARGET_K64F)
mazgch 74:208e3e32d263 17 #define MDM_DEBUG
mazgch 74:208e3e32d263 18 #endif
mazgch 74:208e3e32d263 19
mazgch 38:e6cab4632d84 20 /** basic modem parser class
mazgch 38:e6cab4632d84 21 */
mazgch 18:e5697801df29 22 class MDMParser
mazgch 18:e5697801df29 23 {
mazgch 18:e5697801df29 24 public:
mazgch 31:a0bed6c1e05d 25 //! Constructor
mazgch 35:9275215a3a5b 26 MDMParser();
mazgch 74:208e3e32d263 27 //! Destructor
mazgch 74:208e3e32d263 28 ~MDMParser();
mazgch 44:9d12223b78ff 29 //! get static instance
mazgch 44:9d12223b78ff 30 static MDMParser* getInstance() { return inst; };
mazgch 31:a0bed6c1e05d 31
mazgch 31:a0bed6c1e05d 32 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 33 // Types
mazgch 31:a0bed6c1e05d 34 // ----------------------------------------------------------------
mazgch 38:e6cab4632d84 35 //! MT Device Types
mazgch 38:e6cab4632d84 36 typedef enum { DEV_UNKNOWN, DEV_SARA_G350, DEV_LISA_U200, DEV_LISA_C200 } Dev;
mazgch 38:e6cab4632d84 37 //! SIM Status
mazgch 38:e6cab4632d84 38 typedef enum { SIM_UNKNOWN, SIM_PIN, SIM_READY } Sim;
mazgch 38:e6cab4632d84 39 //! SIM Status
mazgch 38:e6cab4632d84 40 typedef enum { LPM_DISABLED, LPM_ENABLED, LPM_ACTIVE, LPM_SLEEP } Lpm;
mazgch 38:e6cab4632d84 41 //! Device status
mazgch 33:fb8fb5021b09 42 typedef struct {
mazgch 34:3b3b7807c0c3 43 Dev dev; //!< Device Type
mazgch 35:9275215a3a5b 44 Lpm lpm; //!< Power Saving
mazgch 34:3b3b7807c0c3 45 Sim sim; //!< SIM Card Status
mazgch 34:3b3b7807c0c3 46 char ccid[20+1]; //!< Integrated Circuit Card ID
mazgch 34:3b3b7807c0c3 47 char imsi[15+1]; //!< International Mobile Station Identity
mazgch 34:3b3b7807c0c3 48 char imei[15+1]; //!< International Mobile Equipment Identity
mazgch 34:3b3b7807c0c3 49 char meid[18+1]; //!< Mobile Equipment IDentifier
mazgch 34:3b3b7807c0c3 50 char manu[16]; //!< Manufacturer (u-blox)
mazgch 34:3b3b7807c0c3 51 char model[16]; //!< Model Name (LISA-U200, LISA-C200 or SARA-G350)
mazgch 34:3b3b7807c0c3 52 char ver[16]; //!< Software Version
mazgch 38:e6cab4632d84 53 } DevStatus;
mazgch 38:e6cab4632d84 54 //! Registration Status
mazgch 38:e6cab4632d84 55 typedef enum { REG_UNKNOWN, REG_DENIED, REG_NONE, REG_HOME, REG_ROAMING } Reg;
mazgch 38:e6cab4632d84 56 //! Access Technology
mazgch 38:e6cab4632d84 57 typedef enum { ACT_UNKNOWN, ACT_GSM, ACT_EDGE, ACT_UTRAN, ACT_CDMA } AcT;
mazgch 72:d1e943ad6558 58 //! Gprs Attach Status
mazgch 72:d1e943ad6558 59 typedef enum { GPRS_UNKNOWN, GPRS_DETACHED, GPRS_ATTACHED } Gprs;
mazgch 38:e6cab4632d84 60 //! Network Status
mazgch 33:fb8fb5021b09 61 typedef struct {
mazgch 34:3b3b7807c0c3 62 Reg reg; //!< Registration Status
mazgch 72:d1e943ad6558 63 Gprs gprs; //!< Gprs Attach status
mazgch 34:3b3b7807c0c3 64 AcT act; //!< Access Technology
mazgch 34:3b3b7807c0c3 65 int rssi; //!< Received Signal Strength Indication (in dBm, range -113..-53)
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 57:869bd35f44cc 91 /** Combined Init, checkNetStatus, join suitable for simple applications
mazgch 57:869bd35f44cc 92 \param simpin a optional pin of the SIM card
mazgch 57:869bd35f44cc 93 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 94 \param username is the user name text string for the authentication phase
mazgch 57:869bd35f44cc 95 \param password is the password text string for the authentication phase
mazgch 57:869bd35f44cc 96 \param dump set to true if you like to dump the status if successful
mazgch 57:869bd35f44cc 97 \return true if successful, false otherwise
mazgch 57:869bd35f44cc 98 */
mazgch 57:869bd35f44cc 99 bool connect(const char* simpin,
mazgch 57:869bd35f44cc 100 const char* apn, const char* username, const char* password,
mazgch 74:208e3e32d263 101 PinName pn _IF( = MDMPWRON, = D4));
mazgch 57:869bd35f44cc 102
mazgch 31:a0bed6c1e05d 103 /** register (Attach) the MT to the GPRS service.
mazgch 57:869bd35f44cc 104 \param simpin a optional pin of the SIM card
mazgch 31:a0bed6c1e05d 105 \param status an optional struture to with device information
mazgch 31:a0bed6c1e05d 106 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 107 */
mazgch 74:208e3e32d263 108 bool init(const char* simpin = NULL, DevStatus* status = NULL,
mazgch 74:208e3e32d263 109 PinName pn _IF( = MDMPWRON, = D4));
mazgch 31:a0bed6c1e05d 110
mazgch 31:a0bed6c1e05d 111 /** check if the network is available
mazgch 31:a0bed6c1e05d 112 \param status an optional structure to with network information
mazgch 31:a0bed6c1e05d 113 \return true if successful and connected to network, false otherwise
mazgch 31:a0bed6c1e05d 114 */
mazgch 31:a0bed6c1e05d 115 bool checkNetStatus(NetStatus* status = NULL);
mazgch 31:a0bed6c1e05d 116
mazgch 31:a0bed6c1e05d 117 /** Power off the MT, This function has to be called prior to
mazgch 31:a0bed6c1e05d 118 switching off the supply.
mazgch 31:a0bed6c1e05d 119 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 120 */
mazgch 31:a0bed6c1e05d 121 bool powerOff(void);
mazgch 31:a0bed6c1e05d 122
mazgch 31:a0bed6c1e05d 123 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 124 // Data Connection (GPRS)
mazgch 31:a0bed6c1e05d 125 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 126
mazgch 31:a0bed6c1e05d 127 /** register (Attach) the MT to the GPRS service.
mazgch 31:a0bed6c1e05d 128 \param apn the of the network provider e.g. "internet" or "apn.provider.com"
mazgch 57:869bd35f44cc 129 \param username is the user name text string for the authentication phase
mazgch 31:a0bed6c1e05d 130 \param password is the password text string for the authentication phase
mazgch 57:869bd35f44cc 131 \param dump set to true if you like to dump the status if successful
mazgch 31:a0bed6c1e05d 132 \return the ip that is assigned
mazgch 31:a0bed6c1e05d 133 */
mazgch 57:869bd35f44cc 134 MDMParser::IP join(const char* apn = NULL, const char* username = NULL, const char* password = NULL);
mazgch 31:a0bed6c1e05d 135
mazgch 31:a0bed6c1e05d 136 /** deregister (detach) the MT from the GPRS service.
mazgch 31:a0bed6c1e05d 137 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 138 */
mazgch 31:a0bed6c1e05d 139 bool disconnect(void);
mazgch 31:a0bed6c1e05d 140
mazgch 31:a0bed6c1e05d 141 /** Translates a domain name to an IP address
mazgch 31:a0bed6c1e05d 142 \param host the domain name to translate e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 143 \return the IP if successful, 0 otherwise
mazgch 31:a0bed6c1e05d 144 */
mazgch 31:a0bed6c1e05d 145 MDMParser::IP gethostbyname(const char* host);
mazgch 31:a0bed6c1e05d 146
mazgch 31:a0bed6c1e05d 147 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 148 // Sockets
mazgch 31:a0bed6c1e05d 149 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 150
mazgch 31:a0bed6c1e05d 151 //! Type of IP protocol
mazgch 31:a0bed6c1e05d 152 typedef enum { IPPROTO_TCP, IPPROTO_UDP } IpProtocol;
mazgch 31:a0bed6c1e05d 153
mazgch 31:a0bed6c1e05d 154 //! Socket error return codes
mazgch 31:a0bed6c1e05d 155 #define SOCKET_ERROR -1
mazgch 31:a0bed6c1e05d 156
mazgch 63:42cb563a25bc 157 /** Create a socket for a ip protocol (and optionaly bind)
mazgch 31:a0bed6c1e05d 158 \param ipproto the protocol (UDP or TCP)
mazgch 63:42cb563a25bc 159 \param port in case of UDP, this optional port where it is bind
mazgch 31:a0bed6c1e05d 160 \return the socket handle if successful or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 161 */
mazgch 63:42cb563a25bc 162 int socketSocket(IpProtocol ipproto, int port = -1);
mazgch 31:a0bed6c1e05d 163
mazgch 31:a0bed6c1e05d 164 /** make a socket connection
mazgch 31:a0bed6c1e05d 165 \param socket the socket handle
mazgch 31:a0bed6c1e05d 166 \param host the domain name to connect e.g. "u-blox.com"
mazgch 31:a0bed6c1e05d 167 \param port the port to connect
mazgch 31:a0bed6c1e05d 168 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 169 */
mazgch 31:a0bed6c1e05d 170 bool socketConnect(int socket, const char* host, int port);
mazgch 31:a0bed6c1e05d 171
mazgch 44:9d12223b78ff 172 /** make a socket connection
mazgch 44:9d12223b78ff 173 \param socket the socket handle
mazgch 44:9d12223b78ff 174 \return true if connected, false otherwise
mazgch 44:9d12223b78ff 175 */
mazgch 44:9d12223b78ff 176 bool socketIsConnected(int socket);
mazgch 44:9d12223b78ff 177
mazgch 44:9d12223b78ff 178 /** Get the number of bytes pending for reading for this socket
mazgch 44:9d12223b78ff 179 \param socket the socket handle
mazgch 44:9d12223b78ff 180 \param timeout_ms -1 blocking, else non blocking timeout in ms
mazgch 44:9d12223b78ff 181 \return 0 if successful or SOCKET_ERROR on failure
mazgch 44:9d12223b78ff 182 */
mazgch 66:69072b3c5bca 183 bool socketSetBlocking(int socket, int timeout_ms);
mazgch 44:9d12223b78ff 184
mazgch 31:a0bed6c1e05d 185 /** Write socket data
mazgch 31:a0bed6c1e05d 186 \param socket the socket handle
mazgch 31:a0bed6c1e05d 187 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 188 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 189 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 190 */
mazgch 31:a0bed6c1e05d 191 int socketSend(int socket, const char * buf, int len);
mazgch 31:a0bed6c1e05d 192
mazgch 31:a0bed6c1e05d 193 /** Write socket data to a IP
mazgch 31:a0bed6c1e05d 194 \param socket the socket handle
mazgch 31:a0bed6c1e05d 195 \param ip the ip to send to
mazgch 31:a0bed6c1e05d 196 \param port the port to send to
mazgch 31:a0bed6c1e05d 197 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 198 \param len the size of the buffer to write
mazgch 31:a0bed6c1e05d 199 \return the size written or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 200 */
mazgch 31:a0bed6c1e05d 201 int socketSendTo(int socket, IP ip, int port, const char * buf, int len);
mazgch 31:a0bed6c1e05d 202
mazgch 31:a0bed6c1e05d 203 /** Get the number of bytes pending for reading for this socket
mazgch 31:a0bed6c1e05d 204 \param socket the socket handle
mazgch 31:a0bed6c1e05d 205 \return the number of bytes pending or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 206 */
mazgch 31:a0bed6c1e05d 207 int socketReadable(int socket);
mazgch 31:a0bed6c1e05d 208
mazgch 31:a0bed6c1e05d 209 /** Read this socket
mazgch 31:a0bed6c1e05d 210 \param socket the socket handle
mazgch 31:a0bed6c1e05d 211 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 212 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 213 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 214 */
mazgch 31:a0bed6c1e05d 215 int socketRecv(int socket, char* buf, int len);
mazgch 31:a0bed6c1e05d 216
mazgch 31:a0bed6c1e05d 217 /** Read from this socket
mazgch 31:a0bed6c1e05d 218 \param socket the socket handle
mazgch 63:42cb563a25bc 219 \param ip the ip of host where the data originates from
mazgch 63:42cb563a25bc 220 \param port the port where the data originates from
mazgch 31:a0bed6c1e05d 221 \param buf the buffer to read into
mazgch 31:a0bed6c1e05d 222 \param len the size of the buffer to read into
mazgch 31:a0bed6c1e05d 223 \return the number of bytes read or SOCKET_ERROR on failure
mazgch 31:a0bed6c1e05d 224 */
mazgch 63:42cb563a25bc 225 int socketRecvFrom(int socket, IP* ip, int* port, char* buf, int len);
mazgch 31:a0bed6c1e05d 226
mazgch 31:a0bed6c1e05d 227 /** Close a connectied socket (that was connected with #socketConnect)
mazgch 31:a0bed6c1e05d 228 \param socket the socket handle
mazgch 31:a0bed6c1e05d 229 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 230 */
mazgch 31:a0bed6c1e05d 231 bool socketClose(int socket);
mazgch 31:a0bed6c1e05d 232
mazgch 31:a0bed6c1e05d 233 /** Free the socket (that was allocated before by #socketSocket)
mazgch 31:a0bed6c1e05d 234 \param socket the socket handle
mazgch 31:a0bed6c1e05d 235 \return true if successfully, false otherwise
mazgch 31:a0bed6c1e05d 236 */
mazgch 31:a0bed6c1e05d 237 bool socketFree(int socket);
mazgch 31:a0bed6c1e05d 238
mazgch 31:a0bed6c1e05d 239 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 240 // SMS Short Message Service
mazgch 31:a0bed6c1e05d 241 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 242
mazgch 31:a0bed6c1e05d 243 /** count the number of sms in the device and optionally return a
mazgch 31:a0bed6c1e05d 244 list with indexes from the storage locations in the device.
mazgch 31:a0bed6c1e05d 245 \param stat what type of messages you can use use
mazgch 31:a0bed6c1e05d 246 "REC UNREAD", "REC READ", "STO UNSENT", "STO SENT", "ALL"
mazgch 31:a0bed6c1e05d 247 \param ix list where to save the storage positions
mazgch 31:a0bed6c1e05d 248 \param num number of elements in the list
mazgch 31:a0bed6c1e05d 249 \return the number of messages, this can be bigger than num, -1 on failure
mazgch 31:a0bed6c1e05d 250 */
mazgch 31:a0bed6c1e05d 251 int smsList(const char* stat = "ALL", int* ix = NULL, int num = 0);
mazgch 31:a0bed6c1e05d 252
mazgch 31:a0bed6c1e05d 253 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 254 \param ix the storage position to read
mazgch 31:a0bed6c1e05d 255 \param num the originator address (~16 chars)
mazgch 31:a0bed6c1e05d 256 \param buf a buffer where to save the sm
mazgch 31:a0bed6c1e05d 257 \param len the length of the sm
mazgch 31:a0bed6c1e05d 258 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 259 */
mazgch 31:a0bed6c1e05d 260 bool smsRead(int ix, char* num, char* buf, int len);
mazgch 31:a0bed6c1e05d 261
mazgch 31:a0bed6c1e05d 262 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 263 \param ix the storage position to delete
mazgch 31:a0bed6c1e05d 264 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 265 */
mazgch 31:a0bed6c1e05d 266 bool smsDelete(int ix);
mazgch 31:a0bed6c1e05d 267
mazgch 31:a0bed6c1e05d 268 /** Send a message to a recipient
mazgch 31:a0bed6c1e05d 269 \param num the phone number of the recipient
mazgch 31:a0bed6c1e05d 270 \param buf the content of the message to sent
mazgch 31:a0bed6c1e05d 271 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 272 */
mazgch 31:a0bed6c1e05d 273 bool smsSend(const char* num, const char* buf);
mazgch 31:a0bed6c1e05d 274
mazgch 31:a0bed6c1e05d 275 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 276 // USSD Unstructured Supplementary Service Data
mazgch 31:a0bed6c1e05d 277 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 278
mazgch 31:a0bed6c1e05d 279 /** Read a Message from a storage position
mazgch 31:a0bed6c1e05d 280 \param cmd the ussd command to send e.g "*#06#"
mazgch 31:a0bed6c1e05d 281 \param buf a buffer where to save the reply
mazgch 31:a0bed6c1e05d 282 \return true if successful, false otherwise
mazgch 31:a0bed6c1e05d 283 */
mazgch 31:a0bed6c1e05d 284 bool ussdCommand(const char* cmd, char* buf);
mazgch 31:a0bed6c1e05d 285
mazgch 38:e6cab4632d84 286 // ----------------------------------------------------------------
mazgch 74:208e3e32d263 287 // DEBUG/DUMP status to standard out (printf)
mazgch 54:7ba8e4c218e2 288 // ----------------------------------------------------------------
mazgch 54:7ba8e4c218e2 289
mazgch 74:208e3e32d263 290 /*! Set the debug level
mazgch 74:208e3e32d263 291 \param level 0 = OFF, 1 = INFO(default), 2 = TRACE, 3 = ATCMD
mazgch 74:208e3e32d263 292 \return true if successful, false not possible
mazgch 74:208e3e32d263 293 */
mazgch 74:208e3e32d263 294 bool setDebug(int level);
mazgch 74:208e3e32d263 295
mazgch 73:2b32e0a21df2 296 //! helper type for DPRINT
mazgch 73:2b32e0a21df2 297 typedef int (*_DPRINT)(void* param, char const * format, ...);
mazgch 73:2b32e0a21df2 298
mazgch 73:2b32e0a21df2 299 //! helper to declate templates and void versions
mazgch 73:2b32e0a21df2 300 #define _DUMP_TEMPLATE(func, type, arg) \
mazgch 73:2b32e0a21df2 301 template<class T> \
mazgch 73:2b32e0a21df2 302 inline void func(type arg, \
mazgch 73:2b32e0a21df2 303 int (*dprint)( T* param, char const * format, ...), \
mazgch 73:2b32e0a21df2 304 T* param) { func(arg, (_DPRINT)dprint, (void*)param); } \
mazgch 73:2b32e0a21df2 305 static void func(type arg, \
mazgch 73:2b32e0a21df2 306 _DPRINT dprint = (_DPRINT)fprintf, \
mazgch 73:2b32e0a21df2 307 void* param = (void*)stdout);
mazgch 74:208e3e32d263 308
mazgch 54:7ba8e4c218e2 309 /** dump the device status to stdout using printf
mazgch 54:7ba8e4c218e2 310 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 311 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 312 \param dprint a function pointer
mazgch 73:2b32e0a21df2 313 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 314 */
mazgch 73:2b32e0a21df2 315 _DUMP_TEMPLATE(dumpDevStatus, MDMParser::DevStatus*, status)
mazgch 54:7ba8e4c218e2 316
mazgch 54:7ba8e4c218e2 317 /** dump the network status to stdout using printf
mazgch 54:7ba8e4c218e2 318 \param status the status to convert to textual form,
mazgch 54:7ba8e4c218e2 319 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 320 \param dprint a function pointer
mazgch 73:2b32e0a21df2 321 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 322 */
mazgch 73:2b32e0a21df2 323 _DUMP_TEMPLATE(dumpNetStatus, MDMParser::NetStatus*, status)
mazgch 73:2b32e0a21df2 324
mazgch 54:7ba8e4c218e2 325 /** dump the ip address to stdout using printf
mazgch 54:7ba8e4c218e2 326 \param ip the ip to convert to textual form,
mazgch 54:7ba8e4c218e2 327 unavailable fields are ommited (not printed)
mazgch 73:2b32e0a21df2 328 \param dprint a function pointer
mazgch 73:2b32e0a21df2 329 \param param the irst argument passed to dprint
mazgch 54:7ba8e4c218e2 330 */
mazgch 73:2b32e0a21df2 331 _DUMP_TEMPLATE(dumpIp, MDMParser::IP, ip)
mazgch 73:2b32e0a21df2 332
mazgch 54:7ba8e4c218e2 333 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 334 // Parseing
mazgch 31:a0bed6c1e05d 335 // ----------------------------------------------------------------
mazgch 31:a0bed6c1e05d 336
mazgch 51:e7b81c31baec 337 enum {
mazgch 51:e7b81c31baec 338 // waitFinalResp Responses
mazgch 52:8071747a7cb3 339 NOT_FOUND = 0,
mazgch 52:8071747a7cb3 340 WAIT = -1, // TIMEOUT
mazgch 52:8071747a7cb3 341 RESP_OK = -2,
mazgch 52:8071747a7cb3 342 RESP_ERROR = -3,
mazgch 52:8071747a7cb3 343 RESP_PROMPT = -4,
mazgch 31:a0bed6c1e05d 344
mazgch 51:e7b81c31baec 345 // getLine Responses
mazgch 51:e7b81c31baec 346 #define LENGTH(x) (x & 0x00FFFF) //!< extract/mask the length
mazgch 51:e7b81c31baec 347 #define TYPE(x) (x & 0xFF0000) //!< extract/mask the type
mazgch 51:e7b81c31baec 348
mazgch 51:e7b81c31baec 349 TYPE_UNKNOWN = 0x000000,
mazgch 51:e7b81c31baec 350 TYPE_OK = 0x110000,
mazgch 51:e7b81c31baec 351 TYPE_ERROR = 0x120000,
mazgch 51:e7b81c31baec 352 TYPE_RING = 0x210000,
mazgch 51:e7b81c31baec 353 TYPE_CONNECT = 0x220000,
mazgch 51:e7b81c31baec 354 TYPE_NOCARRIER = 0x230000,
mazgch 51:e7b81c31baec 355 TYPE_NODIALTONE = 0x240000,
mazgch 51:e7b81c31baec 356 TYPE_BUSY = 0x250000,
mazgch 51:e7b81c31baec 357 TYPE_NOANSWER = 0x260000,
mazgch 51:e7b81c31baec 358 TYPE_PROMPT = 0x300000,
mazgch 51:e7b81c31baec 359 TYPE_PLUS = 0x400000,
mazgch 66:69072b3c5bca 360 TYPE_TEXT = 0x500000,
mazgch 66:69072b3c5bca 361
mazgch 66:69072b3c5bca 362 // special timout constant
mazgch 66:69072b3c5bca 363 TIMEOUT_BLOCKING = -1
mazgch 51:e7b81c31baec 364 };
mazgch 31:a0bed6c1e05d 365
mazgch 31:a0bed6c1e05d 366 /** Get a line from the physical interface. This function need
mazgch 31:a0bed6c1e05d 367 to be implemented in a inherited class. Usually just calls
mazgch 31:a0bed6c1e05d 368 #_getLine on the rx buffer pipe.
mazgch 31:a0bed6c1e05d 369
mazgch 31:a0bed6c1e05d 370 \param buf the buffer to store it
mazgch 31:a0bed6c1e05d 371 \param buf size of the buffer
mazgch 31:a0bed6c1e05d 372 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 373 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 374 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 375 */
mazgch 31:a0bed6c1e05d 376 virtual int getLine(char* buf, int len) = 0;
mazgch 28:4d9509e3b1cf 377
mazgch 31:a0bed6c1e05d 378 /** Write data to the device
mazgch 31:a0bed6c1e05d 379 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 380 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 381 \return bytes written
mazgch 31:a0bed6c1e05d 382 */
mazgch 31:a0bed6c1e05d 383 virtual int send(const char* buf, int len);
mazgch 21:c4d64830bf02 384
mazgch 31:a0bed6c1e05d 385 /** Write formated date to the physical interface (printf style)
mazgch 31:a0bed6c1e05d 386 \param fmt the format string
mazgch 31:a0bed6c1e05d 387 \param .. variable arguments to be formated
mazgch 31:a0bed6c1e05d 388 \return bytes written
mazgch 31:a0bed6c1e05d 389 */
mazgch 21:c4d64830bf02 390 int sendFormated(const char* format, ...);
mazgch 26:07be5faf8925 391
mazgch 31:a0bed6c1e05d 392 /** callback function for #waitFinalResp with void* as argument
mazgch 31:a0bed6c1e05d 393 \param type the #getLine response
mazgch 31:a0bed6c1e05d 394 \param buf the parsed line
mazgch 31:a0bed6c1e05d 395 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 396 \param param the optional argument passed to #waitFinalResp
mazgch 31:a0bed6c1e05d 397 \return WAIT if processing should continue,
mazgch 31:a0bed6c1e05d 398 any other value aborts #waitFinalResp and this retunr value retuned
mazgch 31:a0bed6c1e05d 399 */
mazgch 26:07be5faf8925 400 typedef int (*_CALLBACKPTR)(int type, const char* buf, int len, void* param);
mazgch 31:a0bed6c1e05d 401
mazgch 31:a0bed6c1e05d 402 /** Wait for a final respons
mazgch 31:a0bed6c1e05d 403 \param cb the optional callback function
mazgch 31:a0bed6c1e05d 404 \param param the optional callback function parameter
mazgch 58:e38a2e942fbb 405 \param timeout_ms the timeout to wait (See Estimated command
mazgch 58:e38a2e942fbb 406 response time of AT manual)
mazgch 31:a0bed6c1e05d 407 */
mazgch 31:a0bed6c1e05d 408 int waitFinalResp(_CALLBACKPTR cb = NULL,
mazgch 26:07be5faf8925 409 void* param = NULL,
mazgch 58:e38a2e942fbb 410 int timeout_ms = 10000);
mazgch 31:a0bed6c1e05d 411
mazgch 31:a0bed6c1e05d 412 /** template version of #waitFinalResp when using callbacks,
mazgch 31:a0bed6c1e05d 413 This template will allow the compiler to do type cheking but
mazgch 31:a0bed6c1e05d 414 internally symply casts the arguments and call the (void*)
mazgch 31:a0bed6c1e05d 415 version of #waitFinalResp.
mazgch 31:a0bed6c1e05d 416 \sa waitFinalResp
mazgch 31:a0bed6c1e05d 417 */
mazgch 26:07be5faf8925 418 template<class T>
mazgch 73:2b32e0a21df2 419 inline int waitFinalResp(int (*cb)(int type, const char* buf, int len, T* param),
mazgch 73:2b32e0a21df2 420 T* param,
mazgch 73:2b32e0a21df2 421 int timeout_ms = 10000)
mazgch 26:07be5faf8925 422 {
mazgch 26:07be5faf8925 423 return waitFinalResp((_CALLBACKPTR)cb, (void*)param, timeout_ms);
mazgch 26:07be5faf8925 424 }
mazgch 31:a0bed6c1e05d 425
mazgch 18:e5697801df29 426 protected:
mazgch 31:a0bed6c1e05d 427 /** Write bytes to the physical interface. This function should be
mazgch 31:a0bed6c1e05d 428 implemented in a inherited class.
mazgch 31:a0bed6c1e05d 429 \param buf the buffer to write
mazgch 31:a0bed6c1e05d 430 \param buf size of the buffer to write
mazgch 31:a0bed6c1e05d 431 \return bytes written
mazgch 31:a0bed6c1e05d 432 */
mazgch 18:e5697801df29 433 virtual int _send(const void* buf, int len) = 0;
mazgch 31:a0bed6c1e05d 434
mazgch 31:a0bed6c1e05d 435 /** Helper: Parse a line from the receiving buffered pipe
mazgch 31:a0bed6c1e05d 436 \param pipe the receiving buffer pipe
mazgch 31:a0bed6c1e05d 437 \param buf the parsed line
mazgch 31:a0bed6c1e05d 438 \param len the size of the parsed line
mazgch 31:a0bed6c1e05d 439 \return type and length if something was found,
mazgch 31:a0bed6c1e05d 440 WAIT if not enough data is available
mazgch 31:a0bed6c1e05d 441 NOT_FOUND if nothing was found
mazgch 31:a0bed6c1e05d 442 */
mazgch 31:a0bed6c1e05d 443 static int _getLine(Pipe<char>* pipe, char* buffer, int length);
mazgch 31:a0bed6c1e05d 444
mazgch 31:a0bed6c1e05d 445 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 446 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 447 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 448 \param sta the starting string, NULL if none
mazgch 31:a0bed6c1e05d 449 \param end the terminating string, NULL if none
mazgch 31:a0bed6c1e05d 450 \return size of parsed match
mazgch 31:a0bed6c1e05d 451 */
mazgch 31:a0bed6c1e05d 452 static int _parseMatch(Pipe<char>* pipe, int len, const char* sta, const char* end);
mazgch 31:a0bed6c1e05d 453
mazgch 31:a0bed6c1e05d 454 /** Helper: Parse a match from the pipe
mazgch 31:a0bed6c1e05d 455 \param pipe the buffered pipe
mazgch 31:a0bed6c1e05d 456 \param number of bytes to parse at maximum,
mazgch 31:a0bed6c1e05d 457 \param fmt the formating string (%d any number, %c any char of last %d len)
mazgch 31:a0bed6c1e05d 458 \return size of parsed match
mazgch 31:a0bed6c1e05d 459 */
mazgch 31:a0bed6c1e05d 460 static int _parseFormated(Pipe<char>* pipe, int len, const char* fmt);
mazgch 31:a0bed6c1e05d 461
mazgch 35:9275215a3a5b 462 protected:
mazgch 31:a0bed6c1e05d 463 // parsing callbacks for different AT commands and their parameter arguments
mazgch 31:a0bed6c1e05d 464 static int _cbString(int type, const char* buf, int len, char* str);
mazgch 31:a0bed6c1e05d 465 static int _cbInt(int type, const char* buf, int len, int* val);
mazgch 31:a0bed6c1e05d 466 // device
mazgch 32:8f12ac182bbb 467 static int _cbATI(int type, const char* buf, int len, Dev* dev);
mazgch 31:a0bed6c1e05d 468 static int _cbCPIN(int type, const char* buf, int len, Sim* sim);
mazgch 31:a0bed6c1e05d 469 static int _cbCCID(int type, const char* buf, int len, char* ccid);
mazgch 31:a0bed6c1e05d 470 // network
mazgch 54:7ba8e4c218e2 471 static int _cbCSQ(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 472 static int _cbCOPS(int type, const char* buf, int len, NetStatus* status);
mazgch 31:a0bed6c1e05d 473 static int _cbCNUM(int type, const char* buf, int len, char* num);
mazgch 72:d1e943ad6558 474 static int _cbCGATT(int type, const char* buf, int len, Gprs* gprs);
mazgch 31:a0bed6c1e05d 475 // sockets
mazgch 32:8f12ac182bbb 476 static int _cbCMIP(int type, const char* buf, int len, IP* ip);
mazgch 31:a0bed6c1e05d 477 static int _cbUPSND(int type, const char* buf, int len, int* act);
mazgch 31:a0bed6c1e05d 478 static int _cbUPSND(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 479 static int _cbUDNSRN(int type, const char* buf, int len, IP* ip);
mazgch 21:c4d64830bf02 480 static int _cbUSOCR(int type, const char* buf, int len, int* socket);
mazgch 21:c4d64830bf02 481 static int _cbUSORD(int type, const char* buf, int len, char* out);
mazgch 21:c4d64830bf02 482 typedef struct { char* buf; IP ip; int port; } USORFparam;
mazgch 21:c4d64830bf02 483 static int _cbUSORF(int type, const char* buf, int len, USORFparam* param);
mazgch 21:c4d64830bf02 484 typedef struct { char* buf; char* num; } CMGRparam;
mazgch 21:c4d64830bf02 485 static int _cbCUSD(int type, const char* buf, int len, char* buf);
mazgch 31:a0bed6c1e05d 486 // sms
mazgch 31:a0bed6c1e05d 487 typedef struct { int* ix; int num; } CMGLparam;
mazgch 31:a0bed6c1e05d 488 static int _cbCMGL(int type, const char* buf, int len, CMGLparam* param);
mazgch 21:c4d64830bf02 489 static int _cbCMGR(int type, const char* buf, int len, CMGRparam* param);
mazgch 38:e6cab4632d84 490 // variables
mazgch 31:a0bed6c1e05d 491 DevStatus _dev; //!< collected device information
mazgch 31:a0bed6c1e05d 492 NetStatus _net; //!< collected network information
mazgch 31:a0bed6c1e05d 493 IP _ip; //!< assigned ip address
mazgch 31:a0bed6c1e05d 494 // management struture for sockets
mazgch 21:c4d64830bf02 495 typedef enum { SOCK_FREE, SOCK_CREATED, SOCK_CONNECTED } SockState;
mazgch 66:69072b3c5bca 496 typedef struct { SockState state; int pending; int timeout_ms; } SockCtrl;
mazgch 59:382695f1ce85 497 // LISA-C has 6 TCP and 6 UDP sockets starting at index 18
mazgch 59:382695f1ce85 498 // LISA-U and SARA-G have 7 sockets starting at index 1
mazgch 59:382695f1ce85 499 SockCtrl _sockets[32];
mazgch 44:9d12223b78ff 500 static MDMParser* inst;
mazgch 74:208e3e32d263 501 #ifdef TARGET_UBLOX_C027
mazgch 74:208e3e32d263 502 bool _onboard;
mazgch 74:208e3e32d263 503 #endif
mazgch 74:208e3e32d263 504 #ifdef MDM_DEBUG
mazgch 74:208e3e32d263 505 int _debugLevel;
mazgch 74:208e3e32d263 506 Timer _debugTime;
mazgch 74:208e3e32d263 507 #endif
mazgch 18:e5697801df29 508 };
mazgch 18:e5697801df29 509
mazgch 18:e5697801df29 510 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 511
mazgch 38:e6cab4632d84 512 /** modem class which uses a serial port
mazgch 38:e6cab4632d84 513 as physical interface.
mazgch 38:e6cab4632d84 514 */
mazgch 18:e5697801df29 515 class MDMSerial : public SerialPipe, public MDMParser
mazgch 17:296d94a006b4 516 {
mazgch 17:296d94a006b4 517 public:
mazgch 38:e6cab4632d84 518 /** Constructor
mazgch 38:e6cab4632d84 519
mazgch 38:e6cab4632d84 520 \param tx is the serial ports transmit pin (modem to CPU)
mazgch 38:e6cab4632d84 521 \param rx is the serial ports receive pin (CPU to modem)
mazgch 38:e6cab4632d84 522 \param baudrate the baudrate of the modem use 115200
mazgch 38:e6cab4632d84 523 \param rts is the serial ports ready to send pin (CPU to modem)
mazgch 38:e6cab4632d84 524 this pin is optional
mazgch 38:e6cab4632d84 525 \param cts is the serial ports clear to send pin (modem to CPU)
mazgch 38:e6cab4632d84 526 this pin is optional, but required for power saving to be enabled
mazgch 38:e6cab4632d84 527 \param rxSize the size of the serial rx buffer
mazgch 38:e6cab4632d84 528 \param txSize the size of the serial tx buffer
mazgch 38:e6cab4632d84 529 */
mazgch 74:208e3e32d263 530 MDMSerial(PinName tx _IF( = MDMTXD, = D1 ),
mazgch 74:208e3e32d263 531 PinName rx _IF( = MDMRXD, = D2 ),
mazgch 74:208e3e32d263 532 int baudrate _IF( = MDMBAUD, = 115200 ),
mazgch 35:9275215a3a5b 533 #if DEVICE_SERIAL_FC
mazgch 74:208e3e32d263 534 PinName rts _IF( = MDMRTS, = NC ),
mazgch 74:208e3e32d263 535 PinName cts _IF( = MDMCTS, = NC ),
mazgch 35:9275215a3a5b 536 #endif
mazgch 19:2b5d097ca15d 537 int rxSize = 256 ,
mazgch 21:c4d64830bf02 538 int txSize = 128 );
mazgch 38:e6cab4632d84 539 /** Get a line from the physical interface.
mazgch 38:e6cab4632d84 540 \param buf the buffer to store it
mazgch 38:e6cab4632d84 541 \param buf size of the buffer
mazgch 38:e6cab4632d84 542 \return type and length if something was found,
mazgch 38:e6cab4632d84 543 WAIT if not enough data is available
mazgch 38:e6cab4632d84 544 NOT_FOUND if nothing was found
mazgch 38:e6cab4632d84 545 */
mazgch 18:e5697801df29 546 virtual int getLine(char* buffer, int length);
mazgch 18:e5697801df29 547 protected:
mazgch 38:e6cab4632d84 548 /** Write bytes to the physical interface.
mazgch 38:e6cab4632d84 549 \param buf the buffer to write
mazgch 38:e6cab4632d84 550 \param buf size of the buffer to write
mazgch 38:e6cab4632d84 551 \return bytes written
mazgch 38:e6cab4632d84 552 */
mazgch 18:e5697801df29 553 virtual int _send(const void* buf, int len);
mazgch 17:296d94a006b4 554 };
mazgch 18:e5697801df29 555
mazgch 18:e5697801df29 556 // -----------------------------------------------------------------------
mazgch 18:e5697801df29 557
mazgch 38:e6cab4632d84 558 //#define HAVE_MDMUSB
mazgch 18:e5697801df29 559 #ifdef HAVE_MDMUSB
mazgch 18:e5697801df29 560 class MDMUsb : /*public UsbSerial,*/ public MDMParser
mazgch 18:e5697801df29 561 {
mazgch 18:e5697801df29 562 public:
mazgch 18:e5697801df29 563 MDMUsb(void);
mazgch 18:e5697801df29 564 virtual int getLine(char* buffer, int length);
mazgch 18:e5697801df29 565 protected:
mazgch 18:e5697801df29 566 virtual int _send(const void* buf, int len);
mazgch 18:e5697801df29 567 };
mazgch 18:e5697801df29 568 #endif
mazgch 18:e5697801df29 569
mazgch 18:e5697801df29 570