1 /*
2  * Copyright (c) 2013 - 2016, 2018 - 2021, The Linux Foundation. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *    * Redistributions of source code must retain the above copyright
8  *      notice, this list of conditions and the following disclaimer.
9  *    * Redistributions in binary form must reproduce the above
10  *      copyright notice, this list of conditions and the following
11  *      disclaimer in the documentation and/or other materials provided
12  *      with the distribution.
13  *    * Neither the name of The Linux Foundation. nor the names of its
14  *      contributors may be used to endorse or promote products derived
15  *      from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
18  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef _DISPLAY_CONFIG_H
31 #define _DISPLAY_CONFIG_H
32 
33 #include <vector>
34 
35 #include <gralloc_priv.h>
36 #include <qdMetaData.h>
37 #include <hardware/hwcomposer.h>
38 
39 // This header is for clients to use to set/get global display configuration.
40 // Only primary and external displays are supported here.
41 
42 namespace qdutils {
43 
44 
45 /* TODO: Have all the common enums that need be exposed to clients and which
46  * are also needed in hwc defined here. Remove such definitions we have in
47  * hwc_utils.h
48  */
49 
50 // Use this enum to specify the dpy parameters where needed
51 enum {
52     // DO NOT CHANGE THE LEGACY DEFINES
53     DISPLAY_PRIMARY = 0,    // = HWC_DISPLAY_PRIMARY
54     DISPLAY_EXTERNAL = 1,   // = HWC_DISPLAY_EXTERNAL
55     DISPLAY_VIRTUAL = 2,    // = HWC_DISPLAY_VIRTUAL
56 
57     // Additional displays only for vendor client (e.g. pp) reference
58     DISPLAY_BUILTIN_2 = 3,
59     DISPLAY_EXTERNAL_2 = 4,
60 };
61 
62 // External Display states - used in setSecondaryDisplayStatus()
63 // To be consistent with the same defined in hwc_utils.h
64 enum {
65     EXTERNAL_OFFLINE = 0,
66     EXTERNAL_ONLINE,
67     EXTERNAL_PAUSE,
68     EXTERNAL_RESUME,
69 };
70 
71 enum {
72     DISABLE_METADATA_DYN_REFRESH_RATE = 0,
73     ENABLE_METADATA_DYN_REFRESH_RATE,
74     SET_BINDER_DYN_REFRESH_RATE,
75 };
76 
77 enum {
78     DEFAULT_MODE = 0,
79     VIDEO_MODE,
80     COMMAND_MODE,
81 };
82 
83 enum {
84     DISPLAY_PORT_DEFAULT = 0,
85     DISPLAY_PORT_DSI,
86     DISPLAY_PORT_DTV,
87     DISPLAY_PORT_WRITEBACK,
88     DISPLAY_PORT_LVDS,
89     DISPLAY_PORT_EDP,
90     DISPLAY_PORT_DP,
91 };
92 
93 // Display Attributes that are available to clients of this library
94 // Not to be confused with a similar struct in hwc_utils (in the hwc namespace)
95 typedef struct DisplayAttributes {
96     uint32_t vsync_period = 0; //nanoseconds
97     uint32_t xres = 0;
98     uint32_t yres = 0;
99     float xdpi = 0.0f;
100     float ydpi = 0.0f;
101     int panel_type = DISPLAY_PORT_DEFAULT;
102     bool is_yuv = false;
103 } DisplayAttributes_t;
104 
105 //=============================================================================
106 // The functions below run in the client process and wherever necessary
107 // do a binder call to HWC to get/set data.
108 
109 // Check if external display is connected. Useful to check before making
110 // calls for external displays
111 // Returns 1 if connected, 0 if disconnected, negative values on errors
112 int isExternalConnected(void);
113 
114 // Get display vsync period which is in nanoseconds
115 // i.e vsync_period = 1000000000l / fps
116 // Returns 0 on success, negative values on errors
117 int getDisplayAttributes(int dpy, DisplayAttributes_t& dpyattr);
118 
119 // get the active visible region for the display
120 // Returns 0 on success, negative values on errors
121 int getDisplayVisibleRegion(int dpy, hwc_rect_t &rect);
122 
123 // set the view frame information in hwc context from surfaceflinger
124 int setViewFrame(int dpy, int l, int t, int r, int b);
125 
126 // Set the secondary display status(pause/resume/offline etc.,)
127 int setSecondaryDisplayStatus(int dpy, uint32_t status);
128 
129 // Enable/Disable/Set refresh rate dynamically
130 int configureDynRefreshRate(uint32_t op, uint32_t refreshRate);
131 
132 // Returns the number of configs supported for the display on success.
133 // Returns -1 on error.
134 // Only primary display supported for now, value of dpy ignored.
135 int getConfigCount(int dpy);
136 
137 // Returns the index of config that is current set for the display on success.
138 // Returns -1 on error.
139 // Only primary display supported for now, value of dpy ignored.
140 int getActiveConfig(int dpy);
141 
142 // Sets the config for the display on success and returns 0.
143 // Returns -1 on error.
144 // Only primary display supported for now, value of dpy ignored
145 int setActiveConfig(int configIndex, int dpy);
146 
147 // Returns the attributes for the specified config for the display on success.
148 // Returns xres and yres as 0 on error.
149 // Only primary display supported for now, value of dpy ignored
150 DisplayAttributes getDisplayAttributes(int configIndex, int dpy);
151 
152 // Set the primary display mode to command or video mode
153 int setDisplayMode(int mode);
154 
155 // Sets the panel brightness of the primary display
156 int setPanelBrightness(int level);
157 
158 // Retrieves the current panel brightness value
159 int getPanelBrightness();
160 
161 // Sets the specified bit clk value.
162 int setDsiClk(int dpy, uint64_t bitClk);
163 
164 // Retrieves the current bit clk value.
165 uint64_t getDsiClk(int dpy);
166 
167 // Get supported bit clk values.
168 int getSupportedBitClk(int dpy, std::vector<uint64_t>& bit_rates);
169 
170 // Sets the specified min and max luminance values.
171 int setPanelLuminanceAttributes(int dpy, float min_lum, float max_lum);
172 
173 // Sets display standy mode
174 extern "C" int setStandByMode(int mode);
175 
176 }; //namespace
177 
178 
179 extern "C" int waitForComposerInit();
180 #endif
181