Introduction

This is CSI2 Rx's top level include for applications.

Files
file	csirx.h
	CSIRX Driver API/interface file.

Macros
#define	CSIRX_CAPT_DRV_ID (FVID2_CSIRX_DRV_BASE + 0x00000000U)
	CSIRX capture driver ID used at the time of FVID2 create. More...

#define	IOCTL_CSIRX_GET_INST_STATUS (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0000U)
	Get capture status IOCTL. More...

#define	IOCTL_CSIRX_PRINT_DEBUG_LOGS (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0100U)
	Print capture debug logs. More...

#define	IOCTL_CSIRX_SET_DPHY_CONFIG (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0200U)
	Set CSIRX D-PHY Configuration Parameters. More...

#define	IOCTL_CSIRX_REGISTER_EVENT (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0300U)
	Register CSIRX events. More...

#define	IOCTL_CSIRX_UNREGISTER_EVENT (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0400U)
	Un-register CSIRX events. More...

Macro Definition Documentation

#define CSIRX_CAPT_DRV_ID (FVID2_CSIRX_DRV_BASE + 0x00000000U)

CSIRX capture driver ID used at the time of FVID2 create.

#define IOCTL_CSIRX_GET_INST_STATUS (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0000U)

Get capture status IOCTL.

This IOCTL can be used to get the capture status like number of frames queued/dequeued. Note: These counters will be reset either at the time of driver create or while starting the capture operation. See respective counter comments for details.

Parameters

cmdArgs	[OUT] Csirx_InstStatus *
cmdArgsStatus	[OUT] NULL

Returns: FVID2_SOK on success, else failure

#define IOCTL_CSIRX_PRINT_DEBUG_LOGS (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0100U)

Print capture debug logs.

This IOCTL can be used to print the capture debug logs if enabled through CSIRX_DRV_ENABLE_DEBUG. Note: These logs will be reset at the time of driver create.

Parameters

cmdArgs	[OUT] NULL
cmdArgsStatus	[OUT] NULL

Returns: FVID2_SOK on success, else failure

#define IOCTL_CSIRX_SET_DPHY_CONFIG (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0200U)

Set CSIRX D-PHY Configuration Parameters.

This IOCTL can be used to set CSIRX D-PHY configuration parameters.

Parameters

cmdArgs	[IN] Csirx_DPhyCfg *
cmdArgsStatus	[OUT] NULL

Returns: FVID2_SOK on success, else failure

#define IOCTL_CSIRX_REGISTER_EVENT (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0300U)

Register CSIRX events.

This IOCTL can be used to set enable/register CSIRX events. Note: This IOCTL should be called after calling Fvid2_create() for particular instance.

Parameters

cmdArgs	[IN] Fdrv_Handle
cmdArgs	[IN] CsirxDrv_EventPrms *
cmdArgsStatus	[OUT] NULL

Returns: FVID2_SOK on success, else failure

#define IOCTL_CSIRX_UNREGISTER_EVENT (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0400U)

Un-register CSIRX events.

This IOCTL can be used to set disable/un-register CSIRX events. Note: This IOCTL should be called after calling Fvid2_delete() for particular instance.

Parameters

cmdArgs	[IN] Fdrv_Handle
cmdArgs	[IN] eventGroup
cmdArgsStatus	[OUT] NULL

Returns: FVID2_SOK on success, else failure

Introduction

Files

Macros

Macro Definition Documentation