CSI TX Sub-System

Introduction

Files
file	csitx_ss.h
	This file contains the prototypes of the APIs present in the device abstraction layer file of CSI TX SS. This also contains some related macros.

Data Structures
struct	CSL_CsitxRevisionId
	Structure for accessing Revision ID and Core Release Info. of CSI Tx module. More...
struct	CSL_CsitxColorbarGenCfg
	Structure for Color-bar generation configurations. More...
struct	CSL_CsitxRetransCfg
	Structure for re-transmission streams configurations. More...
struct	CSL_CsitxStrmStatus
	Structure for streams status. More...
struct	CSL_CsitxDMAConfig
	Structure for PSI-L/DMA configuration for CSI Tx SS. More...

Functions
void	CSL_csitxGetRevisionId (const CSL_csi_tx_ifRegs *ifRegisters, CSL_CsitxRevisionId *revId)
	This API is used get the CSI Tx revision ID. More...
int32_t	CSL_csitxColorbarCfg (const CSL_csi_tx_ifRegs *ifRegisters, const CSL_CsitxColorbarGenCfg *cfg)
	This API is used program the color bar generation parameters. More...
void	CSL_csitxEnableColorbarGen (CSL_csi_tx_ifRegs *ifRegisters, uint32_t enable)
	This API is used enable/disable Color-bar generation. More...
int32_t	CSL_csitxRetransCfg (const CSL_csi_tx_ifRegs *ifRegisters, const CSL_CsitxRetransCfg *cfg)
	This API is used program the re-transmission streams parameters. More...
void	CSL_csitxAssertPixelIfReset (CSL_csi_tx_ifRegs *ifRegisters, uint32_t assert)
	This API is used assert/de-assert reset for pixel interface. More...
void	CSL_csitxGetStrmStatus (const CSL_csi_tx_ifRegs *ifRegisters, CSL_CsitxStrmStatus *status)
	This API is used get the current stream status. More...
int32_t	CSL_csitxFrmToFrmDelayCfg (const CSL_csi_tx_ifRegs *ifRegisters, const uint32_t vc, const uint32_t delay)
	This API is used program frame to frame delay. More...
int32_t	CSL_csitxConfigDMA (CSL_csi_tx_ifRegs *ifRegisters, const CSL_CsitxDMAConfig *cfg)
	This API is used to configure DMA/PSIL thread. More...

Macros
#define	CSL_CSITX_PSI_L_THREAD_NUM_MAX   ((uint32_t)32U)
	Maximum number of PSI-L Threads supported by CSI Tx SS. More...

CSITX DMA Data Size Shift
DMA data size shift for unpacking.
#define	CSL_CSITX_DMA_DATA_SIZE_SHIFT_8BITS   (0U)
	DMA Data Size Shift: 8 bits. More...
#define	CSL_CSITX_DMA_DATA_SIZE_SHIFT_16BITS   (1U)
	DMA Data Size Shift: 16 bits. More...
#define	CSL_CSITX_DMA_DATA_SIZE_SHIFT_32BITS   (2U)
	DMA Data Size Shift: 32 bits. More...

CSITX YUV422 Mode
Storage class specifier for YUV422 data.
#define	CSL_CSITX_YUV422_MODE_UYVY   (0U)
	YUV422 Mode: UYVY. More...
#define	CSL_CSITX_YUV422_MODE_YUYV   (2U)
	YUV422 Mode: VYUY. More...
#define	CSL_CSITX_YUV422_MODE_VYUY   (1U)
	YUV422 Mode: YUYV. More...
#define	CSL_CSITX_YUV422_MODE_YVYU   (3U)
	YUV422 Mode: YVYU. More...

Macro Definition Documentation

#define CSL_CSITX_PSI_L_THREAD_NUM_MAX   ((uint32_t)32U)

Maximum number of PSI-L Threads supported by CSI Tx SS.

#define CSL_CSITX_DMA_DATA_SIZE_SHIFT_8BITS   (0U)

DMA Data Size Shift: 8 bits.

#define CSL_CSITX_DMA_DATA_SIZE_SHIFT_16BITS   (1U)

DMA Data Size Shift: 16 bits.

