J722S MCU+ SDK  09.02.00
CSIRX Driver

Introduction

The CSI2 RX module provides the logic to for handling CSI2 protocol based camera sensor or sensor data stream for capture. This is CSIRX FVID2 driver documentation.

Sub Modules

 CSIRX Driver Header
 

Data Structures

struct  Csirx_ChCfg
 Structure containing Channels configurations. More...
 
struct  Csirx_InstCfg
 Structure containing csirx module initialization arguments. More...
 
struct  Csirx_CreateParams
 Capture driver create arguments, used when calling Fvid2_create(). Structure containing Streams configurations. More...
 
struct  Csirx_InitParams
 Capture driver create arguments, used when calling Fvid2_create(). Structure containing Streams configurations. More...
 
struct  Csirx_CreateStatus
 Capture driver create status. Returned after calling Fvid2_create(). More...
 
struct  Csirx_InstStatus
 Capture status structure used to get the current status. More...
 

Functions

int32_t Csirx_init (const Csirx_InitParams *initParams)
 CSIRX Driver Init function. More...
 
int32_t Csirx_deInit (void)
 CSIRX Driver de-Init function. More...
 
static void Csirx_initParamsInit (Csirx_InitParams *initPrms)
 Csirx_InitParams structure init function. More...
 
static void Csirx_createParamsInit (Csirx_CreateParams *createPrms)
 Csirx_CreateParams structure init function. More...
 
static void Csirx_chCfgInit (Csirx_ChCfg *chCfg)
 Csirx_ChCfg structure init function. More...
 
static void Csirx_instCfgInit (Csirx_InstCfg *instCfg)
 Csirx_InstCfg structure init function. More...
 
static void Csirx_instStatusInit (Csirx_InstStatus *status)
 Csirx_InstStatus structure init function. More...
 

Macros

#define CSIRX_BUF_ALIGNMENT   (UDMA_CACHELINE_ALIGNMENT)
 Buffer memory alignment with cache line size. More...
 

CSIRX Channel Type

Id for CSIRX Channel/Stream type.

#define CSIRX_CH_TYPE_CAPT   ((uint32_t) 0x0U)
 Stream type: capture mode, frames will captured to internal memory or DDR. More...
 
#define CSIRX_CH_TYPE_OTF   ((uint32_t) 0x1U)
 Stream type: OTF mode, frames will be forwarded to Video Port/VISS. More...
 
#define CSIRX_CH_TYPE_LPBK   ((uint32_t) 0x2U)
 Stream type: Loopback mode, frames will be forwarded to CSI Tx trans PADs. More...
 

CSIRX Stram ID

Id for CSIRX Stream

#define CSIRX_CAPT_STREAM_ID   ((uint32_t) 0x0U)
 Stream type: capture mode, frames will captured to internal memory or DDR. More...
 
#define CSIRX_LPBK_STREAM_ID   ((uint32_t) 0x1U)
 Stream type: Loopback mode, frames will be forwarded to CSI Tx trans PADs. More...
 
#define CSIRX_OTF_STREAM0_ID   ((uint32_t) 0x2U)
 Stream type: OTF mode, frames will be forwarded to Video Port/VISS. More...
 
#define CSIRX_OTF_STREAM1_ID   ((uint32_t) 0x3U)
 Stream type: OTF mode, frames will be forwarded to Video Port/VISS. More...
 

Macro Definition Documentation

◆ CSIRX_CH_TYPE_CAPT

#define CSIRX_CH_TYPE_CAPT   ((uint32_t) 0x0U)

Stream type: capture mode, frames will captured to internal memory or DDR.

◆ CSIRX_CH_TYPE_OTF

#define CSIRX_CH_TYPE_OTF   ((uint32_t) 0x1U)

Stream type: OTF mode, frames will be forwarded to Video Port/VISS.

◆ CSIRX_CH_TYPE_LPBK

#define CSIRX_CH_TYPE_LPBK   ((uint32_t) 0x2U)

Stream type: Loopback mode, frames will be forwarded to CSI Tx trans PADs.

◆ CSIRX_CAPT_STREAM_ID

#define CSIRX_CAPT_STREAM_ID   ((uint32_t) 0x0U)

Stream type: capture mode, frames will captured to internal memory or DDR.

◆ CSIRX_LPBK_STREAM_ID

#define CSIRX_LPBK_STREAM_ID   ((uint32_t) 0x1U)

Stream type: Loopback mode, frames will be forwarded to CSI Tx trans PADs.

◆ CSIRX_OTF_STREAM0_ID

#define CSIRX_OTF_STREAM0_ID   ((uint32_t) 0x2U)

Stream type: OTF mode, frames will be forwarded to Video Port/VISS.

◆ CSIRX_OTF_STREAM1_ID

#define CSIRX_OTF_STREAM1_ID   ((uint32_t) 0x3U)

Stream type: OTF mode, frames will be forwarded to Video Port/VISS.

◆ CSIRX_BUF_ALIGNMENT

#define CSIRX_BUF_ALIGNMENT   (UDMA_CACHELINE_ALIGNMENT)

Buffer memory alignment with cache line size.

Function Documentation

◆ Csirx_init()

int32_t Csirx_init ( const Csirx_InitParams initParams)

CSIRX Driver Init function.

Parameters
initParams[IN] Pointer to Csirx_InitParams structure.
Returns
status CSIRX Initialization status. 'FVID2_SOK' is successful.

◆ Csirx_deInit()

int32_t Csirx_deInit ( void  )

CSIRX Driver de-Init function.

Returns
status CSIRX Initialization status. 'FVID2_SOK' is successful.

◆ Csirx_initParamsInit()

static void Csirx_initParamsInit ( Csirx_InitParams initPrms)
inlinestatic

Csirx_InitParams structure init function.

Parameters
initPrms[IN] Pointer to Csirx_InitParams structure.

◆ Csirx_createParamsInit()

static void Csirx_createParamsInit ( Csirx_CreateParams createPrms)
inlinestatic

Csirx_CreateParams structure init function.

Parameters
createPrms[IN] Pointer to Csirx_CreateParams structure.

◆ Csirx_chCfgInit()

static void Csirx_chCfgInit ( Csirx_ChCfg chCfg)
inlinestatic

Csirx_ChCfg structure init function.

Parameters
chCfg[IN] Pointer to Csirx_ChCfg structure.

◆ Csirx_instCfgInit()

static void Csirx_instCfgInit ( Csirx_InstCfg instCfg)
inlinestatic

Csirx_InstCfg structure init function.

Parameters
instCfg[IN] Pointer to Csirx_InstCfg structure.

◆ Csirx_instStatusInit()

static void Csirx_instStatusInit ( Csirx_InstStatus status)
inlinestatic

Csirx_InstStatus structure init function.

Parameters
status[IN] Pointer to Csirx_InstStatus structure.