Include dependency graph for ptx_IOT_READER.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
| struct | ptxIoTRd_ChipConfig |
| Chip RF- and System-Configuration Identifiers. More... | |
| struct | ptxIoTRd_BitRates |
| Available higher bitrate identifiers. More... | |
| struct | ptxIoTRd_HBRConfig_Int |
| Available higher bitrates in Rx- and Tx-direction. More... | |
| struct | ptxIoTRd_HBRConfig |
| Higher bitrate configuration. More... | |
| struct | ptxIoTRd_DiscConfigTypeFPollCmdParams |
| Custom Type-F Polling Command Parameters. More... | |
| struct | ptxIoTRd_DiscConfig |
| Configuration for RF-Discovery Loop. More... | |
| struct | ptxIoTRd_NSCInitConfig |
| Configuration for NSC Init. More... | |
| struct | ptxIoTRd_CardAParams |
| RF-Technology Type-A Card Parameters. More... | |
| struct | ptxIoTRd_CardBParams |
| RF-Technolgy Type-B Card Parameters. More... | |
| struct | ptxIoTRd_CardFParams |
| RF-Technolgy Type-F Card Parameters. More... | |
| struct | ptxIoTRd_CardVParams |
| RF-Technolgy Type-V Card Parameters. More... | |
| struct | ptxIoTRd_CardExtensionParams |
| RF-Technolgy Extension Card Parameters (Prototype/RFU) More... | |
| union | ptxIoTRd_CardTechParams |
| General Card RF-Technology specific Parameters. More... | |
| struct | ptxIoTRd_SupportedRFProt |
| Card Supported RF-Protocols. More... | |
| struct | ptxIoTRd_CardParams |
| General Card Parameters (=> Card Registry Entry) More... | |
| struct | ptxIoTRd_CardRegistry |
| Card Registry structure. More... | |
| struct | ptxIoTRd_Extension |
| struct | ptxIoTRd_ComInterface_Params |
| Parameters for Communication/Host Interface Initialization. More... | |
| struct | ptxIoTRd_InitStack_Params |
| Structure containing stack initialization parameters directly set by the user. More... | |
Typedefs | |
| typedef enum ptxIoTRd_RevisionType | ptxIoTRd_RevisionType_t |
| NSC Revision-Info Types. | |
| typedef enum ptxIoTRd_ChipConfigID | ptxIoTRd_ChipConfigID_t |
| Chip RF- and System-Configuration Identifiers. | |
| typedef enum ptxIoTRd_SysInfoType | ptxIoTRd_SysInfoType_t |
| System Info Identifiers. | |
| typedef struct ptxIoTRd_ChipConfig | ptxIoTRd_ChipConfig_t |
| Chip RF- and System-Configuration Identifiers. | |
| typedef struct ptxIoTRd_BitRates | ptxIoTRd_BitRates_t |
| Available higher bitrate identifiers. | |
| typedef struct ptxIoTRd_HBRConfig_Int | ptxIoTRd_HBRConfig_Int_t |
| Available higher bitrates in Rx- and Tx-direction. | |
| typedef struct ptxIoTRd_HBRConfig | ptxIoTRd_HBRConfig_t |
| Higher bitrate configuration. | |
| typedef enum ptxIoTRd_CardRFTechType | ptxIoTRd_CardRFTechType_t |
| Card RF-Technology Type. | |
| typedef enum ptxIoTRd_CardProtocol | ptxIoTRd_CardProtocol_t |
| Card RF-Protocol Type. | |
| typedef struct ptxIoTRd_DiscConfigTypeFPollCmdParams | ptxIoTRd_DiscConfigTypeFPollCmdParams_t |
| Custom Type-F Polling Command Parameters. | |
| typedef struct ptxIoTRd_DiscConfig | ptxIoTRd_DiscConfig_t |
| Configuration for RF-Discovery Loop. | |
| typedef struct ptxIoTRd_NSCInitConfig | ptxIoTRd_NSCInitConfig_t |
| Configuration for NSC Init. | |
| typedef struct ptxIoTRd_CardAParams | ptxIoTRd_CardAParams_t |
| RF-Technology Type-A Card Parameters. | |
| typedef struct ptxIoTRd_CardBParams | ptxIoTRd_CardBParams_t |
| RF-Technolgy Type-B Card Parameters. | |
| typedef struct ptxIoTRd_CardFParams | ptxIoTRd_CardFParams_t |
| RF-Technolgy Type-F Card Parameters. | |
| typedef struct ptxIoTRd_CardVParams | ptxIoTRd_CardVParams_t |
| RF-Technolgy Type-V Card Parameters. | |
| typedef struct ptxIoTRd_CardExtensionParams | ptxIoTRd_CardExtensionParams_t |
| RF-Technolgy Extension Card Parameters (Prototype/RFU) | |
| typedef union ptxIoTRd_CardTechParams | ptxIoTRd_CardTechParams_t |
| General Card RF-Technology specific Parameters. | |
| typedef struct ptxIoTRd_SupportedRFProt | ptxIoTRd_SupportedRFProt_t |
| Card Supported RF-Protocols. | |
| typedef struct ptxIoTRd_CardParams | ptxIoTRd_CardParams_t |
| General Card Parameters (=> Card Registry Entry) | |
| typedef struct ptxIoTRd_CardRegistry | ptxIoTRd_CardRegistry_t |
| Card Registry structure. | |
| typedef enum ptxIoTRd_CheckPresType | ptxIoTRd_CheckPresType_t |
| Type of Check Presence Mechanism. | |
| typedef enum ptxIoTRd_StatusType | ptxIoTRd_StatusType_t |
| Generic Status / State Identifier. | |
| typedef enum ptxIoTRd_RSSI_Mode | ptxIoTRd_RSSI_Mode_t |
| RSSI Mode. | |
| typedef uint16_t(* | pExtProcessNTF_t) (void *extCtx, void *iotRdComp, void *nscEvent) |
| Extension Prototype (RFU): Handler for NTF Processing at API-level. | |
| typedef 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. | |
| typedef struct ptxIoTRd_Extension | ptxIoTRd_Extension_t |
| typedef struct ptxIoTRd_ComInterface_Params | ptxIoTRd_ComInterface_Params_t |
| Parameters for Communication/Host Interface Initialization. | |
| typedef struct ptxIoTRd_InitStack_Params | ptxIoTRd_InitStack_Params_t |
| Structure containing stack initialization parameters directly set by the user. | |
Enumerations | |
| enum | ptxIoTRd_RevisionType { RevInfo_C_Stack , RevInfo_Local_Changes , RevInfo_DFY_Code , RevInfo_DFY_Toolchain , RevInfo_ChipID , RevInfo_ProductID } |
| NSC Revision-Info Types. | |
| enum | ptxIoTRd_ChipConfigID { RF_Wavebank0 , RF_Wavebank1 , RF_Wavebank2 , RF_Wavebank3 , RF_Wavebank4 , RF_Wavebank5 , RF_Wavebank6 , RF_Wavebank7 , RF_Wavebank8 , RF_Wavebank9 , RF_Wavebank10 , RF_Wavebank11 , RF_Wavebank12 , RF_Wavebank13 , RF_Wavebank14 , RF_Wavebank15 , RF_Wavebank16 , RF_Wavebank17 , RF_Wavebank18 , RF_Wavebank19 , RF_Misc , RF_PollA106 , RF_PollA212 , RF_PollA424 , RF_PollA848 , RF_PollB106 , RF_PollB212 , RF_PollB424 , RF_PollB848 , RF_PollF212 , RF_PollF424 , RF_PollV , SYS_ThermalThreshold = 100 , SYS_OvercurrentThreshold , SYS_ConClockSrc , SYS_ConVarLBS , SYS_ConNHost , SYS_ConNHosCE } |
| Chip RF- and System-Configuration Identifiers. | |
| enum | ptxIoTRd_SysInfoType { SysInfo_VDPA_Calibration_Result } |
| System Info Identifiers. | |
| enum | ptxIoTRd_CardRFTechType { Tech_TypeA = 0 , Tech_TypeB = 1 , Tech_TypeF = 2 , Tech_TypeV = 6 , Tech_TypeExtension = 10 } |
| Card RF-Technology Type. | |
| enum | ptxIoTRd_CardProtocol { Prot_Undefined = 0 , Prot_T2T = 2 , Prot_T3T = 3 , Prot_ISODEP = 4 , Prot_NFCDEP = 5 , Prot_T5T = 6 , Prot_Extension = 10 } |
| Card RF-Protocol Type. | |
| enum | ptxIoTRd_CheckPresType { PresCheck_A , PresCheck_B } |
| Type of Check Presence Mechanism. More... | |
| enum | ptxIoTRd_StatusType { StatusType_System , StatusType_Discover , StatusType_DeactivateSleep , StatusType_LastRFError , StatusType_LPCDNtfCounter , StatusType_HCE_Discover_State } |
| Generic Status / State Identifier. | |
| enum | ptxIoTRd_RSSI_Mode { RSSI_Mode_Enabled , RSSI_Mode_Disabled } |
| RSSI Mode. More... | |
Functions | |
| 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 caller. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_Init_Stack (void *stackComp, ptxIoTRd_InitStack_Params_t *initStackParams) |
| Initialize the stack. | |
| 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, Product-ID etc.). | |
| 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 to a file. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_Close_Stack (void *stackComp, char *logFile) |
| Close the stack. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_Init_NSC (void *stackComp, ptxIoTRd_NSCInitConfig_t *initConfig) |
| Initialize NSC. | |
| 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_ConfigHBR (void *stackComp, ptxIoTRd_HBRConfig_t *configParams) |
| Configures HBR. | |
| 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_Card_Registry (void *stackComp, ptxIoTRd_CardRegistry_t **cardRegistry) |
| Access the internal card registry. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_Activate_Card (void *stackComp, ptxIoTRd_CardParams_t *cardParams, ptxIoTRd_CardProtocol_t protocol) |
| Activates a specific card. | |
| 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. | |
| 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_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 / Tags supporting the T2T protocol. | |
| 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_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_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. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_Reader_Deactivation (void *stackComp, uint8_t deactivationType) |
| Perform generic reader deactivation. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_Set_Power_Mode (void *stackComp, uint8_t newPowerMode) |
| Set reader power mode. | |
| 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. | |
| 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 temperature. The outcome of this process is the calibrated temperature shutdown temperature value, returned in Tshutdown parameter. This value is used in every further call to ptxIoTRd_Init_NSC. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_SWReset (void *stackComp) |
| SW Reset. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_Get_Status_Info (void *stackComp, ptxIoTRd_StatusType_t statusType, uint8_t *statusInfo) |
| Get various status- and state-information. | |
| ptxStatus_t | ptxIoTRd_Get_HCE_Component (void *stackComp, ptxHCE_t **hceComp) |
| Retrieves the HCE component from the stack. | |
| 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. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_Get_RSSI_Value (void *stackComp, uint16_t *rssiValue) |
| This function reads the current RSSI-value. | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_Register_Extension (void *stackComp, uint8_t extensionID, ptxIoTRd_Extension_t *extension) |
| Register an IoT-Extension (Prototype/RFU). | |
| PTX_API_LIBFUNC uint16_t | ptxIoTRd_DeRegister_Extension (void *stackComp, uint8_t extensionID) |
| De-Register an IoT-Extension (Prototype/RFU). | |
Detailed Description
SPDX-License-Identifier: BSD-3-Clause
Copyright (c) 2026, Renesas Electronics Corporation and/or its affiliates
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of Renesas nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY Renesas "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RENESAS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project : PTX1K Module : IOT_READER File : ptx_IOT_READER.h
Description : API for IOT READER
