CSIRX Debug APIs

Introduction

APIs related to CSIRX debug features. Typically not used by applications.

Functions
int32_t	CSIRX_debugModeSetShortPacket (CSIRX_Handle handle, uint32_t shortPacket)
	Set short packet header. More...
int32_t	CSIRX_debugModeSetLongPacketHeader (CSIRX_Handle handle, uint32_t longPacketHeader)
	Set long packet header. More...
int32_t	CSIRX_debugModeSetLongPacketPayload (CSIRX_Handle handle, uint32_t payload)
	Set long packet payload. More...
int32_t	CSIRX_debugModeEnable (CSIRX_Handle handle)
	Enable debug mode. More...
int32_t	CSIRX_debugModeDisable (CSIRX_Handle handle)
	Disable debug mode. More...
void	CSIRX_debugModeGenerateFrames (CSIRX_Handle handle, uint16_t txFormat, uint8_t virtualChannelId, uint32_t numOfFrames, uint32_t numLinesPerFrame, uint32_t numBytesPerLine)
	Generate frames in debug mode. More...

Function Documentation

CSIRX_debugModeSetShortPacket()

int32_t CSIRX_debugModeSetShortPacket	(	CSIRX_Handle	handle,
		uint32_t	shortPacket
	)

Set short packet header.

Parameters

handle	[in] CSIRX driver handle
shortPacket	[in] short packet header

Returns

SystemP_SUCCESS on success, else failure

CSIRX_debugModeSetLongPacketHeader()

int32_t CSIRX_debugModeSetLongPacketHeader	(	CSIRX_Handle	handle,
		uint32_t	longPacketHeader
	)

Set long packet header.

Parameters

handle	[in] CSIRX driver handle
longPacketHeader	[in] Long packet header

Returns

SystemP_SUCCESS on success, else failure

CSIRX_debugModeSetLongPacketPayload()

int32_t CSIRX_debugModeSetLongPacketPayload	(	CSIRX_Handle	handle,
		uint32_t	payload
	)

Set long packet payload.

Parameters

handle	[in] CSIRX driver handle
payload	[in] long packet payload

Returns

SystemP_SUCCESS on success, else failure

CSIRX_debugModeEnable()

int32_t CSIRX_debugModeEnable

(

CSIRX_Handle

handle

)

Enable debug mode.

Parameters

handle

[in] CSIRX driver handle

Returns

SystemP_SUCCESS on success, else failure

CSIRX_debugModeDisable()

int32_t CSIRX_debugModeDisable

(

CSIRX_Handle

handle

)

Disable debug mode.

Parameters

handle

[in] CSIRX driver handle

Returns

SystemP_SUCCESS on success, else failure

CSIRX_debugModeGenerateFrames()

void CSIRX_debugModeGenerateFrames	(	CSIRX_Handle	handle,
		uint16_t	txFormat,
		uint8_t	virtualChannelId,
		uint32_t	numOfFrames,
		uint32_t	numLinesPerFrame,
		uint32_t	numBytesPerLine
	)

Generate frames in debug mode.

CSIRX_debugModeEnable needs to be called before this API

Parameters

handle	[in] CSIRX driver handle
txFormat	[in] see CSIRX_DATA_FORMAT
virtualChannelId	[in] 0..3
numOfFrames	[in] Number of frames of debug data to generate
numLinesPerFrame	[in] Lines per frame
numBytesPerLine	[in] Bytes per line