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