hwcomposer.h revision ac3f7e195cadcf1f826340976a228fd5bbcdb807
15d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian/* 25d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * Copyright (C) 2010 The Android Open Source Project 35d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 45d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * Licensed under the Apache License, Version 2.0 (the "License"); 55d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * you may not use this file except in compliance with the License. 65d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * You may obtain a copy of the License at 75d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 85d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * http://www.apache.org/licenses/LICENSE-2.0 95d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 105d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * Unless required by applicable law or agreed to in writing, software 115d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * distributed under the License is distributed on an "AS IS" BASIS, 125d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 135d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * See the License for the specific language governing permissions and 145d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * limitations under the License. 155d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian */ 165d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 175d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian#ifndef ANDROID_INCLUDE_HARDWARE_HWCOMPOSER_H 185d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian#define ANDROID_INCLUDE_HARDWARE_HWCOMPOSER_H 195d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 205d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian#include <stdint.h> 215d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian#include <sys/cdefs.h> 225d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 2345e2371cb954a8f8e0aee16d1ee8bec7eae9b897Louis Huemiller#include <hardware/gralloc.h> 245d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian#include <hardware/hardware.h> 255d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian#include <cutils/native_handle.h> 265d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 27e291f71e0a25ac9bb39fb754c599b710ab8f59d5Mathias Agopian#include <hardware/hwcomposer_defs.h> 28e291f71e0a25ac9bb39fb754c599b710ab8f59d5Mathias Agopian 295d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian__BEGIN_DECLS 305d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 315d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian/*****************************************************************************/ 32e99520400f228e45b1feff28eb4105b8e5599196Erik Gilling 33d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall/* for compatibility */ 34b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian#define HWC_MODULE_API_VERSION HWC_MODULE_API_VERSION_0_1 35b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian#define HWC_DEVICE_API_VERSION HWC_DEVICE_API_VERSION_0_1 3681c323dd54d5f0ea1e75ab392187608049b2326cMathias Agopian#define HWC_API_VERSION HWC_DEVICE_API_VERSION 37e99520400f228e45b1feff28eb4105b8e5599196Erik Gilling 38d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall/* Users of this header can define HWC_REMOVE_DEPRECATED_VERSIONS to test that 39d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * they still work with just the current version declared, before the 40d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * deprecated versions are actually removed. 41d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * 42d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * To find code that still depends on the old versions, set the #define to 1 43d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * here. Code that explicitly sets it to zero (rather than simply not defining 44d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * it) will still see the old versions. 45d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall */ 46d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall#if !defined(HWC_REMOVE_DEPRECATED_VERSIONS) 47d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall#define HWC_REMOVE_DEPRECATED_VERSIONS 0 48d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall#endif 49d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall 50d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall/*****************************************************************************/ 51d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall 525d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian/** 535d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * The id of this module 545d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian */ 555d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian#define HWC_HARDWARE_MODULE_ID "hwcomposer" 565d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 575d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian/** 585d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * Name of the sensors device to open 595d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian */ 605d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian#define HWC_HARDWARE_COMPOSER "composer" 615d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 62d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hallstruct hwc_composer_device_1; 63d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Halltypedef struct hwc_methods_1 { 64b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian 65b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian /* 66b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * eventControl(..., event, enabled) 67f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * Enables or disables h/w composer events for a display. 68b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * 69b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * eventControl can be called from any thread and takes effect 70b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * immediately. 71b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * 72b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * Supported events are: 73b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * HWC_EVENT_VSYNC 74b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * 75b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * returns -EINVAL if the "event" parameter is not one of the value above 76b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * or if the "enabled" parameter is not 0 or 1. 77b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian */ 78b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian int (*eventControl)( 79f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall struct hwc_composer_device_1* dev, int dpy, 80f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall int event, int enabled); 81b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian 8238fccf483b19a0dd2431cb8515e7a2cc5546b373Colin Cross /* 8338fccf483b19a0dd2431cb8515e7a2cc5546b373Colin Cross * blank(..., blank) 84f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * Blanks or unblanks a display's screen. 8538fccf483b19a0dd2431cb8515e7a2cc5546b373Colin Cross * 8638fccf483b19a0dd2431cb8515e7a2cc5546b373Colin Cross * Turns the screen off when blank is nonzero, on when blank is zero. 87ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * Multiple sequential calls with the same blank value must be supported. 8838fccf483b19a0dd2431cb8515e7a2cc5546b373Colin Cross * 8938fccf483b19a0dd2431cb8515e7a2cc5546b373Colin Cross * returns 0 on success, negative on error. 9038fccf483b19a0dd2431cb8515e7a2cc5546b373Colin Cross */ 91f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall int (*blank)(struct hwc_composer_device_1* dev, int dpy, int blank); 9238fccf483b19a0dd2431cb8515e7a2cc5546b373Colin Cross 93d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall} hwc_methods_1_t; 94b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian 955d3de309f44f6a72f2a46db792f3865088897039Mathias Agopiantypedef struct hwc_rect { 965d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian int left; 975d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian int top; 985d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian int right; 995d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian int bottom; 1005d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian} hwc_rect_t; 1015d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 1025d3de309f44f6a72f2a46db792f3865088897039Mathias Agopiantypedef struct hwc_region { 1035d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian size_t numRects; 1045d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian hwc_rect_t const* rects; 1055d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian} hwc_region_t; 1065d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 107eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopiantypedef struct hwc_color { 108eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian uint8_t r; 109eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian uint8_t g; 110eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian uint8_t b; 111eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian uint8_t a; 112eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian} hwc_color_t; 113eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian 114d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Halltypedef struct hwc_layer_1 { 1155d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian /* 116eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * initially set to HWC_FRAMEBUFFER or HWC_BACKGROUND. 117eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * HWC_FRAMEBUFFER 118eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * indicates the layer will be drawn into the framebuffer 119eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * using OpenGL ES. 120eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * The HWC can toggle this value to HWC_OVERLAY, to indicate 121eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * it will handle the layer. 122eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * 123eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * HWC_BACKGROUND 124eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * indicates this is a special "background" layer. The only valid 125eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * field is backgroundColor. HWC_BACKGROUND can only be used with 126eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * HWC_API_VERSION >= 0.2 127eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * The HWC can toggle this value to HWC_FRAMEBUFFER, to indicate 128eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * it CANNOT handle the background color 129eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * 1305d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian */ 1315d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian int32_t compositionType; 1325d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 1335d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian /* see hwc_layer_t::hints above */ 1345d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian uint32_t hints; 1355d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 1365d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian /* see hwc_layer_t::flags above */ 1375d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian uint32_t flags; 1385d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 139eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian union { 140eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian /* color of the background. hwc_color_t.a is ignored */ 141eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian hwc_color_t backgroundColor; 142eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian 143eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian struct { 144eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian /* handle of buffer to compose. This handle is guaranteed to have been 145eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * allocated from gralloc using the GRALLOC_USAGE_HW_COMPOSER usage flag. If 146eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * the layer's handle is unchanged across two consecutive prepare calls and 147eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * the HWC_GEOMETRY_CHANGED flag is not set for the second call then the 148eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * HWComposer implementation may assume that the contents of the buffer have 149eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * not changed. */ 150eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian buffer_handle_t handle; 151eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian 152eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian /* transformation to apply to the buffer during composition */ 153eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian uint32_t transform; 154eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian 155eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian /* blending to apply during composition */ 156eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian int32_t blending; 157eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian 158eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian /* area of the source to consider, the origin is the top-left corner of 159eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * the buffer */ 160eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian hwc_rect_t sourceCrop; 161eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian 162eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian /* where to composite the sourceCrop onto the display. The sourceCrop 163eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * is scaled using linear filtering to the displayFrame. The origin is the 164eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * top-left corner of the screen. 165eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian */ 166eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian hwc_rect_t displayFrame; 167eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian 168eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian /* visible region in screen space. The origin is the 169eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * top-left corner of the screen. 170eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * The visible region INCLUDES areas overlapped by a translucent layer. 171eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian */ 172eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian hwc_region_t visibleRegionScreen; 173d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall 174d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall /* Sync fence object that will be signaled when the buffer's 175d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * contents are available. May be -1 if the contents are already 176d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * available. This field is only valid during set(), and should be 177d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * ignored during prepare(). The set() call must not wait for the 178d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * fence to be signaled before returning, but the HWC must wait for 179d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * all buffers to be signaled before reading from them. 180d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * 181d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * The HWC takes ownership of the acquireFenceFd and is responsible 182d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * for closing it when no longer needed. 183d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall */ 184d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall int acquireFenceFd; 185d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall 186d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall /* During set() the HWC must set this field to a file descriptor for 187d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * a sync fence object that will signal after the HWC has finished 188d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * reading from the buffer. The field is ignored by prepare(). Each 189d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * layer should have a unique file descriptor, even if more than one 190d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * refer to the same underlying fence object; this allows each to be 191d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * closed independently. 192d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * 193d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * If buffer reads can complete at significantly different times, 194d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * then using independent fences is preferred. For example, if the 195d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * HWC handles some layers with a blit engine and others with 196d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * overlays, then the blit layers can be reused immediately after 197d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * the blit completes, but the overlay layers can't be reused until 198d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * a subsequent frame has been displayed. 199d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * 200d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * The HWC client taks ownership of the releaseFenceFd and is 201d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * responsible for closing it when no longer needed. 202d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall */ 203d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall int releaseFenceFd; 204eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian }; 205eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian }; 2065d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 207d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall /* Allow for expansion w/o breaking binary compatibility. 208d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * Pad layer to 96 bytes, assuming 32-bit pointers. 209d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall */ 210d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall int32_t reserved[24 - 18]; 211d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall 212d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall} hwc_layer_1_t; 2135d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 214f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall/* This represents a display, typically an EGLDisplay object */ 215f9d6cd7dee62789b220033c926c87deab8991bdeJesse Halltypedef void* hwc_display_t; 216f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall 217f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall/* This represents a surface, typically an EGLSurface object */ 218f9d6cd7dee62789b220033c926c87deab8991bdeJesse Halltypedef void* hwc_surface_t; 219f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall 2205d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian/* 221f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * hwc_display_contents_1_t::flags values 2225d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian */ 2235d3de309f44f6a72f2a46db792f3865088897039Mathias Agopianenum { 2245d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian /* 2255d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * HWC_GEOMETRY_CHANGED is set by SurfaceFlinger to indicate that the list 226d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * passed to (*prepare)() has changed by more than just the buffer handles 227d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall * and acquire fences. 2285d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian */ 2295d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian HWC_GEOMETRY_CHANGED = 0x00000001, 2305d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian}; 2315d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 232871815b5f144048b63a18ef764f82e89394899faLouis Huemiller/* 233f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * Description of the contents to output on a display. 234f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * 235f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * This is the top-level structure passed to the prepare and set calls to 236f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * negotiate and commit the composition of a display image. 237871815b5f144048b63a18ef764f82e89394899faLouis Huemiller */ 238f9d6cd7dee62789b220033c926c87deab8991bdeJesse Halltypedef struct hwc_display_contents_1 { 239f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall /* File descriptor referring to a Sync HAL fence object which will signal 240f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * when this display image is no longer visible, i.e. when the following 241f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * set() takes effect. The fence object is created and returned by the set 242f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * call; this field will be -1 on entry to prepare and set. SurfaceFlinger 243f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * will close the returned file descriptor. 244f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall */ 245f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall int flipFenceFd; 246f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall 247f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall /* (dpy, sur) is the target of SurfaceFlinger's OpenGL ES composition. 248f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * They aren't relevant to prepare. The set call should commit this surface 249f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * atomically to the display along with any overlay layers. 250f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall */ 251f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall hwc_display_t dpy; 252f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall hwc_surface_t sur; 253f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall 254f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall /* List of layers that will be composed on the display. The buffer handles 255ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * in the list will be unique. If numHwLayers is 0, all composition will be 256ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * performed by SurfaceFlinger. 257f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall */ 2585d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian uint32_t flags; 2595d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian size_t numHwLayers; 260d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall hwc_layer_1_t hwLayers[0]; 2615d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 262f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall} hwc_display_contents_1_t; 2635d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 264d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian/* see hwc_composer_device::registerProcs() 265d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * Any of the callbacks can be NULL, in which case the corresponding 266d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * functionality is not supported. 267d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian */ 268d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopiantypedef struct hwc_procs { 269d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian /* 270d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * (*invalidate)() triggers a screen refresh, in particular prepare and set 271d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * will be called shortly after this call is made. Note that there is 272d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * NO GUARANTEE that the screen refresh will happen after invalidate() 273d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * returns (in particular, it could happen before). 274d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * invalidate() is GUARANTEED TO NOT CALL BACK into the h/w composer HAL and 275d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * it is safe to call invalidate() from any of hwc_composer_device 276d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * hooks, unless noted otherwise. 277d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian */ 278d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian void (*invalidate)(struct hwc_procs* procs); 279b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian 280b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian /* 281b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * (*vsync)() is called by the h/w composer HAL when a vsync event is 282f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * received and HWC_EVENT_VSYNC is enabled on a display 283f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * (see: hwc_event_control). 284b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * 285f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * the "dpy" parameter indicates which display the vsync event is for. 2866b7adef0ef38f568099eab38d6865f402c92235bJamie Gennis * the "timestamp" parameter is the system monotonic clock timestamp in 2876b7adef0ef38f568099eab38d6865f402c92235bJamie Gennis * nanosecond of when the vsync event happened. 288b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * 289b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * vsync() is GUARANTEED TO NOT CALL BACK into the h/w composer HAL. 290b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * 291b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * It is expected that vsync() is called from a thread of at least 292eb67160b995a504dd70a8f29d228ec837341eb07Mathias Agopian * HAL_PRIORITY_URGENT_DISPLAY with as little latency as possible, 293b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * typically less than 0.5 ms. 294b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * 2956d3fec70d86fe8e8fb71b233d2de727fee3f6f3fMathias Agopian * It is a (silent) error to have HWC_EVENT_VSYNC enabled when calling 2966d3fec70d86fe8e8fb71b233d2de727fee3f6f3fMathias Agopian * hwc_composer_device.set(..., 0, 0, 0) (screen off). The implementation 2976d3fec70d86fe8e8fb71b233d2de727fee3f6f3fMathias Agopian * can either stop or continue to process VSYNC events, but must not 2986d3fec70d86fe8e8fb71b233d2de727fee3f6f3fMathias Agopian * crash or cause other problems. 299b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian */ 300f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall void (*vsync)(struct hwc_procs* procs, int dpy, int64_t timestamp); 301d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian} hwc_procs_t; 302d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian 303d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian 304d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian/*****************************************************************************/ 3055d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 3065d3de309f44f6a72f2a46db792f3865088897039Mathias Agopiantypedef struct hwc_module { 3075d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian struct hw_module_t common; 3085d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian} hwc_module_t; 3095d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 310d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Halltypedef struct hwc_composer_device_1 { 3115d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian struct hw_device_t common; 3125d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 3135d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian /* 3145d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * (*prepare)() is called for each frame before composition and is used by 3155d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * SurfaceFlinger to determine what composition steps the HWC can handle. 3165d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 3175d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * (*prepare)() can be called more than once, the last call prevails. 3185d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 319f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * The HWC responds by setting the compositionType field in each layer to 320f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * either HWC_FRAMEBUFFER or HWC_OVERLAY. In the former case, the 321f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * composition for the layer is handled by SurfaceFlinger with OpenGL ES, 322f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * in the later case, the HWC will have to handle the layer's composition. 3235d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 3245d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * (*prepare)() is called with HWC_GEOMETRY_CHANGED to indicate that the 3255d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * list's geometry has changed, that is, when more than just the buffer's 3265d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * handles have been updated. Typically this happens (but is not limited to) 3275d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * when a window is added, removed, resized or moved. 3285d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 329ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * The numDisplays parameter will always be greater than zero, displays 330ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * will be non-NULL, and the array entries will be non-NULL. 331ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * 3325d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * returns: 0 on success. An negative error code on error. If an error is 3335d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * returned, SurfaceFlinger will assume that none of the layer will be 3345d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * handled by the HWC. 3355d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian */ 336d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall int (*prepare)(struct hwc_composer_device_1 *dev, 337f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall size_t numDisplays, hwc_display_contents_1_t** displays); 3385d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 3395d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian /* 3405d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * (*set)() is used in place of eglSwapBuffers(), and assumes the same 3415d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * functionality, except it also commits the work list atomically with 3425d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * the actual eglSwapBuffers(). 3435d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 344f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * The layer lists are guaranteed to be the same as the ones returned from 345f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * the last call to (*prepare)(). 3465d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 347f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * When this call returns the caller assumes that the displays will be 348f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * updated in the near future with the content of their work lists, without 349f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * artifacts during the transition from the previous frame. 3505d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 351ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * A display with zero layers indicates that the entire composition has 352ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * been handled by SurfaceFlinger with OpenGL ES. In this case, (*set)() 353ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * behaves just like eglSwapBuffers(). 3545d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * 355ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * The numDisplays parameter will always be greater than zero, displays 356ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * will be non-NULL, and the array entries will be non-NULL. 35771212e3fca328630aba1ebfa1299a8719b80f476Mathias Agopian * 358fb410365ca67d36d4c81d7826712c6a05437612fMathias Agopian * IMPORTANT NOTE: there is an implicit layer containing opaque black 359f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * pixels behind all the layers in the list. It is the responsibility of 360f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * the hwcomposer module to make sure black pixels are output (or blended 361f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall * from). 362fb410365ca67d36d4c81d7826712c6a05437612fMathias Agopian * 3635d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * returns: 0 on success. An negative error code on error: 3645d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * HWC_EGL_ERROR: eglGetError() will provide the proper error code 3655d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian * Another code for non EGL errors. 3665d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian */ 367d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall int (*set)(struct hwc_composer_device_1 *dev, 368f9d6cd7dee62789b220033c926c87deab8991bdeJesse Hall size_t numDisplays, hwc_display_contents_1_t** displays); 369d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall 370158549c89405186d9ecaefd3811cfae3949056eeErik Gilling /* 371b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * This field is OPTIONAL and can be NULL. 372158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * 373d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * If non NULL it will be called by SurfaceFlinger on dumpsys 374158549c89405186d9ecaefd3811cfae3949056eeErik Gilling */ 375d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall void (*dump)(struct hwc_composer_device_1* dev, char *buff, int buff_len); 3765d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 377d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian /* 378b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * This field is OPTIONAL and can be NULL. 379d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * 380d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * (*registerProcs)() registers a set of callbacks the h/w composer HAL 381d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * can later use. It is FORBIDDEN to call any of the callbacks from 382d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * within registerProcs(). registerProcs() must save the hwc_procs_t pointer 383d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * which is needed when calling a registered callback. 384d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * Each call to registerProcs replaces the previous set of callbacks. 385d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * registerProcs is called with NULL to unregister all callbacks. 386d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * 387d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * Any of the callbacks can be NULL, in which case the corresponding 388d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian * functionality is not supported. 389d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian */ 390d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall void (*registerProcs)(struct hwc_composer_device_1* dev, 391d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian hwc_procs_t const* procs); 392d6afef62ff8ea1fde3a060ac5c5d887c7523b359Mathias Agopian 393eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian /* 394b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * This field is OPTIONAL and can be NULL. 395eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * 396eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * Used to retrieve information about the h/w composer 397eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * 398eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian * Returns 0 on success or -errno on error. 399eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian */ 400d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall int (*query)(struct hwc_composer_device_1* dev, int what, int* value); 401eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian 402b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian /* 403b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian * Reserved for future use. Must be NULL. 404b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian */ 405b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian void* reserved_proc[4]; 406eb8fb508148d809166a30783a14e186fda0e31c9Mathias Agopian 407b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian /* 408ac3f7e195cadcf1f826340976a228fd5bbcdb807Jesse Hall * This field is REQUIRED and must not be NULL. 409b08d45dff634673e6dc5901a65f4c04bfdabf76eMathias Agopian */ 410d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall hwc_methods_1_t const *methods; 4115d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 412d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall} hwc_composer_device_1_t; 4135d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 4145d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian/** convenience API for opening and closing a device */ 4155d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 416d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hallstatic inline int hwc_open_1(const struct hw_module_t* module, 417d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall hwc_composer_device_1_t** device) { 4185d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian return module->methods->open(module, 4195d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian HWC_HARDWARE_COMPOSER, (struct hw_device_t**)device); 4205d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian} 4215d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 422d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hallstatic inline int hwc_close_1(hwc_composer_device_1_t* device) { 4235d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian return device->common.close(&device->common); 4245d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian} 4255d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 4265d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian/*****************************************************************************/ 4275d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 428d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall#if !HWC_REMOVE_DEPRECATED_VERSIONS 429d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall#include <hardware/hwcomposer_v0.h> 430d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall#endif 431d479ad22a0254fa0b5358fe82fa404e3e96c631aJesse Hall 4325d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian__END_DECLS 4335d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian 4345d3de309f44f6a72f2a46db792f3865088897039Mathias Agopian#endif /* ANDROID_INCLUDE_HARDWARE_HWCOMPOSER_H */ 435