Renesas PTX1xxR IoT-Reader API Version 7.3.1
Renesas Software Stack for IoT-Reader Applications
ptxHce.h
Go to the documentation of this file.
1
49#ifndef ptxHCE_H_
50#define ptxHCE_H_
51
58#include "ptx_Status.h"
59#include "ptxLog.h"
60#include "ptxNvm.h"
61#include "ptxOsal.h"
62
63#ifdef __cplusplus
64extern "C" {
65#endif
66
73#define PTX_HCE_RF_MSG_MAX_SIZE (512U)
75#define PTX_HCE_RF_DISCOVERY_STATE_NO_CARD (0u)
76#define PTX_HCE_RF_DISCOVER_STATE_LISTEN_A (1u)
83#define PTX_HCE_DEACTIVATE_REASON_DESELECT (uint8_t)0x01
84#define PTX_HCE_DEACTIVATE_REASON_RELEASE (uint8_t)0x02
85#define PTX_HCE_DEACTIVATE_REASON_FIELD_OFF (uint8_t)0x03
92#define PTX_HCE_MAX_NR_EVENT_RECORDS (32u)
93#define PTX_HCE_SIZE_SHORT_MSG_BUFFER (3u)
94#define PTX_HCE_SIZE_ACTIVATION_BUFFER (16u)
101#define PTX_HCE_EVENT_RECORD_INDEX_MIN (0u)
102#define PTX_HCE_EVENT_RECORD_INDEX_MAX PTX_HCE_MAX_NR_EVENT_RECORDS - (1u)
103#define PTX_HCE_EVENT_RECORD_NOT_SET (0u)
110struct ptxNSC;
111
122typedef enum
123{
124 HceRfProt_Undefined = 0x00,
125 HceRfProt_T2T = 0x02,
126 HceRfProt_IsoDep = 0x04,
127
129
134{
135 HCEEvent_ExtFieldOn,
136 HCEEvent_ExtFieldOff,
137 HCEEvent_Activated_ListenA,
138 HCEEvent_Data,
139 HCEEvent_Deactivated,
140 HCEEvent_NoEvent,
141
143
147typedef struct
148{
150 uint8_t RxMsgDataShortMsgData[PTX_HCE_SIZE_SHORT_MSG_BUFFER];
151 uint8_t *RxMsgData;
152 uint32_t RxMsgDataLen;
155
169
170
193
207
223
232
257
270ptxStatus_t ptxHCE_ReserveEventRecord ( ptxHCE_t *hce, ptxHCE_EventRecord_t **evtRecord, uint16_t *evtRecordIndex );
271
282ptxStatus_t ptxHCE_AddNewEventPending ( ptxHCE_t *hce, uint16_t recordIndex );
283
294uint16_t ptxHCE_SendData (void *stackComp, ptxHCE_t *hce, uint8_t *tx, uint32_t txLength);
295
296#ifdef __cplusplus
297}
298#endif
299
300#endif /* Guard */
301
ptxHCE_EventType
HCE Event Identifiers.
Definition ptxHce.h:134
uint16_t ptxHCE_SendData(void *stackComp, ptxHCE_t *hce, uint8_t *tx, uint32_t txLength)
Send Tx Data.
ptxHCE_RfProtocol_t
HCE RF-Protocol Type(s)
Definition ptxHce.h:123
struct ptxHCE ptxHCE_t
Main Component Struture.
ptxStatus_t ptxHCE_AddNewEventPending(ptxHCE_t *hce, uint16_t recordIndex)
Adds a new pending Event Record at the Tail of the Event Queue.
struct ptxHCE_InitParams ptxHCE_InitParams_t
Main Component Struture.
enum ptxHCE_EventType ptxHCE_EventType_t
HCE Event Identifiers.
#define PTX_HCE_MAX_NR_EVENT_RECORDS
Definition ptxHce.h:92
ptxStatus_t ptxHCE_Deinit(ptxHCE_t *hceCtx)
Component De-Initialization.
ptxStatus_t ptxHCE_GetEvent(ptxHCE_t *hceCtx, ptxHCE_EventRecord_t **event)
This function allows the user to request latest event notification data received from the PTX card em...
#define PTX_HCE_SIZE_SHORT_MSG_BUFFER
Definition ptxHce.h:93
ptxStatus_t ptxHCE_ReserveEventRecord(ptxHCE_t *hce, ptxHCE_EventRecord_t **evtRecord, uint16_t *evtRecordIndex)
Reserves an Event Record at the Tail of the Event Queue.
#define PTX_HCE_RF_MSG_MAX_SIZE
Definition ptxHce.h:73
ptxStatus_t ptxHCE_Init(ptxHCE_t *hceCtx, ptxHCE_InitParams_t *initParams)
Component Initialization.
uint16_t ptxStatus_t
Status Type.
Definition ptx_Status.h:82
enum ptxStatus_Comps ptxStatus_Comps_t
Component Definitions.
struct ptxMutex * ptxMutex_t
Mutex Wrapper Structure - Forward Declaration.
Definition ptxOsal.h:95
struct ptxSemaphore * ptxSemaphore_t
Semaphore Wrapper Structure - Forward Declaration.
Definition ptxOsal.h:100
HCE Event Queue.
Definition ptxHce.h:160
uint16_t MaxNrOfEntries
Definition ptxHce.h:164
uint16_t TailIndex
Definition ptxHce.h:163
uint16_t NrOfEntries
Definition ptxHce.h:161
uint16_t HeadIndex
Definition ptxHce.h:162
HCE Event Record Type.
Definition ptxHce.h:148
uint8_t * RxMsgData
Definition ptxHce.h:151
ptxHCE_EventType_t EventID
Definition ptxHce.h:149
uint32_t RxMsgDataLen
Definition ptxHce.h:152
Main Component Struture.
Definition ptxHce.h:198
ptxNvm_t * NVM
Definition ptxHce.h:201
struct ptxNSC * NSC
Definition ptxHce.h:202
ptxSemaphore_t * Sem_Completion
Definition ptxHce.h:203
ptxLog_t * LOG
Definition ptxHce.h:200
uint16_t * CompletionStatus
Definition ptxHce.h:204
struct ptxOsal * OS
Definition ptxHce.h:199
Main Component Struture.
Definition ptxHce.h:175
ptxNvm_t * NVM
Definition ptxHce.h:179
uint16_t BuffIndex
Definition ptxHce.h:188
uint8_t DiscoveryState
Definition ptxHce.h:185
struct ptxNSC * NSC
Definition ptxHce.h:180
ptxSemaphore_t * Sem_Completion
Definition ptxHce.h:182
ptxLog_t * LOG
Definition ptxHce.h:178
uint16_t * CompletionStatus
Definition ptxHce.h:184
uint8_t Buff[PTX_HCE_RF_MSG_MAX_SIZE]
Definition ptxHce.h:189
ptxHCE_EventQueue_t EventQ
Definition ptxHce.h:187
ptxMutex_t Mutex
Definition ptxHce.h:181
ptxStatus_Comps_t CompId
Definition ptxHce.h:176
struct ptxOsal * OS
Definition ptxHce.h:177
size_t BuffLen
Definition ptxHce.h:190
Logger Component Structure.
Definition ptxLog.h:208
Definition ptxNSC_Interface.h:152
Main Nvm Component.
Definition ptxNvm.h:140