Device Settings HAL types. More...

#include <sys/types.h>
#include <stdint.h>
#include <stdbool.h>

Include dependency graph for dsTypes.h:

Data Structures
struct	_dsAudioSADList_t

struct	_dsAudioARCStatus_t
	Structure that defines ARC status for the HDMI ARC/EARC port. More...

struct	_dsMS12AudioProfileList_t

struct	_dsVolumeLeveller_t

struct	_dsSurroundVirtualizer_t

struct	_dsVideoConfig_t
	Structure that defines video device configuration for the output. More...

struct	_dsAudioTypeConfig_t
	Structure that defines audio output device configuration. More...

struct	_dsVideoPortResolution_t
	Structure that defines video port resolution settings of output video device. More...

struct	_dsAudioPortId_t
	Structure that defines the audio port type and associated ID. More...

struct	_dsVideoPortPortId_t
	Structure that defines port id associated with video port. More...

struct	_dsVideoPortTypeConfig_t
	Structure that defines the video output port configuration. More...

struct	_dsAudioPortConfig_t
	Structure that defines audio port configuration. More...

struct	_dsVideoPortPortConfig_t
	Structure that defines video port configuration settings. More...

struct	_dsDisplayEDID_t
	Defines the structure that is used to get the EDID information of the video display. More...

struct	_dsHdmiInStatus_t

struct	_dsHdmiInCap_t

struct	_dsCompositeInStatus_t

struct	dsVideoCodecProfileSupport_t

struct	dsVideoCodecInfo_t

struct	dsSpd_infoframe_st

struct	_dsSupportedGameFeatureList_t

Macros
#define	dsAUDIOPORT_TYPE_NUM_MAX 4

#define	dsAudioPORT_NUM_MAX 4

#define	dsAudioType_isValid(t) (((t) >= dsAUDIOPORT_TYPE_ID_LR ) && ((t) < dsAUDIOPORT_TYPE_MAX))

#define	dsAudioEncoding_isValid(t) (((t) >= dsAUDIO_ENC_NONE ) && ((t) < dsAUDIO_ENC_MAX))

#define	MAX_SAD 15
	Structure that defines Short Audio Descriptors retrieved from connected ARC device.

#define	MAX_PROFILE_LIST_BUFFER_LEN 1024
	Structure that captures MS12 Audio Profile list.

#define	dsAudioCompression_isValid(t) (((t) >= dsAUDIO_CMP_NONE ) && ((t) < dsAUDIO_CMP_MAX))

#define	dsAudioStereoMode_isValid(t) (((t) >= dsAUDIO_STEREO_UNKNOWN ) && ((t) < dsAUDIO_STEREO_MAX))

#define	dsHdcpStatus_isValid(t) (((t) >= dsHDCP_STATUS_UNPOWERED ) && ((t) < dsHDCP_STATUS_MAX))

#define	dsVideoPortType_isValid(t) (((t) >= dsVIDEOPORT_TYPE_RF ) && ((t) < dsVIDEOPORT_TYPE_MAX))

#define	dsVideoPortPixelResolution_isValid(t) (((t) >= dsVIDEO_PIXELRES_720x480 ) && ((t) < dsVIDEO_PIXELRES_MAX))

#define	dsVideoPortFrameRate_isValid(t) (((t) >= dsVIDEO_FRAMERATE_UNKNOWN ) && ((t) < dsVIDEO_FRAMERATE_MAX))

#define	dsVideoPortScanMode_isValid(t) (((t) >= dsVIDEO_SCANMODE_INTERLACED ) && ((t) < dsVIDEO_SCANMODE_MAX))

#define	dsVideoPortAspectRatio_isValid(t) (((t) >= dsVIDEO_ASPECT_RATIO_4x3 ) && ((t) < dsVIDEO_ASPECT_RATIO_MAX))

#define	dsVideoPortStereoScopicMode_isValid(t) (((t) >= dsVIDEO_SSMODE_UNKNOWN ) && ((t) < dsVIDEO_SSMODE_MAX))

#define	dsVideoPortDFC_isValid(t) (((t) >= dsVIDEO_ZOOM_NONE ) && ((t) < dsVIDEO_ZOOM_MAX))

#define	HDCP_KEY_MAX_SIZE (4*1024)

#define	MAX_LANGUAGE_LEN 10

#define	dsFPDColor_Make(R8, G8, B8) (((R8)<<16) \| ((G8)<< 8) \| ((B8) ))

#define	dsFPDColor_R(RGB32) (((RGB32) >> 16) & 0xFF)

#define	dsFPDColor_G(RGB32) (((RGB32) >> 8) & 0xFF)

#define	dsFPDColor_B(RGB32) (((RGB32) ) & 0xFF)

#define	dsFPD_COLOR_BLUE dsFPDColor_Make(0, 0, 0xFF)

#define	dsFPD_COLOR_GREEN dsFPDColor_Make(0, 0xFF, 0)

#define	dsFPD_COLOR_RED dsFPDColor_Make(0xFF, 0, 0x0)

