DSS Overlay Hardware Layer

Introduction

This is hardware include layer for DSS overlay region.

Files
file	csl_dssOverlay.h
	DSS Overlay layer interface file.

Data Structures
struct	CSL_DssOverlayCfg
	Configuration for DSS Overlay. More...
struct	CSL_DssOverlayLayerCfg
	Configuration for selecting overlay input layers. More...
struct	CSL_DssOverlayPipePosCfg
	Video Pipe Position Configuration in Overlay. More...

Functions
void	CSL_dssOverlaySetConfig (CSL_dss_overlayRegs *overlayRegs, const CSL_DssOverlayCfg *overlayCfg)
	Configure the Overlay Params. More...
void	CSL_dssOverlayColorBarEnable (CSL_dss_overlayRegs *overlayRegs, uint32_t enable)
	Enable the Color Bar in DSS Overlay. More...
void	CSL_dssOverlaySetLayerConfig (CSL_dss_overlayRegs *overlayRegs, const CSL_DssOverlayLayerCfg *layerCfg)
	Configure the Overlay input selection. More...
void	CSL_dssOverlaySetPipePosConfig (CSL_dss_overlayRegs *overlayRegs, const CSL_DssOverlayPipePosCfg *pipePosCfg, uint32_t layerNum)
	Configure the Video Pipe Position in Overlay. More...
uint32_t	CSL_dssOverlayGetEnabledPipeLayerNum (const CSL_dss_overlayRegs *overlayRegs, uint32_t pipeId)
	Get the layer number where a particular Video Pipe is connected. More...
static void	CSL_dssOverlayCfgInit (CSL_DssOverlayCfg *overlayCfg)
	CSL_DssOverlayCfg structure init function. More...
static void	CSL_dssOverlayLayerCfgInit (CSL_DssOverlayLayerCfg *layerCfg)
	CSL_DssOverlayLayerCfg structure init function. More...
static void	CSL_dssOverlayPipePosCfgInit (CSL_DssOverlayPipePosCfg *pipePosCfg)
	CSL_DssOverlayPipePosCfg structure init function. More...

Typedefs
typedef CSL_dss_ovr1Regs	CSL_dss_overlayRegs
	DSS Overlay Registers. More...

DSS Overlay Transparency Color Key Selection
#define	CSL_DSS_OVERLAY_TRANS_COLOR_DEST    ((uint32_t) CSL_DSS_OVR1_CONFIG_TCKLCDSELECTION_VAL_GDTK)
	Destination transparency color key selected. More...
#define	CSL_DSS_OVERLAY_TRANS_COLOR_SRC    ((uint32_t) CSL_DSS_OVR1_CONFIG_TCKLCDSELECTION_VAL_VSTK)
	Source transparency color key selected. More...

DSS Overlay Layer Number
#define	CSL_DSS_OVERLAY_LAYER_NUM_0   ((uint32_t) 0x0U)
	Overlay Layer 0. More...
#define	CSL_DSS_OVERLAY_LAYER_NUM_1   ((uint32_t) 0x1U)
	Overlay Layer 1. More...
#define	CSL_DSS_OVERLAY_LAYER_MAX   ((uint32_t) 0x2U)
	Maximum overlay layers. More...
#define	CSL_DSS_OVERLAY_LAYER_INVALID   ((uint32_t) 0xFFU)
	Invalid Overlay Layer. More...

Macro Definition Documentation

CSL_DSS_OVERLAY_TRANS_COLOR_DEST

#define CSL_DSS_OVERLAY_TRANS_COLOR_DEST    ((uint32_t) CSL_DSS_OVR1_CONFIG_TCKLCDSELECTION_VAL_GDTK)

Destination transparency color key selected.

CSL_DSS_OVERLAY_TRANS_COLOR_SRC

#define CSL_DSS_OVERLAY_TRANS_COLOR_SRC    ((uint32_t) CSL_DSS_OVR1_CONFIG_TCKLCDSELECTION_VAL_VSTK)

Source transparency color key selected.

CSL_DSS_OVERLAY_LAYER_NUM_0

#define CSL_DSS_OVERLAY_LAYER_NUM_0   ((uint32_t) 0x0U)

Overlay Layer 0.

CSL_DSS_OVERLAY_LAYER_NUM_1

