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 /******************************************************************************* 108 * Beyond this point are things only used by HWC1, which should be ignored when 109 * implementing a HWC2 device 110 ******************************************************************************/ 111 112 enum { 113 /* hwc_composer_device_t::set failed in EGL */ 114 HWC_EGL_ERROR = -1 115 }; 116 117 /* 118 * hwc_layer_t::hints values 119 * Hints are set by the HAL and read by SurfaceFlinger 120 */ 121 enum { 122 /* 123 * HWC can set the HWC_HINT_TRIPLE_BUFFER hint to indicate to SurfaceFlinger 124 * that it should triple buffer this layer. Typically HWC does this when 125 * the layer will be unavailable for use for an extended period of time, 126 * e.g. if the display will be fetching data directly from the layer and 127 * the layer can not be modified until after the next set(). 128 */ 129 HWC_HINT_TRIPLE_BUFFER = 0x00000001, 130 131 /* 132 * HWC sets HWC_HINT_CLEAR_FB to tell SurfaceFlinger that it should clear the 133 * framebuffer with transparent pixels where this layer would be. 134 * SurfaceFlinger will only honor this flag when the layer has no blending 135 * 136 */ 137 HWC_HINT_CLEAR_FB = 0x00000002 138 }; 139 140 /* 141 * hwc_layer_t::flags values 142 * Flags are set by SurfaceFlinger and read by the HAL 143 */ 144 enum { 145 /* 146 * HWC_SKIP_LAYER is set by SurfaceFlinger to indicate that the HAL 147 * shall not consider this layer for composition as it will be handled 148 * by SurfaceFlinger (just as if compositionType was set to HWC_FRAMEBUFFER). 149 */ 150 HWC_SKIP_LAYER = 0x00000001, 151 152 /* 153 * HWC_IS_CURSOR_LAYER is set by surfaceflinger to indicate that this 154 * layer is being used as a cursor on this particular display, and that 155 * surfaceflinger can potentially perform asynchronous position updates for 156 * this layer. If a call to prepare() returns HWC_CURSOR_OVERLAY for the 157 * composition type of this layer, then the hwcomposer will allow async 158 * position updates to this layer via setCursorPositionAsync(). 159 */ 160 HWC_IS_CURSOR_LAYER = 0x00000002 161 }; 162 163 /* 164 * hwc_layer_t::compositionType values 165 */ 166 enum { 167 /* this layer is to be drawn into the framebuffer by SurfaceFlinger */ 168 HWC_FRAMEBUFFER = 0, 169 170 /* this layer will be handled in the HWC */ 171 HWC_OVERLAY = 1, 172 173 /* this is the background layer. it's used to set the background color. 174 * there is only a single background layer */ 175 HWC_BACKGROUND = 2, 176 177 /* this layer holds the result of compositing the HWC_FRAMEBUFFER layers. 178 * Added in HWC_DEVICE_API_VERSION_1_1. */ 179 HWC_FRAMEBUFFER_TARGET = 3, 180 181 /* this layer's contents are taken from a sideband buffer stream. 182 * Added in HWC_DEVICE_API_VERSION_1_4. */ 183 HWC_SIDEBAND = 4, 184 185 /* this layer's composition will be handled by hwcomposer by dedicated 186 cursor overlay hardware. hwcomposer will also all async position updates 187 of this layer outside of the normal prepare()/set() loop. Added in 188 HWC_DEVICE_API_VERSION_1_4. */ 189 HWC_CURSOR_OVERLAY = 5 190 }; 191 /* 192 * hwc_layer_t::blending values 193 */ 194 enum { 195 /* no blending */ 196 HWC_BLENDING_NONE = 0x0100, 197 198 /* ONE / ONE_MINUS_SRC_ALPHA */ 199 HWC_BLENDING_PREMULT = 0x0105, 200 201 /* SRC_ALPHA / ONE_MINUS_SRC_ALPHA */ 202 HWC_BLENDING_COVERAGE = 0x0405 203 }; 204 205 /* attributes queriable with query() */ 206 enum { 207 /* 208 * Must return 1 if the background layer is supported, 0 otherwise. 209 */ 210 HWC_BACKGROUND_LAYER_SUPPORTED = 0, 211 212 /* 213 * Returns the vsync period in nanoseconds. 214 * 215 * This query is not used for HWC_DEVICE_API_VERSION_1_1 and later. 216 * Instead, the per-display attribute HWC_DISPLAY_VSYNC_PERIOD is used. 217 */ 218 HWC_VSYNC_PERIOD = 1, 219 220 /* 221 * Availability: HWC_DEVICE_API_VERSION_1_1 222 * Returns a mask of supported display types. 223 */ 224 HWC_DISPLAY_TYPES_SUPPORTED = 2, 225 }; 226 227 /* display attributes returned by getDisplayAttributes() */ 228 enum { 229 /* Indicates the end of an attribute list */ 230 HWC_DISPLAY_NO_ATTRIBUTE = 0, 231 232 /* The vsync period in nanoseconds */ 233 HWC_DISPLAY_VSYNC_PERIOD = 1, 234 235 /* The number of pixels in the horizontal and vertical directions. */ 236 HWC_DISPLAY_WIDTH = 2, 237 HWC_DISPLAY_HEIGHT = 3, 238 239 /* The number of pixels per thousand inches of this configuration. 240 * 241 * Scaling DPI by 1000 allows it to be stored in an int without losing 242 * too much precision. 243 * 244 * If the DPI for a configuration is unavailable or the HWC implementation 245 * considers it unreliable, it should set these attributes to zero. 246 */ 247 HWC_DISPLAY_DPI_X = 4, 248 HWC_DISPLAY_DPI_Y = 5, 249 250 /* Indicates which of the vendor-defined color transforms is provided by 251 * this configuration. */ 252 HWC_DISPLAY_COLOR_TRANSFORM = 6, 253 }; 254 255 /* Allowed events for hwc_methods::eventControl() */ 256 enum { 257 HWC_EVENT_VSYNC = 0 258 }; 259 260 /* Display types and associated mask bits. */ 261 enum { 262 HWC_DISPLAY_PRIMARY = 0, 263 HWC_DISPLAY_EXTERNAL = 1, // HDMI, DP, etc. 264 HWC_DISPLAY_VIRTUAL = 2, 265 266 HWC_NUM_PHYSICAL_DISPLAY_TYPES = 2, 267 HWC_NUM_DISPLAY_TYPES = 3, 268 }; 269 270 enum { 271 HWC_DISPLAY_PRIMARY_BIT = 1 << HWC_DISPLAY_PRIMARY, 272 HWC_DISPLAY_EXTERNAL_BIT = 1 << HWC_DISPLAY_EXTERNAL, 273 HWC_DISPLAY_VIRTUAL_BIT = 1 << HWC_DISPLAY_VIRTUAL, 274 }; 275 276 /* Display power modes */ 277 enum { 278 /* The display is turned off (blanked). */ 279 HWC_POWER_MODE_OFF = 0, 280 /* The display is turned on and configured in a low power state 281 * that is suitable for presenting ambient information to the user, 282 * possibly with lower fidelity than normal but greater efficiency. */ 283 HWC_POWER_MODE_DOZE = 1, 284 /* The display is turned on normally. */ 285 HWC_POWER_MODE_NORMAL = 2, 286 /* The display is configured as in HWC_POWER_MODE_DOZE but may 287 * stop applying frame buffer updates from the graphics subsystem. 288 * This power mode is effectively a hint from the doze dream to 289 * tell the hardware that it is done drawing to the display for the 290 * time being and that the display should remain on in a low power 291 * state and continue showing its current contents indefinitely 292 * until the mode changes. 293 * 294 * This mode may also be used as a signal to enable hardware-based doze 295 * functionality. In this case, the doze dream is effectively 296 * indicating that the hardware is free to take over the display 297 * and manage it autonomously to implement low power always-on display 298 * functionality. */ 299 HWC_POWER_MODE_DOZE_SUSPEND = 3, 300 }; 301 302 /*****************************************************************************/ 303 304 __END_DECLS 305 306 #endif /* ANDROID_INCLUDE_HARDWARE_HWCOMPOSER_DEFS_H */ 307