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