This is CSI2 Rx's top level include for applications.
|
file | csirx.h |
| CSIRX Driver API/interface file.
|
|
◆ CSIRX_CAPT_DRV_ID
#define CSIRX_CAPT_DRV_ID (FVID2_CSIRX_DRV_BASE + 0x00000000U) |
CSIRX capture driver ID used at the time of FVID2 create.
◆ IOCTL_CSIRX_GET_INST_STATUS
#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
-
- Returns
- FVID2_SOK on success, else failure
◆ IOCTL_CSIRX_PRINT_DEBUG_LOGS
#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
◆ IOCTL_CSIRX_SET_DPHY_CONFIG
#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
-
- Returns
- FVID2_SOK on success, else failure
◆ IOCTL_CSIRX_REGISTER_EVENT
#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
◆ IOCTL_CSIRX_UNREGISTER_EVENT
#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
◆ IOCTL_CSIRX_GET_INST_CH_NUM
#define IOCTL_CSIRX_GET_INST_CH_NUM (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0500U) |
Get number of channels created for a given driver instance.
This IOCTL can be used to get number of channels created for given instance. Note: This IOCTL should be called after calling Fvid2_create() for particular instance.
- Parameters
-
cmdArgs | [IN] Fdrv_Handle |
cmdArgs | [IN] (uint32_t *)Pointer to variable where number of channels created for given instance has to stored |
cmdArgsStatus | [OUT] NULL |
- Returns
- FVID2_SOK on success, else failure
◆ IOCTL_CSIRX_CH_START
#define IOCTL_CSIRX_CH_START (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0600U) |
Start a channel for capture. This will start up PSIL thread, UDMA channel.
This IOCTL can be used to start/enable capture channel. Note: This IOCTL should be called after calling 'Fvid2_create()' and before 'Fvid2_delete()' for particular instance.
- Parameters
-
cmdArgs | [IN] Fdrv_Handle |
cmdArgs | [IN] channel ID |
cmdArgsStatus | [OUT] NULL |
- Returns
- FVID2_SOK on success, else failure
◆ IOCTL_CSIRX_CH_STOP
#define IOCTL_CSIRX_CH_STOP (FVID2_CSIRX_DRV_IOCTL_BASE + 0x0700U) |
Stop a channel for capture. This will stop a PSIL thread, UDMA channel.
This IOCTL can be used to stop/disable capture channel. Note: This IOCTL should be called after calling 'Fvid2_create()' and before 'Fvid2_delete()' for particular instance.
- Parameters
-
cmdArgs | [IN] Fdrv_Handle |
cmdArgs | [IN] channel ID |
cmdArgsStatus | [OUT] NULL |
- Returns
- FVID2_SOK on success, else failure