#define CSL_CSITX_DMA_DATA_SIZE_SHIFT_32BITS   (2U)

DMA Data Size Shift: 32 bits.

#define CSL_CSITX_YUV422_MODE_UYVY   (0U)

YUV422 Mode: UYVY.

#define CSL_CSITX_YUV422_MODE_YUYV   (2U)

YUV422 Mode: VYUY.

#define CSL_CSITX_YUV422_MODE_VYUY   (1U)

YUV422 Mode: YUYV.

#define CSL_CSITX_YUV422_MODE_YVYU   (3U)

YUV422 Mode: YVYU.

Function Documentation

void CSL_csitxGetRevisionId	(	const CSL_csi_tx_ifRegs *	ifRegisters,
		CSL_CsitxRevisionId *	revId
	)

This API is used get the CSI Tx revision ID.

Parameters

ifRegisters	Base Address of the CSI Tx SS Registers.
revId	Contains Revision ID of CSI Tx module. Refer to CSL_CsitxRevisionId.

Returns

None.

int32_t CSL_csitxColorbarCfg	(	const CSL_csi_tx_ifRegs *	ifRegisters,
		const CSL_CsitxColorbarGenCfg *	cfg
	)

This API is used program the color bar generation parameters.

Parameters

ifRegisters	Base Address of the CSI Tx SS Registers.
cfg	Color-bar generation configurations. Refer to CSL_CsitxColorbarGenCfg.

Returns

status CSL_PASS if successful otherwise CSL_EFAIL.

void CSL_csitxEnableColorbarGen	(	CSL_csi_tx_ifRegs *	ifRegisters,
		uint32_t	enable
	)

This API is used enable/disable Color-bar generation.

Parameters

ifRegisters	Base Address of the CSI Tx SS Registers.
enable	Color-bar generation is enabled if it is TRUE. Color-bar generation is disabled if it is FALSE.

Returns

None.

int32_t CSL_csitxRetransCfg	(	const CSL_csi_tx_ifRegs *	ifRegisters,
		const CSL_CsitxRetransCfg *	cfg
	)

This API is used program the re-transmission streams parameters.

Parameters

ifRegisters	Base Address of the CSI Tx SS Registers.
cfg	Re-transmission streams configurations. Refer to CSL_CsitxRetransCfg.

Returns

status CSL_PASS if successful otherwise CSL_EFAIL.

void CSL_csitxAssertPixelIfReset	(	CSL_csi_tx_ifRegs *	ifRegisters,
		uint32_t	assert
	)

This API is used assert/de-assert reset for pixel interface.

Parameters

ifRegisters	Base Address of the CSI Tx SS Registers.
assert	Reset is asserted if it is TRUE. Reset is not asserted if it is FALSE.

Returns

None.

void CSL_csitxGetStrmStatus	(	const CSL_csi_tx_ifRegs *	ifRegisters,
		CSL_CsitxStrmStatus *	status
	)

This API is used get the current stream status.

Parameters

ifRegisters	Base Address of the CSI Tx SS Registers.
status	Stream status. Refer to CSL_CsitxStrmStatus.

Returns

None.

int32_t CSL_csitxFrmToFrmDelayCfg	(	const CSL_csi_tx_ifRegs *	ifRegisters,
		const uint32_t	vc,
		const uint32_t	delay
	)

This API is used program frame to frame delay.

Parameters

ifRegisters	Base Address of the CSI Tx SS Registers.
vc	Virtual channel number for which delay needs to configured.
delay	Delay in number of main clock cyles from start of last frame line to start of next frame first line.

Returns

status CSL_PASS if successful otherwise CSL_EFAIL.

int32_t CSL_csitxConfigDMA	(	CSL_csi_tx_ifRegs *	ifRegisters,
		const CSL_CsitxDMAConfig *	cfg
	)

This API is used to configure DMA/PSIL thread.

Parameters

ifRegisters	Base Address of the CSI Tx SS Registers.
cfg	Pointer to DMA/PSIL Configurations. Refer to CSL_CsitxDMAConfig

Returns

status CSL_PASS if successful otherwise CSL_EFAIL.