FeliCa DTE API

Collaboration diagram for FeliCa DTE API:

Data Structures
struct	ptxFeliCa_DTE_PerformanceTest
	FeliCa-DTE Test Parameters for Performance-Tests. More...
struct	ptxFeliCa_DTE_RWDigProtTest
	FeliCa-DTE Test Parameters for Performance-Tests. More...
union	ptxFeliCa_DTE_Params
	FeliCa-DTE Test Parameters. More...
struct	ptxFeliCa_DTE_TestProgressParams
	FeliCa-DTE Test Progress Parameters. More...
struct	ptxFeliCa_DTE_TestParams
	FeliCa-DTE Test Parameters. More...
struct	ptxFeliCa_DTE_InitParams
	FeliCa-DTE Initialization Parameters. More...
struct	ptxFeliCa_DTE
	FeliCa-DTE Component. More...

Typedefs
typedef enum ptxFeliCa_DTE_BitRate	ptxFeliCa_DTE_BitRate_t
	FeliCa-DTE Test Type.
typedef enum ptxFeliCa_DTE_TestID	ptxFeliCa_DTE_TestID_t
	FeliCa-DTE Test Type.
typedef enum ptxFeliCa_DTE_RWDigProt_TestID	ptxFeliCa_DTE_RWDigProt_TestID_t
	FeliCa-DTE Reader/Writer Digital Protocol (Sub-)Test Type.
typedef struct ptxFeliCa_DTE_PerformanceTest	ptxFeliCa_DTE_PerformanceTest_t
	FeliCa-DTE Test Parameters for Performance-Tests.
typedef struct ptxFeliCa_DTE_RWDigProtTest	ptxFeliCa_DTE_RWDigProtTest_t
	FeliCa-DTE Test Parameters for Performance-Tests.
typedef union ptxFeliCa_DTE_Params	ptxFeliCa_DTE_Params_t
	FeliCa-DTE Test Parameters.
typedef struct ptxFeliCa_DTE_TestProgressParams	ptxFeliCa_DTE_TestProgressParams_t
	FeliCa-DTE Test Progress Parameters.
typedef void(*	ptxFeliCa_DTE_ProgressFn_t) (ptxFeliCa_DTE_TestProgressParams_t *progressParams)
	Progress Callback Function.
typedef struct ptxFeliCa_DTE_TestParams	ptxFeliCa_DTE_TestParams_t
	FeliCa-DTE Test Parameters.
typedef struct ptxFeliCa_DTE_InitParams	ptxFeliCa_DTE_InitParams_t
	FeliCa-DTE Initialization Parameters.
typedef struct ptxFeliCa_DTE	ptxFeliCa_DTE_t
	FeliCa-DTE Component.

Enumerations
enum	ptxFeliCa_DTE_BitRate { FELICA_DTE_BITRATE_212 = 1 , FELICA_DTE_BITRATE_424 = 2 }
	FeliCa-DTE Test Type. More...
enum	ptxFeliCa_DTE_TestID { FELICA_DTE_TestID_PerformanceTest , FELICA_DTE_TestID_RWDigProtTest }
	FeliCa-DTE Test Type. More...
enum	ptxFeliCa_DTE_RWDigProt_TestID {   FELICA_DTE_SubTestID_RWDigProt_eMoney_Variant1 , FELICA_DTE_SubTestID_RWDigProt_eMoney_Variant2 , FELICA_DTE_SubTestID_RWDigProt_eMoney_NFCDEP , FELICA_DTE_SubTestID_RWDigProt_FrameStructure ,   FELICA_DTE_SubTestID_RWDigProt_FrameStructure1 , FELICA_DTE_SubTestID_RWDigProt_FrameStructure2 , FELICA_DTE_SubTestID_RWDigProt_FrameStructure3 , FELICA_DTE_SubTestID_RWDigProt_FrameStructure4 ,   FELICA_DTE_SubTestID_RWDigProt_FrameStructure5 , FELICA_DTE_SubTestID_RWDigProt_FrameStructure6 , FELICA_DTE_SubTestID_RWDigProt_Setup_DP_POS , FELICA_DTE_SubTestID_RWDigProt_Setup_DP_NEG ,   FELICA_DTE_SubTestID_RWDigProt_Generic }
	FeliCa-DTE Reader/Writer Digital Protocol (Sub-)Test Type. More...

Functions
PTX_API_LIBFUNC ptxStatus_t	ptxFeliCa_DTE_Init (ptxFeliCa_DTE_t *feliCaDTEComp, ptxFeliCa_DTE_InitParams_t *initParams)
	Initializes the FeliCa-DTE Component.
PTX_API_LIBFUNC ptxStatus_t	ptxFeliCa_DTE_Deinit (ptxFeliCa_DTE_t *feliCaDTEComp)
	Deinitializes the FeliCa-DTE Component.
PTX_API_LIBFUNC ptxStatus_t	ptxFeliCa_DTE_EnableMode (ptxFeliCa_DTE_t *feliCaDTEComp, uint8_t enableMode, ptxFeliCa_DTE_TestParams_t *testParams)
	Enables/Disables the FeliCa-DTE mode in the system and configures the test parameters.
PTX_API_LIBFUNC ptxStatus_t	ptxFeliCa_DTE_RunTest (ptxFeliCa_DTE_t *feliCaDTEComp, ptxFeliCa_DTE_TestParams_t *testParams)
	Performs a FeliCa compliance test with given test parameters.

