Introduction

APIs related to CSIRX complex IO lanes

Data Structures
struct	CSIRX_ComplexioLaneConfig
	Lane configuration. More...

struct	CSIRX_ComplexioLaneIntr
	Complex IO per lane interrupt. More...

struct	CSIRX_ComplexioLanesIntr
	Complex IO all (logical) lanes interrupts. More...

struct	CSIRX_ComplexioLanesConfig
	All lanes configuration. More...

struct	CSIRX_ComplexioConfig
	Complex IO configuration. More...

Functions
void	CSIRX_ComplexioConfig_init (CSIRX_ComplexioConfig *config)
	Sets default values for configuration. More...

int32_t	CSIRX_complexioSetConfig (CSIRX_Handle handle, CSIRX_ComplexioConfig *config)
	Configure Complex IO. More...

int32_t	CSIRX_complexioClearAllIntr (CSIRX_Handle handle)
	Celar all pending complex IO interrupts. More...

int32_t	CSIRX_complexioGetPendingIntr (CSIRX_Handle handle, CSIRX_ComplexioLanesIntr *intrStatus)
	Get all pending complex IO interrupts. More...

int32_t	CSIRX_complexioGetPowerStatus (CSIRX_Handle handle, uint8_t *powerStatus)
	Query about ComplexIO power status. More...

int32_t	CSIRX_complexioSetPowerCommand (CSIRX_Handle handle, uint8_t powerCommand)
	Set Complex IO power command. More...

int32_t	CSIRX_complexioDeassertReset (CSIRX_Handle handle)
	Deaasert complex IO reset. More...

int32_t	CSIRX_complexioAssertForceRxModeOn (CSIRX_Handle handle)
	Assert Force Rx Mode on complex IO. More...

int32_t	CSIRX_complexioDeassertForceRxModeOn (CSIRX_Handle handle)
	De-assert Force Rx Mode on complex IO. More...

int32_t	CSIRX_complexioIsResetDone (CSIRX_Handle handle, bool *isDone)
	Check if complex IO reset is done. More...

int32_t	CSIRX_complexioIsDeassertForceRxModeOn (CSIRX_Handle handle, bool *isDeasserted)
	Check if force RX mode on is deasserted. More...

static int32_t	CSIRX_complexioPowerOn (CSIRX_Handle handle)
	Power ON complex IO. More...

static int32_t	CSIRX_complexioPowerOff (CSIRX_Handle handle)
	Power OFF complex IO. More...

static int32_t	CSIRX_complexioUltraLowPower (CSIRX_Handle handle)
	Put complex IO in ULP (Ultra Low Power) state. More...

Macros
#define	CSIRX_DATA_LANES_MAX (4U)
	Max possible data lanes. More...

Complex IO power commands

#define	CSIRX_COMPLEXIO_POWER_COMMAND_OFF (0U)
	Power off ComplexIO. More...

#define	CSIRX_COMPLEXIO_POWER_COMMAND_ON (1U)
	Power on ComplexIO. More...

#define	CSIRX_COMPLEXIO_POWER_COMMAND_ULP (2U)
	Put ComplexIO in ULP (Ultra Low Power) state. More...

Complex IO power status

#define	CSIRX_COMPLEXIO_POWER_STATUS_OFF (0U)
	Complex IO power status OFF. More...

#define	CSIRX_COMPLEXIO_POWER_STATUS_ON (1U)
	Complex IO power status ON. More...

#define	CSIRX_COMPLEXIO_POWER_STATUS_ULP (2U)
	Complex IO power status ULP (Ultra Low Power) More...

Lane polarity

#define	CSIRX_LANE_POLARITY_PLUS_MINUS (0U)
	Lane polarity +/-. More...

#define	CSIRX_LANE_POLARITY_MINUS_PLUS (1U)
	Lane polarity -/+. More...

Lane position

#define	CSIRX_LANE_POSITION_LANE_NOT_USED (0U)
	Lane not used. More...

#define	CSIRX_LANE_POSITION_1 (1U)
	Physical lane position #1. More...

#define	CSIRX_LANE_POSITION_2 (2U)
	Physical lane position #2. More...

#define	CSIRX_LANE_POSITION_3 (3U)
	Physical lane position #3. More...

#define	CSIRX_LANE_POSITION_4 (4U)
	Physical lane position #4. More...

