PDK API Guide for J721E
Macros
Display IOCTLs
DSS Driver » Display Pipe Driver

Introduction

These are display FVID2 APIs that can be called by the application.

Macros

#define IOCTL_DSS_DISP_SET_DSS_PARAMS   (DSS_DISP_IOCTL_BASE + 0x0001U)
 Command to set DSS display parameters. More...
 
#define IOCTL_DSS_DISP_SET_PIPE_MFLAG_PARAMS   (DSS_DISP_IOCTL_BASE + 0x0002U)
 Command to set MFLAG parameters for video pipe. More...
 
#define IOCTL_DSS_DISP_GET_CURRENT_STATUS   (DSS_DISP_IOCTL_BASE + 0x0003U)
 Command to get the display status. More...
 
#define IOCTL_DSS_DISP_SET_PIPE_SAFETY_CHK_PARAMS   (DSS_DISP_IOCTL_BASE + 0x0004U)
 Command to program Safety Check configuration at Video Pipe Output. More...
 
#define IOCTL_DSS_DISP_SET_PIPE_CSC_COEFF   (DSS_DISP_IOCTL_BASE + 0x0005U)
 Command to program the CSC coefficients for Video Pipe. By default BT 601 coefficients are set. More...
 
#define IOCTL_DSS_DISP_REGISTER_BUF_PRGM_CB   (DSS_DISP_IOCTL_BASE + 0x0006U)
 Command to register buffer program callback function. More...
 
#define IOCTL_DSS_DISP_REGISTER_PIPE_PRGM_CB   (DSS_DISP_IOCTL_BASE + 0x0007U)
 Command to register video pipe program callback function. More...
 
#define IOCTL_DSS_DISP_REGISTER_PIPE_UNDERFLOW_CB   (DSS_DISP_IOCTL_BASE + 0x0008U)
 Command to register video pipe underflow callback function. More...
 

Macro Definition Documentation

◆ IOCTL_DSS_DISP_SET_DSS_PARAMS

#define IOCTL_DSS_DISP_SET_DSS_PARAMS   (DSS_DISP_IOCTL_BASE + 0x0001U)

Command to set DSS display parameters.

This IOCTL is used to program the DSS display parameters. Refer to structure Dss_DispParams for details on DSS parameters.

Parameters
cmdArgs[IN] Pointer of type Dss_DispParams
cmdArgsStatus[OUT] NULL
Returns
FVID2_SOK if successful, else suitable error code

◆ IOCTL_DSS_DISP_SET_PIPE_MFLAG_PARAMS

#define IOCTL_DSS_DISP_SET_PIPE_MFLAG_PARAMS   (DSS_DISP_IOCTL_BASE + 0x0002U)

Command to set MFLAG parameters for video pipe.

This IOCTL can be used to set the MFLAG parameters for the given video pipe.

Parameters
cmdArgs[IN] Pointer of type Dss_DispPipeMflagParams
cmdArgsStatus[OUT] NULL
Returns
FVID2_SOK if successful, else suitable error code

◆ IOCTL_DSS_DISP_GET_CURRENT_STATUS

#define IOCTL_DSS_DISP_GET_CURRENT_STATUS   (DSS_DISP_IOCTL_BASE + 0x0003U)

Command to get the display status.

This IOCTL can be used to get the display status like number of frames displayed, repeated, queued. dequeued, etc. Note: These counters will be reset either at the time of driver create or while starting the display operation. See respective counter comments for details.

Parameters
cmdArgs[IN] Pointer of type Dss_DispCurrentStatus
cmdArgsStatus[OUT] NULL
Returns
FVID2_SOK if successful, else suitable error code

◆ IOCTL_DSS_DISP_SET_PIPE_SAFETY_CHK_PARAMS

#define IOCTL_DSS_DISP_SET_PIPE_SAFETY_CHK_PARAMS   (DSS_DISP_IOCTL_BASE + 0x0004U)

Command to program Safety Check configuration at Video Pipe Output.

This IOCTL is used to program the safety check configuration parameters.

Parameters
cmdArgs[IN] Pointer of type Dss_DispPipeSafetyChkParams
cmdArgsStatus[OUT] NULL
Returns
FVID2_SOK if successful, else suitable error code

◆ IOCTL_DSS_DISP_SET_PIPE_CSC_COEFF

#define IOCTL_DSS_DISP_SET_PIPE_CSC_COEFF   (DSS_DISP_IOCTL_BASE + 0x0005U)

Command to program the CSC coefficients for Video Pipe. By default BT 601 coefficients are set.

Parameters
cmdArgs[IN] Pointer of type CSL_DssCscCoeff
cmdArgsStatus[OUT] NULL
Returns
FVID2_SOK if successful, else suitable error code

◆ IOCTL_DSS_DISP_REGISTER_BUF_PRGM_CB

#define IOCTL_DSS_DISP_REGISTER_BUF_PRGM_CB   (DSS_DISP_IOCTL_BASE + 0x0006U)

Command to register buffer program callback function.

This IOCTL can be used to register a callback when the actual buffer is getting programmed to the hardware. See Dss_DispBufPrgmCbFxn for details. This IOCTL is per display driver instance and hence should be called separately for each display pipeline. Also this IOCTL should be called before starting the display. Note: bufPrgmCbFxn should be set to NULL in order to unregister the callback.

Parameters
cmdArgs[IN] Pointer of type Dss_DispBufPrgmCbParams
cmdArgsStatus[OUT] NULL
Returns
FVID2_SOK if successful, else suitable error code

◆ IOCTL_DSS_DISP_REGISTER_PIPE_PRGM_CB

#define IOCTL_DSS_DISP_REGISTER_PIPE_PRGM_CB   (DSS_DISP_IOCTL_BASE + 0x0007U)

Command to register video pipe program callback function.

This IOCTL can be used to register a callback when the actual buffer has been programmed to the hardware. See Dss_DispPipePrgmCbFxn for details. This IOCTL is per display driver instance and hence should be called separately for each display pipeline. Also this IOCTL should be called before starting the display. Note: pipePrgmCbFxn should be set to NULL in order to unregister the callback.

Parameters
cmdArgs[IN] Pointer of type Dss_DispPipePrgmCbParams
cmdArgsStatus[OUT] NULL
Returns
FVID2_SOK if successful, else suitable error code

◆ IOCTL_DSS_DISP_REGISTER_PIPE_UNDERFLOW_CB

#define IOCTL_DSS_DISP_REGISTER_PIPE_UNDERFLOW_CB   (DSS_DISP_IOCTL_BASE + 0x0008U)

Command to register video pipe underflow callback function.

This IOCTL can be used to register a callback when there is a underflow for a particular video pipe. See Dss_DispUnderFlowCbFxn for details. This IOCTL is per display driver instance and hence should be called separately for each display pipeline. Also this IOCTL should be called before starting the display. Note: underFlowCbFxn should be set to NULL in order to unregister the callback.

Parameters
cmdArgs[IN] Pointer of type Dss_DispUnderFlowCbParams
cmdArgsStatus[OUT] NULL
Returns
FVID2_SOK if successful, else suitable error code