1 /*
2  * Copyright (c) 2013 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 <gralloc_priv.h>
34 #include <qdMetaData.h>
35 #include <hardware/hwcomposer.h>
36 
37 // This header is for clients to use to set/get global display configuration.
38 // Only primary and external displays are supported here.
39 
40 namespace qdutils {
41 
42 
43 /* TODO: Have all the common enums that need be exposed to clients and which
44  * are also needed in hwc defined here. Remove such definitions we have in
45  * hwc_utils.h
46  */
47 
48 // Use this enum to specify the dpy parameters where needed
49 enum {
50     DISPLAY_PRIMARY = 0,
51     DISPLAY_EXTERNAL,
52     DISPLAY_TERTIARY,
53     DISPLAY_VIRTUAL,
54 };
55 
56 // External Display states - used in setSecondaryDisplayStatus()
57 // To be consistent with the same defined in hwc_utils.h
58 enum {
59     EXTERNAL_OFFLINE = 0,
60     EXTERNAL_ONLINE,
61     EXTERNAL_PAUSE,
62     EXTERNAL_RESUME,
63 };
64 
65 enum {
66     DISABLE_METADATA_DYN_REFRESH_RATE = 0,
67     ENABLE_METADATA_DYN_REFRESH_RATE,
68     SET_BINDER_DYN_REFRESH_RATE,
69 };
70 
71 enum {
72     DEFAULT_MODE = 0,
73     VIDEO_MODE,
74     COMMAND_MODE,
75 };
76 
77 // Display Attributes that are available to clients of this library
78 // Not to be confused with a similar struct in hwc_utils (in the hwc namespace)
79 typedef struct DisplayAttributes {
80     uint32_t vsync_period; //nanoseconds
81     uint32_t xres;
82     uint32_t yres;
83     float xdpi;
84     float ydpi;
85     char panel_type;
DisplayAttributesDisplayAttributes86     DisplayAttributes() : vsync_period(0), xres(0), yres(0), xdpi(0.0f),
87             ydpi(0.0f), panel_type(0) {}
88 } DisplayAttributes_t;
89 
90 //=============================================================================
91 // The functions below run in the client process and wherever necessary
92 // do a binder call to HWC to get/set data.
93 
94 // Check if external display is connected. Useful to check before making
95 // calls for external displays
96 // Returns 1 if connected, 0 if disconnected, negative values on errors
97 int isExternalConnected(void);
98 
99 // Get display vsync period which is in nanoseconds
100 // i.e vsync_period = 1000000000l / fps
101 // Returns 0 on success, negative values on errors
102 int getDisplayAttributes(int dpy, DisplayAttributes_t& dpyattr);
103 
104 // Set HSIC data on a given display ID
105 // Returns 0 on success, negative values on errors
106 int setHSIC(int dpy, const HSICData_t& hsic_data);
107 
108 // get the active visible region for the display
109 // Returns 0 on success, negative values on errors
110 int getDisplayVisibleRegion(int dpy, hwc_rect_t &rect);
111 
112 // set the view frame information in hwc context from surfaceflinger
113 int setViewFrame(int dpy, int l, int t, int r, int b);
114 
115 // Set the secondary display status(pause/resume/offline etc.,)
116 int setSecondaryDisplayStatus(int dpy, uint32_t status);
117 
118 // Enable/Disable/Set refresh rate dynamically
119 int configureDynRefreshRate(uint32_t op, uint32_t refreshRate);
120 
121 // Returns the number of configs supported for the display on success.
122 // Returns -1 on error.
123 // Only primary display supported for now, value of dpy ignored.
124 int getConfigCount(int dpy);
125 
126 // Returns the index of config that is current set for the display on success.
127 // Returns -1 on error.
128 // Only primary display supported for now, value of dpy ignored.
129 int getActiveConfig(int dpy);
130 
131 // Sets the config for the display on success and returns 0.
132 // Returns -1 on error.
133 // Only primary display supported for now, value of dpy ignored
134 int setActiveConfig(int configIndex, int dpy);
135 
136 // Returns the attributes for the specified config for the display on success.
137 // Returns xres and yres as 0 on error.
138 // Only primary display supported for now, value of dpy ignored
139 DisplayAttributes getDisplayAttributes(int configIndex, int dpy);
140 
141 // Set the primary display mode to command or video mode
142 int setDisplayMode(int mode);
143 
144 // Sets the panel brightness of the primary display
145 int setPanelBrightness(int level);
146 
147 // Retrieves the current panel brightness value
148 int getPanelBrightness();
149 
150 }; //namespace
151 
152 #endif
153