Daniel Peter / Net

drv/at/ATIf.h@0:d616ece2d859, 2010-09-18 (annotated)

Committer:
mbed714
Date:
Sat Sep 18 23:05:49 2010 +0000
Revision:
0:d616ece2d859

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


mbed714

0:d616ece2d859


     1







mbed714

0:d616ece2d859


     2

/*





mbed714

0:d616ece2d859


     3

Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)





mbed714

0:d616ece2d859


     4

 





mbed714

0:d616ece2d859


     5

Permission is hereby granted, free of charge, to any person obtaining a copy





mbed714

0:d616ece2d859


     6

of this software and associated documentation files (the "Software"), to deal





mbed714

0:d616ece2d859


     7

in the Software without restriction, including without limitation the rights





mbed714

0:d616ece2d859


     8

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell





mbed714

0:d616ece2d859


     9

copies of the Software, and to permit persons to whom the Software is





mbed714

0:d616ece2d859


    10

furnished to do so, subject to the following conditions:





mbed714

0:d616ece2d859


    11

 





mbed714

0:d616ece2d859


    12

The above copyright notice and this permission notice shall be included in





mbed714

0:d616ece2d859


    13

all copies or substantial portions of the Software.





mbed714

0:d616ece2d859


    14

 





mbed714

0:d616ece2d859


    15

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR





mbed714

0:d616ece2d859


    16

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,





mbed714

0:d616ece2d859


    17

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE





mbed714

0:d616ece2d859


    18

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER





mbed714

0:d616ece2d859


    19

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,





mbed714

0:d616ece2d859


    20

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN





mbed714

0:d616ece2d859


    21

THE SOFTWARE.





mbed714

0:d616ece2d859


    22

*/





mbed714

0:d616ece2d859


    23







mbed714

0:d616ece2d859


    24

#ifndef ATIF_H





mbed714

0:d616ece2d859


    25

#define ATIF_H





mbed714

0:d616ece2d859


    26







mbed714

0:d616ece2d859


    27

#include "netCfg.h"





mbed714

0:d616ece2d859


    28







mbed714

0:d616ece2d859


    29

#include "mbed.h"





mbed714

0:d616ece2d859


    30

#include "drv/serial/buf/SerialBuf.h"





mbed714

0:d616ece2d859


    31

#include <list>





mbed714

0:d616ece2d859


    32

using std::list;





mbed714

0:d616ece2d859


    33







mbed714

0:d616ece2d859


    34

//class Serial; //Pb w forward decl





mbed714

0:d616ece2d859


    35







mbed714

0:d616ece2d859


    36

enum ATErr





mbed714

0:d616ece2d859


    37

{





mbed714

0:d616ece2d859


    38

  __AT_MIN = -0xFFFF,





mbed714

0:d616ece2d859


    39

  AT_CLOSED,





mbed714

0:d616ece2d859


    40

  AT_NOANSWER,





mbed714

0:d616ece2d859


    41

  AT_ERROR,





mbed714

0:d616ece2d859


    42

  AT_TIMEOUT, 





mbed714

0:d616ece2d859


    43

  AT_BUSY,





mbed714

0:d616ece2d859


    44

  AT_PARSE,





mbed714

0:d616ece2d859


    45

  AT_INCOMPLETE,





mbed714

0:d616ece2d859


    46

  AT_OK = 0





mbed714

0:d616ece2d859


    47

};





mbed714

0:d616ece2d859


    48







mbed714

0:d616ece2d859


    49

class ATIf : public SerialBuf





mbed714

0:d616ece2d859


    50