#define	dsFPD_COLOR_YELLOW dsFPDColor_Make(0xFF, 0xFF, 0xE0)

#define	dsFPD_COLOR_ORANGE dsFPDColor_Make(0xFF, 0x8C, 0x00)

#define	dsFPD_COLOR_WHITE dsFPDColor_Make(0xFF, 0xFF, 0xFF)

#define	dsFPD_COLOR_MAX 6

#define	dsFPDColor_isValid(t) (((t) & 0xFF000000) == 0)

#define	dsFPD_INDICATOR_MESSAGE 0

#define	dsFPD_INDICATOR_POWER 1

#define	dsFPD_INDICATOR_RECORD 2

#define	dsFPD_INDICATOR_REMOTE 3

#define	dsFPD_INDICATOR_RFBYPASS 4

#define	dsFPD_INDICATOR_MAX 5

#define	dsFPDIndicator_isValid(t) (true)

#define	dsFPDTextDisplay_isValid(t) (((t) >= dsFPD_TEXTDISP_TEXT ) && ((t) < dsFPD_TEXTDISP_MAX))

#define	dsFPD_BRIGHTNESS_MAX 100

#define	dsEEDID_MAX_VIDEO_CODE 64

#define	dsEEDID_MAX_MON_NAME_LENGTH 14

#define	MAX_EDID_BYTES_LEN (1024)

#define	dsSleepMode_isValid(t) (((t) >= dsHOST_SLEEP_MODE_LIGHT) && ((t) < dsHOST_SLEEP_MODE_MAX))

#define	MAX_FEATURE_LIST_BUFFER_LEN 1024
	Structure that captures Supported Game Features list.

#define	dsHAL_APIVER(major, minor) (uint32_t)((major << 16) \| (minor & 0xFFFF))

#define	dsHAL_APIVER_MAJOR(x) ((x) >> 16) & (0x7FFF)

#define	dsHAL_APIVER_MINOR(x) (x & 0xFFFF)

Typedefs
typedef enum _dsAudioPortType_t	dsAudioPortType_t

typedef enum _dsAudioEncoding_t	dsAudioEncoding_t

typedef enum _dsAudioCompression_t	dsAudioCompression_t

typedef enum _dsAudioFormat_t	dsAudioFormat_t

typedef enum _dsAudioDuckingAction_t	dsAudioDuckingAction_t

typedef enum _dsAudioDuckingType_t	dsAudioDuckingType_t

typedef int	dsAudioCompressionValue_t

typedef int	dsDialogEnhancer_t

typedef int	dsIntelligentEqualizerMode_t

typedef enum _dsAudioCapabilities_t	dsAudioCapabilities_t

typedef enum _dsAudioARCTypes_t	dsAudioARCTypes_t

typedef struct _dsAudioSADList_t	dsAudioSADList_t

typedef struct _dsAudioARCStatus_t	dsAudioARCStatus_t
	Structure that defines ARC status for the HDMI ARC/EARC port.

typedef enum _dsMS12Capabilities_t	dsMS12Capabilities_t

typedef struct _dsMS12AudioProfileList_t	dsMS12AudioProfileList_t

typedef struct _dsVolumeLeveller_t	dsVolumeLeveller_t

typedef struct _dsSurroundVirtualizer_t	dsSurroundVirtualizer_t

typedef enum StereoMode	dsAudioStereoMode_t

typedef enum _dsATMOSCapability_t	dsATMOSCapability_t

typedef enum _dsHdcpProtocolVersion_t	dsHdcpProtocolVersion_t

typedef enum _dsHdcpStatus_t	dsHdcpStatus_t

typedef enum _dsVideoPortType_t	dsVideoPortType_t

typedef enum _dsVideoResolution_t	dsVideoResolution_t

typedef enum _dsTVResolution_t	dsTVResolution_t

typedef enum _dsVideoFrameRate_t	dsVideoFrameRate_t

typedef enum _dsVideoScanMode_t	dsVideoScanMode_t

typedef enum _dsVideoBackgroundColor_t	dsVideoBackgroundColor_t

typedef enum _dsVideoAspectRatio_t	dsVideoAspectRatio_t

typedef enum _dsVideoStereoScopicMode_t	dsVideoStereoScopicMode_t

typedef enum _dsVideoZoom_t	dsVideoZoom_t

typedef struct _dsVideoConfig_t	dsVideoConfig_t
	Structure that defines video device configuration for the output.

typedef struct _dsAudioTypeConfig_t	dsAudioTypeConfig_t
	Structure that defines audio output device configuration.

typedef struct _dsVideoPortResolution_t	dsVideoPortResolution_t
	Structure that defines video port resolution settings of output video device.

typedef struct _dsAudioPortId_t	dsAudioPortId_t
	Structure that defines the audio port type and associated ID.

typedef struct _dsVideoPortPortId_t	dsVideoPortPortId_t
	Structure that defines port id associated with video port.

typedef struct _dsVideoPortTypeConfig_t	dsVideoPortTypeConfig_t
	Structure that defines the video output port configuration.