#define CSL_DSS_OVERLAY_LAYER_NUM_1   ((uint32_t) 0x1U)

Overlay Layer 1.

CSL_DSS_OVERLAY_LAYER_MAX

#define CSL_DSS_OVERLAY_LAYER_MAX   ((uint32_t) 0x2U)

Maximum overlay layers.

CSL_DSS_OVERLAY_LAYER_INVALID

#define CSL_DSS_OVERLAY_LAYER_INVALID   ((uint32_t) 0xFFU)

Invalid Overlay Layer.

Typedef Documentation

CSL_dss_overlayRegs

typedef CSL_dss_ovr1Regs CSL_dss_overlayRegs

DSS Overlay Registers.

DSS7 UL has two identical Overlay blocks, hence define a generic structure to have common APIs

Function Documentation

CSL_dssOverlaySetConfig()

void CSL_dssOverlaySetConfig	(	CSL_dss_overlayRegs *	overlayRegs,
		const CSL_DssOverlayCfg *	overlayCfg
	)

Configure the Overlay Params.

Parameters

overlayRegs	Pointer to a CSL_dss_overlayRegs structure containing the overlay configuration
overlayCfg	Pointer to the CSL_DssOverlayCfg structure. This parameter should not be NULL

CSL_dssOverlayColorBarEnable()

void CSL_dssOverlayColorBarEnable	(	CSL_dss_overlayRegs *	overlayRegs,
		uint32_t	enable
	)

Enable the Color Bar in DSS Overlay.

Parameters

overlayRegs	Pointer to a CSL_dss_overlayRegs structure containing the overlay configuration
enable	Enable or disable the color bar

CSL_dssOverlaySetLayerConfig()

void CSL_dssOverlaySetLayerConfig	(	CSL_dss_overlayRegs *	overlayRegs,
		const CSL_DssOverlayLayerCfg *	layerCfg
	)

Configure the Overlay input selection.

Parameters

overlayRegs	Pointer to a CSL_dss_overlayRegs structure containing the overlay configuration
layerCfg	Pointer to CSL_DssOverlayLayerCfg structure. This parameter should not be NULL

CSL_dssOverlaySetPipePosConfig()

void CSL_dssOverlaySetPipePosConfig	(	CSL_dss_overlayRegs *	overlayRegs,
		const CSL_DssOverlayPipePosCfg *	pipePosCfg,
		uint32_t	layerNum
	)

Configure the Video Pipe Position in Overlay.

Parameters

overlayRegs	Pointer to a CSL_dss_overlayRegs structure containing the overlay configuration
pipePosCfg	Pointer to CSL_DssOverlayPipePosCfg structure. This parameter should not be NULL
layerNum	Layer Number

CSL_dssOverlayGetEnabledPipeLayerNum()

uint32_t CSL_dssOverlayGetEnabledPipeLayerNum	(	const CSL_dss_overlayRegs *	overlayRegs,
		uint32_t	pipeId
	)

Get the layer number where a particular Video Pipe is connected.

Parameters

overlayRegs	Pointer to a CSL_dss_overlayRegs structure containing the overlay configuration
pipeId	Pipe Id. Refer to CSL_DssVidPipeId for values

Returns

CSL_DssOverlayLayerNum Layer Number to which pipe is connected. API returns CSL_DSS_OVERLAY_LAYER_INVALID if pipe is not connected to any overlay layer

CSL_dssOverlayCfgInit()

static void CSL_dssOverlayCfgInit ( CSL_DssOverlayCfg *  overlayCfg )

inlinestatic

CSL_DssOverlayCfg structure init function.

Parameters

overlayCfg

Pointer to CSL_DssOverlayCfg structure

CSL_dssOverlayLayerCfgInit()

static void CSL_dssOverlayLayerCfgInit ( CSL_DssOverlayLayerCfg *  layerCfg )

inlinestatic

CSL_DssOverlayLayerCfg structure init function.

Parameters

layerCfg

Pointer to CSL_DssOverlayLayerCfg structure

CSL_dssOverlayPipePosCfgInit()

static void CSL_dssOverlayPipePosCfgInit ( CSL_DssOverlayPipePosCfg *  pipePosCfg )

inlinestatic

CSL_DssOverlayPipePosCfg structure init function.

Parameters

pipePosCfg

Pointer to CSL_DssOverlayPipePosCfg structure