CSIRX Instance APIs

Introduction

APIs to open/close top level CSIRX instance's

Data Structures
struct	CSIRX_Info
	CSIRX Instance information. More...
struct	CSIRX_ContextObject
	Context specific state information, not to be used by end users. More...
struct	CSIRX_Object
	CSIRX Instance Object. Used internally, not to be used by end users. More...
struct	CSIRX_HwAttrs
	CSIRX HW Attributes. Generated when using sysconfig. More...
struct	CSIRX_Config
	CSIRX Instance Config Object. More...

Functions
int32_t	CSIRX_init (void)
	Initialize CSIRX driver. More...
int32_t	CSIRX_deinit (void)
	De-Initialize CSIRX driver. More...
CSIRX_Handle	CSIRX_open (uint32_t instanceId)
	Open CSIRX driver. More...
int32_t	CSIRX_getInfo (CSIRX_Handle handle, CSIRX_Info *info)
	Get CSIRX instance info. More...
int32_t	CSIRX_reset (CSIRX_Handle handle)
	Reset CSIRX instance. More...
int32_t	CSIRX_close (CSIRX_Handle handle)
	Close CSIRX instance. More...

Typedefs
typedef struct CSIRX_Config_s *	CSIRX_Handle
	CSIRX driver handle. More...

Macros
#define	CSIRX_INTERRUPT_NOT_CONNECTED_ID   (0xFFFFU)
	Interrupt number ID to indicate, this interrupt line is not connected in this CPU. More...

FIFO depth
#define	CSIRX_FIFODEPTH_8X68   (2U)
	FIFO depth is 8 times 68-bits. More...
#define	CSIRX_FIFODEPTH_16X68   (3U)
	FIFO depth is 16 times 68-bits. More...
#define	CSIRX_FIFODEPTH_32X68   (4U)
	FIFO depth is 32 times 68-bits. More...
#define	CSIRX_FIFODEPTH_64X68   (5U)
	FIFO depth is 64 times 68-bits. More...
#define	CSIRX_FIFODEPTH_128X68   (6U)
	FIFO depth is 128 times 68-bits. More...
#define	CSIRX_FIFODEPTH_256X68   (7U)
	FIFO depth is 256 times 68-bits. More...

Macro Definition Documentation

CSIRX_INTERRUPT_NOT_CONNECTED_ID

#define CSIRX_INTERRUPT_NOT_CONNECTED_ID   (0xFFFFU)

Interrupt number ID to indicate, this interrupt line is not connected in this CPU.

CSIRX_FIFODEPTH_8X68

#define CSIRX_FIFODEPTH_8X68   (2U)

FIFO depth is 8 times 68-bits.

CSIRX_FIFODEPTH_16X68

#define CSIRX_FIFODEPTH_16X68   (3U)

FIFO depth is 16 times 68-bits.

CSIRX_FIFODEPTH_32X68

#define CSIRX_FIFODEPTH_32X68   (4U)

FIFO depth is 32 times 68-bits.

CSIRX_FIFODEPTH_64X68

#define CSIRX_FIFODEPTH_64X68   (5U)

FIFO depth is 64 times 68-bits.

CSIRX_FIFODEPTH_128X68

#define CSIRX_FIFODEPTH_128X68   (6U)

FIFO depth is 128 times 68-bits.

CSIRX_FIFODEPTH_256X68

#define CSIRX_FIFODEPTH_256X68   (7U)

FIFO depth is 256 times 68-bits.

Typedef Documentation

CSIRX_Handle

typedef struct CSIRX_Config_s* CSIRX_Handle

CSIRX driver handle.

Function Documentation

CSIRX_init()

int32_t CSIRX_init

(

void

)

Initialize CSIRX driver.

This does not touch the HW itself, it only initialized internal data structures. Called by SysConfig as part of System_init()

Returns

SystemP_SUCCESS on success, else failure

CSIRX_deinit()

int32_t CSIRX_deinit

(

void

)

De-Initialize CSIRX driver.

This does not touch the HW itself, it only de-initialized internal data structures. Called by SysConfig as part of System_deinit()

Returns

SystemP_SUCCESS on success, else failure

CSIRX_open()

CSIRX_Handle CSIRX_open

(

uint32_t

instanceId

)

Open CSIRX driver.

Parameters

instanceId

[in] CSIRX config to open. This acts as a index into gCsirxConfig[]

Returns

Handle to CSIRX driver for given instance. NULL in case of failure

CSIRX_getInfo()

int32_t CSIRX_getInfo	(	CSIRX_Handle	handle,
		CSIRX_Info *	info
	)

Get CSIRX instance info.

Parameters

handle	[in] CSIRX driver handle
info	[out] Instance information

Returns

SystemP_SUCCESS on success, else failure

CSIRX_reset()

int32_t CSIRX_reset

(

CSIRX_Handle

handle

)

Reset CSIRX instance.

Parameters

handle

[in] CSIRX driver handle

Returns

SystemP_SUCCESS on success, else failure

CSIRX_close()

int32_t CSIRX_close

(

CSIRX_Handle

handle

)

Close CSIRX instance.

Parameters

handle

[in] CSIRX driver handle

Returns

SystemP_SUCCESS on success, else failure

Variable Documentation

gCsirxConfig

CSIRX_Config gCsirxConfig[]

extern

Array of CSIRX instance enabled via SysConfig.

gCsirxConfigNum

uint32_t gCsirxConfigNum

extern

Number of CSIRX instances enabled via SysConfig.