Renesas PTX1xxR IoT-Reader API Version 7.3.1
Renesas Software Stack for IoT-Reader Applications
Data Structures | Macros | Typedefs | Enumerations | Functions
ptxHce.h File Reference
#include "ptx_Status.h"
#include "ptxLog.h"
#include "ptxNvm.h"
#include "ptxOsal.h"
Include dependency graph for ptxHce.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ptxHCE_EventRecord_t
 HCE Event Record Type. More...
 
struct  ptxHCE_EventQueue_t
 HCE Event Queue. More...
 
struct  ptxHCE
 Main Component Struture. More...
 
struct  ptxHCE_InitParams
 Main Component Struture. More...
 

Macros

#define PTX_HCE_RF_MSG_MAX_SIZE   (512U)
 
#define PTX_HCE_RF_DISCOVERY_STATE_NO_CARD   (0u)
 
#define PTX_HCE_RF_DISCOVER_STATE_LISTEN_A   (1u)
 
NSC DEACTIVATE-Reasons.
#define PTX_HCE_DEACTIVATE_REASON_DESELECT   (uint8_t)0x01
 
#define PTX_HCE_DEACTIVATE_REASON_RELEASE   (uint8_t)0x02
 
#define PTX_HCE_DEACTIVATE_REASON_FIELD_OFF   (uint8_t)0x03
 
HCE Event Queue Management (Dimensions)
#define PTX_HCE_MAX_NR_EVENT_RECORDS   (32u)
 
#define PTX_HCE_SIZE_SHORT_MSG_BUFFER   (3u)
 
#define PTX_HCE_SIZE_ACTIVATION_BUFFER   (16u)
 
HCE Event Queue Management (Ranges)
#define PTX_HCE_EVENT_RECORD_INDEX_MIN   (0u)
 
#define PTX_HCE_EVENT_RECORD_INDEX_MAX   PTX_HCE_MAX_NR_EVENT_RECORDS - (1u)
 
#define PTX_HCE_EVENT_RECORD_NOT_SET   (0u)
 

Typedefs

typedef enum ptxHCE_EventType ptxHCE_EventType_t
 HCE Event Identifiers.
 
typedef struct ptxHCE ptxHCE_t
 Main Component Struture.
 
typedef struct ptxHCE_InitParams ptxHCE_InitParams_t
 Main Component Struture.
 

Enumerations

enum  ptxHCE_RfProtocol_t { HceRfProt_Undefined = 0x00 , HceRfProt_T2T = 0x02 , HceRfProt_IsoDep = 0x04 }
 HCE RF-Protocol Type(s) More...
 
enum  ptxHCE_EventType {
  HCEEvent_ExtFieldOn , HCEEvent_ExtFieldOff , HCEEvent_Activated_ListenA , HCEEvent_Data ,
  HCEEvent_Deactivated , HCEEvent_NoEvent
}
 HCE Event Identifiers.
 

Functions

ptxStatus_t ptxHCE_Init (ptxHCE_t *hceCtx, ptxHCE_InitParams_t *initParams)
 Component Initialization.
 
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 emulation device.
 
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.
 
ptxStatus_t ptxHCE_AddNewEventPending (ptxHCE_t *hce, uint16_t recordIndex)
 Adds a new pending Event Record at the Tail of the Event Queue.
 
uint16_t ptxHCE_SendData (void *stackComp, ptxHCE_t *hce, uint8_t *tx, uint32_t txLength)
 Send Tx Data.
 

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 : HCE File : ptxHce.h

Description : Description