Device Settings HAL 0.2.0
 
Loading...
Searching...
No Matches
dsVideoPortSettings_sample.h
Go to the documentation of this file.
1/*
2 * If not stated otherwise in this file or this component's LICENSE file the
3 * following copyright and licenses apply:
4 *
5 * Copyright 2016 RDK Management
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18*/
19
20/**
21 * @addtogroup HPK Hardware Porting Kit
22 * @{
23 * @par The Hardware Porting Kit
24 * HPK is the next evolution of the well-defined Hardware Abstraction Layer
25 * (HAL), but augmented with more comprehensive documentation and test suites
26 * that OEM or SOC vendors can use to self-certify their ports before taking
27 * them to RDKM for validation or to an operator for final integration and
28 * deployment. The Hardware Porting Kit effectively enables an OEM and/or SOC
29 * vendor to self-certify their own Video Accelerator devices, with minimal RDKM
30 * assistance.
31 *
32 */
33
34/**
35 * @addtogroup Device_Settings Device Settings Module
36 * @{
37 */
38
39/**
40 * @addtogroup Device_Settings_HAL Device Settings HAL
41 * @par Application API Specification
42 * Described herein are the DeviceSettings HAL types and functions that are part of
43 * the Video Port subsystem. The Video Port subsystem manages system-specific HAL operations.
44 * @{
45 */
46
47/**
48 * @addtogroup dsVideoPort_HAL DS Video Port HAL
49 * @{
50 * @par Application API Specification
51 * dsVideoPort HAL provides an interface for managing the VideoPort settings for the device settings module
52 */
53
54/**
55 * @defgroup DSHAL_VIDEOPORT_SETTINGS_H DS Video Port Settings Header
56 * @{
57 * @par Application API Specification
58 */
59
60/**
61 * @file dsVideoPortSettings_sample.h
62 *
63 * <b> Following abbreviations present in HAL API </b>
64 *
65 * @par Abbreviations
66 * - cb: Callback function (suffix).
67 * - DS: Device Settings.
68 * - HAL: Hardware Abstraction Layer.
69 * - HDMI: High-Definition Multimedia Interface
70 *
71 */
72
73
74#ifndef _DS_VIDEOOUTPUTPORTSETTINGS_H_
75#define _DS_VIDEOOUTPUTPORTSETTINGS_H_
76
77#include "dsTypes.h"
78#include "dsUtl.h"
79#include "dsVideoResolutionSettings.h"
80
81
82#ifdef __cplusplus
83extern "C" {
84#endif
85
86namespace {
87/*
88 * Enumerate the supported video port configurations here.
89 */
90static const dsVideoPortType_t kSupportedPortTypes[] = { dsVIDEOPORT_TYPE_HDMI };
91
92/*
93 * Enumerate all configurations for each port type.
94 */
95static const dsVideoPortTypeConfig_t kConfigs[]= {
96 {
97 /*.typeId = */ dsVIDEOPORT_TYPE_HDMI,
98 /*.name = */ "HDMI",
99 /*.dtcpSupported = */ false,
100 /*.hdcpSupported = */ true,
101 /*.restrictedResollution = */ -1,
102 /*.numSupportedResolutions = */ dsUTL_DIM(kResolutions), // 0 means "Info available at runtime"
103 /*.supportedResolutons = */ kResolutions,
104 },
105};
106
107/*
108 * Enumerate all enabled Video Output Ports here.
109 */
110static const dsVideoPortPortConfig_t kPorts[] = {
111 {
112 /*.typeId = */ {dsVIDEOPORT_TYPE_HDMI, 0},
113 /*.connectedAOP */ {dsAUDIOPORT_TYPE_HDMI, 0},
114 /*.defaultResolution = */ "720p"
115 },
116};
117
118}
119
120#ifdef __cplusplus
121}
122#endif
123#endif /* _DS_VIDEOOUTPUTPORTSETTINGS_H_ */
124
125/** @} */ // End of DS Video Port Settings Header
126/** @} */ // End of DS Video Port HAL
127/** @} */ // End of Device Settings HAL
128/** @} */ // End of Device Settings Module
129/** @} */ // End of HPK
HAL types.
Device Settings HAL utilities.
enum _dsVideoPortType_t dsVideoPortType_t
This enumeration defines all of the standard type of Video ports.
@ dsAUDIOPORT_TYPE_HDMI
HDMI audio output
Definition dsTypes.h:101
@ dsVIDEOPORT_TYPE_HDMI
HDMI video output.
Definition dsTypes.h:385
#define dsUTL_DIM(arr)
Device Settings general Array dimension calculation inline definition.
Definition dsUtl.h:98
Structure that defines video port configuration settings.
Definition dsTypes.h:684
Structure that defines the video output port configuration.
Definition dsTypes.h:610