Ashley Mills / VodafoneUSBModem_bleedingedge2

local fork

Dependencies:   Socket USBHostWANDongle_bleedingedge lwip-sys lwip

Dependents:   Encrypted

Fork of VodafoneUSBModem_bleedingedge by Donatien Garnier

at/ATCommandsInterface.h@41:8bec5a8ea878, 2012-09-21 (annotated)

Committer:
ashleymills
Date:
Fri Sep 21 11:10:32 2012 +0000
Revision:
41:8bec5a8ea878
Parent:
22:06fb2a93a1f6
Child:
50:8ad4cb12749d
Added some descriptive comments to the code.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:3b2f052c333b 1 /* ATCommandsInterface.h */
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
donatien 0:3b2f052c333b 20 #ifndef ATCOMMANDSINTERFACE_H_
donatien 0:3b2f052c333b 21 #define ATCOMMANDSINTERFACE_H_
donatien 0:3b2f052c333b 22
donatien 0:3b2f052c333b 23 #include "core/fwk.h"
donatien 0:3b2f052c333b 24 #include "rtos.h"
donatien 0:3b2f052c333b 25
donatien 16:02db4f537955 26 #define MAX_AT_EVENTS_HANDLERS 4
donatien 0:3b2f052c333b 27
donatien 0:3b2f052c333b 28 class ATCommandsInterface;
donatien 0:3b2f052c333b 29
donatien 0:3b2f052c333b 30 /** Interface implemented by components handling AT events
donatien 0:3b2f052c333b 31 *
donatien 0:3b2f052c333b 32 */
donatien 0:3b2f052c333b 33 class IATEventsHandler
donatien 0:3b2f052c333b 34 {
donatien 0:3b2f052c333b 35 protected:
donatien 0:3b2f052c333b 36 virtual bool isATCodeHandled(const char* atCode) = 0; //Is this AT code handled
donatien 0:3b2f052c333b 37 virtual void onDispatchStart() = 0;
donatien 0:3b2f052c333b 38 virtual void onDispatchStop() = 0;
donatien 0:3b2f052c333b 39 virtual void onEvent(const char* atCode, const char* evt) = 0;
donatien 0:3b2f052c333b 40 friend class ATCommandsInterface;
donatien 0:3b2f052c333b 41 };
donatien 0:3b2f052c333b 42
donatien 0:3b2f052c333b 43 /** Interface implemented by components executing complex AT commands
donatien 0:3b2f052c333b 44 *
donatien 0:3b2f052c333b 45 */
donatien 0:3b2f052c333b 46 class IATCommandsProcessor
donatien 0:3b2f052c333b 47 {
donatien 0:3b2f052c333b 48 protected:
donatien 0:3b2f052c333b 49 virtual int onNewATResponseLine(ATCommandsInterface* pInst, const char* line) = 0;
donatien 0:3b2f052c333b 50 virtual int onNewEntryPrompt(ATCommandsInterface* pInst) = 0;
donatien 0:3b2f052c333b 51 friend class ATCommandsInterface;
donatien 0:3b2f052c333b 52 };
donatien 0:3b2f052c333b 53
donatien 0:3b2f052c333b 54 #define AT_INPUT_BUF_SIZE 64
donatien 0:3b2f052c333b 55
donatien 0:3b2f052c333b 56 //Signals to be sent to the processing thread
donatien 0:3b2f052c333b 57 #define AT_SIG_PROCESSING_START 1
donatien 0:3b2f052c333b 58 #define AT_SIG_PROCESSING_STOP 2
donatien 0:3b2f052c333b 59 //Messages to be sent to the processing thread
donatien 0:3b2f052c333b 60 #define AT_CMD_READY 1
donatien 0:3b2f052c333b 61 #define AT_TIMEOUT 2
donatien 0:3b2f052c333b 62 #define AT_STOP 3
donatien 0:3b2f052c333b 63 //Messages to be sent from the processing thread
donatien 0:3b2f052c333b 64 #define AT_RESULT_READY 1
donatien 0:3b2f052c333b 65
donatien 0:3b2f052c333b 66 /** AT Commands interface class
donatien 0:3b2f052c333b 67 *
donatien 0:3b2f052c333b 68 */
donatien 0:3b2f052c333b 69 class ATCommandsInterface : protected IATCommandsProcessor
donatien 0:3b2f052c333b 70 {
donatien 0:3b2f052c333b 71 public:
donatien 0:3b2f052c333b 72 ATCommandsInterface(IOStream* pStream);
donatien 0:3b2f052c333b 73
donatien 0:3b2f052c333b 74 //Open connection to AT Interface in order to execute command & register/unregister events
donatien 0:3b2f052c333b 75 int open();
donatien 0:3b2f052c333b 76
donatien 0:3b2f052c333b 77 //Initialize AT link
donatien 0:3b2f052c333b 78 int init();
donatien 0:3b2f052c333b 79
donatien 0:3b2f052c333b 80 //Close connection
donatien 0:3b2f052c333b 81 int close();
donatien 0:3b2f052c333b 82
donatien 0:3b2f052c333b 83 bool isOpen();
donatien 0:3b2f052c333b 84
donatien 0:3b2f052c333b 85 class ATResult
donatien 0:3b2f052c333b 86 {
donatien 0:3b2f052c333b 87 public:
donatien 0:3b2f052c333b 88 enum { AT_OK, AT_ERROR, AT_CONNECT, AT_CMS_ERROR, AT_CME_ERROR } result;
donatien 0:3b2f052c333b 89 int code;
donatien 0:3b2f052c333b 90 };
donatien 0:3b2f052c333b 91
donatien 0:3b2f052c333b 92 int executeSimple(const char* command, ATResult* pResult, uint32_t timeout=1000);
donatien 0:3b2f052c333b 93 int execute(const char* command, IATCommandsProcessor* pProcessor, ATResult* pResult, uint32_t timeout=1000);
donatien 0:3b2f052c333b 94 int registerEventsHandler(IATEventsHandler* pHdlr);
donatien 0:3b2f052c333b 95 int deregisterEventsHandler(IATEventsHandler* pHdlr);
donatien 0:3b2f052c333b 96
donatien 0:3b2f052c333b 97 //Commands that can be called during onNewATResponseLine callback, additionally to close()
donatien 0:3b2f052c333b 98 //Access to this method is protected (can ONLY be called on processing thread during IATCommandsProcessor::onNewATResponseLine execution)
donatien 0:3b2f052c333b 99 int sendData(const char* data);
donatien 0:3b2f052c333b 100
donatien 0:3b2f052c333b 101 static void staticCallback(void const* p);
donatien 0:3b2f052c333b 102 private:
donatien 0:3b2f052c333b 103 int tryReadLine();
donatien 0:3b2f052c333b 104 int trySendCommand();
donatien 0:3b2f052c333b 105 int processReadLine();
donatien 0:3b2f052c333b 106 int processEntryPrompt();
donatien 0:3b2f052c333b 107
donatien 0:3b2f052c333b 108 int ATResultToReturnCode(ATResult result); //Helper
donatien 0:3b2f052c333b 109
donatien 0:3b2f052c333b 110 virtual int onNewATResponseLine(ATCommandsInterface* pInst, const char* line); //Default implementation for simple commands handling
donatien 0:3b2f052c333b 111 virtual int onNewEntryPrompt(ATCommandsInterface* pInst); //Default implementation (just sends Ctrl+Z to exit the prompt)
donatien 0:3b2f052c333b 112
donatien 0:3b2f052c333b 113 void process(); //Processing thread
donatien 0:3b2f052c333b 114
donatien 0:3b2f052c333b 115 IOStream* m_pStream;
ashleymills 41:8bec5a8ea878 116
ashleymills 41:8bec5a8ea878 117 bool m_open; //< TRUE when the AT interface is open, and FALSE when it is not.
donatien 0:3b2f052c333b 118
donatien 0:3b2f052c333b 119 const char* m_transactionCommand;
donatien 0:3b2f052c333b 120 const char* m_transactionData;
donatien 0:3b2f052c333b 121
donatien 0:3b2f052c333b 122 IATCommandsProcessor* m_pTransactionProcessor;
donatien 0:3b2f052c333b 123 ATResult m_transactionResult;
donatien 0:3b2f052c333b 124
donatien 0:3b2f052c333b 125 enum { IDLE, COMMAND_SENT, READING_RESULT, ABORTED } m_transactionState;
donatien 0:3b2f052c333b 126
donatien 0:3b2f052c333b 127 char m_inputBuf[AT_INPUT_BUF_SIZE];
donatien 0:3b2f052c333b 128 int m_inputPos;
donatien 0:3b2f052c333b 129
donatien 0:3b2f052c333b 130 Mutex m_transactionMtx;
donatien 0:3b2f052c333b 131
donatien 0:3b2f052c333b 132 Mail<int,1> m_env2AT;
donatien 0:3b2f052c333b 133 Mail<int,1> m_AT2Env;
donatien 0:3b2f052c333b 134
donatien 0:3b2f052c333b 135 IATEventsHandler* m_eventsHandlers[MAX_AT_EVENTS_HANDLERS];
donatien 0:3b2f052c333b 136
donatien 0:3b2f052c333b 137 Mutex m_processingMtx;
donatien 0:3b2f052c333b 138 Thread m_processingThread;
donatien 0:3b2f052c333b 139
donatien 0:3b2f052c333b 140 Mutex m_eventsMtx;
donatien 0:3b2f052c333b 141 };
donatien 0:3b2f052c333b 142
donatien 0:3b2f052c333b 143 #endif /* ATCOMMANDSINTERFACE_H_ */