#include "ptxStatus.h"
#include "ptxNSC_Event.h"

Include dependency graph for ptxHce.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	ptxHce_DiscConfig_t
	HCE RF-Discovery Configuration for Listen-Mode. More...

struct	ptxHce_EventRecord_t
	HCE Event Record Type. More...

struct	ptxHce_EventQueue_t
	HCE Event Queue. More...

struct	ptxHce
	HCE Main Structure (Context). More...

Macros
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

Typedefs
typedef enum ptxHce_EventType	ptxHce_EventType_t
	HCE Event Identifiers.

typedef struct ptxHce	ptxHce_t
	HCE Main Structure (Context).

Enumerations
enum	ptxHce_RfProtocol_t { HceRfProt_Undefined = 0x00 , HceRfProt_T2T = 0x02 , HceRfProt_IsoDep = 0x04 }
	HCE RF-Protocol Type(s)

enum	ptxHce_EventQueueDimensions_t { e_MaxNrOfEventRecords = 32 , e_SizeOfShortMsgBuffer = 3 , e_SizeOfActivationBuffer = 16 }
	HCE Event Queue Management (Dimensions)

enum	ptxHce_EventQueueRanges_t { e_EvtRecordIndexMin = 0 , e_EvtRecordIndexMax = e_MaxNrOfEventRecords-1 , e_EvtMaxNrOfRecords , e_EvtRecIndexNotSet }
	HCE Event Queue Management (Ranges)

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 hce, struct ptxPlat plat, struct ptxNSC nsc, uint8_t appRxBuffer, uint16_t appRxBufferSize)
	This function initializes the Host Card Emulation Component (HCE).

ptxStatus_t	ptxHce_Deinit (ptxHce_t *hce)
	This function De-initializes the Host Card Emulation Component.

ptxStatus_t	ptxHce_Get_Event (ptxHce_t hce, 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_Send_Data (ptxHce_t hce, uint8_t tx, uint32_t txLength)
	This function allows the currently activated card to send data to a nearby card reader.

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.

Detailed Description

SPDX-License-Identifier: BSD-3-Clause

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 : Host Card Emulation (HCE) File : ptxHce.h

Description : HCE Application Programmers Interface (API)

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.