Renesas PTX1xxR IoT-Reader API Version 7.3.1
Renesas Software Stack for IoT-Reader Applications
ptx_IOT_READER.h
Go to the documentation of this file.
1
49#ifndef APIS_IOT_READER_PTX_IOT_READER_H_
50#define APIS_IOT_READER_PTX_IOT_READER_H_
51
52/*
53 * ####################################################################################################################
54 * INCLUDES
55 * ####################################################################################################################
56 */
57
58#include <stdint.h>
59#include "ptxHce.h"
60#include "ptxCOMMON.h"
61
62
63#ifdef __cplusplus
64extern "C" {
65#endif
66
67/*
68 * ####################################################################################################################
69 * DEFINES / TYPES
70 * ####################################################################################################################
71 */
72
73#if defined (_WIN32) || defined (_WIN64) || defined (ming) || defined (__MINGW32__) || defined (__GNUWIN32__)
74
75 #define PTX_API_LIBFUNC __declspec(dllexport) /* */
76
77#else
78
79 #if defined (__GNUC__) /* GCC */
80 #define PTX_API_LIBFUNC __attribute__ ((visibility("default"))) /* requires -fvisibility=hidden as compiler option */
81 #elif defined (_linux) || defined (__linux) /* Linux with some other compiler */
82 #error Missing Platform Specification /* To be added */
83 #else
84 #error Missing Platform Specification
85 #endif
86#endif
87
92
93#define PTX_IOTRD_MAX_SUPPORTED_DEVICES (uint8_t)50
94#define PTX_IOTRD_MAX_SUPPORTED_RF_PROTOCOLS (uint8_t)4
96#define PTX_IOTRD_TECH_A_SENSRES_MAX_SIZE (uint8_t)2
97#define PTX_IOTRD_TECH_A_NFCID1_MAX_SIZE (uint8_t)10
98#define PTX_IOTRD_TECH_B_SENSB_MAX_SIZE (uint8_t)13
99#define PTX_IOTRD_TECH_F_SENSF_MAX_SIZE (uint8_t)20
100#define PTX_IOTRD_TECH_V_UID_MAX_SIZE (uint8_t)8
101#define PTX_IOTRD_TECH_EXT_PARAM_MAX_SIZE (uint8_t)32
103#define PTX_IOTRD_PROT_ISO_DEP_ATS_MAX_SIZE (uint8_t)21
104#define PTX_IOTRD_PROT_ISO_DEP_ATTRIB_RES_MAX_SIZE (uint8_t)16
105#define PTX_IOTRD_PROT_NFC_DEP_ATR_RES_MAX_SIZE (uint8_t)65
106#define PTX_IOTRD_HIGH_LEVEL_PROT_MAX_SIZE PTX_IOTRD_PROT_NFC_DEP_ATR_RES_MAX_SIZE
108#define PTX_IOTRD_RF_BAILOUT_TECH_A (uint8_t)1
109#define PTX_IOTRD_RF_BAILOUT_TECH_B (uint8_t)2
110#define PTX_IOTRD_RF_BAILOUT_TECH_F (uint8_t)4
112#define PTX_IOTRD_RF_DISCOVER_STATUS_NO_CARD (uint8_t)0
113#define PTX_IOTRD_RF_DISCOVER_STATUS_CARD_ACTIVE (uint8_t)1
114#define PTX_IOTRD_RF_DISCOVER_STATUS_DISCOVER_RUNNING (uint8_t)2
115#define PTX_IOTRD_RF_DISCOVER_STATUS_DISCOVER_DONE (uint8_t)3
116#define PTX_IOTRD_RF_DISCOVER_STATUS_UNDEFINED (uint8_t)0xFF
118#define PTX_IOTRD_RF_DEACTIVATION_TYPE_IDLE (uint8_t)0
119#define PTX_IOTRD_RF_DEACTIVATION_TYPE_DISCOVER (uint8_t)1
120#define PTX_IOTRD_RF_DEACTIVATION_TYPE_SLEEP (uint8_t)2
121#define PTX_IOTRD_RF_DEACTIVATION_TYPE_SLEEP_NON_BLOCKING (uint8_t)3
122#define PTX_IOTRD_RF_DEACTIVATION_TYPE_NO_RF_RESET (uint8_t)4
123#define PTX_IOTRD_RF_DEACTIVATION_TYPE_IDLE_PROTOCOL (uint8_t)5
124#define PTX_IOTRD_RF_DEACTIVATION_TYPE_DISCOVER_PROTOCOL (uint8_t)6
126#define PTX_IOTRD_RF_DEACTIVATION_SLEEP_ONGOING (uint8_t)0
127#define PTX_IOTRD_RF_DEACTIVATION_SLEEP_DONE (uint8_t)1
134#define PTX_STATUS_UNDEFINED (uint16_t)0xFFFF
135#define PTX_STATUS_OK (uint16_t)0
136#define PTX_STATUS_FILE_NOT_FOUND (uint16_t)18
137#define PTX_STATUS_ERR_RF_TIMEOUT (uint16_t)5
138#define PTX_STATUS_ERR_RF_NTF (uint16_t)34
140#define PTX_SYSTEM_STATUS_OK (uint8_t)0
141#define PTX_SYSTEM_STATUS_ERR_OVERCURRENT (uint8_t)1
142#define PTX_SYSTEM_STATUS_ERR_TEMPERATURE (uint8_t)2
151#define PTX_RF_ERROR_NTF_CODE_NO_ERROR (uint8_t)0x00
152#define PTX_RF_ERROR_NTF_CODE_UNKNOWN_ERROR (uint8_t)0xFF
153#define PTX_RF_ERROR_NTF_CODE_WARNING_PA_OVERCURRENT_LIMIT (uint8_t)0x09
154#define PTX_RF_ERROR_NTF_CODE_ERR_EMV_COLL (uint8_t)0x11
155#define PTX_RF_ERROR_NTF_CODE_ERR_TIMEOUT (uint8_t)0x12
156#define PTX_RF_ERROR_NTF_CODE_ERR_TRANSMISSION (uint8_t)0x13
157#define PTX_RF_ERROR_NTF_CODE_ERR_PROTOCOL (uint8_t)0x14
158#define PTX_RF_ERROR_NTF_CODE_ERR_COMM_INTERFACE (uint8_t)0xFE
166#define PTX_HW_PRODUCT_ID_PTX100X (uint8_t)0x00
167#define PTX_HW_PRODUCT_ID_PTX105X (uint8_t)0x01
168#define PTX_HW_PRODUCT_ID_PTX130X (uint8_t)0x02
175#define PTX_IOTRD_READER_INTERFACE_TYPE_UART (uint8_t)1
176#define PTX_IOTRD_READER_INTERFACE_TYPE_SPI (uint8_t)2
177#define PTX_IOTRD_READER_INTERFACE_TYPE_I2C (uint8_t)3
185#define PTX_IOTRD_HOST_SPEED_I2C_100000 (100000UL)
186#define PTX_IOTRD_HOST_SPEED_I2C_400000 (400000UL)
187#define PTX_IOTRD_HOST_SPEED_I2C_1000000 (1000000UL)
188#define PTX_IOTRD_HOST_SPEED_I2C_3400000 (3400000UL)
189#define PTX_IOTRD_HOST_SPEED_I2C_MAX PTX_IOTRD_HOST_SPEED_I2C_3400000
197#define PTX_IOTRD_HOST_SPEED_UART_9600 (9600UL)
198#define PTX_IOTRD_HOST_SPEED_UART_14400 (14400UL)
199#define PTX_IOTRD_HOST_SPEED_UART_19200 (19200UL)
200#define PTX_IOTRD_HOST_SPEED_UART_28800 (28800UL)
201#define PTX_IOTRD_HOST_SPEED_UART_38400 (38400UL)
202#define PTX_IOTRD_HOST_SPEED_UART_57600 (57600UL)
203#define PTX_IOTRD_HOST_SPEED_UART_115200 (115200UL)
204#define PTX_IOTRD_HOST_SPEED_UART_230400 (230400UL)
205#define PTX_IOTRD_HOST_SPEED_UART_460800 (460800UL)
206#define PTX_IOTRD_HOST_SPEED_UART_921600 (921600UL)
207#define PTX_IOTRD_HOST_SPEED_UART_1843200 (1843200UL)
208#define PTX_IOTRD_HOST_SPEED_UART_3000000 (3000000UL)
209#define PTX_IOTRD_HOST_SPEED_UART_MAX PTX_IOTRD_HOST_SPEED_UART_3000000
217#define PTX_IOTRD_HOST_SPEED_SPI_1M (1000000UL)
218#define PTX_IOTRD_HOST_SPEED_SPI_5M (5000000UL)
219#define PTX_IOTRD_HOST_SPEED_SPI_10M (10000000UL)
220#define PTX_IOTRD_HOST_SPEED_SPI_MAX PTX_IOTRD_HOST_SPEED_SPI_10M
228#define PTX_IOTRD_MAX_EXTENSIONS (1u)
231/*
232 * ####################################################################################################################
233 * TYPES
234 * ####################################################################################################################
235 */
236
241{
242 RevInfo_C_Stack,
243 RevInfo_Local_Changes,
244 RevInfo_DFY_Code,
245 RevInfo_DFY_Toolchain,
246 RevInfo_ChipID,
247 RevInfo_ProductID,
248
250
255{
256 /* RF-Configuration IDs */
257 RF_Wavebank0,
258 RF_Wavebank1,
259 RF_Wavebank2,
260 RF_Wavebank3,
261 RF_Wavebank4,
262 RF_Wavebank5,
263 RF_Wavebank6,
264 RF_Wavebank7,
265 RF_Wavebank8,
266 RF_Wavebank9,
267 RF_Wavebank10,
268 RF_Wavebank11,
269 RF_Wavebank12,
270 RF_Wavebank13,
271 RF_Wavebank14,
272 RF_Wavebank15,
273 RF_Wavebank16,
274 RF_Wavebank17,
275 RF_Wavebank18,
276 RF_Wavebank19,
277 RF_Misc,
278 RF_PollA106,
279 RF_PollA212,
280 RF_PollA424,
281 RF_PollA848,
282 RF_PollB106,
283 RF_PollB212,
284 RF_PollB424,
285 RF_PollB848,
286 RF_PollF212,
287 RF_PollF424,
288 RF_PollV,
289
290 /* System-Configuration IDs */
291 SYS_ThermalThreshold = 100,
292 SYS_OvercurrentThreshold,
293 SYS_ConClockSrc,
294 SYS_ConVarLBS,
295 SYS_ConNHost,
296 SYS_ConNHosCE,
297
299
304{
305 SysInfo_VDPA_Calibration_Result,
306
308
319
330
340
350
355{
356 /* map enum values to system internal definitions */
357 Tech_TypeA = 0,
358 Tech_TypeB = 1,
359 Tech_TypeF = 2,
360 Tech_TypeV = 6,
361 Tech_TypeExtension = 10,
363
368{
369 Prot_Undefined = 0,
370 Prot_T2T = 2,
371 Prot_T3T = 3,
372 Prot_ISODEP = 4,
373 Prot_NFCDEP = 5,
374 Prot_T5T = 6,
375 Prot_Extension = 10,
377
390
395{
402
404 uint8_t PollTypeA;
405
408
410 uint8_t PollTypeB;
411
414
417
420
423
426
428 uint8_t PollTypeV;
429
432
435
441
444
447
450
453
455 uint32_t IdleTime;
456
459
462
465
467 uint8_t ListenTypeA;
468
470 uint8_t EnableHbr;
471
474
477
479 uint8_t AfiValue;
480
482 uint8_t ContinuousField;
483
485
486
497
498
510
518
527
537
547
559
568
579
593
602
607{
608 StatusType_System,
609 StatusType_Discover,
610 StatusType_DeactivateSleep,
611 StatusType_LastRFError,
612 StatusType_LPCDNtfCounter,
613 StatusType_HCE_Discover_State,
615
624
628typedef uint16_t (*pExtProcessNTF_t)(void *extCtx, void *iotRdComp, void *nscEvent);
629
633typedef uint16_t (*pExtActivateCMD_t)(void *extCtx, void *iotRdComp, ptxIoTRd_CardParams_t *cardParams, ptxIoTRd_CardProtocol_t protocol);
634
647
659
668
669
670/*
671 * ####################################################################################################################
672 * API FUNCTIONS
673 * ####################################################################################################################
674 */
675
684PTX_API_LIBFUNC void *ptxIoTRd_Allocate_Stack (void);
685
696PTX_API_LIBFUNC uint16_t ptxIoTRd_Init_Stack (void *stackComp, ptxIoTRd_InitStack_Params_t *initStackParams);
697
717PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_Revision_Info (void *stackComp, ptxIoTRd_RevisionType_t revisionType, uint32_t * revisionInfo);
718
730PTX_API_LIBFUNC uint16_t ptxIoTRd_Enable_RT_Log (void *stackComp, uint8_t mode, const char *logFile);
731
732
744PTX_API_LIBFUNC uint16_t ptxIoTRd_Close_Stack (void *stackComp, char *logFile);
745
756PTX_API_LIBFUNC uint16_t ptxIoTRd_Init_NSC (void *stackComp, ptxIoTRd_NSCInitConfig_t *initConfig);
757
769PTX_API_LIBFUNC uint16_t ptxIoTRd_Update_ChipConfig (void *stackComp, uint8_t nrConfigs, ptxIoTRd_ChipConfig_t *configParams);
770
781PTX_API_LIBFUNC uint16_t ptxIoTRd_ConfigHBR (void *stackComp, ptxIoTRd_HBRConfig_t *configParams);
782
793PTX_API_LIBFUNC uint16_t ptxIoTRd_Initiate_Discovery (void *stackComp, ptxIoTRd_DiscConfig_t * discConfig);
794
805PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_Card_Registry (void *stackComp, ptxIoTRd_CardRegistry_t **cardRegistry);
806
818PTX_API_LIBFUNC uint16_t ptxIoTRd_Activate_Card (void *stackComp, ptxIoTRd_CardParams_t * cardParams, ptxIoTRd_CardProtocol_t protocol);
819
841PTX_API_LIBFUNC uint16_t ptxIoTRd_Data_Exchange (void *stackComp, uint8_t *tx, uint32_t txLength, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout);
842
857PTX_API_LIBFUNC uint16_t ptxIoTRd_Bits_Exchange_Mode (void *stackComp, uint8_t enable);
858
878PTX_API_LIBFUNC uint16_t ptxIoTRd_Bits_Exchange (void *stackComp, uint8_t *tx, uint8_t *txPar, uint32_t txLength,
879 uint8_t *rx, uint8_t *rxPar, uint32_t *rxLength, uint32_t *numTotBits, uint32_t msAppTimeout);
880
893PTX_API_LIBFUNC uint16_t ptxIoTRd_RF_PresenceCheck( void *stackComp, ptxIoTRd_CheckPresType_t presCheckType);
894
895
909PTX_API_LIBFUNC uint16_t ptxIoTRd_T5T_IsolatedEoF ( void *stackComp, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout);
910
927PTX_API_LIBFUNC uint16_t ptxIoTRd_T3T_SENSFRequest ( void *stackComp, uint16_t systemCode, uint8_t requestCode, uint8_t tsn,
928 uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout);
947PTX_API_LIBFUNC uint16_t ptxIoTRd_Reader_Deactivation (void *stackComp, uint8_t deactivationType);
948
965PTX_API_LIBFUNC uint16_t ptxIoTRd_Set_Power_Mode (void *stackComp, uint8_t newPowerMode);
966
981PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_System_Info (void *stackComp, ptxIoTRd_SysInfoType_t infoType, uint8_t *infoBuffer, uint32_t *infoBufferLength);
982
1005PTX_API_LIBFUNC uint16_t ptxIoTRd_TempSensor_Calibration (void *stackComp, uint8_t Tambient, uint8_t *Tshutdown);
1006
1016PTX_API_LIBFUNC uint16_t ptxIoTRd_SWReset (void *stackComp);
1017
1061PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_Status_Info (void *stackComp, ptxIoTRd_StatusType_t statusType, uint8_t *statusInfo);
1062
1070
1084PTX_API_LIBFUNC uint16_t ptxIoTRd_Set_RSSI_Mode (void *stackComp, ptxIoTRd_RSSI_Mode_t rssiMode, uint8_t *rssiRefreshPeriodInt);
1085
1097PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_RSSI_Value (void *stackComp, uint16_t *rssiValue);
1098
1109PTX_API_LIBFUNC uint16_t ptxIoTRd_Register_Extension(void *stackComp, uint8_t extensionID, ptxIoTRd_Extension_t *extension);
1110
1120PTX_API_LIBFUNC uint16_t ptxIoTRd_DeRegister_Extension(void *stackComp, uint8_t extensionID);
1121
1122#ifdef __cplusplus
1123}
1124#endif
1125
1128#endif /* Guard */
1129
enum ptxIoTRd_RSSI_Mode ptxIoTRd_RSSI_Mode_t
RSSI Mode.
PTX_API_LIBFUNC void * ptxIoTRd_Allocate_Stack(void)
Reserve memory for the main component of the stack, and return the allocated-memory as pointer to the...
struct ptxIoTRd_CardParams ptxIoTRd_CardParams_t
General Card Parameters (=> Card Registry Entry)
PTX_API_LIBFUNC uint16_t ptxIoTRd_TempSensor_Calibration(void *stackComp, uint8_t Tambient, uint8_t *Tshutdown)
Perform PTX1K integrated temperature sensor calibration and calculate calibrated temperature shutdown...
#define PTX_IOTRD_TECH_B_SENSB_MAX_SIZE
Definition ptx_IOT_READER.h:98
#define PTX_IOTRD_TECH_A_SENSRES_MAX_SIZE
Definition ptx_IOT_READER.h:96
enum ptxIoTRd_CheckPresType ptxIoTRd_CheckPresType_t
Type of Check Presence Mechanism.
ptxIoTRd_SysInfoType
System Info Identifiers.
Definition ptx_IOT_READER.h:304
struct ptxIoTRd_BitRates ptxIoTRd_BitRates_t
Available higher bitrate identifiers.
ptxIoTRd_RSSI_Mode
RSSI Mode.
Definition ptx_IOT_READER.h:620
PTX_API_LIBFUNC uint16_t ptxIoTRd_ConfigHBR(void *stackComp, ptxIoTRd_HBRConfig_t *configParams)
Configures HBR.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Update_ChipConfig(void *stackComp, uint8_t nrConfigs, ptxIoTRd_ChipConfig_t *configParams)
Updates the RF- and System-Configuration parameters of the NFC hardware.
PTX_API_LIBFUNC uint16_t ptxIoTRd_T3T_SENSFRequest(void *stackComp, uint16_t systemCode, uint8_t requestCode, uint8_t tsn, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout)
This function sends a polling-command (SENSF_REQ) to an already activated FeliCa/T3T card.
ptxIoTRd_CardRFTechType
Card RF-Technology Type.
Definition ptx_IOT_READER.h:355
enum ptxIoTRd_StatusType ptxIoTRd_StatusType_t
Generic Status / State Identifier.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Enable_RT_Log(void *stackComp, uint8_t mode, const char *logFile)
Enables / Disables the Realtime-Logging Feature i.e. every logging-entry will be immediately written ...
#define PTX_IOTRD_TECH_EXT_PARAM_MAX_SIZE
Definition ptx_IOT_READER.h:101
struct ptxIoTRd_ChipConfig ptxIoTRd_ChipConfig_t
Chip RF- and System-Configuration Identifiers.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Set_Power_Mode(void *stackComp, uint8_t newPowerMode)
Set reader power mode.
ptxStatus_t ptxIoTRd_Get_HCE_Component(void *stackComp, ptxHCE_t **hceComp)
Retrieves the HCE component from the stack.
uint16_t(* pExtProcessNTF_t)(void *extCtx, void *iotRdComp, void *nscEvent)
Extension Prototype (RFU): Handler for NTF Processing at API-level.
Definition ptx_IOT_READER.h:628
struct ptxIoTRd_CardFParams ptxIoTRd_CardFParams_t
RF-Technolgy Type-F Card Parameters.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Bits_Exchange(void *stackComp, uint8_t *tx, uint8_t *txPar, uint32_t txLength, uint8_t *rx, uint8_t *rxPar, uint32_t *rxLength, uint32_t *numTotBits, uint32_t msAppTimeout)
Exchanges Type-A RF-technology aligned raw RF bit-streams in state "DATA EXCHANGE" based on Cards / T...
struct ptxIoTRd_CardBParams ptxIoTRd_CardBParams_t
RF-Technolgy Type-B Card Parameters.
struct ptxIoTRd_CardAParams ptxIoTRd_CardAParams_t
RF-Technology Type-A Card Parameters.
#define PTX_IOTRD_MAX_SUPPORTED_RF_PROTOCOLS
Definition ptx_IOT_READER.h:94
PTX_API_LIBFUNC uint16_t ptxIoTRd_Close_Stack(void *stackComp, char *logFile)
Close the stack.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_RSSI_Value(void *stackComp, uint16_t *rssiValue)
This function reads the current RSSI-value.
struct ptxIoTRd_ComInterface_Params ptxIoTRd_ComInterface_Params_t
Parameters for Communication/Host Interface Initialization.
ptxIoTRd_ChipConfigID
Chip RF- and System-Configuration Identifiers.
Definition ptx_IOT_READER.h:255
#define PTX_IOTRD_TECH_F_SENSF_MAX_SIZE
Definition ptx_IOT_READER.h:99
struct ptxIoTRd_SupportedRFProt ptxIoTRd_SupportedRFProt_t
Card Supported RF-Protocols.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Init_NSC(void *stackComp, ptxIoTRd_NSCInitConfig_t *initConfig)
Initialize NSC.
enum ptxIoTRd_CardProtocol ptxIoTRd_CardProtocol_t
Card RF-Protocol Type.
ptxIoTRd_RevisionType
NSC Revision-Info Types.
Definition ptx_IOT_READER.h:241
PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_Revision_Info(void *stackComp, ptxIoTRd_RevisionType_t revisionType, uint32_t *revisionInfo)
Get various revisions of system (C-Stack, DFY-Code/-Toolchain, Chip-ID, Local changes,...
PTX_API_LIBFUNC uint16_t ptxIoTRd_DeRegister_Extension(void *stackComp, uint8_t extensionID)
De-Register an IoT-Extension (Prototype/RFU).
struct ptxIoTRd_CardRegistry ptxIoTRd_CardRegistry_t
Card Registry structure.
PTX_API_LIBFUNC uint16_t ptxIoTRd_RF_PresenceCheck(void *stackComp, ptxIoTRd_CheckPresType_t presCheckType)
Check the presence of Activated Card.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Set_RSSI_Mode(void *stackComp, ptxIoTRd_RSSI_Mode_t rssiMode, uint8_t *rssiRefreshPeriodInt)
This function puts the system / stack into RSSI-mode or deactivates the RSSI-mode.
struct ptxIoTRd_DiscConfigTypeFPollCmdParams ptxIoTRd_DiscConfigTypeFPollCmdParams_t
Custom Type-F Polling Command Parameters.
#define PTX_IOTRD_TECH_A_NFCID1_MAX_SIZE
Definition ptx_IOT_READER.h:97
ptxIoTRd_StatusType
Generic Status / State Identifier.
Definition ptx_IOT_READER.h:607
struct ptxIoTRd_HBRConfig_Int ptxIoTRd_HBRConfig_Int_t
Available higher bitrates in Rx- and Tx-direction.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Register_Extension(void *stackComp, uint8_t extensionID, ptxIoTRd_Extension_t *extension)
Register an IoT-Extension (Prototype/RFU).
enum ptxIoTRd_SysInfoType ptxIoTRd_SysInfoType_t
System Info Identifiers.
struct ptxIoTRd_InitStack_Params ptxIoTRd_InitStack_Params_t
Structure containing stack initialization parameters directly set by the user.
enum ptxIoTRd_ChipConfigID ptxIoTRd_ChipConfigID_t
Chip RF- and System-Configuration Identifiers.
#define PTX_IOTRD_HIGH_LEVEL_PROT_MAX_SIZE
Definition ptx_IOT_READER.h:106
enum ptxIoTRd_CardRFTechType ptxIoTRd_CardRFTechType_t
Card RF-Technology Type.
#define PTX_IOTRD_MAX_SUPPORTED_DEVICES
Definition ptx_IOT_READER.h:93
struct ptxIoTRd_DiscConfig ptxIoTRd_DiscConfig_t
Configuration for RF-Discovery Loop.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Init_Stack(void *stackComp, ptxIoTRd_InitStack_Params_t *initStackParams)
Initialize the stack.
uint16_t(* pExtActivateCMD_t)(void *extCtx, void *iotRdComp, ptxIoTRd_CardParams_t *cardParams, ptxIoTRd_CardProtocol_t protocol)
Extension Prototype (RFU): Handler for Activate-/Select-Command Processing at API-level.
Definition ptx_IOT_READER.h:633
PTX_API_LIBFUNC uint16_t ptxIoTRd_Data_Exchange(void *stackComp, uint8_t *tx, uint32_t txLength, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout)
Exchange data with an already activated card.
struct ptxIoTRd_HBRConfig ptxIoTRd_HBRConfig_t
Higher bitrate configuration.
ptxIoTRd_CheckPresType
Type of Check Presence Mechanism.
Definition ptx_IOT_READER.h:598
ptxIoTRd_CardProtocol
Card RF-Protocol Type.
Definition ptx_IOT_READER.h:368
struct ptxIoTRd_CardExtensionParams ptxIoTRd_CardExtensionParams_t
RF-Technolgy Extension Card Parameters (Prototype/RFU)
PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_Status_Info(void *stackComp, ptxIoTRd_StatusType_t statusType, uint8_t *statusInfo)
Get various status- and state-information.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Activate_Card(void *stackComp, ptxIoTRd_CardParams_t *cardParams, ptxIoTRd_CardProtocol_t protocol)
Activates a specific card.
union ptxIoTRd_CardTechParams ptxIoTRd_CardTechParams_t
General Card RF-Technology specific Parameters.
PTX_API_LIBFUNC uint16_t ptxIoTRd_T5T_IsolatedEoF(void *stackComp, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout)
This function sends EoF command to a T5T activated card and waits for an answer.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Bits_Exchange_Mode(void *stackComp, uint8_t enable)
Enable or disable Bits Exchange Option.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Reader_Deactivation(void *stackComp, uint8_t deactivationType)
Perform generic reader deactivation.
enum ptxIoTRd_RevisionType ptxIoTRd_RevisionType_t
NSC Revision-Info Types.
PTX_API_LIBFUNC uint16_t ptxIoTRd_SWReset(void *stackComp)
SW Reset.
struct ptxIoTRd_CardVParams ptxIoTRd_CardVParams_t
RF-Technolgy Type-V Card Parameters.
#define PTX_IOTRD_TECH_V_UID_MAX_SIZE
Definition ptx_IOT_READER.h:100
struct ptxIoTRd_NSCInitConfig ptxIoTRd_NSCInitConfig_t
Configuration for NSC Init.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_Card_Registry(void *stackComp, ptxIoTRd_CardRegistry_t **cardRegistry)
Access the internal card registry.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Initiate_Discovery(void *stackComp, ptxIoTRd_DiscConfig_t *discConfig)
Initiate RF-Discovery according to NFC-Forum.
PTX_API_LIBFUNC uint16_t ptxIoTRd_Get_System_Info(void *stackComp, ptxIoTRd_SysInfoType_t infoType, uint8_t *infoBuffer, uint32_t *infoBufferLength)
Get System-internal Information.
@ RSSI_Mode_Enabled
Definition ptx_IOT_READER.h:621
@ RSSI_Mode_Disabled
Definition ptx_IOT_READER.h:622
@ PresCheck_A
Definition ptx_IOT_READER.h:599
@ PresCheck_B
Definition ptx_IOT_READER.h:600
uint16_t ptxStatus_t
Status Type.
Definition ptx_Status.h:82
Main Component Struture.
Definition ptxHce.h:175
Available higher bitrate identifiers.
Definition ptx_IOT_READER.h:325
uint8_t BitRate212
Definition ptx_IOT_READER.h:328
uint8_t BitRate424
Definition ptx_IOT_READER.h:327
uint8_t BitRate848
Definition ptx_IOT_READER.h:326
RF-Technology Type-A Card Parameters.
Definition ptx_IOT_READER.h:503
uint8_t NFCID1_LEN
Definition ptx_IOT_READER.h:505
uint8_t SENS_RES[PTX_IOTRD_TECH_A_SENSRES_MAX_SIZE]
Definition ptx_IOT_READER.h:504
uint8_t NFCID1[PTX_IOTRD_TECH_A_NFCID1_MAX_SIZE]
Definition ptx_IOT_READER.h:506
uint8_t SEL_RES
Definition ptx_IOT_READER.h:508
uint8_t SEL_RES_LEN
Definition ptx_IOT_READER.h:507
RF-Technolgy Type-B Card Parameters.
Definition ptx_IOT_READER.h:515
uint8_t SENSB_RES[PTX_IOTRD_TECH_B_SENSB_MAX_SIZE]
Definition ptx_IOT_READER.h:516
RF-Technolgy Extension Card Parameters (Prototype/RFU)
Definition ptx_IOT_READER.h:542
uint8_t Param[PTX_IOTRD_TECH_EXT_PARAM_MAX_SIZE]
Definition ptx_IOT_READER.h:545
uint8_t ParamLength
Definition ptx_IOT_READER.h:544
uint16_t Flags
Definition ptx_IOT_READER.h:543
RF-Technolgy Type-F Card Parameters.
Definition ptx_IOT_READER.h:523
uint8_t SENSF_RES[PTX_IOTRD_TECH_F_SENSF_MAX_SIZE]
Definition ptx_IOT_READER.h:525
uint8_t SENSF_RES_LEN
Definition ptx_IOT_READER.h:524
General Card Parameters (=> Card Registry Entry)
Definition ptx_IOT_READER.h:573
ptxIoTRd_SupportedRFProt_t SupportedProtocols
Definition ptx_IOT_READER.h:576
ptxIoTRd_CardTechParams_t TechParams
Definition ptx_IOT_READER.h:575
ptxIoTRd_CardRFTechType_t TechType
Definition ptx_IOT_READER.h:574
uint8_t DeviceState
Definition ptx_IOT_READER.h:577
Card Registry structure.
Definition ptx_IOT_READER.h:584
ptxIoTRd_CardParams_t * ActiveCard
Definition ptx_IOT_READER.h:587
ptxIoTRd_CardParams_t Cards[PTX_IOTRD_MAX_SUPPORTED_DEVICES]
Definition ptx_IOT_READER.h:585
uint8_t ActiveCardProtInfo[PTX_IOTRD_HIGH_LEVEL_PROT_MAX_SIZE]
Definition ptx_IOT_READER.h:590
uint8_t ActiveCardProtInfoLen
Definition ptx_IOT_READER.h:589
ptxIoTRd_CardProtocol_t ActiveCardProtType
Definition ptx_IOT_READER.h:588
uint8_t ActiveCardProtSpeed
Definition ptx_IOT_READER.h:591
uint8_t NrCards
Definition ptx_IOT_READER.h:586
RF-Technolgy Type-V Card Parameters.
Definition ptx_IOT_READER.h:532
uint8_t DSFID
Definition ptx_IOT_READER.h:534
uint8_t UID[PTX_IOTRD_TECH_V_UID_MAX_SIZE]
Definition ptx_IOT_READER.h:535
uint8_t RES_FLAG
Definition ptx_IOT_READER.h:533
Chip RF- and System-Configuration Identifiers.
Definition ptx_IOT_READER.h:313
uint8_t * Value
Definition ptx_IOT_READER.h:315
uint8_t Length
Definition ptx_IOT_READER.h:316
ptxIoTRd_ChipConfigID_t ID
Definition ptx_IOT_READER.h:314
Parameters for Communication/Host Interface Initialization.
Definition ptx_IOT_READER.h:652
uint8_t InterfaceType
Definition ptx_IOT_READER.h:653
char * Name
Definition ptx_IOT_READER.h:654
uint32_t GPIONum
Definition ptx_IOT_READER.h:657
uint8_t DeviceAddress
Definition ptx_IOT_READER.h:656
uint32_t Speed
Definition ptx_IOT_READER.h:655
Configuration for RF-Discovery Loop.
Definition ptx_IOT_READER.h:395
uint8_t PollBailOutFlags
Definition ptx_IOT_READER.h:434
uint8_t EnableIsoPollMode
Definition ptx_IOT_READER.h:473
uint8_t EnableExtdAtqB
Definition ptx_IOT_READER.h:476
uint8_t PollTypeVDeviceLimit
Definition ptx_IOT_READER.h:431
uint8_t EnableLPCDNotification
Definition ptx_IOT_READER.h:461
uint8_t PollTypeF424
Definition ptx_IOT_READER.h:419
uint8_t * conPollNfcDepAtrReqG
Definition ptx_IOT_READER.h:449
uint8_t DisableNfcDepProtocol
Definition ptx_IOT_READER.h:446
uint8_t PollTypeA
Definition ptx_IOT_READER.h:404
uint8_t DisableIsoDepProtocol
Definition ptx_IOT_READER.h:443
uint8_t PollTypeADeviceLimit
Definition ptx_IOT_READER.h:407
uint8_t PollGuardTime
Definition ptx_IOT_READER.h:464
uint8_t EnableHbr
Definition ptx_IOT_READER.h:470
uint8_t PollTypeV
Definition ptx_IOT_READER.h:428
uint8_t EnableStandBy
Definition ptx_IOT_READER.h:458
uint8_t AfiValue
Definition ptx_IOT_READER.h:479
uint8_t PollTypeB
Definition ptx_IOT_READER.h:410
uint8_t conPollNfcDepAtrReqGLen
Definition ptx_IOT_READER.h:452
uint8_t ListenTypeA
Definition ptx_IOT_READER.h:467
uint8_t PollTypeFDeviceLimit
Definition ptx_IOT_READER.h:425
uint8_t PollTypeBDeviceLimit
Definition ptx_IOT_READER.h:413
ptxIoTRd_CardRFTechType_t PollStartTechnology
Definition ptx_IOT_READER.h:440
uint32_t IdleTime
Definition ptx_IOT_READER.h:455
uint8_t PollTypeF212
Definition ptx_IOT_READER.h:416
uint8_t Discover_Mode
Definition ptx_IOT_READER.h:401
ptxIoTRd_DiscConfigTypeFPollCmdParams_t PollTypeFCmdParams
Definition ptx_IOT_READER.h:422
Custom Type-F Polling Command Parameters.
Definition ptx_IOT_READER.h:384
uint8_t InitialTimeSlotNr
Definition ptx_IOT_READER.h:388
uint8_t OverwriteDefaultParams
Definition ptx_IOT_READER.h:385
uint8_t RequestCode
Definition ptx_IOT_READER.h:387
uint8_t SystemCode[2]
Definition ptx_IOT_READER.h:386
Definition ptx_IOT_READER.h:640
pExtActivateCMD_t CBFnExtActivateCmd
Definition ptx_IOT_READER.h:643
pExtProcessNTF_t CBFnExtProcessNtf
Definition ptx_IOT_READER.h:642
uint8_t ExtensionID
Definition ptx_IOT_READER.h:641
void * ExtensionCtx
Definition ptx_IOT_READER.h:644
Available higher bitrates in Rx- and Tx-direction.
Definition ptx_IOT_READER.h:336
ptxIoTRd_BitRates_t Rx
Definition ptx_IOT_READER.h:337
ptxIoTRd_BitRates_t Tx
Definition ptx_IOT_READER.h:338
Higher bitrate configuration.
Definition ptx_IOT_READER.h:346
ptxIoTRd_HBRConfig_Int_t PollA
Definition ptx_IOT_READER.h:347
ptxIoTRd_HBRConfig_Int_t PollB
Definition ptx_IOT_READER.h:348
Structure containing stack initialization parameters directly set by the user.
Definition ptx_IOT_READER.h:664
char * FileSystemPath
Definition ptx_IOT_READER.h:666
ptxIoTRd_ComInterface_Params_t ComInterface
Definition ptx_IOT_READER.h:665
Configuration for NSC Init.
Definition ptx_IOT_READER.h:491
uint8_t CalibratedTempThreshold
Definition ptx_IOT_READER.h:493
struct ptxNSC_RfConfig_Param * RfConfigParameter
Definition ptx_IOT_READER.h:495
Card Supported RF-Protocols.
Definition ptx_IOT_READER.h:564
uint8_t NrRFProtocols
Definition ptx_IOT_READER.h:566
ptxIoTRd_CardProtocol_t RFProtocol[PTX_IOTRD_MAX_SUPPORTED_RF_PROTOCOLS]
Definition ptx_IOT_READER.h:565
NSC Rf Config Parameters.
Definition ptxNSC_InterfaceTypes.h:531
General Card RF-Technology specific Parameters.
Definition ptx_IOT_READER.h:552
ptxIoTRd_CardBParams_t CardBParams
Definition ptx_IOT_READER.h:554
ptxIoTRd_CardVParams_t CardVParams
Definition ptx_IOT_READER.h:556
ptxIoTRd_CardAParams_t CardAParams
Definition ptx_IOT_READER.h:553
ptxIoTRd_CardExtensionParams_t CardExtParams
Definition ptx_IOT_READER.h:557
ptxIoTRd_CardFParams_t CardFParams
Definition ptx_IOT_READER.h:555