phs fan / AbitModemInterface

PHS module APM-002 library. see: https://developer.mbed.org/users/phsfan/notebook/abitusbmodem/

Dependencies:   Socket lwip-sys lwip

Fork of AbitUSBModem by phs fan

at/ATCommandsInterface.cpp@96:b50f5f795684, 2015-02-18 (annotated)

Committer:
phsfan
Date:
Wed Feb 18 09:40:07 2015 +0000
Revision:
96:b50f5f795684
Parent:
91:7b311719374d
Child:
97:7d9cc95e2ea7
1st build.; ABIT SMA-01

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:3b2f052c333b 1 /* ATCommandsInterface.cpp */
donatien 22:06fb2a93a1f6 2 /* Copyright (C) 2012 mbed.org, MIT License
donatien 22:06fb2a93a1f6 3 *
donatien 22:06fb2a93a1f6 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 22:06fb2a93a1f6 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
donatien 22:06fb2a93a1f6 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
donatien 22:06fb2a93a1f6 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
donatien 22:06fb2a93a1f6 8 * furnished to do so, subject to the following conditions:
donatien 22:06fb2a93a1f6 9 *
donatien 22:06fb2a93a1f6 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 22:06fb2a93a1f6 11 * substantial portions of the Software.
donatien 22:06fb2a93a1f6 12 *
donatien 22:06fb2a93a1f6 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 22:06fb2a93a1f6 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 22:06fb2a93a1f6 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 22:06fb2a93a1f6 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 22:06fb2a93a1f6 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 22:06fb2a93a1f6 18 */
donatien 0:3b2f052c333b 19
ashleymills 79:a6ac8206a58d 20 #define __DEBUG__ 0 //ERR+WARN
donatien 0:3b2f052c333b 21 #ifndef __MODULE__
donatien 0:3b2f052c333b 22 #define __MODULE__ "ATCommandsInterface.cpp"
donatien 0:3b2f052c333b 23 #endif
donatien 0:3b2f052c333b 24
donatien 0:3b2f052c333b 25 #include "core/fwk.h"
donatien 0:3b2f052c333b 26
donatien 0:3b2f052c333b 27 #include <cstdio>
donatien 62:6f42a974eea6 28 #include <cstring> //For memset, strstr...
donatien 0:3b2f052c333b 29
donatien 0:3b2f052c333b 30 using std::memmove;
donatien 0:3b2f052c333b 31
donatien 0:3b2f052c333b 32 #include "ATCommandsInterface.h"
donatien 0:3b2f052c333b 33
donatien 0:3b2f052c333b 34 ATCommandsInterface::ATCommandsInterface(IOStream* pStream) :
ashleymills 83:897a0de9d668 35 m_pStream(pStream), // this is the serial interface to the modem
ashleymills 83:897a0de9d668 36 m_open(false), // AT interface is initially in a closed state
ashleymills 83:897a0de9d668 37 m_env2AT(), // send messages from calling functions to AT parsing thread
ashleymills 83:897a0de9d668 38 m_AT2Env(), // send messages from AT parsing thread to calling functions
ashleymills 83:897a0de9d668 39 m_processingMtx(), // mutex for processing thread
ashleymills 83:897a0de9d668 40 m_processingThread( // construct processing thread
ashleymills 83:897a0de9d668 41 &ATCommandsInterface::staticCallback, // static callback uses this pointer to run process()
ashleymills 83:897a0de9d668 42 this,
ashleymills 83:897a0de9d668 43 (osPriority)AT_THREAD_PRIORITY, // normal priority
ashleymills 83:897a0de9d668 44 4*192 // size of the processing thread
ashleymills 83:897a0de9d668 45 ),
ashleymills 83:897a0de9d668 46 m_eventsMgmtMtx(), // mutex for managing events
ashleymills 83:897a0de9d668 47 m_eventsProcessingMtx() // mutex for processing events
donatien 0:3b2f052c333b 48 {
ashleymills 83:897a0de9d668 49 // zero the memory for the event handler pointers
ashleymills 83:897a0de9d668 50 memset(m_eventsHandlers, 0, MAX_AT_EVENTS_HANDLERS * sizeof(IATEventsHandler*));
ashleymills 83:897a0de9d668 51 m_processingMtx.lock();
donatien 0:3b2f052c333b 52 }
donatien 0:3b2f052c333b 53
ashleymills 83:897a0de9d668 54 // open connection to AT Interface in order to execute command & register/unregister events
ashleymills 83:897a0de9d668 55 int ATCommandsInterface::open() {
ashleymills 83:897a0de9d668 56 if( m_open ) {
donatien 0:3b2f052c333b 57 WARN("AT interface is already open");
donatien 0:3b2f052c333b 58 return OK;
donatien 0:3b2f052c333b 59 }
donatien 0:3b2f052c333b 60 DBG("Opening AT interface");
ashleymills 83:897a0de9d668 61
ashleymills 83:897a0de9d668 62 // start processing
donatien 0:3b2f052c333b 63 m_processingThread.signal_set(AT_SIG_PROCESSING_START);
donatien 0:3b2f052c333b 64
donatien 0:3b2f052c333b 65 m_processingMtx.unlock();
donatien 0:3b2f052c333b 66
donatien 0:3b2f052c333b 67 m_open = true;
donatien 0:3b2f052c333b 68
donatien 0:3b2f052c333b 69 DBG("AT interface opened");
donatien 59:593fb493172f 70
donatien 0:3b2f052c333b 71 return OK;
donatien 0:3b2f052c333b 72 }
donatien 0:3b2f052c333b 73
ashleymills 83:897a0de9d668 74 // initialize AT link & start events processing
donatien 0:3b2f052c333b 75 int ATCommandsInterface::init()
donatien 0:3b2f052c333b 76 {
donatien 0:3b2f052c333b 77 DBG("Sending ATZ E1 V1");
donatien 59:593fb493172f 78
donatien 59:593fb493172f 79 //Lock transaction mutex
donatien 59:593fb493172f 80 m_transactionMtx.lock();
donatien 59:593fb493172f 81
ashleymills 83:897a0de9d668 82 // should we flush m_pStream at this point ???
ashleymills 83:897a0de9d668 83 // ash - it would do no harm so we should, incase some pending crap arrives
donatien 0:3b2f052c333b 84 int err;
donatien 0:3b2f052c333b 85 int tries = 5;
donatien 0:3b2f052c333b 86 do
donatien 0:3b2f052c333b 87 {
phsfan 96:b50f5f795684 88 // err = executeInternal("ATZ E1 V1", this, NULL, 3000); //Enable echo and verbosity
phsfan 96:b50f5f795684 89 err = executeInternal("ATZ", this, NULL, 3000); //Enable echo and verbosity
donatien 0:3b2f052c333b 90 if(err && tries)
donatien 0:3b2f052c333b 91 {
donatien 0:3b2f052c333b 92 WARN("No response, trying again");
donatien 0:3b2f052c333b 93 Thread::wait(1000); //Give dongle time to recover
donatien 0:3b2f052c333b 94 }
donatien 0:3b2f052c333b 95 } while(err && tries--);
donatien 0:3b2f052c333b 96 if( err )
donatien 0:3b2f052c333b 97 {
donatien 0:3b2f052c333b 98 ERR("Sending ATZ E1 V1 returned with err code %d", err);
donatien 59:593fb493172f 99 m_transactionMtx.unlock();
donatien 0:3b2f052c333b 100 return err;
donatien 0:3b2f052c333b 101 }
donatien 59:593fb493172f 102
donatien 59:593fb493172f 103 //Enable events handling and execute events enabling commands
donatien 59:593fb493172f 104 enableEvents();
donatien 0:3b2f052c333b 105
donatien 0:3b2f052c333b 106 DBG("AT interface initialized");
donatien 59:593fb493172f 107
donatien 59:593fb493172f 108 //Unlock transaction mutex
donatien 59:593fb493172f 109 m_transactionMtx.unlock();
donatien 0:3b2f052c333b 110
donatien 0:3b2f052c333b 111 return OK;
donatien 0:3b2f052c333b 112 }
donatien 0:3b2f052c333b 113
donatien 0:3b2f052c333b 114 //Close connection
donatien 0:3b2f052c333b 115 int ATCommandsInterface::close()
donatien 0:3b2f052c333b 116 {
donatien 0:3b2f052c333b 117 if( !m_open )
donatien 0:3b2f052c333b 118 {
donatien 0:3b2f052c333b 119 WARN("AT interface is already closed");
donatien 0:3b2f052c333b 120 return OK;
donatien 0:3b2f052c333b 121 }
donatien 0:3b2f052c333b 122
donatien 0:3b2f052c333b 123 DBG("Closing AT interface");
donatien 61:0bcb8c5216d4 124
donatien 61:0bcb8c5216d4 125 //Lock transaction mutex
donatien 61:0bcb8c5216d4 126 m_transactionMtx.lock();
donatien 61:0bcb8c5216d4 127
donatien 61:0bcb8c5216d4 128 //Disable events handling and advertize this to the events handlers
donatien 61:0bcb8c5216d4 129 disableEvents();
donatien 0:3b2f052c333b 130
donatien 0:3b2f052c333b 131 //Stop processing
donatien 0:3b2f052c333b 132 m_processingThread.signal_set(AT_SIG_PROCESSING_STOP);
donatien 0:3b2f052c333b 133 //m_stopSphre.release();
donatien 0:3b2f052c333b 134
ashleymills 83:897a0de9d668 135 // ash - don't know why he sends this as it is never used XXX
donatien 0:3b2f052c333b 136 int* msg = m_env2AT.alloc(osWaitForever);
donatien 0:3b2f052c333b 137 *msg = AT_STOP;
donatien 0:3b2f052c333b 138 m_env2AT.put(msg); //Used to unstall the process if needed
donatien 0:3b2f052c333b 139
donatien 0:3b2f052c333b 140 //Unlock process routine (abort read)
donatien 0:3b2f052c333b 141 m_pStream->abortRead(); //This is thread-safe
donatien 0:3b2f052c333b 142 m_processingMtx.lock();
donatien 0:3b2f052c333b 143 m_open = false;
donatien 61:0bcb8c5216d4 144
donatien 61:0bcb8c5216d4 145 //Unlock transaction mutex
donatien 61:0bcb8c5216d4 146 m_transactionMtx.unlock();
donatien 0:3b2f052c333b 147
donatien 0:3b2f052c333b 148 DBG("AT interface closed");
donatien 0:3b2f052c333b 149 return OK;
donatien 0:3b2f052c333b 150 }
donatien 0:3b2f052c333b 151
donatien 0:3b2f052c333b 152 bool ATCommandsInterface::isOpen()
donatien 0:3b2f052c333b 153 {
donatien 0:3b2f052c333b 154 return m_open;
donatien 0:3b2f052c333b 155 }
donatien 0:3b2f052c333b 156
donatien 0:3b2f052c333b 157 int ATCommandsInterface::executeSimple(const char* command, ATResult* pResult, uint32_t timeout/*=1000*/)
donatien 0:3b2f052c333b 158 {
donatien 0:3b2f052c333b 159 return execute(command, this, pResult, timeout);
donatien 0:3b2f052c333b 160 }
donatien 0:3b2f052c333b 161
donatien 0:3b2f052c333b 162 int ATCommandsInterface::execute(const char* command, IATCommandsProcessor* pProcessor, ATResult* pResult, uint32_t timeout/*=1000*/)
donatien 0:3b2f052c333b 163 {
donatien 0:3b2f052c333b 164 if(!m_open)
donatien 0:3b2f052c333b 165 {
donatien 0:3b2f052c333b 166 WARN("Interface is not open!");
donatien 0:3b2f052c333b 167 return NET_INVALID;
donatien 0:3b2f052c333b 168 }
donatien 0:3b2f052c333b 169
donatien 0:3b2f052c333b 170 //Lock transaction mutex
donatien 0:3b2f052c333b 171 m_transactionMtx.lock();
ashleymills 83:897a0de9d668 172 DBG("ATCommandsInterface::execute");
donatien 59:593fb493172f 173 disableEvents(); //Disable unsollicited result codes
donatien 59:593fb493172f 174 int ret = executeInternal(command, pProcessor, pResult, timeout);
donatien 59:593fb493172f 175 enableEvents(); //Re-enable unsollicited result codes whatever the result of the command is
donatien 59:593fb493172f 176
donatien 59:593fb493172f 177 //Unlock transaction mutex
donatien 59:593fb493172f 178 m_transactionMtx.unlock();
donatien 59:593fb493172f 179
donatien 59:593fb493172f 180 return ret;
donatien 59:593fb493172f 181 }
donatien 59:593fb493172f 182
donatien 59:593fb493172f 183 int ATCommandsInterface::registerEventsHandler(IATEventsHandler* pHdlr)
donatien 59:593fb493172f 184 {
donatien 59:593fb493172f 185 m_eventsMgmtMtx.lock();
donatien 59:593fb493172f 186 m_eventsProcessingMtx.lock();
donatien 59:593fb493172f 187 for(int i = 0; i < MAX_AT_EVENTS_HANDLERS; i++) //Find a free slot
donatien 59:593fb493172f 188 {
donatien 59:593fb493172f 189 if( m_eventsHandlers[i] == NULL )
donatien 59:593fb493172f 190 {
donatien 59:593fb493172f 191 m_eventsHandlers[i] = pHdlr;
donatien 59:593fb493172f 192 m_eventsProcessingMtx.unlock();
donatien 59:593fb493172f 193 m_eventsMgmtMtx.unlock();
donatien 59:593fb493172f 194 return OK;
donatien 59:593fb493172f 195 }
donatien 59:593fb493172f 196 }
donatien 59:593fb493172f 197 m_eventsProcessingMtx.unlock();
donatien 59:593fb493172f 198 m_eventsMgmtMtx.unlock();
donatien 59:593fb493172f 199 return NET_OOM; //No room left
donatien 59:593fb493172f 200 }
donatien 59:593fb493172f 201
donatien 59:593fb493172f 202 int ATCommandsInterface::deregisterEventsHandler(IATEventsHandler* pHdlr)
donatien 59:593fb493172f 203 {
donatien 59:593fb493172f 204 m_eventsMgmtMtx.lock();
donatien 59:593fb493172f 205 m_eventsProcessingMtx.lock();
donatien 59:593fb493172f 206 for(int i = 0; i < MAX_AT_EVENTS_HANDLERS; i++) //Find handler in list
donatien 59:593fb493172f 207 {
donatien 59:593fb493172f 208 if( m_eventsHandlers[i] == pHdlr )
donatien 59:593fb493172f 209 {
donatien 59:593fb493172f 210 m_eventsHandlers[i] = NULL;
donatien 59:593fb493172f 211 m_eventsProcessingMtx.unlock();
donatien 59:593fb493172f 212 m_eventsMgmtMtx.unlock();
donatien 59:593fb493172f 213 return OK;
donatien 59:593fb493172f 214 }
donatien 59:593fb493172f 215 }
donatien 59:593fb493172f 216 m_eventsProcessingMtx.unlock();
donatien 59:593fb493172f 217 m_eventsMgmtMtx.unlock();
donatien 59:593fb493172f 218 return NET_NOTFOUND; //Not found
donatien 59:593fb493172f 219 }
donatien 59:593fb493172f 220
donatien 59:593fb493172f 221 //Private methods
donatien 59:593fb493172f 222
donatien 59:593fb493172f 223 int ATCommandsInterface::executeInternal(const char* command, IATCommandsProcessor* pProcessor, ATResult* pResult, uint32_t timeout/*=1000*/)
donatien 59:593fb493172f 224 {
donatien 59:593fb493172f 225 DBG("Executing command %s", command);
donatien 0:3b2f052c333b 226
donatien 0:3b2f052c333b 227 //Discard previous result if it arrived too late
donatien 0:3b2f052c333b 228 osEvent evt = m_AT2Env.get(0);
donatien 0:3b2f052c333b 229
donatien 0:3b2f052c333b 230 if(evt.status == osEventMail)
donatien 0:3b2f052c333b 231 {
donatien 0:3b2f052c333b 232 m_AT2Env.free((int*)evt.value.p);
donatien 0:3b2f052c333b 233 WARN("Previous result discarded");
donatien 0:3b2f052c333b 234 }
donatien 0:3b2f052c333b 235
donatien 0:3b2f052c333b 236 //Send params to the process routine
donatien 0:3b2f052c333b 237 m_transactionCommand = command;
donatien 0:3b2f052c333b 238 if(pProcessor != NULL)
donatien 0:3b2f052c333b 239 {
donatien 0:3b2f052c333b 240 m_pTransactionProcessor = pProcessor;
donatien 0:3b2f052c333b 241 }
donatien 0:3b2f052c333b 242 else
donatien 0:3b2f052c333b 243 {
donatien 0:3b2f052c333b 244 m_pTransactionProcessor = this; //Use default behaviour
donatien 0:3b2f052c333b 245 }
donatien 0:3b2f052c333b 246
donatien 0:3b2f052c333b 247 DBG("Sending command ready signal to AT thread & aborting current blocking read operation");
donatien 0:3b2f052c333b 248
donatien 0:3b2f052c333b 249 //Produce command ready signal
donatien 0:3b2f052c333b 250 int* msg = m_env2AT.alloc(osWaitForever);
donatien 0:3b2f052c333b 251 *msg = AT_CMD_READY;
donatien 0:3b2f052c333b 252 m_env2AT.put(msg);
donatien 0:3b2f052c333b 253
donatien 0:3b2f052c333b 254 DBG("Trying to enter abortRead()");
donatien 0:3b2f052c333b 255 //Unlock process routine (abort read)
donatien 0:3b2f052c333b 256 m_pStream->abortRead(); //This is thread-safe
donatien 0:3b2f052c333b 257
donatien 0:3b2f052c333b 258 //Wait for a result (get result message)
ashleymills 83:897a0de9d668 259 DBG("Timeout: %d",timeout);
donatien 0:3b2f052c333b 260 evt = m_AT2Env.get(timeout);
donatien 0:3b2f052c333b 261
donatien 0:3b2f052c333b 262 if(evt.status != osEventMail)
donatien 0:3b2f052c333b 263 {
donatien 0:3b2f052c333b 264 //Cancel request
donatien 0:3b2f052c333b 265 msg = m_env2AT.alloc(osWaitForever);
donatien 0:3b2f052c333b 266 *msg = AT_TIMEOUT;
donatien 0:3b2f052c333b 267 m_env2AT.put(msg);
donatien 0:3b2f052c333b 268
donatien 0:3b2f052c333b 269 DBG("Trying to enter abortRead()");
donatien 0:3b2f052c333b 270 //Unlock process routine (abort read)
donatien 0:3b2f052c333b 271 m_pStream->abortRead(); //This is thread-safe
donatien 61:0bcb8c5216d4 272
donatien 61:0bcb8c5216d4 273 //Wait for acknowledge
donatien 61:0bcb8c5216d4 274 int msgResult;
donatien 61:0bcb8c5216d4 275 do
donatien 61:0bcb8c5216d4 276 {
donatien 61:0bcb8c5216d4 277 evt = m_AT2Env.get(osWaitForever);
donatien 61:0bcb8c5216d4 278 msgResult = *((int*) evt.value.p);
donatien 61:0bcb8c5216d4 279 m_AT2Env.free((int*)evt.value.p);
ashleymills 83:897a0de9d668 280 } while(msgResult != AT_TIMEOUT );
donatien 0:3b2f052c333b 281
donatien 0:3b2f052c333b 282 WARN("Command returned no message");
donatien 0:3b2f052c333b 283 return NET_TIMEOUT;
donatien 0:3b2f052c333b 284 }
donatien 0:3b2f052c333b 285 DBG("Command returned with message %d", *msg);
donatien 0:3b2f052c333b 286
donatien 0:3b2f052c333b 287 m_AT2Env.free((int*)evt.value.p);
donatien 0:3b2f052c333b 288
donatien 0:3b2f052c333b 289 if(pResult != NULL)
donatien 0:3b2f052c333b 290 {
donatien 0:3b2f052c333b 291 *pResult = m_transactionResult;
donatien 0:3b2f052c333b 292 }
donatien 0:3b2f052c333b 293
donatien 0:3b2f052c333b 294 int ret = ATResultToReturnCode(m_transactionResult);
donatien 0:3b2f052c333b 295 if(ret != OK)
donatien 0:3b2f052c333b 296 {
donatien 0:3b2f052c333b 297 WARN("Command returned AT result %d with code %d", m_transactionResult.result, m_transactionResult.code);
donatien 0:3b2f052c333b 298 }
donatien 0:3b2f052c333b 299
donatien 0:3b2f052c333b 300 DBG("Command returned successfully");
ashleymills 91:7b311719374d 301
donatien 0:3b2f052c333b 302 return ret;
donatien 0:3b2f052c333b 303 }
donatien 0:3b2f052c333b 304
donatien 0:3b2f052c333b 305 int ATCommandsInterface::tryReadLine()
donatien 0:3b2f052c333b 306 {
donatien 0:3b2f052c333b 307 static bool lineDetected = false;
donatien 0:3b2f052c333b 308
donatien 0:3b2f052c333b 309 //Block on serial read or incoming command
donatien 0:3b2f052c333b 310 DBG("Trying to read a new line from stream");
donatien 0:3b2f052c333b 311 int ret = m_pStream->waitAvailable(); //This can be aborted
ashleymills 83:897a0de9d668 312
donatien 0:3b2f052c333b 313 size_t readLen = 0;
donatien 0:3b2f052c333b 314 if(ret == OK)
donatien 0:3b2f052c333b 315 {
donatien 0:3b2f052c333b 316 ret = m_pStream->read((uint8_t*)m_inputBuf + m_inputPos, &readLen, AT_INPUT_BUF_SIZE - 1 - m_inputPos, 0); //Do NOT wait at this point
donatien 0:3b2f052c333b 317 }
donatien 0:3b2f052c333b 318 if(ret == OK)
donatien 0:3b2f052c333b 319 {
donatien 0:3b2f052c333b 320 m_inputPos+=readLen;
donatien 0:3b2f052c333b 321 m_inputBuf[m_inputPos] = '\0'; //Add null terminating character to ease the use of str* functions
ashleymills 91:7b311719374d 322 #if __DEBUG__ >= 4
ashleymills 91:7b311719374d 323 DBGX("In buffer: [");
phsfan 96:b50f5f795684 324 if (__DEBUG__)
ashleymills 91:7b311719374d 325 for(int i=0; i<strlen(m_inputBuf); i++) {
ashleymills 91:7b311719374d 326 if(m_inputBuf[i]=='\r') {
ashleymills 91:7b311719374d 327 DBGX("<CR>");
ashleymills 91:7b311719374d 328 } else if(m_inputBuf[i]=='\n') {
ashleymills 91:7b311719374d 329 DBGX("<LF>");
ashleymills 91:7b311719374d 330 } else {
ashleymills 91:7b311719374d 331 DBGX("%c",m_inputBuf[i]);
ashleymills 91:7b311719374d 332 }
ashleymills 91:7b311719374d 333 }
ashleymills 91:7b311719374d 334 DBGX("]\r\n");
ashleymills 91:7b311719374d 335 #endif
donatien 0:3b2f052c333b 336 }
donatien 0:3b2f052c333b 337
donatien 0:3b2f052c333b 338 if( ret == NET_INTERRUPTED ) //It is worth checking readLen as data might have been read even though the read was interrupted
donatien 0:3b2f052c333b 339 {
ashleymills 83:897a0de9d668 340 DBG("Read was interrupted with %d chars read",readLen);
donatien 0:3b2f052c333b 341 return NET_INTERRUPTED; //0 chars were read
donatien 0:3b2f052c333b 342 }
donatien 0:3b2f052c333b 343 else if(readLen == 0)
donatien 0:3b2f052c333b 344 {
donatien 0:3b2f052c333b 345 DBG("Nothing read");
donatien 0:3b2f052c333b 346 return OK; //0 chars were read
donatien 0:3b2f052c333b 347 }
donatien 0:3b2f052c333b 348
donatien 0:3b2f052c333b 349 DBG("Trying to process incoming line");
donatien 0:3b2f052c333b 350 bool lineProcessed = false;
donatien 0:3b2f052c333b 351
donatien 0:3b2f052c333b 352 do
donatien 0:3b2f052c333b 353 {
donatien 0:3b2f052c333b 354 lineProcessed = false; //Reset flag
donatien 0:3b2f052c333b 355
donatien 0:3b2f052c333b 356 DBG("New iteration");
donatien 0:3b2f052c333b 357
donatien 0:3b2f052c333b 358 //Look for a new line
donatien 0:3b2f052c333b 359 if(!lineDetected)
donatien 0:3b2f052c333b 360 {
donatien 0:3b2f052c333b 361 DBG("No line detected yet");
donatien 0:3b2f052c333b 362 //Try to look for a starting CRLF
donatien 0:3b2f052c333b 363 char* crPtr = strchr(m_inputBuf, CR);
donatien 0:3b2f052c333b 364 /*
donatien 0:3b2f052c333b 365 Different cases at this point:
donatien 0:3b2f052c333b 366 - CRLF%c sequence: this is the start of a line
donatien 0:3b2f052c333b 367 - CRLFCR(LF) sequence: this is the end of a line (followed by the beginning of the next one)
donatien 0:3b2f052c333b 368 - LF: this is the trailing LF char of the previous line, discard
donatien 0:3b2f052c333b 369 - CR / CRLF incomplete sequence: more data is needed to determine which action to take
donatien 0:3b2f052c333b 370 - %c ... CR sequence: this should be the echo of the previous sequence
donatien 0:3b2f052c333b 371 - %c sequence: This might be the echo of the previous command; more data is needed to determine which action to take
donatien 0:3b2f052c333b 372
donatien 0:3b2f052c333b 373 In every case, move mem at the beginning
donatien 0:3b2f052c333b 374 */
donatien 0:3b2f052c333b 375 if(crPtr != NULL)
donatien 0:3b2f052c333b 376 {
donatien 0:3b2f052c333b 377 DBG("CR char found");
donatien 0:3b2f052c333b 378
donatien 0:3b2f052c333b 379 #if 0
donatien 0:3b2f052c333b 380 //Discard all preceding characters (can do nothing if m_inputBuf == crPtr)
donatien 0:3b2f052c333b 381 memmove(m_inputBuf, crPtr, (m_inputPos + 1) - (crPtr-m_inputBuf)); //Move null-terminating char as well
donatien 0:3b2f052c333b 382 m_inputPos = m_inputPos - (crPtr-m_inputBuf); //Adjust m_inputPos
donatien 0:3b2f052c333b 383 #endif
donatien 0:3b2f052c333b 384
donatien 0:3b2f052c333b 385 //If the line starts with CR, this should be a result code
donatien 0:3b2f052c333b 386 if( crPtr == m_inputBuf )
donatien 0:3b2f052c333b 387 {
donatien 0:3b2f052c333b 388 //To determine the sequence we need at least 3 chars
donatien 0:3b2f052c333b 389 if(m_inputPos >= 3)
donatien 0:3b2f052c333b 390 {
donatien 0:3b2f052c333b 391 //Look for a LF char next to the CR char
donatien 0:3b2f052c333b 392 if(m_inputBuf[1] == LF)
donatien 0:3b2f052c333b 393 {
donatien 0:3b2f052c333b 394 //At this point we can check whether this is the end of a preceding line or the beginning of a new one
donatien 0:3b2f052c333b 395 if(m_inputBuf[2] != CR)
donatien 0:3b2f052c333b 396 {
donatien 0:3b2f052c333b 397 DBG("Beginning of new line found");
donatien 0:3b2f052c333b 398 //Beginning of a line
donatien 0:3b2f052c333b 399 lineDetected = true; //Move to next state-machine step
donatien 0:3b2f052c333b 400 }
donatien 0:3b2f052c333b 401 else
donatien 0:3b2f052c333b 402 {
donatien 0:3b2f052c333b 403 //End of an unprocessed line
donatien 0:3b2f052c333b 404 WARN("End of unprocessed line");
donatien 0:3b2f052c333b 405 }
donatien 0:3b2f052c333b 406 //In both cases discard CRLF
donatien 0:3b2f052c333b 407 DBG("Discarding CRLF");
donatien 0:3b2f052c333b 408 memmove(m_inputBuf, m_inputBuf + 2, (m_inputPos + 1) - 2); //Move null-terminating char as well
donatien 0:3b2f052c333b 409 m_inputPos = m_inputPos - 2; //Adjust m_inputPos
donatien 0:3b2f052c333b 410 }
donatien 0:3b2f052c333b 411 else
donatien 0:3b2f052c333b 412 {
donatien 0:3b2f052c333b 413 //This is completely unexpected, discard the CR char to try to recover good state
donatien 0:3b2f052c333b 414 WARN("Unexpected %c char (%02d code) found after CR char", m_inputBuf[1]);
donatien 0:3b2f052c333b 415 memmove(m_inputBuf, m_inputBuf + 1, (m_inputPos + 1) - 1); //Move null-terminating char as well
donatien 0:3b2f052c333b 416 m_inputPos = m_inputPos - 1; //Adjust m_inputPos
donatien 0:3b2f052c333b 417 }
donatien 0:3b2f052c333b 418 }
donatien 0:3b2f052c333b 419 }
donatien 0:3b2f052c333b 420 //if the line does NOT begin with CR, this can be an echo of the previous command, process it
donatien 0:3b2f052c333b 421 else
donatien 0:3b2f052c333b 422 {
donatien 0:3b2f052c333b 423 int crPos = crPtr - m_inputBuf;
donatien 0:3b2f052c333b 424 int lfOff = 0; //Offset for LF if present
donatien 0:3b2f052c333b 425 DBG("New line found (possible echo of command)");
donatien 0:3b2f052c333b 426 //This is the end of line
donatien 0:3b2f052c333b 427 //Replace m_inputBuf[crPos] with null-terminating char
donatien 0:3b2f052c333b 428 m_inputBuf[crPos] = '\0';
donatien 0:3b2f052c333b 429 //Check if there is a LF char afterwards
donatien 0:3b2f052c333b 430 if(m_inputPos - crPos >= 1)
donatien 0:3b2f052c333b 431 {
donatien 0:3b2f052c333b 432 if(m_inputBuf[crPos+1] == LF)
donatien 0:3b2f052c333b 433 {
donatien 0:3b2f052c333b 434 lfOff++; //We will discard LF char as well
donatien 0:3b2f052c333b 435 }
donatien 0:3b2f052c333b 436 }
donatien 0:3b2f052c333b 437 //Process line
donatien 51:54ca82a7644c 438 int ret = processReadLine();
donatien 51:54ca82a7644c 439 if(ret)
donatien 51:54ca82a7644c 440 {
donatien 51:54ca82a7644c 441 m_inputPos = 0;
donatien 51:54ca82a7644c 442 m_inputBuf[0] = '\0'; //Always have a null-terminating char at start of buffer
donatien 51:54ca82a7644c 443 lineDetected = false;
donatien 51:54ca82a7644c 444 return ret;
donatien 51:54ca82a7644c 445 }
donatien 51:54ca82a7644c 446
donatien 51:54ca82a7644c 447 //If sendData has been called, all incoming data has been discarded
donatien 51:54ca82a7644c 448 if(m_inputPos > 0)
donatien 51:54ca82a7644c 449 {
donatien 51:54ca82a7644c 450 memmove(m_inputBuf, m_inputBuf + crPos + lfOff + 1, (m_inputPos + 1) - (crPos + lfOff + 1)); //Move null-terminating char as well
donatien 51:54ca82a7644c 451 m_inputPos = m_inputPos - (crPos + lfOff + 1); //Adjust m_inputPos
donatien 51:54ca82a7644c 452 }
donatien 0:3b2f052c333b 453 DBG("One line was successfully processed");
donatien 0:3b2f052c333b 454 lineProcessed = true; //Line was processed with success
donatien 0:3b2f052c333b 455 lineDetected = false; //Search now for a new line
donatien 0:3b2f052c333b 456 }
donatien 0:3b2f052c333b 457 }
donatien 0:3b2f052c333b 458 else if(m_inputBuf[0] == LF) //If there is a remaining LF char from the previous line, discard it
donatien 0:3b2f052c333b 459 {
donatien 0:3b2f052c333b 460 DBG("Discarding single LF char");
donatien 0:3b2f052c333b 461 memmove(m_inputBuf, m_inputBuf + 1, (m_inputPos + 1) - 1); //Move null-terminating char as well
donatien 0:3b2f052c333b 462 m_inputPos = m_inputPos - 1; //Adjust m_inputPos
donatien 0:3b2f052c333b 463 }
donatien 0:3b2f052c333b 464 }
donatien 0:3b2f052c333b 465
donatien 0:3b2f052c333b 466 //Look for the end of line
donatien 0:3b2f052c333b 467 if(lineDetected)
donatien 0:3b2f052c333b 468 {
donatien 0:3b2f052c333b 469 DBG("Looking for end of line");
donatien 0:3b2f052c333b 470 //Try to look for a terminating CRLF
donatien 0:3b2f052c333b 471 char* crPtr = strchr(m_inputBuf, CR);
donatien 0:3b2f052c333b 472 /*
donatien 0:3b2f052c333b 473 Different cases at this point:
donatien 0:3b2f052c333b 474 - CRLF sequence: this is the end of the line
donatien 0:3b2f052c333b 475 - CR%c sequence : unexpected
donatien 0:3b2f052c333b 476 - CR incomplete sequence: more data is needed to determine which action to take
donatien 0:3b2f052c333b 477 */
donatien 0:3b2f052c333b 478
donatien 0:3b2f052c333b 479 //Try to look for a '>' (greater than character) that marks an entry prompt
donatien 0:3b2f052c333b 480 char* greaterThanPtr = strchr(m_inputBuf, GD);
donatien 0:3b2f052c333b 481 /*
donatien 0:3b2f052c333b 482 This character must be detected as there is no CRLF sequence at the end of an entry prompt
donatien 0:3b2f052c333b 483 */
donatien 0:3b2f052c333b 484
donatien 0:3b2f052c333b 485 if(crPtr != NULL)
donatien 0:3b2f052c333b 486 {
donatien 0:3b2f052c333b 487 DBG("CR char found");
donatien 0:3b2f052c333b 488 int crPos = crPtr - m_inputBuf;
donatien 0:3b2f052c333b 489 //To determine the sequence we need at least 2 chars
donatien 0:3b2f052c333b 490 if(m_inputPos - crPos >= 2)
donatien 0:3b2f052c333b 491 {
donatien 0:3b2f052c333b 492 //Look for a LF char next to the CR char
donatien 0:3b2f052c333b 493 if(m_inputBuf[crPos + 1] == LF)
donatien 0:3b2f052c333b 494 {
donatien 0:3b2f052c333b 495 DBG("End of new line found");
donatien 0:3b2f052c333b 496 //This is the end of line
donatien 0:3b2f052c333b 497 //Replace m_inputBuf[crPos] with null-terminating char
donatien 0:3b2f052c333b 498 m_inputBuf[crPos] = '\0';
donatien 0:3b2f052c333b 499 //Process line
donatien 0:3b2f052c333b 500 int ret = processReadLine();
ashleymills 91:7b311719374d 501 // ret is non-zero in case of error
donatien 0:3b2f052c333b 502 if(ret)
donatien 0:3b2f052c333b 503 {
donatien 0:3b2f052c333b 504 m_inputPos = 0;
donatien 51:54ca82a7644c 505 m_inputBuf[0] = '\0'; //Always have a null-terminating char at start of buffer
donatien 0:3b2f052c333b 506 lineDetected = false;
donatien 0:3b2f052c333b 507 return ret;
donatien 0:3b2f052c333b 508 }
donatien 0:3b2f052c333b 509
donatien 0:3b2f052c333b 510 //If sendData has been called, all incoming data has been discarded
donatien 0:3b2f052c333b 511 if(m_inputPos > 0)
donatien 0:3b2f052c333b 512 {
donatien 0:3b2f052c333b 513 //Shift remaining data to beginning of buffer
donatien 0:3b2f052c333b 514 memmove(m_inputBuf, m_inputBuf + crPos + 2, (m_inputPos + 1) - (crPos + 2)); //Move null-terminating char as well
donatien 0:3b2f052c333b 515 m_inputPos = m_inputPos - (crPos + 2); //Adjust m_inputPos
donatien 0:3b2f052c333b 516 }
donatien 0:3b2f052c333b 517
donatien 0:3b2f052c333b 518 DBG("One line was successfully processed");
donatien 0:3b2f052c333b 519 lineProcessed = true; //Line was processed with success
donatien 0:3b2f052c333b 520 }
donatien 0:3b2f052c333b 521 else
donatien 0:3b2f052c333b 522 {
donatien 0:3b2f052c333b 523 //This is completely unexpected, discard all chars till the CR char to try to recover good state
donatien 0:3b2f052c333b 524 WARN("Unexpected %c char (%02d code) found in incoming line", m_inputBuf[crPos + 1]);
donatien 0:3b2f052c333b 525 memmove(m_inputBuf, m_inputBuf + crPos + 1, (m_inputPos + 1) - (crPos + 1)); //Move null-terminating char as well
donatien 0:3b2f052c333b 526 m_inputPos = m_inputPos - (crPos + 1); //Adjust m_inputPos
donatien 0:3b2f052c333b 527 }
donatien 0:3b2f052c333b 528 lineDetected = false; //In both case search now for a new line
donatien 0:3b2f052c333b 529 }
donatien 0:3b2f052c333b 530 }
donatien 0:3b2f052c333b 531 else if(greaterThanPtr != NULL)
donatien 0:3b2f052c333b 532 {
donatien 0:3b2f052c333b 533 DBG("> char found");
donatien 0:3b2f052c333b 534 int gdPos = greaterThanPtr - m_inputBuf;
donatien 0:3b2f052c333b 535 //To determine the sequence we need at least 2 chars
donatien 0:3b2f052c333b 536 if(m_inputPos - gdPos >= 2)
donatien 0:3b2f052c333b 537 {
donatien 0:3b2f052c333b 538 //Look for a space char next to the GD char
donatien 0:3b2f052c333b 539 if(m_inputBuf[gdPos + 1] == ' ')
donatien 0:3b2f052c333b 540 {
donatien 0:3b2f052c333b 541 //This is an entry prompt
donatien 0:3b2f052c333b 542 //Replace m_inputBuf[gdPos] with null-terminating char
donatien 0:3b2f052c333b 543 m_inputBuf[gdPos] = '\0';
donatien 0:3b2f052c333b 544
donatien 0:3b2f052c333b 545 //Shift remaining data to beginning of buffer
donatien 0:3b2f052c333b 546 memmove(m_inputBuf, m_inputBuf + gdPos + 1, (m_inputPos + 1) - (gdPos + 1)); //Move null-terminating char as well
donatien 0:3b2f052c333b 547 m_inputPos = m_inputPos - (gdPos + 1); //Adjust m_inputPos
donatien 0:3b2f052c333b 548
donatien 0:3b2f052c333b 549 //Process prompt
donatien 0:3b2f052c333b 550 ret = processEntryPrompt();
donatien 0:3b2f052c333b 551 if(ret)
donatien 0:3b2f052c333b 552 {
donatien 0:3b2f052c333b 553 m_inputPos = 0;
donatien 51:54ca82a7644c 554 m_inputBuf[0] = '\0'; //Always have a null-terminating char at start of buffer
donatien 0:3b2f052c333b 555 lineDetected = false;
donatien 0:3b2f052c333b 556 return ret;
donatien 0:3b2f052c333b 557 }
donatien 0:3b2f052c333b 558
donatien 0:3b2f052c333b 559 DBG("One line was successfully processed");
donatien 0:3b2f052c333b 560 lineProcessed = true; //Line was processed with success
donatien 0:3b2f052c333b 561 }
donatien 0:3b2f052c333b 562 else
donatien 0:3b2f052c333b 563 {
donatien 0:3b2f052c333b 564 //This is completely unexpected, discard all chars till the GD char to try to recover good state
donatien 0:3b2f052c333b 565 WARN("Unexpected %c char (%02d code) found in incoming line", m_inputBuf[gdPos + 1]);
donatien 0:3b2f052c333b 566 memmove(m_inputBuf, m_inputBuf + gdPos + 1, (m_inputPos + 1) - (gdPos + 1)); //Move null-terminating char as well
donatien 0:3b2f052c333b 567 m_inputPos = m_inputPos - (gdPos + 1); //Adjust m_inputPos
donatien 0:3b2f052c333b 568 }
donatien 0:3b2f052c333b 569 lineDetected = false; //In both case search now for a new line
donatien 0:3b2f052c333b 570 }
donatien 0:3b2f052c333b 571 }
donatien 0:3b2f052c333b 572 }
donatien 0:3b2f052c333b 573 } while(lineProcessed); //If one complete line was processed there might be other incoming lines that can also be processed without reading the buffer again
donatien 0:3b2f052c333b 574
donatien 0:3b2f052c333b 575 //If the line could not be processed AND buffer is full, it means that we won't ever be able to process it (buffer too short)
donatien 0:3b2f052c333b 576 if(m_inputPos == AT_INPUT_BUF_SIZE - 1)
donatien 0:3b2f052c333b 577 {
donatien 0:3b2f052c333b 578 //Discard everything
donatien 0:3b2f052c333b 579 m_inputPos = 0;
donatien 51:54ca82a7644c 580 m_inputBuf[0] = '\0'; //Always have a null-terminating char at start of buffer
donatien 0:3b2f052c333b 581 WARN("Incoming buffer is too short to process incoming line");
donatien 0:3b2f052c333b 582 //Look for a new line
donatien 0:3b2f052c333b 583 lineDetected = false;
donatien 0:3b2f052c333b 584 }
donatien 0:3b2f052c333b 585
donatien 0:3b2f052c333b 586 DBG("Processed every full incoming lines");
donatien 0:3b2f052c333b 587
donatien 0:3b2f052c333b 588 return OK;
donatien 0:3b2f052c333b 589 }
donatien 0:3b2f052c333b 590
donatien 0:3b2f052c333b 591 int ATCommandsInterface::trySendCommand()
donatien 0:3b2f052c333b 592 {
donatien 0:3b2f052c333b 593 osEvent evt = m_env2AT.get(0);
donatien 0:3b2f052c333b 594 DBG("status = %d, msg = %d", evt.status, evt.value.p);
donatien 0:3b2f052c333b 595 if(evt.status == osEventMail)
donatien 0:3b2f052c333b 596 {
donatien 0:3b2f052c333b 597 int* msg = (int*) evt.value.p;
donatien 0:3b2f052c333b 598 if( *msg == AT_CMD_READY ) //Command pending
donatien 0:3b2f052c333b 599 {
donatien 0:3b2f052c333b 600 if(m_transactionState != IDLE)
donatien 0:3b2f052c333b 601 {
donatien 0:3b2f052c333b 602 WARN("Previous command not processed!");
donatien 0:3b2f052c333b 603 }
ashleymills 83:897a0de9d668 604 DBG("Sending pending command %s (%d)",m_transactionCommand,strlen(m_transactionCommand));
donatien 0:3b2f052c333b 605 m_pStream->write((uint8_t*)m_transactionCommand, strlen(m_transactionCommand), osWaitForever);
donatien 0:3b2f052c333b 606 char cr = CR;
donatien 0:3b2f052c333b 607 m_pStream->write((uint8_t*)&cr, 1, osWaitForever); //Carriage return line terminator
donatien 0:3b2f052c333b 608 m_transactionState = COMMAND_SENT;
donatien 0:3b2f052c333b 609 }
donatien 61:0bcb8c5216d4 610 else //Timeout
donatien 0:3b2f052c333b 611 {
ashleymills 83:897a0de9d668 612 DBG("Timeout message received");
donatien 61:0bcb8c5216d4 613 //Acknowledge
donatien 61:0bcb8c5216d4 614 int* msg = m_AT2Env.alloc(osWaitForever);
donatien 61:0bcb8c5216d4 615 *msg = AT_TIMEOUT;
donatien 61:0bcb8c5216d4 616 m_AT2Env.put(msg); //Command has timed out
donatien 0:3b2f052c333b 617 m_transactionState = IDLE; //State-machine reset
donatien 0:3b2f052c333b 618 }
donatien 0:3b2f052c333b 619 m_env2AT.free(msg);
donatien 0:3b2f052c333b 620 }
donatien 0:3b2f052c333b 621 return OK;
donatien 0:3b2f052c333b 622 }
donatien 0:3b2f052c333b 623
donatien 0:3b2f052c333b 624 int ATCommandsInterface::processReadLine()
donatien 0:3b2f052c333b 625 {
donatien 0:3b2f052c333b 626 DBG("Processing read line [%s]", m_inputBuf);
donatien 0:3b2f052c333b 627 //The line is stored in m_inputBuf
donatien 0:3b2f052c333b 628 if(m_transactionState == COMMAND_SENT)
donatien 0:3b2f052c333b 629 {
donatien 0:3b2f052c333b 630 //If the command has been sent, checks echo to see if it has been received properly
donatien 0:3b2f052c333b 631 if( strcmp(m_transactionCommand, m_inputBuf) == 0 )
donatien 0:3b2f052c333b 632 {
donatien 0:3b2f052c333b 633 DBG("Command echo received");
donatien 0:3b2f052c333b 634 //If so, it means that the following lines will only be solicited results
donatien 0:3b2f052c333b 635 m_transactionState = READING_RESULT;
donatien 0:3b2f052c333b 636 return OK;
donatien 0:3b2f052c333b 637 }
donatien 0:3b2f052c333b 638 }
donatien 0:3b2f052c333b 639 if(m_transactionState == IDLE || m_transactionState == COMMAND_SENT)
donatien 0:3b2f052c333b 640 {
donatien 0:3b2f052c333b 641 bool found = false;
donatien 0:3b2f052c333b 642 char* pSemicol = strchr(m_inputBuf, ':');
donatien 0:3b2f052c333b 643 char* pData = NULL;
donatien 0:3b2f052c333b 644 if( pSemicol != NULL ) //Split the identifier & the result code (if it exists)
donatien 0:3b2f052c333b 645 {
donatien 0:3b2f052c333b 646 *pSemicol = '\0';
donatien 0:3b2f052c333b 647 pData = pSemicol + 1;
donatien 0:3b2f052c333b 648 if(pData[0]==' ')
donatien 0:3b2f052c333b 649 {
donatien 0:3b2f052c333b 650 pData++; //Suppress whitespace
donatien 0:3b2f052c333b 651 }
donatien 0:3b2f052c333b 652 }
donatien 0:3b2f052c333b 653 //Looks for a unsolicited result code; we can have m_transactionState == COMMAND_SENT as the code may have arrived just before we sent the command
donatien 59:593fb493172f 654 m_eventsProcessingMtx.lock();
donatien 0:3b2f052c333b 655 //Go through the list
donatien 0:3b2f052c333b 656 for(int i = 0; i < MAX_AT_EVENTS_HANDLERS; i++) //Find a free slot
donatien 0:3b2f052c333b 657 {
donatien 0:3b2f052c333b 658 if( m_eventsHandlers[i] != NULL )
donatien 0:3b2f052c333b 659 {
donatien 0:3b2f052c333b 660 if( m_eventsHandlers[i]->isATCodeHandled(m_inputBuf) )
donatien 0:3b2f052c333b 661 {
donatien 0:3b2f052c333b 662 m_eventsHandlers[i]->onEvent(m_inputBuf, pData);
donatien 0:3b2f052c333b 663 found = true; //Do not break here as there might be multiple handlers for one event type
donatien 0:3b2f052c333b 664 }
donatien 0:3b2f052c333b 665 }
donatien 0:3b2f052c333b 666 }
donatien 59:593fb493172f 667 m_eventsProcessingMtx.unlock();
donatien 0:3b2f052c333b 668 if(found)
donatien 0:3b2f052c333b 669 {
donatien 0:3b2f052c333b 670 return OK;
donatien 0:3b2f052c333b 671 }
donatien 0:3b2f052c333b 672 }
donatien 0:3b2f052c333b 673 if(m_transactionState == READING_RESULT)
donatien 0:3b2f052c333b 674 {
donatien 0:3b2f052c333b 675 //The following lines can either be a command response or a result code (OK / ERROR / CONNECT / +CME ERROR: %s / +CMS ERROR: %s)
donatien 0:3b2f052c333b 676 if(strcmp("OK", m_inputBuf) == 0)
donatien 0:3b2f052c333b 677 {
donatien 0:3b2f052c333b 678 DBG("OK result received");
donatien 0:3b2f052c333b 679 m_transactionResult.code = 0;
donatien 0:3b2f052c333b 680 m_transactionResult.result = ATResult::AT_OK;
donatien 0:3b2f052c333b 681 m_transactionState = IDLE;
donatien 0:3b2f052c333b 682 int* msg = m_AT2Env.alloc(osWaitForever);
donatien 0:3b2f052c333b 683 *msg = AT_RESULT_READY;
donatien 0:3b2f052c333b 684 m_AT2Env.put(msg); //Command has been processed
donatien 0:3b2f052c333b 685 return OK;
donatien 0:3b2f052c333b 686 }
donatien 0:3b2f052c333b 687 else if(strcmp("ERROR", m_inputBuf) == 0)
donatien 0:3b2f052c333b 688 {
donatien 0:3b2f052c333b 689 DBG("ERROR result received");
donatien 0:3b2f052c333b 690 m_transactionResult.code = 0;
donatien 0:3b2f052c333b 691 m_transactionResult.result = ATResult::AT_ERROR;
donatien 0:3b2f052c333b 692 m_transactionState = IDLE;
donatien 0:3b2f052c333b 693 int* msg = m_AT2Env.alloc(osWaitForever);
donatien 0:3b2f052c333b 694 *msg = AT_RESULT_READY;
donatien 0:3b2f052c333b 695 m_AT2Env.put(msg); //Command has been processed
donatien 0:3b2f052c333b 696 return OK;
donatien 0:3b2f052c333b 697 }
donatien 0:3b2f052c333b 698 else if(strncmp("CONNECT", m_inputBuf, 7 /*=strlen("CONNECT")*/) == 0) //Result can be "CONNECT" or "CONNECT %d", indicating baudrate
donatien 0:3b2f052c333b 699 {
donatien 0:3b2f052c333b 700 DBG("CONNECT result received");
donatien 0:3b2f052c333b 701 m_transactionResult.code = 0;
donatien 0:3b2f052c333b 702 m_transactionResult.result = ATResult::AT_CONNECT;
donatien 0:3b2f052c333b 703 m_transactionState = IDLE;
donatien 0:3b2f052c333b 704 int* msg = m_AT2Env.alloc(osWaitForever);
donatien 0:3b2f052c333b 705 *msg = AT_RESULT_READY;
donatien 0:3b2f052c333b 706 m_AT2Env.put(msg); //Command has been processed
donatien 0:3b2f052c333b 707 return OK;
donatien 0:3b2f052c333b 708 }
donatien 0:3b2f052c333b 709 else if(strcmp("COMMAND NOT SUPPORT", m_inputBuf) == 0) //Huawei-specific, not normalized
donatien 0:3b2f052c333b 710 {
donatien 0:3b2f052c333b 711 DBG("COMMAND NOT SUPPORT result received");
donatien 0:3b2f052c333b 712 m_transactionResult.code = 0;
donatien 0:3b2f052c333b 713 m_transactionResult.result = ATResult::AT_ERROR;
donatien 0:3b2f052c333b 714 m_transactionState = IDLE;
donatien 0:3b2f052c333b 715 int* msg = m_AT2Env.alloc(osWaitForever);
donatien 0:3b2f052c333b 716 *msg = AT_RESULT_READY;
donatien 0:3b2f052c333b 717 m_AT2Env.put(msg); //Command has been processed
donatien 0:3b2f052c333b 718 return OK;
donatien 0:3b2f052c333b 719 }
donatien 0:3b2f052c333b 720 else if(strstr(m_inputBuf, "+CME ERROR:") == m_inputBuf) //Mobile Equipment Error
donatien 0:3b2f052c333b 721 {
donatien 0:3b2f052c333b 722 std::sscanf(m_inputBuf + 12 /* =strlen("+CME ERROR: ") */, "%d", &m_transactionResult.code);
donatien 0:3b2f052c333b 723 DBG("+CME ERROR: %d result received", m_transactionResult.code);
donatien 0:3b2f052c333b 724 m_transactionResult.result = ATResult::AT_CME_ERROR;
donatien 0:3b2f052c333b 725 m_transactionState = IDLE;
donatien 0:3b2f052c333b 726 int* msg = m_AT2Env.alloc(osWaitForever);
donatien 0:3b2f052c333b 727 *msg = AT_RESULT_READY;
donatien 0:3b2f052c333b 728 m_AT2Env.put(msg); //Command has been processed
donatien 0:3b2f052c333b 729 return OK;
donatien 0:3b2f052c333b 730 }
donatien 0:3b2f052c333b 731 else if(strstr(m_inputBuf, "+CMS ERROR:") == m_inputBuf) //SIM Error
donatien 0:3b2f052c333b 732 {
donatien 0:3b2f052c333b 733 std::sscanf(m_inputBuf + 13 /* =strlen("+CME ERROR: ") */, "%d", &m_transactionResult.code);
donatien 0:3b2f052c333b 734 DBG("+CMS ERROR: %d result received", m_transactionResult.code);
donatien 0:3b2f052c333b 735 m_transactionResult.result = ATResult::AT_CMS_ERROR;
donatien 0:3b2f052c333b 736 m_transactionState = IDLE;
donatien 0:3b2f052c333b 737 int* msg = m_AT2Env.alloc(osWaitForever);
donatien 0:3b2f052c333b 738 *msg = AT_RESULT_READY;
donatien 0:3b2f052c333b 739 m_AT2Env.put(msg); //Command has been processed
donatien 0:3b2f052c333b 740 return OK;
donatien 0:3b2f052c333b 741 }
donatien 0:3b2f052c333b 742 else
donatien 0:3b2f052c333b 743 {
donatien 0:3b2f052c333b 744 DBG("Unprocessed result received: '%s'", m_inputBuf);
donatien 0:3b2f052c333b 745 //Must call transaction processor to complete line processing
donatien 0:3b2f052c333b 746 int ret = m_pTransactionProcessor->onNewATResponseLine(this, m_inputBuf); //Here sendData can be called
donatien 0:3b2f052c333b 747 return ret;
donatien 0:3b2f052c333b 748 }
donatien 0:3b2f052c333b 749 }
donatien 0:3b2f052c333b 750
donatien 0:3b2f052c333b 751 return OK;
donatien 0:3b2f052c333b 752 }
donatien 0:3b2f052c333b 753
donatien 0:3b2f052c333b 754 int ATCommandsInterface::processEntryPrompt()
donatien 0:3b2f052c333b 755 {
donatien 0:3b2f052c333b 756 DBG("Calling prompt handler");
donatien 0:3b2f052c333b 757 int ret = m_pTransactionProcessor->onNewEntryPrompt(this); //Here sendData can be called
donatien 0:3b2f052c333b 758
donatien 0:3b2f052c333b 759 if( ret != NET_MOREINFO ) //A new prompt is expected
donatien 0:3b2f052c333b 760 {
donatien 0:3b2f052c333b 761 DBG("Sending break character");
donatien 0:3b2f052c333b 762 //Send CTRL+Z (break sequence) to exit prompt
donatien 0:3b2f052c333b 763 char seq[2] = {BRK, 0x00};
donatien 0:3b2f052c333b 764 sendData(seq);
donatien 0:3b2f052c333b 765 }
donatien 0:3b2f052c333b 766 return OK;
donatien 0:3b2f052c333b 767 }
donatien 0:3b2f052c333b 768
donatien 59:593fb493172f 769 //This will be called on initialization & after the execution of a command
donatien 59:593fb493172f 770 void ATCommandsInterface::enableEvents()
donatien 59:593fb493172f 771 {
ashleymills 83:897a0de9d668 772 DBG("Trying to enable events");
donatien 59:593fb493172f 773 //Advertize this to events handlers
donatien 59:593fb493172f 774 m_eventsMgmtMtx.lock();
donatien 59:593fb493172f 775 for(int i = 0; i < MAX_AT_EVENTS_HANDLERS; i++) //Find a free slot
donatien 59:593fb493172f 776 {
donatien 59:593fb493172f 777 if( m_eventsHandlers[i] != NULL )
donatien 59:593fb493172f 778 {
donatien 59:593fb493172f 779 m_eventsHandlers[i]->onDispatchStart();
donatien 59:593fb493172f 780 //Enable this kind of events
donatien 59:593fb493172f 781 if(m_eventsHandlers[i]->getEventsEnableCommand() != NULL)
donatien 59:593fb493172f 782 {
ashleymills 83:897a0de9d668 783 DBG("Enabling events for handler %d",i);
donatien 59:593fb493172f 784 int ret = executeInternal(m_eventsHandlers[i]->getEventsEnableCommand(), this, NULL); //Execute enable command
donatien 59:593fb493172f 785 if(ret)
donatien 59:593fb493172f 786 {
ashleymills 83:897a0de9d668 787 WARN("Events enabling command failed: %d",ret);
ashleymills 83:897a0de9d668 788 } else {
ashleymills 83:897a0de9d668 789 DBG("Enabled events");
donatien 59:593fb493172f 790 }
donatien 59:593fb493172f 791 }
donatien 59:593fb493172f 792 }
donatien 59:593fb493172f 793 }
donatien 59:593fb493172f 794 m_eventsMgmtMtx.unlock();
donatien 59:593fb493172f 795 }
donatien 59:593fb493172f 796
donatien 59:593fb493172f 797 //This will be called on de-initialization & before the execution of a command to prevent unsollicited result codes from polluting the results
donatien 59:593fb493172f 798 void ATCommandsInterface::disableEvents()
donatien 59:593fb493172f 799 {
donatien 59:593fb493172f 800 //Advertize this to events handlers
donatien 59:593fb493172f 801 m_eventsMgmtMtx.lock();
donatien 59:593fb493172f 802 for(int i = 0; i < MAX_AT_EVENTS_HANDLERS; i++) //Find a free slot
donatien 59:593fb493172f 803 {
donatien 59:593fb493172f 804 if( m_eventsHandlers[i] != NULL )
donatien 59:593fb493172f 805 {
donatien 59:593fb493172f 806 m_eventsHandlers[i]->onDispatchStart();
donatien 59:593fb493172f 807 //Disable this kind of events
donatien 59:593fb493172f 808 if(m_eventsHandlers[i]->getEventsDisableCommand() != NULL)
donatien 59:593fb493172f 809 {
donatien 59:593fb493172f 810 int ret = executeInternal(m_eventsHandlers[i]->getEventsDisableCommand(), this, NULL); //Execute disable command
donatien 59:593fb493172f 811 if(ret)
donatien 59:593fb493172f 812 {
donatien 59:593fb493172f 813 WARN("Events disabling command failed");
donatien 59:593fb493172f 814 }
donatien 59:593fb493172f 815 }
donatien 59:593fb493172f 816 }
donatien 59:593fb493172f 817 }
donatien 59:593fb493172f 818 m_eventsMgmtMtx.unlock();
donatien 59:593fb493172f 819 }
donatien 59:593fb493172f 820
donatien 0:3b2f052c333b 821 //Commands that can be called during onNewATResponseLine callback, additionally to close()
donatien 0:3b2f052c333b 822 //Access to this method is protected (can ONLY be called on processing thread during IATCommandsProcessor::onNewATResponseLine execution)
donatien 0:3b2f052c333b 823 int ATCommandsInterface::sendData(const char* data)
donatien 0:3b2f052c333b 824 {
donatien 0:3b2f052c333b 825 //m_inputBuf is cleared at this point (and MUST therefore be empty)
donatien 0:3b2f052c333b 826 int dataLen = strlen(data);
donatien 0:3b2f052c333b 827 DBG("Sending raw string of length %d", dataLen);
donatien 0:3b2f052c333b 828 int ret = m_pStream->write((uint8_t*)data, dataLen, osWaitForever);
donatien 0:3b2f052c333b 829 if(ret)
donatien 0:3b2f052c333b 830 {
donatien 0:3b2f052c333b 831 WARN("Could not write to stream (returned %d)", ret);
donatien 0:3b2f052c333b 832 return ret;
donatien 0:3b2f052c333b 833 }
donatien 0:3b2f052c333b 834
donatien 0:3b2f052c333b 835 int dataPos = 0;
donatien 0:3b2f052c333b 836 do
donatien 0:3b2f052c333b 837 {
donatien 0:3b2f052c333b 838 //Read echo
donatien 0:3b2f052c333b 839 size_t readLen;
donatien 0:3b2f052c333b 840 int ret = m_pStream->read((uint8_t*)m_inputBuf, &readLen, MIN(dataLen - dataPos, AT_INPUT_BUF_SIZE - 1), osWaitForever); //Make sure we do not read more than needed otherwise it could break the parser
donatien 0:3b2f052c333b 841 if(ret)
donatien 0:3b2f052c333b 842 {
donatien 0:3b2f052c333b 843 WARN("Could not read from stream (returned %d)", ret);
donatien 51:54ca82a7644c 844 m_inputPos = 0; //Reset input buffer state
donatien 51:54ca82a7644c 845 m_inputBuf[0] = '\0'; //Always have a null-terminating char at start of buffer
donatien 0:3b2f052c333b 846 return ret;
donatien 51:54ca82a7644c 847 }
donatien 0:3b2f052c333b 848
donatien 0:3b2f052c333b 849 if( memcmp(m_inputBuf, data + dataPos, readLen) != 0 )
donatien 0:3b2f052c333b 850 {
donatien 0:3b2f052c333b 851 //Echo does not match output
donatien 59:593fb493172f 852 m_inputBuf[readLen] = '\0';
donatien 59:593fb493172f 853 WARN("Echo does not match output, got '%s' instead", m_inputBuf);
donatien 51:54ca82a7644c 854 m_inputPos = 0; //Reset input buffer state
donatien 51:54ca82a7644c 855 m_inputBuf[0] = '\0'; //Always have a null-terminating char at start of buffer
donatien 0:3b2f052c333b 856 return NET_DIFF;
donatien 0:3b2f052c333b 857 }
donatien 0:3b2f052c333b 858
donatien 0:3b2f052c333b 859 dataPos += readLen;
donatien 0:3b2f052c333b 860 //If all characters have not been read yet
donatien 0:3b2f052c333b 861
donatien 0:3b2f052c333b 862 } while(dataPos < dataLen);
donatien 0:3b2f052c333b 863
donatien 0:3b2f052c333b 864 DBG("String sent successfully");
donatien 0:3b2f052c333b 865
donatien 0:3b2f052c333b 866 m_inputPos = 0; //Reset input buffer state
donatien 51:54ca82a7644c 867 m_inputBuf[0] = '\0'; //Always have a null-terminating char at start of buffer
donatien 0:3b2f052c333b 868
donatien 0:3b2f052c333b 869 return OK;
donatien 0:3b2f052c333b 870 }
donatien 0:3b2f052c333b 871
donatien 0:3b2f052c333b 872 /*static*/ void ATCommandsInterface::staticCallback(void const* p)
donatien 0:3b2f052c333b 873 {
donatien 0:3b2f052c333b 874 ((ATCommandsInterface*)p)->process();
donatien 0:3b2f052c333b 875 }
donatien 0:3b2f052c333b 876
donatien 0:3b2f052c333b 877 int ATCommandsInterface::ATResultToReturnCode(ATResult result) //Helper
donatien 0:3b2f052c333b 878 {
donatien 0:3b2f052c333b 879 if(result.result == ATResult::AT_OK)
donatien 0:3b2f052c333b 880 {
donatien 0:3b2f052c333b 881 return OK;
donatien 0:3b2f052c333b 882 }
donatien 0:3b2f052c333b 883 else
donatien 0:3b2f052c333b 884 {
donatien 0:3b2f052c333b 885 return NET_MOREINFO;
donatien 0:3b2f052c333b 886 }
donatien 0:3b2f052c333b 887 }
donatien 0:3b2f052c333b 888
donatien 0:3b2f052c333b 889 /*virtual*/ int ATCommandsInterface::onNewATResponseLine(ATCommandsInterface* pInst, const char* line) //Default implementation for simple commands handling
donatien 0:3b2f052c333b 890 {
donatien 0:3b2f052c333b 891 return OK;
donatien 0:3b2f052c333b 892 }
donatien 0:3b2f052c333b 893
donatien 0:3b2f052c333b 894 /*virtual*/ int ATCommandsInterface::onNewEntryPrompt(ATCommandsInterface* pInst) //Default implementation (just sends Ctrl+Z to exit the prompt by returning OK right-away)
donatien 0:3b2f052c333b 895 {
donatien 0:3b2f052c333b 896 return OK;
donatien 0:3b2f052c333b 897 }
donatien 0:3b2f052c333b 898
ashleymills 79:a6ac8206a58d 899 void ATCommandsInterface::pause() {
ashleymills 79:a6ac8206a58d 900 DBG("pausing at commands interface");
ashleymills 79:a6ac8206a58d 901 m_pStream->abortRead();
ashleymills 79:a6ac8206a58d 902 m_processingThread.signal_set(AT_SIG_PROCESSING_STOP);
ashleymills 79:a6ac8206a58d 903 }
ashleymills 79:a6ac8206a58d 904
ashleymills 79:a6ac8206a58d 905 void ATCommandsInterface::restart() {
ashleymills 79:a6ac8206a58d 906 DBG("restarting AT commands interface");
ashleymills 79:a6ac8206a58d 907 m_processingThread.signal_set(AT_SIG_PROCESSING_START);
ashleymills 79:a6ac8206a58d 908 }
ashleymills 79:a6ac8206a58d 909
donatien 0:3b2f052c333b 910 void ATCommandsInterface::process() //Processing thread
donatien 0:3b2f052c333b 911 {
donatien 0:3b2f052c333b 912 DBG("AT Thread started");
donatien 0:3b2f052c333b 913 while(true)
donatien 0:3b2f052c333b 914 {
donatien 0:3b2f052c333b 915 DBG("AT Processing on hold");
donatien 0:3b2f052c333b 916 m_processingThread.signal_wait(AT_SIG_PROCESSING_START); //Block until the process is started
donatien 0:3b2f052c333b 917
donatien 0:3b2f052c333b 918 m_processingMtx.lock();
donatien 0:3b2f052c333b 919 DBG("AT Processing started");
donatien 0:3b2f052c333b 920 //First of all discard buffer
donatien 0:3b2f052c333b 921 int ret;
donatien 0:3b2f052c333b 922 size_t readLen;
donatien 0:3b2f052c333b 923 do //Drop everything
donatien 0:3b2f052c333b 924 {
donatien 0:3b2f052c333b 925 ret = m_pStream->read((uint8_t*)m_inputBuf, &readLen, AT_INPUT_BUF_SIZE - 1, 0); //Do NOT wait at this point
donatien 0:3b2f052c333b 926 } while(ret == OK);
donatien 0:3b2f052c333b 927 m_inputPos = 0; //Clear input buffer
donatien 0:3b2f052c333b 928 do
donatien 0:3b2f052c333b 929 {
donatien 59:593fb493172f 930 DBG("Trying to send a pending command");
donatien 59:593fb493172f 931 trySendCommand(); //This must be tried first as we discarded the buffer before and therefore would be blocking though there is a pending command
donatien 0:3b2f052c333b 932 DBG("Trying to read a new line");
donatien 0:3b2f052c333b 933 tryReadLine();
donatien 0:3b2f052c333b 934 } while( m_processingThread.signal_wait(AT_SIG_PROCESSING_STOP, 0).status != osEventSignal ); //Loop until the process is interrupted
donatien 0:3b2f052c333b 935 m_processingMtx.unlock();
donatien 0:3b2f052c333b 936 DBG("AT Processing stopped");
donatien 0:3b2f052c333b 937 }
donatien 0:3b2f052c333b 938 }
donatien 0:3b2f052c333b 939