Renesas PTX1xxR IoT-Reader API (non-OS) Version 7.3.1
Renesas Software Stack for IoT-Reader Applications (non-OS)
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#include "ptxStatus.h"
58#include "ptxHce.h"
59#include "ptxNSC.h"
60#include <stddef.h>
61
62#ifdef __cplusplus
63extern "C" {
64#endif
65
66/*
67 * ####################################################################################################################
68 * DEFINES / TYPES
69 * ####################################################################################################################
70 */
71
75struct ptxPlat;
76struct ptxNSC;
77
78#define PTX_IOTRD_MAX_SUPPORTED_DEVICES (uint8_t)50
79#define PTX_IOTRD_MAX_SUPPORTED_RF_PROTOCOLS (uint8_t)4
81#define PTX_IOTRD_TECH_A_SENSRES_MAX_SIZE (uint8_t)2
82#define PTX_IOTRD_TECH_A_NFCID1_MAX_SIZE (uint8_t)10
83#define PTX_IOTRD_TECH_B_SENSB_MAX_SIZE (uint8_t)13
84#define PTX_IOTRD_TECH_F_SENSF_MAX_SIZE (uint8_t)20
85#define PTX_IOTRD_TECH_V_UID_MAX_SIZE (uint8_t)8
86#define PTX_IOTRD_TECH_EXT_PARAM_MAX_SIZE (uint8_t)32
88#define PTX_IOTRD_PROT_ISO_DEP_ATS_MAX_SIZE (uint8_t)21
89#define PTX_IOTRD_PROT_ISO_DEP_ATTRIB_RES_MAX_SIZE (uint8_t)16
90#define PTX_IOTRD_PROT_NFC_DEP_ATR_RES_MAX_SIZE (uint8_t)65
91#define PTX_IOTRD_HIGH_LEVEL_PROT_MAX_SIZE PTX_IOTRD_PROT_NFC_DEP_ATR_RES_MAX_SIZE
93#define PTX_IOTRD_RF_BAILOUT_TECH_A (uint8_t)1
94#define PTX_IOTRD_RF_BAILOUT_TECH_B (uint8_t)2
95#define PTX_IOTRD_RF_BAILOUT_TECH_F (uint8_t)4
102#define RF_DISCOVER_STATUS_NO_CARD (uint8_t)0
103#define RF_DISCOVER_STATUS_CARD_ACTIVE (uint8_t)1
104#define RF_DISCOVER_STATUS_DISCOVER_RUNNING (uint8_t)2
105#define RF_DISCOVER_STATUS_DISCOVER_DONE (uint8_t)3
106#define RF_DISCOVER_STATUS_LISTEN_A (uint8_t)4
107#define RF_DISCOVER_STATUS_DISCOVER_UNDEFINED (uint8_t)0xFF
115#define RF_LPCD_STATUS_NO_DEVICE (uint8_t)0
116#define RF_LPCD_STATUS_DEVICE_FOUND (uint8_t)1
124#define PTX_IOTRD_RF_MSG_MAX_SIZE (512U)
126#define PTX_IOTRD_RF_DEACTIVATION_TYPE_IDLE (uint8_t)0
127#define PTX_IOTRD_RF_DEACTIVATION_TYPE_DISCOVER (uint8_t)1
128#define PTX_IOTRD_RF_DEACTIVATION_TYPE_SLEEP (uint8_t)2
129#define PTX_IOTRD_RF_DEACTIVATION_TYPE_SLEEP_NON_BLOCKING (uint8_t)3
130#define PTX_IOTRD_RF_DEACTIVATION_TYPE_NO_RF_RESET (uint8_t)4
131#define PTX_IOTRD_RF_DEACTIVATION_TYPE_IDLE_PROTOCOL (uint8_t)5
132#define PTX_IOTRD_RF_DEACTIVATION_TYPE_DISCOVER_PROTOCOL (uint8_t)6
135#define PTX_IOTRD_RF_DEACTIVATION_SLEEP_ONGOING (uint8_t)0
136#define PTX_IOTRD_RF_DEACTIVATION_SLEEP_DONE (uint8_t)1
144#define PTX_SYSTEM_STATUS_OK (uint8_t)0
145#define PTX_SYSTEM_STATUS_ERR_OVERCURRENT (uint8_t)1
146#define PTX_SYSTEM_STATUS_ERR_TEMPERATURE (uint8_t)2
154#define PTX_RF_ERROR_NTF_CODE_NO_ERROR (uint8_t)0x00
155#define PTX_RF_ERROR_NTF_CODE_UNKNOWN_ERROR (uint8_t)0xFF
156#define PTX_RF_ERROR_NTF_CODE_WARNING_PA_OVERCURRENT_LIMIT (uint8_t)0x09
157#define PTX_RF_ERROR_NTF_CODE_ERR_EMV_COLL (uint8_t)0x11
158#define PTX_RF_ERROR_NTF_CODE_ERR_TIMEOUT (uint8_t)0x12
159#define PTX_RF_ERROR_NTF_CODE_ERR_TRANSMISSION (uint8_t)0x13
160#define PTX_RF_ERROR_NTF_CODE_ERR_PROTOCOL (uint8_t)0x14
168#define PTX_HW_PRODUCT_ID_PTX100X (uint8_t)0x00
169#define PTX_HW_PRODUCT_ID_PTX105X (uint8_t)0x01
170#define PTX_HW_PRODUCT_ID_PTX130X (uint8_t)0x02
178#define PTX_IOTRD_HOST_SPEED_I2C_100000 (100000UL)
179#define PTX_IOTRD_HOST_SPEED_I2C_400000 (400000UL)
180#define PTX_IOTRD_HOST_SPEED_I2C_1000000 (1000000UL)
181#define PTX_IOTRD_HOST_SPEED_I2C_3400000 (3400000UL)
182#define PTX_IOTRD_HOST_SPEED_I2C_MAX PTX_IOTRD_HOST_SPEED_I2C_3400000
190#define PTX_IOTRD_HOST_SPEED_UART_9600 (9600UL)
191#define PTX_IOTRD_HOST_SPEED_UART_14400 (14400UL)
192#define PTX_IOTRD_HOST_SPEED_UART_19200 (19200UL)
193#define PTX_IOTRD_HOST_SPEED_UART_28800 (28800UL)
194#define PTX_IOTRD_HOST_SPEED_UART_38400 (38400UL)
195#define PTX_IOTRD_HOST_SPEED_UART_57600 (57600UL)
196#define PTX_IOTRD_HOST_SPEED_UART_115200 (115200UL)
197#define PTX_IOTRD_HOST_SPEED_UART_230400 (230400UL)
198#define PTX_IOTRD_HOST_SPEED_UART_460800 (460800UL)
199#define PTX_IOTRD_HOST_SPEED_UART_921600 (921600UL)
200#define PTX_IOTRD_HOST_SPEED_UART_1843200 (1843200UL)
201#define PTX_IOTRD_HOST_SPEED_UART_3000000 (3000000UL)
202#define PTX_IOTRD_HOST_SPEED_UART_MAX PTX_IOTRD_HOST_SPEED_UART_3000000
210#define PTX_IOTRD_HOST_SPEED_SPI_1M (1000000UL)
211#define PTX_IOTRD_HOST_SPEED_SPI_5M (5000000UL)
212#define PTX_IOTRD_HOST_SPEED_SPI_10M (10000000UL)
213#define PTX_IOTRD_HOST_SPEED_SPI_MAX PTX_IOTRD_HOST_SPEED_SPI_10M
221#define PTX_IOTRD_MAX_EXTENSIONS (1u)
224#define PTX_IOTRD_MAX_RF_CONFIG_TLVS (10u)
226/*
227 * ####################################################################################################################
228 * TYPES
229 * ####################################################################################################################
230 */
231
236{
237 RevInfo_C_Stack,
238 RevInfo_Local_Changes,
239 RevInfo_DFY_Code,
240 RevInfo_DFY_Toolchain,
241 RevInfo_ChipID,
242 RevInfo_ProductID,
243
245
250{
251 /* RF-Configuration IDs */
252 RF_Wavebank_0,
253 RF_Wavebank_1,
254 RF_Wavebank_2,
255 RF_Wavebank_3,
256 RF_Wavebank_4,
257 RF_Wavebank_5,
258 RF_Wavebank_6,
259 RF_Wavebank_7,
260 RF_Wavebank_8,
261 RF_Wavebank_9,
262 RF_Wavebank_10,
263 RF_Wavebank_11,
264 RF_Wavebank_12,
265 RF_Wavebank_13,
266 RF_Wavebank_14,
267 RF_Wavebank_15,
268 RF_Wavebank_16,
269 RF_Wavebank_17,
270 RF_Wavebank_18,
271 RF_Wavebank_19,
272 RF_Misc,
273 RF_PollA106,
274 RF_PollA212,
275 RF_PollA424,
276 RF_PollA848,
277 RF_PollB106,
278 RF_PollB212,
279 RF_PollB424,
280 RF_PollB848,
281 RF_PollF212,
282 RF_PollF424,
283 RF_PollV,
284 RF_Listen,
285 RF_LAST_RF_CONFIG_ENTRY,
286
287 /* System-Configuration IDs */
288 SYS_ThermalThreshold = 100,
289 SYS_OvercurrentThreshold,
290 SYS_ConClockSrc,
291 SYS_ConVarLBS,
292 SYS_ConNHost,
293 SYS_ConNHosCE,
294
296
301{
302 SysInfo_VDPA_Calibration_Result,
303
305
316
317
326
336
345
355
365
373
383
392
401
411
422
432
442
447{
448 Tech_TypeA = 0,
449 Tech_TypeB = 1,
450 Tech_TypeF = 2,
451 Tech_TypeV = 6,
452 Tech_TypeExtension = 10,
454
459{
460 Prot_Undefined = 0,
461 Prot_T2T = 2,
462 Prot_T3T = 3,
463 Prot_ISODEP = 4,
464 Prot_NFCDEP = 5,
465 Prot_T5T = 6,
466 Prot_Extension = 10,
468
481
576
577
589
597
606
616
626
638
643{
644 StatusType_System,
645 StatusType_Discover,
646 StatusType_DeactivateSleep,
647 StatusType_LastRFError,
648 StatusType_LPCDNtfCounter,
649 StatusType_Lpcd,
651
660
671
685
690{
691 RfMsg_NotReceived,
692 RfMsg_RfMsg_Rcv,
693 RfMsg_RfMsg_Chained_Rcv,
694 RfMsg_RfError,
695 RfMsg_RfErrorTimeOut,
696 RfMsg_CtrlAck,
697 RfMsg_CtrlAttCmd,
698 RfMsg_RfClt
700
709
718
731
735typedef ptxStatus_t (*pExtProcessNTF_t)(void *extCtx, void *iotRdComp, void *nscEvent);
736
740typedef ptxStatus_t (*pExtActivateCMD_t)(void *extCtx, void *iotRdComp, ptxIoTRd_CardParams_t *cardParams, ptxIoTRd_CardProtocol_t protocol);
741
752
779
780
781/*
782 * ####################################################################################################################
783 * API FUNCTIONS
784 * ####################################################################################################################
785 */
786
798
811
812
824
825
840
852
872ptxStatus_t ptxIoTRd_Get_Revision_Info (ptxIoTRd_t *iotRd, ptxIoTRd_RevisionType_t revisionType, uint32_t * revisionInfo);
873
874
886
887
900
901
923ptxStatus_t ptxIoTRd_Data_Exchange (ptxIoTRd_t *iotRd, uint8_t *tx, uint32_t txLength, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout);
924
925
941
962ptxStatus_t ptxIoTRd_Bits_Exchange (ptxIoTRd_t *iotRd, uint8_t *tx, uint8_t *txPar, size_t txLength,
963 uint8_t *rx, uint8_t *rxPar, size_t *rxLength, size_t *numTotBits, uint32_t msTimeout);
964
965
978
979
993ptxStatus_t ptxIoTRd_T5T_IsolatedEoF (ptxIoTRd_t *iotRd, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout);
994
1011ptxStatus_t ptxIoTRd_T3T_SENSFRequest (ptxIoTRd_t *iotRd, uint16_t systemCode, uint8_t requestCode, uint8_t tsn, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout);
1012
1030ptxStatus_t ptxIoTRd_Reader_Deactivation (ptxIoTRd_t *iotRd, uint8_t deactivationType);
1031
1048ptxStatus_t ptxIoTRd_Set_Power_Mode (ptxIoTRd_t *iotRd, uint8_t newPowerMode);
1049
1050
1065ptxStatus_t ptxIoTRd_Get_System_Info (ptxIoTRd_t *iotRd, ptxIoTRd_SysInfoType_t infoType, uint8_t *infoBuffer, uint8_t *infoBufferLength);
1066
1079
1091
1133
1156ptxStatus_t ptxIoTRd_TempSensor_Calibration (ptxIoTRd_t *iotRd, uint8_t Tambient, uint8_t *Tshutdown);
1157
1171ptxStatus_t ptxIoTRd_Set_RSSI_Mode (ptxIoTRd_t *iotRd, ptxIoTRd_RSSI_Mode_t rssiMode, uint8_t *rssiRefreshPeriodInt);
1172
1184ptxStatus_t ptxIoTRd_Get_RSSI_Value (ptxIoTRd_t *iotRd, uint16_t *rssiValue);
1185
1197
1208
1209#ifdef __cplusplus
1210}
1211#endif
1212
1213#endif /* Guard */
1214
ptxStatus_t ptxIoTRd_InitNSC(ptxIoTRd_t *iotRd, ptxIoTRd_ComInterface_Params_t *initParams)
Initializes the NSC component.
enum ptxIoTRd_RSSI_Mode ptxIoTRd_RSSI_Mode_t
RSSI Mode.
struct ptxIoTRd_ProtILimiterSettings ptxIoTRd_ProtILimiterSettings_t
External Protection Limiter Parameters (WLC only, to be ignored for stand-alone IoT-operation).
ptxStatus_t(* pExtProcessNTF_t)(void *extCtx, void *iotRdComp, void *nscEvent)
Extension Prototype (RFU): Handler for NTF Processing at API-level.
Definition ptx_IOT_READER.h:735
ptxStatus_t ptxIoTRd_T5T_IsolatedEoF(ptxIoTRd_t *iotRd, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout)
This function sends EoF command to a T5T activated card and waits for an answer.
ptxStatus_t ptxIoTRd_Register_Extension(ptxIoTRd_t *iotRd, uint8_t extensionID, ptxIoTRd_Extension_t *extension)
Register an IoT-Extension (Prototype/RFU).
struct ptxIoTRd_CardParams ptxIoTRd_CardParams_t
General Card Parameters (=> Card Registry Entry)
ptxIoTRd_ProtType
External Protection Type Parameters (WLC only, to be ignored for stand-alone IoT-operation).
Definition ptx_IOT_READER.h:360
#define PTX_IOTRD_MAX_EXTENSIONS
Definition ptx_IOT_READER.h:221
#define PTX_IOTRD_TECH_B_SENSB_MAX_SIZE
Definition ptx_IOT_READER.h:83
#define PTX_IOTRD_TECH_A_SENSRES_MAX_SIZE
Definition ptx_IOT_READER.h:81
enum ptxIoTRd_CheckPresType ptxIoTRd_CheckPresType_t
Type of Check Presence Mechanism.
ptxIoTRd_SysInfoType
NSC System-Info Types.
Definition ptx_IOT_READER.h:301
struct ptxIoTRd_BitRates ptxIoTRd_BitRates_t
Available higher bitrate identifiers.
ptxStatus_t ptxIoTRd_Update_ChipConfig(ptxIoTRd_t *iotRd, uint8_t nrConfigs, ptxIoTRd_ChipConfig_t *configParams)
Updates the RF- and System-Configuration parameters of the NFC hardware.
ptxIoTRd_RSSI_Mode
RSSI Mode.
Definition ptx_IOT_READER.h:714
struct ptxIoTRd_ProtISensorSettings ptxIoTRd_ProtISensorSettings_t
External Current Sensor Parameters (WLC only, to be ignored for stand-alone IoT-operation).
struct ptxIoTRd_Protection_Params ptxIoTRd_Protection_Params_t
External Protection Parameters (WLC only, to be ignored for stand-alone IoT-operation).
ptxStatus_t ptxIoTRd_RF_PresenceCheck(ptxIoTRd_t *iotRd, ptxIoTRd_CheckPresType_t presCheckType)
Check the presence of an activated Card.
ptxStatus_t ptxIoTRd_Set_RSSI_Mode(ptxIoTRd_t *iotRd, ptxIoTRd_RSSI_Mode_t rssiMode, uint8_t *rssiRefreshPeriodInt)
This function puts the system / stack into RSSI-mode or deactivates the RSSI-mode.
ptxIoTRd_CardRFTechType
Card RF-Technology Type.
Definition ptx_IOT_READER.h:447
ptxStatus_t ptxIoTRd_SWReset(ptxIoTRd_t *iotRd)
SW Reset.
enum ptxIoTRd_StatusType ptxIoTRd_StatusType_t
Generic Status / State Identifier.
#define PTX_IOTRD_TECH_EXT_PARAM_MAX_SIZE
Definition ptx_IOT_READER.h:86
struct ptxIoTRd_ChipConfig ptxIoTRd_ChipConfig_t
Chip RF- and System-Configuration Identifiers.
ptxStatus_t ptxIoTRd_DeRegister_Extension(ptxIoTRd_t *iotRd, uint8_t extensionID)
De-Register an IoT-Extension (Prototype/RFU).
ptxStatus_t ptxIoTRd_Reader_Deactivation(ptxIoTRd_t *iotRd, uint8_t deactivationType)
Perform generic Reader deactivation.
ptxStatus_t ptxIoTRd_ConfigHBR(ptxIoTRd_t *iotRd, ptxIoTRd_HBRConfig_t *configParams)
Configures HBR.
struct ptxIoTRd_CardFParams ptxIoTRd_CardFParams_t
RF-Technolgy Type-F Card Parameters.
ptxStatus_t ptxIoTRd_Get_Card_Registry(ptxIoTRd_t *iotRd, ptxIoTRd_CardRegistry_t **cardRegistry)
Access the internal card registry.
struct ptxIoTRd_CardBParams ptxIoTRd_CardBParams_t
RF-Technolgy Type-B Card Parameters.
enum ptxIoTRd_ProtAttenuation ptxIoTRd_ProtAttenuation_t
External Protection Attenuation Parameters (WLC only, to be ignored for stand-alone IoT-operation).
struct ptxIoTRd_CardAParams ptxIoTRd_CardAParams_t
RF-Technology Type-A Card Parameters.
ptxStatus_t ptxIoTRd_Bits_Exchange(ptxIoTRd_t *iotRd, uint8_t *tx, uint8_t *txPar, size_t txLength, uint8_t *rx, uint8_t *rxPar, size_t *rxLength, size_t *numTotBits, uint32_t msTimeout)
Exchanges Type-A RF-technology aligned raw RF bit-streams in state "DATA EXCHANGE" based on Cards / T...
#define PTX_IOTRD_MAX_SUPPORTED_RF_PROTOCOLS
Definition ptx_IOT_READER.h:79
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:250
struct ptxIoTRd_TempSense_Params ptxIoTRd_TempSense_Params_t
Parameters for Temperature Sensor Initialization.
#define PTX_IOTRD_TECH_F_SENSF_MAX_SIZE
Definition ptx_IOT_READER.h:84
struct ptxIoTRd_SupportedRFProt ptxIoTRd_SupportedRFProt_t
Card Supported RF-Protocols.
enum ptxIoTRd_ProtType ptxIoTRd_ProtType_t
External Protection Type Parameters (WLC only, to be ignored for stand-alone IoT-operation).
ptxStatus_t ptxIoTRd_Activate_Card(ptxIoTRd_t *iotRd, ptxIoTRd_CardParams_t *cardParams, ptxIoTRd_CardProtocol_t protocol)
Activates a specific card.
enum ptxIoTRd_CardProtocol ptxIoTRd_CardProtocol_t
Card RF-Protocol Type.
union ptxIoTRd_ProtSettings ptxIoTRd_ProtSettings_t
External Protection Settings (WLC only, to be ignored for stand-alone IoT-operation).
ptxIoTRd_RevisionType
NSC Revision-Info Types.
Definition ptx_IOT_READER.h:236
struct ptxIoTRd_CardRegistry ptxIoTRd_CardRegistry_t
Card Registry structure.
ptxStatus_t ptxIoTRd_Get_Revision_Info(ptxIoTRd_t *iotRd, ptxIoTRd_RevisionType_t revisionType, uint32_t *revisionInfo)
Get various revisions of system (C-Stack, DFY-Code/-Toolchain, Chip-ID, Local changes,...
ptxStatus_t ptxIoTRd_Init(ptxIoTRd_t *iotRd, ptxIoTRd_InitPars_t *initParams)
Initialize the IoT Reader Component and the PTX1K.
ptxStatus_t ptxIoTRd_Get_RSSI_Value(ptxIoTRd_t *iotRd, uint16_t *rssiValue)
This function reads the current RSSI-value.
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:82
ptxIoTRd_StatusType
Generic Status / State Identifier.
Definition ptx_IOT_READER.h:643
ptxStatus_t ptxIoTRd_Set_Power_Mode(ptxIoTRd_t *iotRd, uint8_t newPowerMode)
Set reader power mode.
struct ptxIoTRd_HBRConfig_Int ptxIoTRd_HBRConfig_Int_t
Available higher bitrates in Rx- and Tx-direction.
enum ptxIoTRd_SysInfoType ptxIoTRd_SysInfoType_t
NSC System-Info Types.
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:91
enum ptxIoTRd_CardRFTechType ptxIoTRd_CardRFTechType_t
Card RF-Technology Type.
#define PTX_IOTRD_MAX_SUPPORTED_DEVICES
Definition ptx_IOT_READER.h:78
struct ptxIoTRd_DiscConfig ptxIoTRd_DiscConfig_t
Configuration for RF-Discovery Loop.
ptxStatus_t ptxIoTRd_Get_Status_Info(ptxIoTRd_t *iotRd, ptxIoTRd_StatusType_t statusType, uint8_t *statusInfo)
Get various status- and state-information.
ptxIoTRd_ProtSupply
External Protection Circuitry Parameters (WLC only, to be ignored for stand-alone IoT-operation).
Definition ptx_IOT_READER.h:341
struct ptxIoTRd_HBRConfig ptxIoTRd_HBRConfig_t
Higher bitrate configuration.
ptxIoTRd_CheckPresType
Type of Check Presence Mechanism.
Definition ptx_IOT_READER.h:705
ptxIoTRd_CardProtocol
Card RF-Protocol Type.
Definition ptx_IOT_READER.h:459
ptxStatus_t ptxIoTRd_Get_System_Info(ptxIoTRd_t *iotRd, ptxIoTRd_SysInfoType_t infoType, uint8_t *infoBuffer, uint8_t *infoBufferLength)
Get System-internal Information.
struct ptxIoTRd_InitPars ptxIoTRd_InitPars_t
Parameters for IoTRd Initialization.
struct ptxIoTRd_RfMsg ptxIoTRd_RfMsg_t
Rf Message Registry structure.
struct ptxIoTRd_Extension ptxIoTRd_Extension_t
Extension Prototype (RFU): Extension Component Structure.
struct ptxIoTRd ptxIoTRd_t
IOT Reader Main Structure (Context).
#define PTX_IOTRD_RF_MSG_MAX_SIZE
Definition ptx_IOT_READER.h:124
struct ptxIoTRd_CardExtensionParams ptxIoTRd_CardExtensionParams_t
RF-Technolgy Extension Card Parameters (Prototype/RFU)
ptxIoTRd_RfMsgState
Rf Message State.
Definition ptx_IOT_READER.h:690
ptxIoTRd_ProtAttenuation
External Protection Attenuation Parameters (WLC only, to be ignored for stand-alone IoT-operation).
Definition ptx_IOT_READER.h:350
ptxStatus_t ptxIoTRd_Bits_Exchange_Mode(ptxIoTRd_t *iotRd, uint8_t enable)
Enable or disable Bits Exchange Option.
union ptxIoTRd_CardTechParams ptxIoTRd_CardTechParams_t
General Card RF-Technology specific Parameters.
ptxStatus_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:740
ptxStatus_t ptxIoTRd_TempSensor_Calibration(ptxIoTRd_t *iotRd, uint8_t Tambient, uint8_t *Tshutdown)
Perform PTX1K integrated temperature sensor calibration and calculate calibrated temperature shutdown...
enum ptxIoTRd_RevisionType ptxIoTRd_RevisionType_t
NSC Revision-Info Types.
ptxStatus_t ptxIoTRd_Initiate_Discovery(ptxIoTRd_t *iotRd, ptxIoTRd_DiscConfig_t *discConfig)
Initiate RF-Discovery according to NFC-Forum.
enum ptxIoTRd_RfMsgState ptxIoTRd_RfMsgState_t
Rf Message State.
struct ptxIoTRd_CardVParams ptxIoTRd_CardVParams_t
RF-Technolgy Type-V Card Parameters.
ptxStatus_t ptxIoTRd_Data_Exchange(ptxIoTRd_t *iotRd, uint8_t *tx, uint32_t txLength, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout)
Exchange data with an already activated card.
ptxStatus_t ptxIoTRd_T3T_SENSFRequest(ptxIoTRd_t *iotRd, uint16_t systemCode, uint8_t requestCode, uint8_t tsn, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout)
This function sends EoF command to a T3T activated card and waits for an answer.
#define PTX_IOTRD_TECH_V_UID_MAX_SIZE
Definition ptx_IOT_READER.h:85
ptxStatus_t ptxIoTRd_Deinit(ptxIoTRd_t *iotRd)
Close the IoT Reader Component.
enum ptxIoTRd_ProtSupply ptxIoTRd_ProtSupply_t
External Protection Circuitry Parameters (WLC only, to be ignored for stand-alone IoT-operation).
@ ProtType_None
Definition ptx_IOT_READER.h:361
@ ProtType_CurrentLimiter
Definition ptx_IOT_READER.h:363
@ ProtType_CurrentSensor
Definition ptx_IOT_READER.h:362
@ RSSI_Mode_Enabled
Definition ptx_IOT_READER.h:715
@ RSSI_Mode_Disabled
Definition ptx_IOT_READER.h:716
@ SupplyPad_GPIO5
Definition ptx_IOT_READER.h:342
@ SupplyPad_ATEST3
Definition ptx_IOT_READER.h:343
@ PresCheck_A
Definition ptx_IOT_READER.h:706
@ PresCheck_B
Definition ptx_IOT_READER.h:707
@ Attenuation_Off
Definition ptx_IOT_READER.h:351
@ Attenuation_09
Definition ptx_IOT_READER.h:353
@ Attenuation_03
Definition ptx_IOT_READER.h:352
enum ptxNSC_PollType ptxNSC_PollType_t
Enum for Polling-Loop type.
uint16_t ptxStatus_t
Status Type.
Definition ptxStatus.h:70
enum ptxStatus_Comps ptxStatus_Comps_t
Component Definitions.
HCE Main Structure (Context).
Definition ptxHce.h:169
Available higher bitrate identifiers.
Definition ptx_IOT_READER.h:417
uint8_t BitRate212
Definition ptx_IOT_READER.h:420
uint8_t BitRate424
Definition ptx_IOT_READER.h:419
uint8_t BitRate848
Definition ptx_IOT_READER.h:418
RF-Technology Type-A Card Parameters.
Definition ptx_IOT_READER.h:582
uint8_t NFCID1_LEN
Definition ptx_IOT_READER.h:584
uint8_t SENS_RES[PTX_IOTRD_TECH_A_SENSRES_MAX_SIZE]
Definition ptx_IOT_READER.h:583
uint8_t NFCID1[PTX_IOTRD_TECH_A_NFCID1_MAX_SIZE]
Definition ptx_IOT_READER.h:585
uint8_t SEL_RES
Definition ptx_IOT_READER.h:587
uint8_t SEL_RES_LEN
Definition ptx_IOT_READER.h:586
RF-Technolgy Type-B Card Parameters.
Definition ptx_IOT_READER.h:594
uint8_t SENSB_RES[PTX_IOTRD_TECH_B_SENSB_MAX_SIZE]
Definition ptx_IOT_READER.h:595
RF-Technolgy Extension Card Parameters (Prototype/RFU)
Definition ptx_IOT_READER.h:621
uint8_t Param[PTX_IOTRD_TECH_EXT_PARAM_MAX_SIZE]
Definition ptx_IOT_READER.h:624
uint8_t ParamLength
Definition ptx_IOT_READER.h:623
uint16_t Flags
Definition ptx_IOT_READER.h:622
RF-Technolgy Type-F Card Parameters.
Definition ptx_IOT_READER.h:602
uint8_t SENSF_RES[PTX_IOTRD_TECH_F_SENSF_MAX_SIZE]
Definition ptx_IOT_READER.h:604
uint8_t SENSF_RES_LEN
Definition ptx_IOT_READER.h:603
General Card Parameters (=> Card Registry Entry)
Definition ptx_IOT_READER.h:665
ptxIoTRd_SupportedRFProt_t SupportedProtocols
Definition ptx_IOT_READER.h:668
ptxIoTRd_CardTechParams_t TechParams
Definition ptx_IOT_READER.h:667
ptxIoTRd_CardRFTechType_t TechType
Definition ptx_IOT_READER.h:666
uint8_t DeviceState
Definition ptx_IOT_READER.h:669
Card Registry structure.
Definition ptx_IOT_READER.h:676
ptxIoTRd_CardParams_t * ActiveCard
Definition ptx_IOT_READER.h:679
ptxIoTRd_CardParams_t Cards[PTX_IOTRD_MAX_SUPPORTED_DEVICES]
Definition ptx_IOT_READER.h:677
uint8_t ActiveCardProtInfo[PTX_IOTRD_HIGH_LEVEL_PROT_MAX_SIZE]
Definition ptx_IOT_READER.h:682
uint8_t ActiveCardProtInfoLen
Definition ptx_IOT_READER.h:681
ptxIoTRd_CardProtocol_t ActiveCardProtType
Definition ptx_IOT_READER.h:680
uint8_t ActiveCardProtSpeed
Definition ptx_IOT_READER.h:683
uint8_t NrCards
Definition ptx_IOT_READER.h:678
RF-Technolgy Type-V Card Parameters.
Definition ptx_IOT_READER.h:611
uint8_t DSFID
Definition ptx_IOT_READER.h:613
uint8_t UID[PTX_IOTRD_TECH_V_UID_MAX_SIZE]
Definition ptx_IOT_READER.h:614
uint8_t RES_FLAG
Definition ptx_IOT_READER.h:612
Chip RF- and System-Configuration Identifiers.
Definition ptx_IOT_READER.h:310
uint8_t * Value
Definition ptx_IOT_READER.h:312
uint8_t Len
Definition ptx_IOT_READER.h:313
ptxIoTRd_ChipConfigID_t ID
Definition ptx_IOT_READER.h:311
Parameters for Communication/Host Interface Initialization.
Definition ptx_IOT_READER.h:322
uint8_t DeviceAddress
Definition ptx_IOT_READER.h:324
uint32_t Speed
Definition ptx_IOT_READER.h:323
Configuration for RF-Discovery Loop.
Definition ptx_IOT_READER.h:486
uint8_t PollBailOutFlags
Definition ptx_IOT_READER.h:525
uint8_t * ConPollNfcDepAtrReqG
Definition ptx_IOT_READER.h:540
uint8_t EnableIsoPollMode
Definition ptx_IOT_READER.h:567
uint8_t EnableExtdAtqB
Definition ptx_IOT_READER.h:570
uint8_t PollTypeVDeviceLimit
Definition ptx_IOT_READER.h:522
uint8_t EnableLPCDNotification
Definition ptx_IOT_READER.h:552
uint8_t ConPollNfcDepAtrReqGLen
Definition ptx_IOT_READER.h:543
uint8_t PollTypeF424
Definition ptx_IOT_READER.h:510
uint8_t DisableNfcDepProtocol
Definition ptx_IOT_READER.h:537
uint8_t PollTypeA
Definition ptx_IOT_READER.h:495
uint8_t DisableIsoDepProtocol
Definition ptx_IOT_READER.h:534
uint8_t PollTypeADeviceLimit
Definition ptx_IOT_READER.h:498
uint8_t PollGuardTime
Definition ptx_IOT_READER.h:555
uint8_t EnableHbr
Definition ptx_IOT_READER.h:564
uint8_t PollTypeV
Definition ptx_IOT_READER.h:519
uint8_t EnableStandBy
Definition ptx_IOT_READER.h:549
uint8_t AfiValue
Definition ptx_IOT_READER.h:573
uint8_t PollTypeB
Definition ptx_IOT_READER.h:501
uint8_t ContinuousField
Definition ptx_IOT_READER.h:558
uint8_t ListenTypeA
Definition ptx_IOT_READER.h:561
uint8_t PollTypeFDeviceLimit
Definition ptx_IOT_READER.h:516
uint8_t PollTypeBDeviceLimit
Definition ptx_IOT_READER.h:504
ptxIoTRd_CardRFTechType_t PollStartTechnology
Definition ptx_IOT_READER.h:531
uint32_t IdleTime
Definition ptx_IOT_READER.h:546
uint8_t PollTypeF212
Definition ptx_IOT_READER.h:507
uint8_t Discover_Mode
Definition ptx_IOT_READER.h:492
ptxIoTRd_DiscConfigTypeFPollCmdParams_t PollTypeFCmdParams
Definition ptx_IOT_READER.h:513
Custom Type-F Polling Command Parameters.
Definition ptx_IOT_READER.h:475
uint8_t InitialTimeSlotNr
Definition ptx_IOT_READER.h:479
uint8_t OverwriteDefaultParams
Definition ptx_IOT_READER.h:476
uint8_t RequestCode
Definition ptx_IOT_READER.h:478
uint8_t SystemCode[2]
Definition ptx_IOT_READER.h:477
Extension Prototype (RFU): Extension Component Structure.
Definition ptx_IOT_READER.h:746
pExtActivateCMD_t CBFnExtActivateCmd
Definition ptx_IOT_READER.h:749
pExtProcessNTF_t CBFnExtProcessNtf
Definition ptx_IOT_READER.h:748
uint8_t ExtensionID
Definition ptx_IOT_READER.h:747
void * ExtensionCtx
Definition ptx_IOT_READER.h:750
Available higher bitrates in Rx- and Tx-direction.
Definition ptx_IOT_READER.h:428
ptxIoTRd_BitRates_t Rx
Definition ptx_IOT_READER.h:429
ptxIoTRd_BitRates_t Tx
Definition ptx_IOT_READER.h:430
Higher bitrate configuration.
Definition ptx_IOT_READER.h:438
ptxIoTRd_HBRConfig_Int_t PollA
Definition ptx_IOT_READER.h:439
ptxIoTRd_HBRConfig_Int_t PollB
Definition ptx_IOT_READER.h:440
Parameters for IoTRd Initialization.
Definition ptx_IOT_READER.h:406
ptxIoTRd_TempSense_Params_t * TemperatureSensor
Definition ptx_IOT_READER.h:407
ptxIoTRd_Protection_Params_t * ExtProtection
Definition ptx_IOT_READER.h:409
ptxIoTRd_ComInterface_Params_t * ComInterface
Definition ptx_IOT_READER.h:408
External Protection Limiter Parameters (WLC only, to be ignored for stand-alone IoT-operation).
Definition ptx_IOT_READER.h:370
uint8_t GuardTime
Definition ptx_IOT_READER.h:371
External Current Sensor Parameters (WLC only, to be ignored for stand-alone IoT-operation).
Definition ptx_IOT_READER.h:378
ptxIoTRd_ProtSupply_t Supply
Definition ptx_IOT_READER.h:379
uint8_t Threshold
Definition ptx_IOT_READER.h:381
ptxIoTRd_ProtAttenuation_t Attenuation
Definition ptx_IOT_READER.h:380
External Protection Parameters (WLC only, to be ignored for stand-alone IoT-operation).
Definition ptx_IOT_READER.h:397
ptxIoTRd_ProtSettings_t Settings
Definition ptx_IOT_READER.h:399
ptxIoTRd_ProtType_t Type
Definition ptx_IOT_READER.h:398
Rf Message Registry structure.
Definition ptx_IOT_READER.h:723
ptxIoTRd_RfMsgState_t State
Definition ptx_IOT_READER.h:724
size_t NumTotalBits
Definition ptx_IOT_READER.h:729
uint8_t BuffSecond[PTX_IOTRD_RF_MSG_MAX_SIZE]
Definition ptx_IOT_READER.h:727
size_t BuffSecondLen
Definition ptx_IOT_READER.h:728
size_t BuffLen
Definition ptx_IOT_READER.h:726
uint8_t Buff[PTX_IOTRD_RF_MSG_MAX_SIZE]
Definition ptx_IOT_READER.h:725
Card Supported RF-Protocols.
Definition ptx_IOT_READER.h:656
uint8_t NrRFProtocols
Definition ptx_IOT_READER.h:658
ptxIoTRd_CardProtocol_t RFProtocol[PTX_IOTRD_MAX_SUPPORTED_RF_PROTOCOLS]
Definition ptx_IOT_READER.h:657
Parameters for Temperature Sensor Initialization.
Definition ptx_IOT_READER.h:331
uint8_t Calibrate
Definition ptx_IOT_READER.h:332
uint8_t Tambient
Definition ptx_IOT_READER.h:334
uint8_t Tshutdown
Definition ptx_IOT_READER.h:333
IOT Reader Main Structure (Context).
Definition ptx_IOT_READER.h:757
size_t BuffNtfLen
Definition ptx_IOT_READER.h:767
uint8_t LPCDNtfCounter
Definition ptx_IOT_READER.h:773
ptxIoTRd_Extension_t Extension[PTX_IOTRD_MAX_EXTENSIONS]
Definition ptx_IOT_READER.h:776
struct ptxPlat * Plat
Definition ptx_IOT_READER.h:759
uint8_t StandbyActive
Definition ptx_IOT_READER.h:774
uint32_t BuffNtfIndex
Definition ptx_IOT_READER.h:768
uint8_t LpcdState
Definition ptx_IOT_READER.h:763
uint8_t DiscoverState
Definition ptx_IOT_READER.h:762
uint8_t BuffNtf[PTX_IOTRD_RF_MSG_MAX_SIZE]
Definition ptx_IOT_READER.h:766
ptxIoTRd_RfMsg_t RfMsg
Definition ptx_IOT_READER.h:764
uint8_t LastRFError
Definition ptx_IOT_READER.h:765
ptxHce_t Hce
Definition ptx_IOT_READER.h:769
uint8_t NrExtensions
Definition ptx_IOT_READER.h:775
ptxNSC_PollType_t PollMode
Definition ptx_IOT_READER.h:770
uint8_t rfResetFlag
Definition ptx_IOT_READER.h:771
struct ptxNSC * Nsc
Definition ptx_IOT_READER.h:760
uint8_t RSSIModeCfg[5]
Definition ptx_IOT_READER.h:772
ptxStatus_Comps_t CompId
Definition ptx_IOT_READER.h:758
ptxIoTRd_CardRegistry_t * CardRegistry
Definition ptx_IOT_READER.h:761
Main NSC component structure.
Definition ptxNSC.h:1184
General Card RF-Technology specific Parameters.
Definition ptx_IOT_READER.h:631
ptxIoTRd_CardBParams_t CardBParams
Definition ptx_IOT_READER.h:633
ptxIoTRd_CardVParams_t CardVParams
Definition ptx_IOT_READER.h:635
ptxIoTRd_CardAParams_t CardAParams
Definition ptx_IOT_READER.h:632
ptxIoTRd_CardExtensionParams_t CardExtParams
Definition ptx_IOT_READER.h:636
ptxIoTRd_CardFParams_t CardFParams
Definition ptx_IOT_READER.h:634
External Protection Settings (WLC only, to be ignored for stand-alone IoT-operation).
Definition ptx_IOT_READER.h:388
ptxIoTRd_ProtISensorSettings_t Sensor
Definition ptx_IOT_READER.h:390
ptxIoTRd_ProtILimiterSettings_t Limiter
Definition ptx_IOT_READER.h:389