Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright © 2011 Intel Corporation |
| 3 | * |
| 4 | * Permission is hereby granted, free of charge, to any person obtaining a |
| 5 | * copy of this software and associated documentation files (the "Software"), |
| 6 | * to deal in the Software without restriction, including without limitation |
| 7 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 8 | * and/or sell copies of the Software, and to permit persons to whom the |
| 9 | * Software is furnished to do so, subject to the following conditions: |
| 10 | * |
| 11 | * The above copyright notice and this permission notice (including the next |
| 12 | * paragraph) shall be included in all copies or substantial portions of the |
| 13 | * Software. |
| 14 | * |
| 15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
| 16 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 17 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
| 18 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
| 19 | * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
| 20 | * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| 22 | * DEALINGS IN THE SOFTWARE. |
| 23 | * |
| 24 | * Authors: |
| 25 | * Benjamin Franzke <benjaminfranzke@googlemail.com> |
| 26 | */ |
| 27 | |
| 28 | #ifndef _GBM_H_ |
| 29 | #define _GBM_H_ |
| 30 | |
| 31 | #ifdef __cplusplus |
| 32 | extern "C" { |
| 33 | #endif |
| 34 | |
| 35 | |
| 36 | #define __GBM__ 1 |
| 37 | |
Maksim Sisov | 11161ac | 2018-10-16 11:24:05 +0300 | [diff] [blame^] | 38 | #ifndef MINIGBM |
| 39 | #define MINIGBM |
| 40 | #endif |
| 41 | |
Heng-Ruey Hsu | 3fa6dff | 2016-12-21 13:59:20 +0800 | [diff] [blame] | 42 | #include <stddef.h> |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 43 | #include <stdint.h> |
| 44 | |
| 45 | /** |
| 46 | * \file gbm.h |
| 47 | * \brief Generic Buffer Manager |
| 48 | */ |
| 49 | |
| 50 | struct gbm_device; |
| 51 | struct gbm_bo; |
| 52 | struct gbm_surface; |
| 53 | |
| 54 | /** |
| 55 | * \mainpage The Generic Buffer Manager |
| 56 | * |
| 57 | * This module provides an abstraction that the caller can use to request a |
| 58 | * buffer from the underlying memory management system for the platform. |
| 59 | * |
| 60 | * This allows the creation of portable code whilst still allowing access to |
| 61 | * the underlying memory manager. |
| 62 | */ |
| 63 | |
| 64 | /** |
| 65 | * Abstraction representing the handle to a buffer allocated by the |
| 66 | * manager |
| 67 | */ |
| 68 | union gbm_bo_handle { |
| 69 | void *ptr; |
| 70 | int32_t s32; |
| 71 | uint32_t u32; |
| 72 | int64_t s64; |
| 73 | uint64_t u64; |
| 74 | }; |
| 75 | |
Kristian H. Kristensen | 3345977 | 2016-09-16 11:14:16 -0700 | [diff] [blame] | 76 | #define GBM_MAX_PLANES 4 |
| 77 | |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 78 | #define __gbm_fourcc_code(a,b,c,d) ((uint32_t)(a) | ((uint32_t)(b) << 8) | \ |
| 79 | ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24)) |
| 80 | |
| 81 | #define GBM_FORMAT_BIG_ENDIAN (1<<31) /* format is big endian instead of little endian */ |
| 82 | |
| 83 | /* color index */ |
| 84 | #define GBM_FORMAT_C8 __gbm_fourcc_code('C', '8', ' ', ' ') /* [7:0] C */ |
| 85 | |
Dongseong Hwang | b26f26d | 2016-04-07 14:51:29 +0300 | [diff] [blame] | 86 | /* 8 bpp Red */ |
| 87 | #define GBM_FORMAT_R8 __gbm_fourcc_code('R', '8', ' ', ' ') /* [7:0] R */ |
| 88 | |
| 89 | /* 16 bpp RG */ |
| 90 | #define GBM_FORMAT_RG88 __gbm_fourcc_code('R', 'G', '8', '8') /* [15:0] R:G 8:8 little endian */ |
| 91 | #define GBM_FORMAT_GR88 __gbm_fourcc_code('G', 'R', '8', '8') /* [15:0] G:R 8:8 little endian */ |
| 92 | |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 93 | /* 8 bpp RGB */ |
| 94 | #define GBM_FORMAT_RGB332 __gbm_fourcc_code('R', 'G', 'B', '8') /* [7:0] R:G:B 3:3:2 */ |
| 95 | #define GBM_FORMAT_BGR233 __gbm_fourcc_code('B', 'G', 'R', '8') /* [7:0] B:G:R 2:3:3 */ |
| 96 | |
| 97 | /* 16 bpp RGB */ |
| 98 | #define GBM_FORMAT_XRGB4444 __gbm_fourcc_code('X', 'R', '1', '2') /* [15:0] x:R:G:B 4:4:4:4 little endian */ |
| 99 | #define GBM_FORMAT_XBGR4444 __gbm_fourcc_code('X', 'B', '1', '2') /* [15:0] x:B:G:R 4:4:4:4 little endian */ |
| 100 | #define GBM_FORMAT_RGBX4444 __gbm_fourcc_code('R', 'X', '1', '2') /* [15:0] R:G:B:x 4:4:4:4 little endian */ |
| 101 | #define GBM_FORMAT_BGRX4444 __gbm_fourcc_code('B', 'X', '1', '2') /* [15:0] B:G:R:x 4:4:4:4 little endian */ |
| 102 | |
| 103 | #define GBM_FORMAT_ARGB4444 __gbm_fourcc_code('A', 'R', '1', '2') /* [15:0] A:R:G:B 4:4:4:4 little endian */ |
| 104 | #define GBM_FORMAT_ABGR4444 __gbm_fourcc_code('A', 'B', '1', '2') /* [15:0] A:B:G:R 4:4:4:4 little endian */ |
| 105 | #define GBM_FORMAT_RGBA4444 __gbm_fourcc_code('R', 'A', '1', '2') /* [15:0] R:G:B:A 4:4:4:4 little endian */ |
| 106 | #define GBM_FORMAT_BGRA4444 __gbm_fourcc_code('B', 'A', '1', '2') /* [15:0] B:G:R:A 4:4:4:4 little endian */ |
| 107 | |
| 108 | #define GBM_FORMAT_XRGB1555 __gbm_fourcc_code('X', 'R', '1', '5') /* [15:0] x:R:G:B 1:5:5:5 little endian */ |
| 109 | #define GBM_FORMAT_XBGR1555 __gbm_fourcc_code('X', 'B', '1', '5') /* [15:0] x:B:G:R 1:5:5:5 little endian */ |
| 110 | #define GBM_FORMAT_RGBX5551 __gbm_fourcc_code('R', 'X', '1', '5') /* [15:0] R:G:B:x 5:5:5:1 little endian */ |
| 111 | #define GBM_FORMAT_BGRX5551 __gbm_fourcc_code('B', 'X', '1', '5') /* [15:0] B:G:R:x 5:5:5:1 little endian */ |
| 112 | |
| 113 | #define GBM_FORMAT_ARGB1555 __gbm_fourcc_code('A', 'R', '1', '5') /* [15:0] A:R:G:B 1:5:5:5 little endian */ |
| 114 | #define GBM_FORMAT_ABGR1555 __gbm_fourcc_code('A', 'B', '1', '5') /* [15:0] A:B:G:R 1:5:5:5 little endian */ |
| 115 | #define GBM_FORMAT_RGBA5551 __gbm_fourcc_code('R', 'A', '1', '5') /* [15:0] R:G:B:A 5:5:5:1 little endian */ |
| 116 | #define GBM_FORMAT_BGRA5551 __gbm_fourcc_code('B', 'A', '1', '5') /* [15:0] B:G:R:A 5:5:5:1 little endian */ |
| 117 | |
| 118 | #define GBM_FORMAT_RGB565 __gbm_fourcc_code('R', 'G', '1', '6') /* [15:0] R:G:B 5:6:5 little endian */ |
| 119 | #define GBM_FORMAT_BGR565 __gbm_fourcc_code('B', 'G', '1', '6') /* [15:0] B:G:R 5:6:5 little endian */ |
| 120 | |
| 121 | /* 24 bpp RGB */ |
| 122 | #define GBM_FORMAT_RGB888 __gbm_fourcc_code('R', 'G', '2', '4') /* [23:0] R:G:B little endian */ |
| 123 | #define GBM_FORMAT_BGR888 __gbm_fourcc_code('B', 'G', '2', '4') /* [23:0] B:G:R little endian */ |
| 124 | |
| 125 | /* 32 bpp RGB */ |
| 126 | #define GBM_FORMAT_XRGB8888 __gbm_fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */ |
| 127 | #define GBM_FORMAT_XBGR8888 __gbm_fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */ |
| 128 | #define GBM_FORMAT_RGBX8888 __gbm_fourcc_code('R', 'X', '2', '4') /* [31:0] R:G:B:x 8:8:8:8 little endian */ |
| 129 | #define GBM_FORMAT_BGRX8888 __gbm_fourcc_code('B', 'X', '2', '4') /* [31:0] B:G:R:x 8:8:8:8 little endian */ |
| 130 | |
| 131 | #define GBM_FORMAT_ARGB8888 __gbm_fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */ |
| 132 | #define GBM_FORMAT_ABGR8888 __gbm_fourcc_code('A', 'B', '2', '4') /* [31:0] A:B:G:R 8:8:8:8 little endian */ |
| 133 | #define GBM_FORMAT_RGBA8888 __gbm_fourcc_code('R', 'A', '2', '4') /* [31:0] R:G:B:A 8:8:8:8 little endian */ |
| 134 | #define GBM_FORMAT_BGRA8888 __gbm_fourcc_code('B', 'A', '2', '4') /* [31:0] B:G:R:A 8:8:8:8 little endian */ |
| 135 | |
| 136 | #define GBM_FORMAT_XRGB2101010 __gbm_fourcc_code('X', 'R', '3', '0') /* [31:0] x:R:G:B 2:10:10:10 little endian */ |
| 137 | #define GBM_FORMAT_XBGR2101010 __gbm_fourcc_code('X', 'B', '3', '0') /* [31:0] x:B:G:R 2:10:10:10 little endian */ |
| 138 | #define GBM_FORMAT_RGBX1010102 __gbm_fourcc_code('R', 'X', '3', '0') /* [31:0] R:G:B:x 10:10:10:2 little endian */ |
| 139 | #define GBM_FORMAT_BGRX1010102 __gbm_fourcc_code('B', 'X', '3', '0') /* [31:0] B:G:R:x 10:10:10:2 little endian */ |
| 140 | |
| 141 | #define GBM_FORMAT_ARGB2101010 __gbm_fourcc_code('A', 'R', '3', '0') /* [31:0] A:R:G:B 2:10:10:10 little endian */ |
| 142 | #define GBM_FORMAT_ABGR2101010 __gbm_fourcc_code('A', 'B', '3', '0') /* [31:0] A:B:G:R 2:10:10:10 little endian */ |
| 143 | #define GBM_FORMAT_RGBA1010102 __gbm_fourcc_code('R', 'A', '3', '0') /* [31:0] R:G:B:A 10:10:10:2 little endian */ |
| 144 | #define GBM_FORMAT_BGRA1010102 __gbm_fourcc_code('B', 'A', '3', '0') /* [31:0] B:G:R:A 10:10:10:2 little endian */ |
| 145 | |
| 146 | /* packed YCbCr */ |
| 147 | #define GBM_FORMAT_YUYV __gbm_fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */ |
| 148 | #define GBM_FORMAT_YVYU __gbm_fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */ |
| 149 | #define GBM_FORMAT_UYVY __gbm_fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */ |
| 150 | #define GBM_FORMAT_VYUY __gbm_fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */ |
| 151 | |
| 152 | #define GBM_FORMAT_AYUV __gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */ |
| 153 | |
| 154 | /* |
| 155 | * 2 plane YCbCr |
| 156 | * index 0 = Y plane, [7:0] Y |
| 157 | * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian |
| 158 | * or |
| 159 | * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian |
| 160 | */ |
| 161 | #define GBM_FORMAT_NV12 __gbm_fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */ |
| 162 | #define GBM_FORMAT_NV21 __gbm_fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */ |
| 163 | #define GBM_FORMAT_NV16 __gbm_fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */ |
| 164 | #define GBM_FORMAT_NV61 __gbm_fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */ |
| 165 | |
| 166 | /* |
| 167 | * 3 plane YCbCr |
| 168 | * index 0: Y plane, [7:0] Y |
| 169 | * index 1: Cb plane, [7:0] Cb |
| 170 | * index 2: Cr plane, [7:0] Cr |
| 171 | * or |
| 172 | * index 1: Cr plane, [7:0] Cr |
| 173 | * index 2: Cb plane, [7:0] Cb |
| 174 | */ |
| 175 | #define GBM_FORMAT_YUV410 __gbm_fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */ |
| 176 | #define GBM_FORMAT_YVU410 __gbm_fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */ |
| 177 | #define GBM_FORMAT_YUV411 __gbm_fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */ |
| 178 | #define GBM_FORMAT_YVU411 __gbm_fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */ |
| 179 | #define GBM_FORMAT_YUV420 __gbm_fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */ |
| 180 | #define GBM_FORMAT_YVU420 __gbm_fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */ |
| 181 | #define GBM_FORMAT_YUV422 __gbm_fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */ |
| 182 | #define GBM_FORMAT_YVU422 __gbm_fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */ |
| 183 | #define GBM_FORMAT_YUV444 __gbm_fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */ |
| 184 | #define GBM_FORMAT_YVU444 __gbm_fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */ |
| 185 | |
Vince Hsu | a6878fe | 2016-05-23 10:32:25 +0800 | [diff] [blame] | 186 | /* |
| 187 | * Format Modifiers: |
| 188 | * |
| 189 | * Format modifiers describe, typically, a re-ordering or modification |
| 190 | * of the data in a plane of an FB. This can be used to express tiled/ |
| 191 | * swizzled formats, or compression, or a combination of the two. |
| 192 | * |
| 193 | * The upper 8 bits of the format modifier are a vendor-id as assigned |
| 194 | * below. The lower 56 bits are assigned as vendor sees fit. |
| 195 | */ |
| 196 | |
| 197 | /* Vendor Ids: */ |
| 198 | #define GBM_FORMAT_MOD_NONE 0 |
| 199 | #define GBM_FORMAT_MOD_VENDOR_INTEL 0x01 |
| 200 | #define GBM_FORMAT_MOD_VENDOR_AMD 0x02 |
| 201 | #define GBM_FORMAT_MOD_VENDOR_NV 0x03 |
| 202 | #define GBM_FORMAT_MOD_VENDOR_SAMSUNG 0x04 |
| 203 | #define GBM_FORMAT_MOD_VENDOR_QCOM 0x05 |
| 204 | /* add more to the end as needed */ |
| 205 | |
| 206 | #define gbm_fourcc_mod_code(vendor, val) \ |
| 207 | ((((__u64)GBM_FORMAT_MOD_VENDOR_## vendor) << 56) | (val & 0x00ffffffffffffffULL)) |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 208 | |
| 209 | /** |
| 210 | * Flags to indicate the intended use for the buffer - these are passed into |
| 211 | * gbm_bo_create(). The caller must set the union of all the flags that are |
| 212 | * appropriate |
| 213 | * |
| 214 | * \sa Use gbm_device_is_format_supported() to check if the combination of format |
| 215 | * and use flags are supported |
| 216 | */ |
| 217 | enum gbm_bo_flags { |
| 218 | /** |
| 219 | * Buffer is going to be presented to the screen using an API such as KMS |
| 220 | */ |
| 221 | GBM_BO_USE_SCANOUT = (1 << 0), |
| 222 | /** |
| 223 | * Buffer is going to be used as cursor |
| 224 | */ |
| 225 | GBM_BO_USE_CURSOR = (1 << 1), |
| 226 | /** |
| 227 | * Deprecated |
| 228 | */ |
| 229 | GBM_BO_USE_CURSOR_64X64 = GBM_BO_USE_CURSOR, |
| 230 | /** |
| 231 | * Buffer is to be used for rendering - for example it is going to be used |
| 232 | * as the storage for a color buffer |
| 233 | */ |
| 234 | GBM_BO_USE_RENDERING = (1 << 2), |
| 235 | /** |
Zach Reizner | 5c22777 | 2016-03-08 10:22:40 -0800 | [diff] [blame] | 236 | * Deprecated |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 237 | */ |
| 238 | GBM_BO_USE_WRITE = (1 << 3), |
Zach Reizner | 1e22939 | 2016-02-25 10:45:44 -0800 | [diff] [blame] | 239 | /** |
| 240 | * Buffer is guaranteed to be laid out linearly in memory. That is, the |
| 241 | * buffer is laid out as an array with 'height' blocks, each block with |
| 242 | * length 'stride'. Each stride is in the same order as the rows of the |
Shirish S | 355b156 | 2017-10-13 09:54:03 +0530 | [diff] [blame] | 243 | * buffer. This is intended to be used with buffers that will be accessed |
| 244 | * via dma-buf mmap(). |
Zach Reizner | 1e22939 | 2016-02-25 10:45:44 -0800 | [diff] [blame] | 245 | */ |
| 246 | GBM_BO_USE_LINEAR = (1 << 4), |
Dongseong Hwang | 3909dc0 | 2017-06-23 16:11:50 -0700 | [diff] [blame] | 247 | /** |
| 248 | * The buffer will be used as a texture that will be sampled from. |
| 249 | */ |
| 250 | GBM_BO_USE_TEXTURING = (1 << 5), |
Tomasz Figa | 11f3d08 | 2017-07-06 15:40:05 +0900 | [diff] [blame] | 251 | /** |
| 252 | * The buffer will be written to by a camera subsystem. |
| 253 | */ |
| 254 | GBM_BO_USE_CAMERA_WRITE = (1 << 6), |
| 255 | /** |
| 256 | * The buffer will be read from by a camera subsystem. |
| 257 | */ |
| 258 | GBM_BO_USE_CAMERA_READ = (1 << 7), |
Tomasz Figa | e0807b1 | 2017-08-04 12:50:03 +0900 | [diff] [blame] | 259 | /** |
| 260 | * Buffer inaccessible to unprivileged users. |
| 261 | */ |
| 262 | GBM_BO_USE_PROTECTED = (1 << 8), |
Shirish S | 355b156 | 2017-10-13 09:54:03 +0530 | [diff] [blame] | 263 | /** |
| 264 | * These flags specify the frequency of software access. These flags do not |
| 265 | * guarantee the buffer is linear, but do guarantee gbm_bo_map(..) will |
| 266 | * present a linear view. |
| 267 | */ |
| 268 | GBM_BO_USE_SW_READ_OFTEN = (1 << 9), |
| 269 | GBM_BO_USE_SW_READ_RARELY = (1 << 10), |
| 270 | GBM_BO_USE_SW_WRITE_OFTEN = (1 << 11), |
| 271 | GBM_BO_USE_SW_WRITE_RARELY = (1 << 12), |
Kristian H. Kristensen | 3cb5bba | 2018-04-04 16:10:42 -0700 | [diff] [blame] | 272 | /** |
| 273 | * The buffer will be written by a video decode accelerator. |
| 274 | */ |
| 275 | GBM_BO_USE_HW_VIDEO_DECODER = (1 << 13), |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 276 | }; |
| 277 | |
| 278 | int |
| 279 | gbm_device_get_fd(struct gbm_device *gbm); |
| 280 | |
| 281 | const char * |
| 282 | gbm_device_get_backend_name(struct gbm_device *gbm); |
| 283 | |
| 284 | int |
| 285 | gbm_device_is_format_supported(struct gbm_device *gbm, |
| 286 | uint32_t format, uint32_t usage); |
| 287 | |
| 288 | void |
| 289 | gbm_device_destroy(struct gbm_device *gbm); |
| 290 | |
| 291 | struct gbm_device * |
| 292 | gbm_create_device(int fd); |
| 293 | |
| 294 | struct gbm_bo * |
| 295 | gbm_bo_create(struct gbm_device *gbm, |
| 296 | uint32_t width, uint32_t height, |
| 297 | uint32_t format, uint32_t flags); |
| 298 | |
Kristian H. Kristensen | b1efbd8 | 2016-09-06 11:43:26 -0700 | [diff] [blame] | 299 | struct gbm_bo * |
| 300 | gbm_bo_create_with_modifiers(struct gbm_device *gbm, |
| 301 | uint32_t width, uint32_t height, |
| 302 | uint32_t format, |
| 303 | const uint64_t *modifiers, uint32_t count); |
| 304 | |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 305 | #define GBM_BO_IMPORT_WL_BUFFER 0x5501 |
| 306 | #define GBM_BO_IMPORT_EGL_IMAGE 0x5502 |
| 307 | #define GBM_BO_IMPORT_FD 0x5503 |
Kristian H. Kristensen | 3345977 | 2016-09-16 11:14:16 -0700 | [diff] [blame] | 308 | #define GBM_BO_IMPORT_FD_PLANAR 0x5504 |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 309 | |
| 310 | struct gbm_import_fd_data { |
| 311 | int fd; |
| 312 | uint32_t width; |
| 313 | uint32_t height; |
| 314 | uint32_t stride; |
| 315 | uint32_t format; |
| 316 | }; |
| 317 | |
Kristian H. Kristensen | 3345977 | 2016-09-16 11:14:16 -0700 | [diff] [blame] | 318 | struct gbm_import_fd_planar_data { |
| 319 | int fds[GBM_MAX_PLANES]; |
| 320 | uint32_t width; |
| 321 | uint32_t height; |
| 322 | uint32_t format; |
| 323 | uint32_t strides[GBM_MAX_PLANES]; |
| 324 | uint32_t offsets[GBM_MAX_PLANES]; |
| 325 | uint64_t format_modifiers[GBM_MAX_PLANES]; |
| 326 | }; |
| 327 | |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 328 | struct gbm_bo * |
| 329 | gbm_bo_import(struct gbm_device *gbm, uint32_t type, |
| 330 | void *buffer, uint32_t usage); |
| 331 | |
Gurchetan Singh | 5753c31 | 2016-10-05 15:16:22 -0700 | [diff] [blame] | 332 | /** |
| 333 | * Flags to indicate the type of mapping for the buffer - these are |
| 334 | * passed into gbm_bo_map(). The caller must set the union of all the |
| 335 | * flags that are appropriate. |
| 336 | * |
| 337 | * These flags are independent of the GBM_BO_USE_* creation flags. However, |
| 338 | * mapping the buffer may require copying to/from a staging buffer. |
| 339 | * |
| 340 | * See also: pipe_transfer_usage |
| 341 | */ |
| 342 | enum gbm_bo_transfer_flags { |
| 343 | /** |
| 344 | * Buffer contents read back (or accessed directly) at transfer |
| 345 | * create time. |
| 346 | */ |
| 347 | GBM_BO_TRANSFER_READ = (1 << 0), |
| 348 | /** |
| 349 | * Buffer contents will be written back at unmap time |
| 350 | * (or modified as a result of being accessed directly). |
| 351 | */ |
| 352 | GBM_BO_TRANSFER_WRITE = (1 << 1), |
| 353 | /** |
| 354 | * Read/modify/write |
| 355 | */ |
| 356 | GBM_BO_TRANSFER_READ_WRITE = (GBM_BO_TRANSFER_READ | GBM_BO_TRANSFER_WRITE), |
| 357 | }; |
| 358 | |
| 359 | void * |
| 360 | gbm_bo_map(struct gbm_bo *bo, |
| 361 | uint32_t x, uint32_t y, uint32_t width, uint32_t height, |
| 362 | uint32_t flags, uint32_t *stride, void **map_data, size_t plane); |
| 363 | |
| 364 | void |
| 365 | gbm_bo_unmap(struct gbm_bo *bo, void *map_data); |
| 366 | |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 367 | uint32_t |
| 368 | gbm_bo_get_width(struct gbm_bo *bo); |
| 369 | |
| 370 | uint32_t |
| 371 | gbm_bo_get_height(struct gbm_bo *bo); |
| 372 | |
| 373 | uint32_t |
| 374 | gbm_bo_get_stride(struct gbm_bo *bo); |
| 375 | |
Lauri Peltonen | 7842d8f | 2014-12-17 23:01:37 -0800 | [diff] [blame] | 376 | /* Tegra bringup hack to pass tiling parameters at EGLImage creation. */ |
| 377 | uint32_t |
| 378 | gbm_bo_get_stride_or_tiling(struct gbm_bo *bo); |
| 379 | |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 380 | uint32_t |
| 381 | gbm_bo_get_format(struct gbm_bo *bo); |
| 382 | |
Maksim Sisov | 79205a5 | 2018-08-03 16:31:20 +0300 | [diff] [blame] | 383 | /* Deprecated */ |
Vince Hsu | a6878fe | 2016-05-23 10:32:25 +0800 | [diff] [blame] | 384 | uint64_t |
| 385 | gbm_bo_get_format_modifier(struct gbm_bo *bo); |
| 386 | |
Maksim Sisov | 79205a5 | 2018-08-03 16:31:20 +0300 | [diff] [blame] | 387 | uint64_t |
| 388 | gbm_bo_get_modifier(struct gbm_bo *bo); |
| 389 | |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 390 | struct gbm_device * |
| 391 | gbm_bo_get_device(struct gbm_bo *bo); |
| 392 | |
| 393 | union gbm_bo_handle |
| 394 | gbm_bo_get_handle(struct gbm_bo *bo); |
| 395 | |
| 396 | int |
| 397 | gbm_bo_get_fd(struct gbm_bo *bo); |
| 398 | |
Maksim Sisov | 79205a5 | 2018-08-03 16:31:20 +0300 | [diff] [blame] | 399 | /* Deprecated */ |
Yuly Novikov | 96c7a3b | 2015-12-08 22:48:29 -0500 | [diff] [blame] | 400 | size_t |
| 401 | gbm_bo_get_num_planes(struct gbm_bo *bo); |
| 402 | |
Maksim Sisov | 79205a5 | 2018-08-03 16:31:20 +0300 | [diff] [blame] | 403 | size_t |
| 404 | gbm_bo_get_plane_count(struct gbm_bo *bo); |
| 405 | |
Maksim Sisov | ff1ecaf | 2018-08-10 14:53:34 +0300 | [diff] [blame] | 406 | /* Deprecated */ |
Yuly Novikov | 96c7a3b | 2015-12-08 22:48:29 -0500 | [diff] [blame] | 407 | union gbm_bo_handle |
| 408 | gbm_bo_get_plane_handle(struct gbm_bo *bo, size_t plane); |
| 409 | |
Maksim Sisov | ff1ecaf | 2018-08-10 14:53:34 +0300 | [diff] [blame] | 410 | union gbm_bo_handle |
| 411 | gbm_bo_get_handle_for_plane(struct gbm_bo* bo, size_t plane); |
| 412 | |
Yuly Novikov | 96c7a3b | 2015-12-08 22:48:29 -0500 | [diff] [blame] | 413 | int |
| 414 | gbm_bo_get_plane_fd(struct gbm_bo *bo, size_t plane); |
| 415 | |
Maksim Sisov | 79205a5 | 2018-08-03 16:31:20 +0300 | [diff] [blame] | 416 | /* Deprecated */ |
Yuly Novikov | 96c7a3b | 2015-12-08 22:48:29 -0500 | [diff] [blame] | 417 | uint32_t |
| 418 | gbm_bo_get_plane_offset(struct gbm_bo *bo, size_t plane); |
| 419 | |
| 420 | uint32_t |
Maksim Sisov | 79205a5 | 2018-08-03 16:31:20 +0300 | [diff] [blame] | 421 | gbm_bo_get_offset(struct gbm_bo *bo, size_t plane); |
Yuly Novikov | 96c7a3b | 2015-12-08 22:48:29 -0500 | [diff] [blame] | 422 | |
| 423 | uint32_t |
Maksim Sisov | 79205a5 | 2018-08-03 16:31:20 +0300 | [diff] [blame] | 424 | gbm_bo_get_plane_size(struct gbm_bo *bo, size_t plane); |
| 425 | |
| 426 | /* Deprecated */ |
| 427 | uint32_t |
Yuly Novikov | 96c7a3b | 2015-12-08 22:48:29 -0500 | [diff] [blame] | 428 | gbm_bo_get_plane_stride(struct gbm_bo *bo, size_t plane); |
| 429 | |
Maksim Sisov | 79205a5 | 2018-08-03 16:31:20 +0300 | [diff] [blame] | 430 | uint32_t |
| 431 | gbm_bo_get_stride_for_plane(struct gbm_bo *bo, size_t plane); |
| 432 | |
Vince Hsu | a6878fe | 2016-05-23 10:32:25 +0800 | [diff] [blame] | 433 | uint64_t |
| 434 | gbm_bo_get_plane_format_modifier(struct gbm_bo *bo, size_t plane); |
| 435 | |
Stéphane Marchesin | 25a2606 | 2014-09-12 16:18:59 -0700 | [diff] [blame] | 436 | void |
| 437 | gbm_bo_set_user_data(struct gbm_bo *bo, void *data, |
| 438 | void (*destroy_user_data)(struct gbm_bo *, void *)); |
| 439 | |
| 440 | void * |
| 441 | gbm_bo_get_user_data(struct gbm_bo *bo); |
| 442 | |
| 443 | void |
| 444 | gbm_bo_destroy(struct gbm_bo *bo); |
| 445 | |
| 446 | struct gbm_surface * |
| 447 | gbm_surface_create(struct gbm_device *gbm, |
| 448 | uint32_t width, uint32_t height, |
| 449 | uint32_t format, uint32_t flags); |
| 450 | |
| 451 | struct gbm_bo * |
| 452 | gbm_surface_lock_front_buffer(struct gbm_surface *surface); |
| 453 | |
| 454 | void |
| 455 | gbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo); |
| 456 | |
| 457 | int |
| 458 | gbm_surface_has_free_buffers(struct gbm_surface *surface); |
| 459 | |
| 460 | void |
| 461 | gbm_surface_destroy(struct gbm_surface *surface); |
| 462 | |
| 463 | #ifdef __cplusplus |
| 464 | } |
| 465 | #endif |
| 466 | |
| 467 | #endif |