gralloc.h revision f5cf8f842a5736281098ef1f8f837ab688b35707
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 31a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 32a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The id of this module 33a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 34a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_MODULE_ID "gralloc" 35a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 36a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 37a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Name of the graphics device to open 38a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 39a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 40a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_FB0 "fb0" 41a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_GPU0 "gpu0" 42a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 43a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianenum { 44a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never read in software */ 45988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian GRALLOC_USAGE_SW_READ_NEVER = 0x00000000, 46a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is rarely read in software */ 47a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_READ_RARELY = 0x00000002, 48a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is often read in software */ 49a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_READ_OFTEN = 0x00000003, 50a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software read values */ 51a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_READ_MASK = 0x0000000F, 52a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 53a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 54988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian GRALLOC_USAGE_SW_WRITE_NEVER = 0x00000000, 55a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 56a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_WRITE_RARELY = 0x00000020, 57a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 58a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_WRITE_OFTEN = 0x00000030, 59a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software write values */ 60a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_SW_WRITE_MASK = 0x000000F0, 61a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 62a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used as an OpenGL ES texture */ 63a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_TEXTURE = 0x00000100, 64a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used as an OpenGL ES render target */ 65a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_RENDER = 0x00000200, 66a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used by the 2D hardware blitter */ 67a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_2D = 0x00000C00, 68a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used with the framebuffer device */ 69a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_FB = 0x00001000, 70a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software usage bit-mask */ 71a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_USAGE_HW_MASK = 0x00001F00, 72a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian}; 73a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 74a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/*****************************************************************************/ 75a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 76a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopiantypedef const native_handle* buffer_handle_t; 77a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 78a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 79a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 80a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * and the fields of this data structure must begin with hw_module_t 81a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * followed by module specific information. 82a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 83a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstruct gralloc_module_t { 84a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_module_t common; 85a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 86988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian 87988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian /* 88988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*registerBuffer)() must be called before a buffer_handle_t that has not 89988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * been created with (*alloc_device_t::alloc)() can be used. 90988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 91988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This is intended to be used with buffer_handle_t's that have been 92988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * received in this process through IPC. 93988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 94988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This function checks that the handle is indeed a valid one and prepares 95988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * it for use with (*lock)() and (*unlock)(). 96988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 97988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * It is not necessary to call (*registerBuffer)() on a handle created 98988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * with (*alloc_device_t::alloc)(). 99a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 100988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * returns an error if this buffer_handle_t is not valid. 101a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 102988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int (*registerBuffer)(struct gralloc_module_t const* module, 103988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian buffer_handle_t handle); 104a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 105a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 106988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*unregisterBuffer)() is called once this handle is no longer needed in 107988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * this process. After this call, it is an error to call (*lock)(), 108988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*unlock)(), or (*registerBuffer)(). 109988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 110988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This function doesn't close or free the handle itself; this is done 111988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * by other means, usually through libcutils's native_handle_close() and 112988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * native_handle_free(). 113a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 114988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * It is an error to call (*unregisterBuffer)() on a buffer that wasn't 115988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * explicitly registered first. 116a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 117988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int (*unregisterBuffer)(struct gralloc_module_t const* module, 118988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian buffer_handle_t handle); 119a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 120a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 121a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The (*lock)() method is called before a buffer is accessed for the 122a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * specified usage. This call may block, for instance if the h/w needs 123a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * to finish rendering or if CPU caches need to be synchronized. 124a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 125988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * The caller promises to modify only pixels in the area specified 126988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * by (l,t,w,h). 127a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 128a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The content of the buffer outside of the specified area is NOT modified 129a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * by this call. 130988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 131988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * If usage specifies GRALLOC_USAGE_SW_*, vaddr is filled with the address 132988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * of the buffer in virtual memory. 133988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 134485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * THREADING CONSIDERATIONS: 135485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 136485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * It is legal for several different threads to lock a buffer from 137485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * read access, none of the threads are blocked. 138485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 139485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * However, locking a buffer simultaneously for write or read/write is 140485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * undefined, but: 141485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * - shall not result in termination of the process 142485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * - shall not block the caller 143485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * It is acceptable to return an error or to leave the buffer's content 144485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * into an indeterminate state. 145485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 146988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * If the buffer was created with a usage mask incompatible with the 147988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * requested usage flags here, -EINVAL is returned. 148a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 149a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 150a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 151a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*lock)(struct gralloc_module_t const* module, 152a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle, int usage, 153988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int l, int t, int w, int h, 154988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian void** vaddr); 155a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 156a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 157a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 158a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The (*unlock)() method must be called after all changes to the buffer 159a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * are completed. 160a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 161a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 162a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*unlock)(struct gralloc_module_t const* module, 163a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle); 164a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 165a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian}; 166a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 167a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/*****************************************************************************/ 168a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 169a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 170a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Every device data structure must begin with hw_device_t 171a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * followed by module specific public methods and attributes. 172a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 173a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 174a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstruct alloc_device_t { 175a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_device_t common; 176a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 177a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 178a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (*alloc)() Allocates a buffer in graphic memory with the requested 179a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * parameters and returns a buffer_handle_t and the stride in pixels to 180a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * allow the implementation to satisfy hardware constraints on the width 181a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * of a pixmap (eg: it may have to be multiple of 8 pixels). 182a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The CALLER TAKES OWNERSHIP of the buffer_handle_t. 183a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 184a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 185a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 186a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 187a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*alloc)(struct alloc_device_t* dev, 188a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int w, int h, int format, int usage, 189a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t* handle, int* stride); 190a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 191a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 192a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (*free)() Frees a previously allocated buffer. 193a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Behavior is undefined if the buffer is still mapped in any process, 194a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * but shall not result in termination of the program or security breaches 195a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (allowing a process to get access to another process' buffers). 196a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * THIS FUNCTION TAKES OWNERSHIP of the buffer_handle_t which becomes 197a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * invalid after the call. 198a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 199a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 200a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 201a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*free)(struct alloc_device_t* dev, 202a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle); 203a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 204a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian}; 205a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 206a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 207a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstruct framebuffer_device_t { 208a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_device_t common; 209a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 210a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* flags describing some attributes of the framebuffer */ 211a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const uint32_t flags; 212a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 213a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* dimensions of the framebuffer in pixels */ 214a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const uint32_t width; 215a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const uint32_t height; 216a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 217a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* frambuffer stride in pixels */ 218a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int stride; 219a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 220a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* framebuffer pixel format */ 221a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int format; 222a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 223a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* resolution of the framebuffer's display panel in pixel per inch*/ 224a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const float xdpi; 225a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const float ydpi; 226a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 227a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* framebuffer's display panel refresh rate in frames per second */ 228a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const float fps; 229a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 230a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* min swap interval supported by this framebuffer */ 231a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int minSwapInterval; 232a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 233a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* max swap interval supported by this framebuffer */ 234a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian const int maxSwapInterval; 235a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 236a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int reserved[8]; 237a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 238a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 239a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * requests a specific swap-interval (same definition than EGL) 240a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 241a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 242a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 243a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*setSwapInterval)(struct framebuffer_device_t* window, 244a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int interval); 245a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 246a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 247f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * This hook is OPTIONAL. 248f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 249f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * It is non NULL If the framebuffer driver supports "update-on-demand" 250f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * and the given rectangle is the area of the screen that gets 251f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * updated during (*post)(). 252f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 253f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * This is useful on devices that are able to DMA only a portion of 254f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * the screen to the display panel, upon demand -- as opposed to 255f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * constantly refreshing the panel 60 times per second, for instance. 256f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 257f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * Only the area defined by this rectangle is guranteed to be valid, that 258f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * is, the driver is not allowed to post anything outside of this 259f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * rectangle. 260f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * 261f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * The rectangle evaluated during (*post)() and specifies which area 262f5cf8f842a5736281098ef1f8f837ab688b35707Mathias Agopian * of the buffer passed in (*post)() shall to be posted. 263a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 264a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * return -EINVAL if width or height <=0, or if left or top < 0 265a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 266a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*setUpdateRect)(struct framebuffer_device_t* window, 267a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int left, int top, int width, int height); 268a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 269a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 270a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Post <buffer> to the display (display it on the screen) 271a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The buffer must have been allocated with the 272a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * GRALLOC_USAGE_HW_FB usage flag. 273a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * buffer must be the same width and height as the display and must NOT 274a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * be locked. 275a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 276a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The buffer is shown during the next VSYNC. 277a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 278a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * If the same buffer is posted again (possibly after some other buffer), 279a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * post() will block until the the first post is completed. 280a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 281a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Internally, post() is expected to lock the buffer so that a 282a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * subsequent call to gralloc_module_t::(*lock)() with USAGE_RENDER or 283a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * USAGE_*_WRITE will block until it is safe; that is typically once this 284a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * buffer is shown and another buffer has been posted. 285a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 286a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 287a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 288a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*post)(struct framebuffer_device_t* dev, buffer_handle_t buffer); 289a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 290a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian void* reserved_proc[8]; 291a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian}; 292a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 293a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 294a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** convenience API for opening and closing a supported device */ 295a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 296a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int gralloc_open(const struct hw_module_t* module, 297a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct alloc_device_t** device) { 298a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return module->methods->open(module, 299a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_HARDWARE_GPU0, (struct hw_device_t**)device); 300a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 301a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 302a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int gralloc_close(struct alloc_device_t* device) { 303a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return device->common.close(&device->common); 304a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 305a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 306a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 307a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int framebuffer_open(const struct hw_module_t* module, 308a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct framebuffer_device_t** device) { 309a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return module->methods->open(module, 310a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_HARDWARE_FB0, (struct hw_device_t**)device); 311a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 312a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 313a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int framebuffer_close(struct framebuffer_device_t* device) { 314a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return device->common.close(&device->common); 315a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 316a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 317a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 318a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian__END_DECLS 319a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 320a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#endif // ANDROID_ALLOC_INTERFACE_H 321