PTX NSC Stack System

Collaboration diagram for PTX NSC Stack System:

Data Structures
struct	ptxNSC_System
	PTX NSC system values. More...

Typedefs
typedef struct ptxNSC_System	ptxNSC_System_t
	PTX NSC system values.

Functions
ptxStatus_t	ptxNSC_System_SetConfig (struct ptxNSC *nscCtx, ptxNSC_System_t *sysParams)
	Function used to directly set System-Config parameters.
ptxStatus_t	ptxNSC_System_GetConfig (struct ptxNSC *nscCtx, ptxNSC_System_t *sysParams)
	Function used to retrieve the current System-Config parameters.
ptxStatus_t	ptxNSC_System_ApplyDefaults (struct ptxNSC *nscCtx)
	Function used to apply default System-Config parameters.

Default Values
#define	SYSTEM_DEFAULT_VERSION   (0x10U)
#define	SYSTEM_DEFAULT_PA_OVERCURRENT_TH   (0x04U)
#define	SYSTEM_DEFAULT_PA_TEMPERATURE_TH   (0xFFU)
#define	SYSTEM_DEFAULT_CON_CLK_SOURCE   (0x00U)
#define	SYSTEM_DEFAULT_CON_VAR_LBS   (0x20U)

System Features - Config Tags
#define	SYSTEM_CFG_TAG_VERSION   (0x00U)
#define	SYSTEM_CFG_TAG_PA_OVERCURRENT_TH   (0x01U)
#define	SYSTEM_CFG_TAG_PA_TEMPERATURE_TH   (0x02U)
#define	SYSTEM_CFG_TAG_CON_CLK_SOURCE   (0x03U)
#define	SYSTEM_CFG_TAG_CON_VAR_LBS   (0x04U)
#define	SYSTEM_CFG_TAG_CON_NHOST   (0x05U)
#define	SYSTEM_CFG_TAG_CON_NHOST_CE   (0x06U)

Detailed Description

Macro Definition Documentation

SYSTEM_CFG_TAG_CON_CLK_SOURCE

#define SYSTEM_CFG_TAG_CON_CLK_SOURCE   (0x03U)

Config Tag Clock synthesizer source

SYSTEM_CFG_TAG_CON_NHOST

#define SYSTEM_CFG_TAG_CON_NHOST   (0x05U)

Config Tag Division factor for Clock synthesizer.

SYSTEM_CFG_TAG_CON_NHOST_CE

#define SYSTEM_CFG_TAG_CON_NHOST_CE   (0x06U)

Config Tag Division factor for Clock synthesizer in CE-mode.

SYSTEM_CFG_TAG_CON_VAR_LBS

#define SYSTEM_CFG_TAG_CON_VAR_LBS   (0x04U)

Config Tag reference division select

SYSTEM_CFG_TAG_PA_OVERCURRENT_TH

#define SYSTEM_CFG_TAG_PA_OVERCURRENT_TH   (0x01U)

Config Tag Power Amp Overcurrent threshold

SYSTEM_CFG_TAG_PA_TEMPERATURE_TH

#define SYSTEM_CFG_TAG_PA_TEMPERATURE_TH   (0x02U)

Config Tag Power Amp Temperature threshold

SYSTEM_CFG_TAG_VERSION

#define SYSTEM_CFG_TAG_VERSION   (0x00U)

Config Tag version

SYSTEM_DEFAULT_CON_CLK_SOURCE

#define SYSTEM_DEFAULT_CON_CLK_SOURCE   (0x00U)

System Default Clock synthesizer source

SYSTEM_DEFAULT_CON_VAR_LBS

#define SYSTEM_DEFAULT_CON_VAR_LBS   (0x20U)

System Default reference division select

SYSTEM_DEFAULT_PA_OVERCURRENT_TH

#define SYSTEM_DEFAULT_PA_OVERCURRENT_TH   (0x04U)

System Default Power Amp Overcurrent threshold

SYSTEM_DEFAULT_PA_TEMPERATURE_TH

#define SYSTEM_DEFAULT_PA_TEMPERATURE_TH   (0xFFU)

System Default Power Amp Temperature threshold

SYSTEM_DEFAULT_VERSION

#define SYSTEM_DEFAULT_VERSION   (0x10U)

System Default version

Function Documentation

ptxNSC_System_ApplyDefaults()

ptxStatus_t ptxNSC_System_ApplyDefaults

(

struct ptxNSC *

nscCtx

)

Function used to apply default System-Config parameters.

Parameters

[in]

nscCtx

Pointer to the component structure.

Returns

Status of the operation. See definition of ptxStatus_t.

ptxNSC_System_GetConfig()

ptxStatus_t ptxNSC_System_GetConfig	(	struct ptxNSC *	nscCtx,
		ptxNSC_System_t *	sysParams )

Function used to retrieve the current System-Config parameters.

Parameters

[in]	nscCtx	Pointer to the component structure.
[out]	sysParams	Pointer to the System Config Parameters.

Returns

Status of the operation. See definition of ptxStatus_t.

ptxNSC_System_SetConfig()

ptxStatus_t ptxNSC_System_SetConfig	(	struct ptxNSC *	nscCtx,
		ptxNSC_System_t *	sysParams )

Function used to directly set System-Config parameters.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	sysParams	Pointer to the System Config Parameters.

Returns

Status of the operation. See definition of ptxStatus_t.