gralloc.h revision 33c0fe022e166007547d9c7390e7e6dbba5122e7
1a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/* 2a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Copyright (C) 2008 The Android Open Source Project 3a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 4a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Licensed under the Apache License, Version 2.0 (the "License"); 5a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * you may not use this file except in compliance with the License. 6a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * You may obtain a copy of the License at 7a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 8a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * http://www.apache.org/licenses/LICENSE-2.0 9a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 10a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Unless required by applicable law or agreed to in writing, software 11a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * distributed under the License is distributed on an "AS IS" BASIS, 12a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * See the License for the specific language governing permissions and 14a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * limitations under the License. 15a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 16a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 17a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 18a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#ifndef ANDROID_GRALLOC_INTERFACE_H 19a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define ANDROID_GRALLOC_INTERFACE_H 20a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 2133c0fe022e166007547d9c7390e7e6dbba5122e7Iliyan Malchev#include <system/window.h> 22a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#include <hardware/hardware.h> 23a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 24a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#include <stdint.h> 25a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#include <sys/cdefs.h> 26a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#include <sys/types.h> 27a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 28a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian__BEGIN_DECLS 29a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 30e99520400f228e45b1feff28eb4105b8e5599196Erik Gilling#define GRALLOC_API_VERSION 1 31e99520400f228e45b1feff28eb4105b8e5599196Erik Gilling 32a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 33a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The id of this module 34a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 35a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_MODULE_ID "gralloc" 36a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 37a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 38a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Name of the graphics device to open 39a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 40a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 41a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_FB0 "fb0" 42a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_GPU0 "gpu0" 43a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 44a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianenum { 45a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never read in software */ 46988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian GRALLOC_USAGE_SW_READ_NEVER = 0x00000000, 47a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is rarely read in software */ 48a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_READ_RARELY = 0x00000002, 49a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is often read in software */ 50a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_READ_OFTEN = 0x00000003, 51a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software read values */ 52a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_READ_MASK = 0x0000000F, 53a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 54a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 55988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian GRALLOC_USAGE_SW_WRITE_NEVER = 0x00000000, 56a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 57a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_WRITE_RARELY = 0x00000020, 58a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 59a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_WRITE_OFTEN = 0x00000030, 60a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software write values */ 61a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_WRITE_MASK = 0x000000F0, 62a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 63a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used as an OpenGL ES texture */ 64a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_TEXTURE = 0x00000100, 65a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used as an OpenGL ES render target */ 66a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_RENDER = 0x00000200, 67a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used by the 2D hardware blitter */ 68aabb70292351f231bfd4daae8b73edb788eeba1aJamie Gennis GRALLOC_USAGE_HW_2D = 0x00000400, 69a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used with the framebuffer device */ 70a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_FB = 0x00001000, 71a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software usage bit-mask */ 72a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_MASK = 0x00001F00, 7395d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis 747edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis /* buffer should be displayed full-screen on an external display when 757edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis * possible 767edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis */ 777edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis GRALLOC_USAGE_EXTERNAL_DISP = 0x00002000, 787edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis 797cb277a5c26447df01196bb19650235603062e93Glenn Kasten /* Must have a hardware-protected path to external display sink for 807cb277a5c26447df01196bb19650235603062e93Glenn Kasten * this buffer. If a hardware-protected path is not available, then 817cb277a5c26447df01196bb19650235603062e93Glenn Kasten * either don't composite only this buffer (preferred) to the 827cb277a5c26447df01196bb19650235603062e93Glenn Kasten * external sink, or (less desirable) do not route the entire 837cb277a5c26447df01196bb19650235603062e93Glenn Kasten * composition to the external sink. 847cb277a5c26447df01196bb19650235603062e93Glenn Kasten */ 857cb277a5c26447df01196bb19650235603062e93Glenn Kasten GRALLOC_USAGE_PROTECTED = 0x00004000, 867cb277a5c26447df01196bb19650235603062e93Glenn Kasten 8795d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis /* implementation-specific private usage flags */ 8895d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_0 = 0x10000000, 8995d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_1 = 0x20000000, 9095d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_2 = 0x40000000, 9195d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_3 = 0x80000000, 9295d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_MASK = 0xF0000000, 93a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian}; 94a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 95a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/*****************************************************************************/ 96a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 97a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 98a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 99a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * and the fields of this data structure must begin with hw_module_t 100a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * followed by module specific information. 101a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 1029d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopiantypedef struct gralloc_module_t { 103a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_module_t common; 104a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 105988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian /* 106988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*registerBuffer)() must be called before a buffer_handle_t that has not 107988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * been created with (*alloc_device_t::alloc)() can be used. 108988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 109988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This is intended to be used with buffer_handle_t's that have been 110988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * received in this process through IPC. 111988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 112988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This function checks that the handle is indeed a valid one and prepares 113988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * it for use with (*lock)() and (*unlock)(). 114988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 115988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * It is not necessary to call (*registerBuffer)() on a handle created 116988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * with (*alloc_device_t::alloc)(). 117a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 118988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * returns an error if this buffer_handle_t is not valid. 119a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 120988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int (*registerBuffer)(struct gralloc_module_t const* module, 121988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian buffer_handle_t handle); 122a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 123a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 124988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*unregisterBuffer)() is called once this handle is no longer needed in 125988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * this process. After this call, it is an error to call (*lock)(), 126988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*unlock)(), or (*registerBuffer)(). 127988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 128988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This function doesn't close or free the handle itself; this is done 129988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * by other means, usually through libcutils's native_handle_close() and 130988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * native_handle_free(). 131a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 132988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * It is an error to call (*unregisterBuffer)() on a buffer that wasn't 133988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * explicitly registered first. 134a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 135988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int (*unregisterBuffer)(struct gralloc_module_t const* module, 136988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian buffer_handle_t handle); 137a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 138a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 139a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The (*lock)() method is called before a buffer is accessed for the 140a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * specified usage. This call may block, for instance if the h/w needs 141a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * to finish rendering or if CPU caches need to be synchronized. 142a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 143988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * The caller promises to modify only pixels in the area specified 144988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * by (l,t,w,h). 145a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 146a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The content of the buffer outside of the specified area is NOT modified 147a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * by this call. 148988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 149988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * If usage specifies GRALLOC_USAGE_SW_*, vaddr is filled with the address 150988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * of the buffer in virtual memory. 151988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 152485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * THREADING CONSIDERATIONS: 153485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 154485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * It is legal for several different threads to lock a buffer from 155485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * read access, none of the threads are blocked. 156485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 157485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * However, locking a buffer simultaneously for write or read/write is 158485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * undefined, but: 159485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * - shall not result in termination of the process 160485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * - shall not block the caller 161485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * It is acceptable to return an error or to leave the buffer's content 162485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * into an indeterminate state. 163485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 164988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * If the buffer was created with a usage mask incompatible with the 165988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * requested usage flags here, -EINVAL is returned. 166a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 167a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 168a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 169a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*lock)(struct gralloc_module_t const* module, 170a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle, int usage, 171988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int l, int t, int w, int h, 172988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian void** vaddr); 173a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 174a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 175a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 176a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The (*unlock)() method must be called after all changes to the buffer 177a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * are completed. 178a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 179a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 180a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*unlock)(struct gralloc_module_t const* module, 181a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle); 182a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 183cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian 184cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian /* reserved for future use */ 185cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian int (*perform)(struct gralloc_module_t const* module, 186cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian int operation, ... ); 187cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian 1888255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian /* reserved for future use */ 189cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian void* reserved_proc[7]; 1909d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian} gralloc_module_t; 191a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 192a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/*****************************************************************************/ 193a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 194a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 195a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Every device data structure must begin with hw_device_t 196a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * followed by module specific public methods and attributes. 197a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 198a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 1999d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopiantypedef struct alloc_device_t { 200a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_device_t common; 201a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 202a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 203a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (*alloc)() Allocates a buffer in graphic memory with the requested 204a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * parameters and returns a buffer_handle_t and the stride in pixels to 205a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * allow the implementation to satisfy hardware constraints on the width 206a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * of a pixmap (eg: it may have to be multiple of 8 pixels). 207a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The CALLER TAKES OWNERSHIP of the buffer_handle_t. 208a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 209a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 210a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 211a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 212a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*alloc)(struct alloc_device_t* dev, 213a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int w, int h, int format, int usage, 214a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t* handle, int* stride); 215a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 216a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 217a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (*free)() Frees a previously allocated buffer. 218a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Behavior is undefined if the buffer is still mapped in any process, 219a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * but shall not result in termination of the program or security breaches 220a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (allowing a process to get access to another process' buffers). 221a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * THIS FUNCTION TAKES OWNERSHIP of the buffer_handle_t which becomes 222a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * invalid after the call. 223a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 224a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 225a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 226a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*free)(struct alloc_device_t* dev, 227a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle); 228a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 229158549c89405186d9ecaefd3811cfae3949056eeErik Gilling /* This hook is OPTIONAL. 230158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * 231158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * If non NULL it will be caused by SurfaceFlinger on dumpsys 232158549c89405186d9ecaefd3811cfae3949056eeErik Gilling */ 233158549c89405186d9ecaefd3811cfae3949056eeErik Gilling void (*dump)(struct alloc_device_t *dev, char *buff, int buff_len); 234158549c89405186d9ecaefd3811cfae3949056eeErik Gilling 235158549c89405186d9ecaefd3811cfae3949056eeErik Gilling void* reserved_proc[7]; 2369d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian} alloc_device_t; 237a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 238a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 2399d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopiantypedef struct framebuffer_device_t { 240a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_device_t common; 241a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 242a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* flags describing some attributes of the framebuffer */ 243a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const uint32_t flags; 244a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 245a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* dimensions of the framebuffer in pixels */ 246a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const uint32_t width; 247a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const uint32_t height; 248a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 249a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* frambuffer stride in pixels */ 250a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int stride; 251a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 252a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* framebuffer pixel format */ 253a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int format; 254a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 255a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* resolution of the framebuffer's display panel in pixel per inch*/ 256a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const float xdpi; 257a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const float ydpi; 258a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 259a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* framebuffer's display panel refresh rate in frames per second */ 260a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const float fps; 261a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 262a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* min swap interval supported by this framebuffer */ 263a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int minSwapInterval; 264a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 265a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* max swap interval supported by this framebuffer */ 266a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int maxSwapInterval; 267a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 268a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int reserved[8]; 269a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 270a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 271a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * requests a specific swap-interval (same definition than EGL) 272a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 273a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 274a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 275a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*setSwapInterval)(struct framebuffer_device_t* window, 276a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int interval); 277a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 278a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 279f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * This hook is OPTIONAL. 280f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 281f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * It is non NULL If the framebuffer driver supports "update-on-demand" 282f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * and the given rectangle is the area of the screen that gets 283f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * updated during (*post)(). 284f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 285f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * This is useful on devices that are able to DMA only a portion of 286f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * the screen to the display panel, upon demand -- as opposed to 287f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * constantly refreshing the panel 60 times per second, for instance. 288f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 2898255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian * Only the area defined by this rectangle is guaranteed to be valid, that 290f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * is, the driver is not allowed to post anything outside of this 291f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * rectangle. 292f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 293f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * The rectangle evaluated during (*post)() and specifies which area 294f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * of the buffer passed in (*post)() shall to be posted. 295a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 296a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * return -EINVAL if width or height <=0, or if left or top < 0 297a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 298a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*setUpdateRect)(struct framebuffer_device_t* window, 299a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int left, int top, int width, int height); 300a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 301a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 302a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Post <buffer> to the display (display it on the screen) 303a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The buffer must have been allocated with the 304a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * GRALLOC_USAGE_HW_FB usage flag. 305a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * buffer must be the same width and height as the display and must NOT 306a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * be locked. 307a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 308a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The buffer is shown during the next VSYNC. 309a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 310a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * If the same buffer is posted again (possibly after some other buffer), 311a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * post() will block until the the first post is completed. 312a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 313a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Internally, post() is expected to lock the buffer so that a 314a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * subsequent call to gralloc_module_t::(*lock)() with USAGE_RENDER or 315a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * USAGE_*_WRITE will block until it is safe; that is typically once this 316a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * buffer is shown and another buffer has been posted. 317a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 318a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 319a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 320a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*post)(struct framebuffer_device_t* dev, buffer_handle_t buffer); 321a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 3228255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian 3238255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian /* 3248255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian * The (*compositionComplete)() method must be called after the 3258255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian * compositor has finished issuing GL commands for client buffers. 3268255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian */ 3278255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian 3288255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian int (*compositionComplete)(struct framebuffer_device_t* dev); 3298255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian 330158549c89405186d9ecaefd3811cfae3949056eeErik Gilling /* 331158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * This hook is OPTIONAL. 332158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * 333158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * If non NULL it will be caused by SurfaceFlinger on dumpsys 334158549c89405186d9ecaefd3811cfae3949056eeErik Gilling */ 335158549c89405186d9ecaefd3811cfae3949056eeErik Gilling void (*dump)(struct framebuffer_device_t* dev, char *buff, int buff_len); 3368255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian 33797c7c40b73329ee86ce2abe5c320dd82d117ea14Mathias Agopian /* 33897c7c40b73329ee86ce2abe5c320dd82d117ea14Mathias Agopian * (*enableScreen)() is used to either blank (enable=0) or 33997c7c40b73329ee86ce2abe5c320dd82d117ea14Mathias Agopian * unblank (enable=1) the screen this framebuffer is attached to. 34097c7c40b73329ee86ce2abe5c320dd82d117ea14Mathias Agopian * 34197c7c40b73329ee86ce2abe5c320dd82d117ea14Mathias Agopian * Returns 0 on success or -errno on error. 34297c7c40b73329ee86ce2abe5c320dd82d117ea14Mathias Agopian */ 34397c7c40b73329ee86ce2abe5c320dd82d117ea14Mathias Agopian int (*enableScreen)(struct framebuffer_device_t* dev, int enable); 34497c7c40b73329ee86ce2abe5c320dd82d117ea14Mathias Agopian 34597c7c40b73329ee86ce2abe5c320dd82d117ea14Mathias Agopian void* reserved_proc[6]; 3469d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian 3479d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian} framebuffer_device_t; 348a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 349a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 350a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** convenience API for opening and closing a supported device */ 351a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 352a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int gralloc_open(const struct hw_module_t* module, 353a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct alloc_device_t** device) { 354a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return module->methods->open(module, 355a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_HARDWARE_GPU0, (struct hw_device_t**)device); 356a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 357a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 358a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int gralloc_close(struct alloc_device_t* device) { 359a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return device->common.close(&device->common); 360a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 361a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 362a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 363a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int framebuffer_open(const struct hw_module_t* module, 364a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct framebuffer_device_t** device) { 365a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return module->methods->open(module, 366a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_HARDWARE_FB0, (struct hw_device_t**)device); 367a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 368a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 369a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int framebuffer_close(struct framebuffer_device_t* device) { 370a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return device->common.close(&device->common); 371a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 372a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 373a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 374a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian__END_DECLS 375a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 376a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#endif // ANDROID_ALLOC_INTERFACE_H 377