gralloc.h revision 2e49f9acbb1039a8388b070332a5e2f35cd35343
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> 2206e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray#include <system/graphics.h> 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 295337b102898cfd48eda7215df15baaf3bc96521fMathias Agopian#include <cutils/native_handle.h> 305337b102898cfd48eda7215df15baaf3bc96521fMathias Agopian 315337b102898cfd48eda7215df15baaf3bc96521fMathias Agopian#include <hardware/hardware.h> 325337b102898cfd48eda7215df15baaf3bc96521fMathias Agopian#include <hardware/fb.h> 335337b102898cfd48eda7215df15baaf3bc96521fMathias Agopian 34a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian__BEGIN_DECLS 35a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 3606e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray/** 3706e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * Module versioning information for the Gralloc hardware module, based on 3806e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * gralloc_module_t.common.module_api_version. 3906e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * 4006e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * Version History: 4106e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * 4206e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * GRALLOC_MODULE_API_VERSION_0_1: 4306e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * Initial Gralloc hardware module API. 4406e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * 4506e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * GRALLOC_MODULE_API_VERSION_0_2: 4606e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * Add support for flexible YCbCr format with (*lock_ycbcr)() method. 472e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * 482e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * GRALLOC_MODULE_API_VERSION_0_3: 492e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * Add support for fence passing to/from lock/unlock. 5006e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray */ 5106e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray 5206e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray#define GRALLOC_MODULE_API_VERSION_0_1 HARDWARE_MODULE_API_VERSION(0, 1) 5306e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray#define GRALLOC_MODULE_API_VERSION_0_2 HARDWARE_MODULE_API_VERSION(0, 2) 542e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart#define GRALLOC_MODULE_API_VERSION_0_3 HARDWARE_MODULE_API_VERSION(0, 3) 5506e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray 5606e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray#define GRALLOC_DEVICE_API_VERSION_0_1 HARDWARE_DEVICE_API_VERSION(0, 1) 57e99520400f228e45b1feff28eb4105b8e5599196Erik Gilling 58a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 59a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The id of this module 60a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 61a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_MODULE_ID "gralloc" 62a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 63a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 64a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Name of the graphics device to open 65a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 66a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 67a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian#define GRALLOC_HARDWARE_GPU0 "gpu0" 68a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 69a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianenum { 70a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never read in software */ 7129ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_SW_READ_NEVER = 0x00000000, 72a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is rarely read in software */ 7329ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_SW_READ_RARELY = 0x00000002, 74a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is often read in software */ 7529ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_SW_READ_OFTEN = 0x00000003, 76a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software read values */ 7729ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_SW_READ_MASK = 0x0000000F, 78a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 79a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer is never written in software */ 8029ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_SW_WRITE_NEVER = 0x00000000, 81d6f7aad8de5d122d4189ecc608c749a63de4983dGreg Hackmann /* buffer is rarely written in software */ 8229ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_SW_WRITE_RARELY = 0x00000020, 83d6f7aad8de5d122d4189ecc608c749a63de4983dGreg Hackmann /* buffer is often written in software */ 8429ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_SW_WRITE_OFTEN = 0x00000030, 85a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software write values */ 8629ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_SW_WRITE_MASK = 0x000000F0, 87a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 88a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used as an OpenGL ES texture */ 8929ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_HW_TEXTURE = 0x00000100, 90a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used as an OpenGL ES render target */ 9129ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_HW_RENDER = 0x00000200, 92a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used by the 2D hardware blitter */ 9329ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_HW_2D = 0x00000400, 944b560d5563ee4699cd24938c2f13b4a416408273Jamie Gennis /* buffer will be used by the HWComposer HAL module */ 9529ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_HW_COMPOSER = 0x00000800, 96a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* buffer will be used with the framebuffer device */ 9729ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_HW_FB = 0x00001000, 9829ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis /* buffer will be used with the HW video encoder */ 9929ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_HW_VIDEO_ENCODER = 0x00010000, 1007797d75b12a90cd03a47642c59dbb677aa4daa88Eino-Ville Talvala /* buffer will be written by the HW camera pipeline */ 1017797d75b12a90cd03a47642c59dbb677aa4daa88Eino-Ville Talvala GRALLOC_USAGE_HW_CAMERA_WRITE = 0x00020000, 1027797d75b12a90cd03a47642c59dbb677aa4daa88Eino-Ville Talvala /* buffer will be read by the HW camera pipeline */ 1037797d75b12a90cd03a47642c59dbb677aa4daa88Eino-Ville Talvala GRALLOC_USAGE_HW_CAMERA_READ = 0x00040000, 1042388a2dc91979364d96e49456b189f904f0267f3Eino-Ville Talvala /* buffer will be used as part of zero-shutter-lag queue */ 1057f8dd0ad2d3d40b57c8359971a351fd194668613Eino-Ville Talvala GRALLOC_USAGE_HW_CAMERA_ZSL = 0x00060000, 1067f8dd0ad2d3d40b57c8359971a351fd194668613Eino-Ville Talvala /* mask for the camera access values */ 1077f8dd0ad2d3d40b57c8359971a351fd194668613Eino-Ville Talvala GRALLOC_USAGE_HW_CAMERA_MASK = 0x00060000, 108a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* mask for the software usage bit-mask */ 1097797d75b12a90cd03a47642c59dbb677aa4daa88Eino-Ville Talvala GRALLOC_USAGE_HW_MASK = 0x00071F00, 11095d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis 11122423852817b19245a2134653eef3f71a39cf42aJason Sams /* buffer will be used as a RenderScript Allocation */ 11222423852817b19245a2134653eef3f71a39cf42aJason Sams GRALLOC_USAGE_RENDERSCRIPT = 0x00100000, 11322423852817b19245a2134653eef3f71a39cf42aJason Sams 1147edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis /* buffer should be displayed full-screen on an external display when 1157edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis * possible 1167edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis */ 11729ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_EXTERNAL_DISP = 0x00002000, 1187edeaf91a8d066e6797f875451f8aa9e9a4682f6Jamie Gennis 1197cb277a5c26447df01196bb19650235603062e93Glenn Kasten /* Must have a hardware-protected path to external display sink for 1207cb277a5c26447df01196bb19650235603062e93Glenn Kasten * this buffer. If a hardware-protected path is not available, then 1217cb277a5c26447df01196bb19650235603062e93Glenn Kasten * either don't composite only this buffer (preferred) to the 1227cb277a5c26447df01196bb19650235603062e93Glenn Kasten * external sink, or (less desirable) do not route the entire 1237cb277a5c26447df01196bb19650235603062e93Glenn Kasten * composition to the external sink. 1247cb277a5c26447df01196bb19650235603062e93Glenn Kasten */ 12529ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_PROTECTED = 0x00004000, 1267cb277a5c26447df01196bb19650235603062e93Glenn Kasten 12795d78bef32edd183fb8c16b7775bf0a069948420Jamie Gennis /* implementation-specific private usage flags */ 12829ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_PRIVATE_0 = 0x10000000, 12929ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_PRIVATE_1 = 0x20000000, 13029ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_PRIVATE_2 = 0x40000000, 13129ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_PRIVATE_3 = 0x80000000, 13229ead941b377cb87bcc7fe48208b96d84d649d43Jamie Gennis GRALLOC_USAGE_PRIVATE_MASK = 0xF0000000, 133a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian}; 134a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 135a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/*****************************************************************************/ 136a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 137a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 138a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 139a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * and the fields of this data structure must begin with hw_module_t 140a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * followed by module specific information. 141a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 1429d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopiantypedef struct gralloc_module_t { 143a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_module_t common; 144a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 145988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian /* 146988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*registerBuffer)() must be called before a buffer_handle_t that has not 147988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * been created with (*alloc_device_t::alloc)() can be used. 148988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 149988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This is intended to be used with buffer_handle_t's that have been 150988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * received in this process through IPC. 151988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 152988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This function checks that the handle is indeed a valid one and prepares 153988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * it for use with (*lock)() and (*unlock)(). 154988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 155988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * It is not necessary to call (*registerBuffer)() on a handle created 156988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * with (*alloc_device_t::alloc)(). 157a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 158988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * returns an error if this buffer_handle_t is not valid. 159a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 160988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int (*registerBuffer)(struct gralloc_module_t const* module, 161988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian buffer_handle_t handle); 162a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 163a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 164988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*unregisterBuffer)() is called once this handle is no longer needed in 165988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * this process. After this call, it is an error to call (*lock)(), 166988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * (*unlock)(), or (*registerBuffer)(). 167988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 168988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * This function doesn't close or free the handle itself; this is done 169988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * by other means, usually through libcutils's native_handle_close() and 170988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * native_handle_free(). 171a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 172988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * It is an error to call (*unregisterBuffer)() on a buffer that wasn't 173988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * explicitly registered first. 174a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 175988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int (*unregisterBuffer)(struct gralloc_module_t const* module, 176988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian buffer_handle_t handle); 177a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 178a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 179a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The (*lock)() method is called before a buffer is accessed for the 180a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * specified usage. This call may block, for instance if the h/w needs 181a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * to finish rendering or if CPU caches need to be synchronized. 182a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 183988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * The caller promises to modify only pixels in the area specified 184988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * by (l,t,w,h). 185a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 186a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The content of the buffer outside of the specified area is NOT modified 187a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * by this call. 188988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 189988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * If usage specifies GRALLOC_USAGE_SW_*, vaddr is filled with the address 190988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * of the buffer in virtual memory. 191988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * 19206e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * Note calling (*lock)() on HAL_PIXEL_FORMAT_YCbCr_*_888 buffers will fail 19306e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * and return -EINVAL. These buffers must be locked with (*lock_ycbcr)() 19406e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * instead. 19506e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * 196485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * THREADING CONSIDERATIONS: 197485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 198485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * It is legal for several different threads to lock a buffer from 199485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * read access, none of the threads are blocked. 200485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 201485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * However, locking a buffer simultaneously for write or read/write is 202485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * undefined, but: 203485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * - shall not result in termination of the process 204485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * - shall not block the caller 205485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * It is acceptable to return an error or to leave the buffer's content 206485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * into an indeterminate state. 207485e69809aef8bf301b6bf19c03dc2d7693aaa1aMathias Agopian * 208988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * If the buffer was created with a usage mask incompatible with the 209988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian * requested usage flags here, -EINVAL is returned. 210a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 211a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 212a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 213a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*lock)(struct gralloc_module_t const* module, 214a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle, int usage, 215988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian int l, int t, int w, int h, 216988b8bd553180e8d71b4028ecb721f46312efe62Mathias Agopian void** vaddr); 217a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 218a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 219a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 220a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The (*unlock)() method must be called after all changes to the buffer 221a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * are completed. 222a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 223a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 224a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*unlock)(struct gralloc_module_t const* module, 225a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle); 226a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 227cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian 228cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian /* reserved for future use */ 229cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian int (*perform)(struct gralloc_module_t const* module, 230cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian int operation, ... ); 231cd2433f3804a537aedc26f595b1c05f95a05244aMathias Agopian 23206e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray /* 23306e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * The (*lock_ycbcr)() method is like the (*lock)() method, with the 23406e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * difference that it fills a struct ycbcr with a description of the buffer 23506e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * layout, and zeroes out the reserved fields. 23606e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * 23706e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * This will only work on buffers with HAL_PIXEL_FORMAT_YCbCr_*_888, and 23806e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * will return -EINVAL on any other buffer formats. 23906e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * 24006e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray * Added in GRALLOC_MODULE_API_VERSION_0_2. 24106e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray */ 24206e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray 24306e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray int (*lock_ycbcr)(struct gralloc_module_t const* module, 24406e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray buffer_handle_t handle, int usage, 24506e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray int l, int t, int w, int h, 24606e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray struct android_ycbcr *ycbcr); 24706e3bf25660a25b417e7a2e146327b35bee5ba00Alex Ray 2482e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart /* 2492e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * The (*lockAsync)() method is like the (*lock)() method except 2502e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * that the buffer's sync fence object is passed into the lock 2512e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * call instead of requiring the caller to wait for completion. 2522e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * 2532e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * The gralloc implementation takes ownership of the fenceFd and 2542e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * is responsible for closing it when no longer needed. 2552e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * 2562e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * Added in GRALLOC_MODULE_API_VERSION_0_3. 2572e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart */ 2582e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart int (*lockAsync)(struct gralloc_module_t const* module, 2592e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart buffer_handle_t handle, int usage, 2602e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart int l, int t, int w, int h, 2612e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart void** vaddr, int fenceFd); 2622e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart 2632e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart /* 2642e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * The (*unlockAsync)() method is like the (*unlock)() method 2652e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * except that a buffer sync fence object is returned from the 2662e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * lock call, representing the completion of any pending work 2672e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * performed by the gralloc implementation. 2682e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * 2692e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * The caller takes ownership of the fenceFd and is responsible 2702e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * for closing it when no longer needed. 2712e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * 2722e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * Added in GRALLOC_MODULE_API_VERSION_0_3. 2732e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart */ 2742e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart int (*unlockAsync)(struct gralloc_module_t const* module, 2752e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart buffer_handle_t handle, int* fenceFd); 2762e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart 2772e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart /* 2782e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * The (*lockAsync_ycbcr)() method is like the (*lock_ycbcr)() 2792e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * method except that the buffer's sync fence object is passed 2802e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * into the lock call instead of requiring the caller to wait for 2812e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * completion. 2822e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * 2832e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * The gralloc implementation takes ownership of the fenceFd and 2842e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * is responsible for closing it when no longer needed. 2852e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * 2862e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart * Added in GRALLOC_MODULE_API_VERSION_0_3. 2872e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart */ 2882e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart int (*lockAsync_ycbcr)(struct gralloc_module_t const* module, 2892e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart buffer_handle_t handle, int usage, 2902e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart int l, int t, int w, int h, 2912e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart struct android_ycbcr *ycbcr, int fenceFd); 2922e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart 2938255d9d3b62ddf90269ddbb54e6f92b29908fa75Mathias Agopian /* reserved for future use */ 2942e49f9acbb1039a8388b070332a5e2f35cd35343Francis Hart void* reserved_proc[3]; 2959d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian} gralloc_module_t; 296a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 297a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/*****************************************************************************/ 298a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 299a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** 300a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Every device data structure must begin with hw_device_t 301a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * followed by module specific public methods and attributes. 302a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 303a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 3049d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopiantypedef struct alloc_device_t { 305a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct hw_device_t common; 306a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 307a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 308a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (*alloc)() Allocates a buffer in graphic memory with the requested 309a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * parameters and returns a buffer_handle_t and the stride in pixels to 310a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * allow the implementation to satisfy hardware constraints on the width 311a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * of a pixmap (eg: it may have to be multiple of 8 pixels). 312a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * The CALLER TAKES OWNERSHIP of the buffer_handle_t. 3136efab252d59ceff806840111b2e6c0e478d377aeEino-Ville Talvala * 3146efab252d59ceff806840111b2e6c0e478d377aeEino-Ville Talvala * If format is HAL_PIXEL_FORMAT_YCbCr_420_888, the returned stride must be 3156efab252d59ceff806840111b2e6c0e478d377aeEino-Ville Talvala * 0, since the actual strides are available from the android_ycbcr 3166efab252d59ceff806840111b2e6c0e478d377aeEino-Ville Talvala * structure. 317a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 318a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 319a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 320a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 321a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*alloc)(struct alloc_device_t* dev, 322a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int w, int h, int format, int usage, 323a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t* handle, int* stride); 324a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 325a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian /* 326a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (*free)() Frees a previously allocated buffer. 327a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Behavior is undefined if the buffer is still mapped in any process, 328a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * but shall not result in termination of the program or security breaches 329a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * (allowing a process to get access to another process' buffers). 330a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * THIS FUNCTION TAKES OWNERSHIP of the buffer_handle_t which becomes 331a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * invalid after the call. 332a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * 333a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian * Returns 0 on success or -errno on error. 334a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian */ 335a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian int (*free)(struct alloc_device_t* dev, 336a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian buffer_handle_t handle); 337a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 338158549c89405186d9ecaefd3811cfae3949056eeErik Gilling /* This hook is OPTIONAL. 339158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * 340158549c89405186d9ecaefd3811cfae3949056eeErik Gilling * If non NULL it will be caused by SurfaceFlinger on dumpsys 341158549c89405186d9ecaefd3811cfae3949056eeErik Gilling */ 342158549c89405186d9ecaefd3811cfae3949056eeErik Gilling void (*dump)(struct alloc_device_t *dev, char *buff, int buff_len); 343158549c89405186d9ecaefd3811cfae3949056eeErik Gilling 344158549c89405186d9ecaefd3811cfae3949056eeErik Gilling void* reserved_proc[7]; 3459d82c1a447a72a2c086b9cd34c5b73b163d7acbcMathias Agopian} alloc_device_t; 346a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 347a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 348a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian/** convenience API for opening and closing a supported device */ 349a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 350a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int gralloc_open(const struct hw_module_t* module, 351a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian struct alloc_device_t** device) { 352a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return module->methods->open(module, 353a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian GRALLOC_HARDWARE_GPU0, (struct hw_device_t**)device); 354a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 355a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 356a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopianstatic inline int gralloc_close(struct alloc_device_t* device) { 357a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian return device->common.close(&device->common); 358a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian} 359a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 360a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian__END_DECLS 361a8a75166a2d3c7639a7432a67075c98796165206Mathias Agopian 362bb56a1007d80ef8165493395ac8c9b0bf05a435fGlenn Kasten#endif // ANDROID_GRALLOC_INTERFACE_H 363