hwcomposer.h revision 705d2912b70ae0dc8d035d475cf75f64c1a4c4b6
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_H 18#define ANDROID_INCLUDE_HARDWARE_HWCOMPOSER_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#include <hardware/hwcomposer_defs.h> 28 29__BEGIN_DECLS 30 31/*****************************************************************************/ 32 33/* for compatibility */ 34#define HWC_MODULE_API_VERSION HWC_MODULE_API_VERSION_0_1 35#define HWC_DEVICE_API_VERSION HWC_DEVICE_API_VERSION_0_1 36#define HWC_API_VERSION HWC_DEVICE_API_VERSION 37 38/* Users of this header can define HWC_REMOVE_DEPRECATED_VERSIONS to test that 39 * they still work with just the current version declared, before the 40 * deprecated versions are actually removed. 41 * 42 * To find code that still depends on the old versions, set the #define to 1 43 * here. Code that explicitly sets it to zero (rather than simply not defining 44 * it) will still see the old versions. 45 */ 46#if !defined(HWC_REMOVE_DEPRECATED_VERSIONS) 47#define HWC_REMOVE_DEPRECATED_VERSIONS 0 48#endif 49 50/*****************************************************************************/ 51 52/** 53 * The id of this module 54 */ 55#define HWC_HARDWARE_MODULE_ID "hwcomposer" 56 57/** 58 * Name of the sensors device to open 59 */ 60#define HWC_HARDWARE_COMPOSER "composer" 61 62struct hwc_composer_device_1; 63typedef struct hwc_methods_1 { 64 65 /* 66 * eventControl(..., event, enabled) 67 * Enables or disables h/w composer events for a display. 68 * 69 * eventControl can be called from any thread and takes effect 70 * immediately. 71 * 72 * Supported events are: 73 * HWC_EVENT_VSYNC 74 * 75 * returns -EINVAL if the "event" parameter is not one of the value above 76 * or if the "enabled" parameter is not 0 or 1. 77 */ 78 int (*eventControl)( 79 struct hwc_composer_device_1* dev, int dpy, 80 int event, int enabled); 81 82 /* 83 * blank(..., blank) 84 * Blanks or unblanks a display's screen. 85 * 86 * Turns the screen off when blank is nonzero, on when blank is zero. 87 * Multiple sequential calls with the same blank value must be supported. 88 * The screen state transition must be be complete when the function 89 * returns. 90 * 91 * returns 0 on success, negative on error. 92 */ 93 int (*blank)(struct hwc_composer_device_1* dev, int dpy, int blank); 94 95} hwc_methods_1_t; 96 97typedef struct hwc_rect { 98 int left; 99 int top; 100 int right; 101 int bottom; 102} hwc_rect_t; 103 104typedef struct hwc_region { 105 size_t numRects; 106 hwc_rect_t const* rects; 107} hwc_region_t; 108 109typedef struct hwc_color { 110 uint8_t r; 111 uint8_t g; 112 uint8_t b; 113 uint8_t a; 114} hwc_color_t; 115 116typedef struct hwc_layer_1 { 117 /* 118 * initially set to HWC_FRAMEBUFFER or HWC_BACKGROUND. 119 * HWC_FRAMEBUFFER 120 * indicates the layer will be drawn into the framebuffer 121 * using OpenGL ES. 122 * The HWC can toggle this value to HWC_OVERLAY, to indicate 123 * it will handle the layer. 124 * 125 * HWC_BACKGROUND 126 * indicates this is a special "background" layer. The only valid 127 * field is backgroundColor. HWC_BACKGROUND can only be used with 128 * HWC_API_VERSION >= 0.2 129 * The HWC can toggle this value to HWC_FRAMEBUFFER, to indicate 130 * it CANNOT handle the background color 131 * 132 */ 133 int32_t compositionType; 134 135 /* see hwc_layer_t::hints above */ 136 uint32_t hints; 137 138 /* see hwc_layer_t::flags above */ 139 uint32_t flags; 140 141 union { 142 /* color of the background. hwc_color_t.a is ignored */ 143 hwc_color_t backgroundColor; 144 145 struct { 146 /* handle of buffer to compose. This handle is guaranteed to have been 147 * allocated from gralloc using the GRALLOC_USAGE_HW_COMPOSER usage flag. If 148 * the layer's handle is unchanged across two consecutive prepare calls and 149 * the HWC_GEOMETRY_CHANGED flag is not set for the second call then the 150 * HWComposer implementation may assume that the contents of the buffer have 151 * not changed. */ 152 buffer_handle_t handle; 153 154 /* transformation to apply to the buffer during composition */ 155 uint32_t transform; 156 157 /* blending to apply during composition */ 158 int32_t blending; 159 160 /* area of the source to consider, the origin is the top-left corner of 161 * the buffer */ 162 hwc_rect_t sourceCrop; 163 164 /* where to composite the sourceCrop onto the display. The sourceCrop 165 * is scaled using linear filtering to the displayFrame. The origin is the 166 * top-left corner of the screen. 167 */ 168 hwc_rect_t displayFrame; 169 170 /* visible region in screen space. The origin is the 171 * top-left corner of the screen. 172 * The visible region INCLUDES areas overlapped by a translucent layer. 173 */ 174 hwc_region_t visibleRegionScreen; 175 176 /* Sync fence object that will be signaled when the buffer's 177 * contents are available. May be -1 if the contents are already 178 * available. This field is only valid during set(), and should be 179 * ignored during prepare(). The set() call must not wait for the 180 * fence to be signaled before returning, but the HWC must wait for 181 * all buffers to be signaled before reading from them. 182 * 183 * The HWC takes ownership of the acquireFenceFd and is responsible 184 * for closing it when no longer needed. 185 */ 186 int acquireFenceFd; 187 188 /* During set() the HWC must set this field to a file descriptor for 189 * a sync fence object that will signal after the HWC has finished 190 * reading from the buffer. The field is ignored by prepare(). Each 191 * layer should have a unique file descriptor, even if more than one 192 * refer to the same underlying fence object; this allows each to be 193 * closed independently. 194 * 195 * If buffer reads can complete at significantly different times, 196 * then using independent fences is preferred. For example, if the 197 * HWC handles some layers with a blit engine and others with 198 * overlays, then the blit layers can be reused immediately after 199 * the blit completes, but the overlay layers can't be reused until 200 * a subsequent frame has been displayed. 201 * 202 * The HWC client taks ownership of the releaseFenceFd and is 203 * responsible for closing it when no longer needed. 204 */ 205 int releaseFenceFd; 206 }; 207 }; 208 209 /* Allow for expansion w/o breaking binary compatibility. 210 * Pad layer to 96 bytes, assuming 32-bit pointers. 211 */ 212 int32_t reserved[24 - 18]; 213 214} hwc_layer_1_t; 215 216/* This represents a display, typically an EGLDisplay object */ 217typedef void* hwc_display_t; 218 219/* This represents a surface, typically an EGLSurface object */ 220typedef void* hwc_surface_t; 221 222/* 223 * hwc_display_contents_1_t::flags values 224 */ 225enum { 226 /* 227 * HWC_GEOMETRY_CHANGED is set by SurfaceFlinger to indicate that the list 228 * passed to (*prepare)() has changed by more than just the buffer handles 229 * and acquire fences. 230 */ 231 HWC_GEOMETRY_CHANGED = 0x00000001, 232}; 233 234/* 235 * Description of the contents to output on a display. 236 * 237 * This is the top-level structure passed to the prepare and set calls to 238 * negotiate and commit the composition of a display image. 239 */ 240typedef struct hwc_display_contents_1 { 241 /* File descriptor referring to a Sync HAL fence object which will signal 242 * when this display image is no longer visible, i.e. when the following 243 * set() takes effect. The fence object is created and returned by the set 244 * call; this field will be -1 on entry to prepare and set. SurfaceFlinger 245 * will close the returned file descriptor. 246 */ 247 int flipFenceFd; 248 249 /* (dpy, sur) is the target of SurfaceFlinger's OpenGL ES composition. 250 * They aren't relevant to prepare. The set call should commit this surface 251 * atomically to the display along with any overlay layers. 252 */ 253 hwc_display_t dpy; 254 hwc_surface_t sur; 255 256 /* List of layers that will be composed on the display. The buffer handles 257 * in the list will be unique. If numHwLayers is 0, all composition will be 258 * performed by SurfaceFlinger. 259 */ 260 uint32_t flags; 261 size_t numHwLayers; 262 hwc_layer_1_t hwLayers[0]; 263 264} hwc_display_contents_1_t; 265 266/* see hwc_composer_device::registerProcs() 267 * Any of the callbacks can be NULL, in which case the corresponding 268 * functionality is not supported. 269 */ 270typedef struct hwc_procs { 271 /* 272 * (*invalidate)() triggers a screen refresh, in particular prepare and set 273 * will be called shortly after this call is made. Note that there is 274 * NO GUARANTEE that the screen refresh will happen after invalidate() 275 * returns (in particular, it could happen before). 276 * invalidate() is GUARANTEED TO NOT CALL BACK into the h/w composer HAL and 277 * it is safe to call invalidate() from any of hwc_composer_device 278 * hooks, unless noted otherwise. 279 */ 280 void (*invalidate)(struct hwc_procs* procs); 281 282 /* 283 * (*vsync)() is called by the h/w composer HAL when a vsync event is 284 * received and HWC_EVENT_VSYNC is enabled on a display 285 * (see: hwc_event_control). 286 * 287 * the "dpy" parameter indicates which display the vsync event is for. 288 * the "timestamp" parameter is the system monotonic clock timestamp in 289 * nanosecond of when the vsync event happened. 290 * 291 * vsync() is GUARANTEED TO NOT CALL BACK into the h/w composer HAL. 292 * 293 * It is expected that vsync() is called from a thread of at least 294 * HAL_PRIORITY_URGENT_DISPLAY with as little latency as possible, 295 * typically less than 0.5 ms. 296 * 297 * It is a (silent) error to have HWC_EVENT_VSYNC enabled when calling 298 * hwc_composer_device.set(..., 0, 0, 0) (screen off). The implementation 299 * can either stop or continue to process VSYNC events, but must not 300 * crash or cause other problems. 301 */ 302 void (*vsync)(struct hwc_procs* procs, int dpy, int64_t timestamp); 303} hwc_procs_t; 304 305 306/*****************************************************************************/ 307 308typedef struct hwc_module { 309 struct hw_module_t common; 310} hwc_module_t; 311 312typedef struct hwc_composer_device_1 { 313 struct hw_device_t common; 314 315 /* 316 * (*prepare)() is called for each frame before composition and is used by 317 * SurfaceFlinger to determine what composition steps the HWC can handle. 318 * 319 * (*prepare)() can be called more than once, the last call prevails. 320 * 321 * The HWC responds by setting the compositionType field in each layer to 322 * either HWC_FRAMEBUFFER or HWC_OVERLAY. In the former case, the 323 * composition for the layer is handled by SurfaceFlinger with OpenGL ES, 324 * in the later case, the HWC will have to handle the layer's composition. 325 * 326 * (*prepare)() is called with HWC_GEOMETRY_CHANGED to indicate that the 327 * list's geometry has changed, that is, when more than just the buffer's 328 * handles have been updated. Typically this happens (but is not limited to) 329 * when a window is added, removed, resized or moved. 330 * 331 * The numDisplays parameter will always be greater than zero, displays 332 * will be non-NULL, and the array entries will be non-NULL. 333 * 334 * returns: 0 on success. An negative error code on error. If an error is 335 * returned, SurfaceFlinger will assume that none of the layer will be 336 * handled by the HWC. 337 */ 338 int (*prepare)(struct hwc_composer_device_1 *dev, 339 size_t numDisplays, hwc_display_contents_1_t** displays); 340 341 /* 342 * (*set)() is used in place of eglSwapBuffers(), and assumes the same 343 * functionality, except it also commits the work list atomically with 344 * the actual eglSwapBuffers(). 345 * 346 * The layer lists are guaranteed to be the same as the ones returned from 347 * the last call to (*prepare)(). 348 * 349 * When this call returns the caller assumes that the displays will be 350 * updated in the near future with the content of their work lists, without 351 * artifacts during the transition from the previous frame. 352 * 353 * A display with zero layers indicates that the entire composition has 354 * been handled by SurfaceFlinger with OpenGL ES. In this case, (*set)() 355 * behaves just like eglSwapBuffers(). 356 * 357 * The numDisplays parameter will always be greater than zero, displays 358 * will be non-NULL, and the array entries will be non-NULL. 359 * 360 * IMPORTANT NOTE: there is an implicit layer containing opaque black 361 * pixels behind all the layers in the list. It is the responsibility of 362 * the hwcomposer module to make sure black pixels are output (or blended 363 * from). 364 * 365 * returns: 0 on success. An negative error code on error: 366 * HWC_EGL_ERROR: eglGetError() will provide the proper error code 367 * Another code for non EGL errors. 368 */ 369 int (*set)(struct hwc_composer_device_1 *dev, 370 size_t numDisplays, hwc_display_contents_1_t** displays); 371 372 /* 373 * This field is OPTIONAL and can be NULL. 374 * 375 * If non NULL it will be called by SurfaceFlinger on dumpsys 376 */ 377 void (*dump)(struct hwc_composer_device_1* dev, char *buff, int buff_len); 378 379 /* 380 * This field is OPTIONAL and can be NULL. 381 * 382 * (*registerProcs)() registers a set of callbacks the h/w composer HAL 383 * can later use. It is FORBIDDEN to call any of the callbacks from 384 * within registerProcs(). registerProcs() must save the hwc_procs_t pointer 385 * which is needed when calling a registered callback. 386 * Each call to registerProcs replaces the previous set of callbacks. 387 * registerProcs is called with NULL to unregister all callbacks. 388 * 389 * Any of the callbacks can be NULL, in which case the corresponding 390 * functionality is not supported. 391 */ 392 void (*registerProcs)(struct hwc_composer_device_1* dev, 393 hwc_procs_t const* procs); 394 395 /* 396 * This field is OPTIONAL and can be NULL. 397 * 398 * Used to retrieve information about the h/w composer 399 * 400 * Returns 0 on success or -errno on error. 401 */ 402 int (*query)(struct hwc_composer_device_1* dev, int what, int* value); 403 404 /* 405 * Reserved for future use. Must be NULL. 406 */ 407 void* reserved_proc[4]; 408 409 /* 410 * This field is REQUIRED and must not be NULL. 411 */ 412 hwc_methods_1_t const *methods; 413 414} hwc_composer_device_1_t; 415 416/** convenience API for opening and closing a device */ 417 418static inline int hwc_open_1(const struct hw_module_t* module, 419 hwc_composer_device_1_t** device) { 420 return module->methods->open(module, 421 HWC_HARDWARE_COMPOSER, (struct hw_device_t**)device); 422} 423 424static inline int hwc_close_1(hwc_composer_device_1_t* device) { 425 return device->common.close(&device->common); 426} 427 428/*****************************************************************************/ 429 430#if !HWC_REMOVE_DEPRECATED_VERSIONS 431#include <hardware/hwcomposer_v0.h> 432#endif 433 434__END_DECLS 435 436#endif /* ANDROID_INCLUDE_HARDWARE_HWCOMPOSER_H */ 437