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, EXPRESS OR 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 18 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 21 * OTHER DEALINGS IN THE SOFTWARE. 22 */ 23 24 #ifndef DRM_FOURCC_H 25 #define DRM_FOURCC_H 26 27 #include "drm.h" 28 29 #define fourcc_code(a, b, c, d) ((__u32)(a) | ((__u32)(b) << 8) | \ 30 ((__u32)(c) << 16) | ((__u32)(d) << 24)) 31 32 #define DRM_FORMAT_BIG_ENDIAN (1<<31) /* format is big endian instead of little endian */ 33 34 /* color index */ 35 #define DRM_FORMAT_C8 fourcc_code('C', '8', ' ', ' ') /* [7:0] C */ 36 37 /* 8 bpp Red */ 38 #define DRM_FORMAT_R8 fourcc_code('R', '8', ' ', ' ') /* [7:0] R */ 39 40 /* 16 bpp RG */ 41 #define DRM_FORMAT_RG88 fourcc_code('R', 'G', '8', '8') /* [15:0] R:G 8:8 little endian */ 42 #define DRM_FORMAT_GR88 fourcc_code('G', 'R', '8', '8') /* [15:0] G:R 8:8 little endian */ 43 44 /* 8 bpp RGB */ 45 #define DRM_FORMAT_RGB332 fourcc_code('R', 'G', 'B', '8') /* [7:0] R:G:B 3:3:2 */ 46 #define DRM_FORMAT_BGR233 fourcc_code('B', 'G', 'R', '8') /* [7:0] B:G:R 2:3:3 */ 47 48 /* 16 bpp RGB */ 49 #define DRM_FORMAT_XRGB4444 fourcc_code('X', 'R', '1', '2') /* [15:0] x:R:G:B 4:4:4:4 little endian */ 50 #define DRM_FORMAT_XBGR4444 fourcc_code('X', 'B', '1', '2') /* [15:0] x:B:G:R 4:4:4:4 little endian */ 51 #define DRM_FORMAT_RGBX4444 fourcc_code('R', 'X', '1', '2') /* [15:0] R:G:B:x 4:4:4:4 little endian */ 52 #define DRM_FORMAT_BGRX4444 fourcc_code('B', 'X', '1', '2') /* [15:0] B:G:R:x 4:4:4:4 little endian */ 53 54 #define DRM_FORMAT_ARGB4444 fourcc_code('A', 'R', '1', '2') /* [15:0] A:R:G:B 4:4:4:4 little endian */ 55 #define DRM_FORMAT_ABGR4444 fourcc_code('A', 'B', '1', '2') /* [15:0] A:B:G:R 4:4:4:4 little endian */ 56 #define DRM_FORMAT_RGBA4444 fourcc_code('R', 'A', '1', '2') /* [15:0] R:G:B:A 4:4:4:4 little endian */ 57 #define DRM_FORMAT_BGRA4444 fourcc_code('B', 'A', '1', '2') /* [15:0] B:G:R:A 4:4:4:4 little endian */ 58 59 #define DRM_FORMAT_XRGB1555 fourcc_code('X', 'R', '1', '5') /* [15:0] x:R:G:B 1:5:5:5 little endian */ 60 #define DRM_FORMAT_XBGR1555 fourcc_code('X', 'B', '1', '5') /* [15:0] x:B:G:R 1:5:5:5 little endian */ 61 #define DRM_FORMAT_RGBX5551 fourcc_code('R', 'X', '1', '5') /* [15:0] R:G:B:x 5:5:5:1 little endian */ 62 #define DRM_FORMAT_BGRX5551 fourcc_code('B', 'X', '1', '5') /* [15:0] B:G:R:x 5:5:5:1 little endian */ 63 64 #define DRM_FORMAT_ARGB1555 fourcc_code('A', 'R', '1', '5') /* [15:0] A:R:G:B 1:5:5:5 little endian */ 65 #define DRM_FORMAT_ABGR1555 fourcc_code('A', 'B', '1', '5') /* [15:0] A:B:G:R 1:5:5:5 little endian */ 66 #define DRM_FORMAT_RGBA5551 fourcc_code('R', 'A', '1', '5') /* [15:0] R:G:B:A 5:5:5:1 little endian */ 67 #define DRM_FORMAT_BGRA5551 fourcc_code('B', 'A', '1', '5') /* [15:0] B:G:R:A 5:5:5:1 little endian */ 68 69 #define DRM_FORMAT_RGB565 fourcc_code('R', 'G', '1', '6') /* [15:0] R:G:B 5:6:5 little endian */ 70 #define DRM_FORMAT_BGR565 fourcc_code('B', 'G', '1', '6') /* [15:0] B:G:R 5:6:5 little endian */ 71 72 /* 24 bpp RGB */ 73 #define DRM_FORMAT_RGB888 fourcc_code('R', 'G', '2', '4') /* [23:0] R:G:B little endian */ 74 #define DRM_FORMAT_BGR888 fourcc_code('B', 'G', '2', '4') /* [23:0] B:G:R little endian */ 75 76 /* 32 bpp RGB */ 77 #define DRM_FORMAT_XRGB8888 fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */ 78 #define DRM_FORMAT_XBGR8888 fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */ 79 #define DRM_FORMAT_RGBX8888 fourcc_code('R', 'X', '2', '4') /* [31:0] R:G:B:x 8:8:8:8 little endian */ 80 #define DRM_FORMAT_BGRX8888 fourcc_code('B', 'X', '2', '4') /* [31:0] B:G:R:x 8:8:8:8 little endian */ 81 82 #define DRM_FORMAT_ARGB8888 fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */ 83 #define DRM_FORMAT_ABGR8888 fourcc_code('A', 'B', '2', '4') /* [31:0] A:B:G:R 8:8:8:8 little endian */ 84 #define DRM_FORMAT_RGBA8888 fourcc_code('R', 'A', '2', '4') /* [31:0] R:G:B:A 8:8:8:8 little endian */ 85 #define DRM_FORMAT_BGRA8888 fourcc_code('B', 'A', '2', '4') /* [31:0] B:G:R:A 8:8:8:8 little endian */ 86 87 #define DRM_FORMAT_XRGB2101010 fourcc_code('X', 'R', '3', '0') /* [31:0] x:R:G:B 2:10:10:10 little endian */ 88 #define DRM_FORMAT_XBGR2101010 fourcc_code('X', 'B', '3', '0') /* [31:0] x:B:G:R 2:10:10:10 little endian */ 89 #define DRM_FORMAT_RGBX1010102 fourcc_code('R', 'X', '3', '0') /* [31:0] R:G:B:x 10:10:10:2 little endian */ 90 #define DRM_FORMAT_BGRX1010102 fourcc_code('B', 'X', '3', '0') /* [31:0] B:G:R:x 10:10:10:2 little endian */ 91 92 #define DRM_FORMAT_ARGB2101010 fourcc_code('A', 'R', '3', '0') /* [31:0] A:R:G:B 2:10:10:10 little endian */ 93 #define DRM_FORMAT_ABGR2101010 fourcc_code('A', 'B', '3', '0') /* [31:0] A:B:G:R 2:10:10:10 little endian */ 94 #define DRM_FORMAT_RGBA1010102 fourcc_code('R', 'A', '3', '0') /* [31:0] R:G:B:A 10:10:10:2 little endian */ 95 #define DRM_FORMAT_BGRA1010102 fourcc_code('B', 'A', '3', '0') /* [31:0] B:G:R:A 10:10:10:2 little endian */ 96 97 /* packed YCbCr */ 98 #define DRM_FORMAT_YUYV fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */ 99 #define DRM_FORMAT_YVYU fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */ 100 #define DRM_FORMAT_UYVY fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */ 101 #define DRM_FORMAT_VYUY fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */ 102 103 #define DRM_FORMAT_AYUV fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */ 104 105 /* 106 * 2 plane YCbCr 107 * index 0 = Y plane, [7:0] Y 108 * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian 109 * or 110 * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian 111 */ 112 #define DRM_FORMAT_NV12 fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */ 113 #define DRM_FORMAT_NV21 fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */ 114 #define DRM_FORMAT_NV16 fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */ 115 #define DRM_FORMAT_NV61 fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */ 116 #define DRM_FORMAT_NV24 fourcc_code('N', 'V', '2', '4') /* non-subsampled Cr:Cb plane */ 117 #define DRM_FORMAT_NV42 fourcc_code('N', 'V', '4', '2') /* non-subsampled Cb:Cr plane */ 118 119 /* 120 * 3 plane YCbCr 121 * index 0: Y plane, [7:0] Y 122 * index 1: Cb plane, [7:0] Cb 123 * index 2: Cr plane, [7:0] Cr 124 * or 125 * index 1: Cr plane, [7:0] Cr 126 * index 2: Cb plane, [7:0] Cb 127 */ 128 #define DRM_FORMAT_YUV410 fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */ 129 #define DRM_FORMAT_YVU410 fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */ 130 #define DRM_FORMAT_YUV411 fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */ 131 #define DRM_FORMAT_YVU411 fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */ 132 #define DRM_FORMAT_YUV420 fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */ 133 #define DRM_FORMAT_YVU420 fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */ 134 #define DRM_FORMAT_YUV422 fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */ 135 #define DRM_FORMAT_YVU422 fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */ 136 #define DRM_FORMAT_YUV444 fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */ 137 #define DRM_FORMAT_YVU444 fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */ 138 139 140 /* 141 * Format Modifiers: 142 * 143 * Format modifiers describe, typically, a re-ordering or modification 144 * of the data in a plane of an FB. This can be used to express tiled/ 145 * swizzled formats, or compression, or a combination of the two. 146 * 147 * The upper 8 bits of the format modifier are a vendor-id as assigned 148 * below. The lower 56 bits are assigned as vendor sees fit. 149 */ 150 151 /* Vendor Ids: */ 152 #define DRM_FORMAT_MOD_NONE 0 153 #define DRM_FORMAT_MOD_VENDOR_NONE 0 154 #define DRM_FORMAT_MOD_VENDOR_INTEL 0x01 155 #define DRM_FORMAT_MOD_VENDOR_AMD 0x02 156 #define DRM_FORMAT_MOD_VENDOR_NV 0x03 157 #define DRM_FORMAT_MOD_VENDOR_SAMSUNG 0x04 158 #define DRM_FORMAT_MOD_VENDOR_QCOM 0x05 159 /* add more to the end as needed */ 160 161 #define fourcc_mod_code(vendor, val) \ 162 ((((__u64)DRM_FORMAT_MOD_VENDOR_## vendor) << 56) | (val & 0x00ffffffffffffffULL)) 163 164 /* 165 * Format Modifier tokens: 166 * 167 * When adding a new token please document the layout with a code comment, 168 * similar to the fourcc codes above. drm_fourcc.h is considered the 169 * authoritative source for all of these. 170 */ 171 172 /* Intel framebuffer modifiers */ 173 174 /* 175 * Intel X-tiling layout 176 * 177 * This is a tiled layout using 4Kb tiles (except on gen2 where the tiles 2Kb) 178 * in row-major layout. Within the tile bytes are laid out row-major, with 179 * a platform-dependent stride. On top of that the memory can apply 180 * platform-depending swizzling of some higher address bits into bit6. 181 * 182 * This format is highly platforms specific and not useful for cross-driver 183 * sharing. It exists since on a given platform it does uniquely identify the 184 * layout in a simple way for i915-specific userspace. 185 */ 186 #define I915_FORMAT_MOD_X_TILED fourcc_mod_code(INTEL, 1) 187 188 /* 189 * Intel Y-tiling layout 190 * 191 * This is a tiled layout using 4Kb tiles (except on gen2 where the tiles 2Kb) 192 * in row-major layout. Within the tile bytes are laid out in OWORD (16 bytes) 193 * chunks column-major, with a platform-dependent height. On top of that the 194 * memory can apply platform-depending swizzling of some higher address bits 195 * into bit6. 196 * 197 * This format is highly platforms specific and not useful for cross-driver 198 * sharing. It exists since on a given platform it does uniquely identify the 199 * layout in a simple way for i915-specific userspace. 200 */ 201 #define I915_FORMAT_MOD_Y_TILED fourcc_mod_code(INTEL, 2) 202 203 /* 204 * Intel Yf-tiling layout 205 * 206 * This is a tiled layout using 4Kb tiles in row-major layout. 207 * Within the tile pixels are laid out in 16 256 byte units / sub-tiles which 208 * are arranged in four groups (two wide, two high) with column-major layout. 209 * Each group therefore consits out of four 256 byte units, which are also laid 210 * out as 2x2 column-major. 211 * 256 byte units are made out of four 64 byte blocks of pixels, producing 212 * either a square block or a 2:1 unit. 213 * 64 byte blocks of pixels contain four pixel rows of 16 bytes, where the width 214 * in pixel depends on the pixel depth. 215 */ 216 #define I915_FORMAT_MOD_Yf_TILED fourcc_mod_code(INTEL, 3) 217 218 /* 219 * Tiled, NV12MT, grouped in 64 (pixels) x 32 (lines) -sized macroblocks 220 * 221 * Macroblocks are laid in a Z-shape, and each pixel data is following the 222 * standard NV12 style. 223 * As for NV12, an image is the result of two frame buffers: one for Y, 224 * one for the interleaved Cb/Cr components (1/2 the height of the Y buffer). 225 * Alignment requirements are (for each buffer): 226 * - multiple of 128 pixels for the width 227 * - multiple of 32 pixels for the height 228 * 229 * For more information: see https://linuxtv.org/downloads/v4l-dvb-apis/re32.html 230 */ 231 #define DRM_FORMAT_MOD_SAMSUNG_64_32_TILE fourcc_mod_code(SAMSUNG, 1) 232 233 #endif /* DRM_FOURCC_H */ 234