#define	CSIRX_LANE_POSITION_5 (5U)
	Physical lane position #5. More...

Macro Definition Documentation

◆ CSIRX_DATA_LANES_MAX

#define CSIRX_DATA_LANES_MAX (4U)

Max possible data lanes.

◆ CSIRX_COMPLEXIO_POWER_COMMAND_OFF

#define CSIRX_COMPLEXIO_POWER_COMMAND_OFF (0U)

Power off ComplexIO.

◆ CSIRX_COMPLEXIO_POWER_COMMAND_ON

#define CSIRX_COMPLEXIO_POWER_COMMAND_ON (1U)

Power on ComplexIO.

◆ CSIRX_COMPLEXIO_POWER_COMMAND_ULP

#define CSIRX_COMPLEXIO_POWER_COMMAND_ULP (2U)

Put ComplexIO in ULP (Ultra Low Power) state.

◆ CSIRX_COMPLEXIO_POWER_STATUS_OFF

#define CSIRX_COMPLEXIO_POWER_STATUS_OFF (0U)

Complex IO power status OFF.

◆ CSIRX_COMPLEXIO_POWER_STATUS_ON

#define CSIRX_COMPLEXIO_POWER_STATUS_ON (1U)

Complex IO power status ON.

◆ CSIRX_COMPLEXIO_POWER_STATUS_ULP

#define CSIRX_COMPLEXIO_POWER_STATUS_ULP (2U)

Complex IO power status ULP (Ultra Low Power)

◆ CSIRX_LANE_POLARITY_PLUS_MINUS

#define CSIRX_LANE_POLARITY_PLUS_MINUS (0U)

Lane polarity +/-.

◆ CSIRX_LANE_POLARITY_MINUS_PLUS

#define CSIRX_LANE_POLARITY_MINUS_PLUS (1U)

Lane polarity -/+.

◆ CSIRX_LANE_POSITION_LANE_NOT_USED

#define CSIRX_LANE_POSITION_LANE_NOT_USED (0U)

Lane not used.

◆ CSIRX_LANE_POSITION_1

#define CSIRX_LANE_POSITION_1 (1U)

Physical lane position #1.

◆ CSIRX_LANE_POSITION_2

#define CSIRX_LANE_POSITION_2 (2U)

Physical lane position #2.

◆ CSIRX_LANE_POSITION_3

#define CSIRX_LANE_POSITION_3 (3U)

Physical lane position #3.

◆ CSIRX_LANE_POSITION_4

#define CSIRX_LANE_POSITION_4 (4U)

Physical lane position #4.

◆ CSIRX_LANE_POSITION_5

#define CSIRX_LANE_POSITION_5 (5U)

Physical lane position #5.

Function Documentation

◆ CSIRX_ComplexioConfig_init()

void CSIRX_ComplexioConfig_init ( CSIRX_ComplexioConfig * config )

Sets default values for configuration.

Parameters

config [in] configuration

◆ CSIRX_complexioSetConfig()

int32_t CSIRX_complexioSetConfig	(	CSIRX_Handle	handle,
		CSIRX_ComplexioConfig *	config
	)

Configure Complex IO.

Parameters

handle	[in] CSIRX driver handle
config	[in] Complex IO configuration

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioClearAllIntr()

int32_t CSIRX_complexioClearAllIntr ( CSIRX_Handle handle )

Celar all pending complex IO interrupts.

Parameters

handle [in] CSIRX driver handle

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioGetPendingIntr()

int32_t CSIRX_complexioGetPendingIntr	(	CSIRX_Handle	handle,
		CSIRX_ComplexioLanesIntr *	intrStatus
	)

Get all pending complex IO interrupts.

Parameters

handle	[in] CSIRX driver handle
intrStatus	[out] Interrupt status

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioGetPowerStatus()

int32_t CSIRX_complexioGetPowerStatus	(	CSIRX_Handle	handle,
		uint8_t *	powerStatus
	)

Query about ComplexIO power status.

See also: CSIRX_complexioPowerOn, CSIRX_complexioPowerOff, CSIRX_complexioUltraLowPower

Parameters

handle	[in] CSIRX driver handle
powerStatus	[out] One of CSIRX_COMPLEXIO_POWER_STATUS

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioSetPowerCommand()