typedef enum _dsHDRStandard_t	dsHDRStandard_t

typedef enum _dsSURROUNDMode_t	dsSURROUNDMode_t

typedef enum _dsMS12FEATURE_t	dsMS12FEATURE_t

typedef struct _dsAudioPortConfig_t	dsAudioPortConfig_t
	Structure that defines audio port configuration.

typedef struct _dsVideoPortPortConfig_t	dsVideoPortPortConfig_t
	Structure that defines video port configuration settings.

typedef uint32_t	dsFPDColor_t

typedef int32_t	dsFPDIndicator_t

typedef enum __dsFPDTextDisplay_t	dsFPDTextDisplay_t

typedef enum __dsFPDState_t	dsFPDState_t

typedef enum __dsFPDLedState_t	dsFPDLedState_t

typedef enum __dsFPDTimeFormat_t	dsFPDTimeFormat_t

typedef uint32_t	dsFPDBrightness_t

typedef enum __dsFPDMode_t	dsFPDMode_t

typedef struct _dsDisplayEDID_t	dsDisplayEDID_t
	Defines the structure that is used to get the EDID information of the video display.

typedef enum _dsSleepMode_t	dsSleepMode_t

typedef enum _dsPowerState_t	dsPowerState_t

typedef enum _dsDisplayMatrixCoefficients_t	dsDisplayMatrixCoefficients_t

typedef enum _dsDisplayColorimetryInfo_t	dsDisplayColorimetryInfo_t

typedef enum _dsDisplayColorSpace_t	dsDisplayColorSpace_t

typedef enum _dsDisplayQuantizationRange_t	dsDisplayQuantizationRange_t

typedef enum _dsDisplayColorDepth_t	dsDisplayColorDepth_t

typedef enum _dsHdmiInPort_t	dsHdmiInPort_t

typedef enum _dsHdmiInSignalStatus_t	dsHdmiInSignalStatus_t

typedef struct _dsHdmiInStatus_t	dsHdmiInStatus_t

typedef struct _dsHdmiInCap_t	dsHdmiInCap_t

typedef enum _dsCompInSignalStatus_t	dsCompInSignalStatus_t

typedef enum _dsCompositeInPort_t	dsCompositeInPort_t

typedef struct _dsCompositeInStatus_t	dsCompositeInStatus_t

typedef enum tv_hdmi_edid_version_e	tv_hdmi_edid_version_t

typedef struct _dsSupportedGameFeatureList_t	dsSupportedGameFeatureList_t

typedef enum _dsAudioPortState	dsAudioPortState_t

Enumerations
enum	_dsAudioPortType_t

enum	_dsAudioEncoding_t

enum	_dsAudioCompression_t

enum	_dsAudioFormat_t

enum	_dsAudioDuckingAction_t

enum	_dsAudioDuckingType_t

enum	_dsAudioCapabilities_t

enum	_dsAudioARCTypes_t

enum	_dsMS12Capabilities_t

enum	StereoMode

enum	_dsATMOSCapability_t

enum	_dsHdcpProtocolVersion_t

enum	_dsHdcpStatus_t

enum	_dsVideoPortType_t

enum	_dsVideoResolution_t

enum	_dsTVResolution_t

enum	_dsVideoFrameRate_t

enum	_dsVideoScanMode_t

enum	_dsVideoBackgroundColor_t

enum	_dsVideoAspectRatio_t

enum	_dsVideoStereoScopicMode_t

enum	_dsVideoZoom_t

enum	_dsHDRStandard_t

enum	_dsSURROUNDMode_t

enum	_dsMS12FEATURE_t

enum	__dsFPDTextDisplay_t

enum	__dsFPDState_t

enum	__dsFPDLedState_t

enum	__dsFPDTimeFormat_t

enum	__dsFPDMode_t

enum	_dsSleepMode_t

enum	_dsPowerState_t

enum	_dsDisplayMatrixCoefficients_t

enum	_dsDisplayColorimetryInfo_t

enum	_dsDisplayColorSpace_t

enum	_dsDisplayQuantizationRange_t

enum	_dsDisplayColorDepth_t

enum	_dsHdmiInPort_t

enum	_dsHdmiInSignalStatus_t

enum	_dsCompInSignalStatus_t

enum	_dsCompositeInPort_t

enum	dsVideoCodingFormat_t

enum	dsVideoCodecHevcProfiles_t

enum	tv_hdmi_edid_version_e

enum	_dsAudioPortState

yes

Device Settings HAL types.

This API defines common types used by the Device Settings HAL.

Document: Document reference.

Open Issues (in no particular order)

None

Assumptions

None

Abbreviations

BE: Big-Endian.
cb: Callback function (suffix).
DS: Device Settings.
FPD: Front-Panel Display.
HAL: Hardware Abstraction Layer.
LE: Little-Endian.
LS: Least Significant.
MBZ: Must be zero.
MS: Most Significant.
RDK: Reference Design Kit.
_t: Type (suffix).

Implementation Notes

None

Definition in file dsTypes.h.

Data Structures

Macros

Typedefs

Enumerations

yes