Detailed Description

Enumeration Type Documentation

ptxFeliCa_DTE_BitRate

enum ptxFeliCa_DTE_BitRate

FeliCa-DTE Test Type.

Enumerator
FELICA_DTE_BITRATE_212	RF Bitrate 212 kBit/s
FELICA_DTE_BITRATE_424	RF Bitrate 424 kBit/s

ptxFeliCa_DTE_RWDigProt_TestID

enum ptxFeliCa_DTE_RWDigProt_TestID

FeliCa-DTE Reader/Writer Digital Protocol (Sub-)Test Type.

Enumerator
FELICA_DTE_SubTestID_RWDigProt_eMoney_Variant1	Reader/Writer Digital Protocol Test - Only enabling eMoney payments, Variant 1: SC = 0x0000, RC = 0x00
FELICA_DTE_SubTestID_RWDigProt_eMoney_Variant2	Reader/Writer Digital Protocol Test - Only enabling eMoney payments, Variant 2: SC = 0xFFFF, RC = 0x01
FELICA_DTE_SubTestID_RWDigProt_eMoney_NFCDEP	Reader/Writer Digital Protocol Test - Enabling eMoney payments and NFC-DEP / P2P
FELICA_DTE_SubTestID_RWDigProt_FrameStructure	Reader/Writer Digital Protocol Test - All Frame Structure sequences (1-6)
FELICA_DTE_SubTestID_RWDigProt_FrameStructure1	Reader/Writer Digital Protocol Test - Frame Structure sequence 1
FELICA_DTE_SubTestID_RWDigProt_FrameStructure2	Reader/Writer Digital Protocol Test - Frame Structure sequence 2
FELICA_DTE_SubTestID_RWDigProt_FrameStructure3	Reader/Writer Digital Protocol Test - Frame Structure sequence 3
FELICA_DTE_SubTestID_RWDigProt_FrameStructure4	Reader/Writer Digital Protocol Test - Frame Structure sequence 4
FELICA_DTE_SubTestID_RWDigProt_FrameStructure5	Reader/Writer Digital Protocol Test - Frame Structure sequence 5
FELICA_DTE_SubTestID_RWDigProt_FrameStructure6	Reader/Writer Digital Protocol Test - Frame Structure sequence 6
FELICA_DTE_SubTestID_RWDigProt_Setup_DP_POS	Reader/Writer Digital Protocol Test - Setup DP Test-board - positive Encoding
FELICA_DTE_SubTestID_RWDigProt_Setup_DP_NEG	Reader/Writer Digital Protocol Test - Setup DP Test-board - negative Encoding
FELICA_DTE_SubTestID_RWDigProt_Generic	Reader/Writer Digital Protocol Test - Generic Test to send any (test-)command from application layer

ptxFeliCa_DTE_TestID

enum ptxFeliCa_DTE_TestID

FeliCa-DTE Test Type.

Enumerator
FELICA_DTE_TestID_PerformanceTest	RF-Performance Tests
FELICA_DTE_TestID_RWDigProtTest	Reader/Writer Digital Protocol Test

Function Documentation

ptxFeliCa_DTE_Deinit()

PTX_API_LIBFUNC ptxStatus_t ptxFeliCa_DTE_Deinit

(

ptxFeliCa_DTE_t *

feliCaDTEComp

)

Deinitializes the FeliCa-DTE Component.

Parameters

[in]

feliCaDTEComp

Pointer to an initialized instance of the FeliCa-DTE component.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxFeliCa_DTE_EnableMode()

PTX_API_LIBFUNC ptxStatus_t ptxFeliCa_DTE_EnableMode	(	ptxFeliCa_DTE_t *	feliCaDTEComp,
		uint8_t	enableMode,
		ptxFeliCa_DTE_TestParams_t *	testParams )

Enables/Disables the FeliCa-DTE mode in the system and configures the test parameters.

Parameters

[in]	feliCaDTEComp	Pointer to an initialized instance of the FeliCa-DTE component.
[in]	enableMode	Enables (!= 0) or Disables (0) the FeliCa-DTE mode.
[in]	testParams	Various test parameters for FeliCa compliance tests.

Returns

Status, indicating whether the operation was successful.

ptxFeliCa_DTE_Init()

PTX_API_LIBFUNC ptxStatus_t ptxFeliCa_DTE_Init	(	ptxFeliCa_DTE_t *	feliCaDTEComp,
		ptxFeliCa_DTE_InitParams_t *	initParams )

Initializes the FeliCa-DTE Component.

Parameters

[in]	feliCaDTEComp	Pointer to an allocated instance of the FeliCa-DTE component.
[in]	initParams	Pointer to initialization parameters.

Returns

Status, indicating whether the operation was successful.

ptxFeliCa_DTE_RunTest()

PTX_API_LIBFUNC ptxStatus_t ptxFeliCa_DTE_RunTest	(	ptxFeliCa_DTE_t *	feliCaDTEComp,
		ptxFeliCa_DTE_TestParams_t *	testParams )

Performs a FeliCa compliance test with given test parameters.

Parameters

[in]	feliCaDTEComp	Pointer to an initialized instance of the FeliCa-DTE component.
[in]	testParams	Various test parameters for FeliCa compliance tests.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.