Description

Typedefs
typedef void(*	dsHdmiInConnectCB_t) (dsHdmiInPort_t Port, bool isPortConnected)
	Callback function used to notify applications of HDMI In hot plug status. More...

typedef void(*	dsHdmiInSignalChangeCB_t) (dsHdmiInPort_t port, dsHdmiInSignalStatus_t sigStatus)
	Callback function used to notify applications of HDMI In signal change status. More...

typedef void(*	dsHdmiInStatusChangeCB_t) (dsHdmiInStatus_t inputStatus)
	Callback function used to notify applications of HDMI Input status. More...

typedef void(*	dsHdmiInVideoModeUpdateCB_t) (dsHdmiInPort_t port, dsVideoPortResolution_t videoResolution)
	Callback function used to notify applications of HDMI In video mode changes. More...

typedef void(*	dsHdmiInAllmChangeCB_t) (dsHdmiInPort_t port, bool allm_mode)
	Callback function used to notify applications of HDMI Input ALLM Mode. More...

Functions
dsError_t	dsHdmiInInit (void)
	Initialize the underlying HDMI Input sub-system. More...

dsError_t	dsHdmiInTerm (void)
	Terminate the underlying HDMI Input sub-system. More...

dsError_t	dsHdmiInGetNumberOfInputs (uint8_t *pNumberOfInputs)
	Get the number of HDMI Input ports on the set-top. More...

dsError_t	dsHdmiInGetStatus (dsHdmiInStatus_t *pStatus)
	Get the HDMI Inpuut Status. More...

dsError_t	dsHdmiInSelectPort (dsHdmiInPort_t Port)
	Select the HDMI Input port to be presented. More...

dsError_t	dsHdmiInScaleVideo (int32_t x, int32_t y, int32_t width, int32_t height)
	Scale the HDMI In video This function is used to scale the HDMI In video. More...

dsError_t	dsHdmiInSelectZoomMode (dsVideoZoom_t requestedZoomMode)
	Select the HDMI Input zoom mode. More...

dsError_t	dsHdmiInPauseAudio (void)
	Stop the output of HDMI Input audio. More...

dsError_t	dsHdmiInResumeAudio (void)
	Start the output of HDMI Input audio. More...

dsError_t	dsHdmiInGetCurrentVideoMode (dsVideoPortResolution_t *resolution)
	Get the current HDMI Input video mode. More...

dsError_t	dsHdmiInRegisterConnectCB (dsHdmiInConnectCB_t CBFunc)
	Register for the HDMI Input hot plug event. More...

dsError_t	dsHdmiInRegisterSignalChangeCB (dsHdmiInSignalChangeCB_t CBFunc)
	Register for the HDMI Input Signal Change event. More...

dsError_t	dsHdmiInRegisterStatusChangeCB (dsHdmiInStatusChangeCB_t CBFunc)
	Register for the HDMI Input Status Change event. More...

dsError_t	dsHdmiInRegisterVideoModeUpdateCB (dsHdmiInVideoModeUpdateCB_t CBFunc)
	Register for the HDMI Input Video Mode change event. More...

dsError_t	dsHdmiInRegisterAllmChangeCB (dsHdmiInAllmChangeCB_t CBFunc)
	Register for the HDMI Input ALLM Mode Change event. More...

bool	dsIsHdmiARCPort (int iPort)

dsError_t	dsGetEDIDBytesInfo (int iHdmiPort, unsigned char *edid, int length)

dsError_t	dsGetHDMISPDInfo (int iHdmiPort, unsigned char **data)

dsError_t	dsSetEdidVersion (int iHdmiPort, int iEdidVersion)

dsError_t	dsGetEdidVersion (int iHdmiPort, int *iEdidVersion)

dsError_t	dsGetAllmStatus (int iHdmiPort, bool *allmStatus)

dsError_t	dsGetSupportedGameFeaturesList (dsSupportedGameFeatureList_t *features)

Typedef Documentation

◆ dsHdmiInConnectCB_t

typedef void(* dsHdmiInConnectCB_t) (dsHdmiInPort_t Port, bool isPortConnected)

Callback function used to notify applications of HDMI In hot plug status.

HAL Implementation should call this method to deliver HDMI In hot plug status to the application (e.g. Connect/Disconnect for Port 0/1).

Parameters

Port	HDMI Input port.
isPortConnected	Connection state of HDMI In Port.

Returns: None.

