| csi2tx Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Data Structures | Macros | Typedefs | Enumerations | Functions
xcsi2tx.h File Reference

## Data Structures
struct | XCsi2Tx_SPktData
| This typedef contains the Short Packet information from the Generic Short Packet Register. More...
struct | XCsi2Tx_Config
| The configuration structure for CSI Controller. More...
struct | XCsi2Tx
| The XCsi2Tx driver instance data. More...

## Macros
#define | XCSI2TX_H_
| Prevent circular inclusions by using protection macros. More...
#define | XCSI2TX_ENABLE 1
| Flag denoting enabling of CSI. More...
#define | XCSI2TX_DISABLE 0
| Flag denoting disabling of CSI. More...
#define | XCSI2TX_MAX_LANES 4
| Max Lanes supported by CSI. More...
#define | XCSI2TX_MAX_VC 4
| Max number of Virtual Channels. More...
Interrupt Types for setting Callbacks
#define | XCSI2TX_HANDLER_WRG_LANE 1
#define | XCSI2TX_HANDLER_GSPFIFO_FULL 2
#define | XCSI2TX_HANDLER_ULPS 3
#define | XCSI2TX_HANDLER_LINEBUF_FULL 4
#define | XCSI2TX_HANDLER_WRG_DATATYPE 5
#define | XCSI2TX_HANDLER_UNDERRUN_PIXEL 6
#define | XCSI2TX_HANDLER_LCERRVC0 7
#define | XCSI2TX_HANDLER_LCERRVC1 8
#define | XCSI2TX_HANDLER_LCERRVC2 9
#define | XCSI2TX_HANDLER_LCERRVC3 10

## Typedefs
typedef void(* | XCsi2Tx_CallBack )(void *CallBackRef, u32 Mask)
| Callback type for all interrupts defined. More...

## Enumerations
enum | XCsi2Tx_LCStatus { XCSI2TX_LC_LESS_LINES = 1, XCSI2TX_LC_MORE_LINES }
| This typedef defines the different errors codes for Line Count status for a Virtual Channel when Frame End Generation is enabled. More...

## Functions
XCsi2Tx_Config * | XCsi2Tx_LookupConfig (u32 DeviceId)
| Look up the hardware configuration for a device instance. More...
u32 | XCsi2Tx_CfgInitialize (XCsi2Tx *InstancePtr, XCsi2Tx_Config *CfgPtr, UINTPTR EffectiveAddr)
| Initialize the XCsi2Tx instance provided by the caller based on the given Config structure. More...
u32 | XCsi2Tx_Configure (XCsi2Tx *InstancePtr)
| This function will configure the core with proper number of Active Lanes. More...
u32 | XCsi2Tx_Activate (XCsi2Tx *InstancePtr, u8 Flag)
| Thsi function will enable/disable the IP Core to start processing. More...
u32 | XCsi2Tx_Reset (XCsi2Tx *InstancePtr)
| This function will do a reset of the IP. More...
void | XCsi2Tx_GetShortPacket (XCsi2Tx *InstancePtr, XCsi2Tx_SPktData *ShortPacketStruct)
| This function will get the short packet received in the FIFO from the Generic Short Packet Register and fill up the structure passed from caller. More...
u8 | XCsi2Tx_IsActiveLaneCountValid (XCsi2Tx *InstancePtr, u8 ActiveLanesCount)
| This function checks the validity of the active lanes parameter. More...
u32 | XCsi2Tx_SetLineCountForVC (XCsi2Tx *InstancePtr, u8 VC, u16 LineCount)
| This function sets the Line Count for virtual Channel if Frame End Generation feature is enabled. More...
u32 | XCsi2Tx_GetLineCountForVC (XCsi2Tx *InstancePtr, u8 VC, u16 *LineCount)
| This function gets the Line Count for virtual Channel if Frame End Generation feature is enabled. More...
u32 | XCsi2Tx_SelfTest (XCsi2Tx *InstancePtr)
| Runs a self-test on the driver/device. More...
void | XCsi2Tx_IntrHandler (void *InstancePtr)
| This function is the interrupt handler for the CSI2 Tx core. More...
int | XCsi2Tx_SetCallBack (XCsi2Tx *InstancePtr, u32 HandleType, void *Callbackfunc, void *Callbackref)
| This routine installs an asynchronous callback function for the given HandlerType: More...
u32 | XCsi2Tx_GetIntrEnable (XCsi2Tx *InstancePtr)
| This function will get the interrupt mask set (enabled) in the CSI2 Tx core. More...
void | XCsi2Tx_IntrEnable (XCsi2Tx *InstancePtr, u32 Mask)
| This function will enable the interrupts present in the interrupt mask passed onto the function. More...
void | XCsi2Tx_IntrDisable (XCsi2Tx *InstancePtr, u32 Mask)
| This function will disable the interrupts present in the interrupt mask passed onto the function. More...
u32 | XCsi2Tx_GetIntrStatus (XCsi2Tx *InstancePtr)
| This function will get the list of interrupts pending in the Interrupt Status Register of the CSI2 Tx core. More...
void | XCsi2Tx_InterruptClear (XCsi2Tx *InstancePtr, u32 Mask)
| This function will clear the interrupts set in the Interrupt Status Register of the CSI2 Tx core. More...