Renesas PTX1xxR IoT-Reader API Version 7.3.1
Renesas Software Stack for IoT-Reader Applications
Data Structures | Typedefs | Functions
ptxTbInt.h File Reference
#include "ptxNscFactory.h"
#include "ptxNSC_System.h"
#include "ptxHal_Ext.h"
Include dependency graph for ptxTbInt.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ptxTbInt
 

Typedefs

typedef void(* pptxInt_Completion_t) (void *sysCtx, uint8_t *complData, size_t complDataLen, int32_t complStatus)
 Completion function pointer for general calls and responses to calls.
 
typedef void(* pptxInt_CompletionNTF_t) (void *sysCtx, ptxNSC_Event_t *complData)
 Completion function pointer for notifications.
 

Functions

ptxStatus_t ptxTbInt_GetIORQNtf (void *cpLayer, ptxIoRq_t *io_rq)
 Integration get IO RQ Ntf (Not including NCI).
 
void ptxTbInt_ReturnIoRqItem (ptxTbInt_t *cInst, ptxIoRq_t *ioCpl, ptxStatus_t reqStatus)
 Internal function to return I/O request objects in case of non-pending status.
 
void ptxTbInt_GetIORQNtfCompletion (ptxIoRq_t *ioCpl, void *cplLayer, void *data, size_t dataLength, ptxStatus_t cplStatus)
 Completion function for ptxTbInt_GetIORQNtf.
 
void ptxTbInt_NSCCompletion (ptxIoRq_t *ioCpl, void *cplLayer, void *data, size_t dataLength, ptxStatus_t cplStatus)
 Internal default completion function general purpose NSC.
 
typedef struct ptxTbInt ptxTbInt_t
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_SetUp (void *compCtx, pptxInt_Completion_t complFn, pptxInt_CompletionNTF_t complFnNtf, void *sysCtx)
 Set up the stack.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_ShutDown (void *compCtx)
 Shut down the stack.
 
PTX_LIBFUNC const char * ptxTbInt_GetVersionDescription (void)
 Get Version Description.
 
PTX_LIBFUNC ptxTbInt_tptxTbInt_Allocate (void)
 Allocate memory for ptxTbInt_t - the main struct for the stack that has to be sent from caller in all the calls.
 
PTX_LIBFUNC void ptxTbInt_Free (ptxTbInt_t *cInst)
 Free the memory previously allocated by ptxTbInt_t.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_SetParameter (ptxTbInt_t *cInst, ptxNscFactory_P_t parType, uint8_t *parBuf, uint32_t parLenOrValue)
 Set Factory Operating Parameter.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_BuildStack (ptxTbInt_t *cInst, void *systemContext)
 Build the stack.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_DestroyStack (ptxTbInt_t *cInst)
 Destroy the stack, except for basic objects such as LOG.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_DestroyStack_Finalize (ptxTbInt_t *cInst)
 Destroy the basic stack objects.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSCFwDownloader (void *compCtx, uint8_t *pData, int length)
 NSC download firmware image to the chip.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_DragonFlyActivation (void *compCtx)
 NSC DFY Activation entry function at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_Init (void *compCtx, ptxNSC_Init_Param_t *initParams)
 NSC Init entry function at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfConfig (void *compCtx, ptxNSC_RfConfig_Param_t *rfConfigParams)
 NSC Rf Config.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfSetParams (void *compCtx, ptxNsc_RfPar_t *rfPar, size_t rfParLen)
 NSC RF SET PARAMETER entry function at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfTestRun (void *compCtx, ptxNsc_RfTest_Id_t rfTestId, uint8_t *rfTestParams, size_t rfTestParamsLen)
 Function for NSC_RF_RUN_CMD.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfTestStop (void *compCtx)
 Function for NSC_RF_STOP_CMD.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSCGetMode (void *compCtx, uint8_t *mode)
 NSC Get State.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSCGetMiscRFConfig (void *compCtx, uint8_t *configBuffer, size_t *configBufferLen)
 NSC Get last loaded Misc. RF-Configuration.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_Read (void *compCtx, uint16_t *address, size_t addressLen, ptxNSC_ReadCmd_Type_t typeRd)
 NSC Read entry function at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_Write (void *compCtx, uint16_t *address, size_t addressLen, uint8_t *value, size_t valueLen, ptxNSC_WriteCmd_Type_t typeWr)
 NSC Write entry function at integration level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfDiscover (void *compCtx, ptxNSC_Discover_Param_t *discoverParams)
 NSC Discover entry function at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfDiscover_EmvCo_TRANSAC_A (void *compCtx)
 NSC Rf Discover entry function at Int level, enabling the TRANSAC_A feature.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfDiscover_EmvCo_TRANSAC_B (void *compCtx)
 NSC Rf Discover entry function at Int level, enabling the TRANSAC_B feature.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_SetField (void *compCtx, uint8_t enabled)
 Turns the RF-field of the Reader on or off.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfConfig_NVMLoad (void *compCtx, ptxNSC_RfConfig_Param_t *rfConfigParams)
 Loads the RF-Configuration from NVM.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfConfig_NVMUnLoad (void *compCtx, ptxNSC_RfConfig_Param_t *rfConfigParams)
 (Un-)Loads the RF-Configuration from internal memory.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_DataMsg (void *compCtx, uint8_t *payload, size_t length, uint8_t isChained)
 NSC Data Msg entry function at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_CltMsg (void *compCtx, uint8_t *pld, uint8_t *pldPar, size_t length)
 NSC Clt Msg entry function at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_PresCheck_IsoDep_Nack (void *compCtx)
 NSC Presence Check at ISO-DEP(Nack) at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_PresCheck_IsoDep_EmptyBlock (void *compCtx)
 NSC Presence Check at ISO-DEP(Empty I-Frame) at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_PresCheck_NfcDep_AttentionCmd (void *compCtx)
 NSC Presence Check at NFC-DEP(Attention Command) at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_T5T_IsolatedEoF (void *compCtx)
 It sends an isolated EoF when T5T protocol is selected.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfActivate (void *compCtx, ptxNSC_RfActiv_Param_t *rfActivParams)
 NSC Rf Activate.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfDeactivate (void *compCtx, ptxNSC_Rf_Deact_Param_t *rfDeactParam)
 NSC Deactivate entry function at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_Standby (void *compCtx, uint8_t powerMode)
 NSC Standby/WakeUp entry function at Int level.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NscSoftReset (void *compCtx)
 Nsc Soft Reset at Integration layer.
 
