v_csc
Vitis Drivers API Documentation
Functions | Variables
xv_csc_sinit.c File Reference

Functions

XV_csc_Config * XV_csc_LookupConfig (u16 DeviceId)
 XV_csc_LookupConfig - Looks up the configuration for a specific Color Space Converter (CSC) device. More...
 
int XV_csc_Initialize (XV_csc *InstancePtr, u16 DeviceId)
 XV_csc_Initialize - Initialize the Color Space Converter (CSC) core. More...
 

Variables

XV_csc_Config XV_csc_ConfigTable []
 XV_csc_ConfigTable - Array of configuration structures for the Color Space Converter (CSC) driver. More...
 

Function Documentation

int XV_csc_Initialize ( XV_csc *  InstancePtr,
u16  DeviceId 
)

XV_csc_Initialize - Initialize the Color Space Converter (CSC) core.

This function initializes an instance of the XV_csc driver. It looks up the configuration for the specified device ID, and if found, initializes the hardware and driver instance with the configuration data.

Parameters
InstancePtrPointer to the XV_csc instance to be initialized.
DeviceIdDevice ID of the CSC core to look up the configuration.
Returns
  • XST_SUCCESS if initialization was successful.
  • XST_DEVICE_NOT_FOUND if the configuration for the given DeviceId was not found.
Note
  • The InstancePtr argument must not be NULL.
  • This function must be called before using other functions of the driver.

References XV_csc_Config::BaseAddress, XV_csc::IsReady, XV_csc_CfgInitialize(), and XV_csc_LookupConfig().

Referenced by XV_CscInitialize().

XV_csc_Config* XV_csc_LookupConfig ( u16  DeviceId)

XV_csc_LookupConfig - Looks up the configuration for a specific Color Space Converter (CSC) device.

Parameters
DeviceId,:The unique identifier for the device instance to look up.

This function searches the configuration table for an entry that matches the provided DeviceId. If a matching entry is found, a pointer to its configuration structure is returned. If no match is found, NULL is returned.

Returns
  • Pointer to the configuration structure for the matching device, or
  • NULL if no matching device is found.

Referenced by XV_csc_Initialize().

Variable Documentation

XV_csc_Config XV_csc_ConfigTable[]

XV_csc_ConfigTable - Array of configuration structures for the Color Space Converter (CSC) driver.

This table contains the configuration parameters for each instance of the CSC hardware present in the system. Each entry is populated with values defined in the hardware platform configuration (xparameters.h), such as device ID, base address, supported data widths, and feature enable flags.

Fields:

  • DeviceId: Unique identifier for the CSC instance.
  • BaseAddress: Base address for the control interface of the CSC.
  • SamplesPerClock: Number of samples processed per clock cycle.
  • MaxWidth: Maximum supported image width.
  • MaxHeight: Maximum supported image height.
  • MaxDataWidth: Maximum data width supported by the CSC.
  • Enable422: Flag indicating support for 4:2:2 chroma subsampling.
  • Enable420: Flag indicating support for 4:2:0 chroma subsampling.
  • EnableWindow: Flag indicating support for windowing feature.

Note: The table is conditionally compiled based on the number of CSC instances defined by XPAR_XV_CSC_NUM_INSTANCES.