Introduction

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

Files
file	csitx.h
	CSITX Driver API/interface file.

Macros
#define	CSITX_TX_DRV_ID (FVID2_CSITX_DRV_BASE + 0x00000000U)
	Application API calling sequence: More...

#define	IOCTL_CSITX_GET_INST_STATUS (FVID2_CSITX_DRV_IOCTL_BASE + 0x0000U)
	Get transmit status IOCTL. More...

#define	IOCTL_CSITX_PRINT_DEBUG_LOGS (FVID2_CSITX_DRV_IOCTL_BASE + 0x0100U)
	Print transmit debug logs. More...

Macro Definition Documentation

◆ CSITX_TX_DRV_ID

#define CSITX_TX_DRV_ID (FVID2_CSITX_DRV_BASE + 0x00000000U)

Application API calling sequence:

Csitx_init()
- to initialize CSITX Driver
Csitx_initParamsInit()
- to initialize initialization parameters
Csitx_createParamsInit()
- to initialize create time parameters
Csitx_instStatusInit()
- not mandatory
- to initialize driver instance status parameters
Fvid2_create()
- to create CSITX driver instance
Fvid2_control(FVID2_REGISTER_TIMESTAMP_FXN)
- to register time-stamping function
Fvid2_control(IOCTL_CSITX_REGISTER_EVENT)
- mandatory for error handling
- to enable event handling in CSITX driver
Fvid2_start()
- to start CSITX driver instance
Fvid2_queue() and Fvid2_dequeue()
- to transmit the frames
Fvid2_stop()
- to stop CSITX driver instance
Fvid2_delete()
- to delete CSITX driver instance
Csitx_deInit()
- to un-initialize CSITX DriverCSITX transmit driver ID used at the time of FVID2 create.

◆ IOCTL_CSITX_GET_INST_STATUS

#define IOCTL_CSITX_GET_INST_STATUS (FVID2_CSITX_DRV_IOCTL_BASE + 0x0000U)

Get transmit status IOCTL.

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

Parameters

cmdArgs	[OUT] Csitx_InstStatus *
cmdArgsStatus	[OUT] NULL

Returns: FVID2_SOK on success, else failure

◆ IOCTL_CSITX_PRINT_DEBUG_LOGS

#define IOCTL_CSITX_PRINT_DEBUG_LOGS (FVID2_CSITX_DRV_IOCTL_BASE + 0x0100U)

Print transmit debug logs.

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