1 /* 2 * Copyright (C) 2010 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef ANDROID_INCLUDE_HARDWARE_HWCOMPOSER_DEFS_H 18 #define ANDROID_INCLUDE_HARDWARE_HWCOMPOSER_DEFS_H 19 20 #include <stdint.h> 21 #include <sys/cdefs.h> 22 23 #include <hardware/gralloc.h> 24 #include <hardware/hardware.h> 25 #include <cutils/native_handle.h> 26 27 __BEGIN_DECLS 28 29 /* Shared by HWC1 and HWC2 */ 30 31 #define HWC_HEADER_VERSION 1 32 33 #define HWC_MODULE_API_VERSION_0_1 HARDWARE_MODULE_API_VERSION(0, 1) 34 35 #define HWC_DEVICE_API_VERSION_1_0 HARDWARE_DEVICE_API_VERSION_2(1, 0, HWC_HEADER_VERSION) 36 #define HWC_DEVICE_API_VERSION_1_1 HARDWARE_DEVICE_API_VERSION_2(1, 1, HWC_HEADER_VERSION) 37 #define HWC_DEVICE_API_VERSION_1_2 HARDWARE_DEVICE_API_VERSION_2(1, 2, HWC_HEADER_VERSION) 38 #define HWC_DEVICE_API_VERSION_1_3 HARDWARE_DEVICE_API_VERSION_2(1, 3, HWC_HEADER_VERSION) 39 #define HWC_DEVICE_API_VERSION_1_4 HARDWARE_DEVICE_API_VERSION_2(1, 4, HWC_HEADER_VERSION) 40 #define HWC_DEVICE_API_VERSION_1_5 HARDWARE_DEVICE_API_VERSION_2(1, 5, HWC_HEADER_VERSION) 41 42 #define HWC_DEVICE_API_VERSION_2_0 HARDWARE_DEVICE_API_VERSION_2(2, 0, HWC_HEADER_VERSION) 43 44 /** 45 * The id of this module 46 */ 47 #define HWC_HARDWARE_MODULE_ID "hwcomposer" 48 49 /** 50 * Name of the sensors device to open 51 */ 52 #define HWC_HARDWARE_COMPOSER "composer" 53 54 typedef struct hwc_color { 55 uint8_t r; 56 uint8_t g; 57 uint8_t b; 58 uint8_t a; 59 } hwc_color_t; 60 61 typedef struct hwc_float_color { 62 float r; 63 float g; 64 float b; 65 float a; 66 } hwc_float_color_t; 67 68 typedef struct hwc_frect { 69 float left; 70 float top; 71 float right; 72 float bottom; 73 } hwc_frect_t; 74 75 typedef struct hwc_rect { 76 int left; 77 int top; 78 int right; 79 int bottom; 80 } hwc_rect_t; 81 82 typedef struct hwc_region { 83 size_t numRects; 84 hwc_rect_t const* rects; 85 } hwc_region_t; 86 87 /* 88 * hwc_layer_t::transform values 89 */ 90 typedef enum { 91 /* flip source image horizontally */ 92 HWC_TRANSFORM_FLIP_H = HAL_TRANSFORM_FLIP_H, 93 /* flip source image vertically */ 94 HWC_TRANSFORM_FLIP_V = HAL_TRANSFORM_FLIP_V, 95 /* rotate source image 90 degrees clock-wise */ 96 HWC_TRANSFORM_ROT_90 = HAL_TRANSFORM_ROT_90, 97 /* rotate source image 180 degrees */ 98 HWC_TRANSFORM_ROT_180 = HAL_TRANSFORM_ROT_180, 99 /* rotate source image 270 degrees clock-wise */ 100 HWC_TRANSFORM_ROT_270 = HAL_TRANSFORM_ROT_270, 101 /* flip source image horizontally, the rotate 90 degrees clock-wise */ 102 HWC_TRANSFORM_FLIP_H_ROT_90 = HAL_TRANSFORM_FLIP_H | HAL_TRANSFORM_ROT_90, 103 /* flip source image vertically, the rotate 90 degrees clock-wise */ 104 HWC_TRANSFORM_FLIP_V_ROT_90 = HAL_TRANSFORM_FLIP_V | HAL_TRANSFORM_ROT_90, 105 } hwc_transform_t; 106 107 /* Constraints for changing vsync period */ 108 typedef struct hwc_vsync_period_change_constraints { 109 /* Time in CLOCK_MONOTONIC after which the vsync period may change 110 * (i.e., the vsync period must not change before this time). */ 111 int64_t desiredTimeNanos; 112 /* 113 * If true, requires that the vsync period change must happen seamlessly without 114 * a noticeable visual artifact. */ 115 uint8_t seamlessRequired; 116 } hwc_vsync_period_change_constraints_t; 117 118 /* Timing for a vsync period change. */ 119 typedef struct hwc_vsync_period_change_timeline { 120 /* The time in CLOCK_MONOTONIC when the new display will start to refresh at 121 * the new vsync period. */ 122 int64_t newVsyncAppliedTimeNanos; 123 124 /* Set to true if the client is required to sent a frame to be displayed before 125 * the change can take place. */ 126 uint8_t refreshRequired; 127 128 /* The time in CLOCK_MONOTONIC when the client is expected to send the new frame. 129 * Should be ignored if refreshRequired is false. */ 130 int64_t refreshTimeNanos; 131 } hwc_vsync_period_change_timeline_t; 132 133 typedef struct hwc_client_target_property { 134 // The pixel format of client target requested by hardware composer. 135 int32_t pixelFormat; 136 // The dataspace of the client target requested by hardware composer. 137 int32_t dataspace; 138 } hwc_client_target_property_t; 139 140 /******************************************************************************* 141 * Beyond this point are things only used by HWC1, which should be ignored when 142 * implementing a HWC2 device 143 ******************************************************************************/ 144 145 enum { 146 /* hwc_composer_device_t::set failed in EGL */ 147 HWC_EGL_ERROR = -1 148 }; 149 150 /* 151 * hwc_layer_t::hints values 152 * Hints are set by the HAL and read by SurfaceFlinger 153 */ 154 enum { 155 /* 156 * HWC can set the HWC_HINT_TRIPLE_BUFFER hint to indicate to SurfaceFlinger 157 * that it should triple buffer this layer. Typically HWC does this when 158 * the layer will be unavailable for use for an extended period of time, 159 * e.g. if the display will be fetching data directly from the layer and 160 * the layer can not be modified until after the next set(). 161 */ 162 HWC_HINT_TRIPLE_BUFFER = 0x00000001, 163 164 /* 165 * HWC sets HWC_HINT_CLEAR_FB to tell SurfaceFlinger that it should clear the 166 * framebuffer with transparent pixels where this layer would be. 167 * SurfaceFlinger will only honor this flag when the layer has no blending 168 * 169 */ 170 HWC_HINT_CLEAR_FB = 0x00000002 171 }; 172 173 /* 174 * hwc_layer_t::flags values 175 * Flags are set by SurfaceFlinger and read by the HAL 176 */ 177 enum { 178 /* 179 * HWC_SKIP_LAYER is set by SurfaceFlinger to indicate that the HAL 180 * shall not consider this layer for composition as it will be handled 181 * by SurfaceFlinger (just as if compositionType was set to HWC_FRAMEBUFFER). 182 */ 183 HWC_SKIP_LAYER = 0x00000001, 184 185 /* 186 * HWC_IS_CURSOR_LAYER is set by surfaceflinger to indicate that this 187 * layer is being used as a cursor on this particular display, and that 188 * surfaceflinger can potentially perform asynchronous position updates for 189 * this layer. If a call to prepare() returns HWC_CURSOR_OVERLAY for the 190 * composition type of this layer, then the hwcomposer will allow async 191 * position updates to this layer via setCursorPositionAsync(). 192 */ 193 HWC_IS_CURSOR_LAYER = 0x00000002 194 }; 195 196 /* 197 * hwc_layer_t::compositionType values 198 */ 199 enum { 200 /* this layer is to be drawn into the framebuffer by SurfaceFlinger */ 201 HWC_FRAMEBUFFER = 0, 202 203 /* this layer will be handled in the HWC */ 204 HWC_OVERLAY = 1, 205 206 /* this is the background layer. it's used to set the background color. 207 * there is only a single background layer */ 208 HWC_BACKGROUND = 2, 209 210 /* this layer holds the result of compositing the HWC_FRAMEBUFFER layers. 211 * Added in HWC_DEVICE_API_VERSION_1_1. */ 212 HWC_FRAMEBUFFER_TARGET = 3, 213 214 /* this layer's contents are taken from a sideband buffer stream. 215 * Added in HWC_DEVICE_API_VERSION_1_4. */ 216 HWC_SIDEBAND = 4, 217 218 /* this layer's composition will be handled by hwcomposer by dedicated 219 cursor overlay hardware. hwcomposer will also all async position updates 220 of this layer outside of the normal prepare()/set() loop. Added in 221 HWC_DEVICE_API_VERSION_1_4. */ 222 HWC_CURSOR_OVERLAY = 5 223 }; 224 /* 225 * hwc_layer_t::blending values 226 */ 227 enum { 228 /* no blending */ 229 HWC_BLENDING_NONE = 0x0100, 230 231 /* ONE / ONE_MINUS_SRC_ALPHA */ 232 HWC_BLENDING_PREMULT = 0x0105, 233 234 /* SRC_ALPHA / ONE_MINUS_SRC_ALPHA */ 235 HWC_BLENDING_COVERAGE = 0x0405 236 }; 237 238 /* attributes queriable with query() */ 239 enum { 240 /* 241 * Must return 1 if the background layer is supported, 0 otherwise. 242 */ 243 HWC_BACKGROUND_LAYER_SUPPORTED = 0, 244 245 /* 246 * Returns the vsync period in nanoseconds. 247 * 248 * This query is not used for HWC_DEVICE_API_VERSION_1_1 and later. 249 * Instead, the per-display attribute HWC_DISPLAY_VSYNC_PERIOD is used. 250 */ 251 HWC_VSYNC_PERIOD = 1, 252 253 /* 254 * Availability: HWC_DEVICE_API_VERSION_1_1 255 * Returns a mask of supported display types. 256 */ 257 HWC_DISPLAY_TYPES_SUPPORTED = 2, 258 }; 259 260 /* display attributes returned by getDisplayAttributes() */ 261 enum { 262 /* Indicates the end of an attribute list */ 263 HWC_DISPLAY_NO_ATTRIBUTE = 0, 264 265 /* The vsync period in nanoseconds */ 266 HWC_DISPLAY_VSYNC_PERIOD = 1, 267 268 /* The number of pixels in the horizontal and vertical directions. */ 269 HWC_DISPLAY_WIDTH = 2, 270 HWC_DISPLAY_HEIGHT = 3, 271 272 /* The number of pixels per thousand inches of this configuration. 273 * 274 * Scaling DPI by 1000 allows it to be stored in an int without losing 275 * too much precision. 276 * 277 * If the DPI for a configuration is unavailable or the HWC implementation 278 * considers it unreliable, it should set these attributes to zero. 279 */ 280 HWC_DISPLAY_DPI_X = 4, 281 HWC_DISPLAY_DPI_Y = 5, 282 283 /* Indicates which of the vendor-defined color transforms is provided by 284 * this configuration. */ 285 HWC_DISPLAY_COLOR_TRANSFORM = 6, 286 287 /* The configuration group this config is associated to. The groups are defined 288 * to mark certain configs as similar and changing configs within a certain group 289 * may be done seamlessly in some conditions. setActiveConfigWithConstraints. */ 290 HWC_DISPLAY_CONFIG_GROUP = 7, 291 }; 292 293 /* Allowed events for hwc_methods::eventControl() */ 294 enum { 295 HWC_EVENT_VSYNC = 0 296 }; 297 298 /* Display types and associated mask bits. */ 299 enum { 300 HWC_DISPLAY_PRIMARY = 0, 301 HWC_DISPLAY_EXTERNAL = 1, // HDMI, DP, etc. 302 HWC_DISPLAY_VIRTUAL = 2, 303 304 HWC_NUM_PHYSICAL_DISPLAY_TYPES = 2, 305 HWC_NUM_DISPLAY_TYPES = 3, 306 }; 307 308 enum { 309 HWC_DISPLAY_PRIMARY_BIT = 1 << HWC_DISPLAY_PRIMARY, 310 HWC_DISPLAY_EXTERNAL_BIT = 1 << HWC_DISPLAY_EXTERNAL, 311 HWC_DISPLAY_VIRTUAL_BIT = 1 << HWC_DISPLAY_VIRTUAL, 312 }; 313 314 /* Display power modes */ 315 enum { 316 /* The display is turned off (blanked). */ 317 HWC_POWER_MODE_OFF = 0, 318 /* The display is turned on and configured in a low power state 319 * that is suitable for presenting ambient information to the user, 320 * possibly with lower fidelity than normal but greater efficiency. */ 321 HWC_POWER_MODE_DOZE = 1, 322 /* The display is turned on normally. */ 323 HWC_POWER_MODE_NORMAL = 2, 324 /* The display is configured as in HWC_POWER_MODE_DOZE but may 325 * stop applying frame buffer updates from the graphics subsystem. 326 * This power mode is effectively a hint from the doze dream to 327 * tell the hardware that it is done drawing to the display for the 328 * time being and that the display should remain on in a low power 329 * state and continue showing its current contents indefinitely 330 * until the mode changes. 331 * 332 * This mode may also be used as a signal to enable hardware-based doze 333 * functionality. In this case, the doze dream is effectively 334 * indicating that the hardware is free to take over the display 335 * and manage it autonomously to implement low power always-on display 336 * functionality. */ 337 HWC_POWER_MODE_DOZE_SUSPEND = 3, 338 }; 339 340 /*****************************************************************************/ 341 342 __END_DECLS 343 344 #endif /* ANDROID_INCLUDE_HARDWARE_HWCOMPOSER_DEFS_H */ 345