WiMODLRHCI.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
 
#ifndef ARDUINO_WIMODLRHCI_H_
#define ARDUINO_WIMODLRHCI_H_
 
//------------------------------------------------------------------------------
//
// Section Includes Files
//
//------------------------------------------------------------------------------
 
 
#include "utils/WMDefs.h"
 
#include <string.h>
 
#include "utils/ComSLIP.h"
 
#include "Arduino.h"
 
/*
 * C++11 supports a better way for function pointers / function objects
 * But C++11 mode is not supported by all platforms.
 */
#ifdef WIMOD_USE_CPP11
#include <functional>
#endif
 
//------------------------------------------------------------------------------
//
// Serial Baudrate
//
//------------------------------------------------------------------------------
#define WIMODLR_SERIAL_BAUDRATE             115200
 
#define WIMODLR_RESPOMSE_TIMEOUT_MS         1000;
 
//------------------------------------------------------------------------------
//
// HCI Message Declaration
//
//------------------------------------------------------------------------------
 
// message header size: 2 bytes for SapID + MsgID
#define WIMODLR_HCI_MSG_HEADER_SIZE     2
 
// message payload size
#define WIMODLR_HCI_MSG_PAYLOAD_SIZE    280
 
// frame check sequence field size: 2 bytes for CRC16
#define WIMODLR_HCI_MSG_FCS_SIZE        2
 
// visible max. buffer size for lower SLIP layer
#define WIMODLR_HCI_RX_MESSAGE_SIZE     (WIMODLR_HCI_MSG_HEADER_SIZE\
                                         + WIMODLR_HCI_MSG_PAYLOAD_SIZE\
                                         + WIMODLR_HCI_MSG_FCS_SIZE)
 
 
#define WiMODLR_HCI_RSP_STATUS_POS      0x00
 
#define WiMODLR_HCI_RSP_CMD_PAYLOAD_POS 0x01
 
 
 
//------------------------------------------------------------------------------
//
// Wake up sequence
//
//------------------------------------------------------------------------------
 
#define WIMODLR_NUMBER_OF_WAKEUP_CHARS      40
 
 
//------------------------------------------------------------------------------
//
// HCI Message
//
//------------------------------------------------------------------------------
 
typedef struct TWiMODLR_HCIMessage
{
    // Payload Length Information, not transmitted over UART interface !
    UINT16  Length;                                                             
    // Service Access Point Identifier
    UINT8   SapID;                                                              
    // Message Identifier
    UINT8   MsgID;                                                              
    // Payload Field
    UINT8   Payload[WIMODLR_HCI_MSG_PAYLOAD_SIZE];                              
    // Frame Check Sequence Field
    UINT8   CRC16[WIMODLR_HCI_MSG_FCS_SIZE];                                    
} TWiMODLR_HCIMessage;
 
 
//------------------------------------------------------------------------------
//
// Definition of Result/Error Codes
//
//------------------------------------------------------------------------------
 
typedef enum TWiMODLRResultCodes
{
    WiMODLR_RESULT_OK = 0,                                                      
    WiMODLR_RESULT_PAYLOAD_LENGTH_ERROR,                                        
    WiMODLR_RESULT_PAYLOAD_PTR_ERROR,                                           
    WiMODLR_RESULT_TRANMIT_ERROR,                                               
    WiMODLR_RESULT_SLIP_ENCODER_ERROR,                                          
    WiMODLR_RESULT_NO_RESPONSE                                                  
}TWiMODLRResultCodes;
 
 
 
//------------------------------------------------------------------------------
//
// Error indicator callback
//
//------------------------------------------------------------------------------
 
typedef enum TWiMODStackError
{
    WIMOD_STACK_ERR_UNKNOWN_RX_MESSAGE,                                         
    WIMOD_STACK_ERR_UNKNOWN_RX_SAP_ID,                                          
    WIMOD_STACK_ERR_UNKNOWN_RX_CMD_ID,                                          
} TWiMODStackError;
 
 
// C++11 check
#ifdef WIMOD_USE_CPP11
        /* C++11 function callback definitions */
 
 
        typedef std::function<void (TWiMODStackError)> TWiMODStackErrorClient;
 
#else
        /* pre C++11 function callback definitions */
 
        typedef void (*TWiMODStackErrorClient)(TWiMODStackError);
 
#endif
 
//------------------------------------------------------------------------------
//
// TWiMODLRHCIClient Class Declaration
//
//------------------------------------------------------------------------------
 
class TWiMODLRHCIClient
{
    public:
                        TWiMODLRHCIClient() {}
    virtual             ~TWiMODLRHCIClient() {}
 
 
    // define handler for received indication messasges
    virtual void        ProcessRxMessage(const TWiMODLR_HCIMessage& /* rxMsg */) = 0;
};
 
 
//------------------------------------------------------------------------------
//
// TWiMODLRHCI Class Declaration
//
//------------------------------------------------------------------------------
 
class TWiMODLRHCI : public TComSlipClient
{
    public:
        /*explicit*/ TWiMODLRHCI(Stream& s);
    ~TWiMODLRHCI(void);
 
    virtual void begin(void);
    virtual void end(void);
 
 
    TWiMODLRResultCodes  SendHCIMessage(UINT8 dstSapID, UINT8 msgID, UINT8 rxMsgID, UINT8* payload, UINT16 length);
    TWiMODLRResultCodes  SendHCIMessageWithoutRx(UINT8 dstSapID, UINT8 msgID,  UINT8* payload, UINT16 length);
    void                Process(void);
    void                SendWakeUpSequence(void);
 
    void                RegisterStackErrorClient(TWiMODStackErrorClient cb);
//    void                RegisterRxMessageClient(TWiMODLRHCIClient* cb);
 
    const TWiMODLR_HCIMessage& GetRxMessage(void);
 
    // enable / disable wakeup sequence
    void EnableWakeupSequence(bool flag);
 
 
    protected:
    TWiMODLRResultCodes  PostMessage(UINT8 sapID, UINT8 msgID, UINT8* payload, UINT16 length);
    TWiMODLRResultCodes  SendPacket(UINT8* txData, UINT16 length);
    bool                WaitForResponse(UINT8 rxSapID, UINT8 rxMsgID);
    UINT8*              ProcessRxMessage(UINT8* rxBuffer, UINT16 length);
    virtual void        ProcessUnexpectedRxMessage(TWiMODLR_HCIMessage& rxMsg) = 0;
    // @end_cond
 
    // receiver struct
    typedef struct TReceiver
    {
 
        bool        Active;                                                     
        bool        Done;                                                       
        UINT8       SapID;                                                      
        UINT8       MsgID;                                                      
        TWiMODLR_HCIMessage Message;                                            
#ifdef WIMOD_USE_2ND_RXBUFFER
        // only neccessary for non IRQ mode!
        TWiMODLR_HCIMessage ExpectedRsponseMsg;                                 
#endif
        // Timeout (~1000ms)
        int         Timeout;                                                    
    }TReceiver;
 
 
    // receiver instance
    TReceiver           Rx;
 
 
    // Stack error indicator callback
    TWiMODStackErrorClient   StackErrorClientCB;
 
 
 
    private:
        virtual void            DispatchRxMessage(TWiMODLR_HCIMessage& rxMsg);
 
        TWiMODLRHCIClient*      RxMessageClient;
 
        Stream&             serial;
        TComSlip            comSlip;
 
        TWiMODLR_HCIMessage TxMessage;
 
        bool                wakeUp;
 
};
 
#endif /* ARDUINO_WIMODLRHCI_H_ */
 
//------------------------------------------------------------------------------
// EOF
//------------------------------------------------------------------------------