1eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke/* 2eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * Copyright © 2011 Intel Corporation 3eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * 4eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * Permission is hereby granted, free of charge, to any person obtaining a 5eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * copy of this software and associated documentation files (the "Software"), 6eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * to deal in the Software without restriction, including without limitation 7eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * the rights to use, copy, modify, merge, publish, distribute, sublicense, 8eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * and/or sell copies of the Software, and to permit persons to whom the 9eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * Software is furnished to do so, subject to the following conditions: 10eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * 11eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * The above copyright notice and this permission notice (including the next 12eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * paragraph) shall be included in all copies or substantial portions of the 13eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * Software. 14eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * 15eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 16eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 17eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 18eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 19eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 20eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 22eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * DEALINGS IN THE SOFTWARE. 23eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * 24eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * Authors: 25eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke * Benjamin Franzke <benjaminfranzke@googlemail.com> 26eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke */ 27eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 28eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke#ifndef _GBM_H_ 29eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke#define _GBM_H_ 30eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 31496bf3822a724127b2632596dc45648fdeda0afbJørgen Lind#ifdef __cplusplus 32496bf3822a724127b2632596dc45648fdeda0afbJørgen Lindextern "C" { 33496bf3822a724127b2632596dc45648fdeda0afbJørgen Lind#endif 34496bf3822a724127b2632596dc45648fdeda0afbJørgen Lind 35496bf3822a724127b2632596dc45648fdeda0afbJørgen Lind 36eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke#define __GBM__ 1 37eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 38eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke#include <stdint.h> 39eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 40baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford/** 41baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * \file gbm.h 42baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * \brief Generic Buffer Manager 43baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford */ 44baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford 45eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkestruct gbm_device; 46eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkestruct gbm_bo; 470d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveirastruct gbm_surface; 48eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 49baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford/** 50baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * \mainpage The Generic Buffer Manager 51baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * 52baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * This module provides an abstraction that the caller can use to request a 53baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * buffer from the underlying memory management system for the platform. 54baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * 55baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * This allows the creation of portable code whilst still allowing access to 56baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * the underlying memory manager. 57baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford */ 58baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford 59baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford/** 60baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * Abstraction representing the handle to a buffer allocated by the 61baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * manager 62baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford */ 63eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeunion gbm_bo_handle { 64eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke void *ptr; 65eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke int32_t s32; 66eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke uint32_t u32; 67eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke int64_t s64; 68eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke uint64_t u64; 69eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke}; 70eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 71baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford/** Format of the allocated buffer */ 72eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeenum gbm_bo_format { 73baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford /** RGB with 8 bits per channel in a 32 bit value */ 74baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford GBM_BO_FORMAT_XRGB8888, 75baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford /** ARGB with 8 bits per channel in a 32 bit value */ 76baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford GBM_BO_FORMAT_ARGB8888 77eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke}; 78eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 798de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define __gbm_fourcc_code(a,b,c,d) ((uint32_t)(a) | ((uint32_t)(b) << 8) | \ 808de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24)) 818de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 828de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BIG_ENDIAN (1<<31) /* format is big endian instead of little endian */ 838de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 848de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes/* color index */ 858de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_C8 __gbm_fourcc_code('C', '8', ' ', ' ') /* [7:0] C */ 868de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 878de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes/* 8 bpp RGB */ 888de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGB332 __gbm_fourcc_code('R', 'G', 'B', '8') /* [7:0] R:G:B 3:3:2 */ 898de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGR233 __gbm_fourcc_code('B', 'G', 'R', '8') /* [7:0] B:G:R 2:3:3 */ 908de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 918de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes/* 16 bpp RGB */ 928de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_XRGB4444 __gbm_fourcc_code('X', 'R', '1', '2') /* [15:0] x:R:G:B 4:4:4:4 little endian */ 938de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_XBGR4444 __gbm_fourcc_code('X', 'B', '1', '2') /* [15:0] x:B:G:R 4:4:4:4 little endian */ 948de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGBX4444 __gbm_fourcc_code('R', 'X', '1', '2') /* [15:0] R:G:B:x 4:4:4:4 little endian */ 958de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGRX4444 __gbm_fourcc_code('B', 'X', '1', '2') /* [15:0] B:G:R:x 4:4:4:4 little endian */ 968de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 978de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_ARGB4444 __gbm_fourcc_code('A', 'R', '1', '2') /* [15:0] A:R:G:B 4:4:4:4 little endian */ 988de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_ABGR4444 __gbm_fourcc_code('A', 'B', '1', '2') /* [15:0] A:B:G:R 4:4:4:4 little endian */ 998de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGBA4444 __gbm_fourcc_code('R', 'A', '1', '2') /* [15:0] R:G:B:A 4:4:4:4 little endian */ 1008de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGRA4444 __gbm_fourcc_code('B', 'A', '1', '2') /* [15:0] B:G:R:A 4:4:4:4 little endian */ 1018de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1028de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_XRGB1555 __gbm_fourcc_code('X', 'R', '1', '5') /* [15:0] x:R:G:B 1:5:5:5 little endian */ 1038de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_XBGR1555 __gbm_fourcc_code('X', 'B', '1', '5') /* [15:0] x:B:G:R 1:5:5:5 little endian */ 1048de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGBX5551 __gbm_fourcc_code('R', 'X', '1', '5') /* [15:0] R:G:B:x 5:5:5:1 little endian */ 1058de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGRX5551 __gbm_fourcc_code('B', 'X', '1', '5') /* [15:0] B:G:R:x 5:5:5:1 little endian */ 1068de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1078de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_ARGB1555 __gbm_fourcc_code('A', 'R', '1', '5') /* [15:0] A:R:G:B 1:5:5:5 little endian */ 1088de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_ABGR1555 __gbm_fourcc_code('A', 'B', '1', '5') /* [15:0] A:B:G:R 1:5:5:5 little endian */ 1098de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGBA5551 __gbm_fourcc_code('R', 'A', '1', '5') /* [15:0] R:G:B:A 5:5:5:1 little endian */ 1108de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGRA5551 __gbm_fourcc_code('B', 'A', '1', '5') /* [15:0] B:G:R:A 5:5:5:1 little endian */ 1118de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1128de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGB565 __gbm_fourcc_code('R', 'G', '1', '6') /* [15:0] R:G:B 5:6:5 little endian */ 1138de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGR565 __gbm_fourcc_code('B', 'G', '1', '6') /* [15:0] B:G:R 5:6:5 little endian */ 1148de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1158de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes/* 24 bpp RGB */ 1168de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGB888 __gbm_fourcc_code('R', 'G', '2', '4') /* [23:0] R:G:B little endian */ 1178de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGR888 __gbm_fourcc_code('B', 'G', '2', '4') /* [23:0] B:G:R little endian */ 1188de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1198de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes/* 32 bpp RGB */ 1208de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_XRGB8888 __gbm_fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */ 1218de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_XBGR8888 __gbm_fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */ 1228de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGBX8888 __gbm_fourcc_code('R', 'X', '2', '4') /* [31:0] R:G:B:x 8:8:8:8 little endian */ 1238de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGRX8888 __gbm_fourcc_code('B', 'X', '2', '4') /* [31:0] B:G:R:x 8:8:8:8 little endian */ 1248de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1258de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_ARGB8888 __gbm_fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */ 1268de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_ABGR8888 __gbm_fourcc_code('A', 'B', '2', '4') /* [31:0] A:B:G:R 8:8:8:8 little endian */ 1278de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGBA8888 __gbm_fourcc_code('R', 'A', '2', '4') /* [31:0] R:G:B:A 8:8:8:8 little endian */ 1288de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGRA8888 __gbm_fourcc_code('B', 'A', '2', '4') /* [31:0] B:G:R:A 8:8:8:8 little endian */ 1298de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1308de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_XRGB2101010 __gbm_fourcc_code('X', 'R', '3', '0') /* [31:0] x:R:G:B 2:10:10:10 little endian */ 1318de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_XBGR2101010 __gbm_fourcc_code('X', 'B', '3', '0') /* [31:0] x:B:G:R 2:10:10:10 little endian */ 1328de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGBX1010102 __gbm_fourcc_code('R', 'X', '3', '0') /* [31:0] R:G:B:x 10:10:10:2 little endian */ 1338de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGRX1010102 __gbm_fourcc_code('B', 'X', '3', '0') /* [31:0] B:G:R:x 10:10:10:2 little endian */ 1348de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1358de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_ARGB2101010 __gbm_fourcc_code('A', 'R', '3', '0') /* [31:0] A:R:G:B 2:10:10:10 little endian */ 1368de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_ABGR2101010 __gbm_fourcc_code('A', 'B', '3', '0') /* [31:0] A:B:G:R 2:10:10:10 little endian */ 1378de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_RGBA1010102 __gbm_fourcc_code('R', 'A', '3', '0') /* [31:0] R:G:B:A 10:10:10:2 little endian */ 1388de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_BGRA1010102 __gbm_fourcc_code('B', 'A', '3', '0') /* [31:0] B:G:R:A 10:10:10:2 little endian */ 1398de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1408de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes/* packed YCbCr */ 1418de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YUYV __gbm_fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */ 1428de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YVYU __gbm_fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */ 1438de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_UYVY __gbm_fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */ 1448de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_VYUY __gbm_fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */ 1458de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1468de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_AYUV __gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */ 1478de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1488de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes/* 1498de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * 2 plane YCbCr 1508de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * index 0 = Y plane, [7:0] Y 1518de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian 1528de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * or 1538de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian 1548de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes */ 1558de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_NV12 __gbm_fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */ 1568de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_NV21 __gbm_fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */ 1578de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_NV16 __gbm_fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */ 1588de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_NV61 __gbm_fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */ 1598de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1608de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes/* 1618de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * 3 plane YCbCr 1628de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * index 0: Y plane, [7:0] Y 1638de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * index 1: Cb plane, [7:0] Cb 1648de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * index 2: Cr plane, [7:0] Cr 1658de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * or 1668de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * index 1: Cr plane, [7:0] Cr 1678de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes * index 2: Cb plane, [7:0] Cb 1688de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes */ 1698de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YUV410 __gbm_fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */ 1708de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YVU410 __gbm_fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */ 1718de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YUV411 __gbm_fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */ 1728de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YVU411 __gbm_fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */ 1738de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YUV420 __gbm_fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */ 1748de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YVU420 __gbm_fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */ 1758de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YUV422 __gbm_fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */ 1768de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YVU422 __gbm_fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */ 1778de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YUV444 __gbm_fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */ 1788de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes#define GBM_FORMAT_YVU444 __gbm_fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */ 1798de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 1808de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 181baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford/** 182baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * Flags to indicate the intended use for the buffer - these are passed into 183baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * gbm_bo_create(). The caller must set the union of all the flags that are 184baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * appropriate 185baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * 186baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * \sa Use gbm_device_is_format_supported() to check if the combination of format 187baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * and use flags are supported 188baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford */ 189eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeenum gbm_bo_flags { 190baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford /** 191baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * Buffer is going to be presented to the screen using an API such as KMS 192baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford */ 193eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke GBM_BO_USE_SCANOUT = (1 << 0), 194baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford /** 195baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * Buffer is going to be used as cursor - the dimensions for the buffer 196baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * must be 64x64 if this flag is passed. 197baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford */ 198eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke GBM_BO_USE_CURSOR_64X64 = (1 << 1), 199baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford /** 200baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * Buffer is to be used for rendering - for example it is going to be used 201baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford * as the storage for a color buffer 202baab68e1a607b818c8988e70546fe3e6f97cf572Rob Bradford */ 203eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke GBM_BO_USE_RENDERING = (1 << 2), 2044fddb2ba21add1c1968330e5224ecead59da3995Kristian Høgsberg /** 2054fddb2ba21add1c1968330e5224ecead59da3995Kristian Høgsberg * Buffer can be used for gbm_bo_write. This is guaranteed to work 2064fddb2ba21add1c1968330e5224ecead59da3995Kristian Høgsberg * with GBM_BO_USE_CURSOR_64X64. but may not work for other 2074fddb2ba21add1c1968330e5224ecead59da3995Kristian Høgsberg * combinations. 2084fddb2ba21add1c1968330e5224ecead59da3995Kristian Høgsberg */ 2094fddb2ba21add1c1968330e5224ecead59da3995Kristian Høgsberg GBM_BO_USE_WRITE = (1 << 3), 210eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke}; 211eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 212eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeint 213eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_device_get_fd(struct gbm_device *gbm); 214eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 215eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeconst char * 216eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_device_get_backend_name(struct gbm_device *gbm); 217eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 218eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeint 219eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_device_is_format_supported(struct gbm_device *gbm, 2208de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes uint32_t format, uint32_t usage); 221eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 222eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkevoid 223eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_device_destroy(struct gbm_device *gbm); 224eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 225eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkestruct gbm_device * 226eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_create_device(int fd); 227eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 228eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkestruct gbm_bo * 229eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_bo_create(struct gbm_device *gbm, 230eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke uint32_t width, uint32_t height, 2318de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes uint32_t format, uint32_t flags); 232eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 23344f066b9ffb7749e872c9cc44ab4d6e2973c2372Kristian Høgsberg#define GBM_BO_IMPORT_WL_BUFFER 0x5501 23444f066b9ffb7749e872c9cc44ab4d6e2973c2372Kristian Høgsberg#define GBM_BO_IMPORT_EGL_IMAGE 0x5502 23544f066b9ffb7749e872c9cc44ab4d6e2973c2372Kristian Høgsberg 236eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkestruct gbm_bo * 23744f066b9ffb7749e872c9cc44ab4d6e2973c2372Kristian Høgsberggbm_bo_import(struct gbm_device *gbm, uint32_t type, 23844f066b9ffb7749e872c9cc44ab4d6e2973c2372Kristian Høgsberg void *buffer, uint32_t usage); 239eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 240eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeuint32_t 241eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_bo_get_width(struct gbm_bo *bo); 242eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 243eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeuint32_t 244eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_bo_get_height(struct gbm_bo *bo); 245eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 246eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeuint32_t 2477250cd506baa0bd4649b30d87509cdd0cbc06a57Kristian Høgsberggbm_bo_get_stride(struct gbm_bo *bo); 248eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 2498de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnesuint32_t 2508de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnesgbm_bo_get_format(struct gbm_bo *bo); 2518de5c355fa2bf0f30df2c7cf39aee01e793284bfJesse Barnes 2526c84f2992fee8b866b9f7434c8c26613b67dc2d4Ander Conselvan de Oliveirastruct gbm_device * 2536c84f2992fee8b866b9f7434c8c26613b67dc2d4Ander Conselvan de Oliveiragbm_bo_get_device(struct gbm_bo *bo); 2546c84f2992fee8b866b9f7434c8c26613b67dc2d4Ander Conselvan de Oliveira 255eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkeunion gbm_bo_handle 256eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_bo_get_handle(struct gbm_bo *bo); 257eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 2584fddb2ba21add1c1968330e5224ecead59da3995Kristian Høgsbergint 2594fddb2ba21add1c1968330e5224ecead59da3995Kristian Høgsberggbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count); 2604fddb2ba21add1c1968330e5224ecead59da3995Kristian Høgsberg 261eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkevoid 262310d8d189d14eb6c29be205bf2c9e98187b2fa84Ander Conselvan de Oliveiragbm_bo_set_user_data(struct gbm_bo *bo, void *data, 263310d8d189d14eb6c29be205bf2c9e98187b2fa84Ander Conselvan de Oliveira void (*destroy_user_data)(struct gbm_bo *, void *)); 264310d8d189d14eb6c29be205bf2c9e98187b2fa84Ander Conselvan de Oliveira 265310d8d189d14eb6c29be205bf2c9e98187b2fa84Ander Conselvan de Oliveiravoid * 266310d8d189d14eb6c29be205bf2c9e98187b2fa84Ander Conselvan de Oliveiragbm_bo_get_user_data(struct gbm_bo *bo); 267310d8d189d14eb6c29be205bf2c9e98187b2fa84Ander Conselvan de Oliveira 268310d8d189d14eb6c29be205bf2c9e98187b2fa84Ander Conselvan de Oliveiravoid 269eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzkegbm_bo_destroy(struct gbm_bo *bo); 270eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke 2710d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveirastruct gbm_surface * 2720d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveiragbm_surface_create(struct gbm_device *gbm, 2730d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveira uint32_t width, uint32_t height, 2740d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveira uint32_t format, uint32_t flags); 2750d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveira 2760d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveirastruct gbm_bo * 2770d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveiragbm_surface_lock_front_buffer(struct gbm_surface *surface); 2780d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveira 2790d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveiravoid 2800d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveiragbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo); 2810d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveira 2820d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveiraint 2830d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveiragbm_surface_has_free_buffers(struct gbm_surface *surface); 2840d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveira 2850d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveiravoid 2860d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveiragbm_surface_destroy(struct gbm_surface *surface); 2870d1ef1f57f9011fd2bc3354d60fb19db29af7363Ander Conselvan de Oliveira 288496bf3822a724127b2632596dc45648fdeda0afbJørgen Lind#ifdef __cplusplus 289496bf3822a724127b2632596dc45648fdeda0afbJørgen Lind} 290496bf3822a724127b2632596dc45648fdeda0afbJørgen Lind#endif 291496bf3822a724127b2632596dc45648fdeda0afbJørgen Lind 292eddcecbf74da26716509c047b95e85b00c12bab4Benjamin Franzke#endif 293