RF Test API

Collaboration diagram for RF Test API:

Data Structures
struct	ptxRF_Test_PRBS_Params
	RF-Test Test Parameters for PRBS-Test. More...
struct	ptxRF_Test_Carrier_Params
	RF-Test Test Parameters for Carrier-Test. More...
union	ptxRF_Test_Params
	RF-Test Parameters. More...
struct	ptxRF_Test_TestParams
	RF-Test Test Parameters. More...
struct	ptxRF_Test_InitParams
	RF-Test Initialization Parameters. More...
struct	ptxRF_Test
	RF-Test Component. More...

Macros
#define	PTX_RF_TEST_FLAGS_PRBS_TYPE_A_INCLUDE_PARITY   (uint8_t)0x01
	RF-Test Flags for PRBS.

Typedefs
typedef enum ptxRF_Test_TestID	ptxRF_Test_TestID_t
	RF-Test Test ID.
typedef enum ptxRF_Test_TechType	ptxRF_Test_TechType_t
	RF-Test Test Type.
typedef enum ptxRF_Test_BitRate	ptxRF_Test_BitRate_t
	RF-Test Test Type.
typedef struct ptxRF_Test_PRBS_Params	ptxRF_Test_PRBS_Params_t
	RF-Test Test Parameters for PRBS-Test.
typedef struct ptxRF_Test_Carrier_Params	ptxRF_Test_Carrier_Params_t
	RF-Test Test Parameters for Carrier-Test.
typedef union ptxRF_Test_Params	ptxRF_Test_Params_t
	RF-Test Parameters.
typedef struct ptxRF_Test_TestParams	ptxRF_Test_TestParams_t
	RF-Test Test Parameters.
typedef struct ptxRF_Test_InitParams	ptxRF_Test_InitParams_t
	RF-Test Initialization Parameters.
typedef struct ptxRF_Test	ptxRF_Test_t
	RF-Test Component.

Enumerations
enum	ptxRF_Test_TestID { RF_TEST_ID_PRBS_9 , RF_TEST_ID_PRBS_15 , RF_TEST_ID_Carrier }
	RF-Test Test ID. More...
enum	ptxRF_Test_TechType { RF_TEST_TECH_A , RF_TEST_TECH_B , RF_TEST_TECH_F , RF_TEST_TECH_V }
	RF-Test Test Type. More...
enum	ptxRF_Test_BitRate {   RF_TEST_BITRATE_106 = 0 , RF_TEST_BITRATE_212 = 1 , RF_TEST_BITRATE_424 = 2 , RF_TEST_BITRATE_848 = 3 ,   RF_TEST_BITRATE_26 = 6 }
	RF-Test Test Type. More...

Functions
ptxStatus_t	ptxRF_Test_Init (ptxRF_Test_t *rfTestComp, ptxRF_Test_InitParams_t *initParams)
	Initializes the RF-Test Component.
ptxStatus_t	ptxRF_Test_Deinit (ptxRF_Test_t *rfTestComp)
	Deinitializes the RF-Test Component.
ptxStatus_t	ptxRF_Test_RunTest (ptxRF_Test_t *rfTestComp, ptxRF_Test_TestParams_t *testParams)
	Performs a given RF-Test using the provided test parameters.
ptxStatus_t	ptxRF_Test_StopTest (ptxRF_Test_t *rfTestComp)
	Stops an ongoing RF-Test.

Detailed Description

Macro Definition Documentation

PTX_RF_TEST_FLAGS_PRBS_TYPE_A_INCLUDE_PARITY

#define PTX_RF_TEST_FLAGS_PRBS_TYPE_A_INCLUDE_PARITY   (uint8_t)0x01

RF-Test Flags for PRBS.

Enable/Disable Parity-Generation for Type-A

Enumeration Type Documentation

ptxRF_Test_BitRate

enum ptxRF_Test_BitRate

RF-Test Test Type.

Enumerator
RF_TEST_BITRATE_106	RF Bitrate 106 kBit/s
RF_TEST_BITRATE_212	RF Bitrate 212 kBit/s
RF_TEST_BITRATE_424	RF Bitrate 424 kBit/s
RF_TEST_BITRATE_848	RF Bitrate 848 kBit/s
RF_TEST_BITRATE_26	RF Bitrate 26,5 kBit/s

ptxRF_Test_TechType

enum ptxRF_Test_TechType

RF-Test Test Type.

Enumerator
RF_TEST_TECH_A	NFC-A Technology
RF_TEST_TECH_B	NFC-B Technology
RF_TEST_TECH_F	NFC-F Technology
RF_TEST_TECH_V	NFC-V Technology

ptxRF_Test_TestID

enum ptxRF_Test_TestID

RF-Test Test ID.

Enumerator
RF_TEST_ID_PRBS_9	PRBS-9 Test
RF_TEST_ID_PRBS_15	PRBS-15 Test
RF_TEST_ID_Carrier	Unmodulated Carrier-On Test

Function Documentation

ptxRF_Test_Deinit()

ptxStatus_t ptxRF_Test_Deinit

(

ptxRF_Test_t *

rfTestComp

)

Deinitializes the RF-Test Component.

Parameters

[in]

rfTestComp

Pointer to an initialized instance of the RF-Test component.

Returns

Status indicating whether the operation was successful. See ptxStatus_t.

ptxRF_Test_Init()

ptxStatus_t ptxRF_Test_Init	(	ptxRF_Test_t *	rfTestComp,
		ptxRF_Test_InitParams_t *	initParams )

Initializes the RF-Test Component.

Parameters

[in]	rfTestComp	Pointer to an allocated instance of the RF-Test component.
[in]	initParams	Pointer to initialization parameters.

Returns

Status, indicating whether the operation was successful.

ptxRF_Test_RunTest()

ptxStatus_t ptxRF_Test_RunTest	(	ptxRF_Test_t *	rfTestComp,
		ptxRF_Test_TestParams_t *	testParams )

Performs a given RF-Test using the provided test parameters.

Parameters

[in]	rfTestComp	Pointer to an initialized instance of the RF-Test component.
[in]	testParams	Various test parameters for RF-Test compliance tests.

Returns

Status Indicating whether the operation was successful. See ptxStatus_t.

ptxRF_Test_StopTest()

ptxStatus_t ptxRF_Test_StopTest

(

ptxRF_Test_t *

rfTestComp

)

Stops an ongoing RF-Test.

Parameters

[in]

rfTestComp

Pointer to an initialized instance of the RF-Test component.

Returns

Status Indicating whether the operation was successful. See ptxStatus_t.