AM273x MCU+ SDK  08.06.00
Data Structures | Functions | Typedefs | Macros
CSIRX Common APIs
APIs for SOC Specific Device Drivers » APIs for CSIRX

Introduction

APIs common across contexts

Data Structures

struct  CSIRX_CommonIntr
 Common (across contexts) interrupts. More...
 
struct  CSIRX_CommonIntrCallbacks
 Callbacks and callback arguments for various common interrupt event. More...
 
struct  CSIRX_CommonConfig
 Common to all context configuration. More...
 

Functions

void CSIRX_CommonConfig_init (CSIRX_CommonConfig *config)
 Sets default values for configuration. More...
 
int32_t CSIRX_commonSetConfig (CSIRX_Handle handle, CSIRX_CommonConfig *config)
 Configure common to all context settings. More...
 
int32_t CSIRX_commonClearAllIntr (CSIRX_Handle handle)
 Clear all pending common to all context interrupts. More...
 
int32_t CSIRX_commonGetPendingIntr (CSIRX_Handle handle, CSIRX_CommonIntr *intrStatus)
 Get all pending common to all context interrupts. More...
 
int32_t CSIRX_commonGetGenericShortPacket (CSIRX_Handle handle, uint32_t *shortPacket)
 Get generic short packet header. More...
 
int32_t CSIRX_commonEnable (CSIRX_Handle handle)
 Enable CSIRX interface. More...
 
int32_t CSIRX_commonDisable (CSIRX_Handle handle)
 Disable CSIRX interface. More...
 

Typedefs

typedef void(* CSIRX_CommonCallback) (CSIRX_Handle handle, void *arg, struct CSIRX_CommonIntr_s *irq)
 Common interrupt callback. More...
 
typedef void(* CSIRX_Callback) (CSIRX_Handle handle, void *arg)
 Generic Interrupt callback. More...
 

Macros

#define CSIRX_STOP_STATE_FSM_TIMEOUT_MAX   (200000U)
 Special value of CSIRX_CommonConfig::stopStateFsmTimeoutInNanoSecs for setting maximum timeout, this is also the CSIRX IP reset state. More...
 

Data endianess

#define CSIRX_ENDIANNESS_NATIVE_MIPI_CSI2   (0U)
 All little endian except legacy YUV422 8b and YUV420, which are big endian. More...
 
#define CSIRX_ENDIANNESS_LITTLE_ENDIAN   (1U)
 All little endian. More...
 
#define CSIRX_ENDIANNESS_MAX   (1U)
 Endianness max for error checking purposes. More...
 

Burst size defines

#define CSIRX_BURST_SIZE_1X64   (0U)
 Burst size 1x64 OCP writes. More...
 
#define CSIRX_BURST_SIZE_2X64   (1U)
 Burst size 2x64 OCP writes. More...
 
#define CSIRX_BURST_SIZE_4X64   (2U)
 Burst size 4x64 OCP writes. More...
 
#define CSIRX_BURST_SIZE_8X64   (3U)
 Burst size 8x64 OCP writes. More...
 
#define CSIRX_BURST_SIZE_MAX   (3U)
 Burst size max. More...
 

Macro Definition Documentation

◆ CSIRX_STOP_STATE_FSM_TIMEOUT_MAX

#define CSIRX_STOP_STATE_FSM_TIMEOUT_MAX   (200000U)

Special value of CSIRX_CommonConfig::stopStateFsmTimeoutInNanoSecs for setting maximum timeout, this is also the CSIRX IP reset state.

◆ CSIRX_ENDIANNESS_NATIVE_MIPI_CSI2

#define CSIRX_ENDIANNESS_NATIVE_MIPI_CSI2   (0U)

All little endian except legacy YUV422 8b and YUV420, which are big endian.

◆ CSIRX_ENDIANNESS_LITTLE_ENDIAN

#define CSIRX_ENDIANNESS_LITTLE_ENDIAN   (1U)

All little endian.

◆ CSIRX_ENDIANNESS_MAX

#define CSIRX_ENDIANNESS_MAX   (1U)

Endianness max for error checking purposes.

◆ CSIRX_BURST_SIZE_1X64

#define CSIRX_BURST_SIZE_1X64   (0U)

Burst size 1x64 OCP writes.

◆ CSIRX_BURST_SIZE_2X64

#define CSIRX_BURST_SIZE_2X64   (1U)

Burst size 2x64 OCP writes.

◆ CSIRX_BURST_SIZE_4X64

#define CSIRX_BURST_SIZE_4X64   (2U)

Burst size 4x64 OCP writes.

◆ CSIRX_BURST_SIZE_8X64

#define CSIRX_BURST_SIZE_8X64   (3U)

Burst size 8x64 OCP writes.

◆ CSIRX_BURST_SIZE_MAX

#define CSIRX_BURST_SIZE_MAX   (3U)

Burst size max.

Typedef Documentation

◆ CSIRX_CommonCallback

typedef void(* CSIRX_CommonCallback) (CSIRX_Handle handle, void *arg, struct CSIRX_CommonIntr_s *irq)

Common interrupt callback.

The driver clear the pending interrupts internally so callback need not clear it

Parameters
handle[in] CSIRX driver handle
arg[in] User supplied argument
irq[in] Interrupt status, see CSIRX_CommonIntr

◆ CSIRX_Callback

typedef void(* CSIRX_Callback) (CSIRX_Handle handle, void *arg)

Generic Interrupt callback.

Parameters
handle[in] CSIRX driver handle
arg[in] User supplied argument

Function Documentation

◆ CSIRX_CommonConfig_init()

void CSIRX_CommonConfig_init ( CSIRX_CommonConfig *  config)

Sets default values for configuration.

Parameters
config[in] configuration

◆ CSIRX_commonSetConfig()

int32_t CSIRX_commonSetConfig ( CSIRX_Handle  handle,
CSIRX_CommonConfig *  config 
)

Configure common to all context settings.

Parameters
handle[in] CSIRX driver handle
config[in] Common to all context configuration
Returns
SystemP_SUCCESS on success, else failure

◆ CSIRX_commonClearAllIntr()

int32_t CSIRX_commonClearAllIntr ( CSIRX_Handle  handle)

Clear all pending common to all context interrupts.

Parameters
handle[in] CSIRX driver handle
Returns
SystemP_SUCCESS on success, else failure

◆ CSIRX_commonGetPendingIntr()

int32_t CSIRX_commonGetPendingIntr ( CSIRX_Handle  handle,
CSIRX_CommonIntr *  intrStatus 
)

Get all pending common to all context interrupts.

Parameters
handle[in] CSIRX driver handle
intrStatus[out] Interrupt status
Returns
SystemP_SUCCESS on success, else failure

◆ CSIRX_commonGetGenericShortPacket()

int32_t CSIRX_commonGetGenericShortPacket ( CSIRX_Handle  handle,
uint32_t *  shortPacket 
)

Get generic short packet header.

Parameters
handle[in] CSIRX driver handle
shortPacket[out] Generic short packet header
Returns
SystemP_SUCCESS on success, else failure

◆ CSIRX_commonEnable()

int32_t CSIRX_commonEnable ( CSIRX_Handle  handle)

Enable CSIRX interface.

Parameters
handle[in] CSIRX driver handle
Returns
SystemP_SUCCESS on success, else failure

◆ CSIRX_commonDisable()

int32_t CSIRX_commonDisable ( CSIRX_Handle  handle)

Disable CSIRX interface.

Parameters
handle[in] CSIRX driver handle
Returns
SystemP_SUCCESS on success, else failure