PTX_LIBFUNC size_t ptxTbInt_GetMtU (void *cInst)
 Get Maximum Transfer Unit (bytes that can be received) by the Stack. This setting is platform dependent.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_SetMtU (ptxTbInt_t *cInst, size_t MaxTransferUnit)
 Set Maximum Unit Transfer(bytes that can be received) by the Stack. This setting is platform dependent.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_SetEMVParams (void *compCtx, ptxNSC_Discover_Param_t *discoverParams)
 Sets up RF-Discover parameter structure for EMVCo.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_SetNFCForumParams (void *compCtx, ptxNSC_Discover_Param_t *discoverParams)
 Sets up RF-Discover parameter structure for NFC Forum.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GetRevisionInfo (void *compCtx, ptxNSC_RevisionType_t revisionType, uint32_t *revisionInfo)
 Get various revisions of system (C-Stack, DFY-Code/-Toochain, Chip-ID, Local changes etc.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_WriteSystemConfig (void *compCtx, ptxNSC_System_t *sysConfigParams)
 NSC System Config Set.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_ReadSystemConfig (void *compCtx, ptxNSC_System_t *sysConfigParams)
 NSC System Config Get.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_ReadTempSensor (void *compCtx)
 Reads current internal temperature sensor value.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_LoadSystemConfig (void *compCtx, ptxNSC_System_t *sysConfigParams, ptxNSC_System_LoadParams_t loadType)
 Load NSC System Config.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GPIO_Config (void *compCtx, uint8_t gpioNr, uint8_t gpioMode, uint8_t gpioFlags)
 Configures a selected GPIO-pin to work as input or output.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GPIO_Write (void *compCtx, uint8_t gpioNr, uint8_t gpioValue)
 Writes the selected GPIO-pin high or low.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GPIO_Read (void *compCtx, uint8_t gpioNr)
 Reads the current value of a selected GPIO-pin.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GetDeactivateTimeout (void *compCtx, uint32_t *currentTimeout)
 Function to retrieve the current timeout value in [ms] to wait for a NSC.RF_DEACTIVATE_RSP.
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_SetDeactivateTimeout (void *compCtx, uint32_t *currentTimeout)
 Function to set the current timeout value in [ms] to wait for a NSC.RF_DEACTIVATE_RSP.
 
ptxStatus_t ptxTbInt_BuildStackCommon (ptxTbInt_t *cInst, void *systemContext, ptxLog_t *log)
 Common function for building the Stack.
 

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:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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.
  3. 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 : TB File : ptxTbInt.h

Description :