Definition at line 226 of file dsHdmiIn.h.

◆ dsHdmiInSignalChangeCB_t

typedef void(* dsHdmiInSignalChangeCB_t) (dsHdmiInPort_t port, dsHdmiInSignalStatus_t sigStatus)

Callback function used to notify applications of HDMI In signal change status.

HAL Implementation should call this method to deliver HDMI In signal change status to the application (e.g. NoSignal/UnstableSignal/NotSupportedSignal/StableSignal for HDMI In ports).

Parameters

port	HDMI Input port.
sigStatus	signal Status of HDMI In Port.

Returns: None.

Definition at line 240 of file dsHdmiIn.h.

◆ dsHdmiInStatusChangeCB_t

typedef void(* dsHdmiInStatusChangeCB_t) (dsHdmiInStatus_t inputStatus)

Callback function used to notify applications of HDMI Input status.

HAL Implementation should call this method to deliver HDMI Input status to the application (e.g. port, isPresented(true/false) etc. for HDMI In ports).

Parameters

inputStatus HDMI Input status of a specific Port.

Returns: None.

Definition at line 253 of file dsHdmiIn.h.

◆ dsHdmiInVideoModeUpdateCB_t

typedef void(* dsHdmiInVideoModeUpdateCB_t) (dsHdmiInPort_t port, dsVideoPortResolution_t videoResolution)

Callback function used to notify applications of HDMI In video mode changes.

HAL Implementation should call this method to deliver updated HDMI In video mode info to the application

Parameters

port	HDMI Input port.
videoResolution	dsVideoPortResolution_t of HDMI In Source

Returns: None.

Definition at line 267 of file dsHdmiIn.h.

◆ dsHdmiInAllmChangeCB_t

typedef void(* dsHdmiInAllmChangeCB_t) (dsHdmiInPort_t port, bool allm_mode)

Callback function used to notify applications of HDMI Input ALLM Mode.

HAL Implementation should call this method to deliver HDMI Input ALLM Mode to the application (e.g. port, allm_mode(true/false) etc. for HDMI In ports).

Parameters

port	HDMI Input port.
allm_mode	ALLM Mode of HDMI In Port.

Returns: None.

Definition at line 281 of file dsHdmiIn.h.

Function Documentation

◆ dsHdmiInInit()

dsError_t dsHdmiInInit ( void )

Initialize the underlying HDMI Input sub-system.

This function must initialize the HDMI Input module and any associated data structures.

Parameters

None

Returns: Device Settings error code

Return values

dsError_t

Definition at line 58 of file dsHdmiIn.c.

◆ dsHdmiInTerm()

dsError_t dsHdmiInTerm ( void )

Terminate the underlying HDMI Input sub-system.

This function must terminate the HDMI Input module and any associated data structures.

Parameters

None

Returns: Device Settings error code

Return values

dsError_t

Definition at line 78 of file dsHdmiIn.c.

◆ dsHdmiInGetNumberOfInputs()

dsError_t dsHdmiInGetNumberOfInputs ( uint8_t * pNumberOfInputs )

Get the number of HDMI Input ports on the set-top.

This function is used to get the number of HDMI Input ports on the set-top.

Parameters

[in]

Definition at line 99 of file dsHdmiIn.c.

◆ dsHdmiInGetStatus()

dsError_t dsHdmiInGetStatus ( dsHdmiInStatus_t * pStatus )

Get the HDMI Inpuut Status.

This function is used to get the current HDMI Input Status.

Parameters

[in]

Definition at line 125 of file dsHdmiIn.c.

◆ dsHdmiInSelectPort()

dsError_t dsHdmiInSelectPort ( dsHdmiInPort_t Port )

Select the HDMI Input port to be presented.

This function is used to select the HDMI Input port for presentation.

Parameters

[in]

Definition at line 152 of file dsHdmiIn.c.

◆ dsHdmiInScaleVideo()

dsError_t dsHdmiInScaleVideo	(	int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height
	)

Scale the HDMI In video This function is used to scale the HDMI In video.

Parameters

[in]	x	: x coordinate for the video
[in]	y	: y coordinate for the video
[in]	width	: width of the video
[in]	height	: height of the video

Returns: Device Settings error code

Return values

dsError_t

Definition at line 176 of file dsHdmiIn.c.

◆ dsHdmiInSelectZoomMode()

dsError_t dsHdmiInSelectZoomMode ( dsVideoZoom_t requestedZoomMode )

