Donatien Garnier / VodafoneUSBModem

Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket

This library is deprecated. Please use the newest production branch of the library from https://mbed.org/users/mbed_official/code/VodafoneUSBModem/

at/ATCommandsInterface.h@2:50930edb6eb3, 2012-11-01 (annotated)

Committer:
donatien
Date:
Thu Nov 01 09:57:11 2012 +0000
Revision:
2:50930edb6eb3
Parent:
0:bd5343539e38 
Deprecated library, pointing out to new one

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:bd5343539e38 1 /* ATCommandsInterface.h */
donatien 0:bd5343539e38 2 /* Copyright (C) 2012 mbed.org, MIT License
donatien 0:bd5343539e38 3 *
donatien 0:bd5343539e38 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 0:bd5343539e38 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
donatien 0:bd5343539e38 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
donatien 0:bd5343539e38 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
donatien 0:bd5343539e38 8 * furnished to do so, subject to the following conditions:
donatien 0:bd5343539e38 9 *
donatien 0:bd5343539e38 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 0:bd5343539e38 11 * substantial portions of the Software.
donatien 0:bd5343539e38 12 *
donatien 0:bd5343539e38 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 0:bd5343539e38 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 0:bd5343539e38 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 0:bd5343539e38 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:bd5343539e38 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 0:bd5343539e38 18 */
donatien 0:bd5343539e38 19
donatien 0:bd5343539e38 20 #ifndef ATCOMMANDSINTERFACE_H_
donatien 0:bd5343539e38 21 #define ATCOMMANDSINTERFACE_H_
donatien 0:bd5343539e38 22
donatien 0:bd5343539e38 23 #include "core/fwk.h"
donatien 0:bd5343539e38 24 #include "rtos.h"
donatien 0:bd5343539e38 25
donatien 0:bd5343539e38 26 #define MAX_AT_EVENTS_HANDLERS 4
donatien 0:bd5343539e38 27
donatien 0:bd5343539e38 28 class ATCommandsInterface;
donatien 0:bd5343539e38 29
donatien 0:bd5343539e38 30 /** Interface implemented by components handling AT events
donatien 0:bd5343539e38 31 *
donatien 0:bd5343539e38 32 */
donatien 0:bd5343539e38 33 class IATEventsHandler
donatien 0:bd5343539e38 34 {
donatien 0:bd5343539e38 35 protected:
donatien 0:bd5343539e38 36 virtual bool isATCodeHandled(const char* atCode) = 0; //Is this AT code handled
donatien 0:bd5343539e38 37 virtual void onDispatchStart() = 0;
donatien 0:bd5343539e38 38 virtual void onDispatchStop() = 0;
donatien 0:bd5343539e38 39 virtual void onEvent(const char* atCode, const char* evt) = 0;
donatien 0:bd5343539e38 40 friend class ATCommandsInterface;
donatien 0:bd5343539e38 41 };
donatien 0:bd5343539e38 42
donatien 0:bd5343539e38 43 /** Interface implemented by components executing complex AT commands
donatien 0:bd5343539e38 44 *
donatien 0:bd5343539e38 45 */
donatien 0:bd5343539e38 46 class IATCommandsProcessor
donatien 0:bd5343539e38 47 {
donatien 0:bd5343539e38 48 protected:
donatien 0:bd5343539e38 49 virtual int onNewATResponseLine(ATCommandsInterface* pInst, const char* line) = 0;
donatien 0:bd5343539e38 50 virtual int onNewEntryPrompt(ATCommandsInterface* pInst) = 0;
donatien 0:bd5343539e38 51 friend class ATCommandsInterface;
donatien 0:bd5343539e38 52 };
donatien 0:bd5343539e38 53
donatien 0:bd5343539e38 54 #define AT_INPUT_BUF_SIZE 64
donatien 0:bd5343539e38 55
donatien 0:bd5343539e38 56 //Signals to be sent to the processing thread
donatien 0:bd5343539e38 57 #define AT_SIG_PROCESSING_START 1
donatien 0:bd5343539e38 58 #define AT_SIG_PROCESSING_STOP 2
donatien 0:bd5343539e38 59 //Messages to be sent to the processing thread
donatien 0:bd5343539e38 60 #define AT_CMD_READY 1
donatien 0:bd5343539e38 61 #define AT_TIMEOUT 2
donatien 0:bd5343539e38 62 #define AT_STOP 3
donatien 0:bd5343539e38 63 //Messages to be sent from the processing thread
donatien 0:bd5343539e38 64 #define AT_RESULT_READY 1
donatien 0:bd5343539e38 65
donatien 0:bd5343539e38 66 /** AT Commands interface class
donatien 0:bd5343539e38 67 *
donatien 0:bd5343539e38 68 */
donatien 0:bd5343539e38 69 class ATCommandsInterface : protected IATCommandsProcessor
donatien 0:bd5343539e38 70 {
donatien 0:bd5343539e38 71 public:
donatien 0:bd5343539e38 72 ATCommandsInterface(IOStream* pStream);
donatien 0:bd5343539e38 73
donatien 0:bd5343539e38 74 //Open connection to AT Interface in order to execute command & register/unregister events
donatien 0:bd5343539e38 75 int open();
donatien 0:bd5343539e38 76
donatien 0:bd5343539e38 77 //Initialize AT link
donatien 0:bd5343539e38 78 int init();
donatien 0:bd5343539e38 79
donatien 0:bd5343539e38 80 //Close connection
donatien 0:bd5343539e38 81 int close();
donatien 0:bd5343539e38 82
donatien 0:bd5343539e38 83 bool isOpen();
donatien 0:bd5343539e38 84
donatien 0:bd5343539e38 85 class ATResult
donatien 0:bd5343539e38 86 {
donatien 0:bd5343539e38 87 public:
donatien 0:bd5343539e38 88 enum { AT_OK, AT_ERROR, AT_CONNECT, AT_CMS_ERROR, AT_CME_ERROR } result;
donatien 0:bd5343539e38 89 int code;
donatien 0:bd5343539e38 90 };
donatien 0:bd5343539e38 91
donatien 0:bd5343539e38 92 int executeSimple(const char* command, ATResult* pResult, uint32_t timeout=1000);
donatien 0:bd5343539e38 93 int execute(const char* command, IATCommandsProcessor* pProcessor, ATResult* pResult, uint32_t timeout=1000);
donatien 0:bd5343539e38 94 int registerEventsHandler(IATEventsHandler* pHdlr);
donatien 0:bd5343539e38 95 int deregisterEventsHandler(IATEventsHandler* pHdlr);
donatien 0:bd5343539e38 96
donatien 0:bd5343539e38 97 //Commands that can be called during onNewATResponseLine callback, additionally to close()
donatien 0:bd5343539e38 98 //Access to this method is protected (can ONLY be called on processing thread during IATCommandsProcessor::onNewATResponseLine execution)
donatien 0:bd5343539e38 99 int sendData(const char* data);
donatien 0:bd5343539e38 100
donatien 0:bd5343539e38 101 static void staticCallback(void const* p);
donatien 0:bd5343539e38 102 private:
donatien 0:bd5343539e38 103 int tryReadLine();
donatien 0:bd5343539e38 104 int trySendCommand();
donatien 0:bd5343539e38 105 int processReadLine();
donatien 0:bd5343539e38 106 int processEntryPrompt();
donatien 0:bd5343539e38 107
donatien 0:bd5343539e38 108 int ATResultToReturnCode(ATResult result); //Helper
donatien 0:bd5343539e38 109
donatien 0:bd5343539e38 110 virtual int onNewATResponseLine(ATCommandsInterface* pInst, const char* line); //Default implementation for simple commands handling
donatien 0:bd5343539e38 111 virtual int onNewEntryPrompt(ATCommandsInterface* pInst); //Default implementation (just sends Ctrl+Z to exit the prompt)
donatien 0:bd5343539e38 112
donatien 0:bd5343539e38 113 void process(); //Processing thread
donatien 0:bd5343539e38 114
donatien 0:bd5343539e38 115 IOStream* m_pStream;
donatien 0:bd5343539e38 116 bool m_open;
donatien 0:bd5343539e38 117
donatien 0:bd5343539e38 118 const char* m_transactionCommand;
donatien 0:bd5343539e38 119 const char* m_transactionData;
donatien 0:bd5343539e38 120
donatien 0:bd5343539e38 121 IATCommandsProcessor* m_pTransactionProcessor;
donatien 0:bd5343539e38 122 ATResult m_transactionResult;
donatien 0:bd5343539e38 123
donatien 0:bd5343539e38 124 enum { IDLE, COMMAND_SENT, READING_RESULT, ABORTED } m_transactionState;
donatien 0:bd5343539e38 125
donatien 0:bd5343539e38 126 char m_inputBuf[AT_INPUT_BUF_SIZE];
donatien 0:bd5343539e38 127 int m_inputPos;
donatien 0:bd5343539e38 128
donatien 0:bd5343539e38 129 Mutex m_transactionMtx;
donatien 0:bd5343539e38 130
donatien 0:bd5343539e38 131 Mail<int,1> m_env2AT;
donatien 0:bd5343539e38 132 Mail<int,1> m_AT2Env;
donatien 0:bd5343539e38 133
donatien 0:bd5343539e38 134 IATEventsHandler* m_eventsHandlers[MAX_AT_EVENTS_HANDLERS];
donatien 0:bd5343539e38 135
donatien 0:bd5343539e38 136 Mutex m_processingMtx;
donatien 0:bd5343539e38 137 Thread m_processingThread;
donatien 0:bd5343539e38 138
donatien 0:bd5343539e38 139 Mutex m_eventsMtx;
donatien 0:bd5343539e38 140 };
donatien 0:bd5343539e38 141
donatien 0:bd5343539e38 142 #endif /* ATCOMMANDSINTERFACE_H_ */