gralloc.h revision 158549c89405186d9ecaefd3811cfae3949056ee
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 21a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#include <cutils/native_handle.h> 22a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 23a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#include <hardware/hardware.h> 24a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 25a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#include <stdint.h> 26a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#include <sys/cdefs.h> 27a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#include <sys/types.h> 28a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 29a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian__BEGIN_DECLS 30a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 31e99520400f228e45b1feff28eb4105b8e5599196Erik Gilling#define GRALLOC_API_VERSION 1 32e99520400f228e45b1feff28eb4105b8e5599196Erik Gilling 33a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 34a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The id of this module 35a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 36a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_MODULE_ID "gralloc" 37a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 38a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 39a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Name of the graphics device to open 40a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 41a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 42a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_FB0 "fb0" 43a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_GPU0 "gpu0" 44a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 45a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianenum { 46a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never read in software */ 47988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian GRALLOC_USAGE_SW_READ_NEVER = 0x00000000, 48a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is rarely read in software */ 49a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_READ_RARELY = 0x00000002, 50a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is often read in software */ 51a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_READ_OFTEN = 0x00000003, 52a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software read values */ 53a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_READ_MASK = 0x0000000F, 54a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 55a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 56988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian GRALLOC_USAGE_SW_WRITE_NEVER = 0x00000000, 57a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 58a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_WRITE_RARELY = 0x00000020, 59a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 60a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_WRITE_OFTEN = 0x00000030, 61a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software write values */ 62a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_WRITE_MASK = 0x000000F0, 63a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 64a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used as an OpenGL ES texture */ 65a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_TEXTURE = 0x00000100, 66a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used as an OpenGL ES render target */ 67a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_RENDER = 0x00000200, 68a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used by the 2D hardware blitter */ 69aabb70292351f231bfd4daae8b73edb788eeba1aJamie Gennis GRALLOC_USAGE_HW_2D = 0x00000400, 70a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used with the framebuffer device */ 71a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_FB = 0x00001000, 72a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software usage bit-mask */ 73a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_MASK = 0x00001F00, 7495d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis 757edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis /* buffer should be displayed full-screen on an external display when 767edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis * possible 777edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis */ 787edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis GRALLOC_USAGE_EXTERNAL_DISP = 0x00002000, 797edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis 8095d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis /* implementation-specific private usage flags */ 8195d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_0 = 0x10000000, 8295d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_1 = 0x20000000, 8395d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_2 = 0x40000000, 8495d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_3 = 0x80000000, 8595d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis GRALLOC_USAGE_PRIVATE_MASK = 0xF0000000, 86a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian}; 87a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 88a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/*****************************************************************************/ 89a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 90a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopiantypedef const native_handle* buffer_handle_t; 91a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 92cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopianenum { 93cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian /* FIXME: this only exists to work-around some issues with 94cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian * the video and camera frameworks. don't implement unless 95cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian * you know what you're doing. 96cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian */ 97cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian GRALLOC_MODULE_PERFORM_CREATE_HANDLE_FROM_BUFFER = 0x080000001, 98cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian}; 99cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian 100a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 101a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 102a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * and the fields of this data structure must begin with hw_module_t 103a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * followed by module specific information. 104a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 1059d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopiantypedef struct gralloc_module_t { 106a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_module_t common; 107a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 108988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian /* 109988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*registerBuffer)() must be called before a buffer_handle_t that has not 110988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * been created with (*alloc_device_t::alloc)() can be used. 111988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 112988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This is intended to be used with buffer_handle_t's that have been 113988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * received in this process through IPC. 114988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 115988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This function checks that the handle is indeed a valid one and prepares 116988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * it for use with (*lock)() and (*unlock)(). 117988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 118988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * It is not necessary to call (*registerBuffer)() on a handle created 119988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * with (*alloc_device_t::alloc)(). 120a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 121988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * returns an error if this buffer_handle_t is not valid. 122a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 123988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int (*registerBuffer)(struct gralloc_module_t const* module, 124988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian buffer_handle_t handle); 125a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 126a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 127988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*unregisterBuffer)() is called once this handle is no longer needed in 128988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * this process. After this call, it is an error to call (*lock)(), 129988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*unlock)(), or (*registerBuffer)(). 130988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 131988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This function doesn't close or free the handle itself; this is done 132988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * by other means, usually through libcutils's native_handle_close() and 133988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * native_handle_free(). 134a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 135988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * It is an error to call (*unregisterBuffer)() on a buffer that wasn't 136988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * explicitly registered first. 137a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 138988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int (*unregisterBuffer)(struct gralloc_module_t const* module, 139988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian buffer_handle_t handle); 140a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 141a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 142a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The (*lock)() method is called before a buffer is accessed for the 143a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * specified usage. This call may block, for instance if the h/w needs 144a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * to finish rendering or if CPU caches need to be synchronized. 145a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 146988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * The caller promises to modify only pixels in the area specified 147988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * by (l,t,w,h). 148a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 149a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The content of the buffer outside of the specified area is NOT modified 150a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * by this call. 151988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 152988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * If usage specifies GRALLOC_USAGE_SW_*, vaddr is filled with the address 153988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * of the buffer in virtual memory. 154988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 155485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * THREADING CONSIDERATIONS: 156485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 157485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * It is legal for several different threads to lock a buffer from 158485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * read access, none of the threads are blocked. 159485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 160485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * However, locking a buffer simultaneously for write or read/write is 161485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * undefined, but: 162485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * - shall not result in termination of the process 163485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * - shall not block the caller 164485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * It is acceptable to return an error or to leave the buffer's content 165485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * into an indeterminate state. 166485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 167988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * If the buffer was created with a usage mask incompatible with the 168988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * requested usage flags here, -EINVAL is returned. 169a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 170a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 171a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 172a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*lock)(struct gralloc_module_t const* module, 173a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle, int usage, 174988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int l, int t, int w, int h, 175988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian void** vaddr); 176a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 177a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 178a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 179a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The (*unlock)() method must be called after all changes to the buffer 180a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * are completed. 181a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 182a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 183a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*unlock)(struct gralloc_module_t const* module, 184a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle); 185a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 186cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian 187cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian /* reserved for future use */ 188cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian int (*perform)(struct gralloc_module_t const* module, 189cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian int operation, ... ); 190cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian 1918255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian /* reserved for future use */ 192cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian void* reserved_proc[7]; 1939d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian} gralloc_module_t; 194a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 195a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/*****************************************************************************/ 196a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 197a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 198a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Every device data structure must begin with hw_device_t 199a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * followed by module specific public methods and attributes. 200a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 201a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 2029d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopiantypedef struct alloc_device_t { 203a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_device_t common; 204a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 205a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 206a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (*alloc)() Allocates a buffer in graphic memory with the requested 207a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * parameters and returns a buffer_handle_t and the stride in pixels to 208a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * allow the implementation to satisfy hardware constraints on the width 209a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * of a pixmap (eg: it may have to be multiple of 8 pixels). 210a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The CALLER TAKES OWNERSHIP of the buffer_handle_t. 211a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 212a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 213a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 214a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 215a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*alloc)(struct alloc_device_t* dev, 216a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int w, int h, int format, int usage, 217a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t* handle, int* stride); 218a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 219a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 220a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (*free)() Frees a previously allocated buffer. 221a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Behavior is undefined if the buffer is still mapped in any process, 222a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * but shall not result in termination of the program or security breaches 223a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (allowing a process to get access to another process' buffers). 224a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * THIS FUNCTION TAKES OWNERSHIP of the buffer_handle_t which becomes 225a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * invalid after the call. 226a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 227a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 228a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 229a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*free)(struct alloc_device_t* dev, 230a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle); 231a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 232158549c89405186d9ecaefd3811cfae3949056eeErik Gilling /* This hook is OPTIONAL. 233158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * 234158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * If non NULL it will be caused by SurfaceFlinger on dumpsys 235158549c89405186d9ecaefd3811cfae3949056eeErik Gilling */ 236158549c89405186d9ecaefd3811cfae3949056eeErik Gilling void (*dump)(struct alloc_device_t *dev, char *buff, int buff_len); 237158549c89405186d9ecaefd3811cfae3949056eeErik Gilling 238158549c89405186d9ecaefd3811cfae3949056eeErik Gilling void* reserved_proc[7]; 2399d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian} alloc_device_t; 240a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 241a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 2429d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopiantypedef struct framebuffer_device_t { 243a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_device_t common; 244a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 245a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* flags describing some attributes of the framebuffer */ 246a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const uint32_t flags; 247a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 248a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* dimensions of the framebuffer in pixels */ 249a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const uint32_t width; 250a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const uint32_t height; 251a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 252a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* frambuffer stride in pixels */ 253a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int stride; 254a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 255a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* framebuffer pixel format */ 256a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int format; 257a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 258a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* resolution of the framebuffer's display panel in pixel per inch*/ 259a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const float xdpi; 260a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const float ydpi; 261a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 262a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* framebuffer's display panel refresh rate in frames per second */ 263a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const float fps; 264a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 265a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* min swap interval supported by this framebuffer */ 266a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int minSwapInterval; 267a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 268a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* max swap interval supported by this framebuffer */ 269a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int maxSwapInterval; 270a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 271a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int reserved[8]; 272a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 273a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 274a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * requests a specific swap-interval (same definition than EGL) 275a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 276a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 277a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 278a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*setSwapInterval)(struct framebuffer_device_t* window, 279a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int interval); 280a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 281a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 282f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * This hook is OPTIONAL. 283f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 284f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * It is non NULL If the framebuffer driver supports "update-on-demand" 285f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * and the given rectangle is the area of the screen that gets 286f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * updated during (*post)(). 287f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 288f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * This is useful on devices that are able to DMA only a portion of 289f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * the screen to the display panel, upon demand -- as opposed to 290f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * constantly refreshing the panel 60 times per second, for instance. 291f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 2928255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian * Only the area defined by this rectangle is guaranteed to be valid, that 293f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * is, the driver is not allowed to post anything outside of this 294f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * rectangle. 295f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 296f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * The rectangle evaluated during (*post)() and specifies which area 297f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * of the buffer passed in (*post)() shall to be posted. 298a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 299a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * return -EINVAL if width or height <=0, or if left or top < 0 300a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 301a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*setUpdateRect)(struct framebuffer_device_t* window, 302a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int left, int top, int width, int height); 303a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 304a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 305a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Post <buffer> to the display (display it on the screen) 306a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The buffer must have been allocated with the 307a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * GRALLOC_USAGE_HW_FB usage flag. 308a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * buffer must be the same width and height as the display and must NOT 309a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * be locked. 310a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 311a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The buffer is shown during the next VSYNC. 312a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 313a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * If the same buffer is posted again (possibly after some other buffer), 314a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * post() will block until the the first post is completed. 315a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 316a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Internally, post() is expected to lock the buffer so that a 317a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * subsequent call to gralloc_module_t::(*lock)() with USAGE_RENDER or 318a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * USAGE_*_WRITE will block until it is safe; that is typically once this 319a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * buffer is shown and another buffer has been posted. 320a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 321a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 322a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 323a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*post)(struct framebuffer_device_t* dev, buffer_handle_t buffer); 324a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 3258255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian 3268255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian /* 3278255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian * The (*compositionComplete)() method must be called after the 3288255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian * compositor has finished issuing GL commands for client buffers. 3298255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian */ 3308255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian 3318255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian int (*compositionComplete)(struct framebuffer_device_t* dev); 3328255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian 333158549c89405186d9ecaefd3811cfae3949056eeErik Gilling /* 334158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * This hook is OPTIONAL. 335158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * 336158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * If non NULL it will be caused by SurfaceFlinger on dumpsys 337158549c89405186d9ecaefd3811cfae3949056eeErik Gilling */ 338158549c89405186d9ecaefd3811cfae3949056eeErik Gilling void (*dump)(struct framebuffer_device_t* dev, char *buff, int buff_len); 3398255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian 340158549c89405186d9ecaefd3811cfae3949056eeErik Gilling void* reserved_proc[7]; 3419d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian 3429d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian} framebuffer_device_t; 343a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 344a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 345a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** convenience API for opening and closing a supported device */ 346a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 347a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int gralloc_open(const struct hw_module_t* module, 348a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct alloc_device_t** device) { 349a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return module->methods->open(module, 350a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_HARDWARE_GPU0, (struct hw_device_t**)device); 351a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 352a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 353a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int gralloc_close(struct alloc_device_t* device) { 354a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return device->common.close(&device->common); 355a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 356a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 357a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 358a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int framebuffer_open(const struct hw_module_t* module, 359a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct framebuffer_device_t** device) { 360a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return module->methods->open(module, 361a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_HARDWARE_FB0, (struct hw_device_t**)device); 362a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 363a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 364a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int framebuffer_close(struct framebuffer_device_t* device) { 365a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return device->common.close(&device->common); 366a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 367a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 368a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 369a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian__END_DECLS 370a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 371a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#endif // ANDROID_ALLOC_INTERFACE_H 372