{





mbed714

0:d616ece2d859


    51

  public:





mbed714

0:d616ece2d859


    52

    





mbed714

0:d616ece2d859


    53

    ATIf();





mbed714

0:d616ece2d859


    54

    virtual ~ATIf();





mbed714

0:d616ece2d859


    55







mbed714

0:d616ece2d859


    56

#if 0    





mbed714

0:d616ece2d859


    57

    template<class T> 





mbed714

0:d616ece2d859


    58

    //void attachSignal( const char* sigName, T* pItem, bool (T::*pMethod)(ATIf*, bool, bool*) ); //Attach Signal ("Unsollicited response code" in Telit_AT_Reference_Guide.pdf) to an handler fn





mbed714

0:d616ece2d859


    59

    //Linker bug : Must be defined here :(





mbed714

0:d616ece2d859


    60

    void attachSignal( const char* sigName, T* pItem, bool (T::*pMethod)(ATIf*, bool, bool*) ) //Attach Signal ("Unsollicited response code" in Telit_AT_Reference_Guide.pdf) to an handler fn





mbed714

0:d616ece2d859


    61

    {





mbed714

0:d616ece2d859


    62

      ATSigHandler sig(sigName, (ATSigHandler::CDummy*)pItem, (bool (ATSigHandler::CDummy::*)(ATIf*, bool, bool*))pMethod);





mbed714

0:d616ece2d859


    63

      m_signals.push_back(sig);





mbed714

0:d616ece2d859


    64

    }





mbed714

0:d616ece2d859


    65

    void detachSignal( const char* sigName );    





mbed714

0:d616ece2d859


    66

#endif





mbed714

0:d616ece2d859


    67

  





mbed714

0:d616ece2d859


    68

    ATErr open(Serial* pSerial); //Deactivate echo, etc





mbed714

0:d616ece2d859


    69

    #if NET_USB_SERIAL





mbed714

0:d616ece2d859


    70

    ATErr open(UsbSerial* pUsbSerial); //Deactivate echo, etc





mbed714

0:d616ece2d859


    71

    #endif





mbed714

0:d616ece2d859


    72

    ATErr close(); //Release port





mbed714

0:d616ece2d859


    73

    





mbed714

0:d616ece2d859


    74

    int printf(const char* format, ... );





mbed714

0:d616ece2d859


    75

    int scanf(const char* format, ... );





mbed714

0:d616ece2d859


    76

    void setTimeout(int timeout); //used by scanf





mbed714

0:d616ece2d859


    77

    void setLineMode(bool lineMode); //Switch btw line & raw fns





mbed714

0:d616ece2d859


    78

    //void setSignals(bool signalsEnable);





mbed714

0:d616ece2d859


    79

    ATErr flushBuffer(); //Discard input buffer





mbed714

0:d616ece2d859


    80

    ATErr flushLine(int timeout); //Discard input buffer until CRLF is encountered





mbed714

0:d616ece2d859


    81

    





mbed714

0:d616ece2d859


    82

  protected:





mbed714

0:d616ece2d859


    83

    //virtual bool onRead(); //Inherited from SerialBuf, return true if data is incomplete





mbed714

0:d616ece2d859


    84

    ATErr rawOpen(Serial* pSerial, int baudrate); //Simple open function for similar non-conforming protocols





mbed714

0:d616ece2d859


    85







mbed714

0:d616ece2d859


    86

  public:





mbed714

0:d616ece2d859


    87

/*    ATErr command(const char* cmd, char* result, int resultLen, int timeout); */ //Kinda useless





mbed714

0:d616ece2d859


    88

    ATErr write(const char* cmd, bool lineMode = false);





mbed714

0:d616ece2d859


    89

    ATErr read(char* result, int resultMaxLen, int timeout, bool lineMode = false, int resultMinLen = 0);





mbed714

0:d616ece2d859


    90

    bool isOpen();





mbed714

0:d616ece2d859


    91

    ATErr checkOK(); //Helper fn to quickly check that OK has been returned





mbed714

0:d616ece2d859


    92

  





mbed714

0:d616ece2d859


    93

  private:  





mbed714

0:d616ece2d859


    94

    int readLine(char* line, int maxLen, int timeout); //Read a single line from serial port





mbed714

0:d616ece2d859


    95

    int writeLine(const char* line); //Write a single line to serial port





mbed714

0:d616ece2d859


    96

    





mbed714

0:d616ece2d859


    97

    int readRaw(char* str, int maxLen, int timeout = 0, int minLen = 0); //Read from serial port in buf





mbed714

0:d616ece2d859


    98

    int writeRaw(const char* str); //Write directly to serial port





mbed714

0:d616ece2d859


    99

      





mbed714

0:d616ece2d859


   100

    volatile int m_readTimeout;





mbed714

0:d616ece2d859


   101

    volatile bool m_lineMode;





mbed714

0:d616ece2d859


   102

    //bool m_signalsEnable;





mbed714

0:d616ece2d859


   103

    bool m_isOpen;





mbed714

0:d616ece2d859


   104

    





mbed714

0:d616ece2d859


   105

    char* m_tmpBuf;





mbed714

0:d616ece2d859


   106

 





mbed714

0:d616ece2d859


   107

#if 0 





mbed714

0:d616ece2d859


   108

    class ATSigHandler





mbed714

0:d616ece2d859


   109

    {





mbed714

0:d616ece2d859


   110

      class CDummy;





mbed714

0:d616ece2d859


   111

      public:





mbed714

0:d616ece2d859


   112

        ATSigHandler(const char* name, CDummy* cbObj, bool (CDummy::*cbMeth)(ATIf* pIf, bool beg, bool* pMoreData)) : m_cbObj(cbObj), m_cbMeth(cbMeth), m_name(name) 





mbed714

0:d616ece2d859


   113

        {}





mbed714

0:d616ece2d859


   114

      protected:





mbed714

0:d616ece2d859


   115

        CDummy* m_cbObj;





mbed714

0:d616ece2d859


   116

        bool (CDummy::*m_cbMeth)(ATIf* pIf, bool beg, bool* pMoreData); //*pMoreData set to true if needs to read next line, beg = true if beginning of new code





mbed714

0:d616ece2d859


   117

        const char* m_name;





mbed714

0:d616ece2d859


   118

     





mbed714

0:d616ece2d859


   119

      friend class ATIf;





mbed714

0:d616ece2d859


   120

    };





mbed714

0:d616ece2d859


   121

    





mbed714

0:d616ece2d859


   122

    volatile ATSigHandler* m_pCurrentSignal; //Signal that asked more data





mbed714

0:d616ece2d859


   123

    





mbed714

0:d616ece2d859


   124

    bool handleSignal(); //Returns true if signal has been handled





mbed714

0:d616ece2d859


   125

    list<ATSigHandler> m_signals;





mbed714

0:d616ece2d859


   126

#endif





mbed714

0:d616ece2d859


   127

    





mbed714

0:d616ece2d859


   128

};





mbed714

0:d616ece2d859


   129







mbed714

0:d616ece2d859


   130

#endif