WiMOD_SAP_RadioLink.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
 
/*
 * THIS IS AN EXAMPLE IMPLEMENTATION ACCORDING THE THE HCI SPEC: V1.10
 * FOR FIRMWARE: LR-BASE
 *
 * SEE FILE: WiMOD_LR_Base_HCI_Spec_V1_10.pdf for detailed information
 */
 
 
 
#ifndef ARDUINO_SAP_WIMOD_SAP_RADIOLINK_H_
#define ARDUINO_SAP_WIMOD_SAP_RADIOLINK_H_
 
//------------------------------------------------------------------------------
//
// Section Includes Files
//
//------------------------------------------------------------------------------
 
#include "WiMOD_SAP_RadioLink_IDs.h"
#include "../HCI/WiMODLRHCI.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
//------------------------------------------------------------------------------
//
// Section defines
//
//------------------------------------------------------------------------------
 
#define WiMOD_RADIOLINK_MSG_SIZE               (WiMODLRBASE_APP_PAYLOAD_LEN)
 
 
 
//-----------------------------------------------------------------------------
//
// types for callback functions
//
//-----------------------------------------------------------------------------
 
 
// C++11 check
#ifdef WIMOD_USE_CPP11
  /* C++11 function callback definitions */
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRadioLinkUDataRxIndicationCallback;
 
  typedef std::function<void (void)> TRadioLinkUDataTxIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRadioLinkRawDataRxIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRadioLinkCDataRxIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRadioLinkCDataTxIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRadioLinkAckRxIndicationCallback;
 
  typedef std::function<void (void)> TRadioLinkAckRxTimeoutIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRadioLinkAckTxIndicationCallback;
 
#else
  /* pre C++11 function callback definitions */
 
 
 
  typedef void (*TRadioLinkUDataRxIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TRadioLinkUDataTxIndicationCallback)(TWiMODLR_HCIMessage& rxMsg); // V1.10 : added parameter
 
  typedef void (*TRadioLinkRawDataRxIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TRadioLinkCDataRxIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TRadioLinkCDataTxIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TRadioLinkAckRxIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TRadioLinkAckRxTimeoutIndicationCallback)(void);
 
  typedef void (*TRadioLinkAckTxIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
#endif
 
 
//------------------------------------------------------------------------------
//
// Section class
//
//------------------------------------------------------------------------------
 
 
class WiMOD_SAP_RadioLink {
public:
    WiMOD_SAP_RadioLink(TWiMODLRHCI* hci, UINT8* buffer, UINT16 bufferSize);
    virtual ~WiMOD_SAP_RadioLink(void);
 
    virtual TWiMODLRResultCodes SendUData(const TWiMODLR_RadioLink_Msg* txMsg, UINT8* statusRsp);
    virtual bool convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLR_RadioLink_Msg* radioLinkMsg);
    virtual TWiMODLRResultCodes SendCData(const TWiMODLR_RadioLink_Msg* txMsg, UINT8* statusRsp);
    virtual bool convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLR_RadioLink_CdataInd* cDataTxInfo);
    virtual bool convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLR_RadioLink_UdataInd* uDataTxInfo);
    virtual bool convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLR_AckTxInd_Msg* txAckIndInfo);
    virtual TWiMODLRResultCodes SetAckData(const TWiMODLR_RadioLink_Msg* txMsg, UINT8* statusRsp);
 
    /* only for sniffer mode */
    virtual bool convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLR_RadioLink_RawMsg* radioLinkRawMsg);
 
 
    virtual void RegisterUDataRxClient(TRadioLinkUDataRxIndicationCallback cb);
    virtual void RegisterUDataTxClient(TRadioLinkUDataTxIndicationCallback cb);
    virtual void RegisterRawDataRxClient(TRadioLinkRawDataRxIndicationCallback cb);
    virtual void RegisterCDataRxClient(TRadioLinkCDataRxIndicationCallback cb);
    virtual void RegisterCDataTxClient(TRadioLinkCDataTxIndicationCallback cb);
    virtual void RegisterAckRxClient(TRadioLinkAckRxIndicationCallback cb);
    virtual void RegisterAckRxTimeoutClient(TRadioLinkAckRxTimeoutIndicationCallback cb);
    virtual void RegisterAckTxCallback(TRadioLinkAckTxIndicationCallback cb);
 
    virtual void DispatchRadioLinkMessage(TWiMODLR_HCIMessage& rxMsg);
 
protected:
    UINT8*            txPayload;
    UINT16            txPayloadSize;
 
    TWiMODLRHCI*       HciParser;
 
private:
 
    TRadioLinkUDataRxIndicationCallback         UDataRxIndCallback;
    TRadioLinkUDataTxIndicationCallback         UDataTxIndCallback;
    TRadioLinkRawDataRxIndicationCallback       RawDataRxIndCallback;
    TRadioLinkCDataRxIndicationCallback         CDataRxIndCallback;
    TRadioLinkCDataTxIndicationCallback         CDataTxIndCallback;
    TRadioLinkAckRxIndicationCallback           AckRxDataIndCallback;
    TRadioLinkAckRxTimeoutIndicationCallback    AckRxTimeoutIndCallback;
    TRadioLinkAckTxIndicationCallback           AckTxIndCallack;
};
 
 
 
#endif /* ARDUINO_SAP_WIMOD_SAP_RADIOLINK_H_ */