Marc BUSSON / 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.

Fork of C027_Support by u-blox

MDM.h@123:66cef6353b13, 2015-08-20 (annotated)

Committer:
mazgch
Date:
Thu Aug 20 07:53:34 2015 +0000
Revision:
123:66cef6353b13
Parent:
121:8da935c2c08c
Child:
124:65eb7d58f2da
first draft for toby

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