Introduction

This is DSS's top level include for applications

Files
file	dss.h
	DSS Driver API/interface file.

Data Structures
struct	Dss_InitParams
	DSS initialization parameters. More...

Functions
void	Dss_initParamsInit (Dss_InitParams *dssParams)
	Dss_InitParams structure init function. More...

int32_t	Dss_init (const Dss_InitParams *initParams)
	DSS initialization function. This function initializes the DSS hardware and drivers. This function should be called before calling any driver APIs and only once. More...

int32_t	Dss_deInit (void)
	DSS de-initialization function. This function un-initializes the DSS hardware and drivers. This function should be called during system shutdown if Dss_init() was called by the application. More...

Macros
#define	DSS_DISP_DRV_ID (FVID2_DSS_DRV_BASE + 0x00U)
	Display driver ID used at the time of FVID2 create. More...

#define	DSS_DCTRL_DRV_ID (FVID2_DSS_DRV_BASE + 0x01U)
	Display controller driver ID used at the time of FVID2 create. More...

#define	DSS_DISP_IOCTL_BASE (FVID2_DSS_DRV_IOCTL_BASE + 0x000U)
	IOCTL base address for the display driver IOCTLs. More...

#define	DSS_DCTRL_IOCTL_BASE (FVID2_DSS_DRV_IOCTL_BASE + 0x100U)
	IOCTL base address for the display controller driver IOCTLs. More...

#define	DSS_DISP_SOC_IOCTL_BASE (DSS_DISP_IOCTL_BASE + 0x40U)
	IOCTL base address for the SOC specific display driver IOCTLs. More...

#define	DSS_DCTRL_SOC_IOCTL_BASE (DSS_DCTRL_IOCTL_BASE + 0x40U)
	IOCTL base address for the SOC specific display controller driver IOCTLs. More...

Macro Definition Documentation

◆ DSS_DISP_DRV_ID

#define DSS_DISP_DRV_ID (FVID2_DSS_DRV_BASE + 0x00U)

Display driver ID used at the time of FVID2 create.

◆ DSS_DCTRL_DRV_ID

#define DSS_DCTRL_DRV_ID (FVID2_DSS_DRV_BASE + 0x01U)

Display controller driver ID used at the time of FVID2 create.

◆ DSS_DISP_IOCTL_BASE

#define DSS_DISP_IOCTL_BASE (FVID2_DSS_DRV_IOCTL_BASE + 0x000U)

IOCTL base address for the display driver IOCTLs.

◆ DSS_DCTRL_IOCTL_BASE

#define DSS_DCTRL_IOCTL_BASE (FVID2_DSS_DRV_IOCTL_BASE + 0x100U)

IOCTL base address for the display controller driver IOCTLs.

◆ DSS_DISP_SOC_IOCTL_BASE

#define DSS_DISP_SOC_IOCTL_BASE (DSS_DISP_IOCTL_BASE + 0x40U)

IOCTL base address for the SOC specific display driver IOCTLs.

◆ DSS_DCTRL_SOC_IOCTL_BASE

#define DSS_DCTRL_SOC_IOCTL_BASE (DSS_DCTRL_IOCTL_BASE + 0x40U)

IOCTL base address for the SOC specific display controller driver IOCTLs.

Function Documentation

◆ Dss_initParamsInit()

void Dss_initParamsInit ( Dss_InitParams * dssParams )

Dss_InitParams structure init function.

Parameters

dssParams Pointer to Dss_InitParams structure.

Returns: None

◆ Dss_init()

int32_t Dss_init ( const Dss_InitParams * initParams )

DSS initialization function. This function initializes the DSS hardware and drivers. This function should be called before calling any driver APIs and only once.

Parameters

initParams Pointer to a Dss_InitParams structure containing the DSS configuration

Returns: FVID2_SOK if successful, else suitable error code

◆ Dss_deInit()

int32_t Dss_deInit ( void )

DSS de-initialization function. This function un-initializes the DSS hardware and drivers. This function should be called during system shutdown if Dss_init() was called by the application.

Returns: FVID2_SOK if successful, else suitable error code