Select the HDMI Input zoom mode.

This function is used to select the HDMI Input zoom mode.

Parameters

[in]

Definition at line 202 of file dsHdmiIn.c.

◆ dsHdmiInPauseAudio()

dsError_t dsHdmiInPauseAudio ( void )

Stop the output of HDMI Input audio.

This function stops the HDMI Input audio from being output via HDMI Out.

Parameters

None

Returns: Device Settings error code

Return values

dsError_t

Definition at line 225 of file dsHdmiIn.c.

◆ dsHdmiInResumeAudio()

dsError_t dsHdmiInResumeAudio ( void )

Start the output of HDMI Input audio.

This function presents the HDMI Input audio via HDMI Out.

Parameters

None

Returns: Device Settings error code

Return values

dsError_t

Definition at line 247 of file dsHdmiIn.c.

◆ dsHdmiInGetCurrentVideoMode()

dsError_t dsHdmiInGetCurrentVideoMode ( dsVideoPortResolution_t * resolution )

Get the current HDMI Input video mode.

This function gets the current HDMI Input video mode.

Parameters

None

Returns: Current HDMI Input video mode (resolution)

Return values

dsError_t

Definition at line 269 of file dsHdmiIn.c.

◆ dsHdmiInRegisterConnectCB()

dsError_t dsHdmiInRegisterConnectCB ( dsHdmiInConnectCB_t CBFunc )

Register for the HDMI Input hot plug event.

This function is used to register for the HDMI Input hot plug event.

Parameters

[in] CBFunc HDMI Input hot plug callback function.

Returns: Device Settings error code

Return values

dsError_t

◆ dsHdmiInRegisterSignalChangeCB()

dsError_t dsHdmiInRegisterSignalChangeCB ( dsHdmiInSignalChangeCB_t CBFunc )

Register for the HDMI Input Signal Change event.

This function is used to register for the HDMI Input Signal Change event.

Parameters

[in] CBFunc HDMI Input Signal change callback function.

Returns: Device Settings error code

Return values

dsError_t

◆ dsHdmiInRegisterStatusChangeCB()

dsError_t dsHdmiInRegisterStatusChangeCB ( dsHdmiInStatusChangeCB_t CBFunc )

Register for the HDMI Input Status Change event.

This function is used to register for the HDMI Input Status Change event.

Parameters

[in] CBFunc HDMI Input Status change callback function.

Returns: Device Settings error code

Return values

dsError_t

◆ dsHdmiInRegisterVideoModeUpdateCB()

dsError_t dsHdmiInRegisterVideoModeUpdateCB ( dsHdmiInVideoModeUpdateCB_t CBFunc )

Register for the HDMI Input Video Mode change event.

This function is used to register for the HDMI Input video mode Change event.

Parameters

[in] CBFunc HDMI Input video mode change callback function.

Returns: Device Settings error code

Return values

dsError_t

◆ dsHdmiInRegisterAllmChangeCB()

dsError_t dsHdmiInRegisterAllmChangeCB ( dsHdmiInAllmChangeCB_t CBFunc )

Register for the HDMI Input ALLM Mode Change event.

This function is used to register for the HDMI Input ALLM Mode Change event.

Parameters

[in] CBFunc HDMI Input ALLM Mode change callback function.

Returns: Device Settings error code

Return values

dsError_t

Description

Typedefs

Functions

Typedef Documentation

◆ dsHdmiInConnectCB_t

◆ dsHdmiInSignalChangeCB_t

◆ dsHdmiInStatusChangeCB_t

◆ dsHdmiInVideoModeUpdateCB_t

◆ dsHdmiInAllmChangeCB_t

Function Documentation

◆ dsHdmiInInit()

◆ dsHdmiInTerm()

◆ dsHdmiInGetNumberOfInputs()

◆ dsHdmiInGetStatus()

◆ dsHdmiInSelectPort()

◆ dsHdmiInScaleVideo()

◆ dsHdmiInSelectZoomMode()

◆ dsHdmiInPauseAudio()

◆ dsHdmiInResumeAudio()

◆ dsHdmiInGetCurrentVideoMode()

◆ dsHdmiInRegisterConnectCB()

◆ dsHdmiInRegisterSignalChangeCB()

◆ dsHdmiInRegisterStatusChangeCB()

◆ dsHdmiInRegisterVideoModeUpdateCB()

◆ dsHdmiInRegisterAllmChangeCB()