int32_t CSIRX_complexioSetPowerCommand	(	CSIRX_Handle	handle,
		uint8_t	powerCommand
	)

Set Complex IO power command.

Parameters

handle	[in] CSIRX driver handle
powerCommand	[out] one of CSIRX_COMPLEXIO_POWER_COMMAND

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioDeassertReset()

int32_t CSIRX_complexioDeassertReset ( CSIRX_Handle handle )

Deaasert complex IO reset.

Parameters

handle [in] CSIRX driver handle

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioAssertForceRxModeOn()

int32_t CSIRX_complexioAssertForceRxModeOn ( CSIRX_Handle handle )

Assert Force Rx Mode on complex IO.

Parameters

handle [in] CSIRX driver handle

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioDeassertForceRxModeOn()

int32_t CSIRX_complexioDeassertForceRxModeOn ( CSIRX_Handle handle )

De-assert Force Rx Mode on complex IO.

Parameters

handle [in] CSIRX driver handle

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioIsResetDone()

int32_t CSIRX_complexioIsResetDone	(	CSIRX_Handle	handle,
		bool *	isDone
	)

Check if complex IO reset is done.

Parameters

handle	[in] CSIRX driver handle
isDone	[out] true: reset is done, false: reset is not done

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioIsDeassertForceRxModeOn()

int32_t CSIRX_complexioIsDeassertForceRxModeOn	(	CSIRX_Handle	handle,
		bool *	isDeasserted
	)

Check if force RX mode on is deasserted.

Parameters

handle	[in] CSIRX driver handle
isDeasserted	[out] true: deassert is done, false: deassert is not done

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioPowerOn()

static int32_t CSIRX_complexioPowerOn ( CSIRX_Handle handle )

inlinestatic

Power ON complex IO.

Parameters

handle [in] CSIRX driver handle

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioPowerOff()

static int32_t CSIRX_complexioPowerOff ( CSIRX_Handle handle )

inlinestatic

Power OFF complex IO.

Parameters

handle [in] CSIRX driver handle

Returns: SystemP_SUCCESS on success, else failure

◆ CSIRX_complexioUltraLowPower()

static int32_t CSIRX_complexioUltraLowPower ( CSIRX_Handle handle )

inlinestatic

Put complex IO in ULP (Ultra Low Power) state.

Parameters

handle [in] CSIRX driver handle

Returns: SystemP_SUCCESS on success, else failure

Introduction

Data Structures

Functions

Macros

Complex IO power commands

Complex IO power status

Lane polarity

Lane position

Macro Definition Documentation

◆ CSIRX_DATA_LANES_MAX

◆ CSIRX_COMPLEXIO_POWER_COMMAND_OFF

◆ CSIRX_COMPLEXIO_POWER_COMMAND_ON

◆ CSIRX_COMPLEXIO_POWER_COMMAND_ULP

◆ CSIRX_COMPLEXIO_POWER_STATUS_OFF

◆ CSIRX_COMPLEXIO_POWER_STATUS_ON

◆ CSIRX_COMPLEXIO_POWER_STATUS_ULP

◆ CSIRX_LANE_POLARITY_PLUS_MINUS

◆ CSIRX_LANE_POLARITY_MINUS_PLUS

◆ CSIRX_LANE_POSITION_LANE_NOT_USED

◆ CSIRX_LANE_POSITION_1

◆ CSIRX_LANE_POSITION_2

◆ CSIRX_LANE_POSITION_3

◆ CSIRX_LANE_POSITION_4

◆ CSIRX_LANE_POSITION_5

Function Documentation

◆ CSIRX_ComplexioConfig_init()

◆ CSIRX_complexioSetConfig()

◆ CSIRX_complexioClearAllIntr()

◆ CSIRX_complexioGetPendingIntr()

◆ CSIRX_complexioGetPowerStatus()

◆ CSIRX_complexioSetPowerCommand()

◆ CSIRX_complexioDeassertReset()

◆ CSIRX_complexioAssertForceRxModeOn()

◆ CSIRX_complexioDeassertForceRxModeOn()

◆ CSIRX_complexioIsResetDone()

◆ CSIRX_complexioIsDeassertForceRxModeOn()

◆ CSIRX_complexioPowerOn()

◆ CSIRX_complexioPowerOff()

◆ CSIRX_complexioUltraLowPower()