Donatien Garnier / VodafoneK3770LibBeta

The beta version of the Vodafone K3770 dongle driver

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

main/drv/at/ATCommandsInterface.h@1:4b33ffe61bfa, 2012-11-01 (annotated)

Committer:
donatien
Date:
Thu Nov 01 10:03:50 2012 +0000
Revision:
1:4b33ffe61bfa
Parent:
0:0ac66acdfdc0 
Deprecating library, pointing out at new one

Who changed what in which revision?

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