ptxHce.h

Go to the documentation of this file.

 
#ifndef COMPS_HCE_PTXHCE_H_
#define COMPS_HCE_PTXHCE_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
#include "ptxStatus.h"
#include "ptxNSC_Event.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DATA DEFINITIONS
 * ####################################################################################################################
 */
 
/*
 * Forward declarations.
 */
struct ptxPlat;
struct ptxNSC;
struct ptxNSC_Event;
 
typedef struct
{
    uint8_t     ListenTypeA;
 
    /*
     * RFU
     */
 
} ptxHce_DiscConfig_t;
 
typedef enum
{
    HceRfProt_Undefined = 0x00,
    HceRfProt_T2T       = 0x02,
    HceRfProt_IsoDep    = 0x04
 
} ptxHce_RfProtocol_t;
 
typedef enum
{
    e_MaxNrOfEventRecords           =  32,
    e_SizeOfShortMsgBuffer          =   3,  /* pay-load of medium size data message buffers. */
    e_SizeOfActivationBuffer        =  16,  /* pay-load of medium size data message buffers. */
 
} ptxHce_EventQueueDimensions_t;
 
typedef enum
{
    e_EvtRecordIndexMin = 0,
    e_EvtRecordIndexMax = e_MaxNrOfEventRecords-1,
    e_EvtMaxNrOfRecords,
    e_EvtRecIndexNotSet
 
} ptxHce_EventQueueRanges_t;
 
typedef enum ptxHce_EventType
{
    HceEvent_ExtFieldOn,
    HceEvent_ExtFieldOff,
    HceEvent_Activated_ListenA,
    HceEvent_Data,
    HceEvent_Deactivated,
    HceEvent_NoEvent,
 
} ptxHce_EventType_t;
 
typedef struct
{
    ptxHce_EventType_t          EventID;        
    uint8_t                     RxMsgDataShortMsgData[e_SizeOfShortMsgBuffer];      
    uint8_t                    *RxMsgData;      
    uint32_t                    RxMsgDataLen;   
} ptxHce_EventRecord_t;
 
typedef struct
{
    ptxHce_EventQueueRanges_t    NrOfEntries;   
    ptxHce_EventQueueRanges_t    HeadIndex;     
    ptxHce_EventQueueRanges_t    TailIndex;     
    ptxHce_EventQueueRanges_t    MaxNrOfEntries;    
    ptxHce_EventRecord_t         Entries[e_MaxNrOfEventRecords]; 
} ptxHce_EventQueue_t;
 
typedef struct ptxHce
{
    ptxStatus_Comps_t       CompId;             
    struct ptxPlat          *Plat;              
    struct ptxNSC           *Nsc;               
    ptxHce_EventQueue_t     EventQ;             
    uint8_t                 ActivationData[e_SizeOfActivationBuffer];   
    uint8_t                 *AppRxBuffer;       
    uint32_t                AppRxBufferSize;    
    uint32_t                AppRxBufferIndex;   
    uint8_t                 DiscoverState;      
} ptxHce_t;
 
#define PTX_HCE_DEACTIVATE_REASON_DESELECT      (uint8_t)0x01       
#define PTX_HCE_DEACTIVATE_REASON_RELEASE       (uint8_t)0x02       
#define PTX_HCE_DEACTIVATE_REASON_FIELD_OFF     (uint8_t)0x03       
/*
 * ####################################################################################################################
 * HCE API FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxHce_Init ( ptxHce_t *hce, struct ptxPlat *plat, struct ptxNSC *nsc, uint8_t *appRxBuffer, uint16_t appRxBufferSize );
 
 
ptxStatus_t ptxHce_Deinit ( ptxHce_t *hce );
 
ptxStatus_t ptxHce_Get_Event ( ptxHce_t *hce, ptxHce_EventRecord_t **event );
 
ptxStatus_t ptxHce_Send_Data ( ptxHce_t *hce, uint8_t *tx, uint32_t txLength );
 
ptxStatus_t ptxHce_ReserveEventRecord ( ptxHce_t *hce, ptxHce_EventRecord_t **evtRecord, uint16_t *evtRecordIndex );
ptxStatus_t ptxHce_AddNewEventPending ( ptxHce_t *hce, uint16_t recordIndex );
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */