drivers/gpu/drm/drm_fourcc.c

   1 /*
   2  * Copyright (c) 2016 Laurent Pinchart <[email protected]>
   3  *
   4  * DRM core format related functions
   5  *
   6  * Permission to use, copy, modify, distribute, and sell this software and its
   7  * documentation for any purpose is hereby granted without fee, provided that
   8  * the above copyright notice appear in all copies and that both that copyright
   9  * notice and this permission notice appear in supporting documentation, and
  10  * that the name of the copyright holders not be used in advertising or
  11  * publicity pertaining to distribution of the software without specific,
  12  * written prior permission.  The copyright holders make no representations
  13  * about the suitability of this software for any purpose.  It is provided "as
  14  * is" without express or implied warranty.
  15  *
  16  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  19  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  20  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  21  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  22  * OF THIS SOFTWARE.
  23  */
  24
  25 #include <linux/bug.h>
  26 #include <linux/ctype.h>
  27 #include <linux/export.h>
  28 #include <linux/kernel.h>
  29
  30 #include <drm/drm_device.h>
  31 #include <drm/drm_fourcc.h>
  32
  33 /**
  34  * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
  35  * @bpp: bits per pixels
  36  * @depth: bit depth per pixel
  37  *
  38  * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
  39  * Useful in fbdev emulation code, since that deals in those values.
  40  */
  41 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
  42 {
  43         uint32_t fmt = DRM_FORMAT_INVALID;
  44
  45         switch (bpp) {
  46         case 8:
  47                 if (depth == 8)
  48                         fmt = DRM_FORMAT_C8;
  49                 break;
  50
  51         case 16:
  52                 switch (depth) {
  53                 case 15:
  54                         fmt = DRM_FORMAT_XRGB1555;
  55                         break;
  56                 case 16:
  57                         fmt = DRM_FORMAT_RGB565;
  58                         break;
  59                 default:
  60                         break;
  61                 }
  62                 break;
  63
  64         case 24:
  65                 if (depth == 24)
  66                         fmt = DRM_FORMAT_RGB888;
  67                 break;
  68
  69         case 32:
  70                 switch (depth) {
  71                 case 24:
  72                         fmt = DRM_FORMAT_XRGB8888;
  73                         break;
  74                 case 30:
  75                         fmt = DRM_FORMAT_XRGB2101010;
  76                         break;
  77                 case 32:
  78                         fmt = DRM_FORMAT_ARGB8888;
  79                         break;
  80                 default:
  81                         break;
  82                 }
  83                 break;
  84
  85         default:
  86                 break;
  87         }
  88
  89         return fmt;
  90 }
  91 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
  92
  93 /**
  94  * drm_driver_legacy_fb_format - compute drm fourcc code from legacy description
  95  * @dev: DRM device
  96  * @bpp: bits per pixels
  97  * @depth: bit depth per pixel
  98  *
  99  * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
 100  * Unlike drm_mode_legacy_fb_format() this looks at the drivers mode_config,
 101  * and depending on the &drm_mode_config.quirk_addfb_prefer_host_byte_order flag
 102  * it returns little endian byte order or host byte order framebuffer formats.
 103  */
 104 uint32_t drm_driver_legacy_fb_format(struct drm_device *dev,
 105                                      uint32_t bpp, uint32_t depth)
 106 {
 107         uint32_t fmt = drm_mode_legacy_fb_format(bpp, depth);
 108
 109         if (dev->mode_config.quirk_addfb_prefer_host_byte_order) {
 110                 if (fmt == DRM_FORMAT_XRGB8888)
 111                         fmt = DRM_FORMAT_HOST_XRGB8888;
 112                 if (fmt == DRM_FORMAT_ARGB8888)
 113                         fmt = DRM_FORMAT_HOST_ARGB8888;
 114                 if (fmt == DRM_FORMAT_RGB565)
 115                         fmt = DRM_FORMAT_HOST_RGB565;
 116                 if (fmt == DRM_FORMAT_XRGB1555)
 117                         fmt = DRM_FORMAT_HOST_XRGB1555;
 118         }
 119
 120         if (dev->mode_config.quirk_addfb_prefer_xbgr_30bpp &&
 121             fmt == DRM_FORMAT_XRGB2101010)
 122                 fmt = DRM_FORMAT_XBGR2101010;
 123
 124         return fmt;
 125 }
 126 EXPORT_SYMBOL(drm_driver_legacy_fb_format);
 127
 128 /*
 129  * Internal function to query information for a given format. See
 130  * drm_format_info() for the public API.
 131  */
 132 const struct drm_format_info *__drm_format_info(u32 format)
 133 {
 134         static const struct drm_format_info formats[] = {
 135                 { .format = DRM_FORMAT_C8,              .depth = 8,  .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
 136                 { .format = DRM_FORMAT_RGB332,          .depth = 8,  .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
 137                 { .format = DRM_FORMAT_BGR233,          .depth = 8,  .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
 138                 { .format = DRM_FORMAT_XRGB4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 139                 { .format = DRM_FORMAT_XBGR4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 140                 { .format = DRM_FORMAT_RGBX4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 141                 { .format = DRM_FORMAT_BGRX4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 142                 { .format = DRM_FORMAT_ARGB4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 143                 { .format = DRM_FORMAT_ABGR4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 144                 { .format = DRM_FORMAT_RGBA4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 145                 { .format = DRM_FORMAT_BGRA4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 146                 { .format = DRM_FORMAT_XRGB1555,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 147                 { .format = DRM_FORMAT_XBGR1555,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 148                 { .format = DRM_FORMAT_RGBX5551,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 149                 { .format = DRM_FORMAT_BGRX5551,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 150                 { .format = DRM_FORMAT_ARGB1555,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 151                 { .format = DRM_FORMAT_ABGR1555,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 152                 { .format = DRM_FORMAT_RGBA5551,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 153                 { .format = DRM_FORMAT_BGRA5551,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 154                 { .format = DRM_FORMAT_RGB565,          .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 155                 { .format = DRM_FORMAT_BGR565,          .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 156                 { .format = DRM_FORMAT_RGB888,          .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 },
 157                 { .format = DRM_FORMAT_BGR888,          .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 },
 158                 { .format = DRM_FORMAT_XRGB8888,        .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 159                 { .format = DRM_FORMAT_XBGR8888,        .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 160                 { .format = DRM_FORMAT_RGBX8888,        .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 161                 { .format = DRM_FORMAT_BGRX8888,        .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 162                 { .format = DRM_FORMAT_RGB565_A8,       .depth = 24, .num_planes = 2, .cpp = { 2, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 163                 { .format = DRM_FORMAT_BGR565_A8,       .depth = 24, .num_planes = 2, .cpp = { 2, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 164                 { .format = DRM_FORMAT_XRGB2101010,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 165                 { .format = DRM_FORMAT_XBGR2101010,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 166                 { .format = DRM_FORMAT_RGBX1010102,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 167                 { .format = DRM_FORMAT_BGRX1010102,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 168                 { .format = DRM_FORMAT_ARGB2101010,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 169                 { .format = DRM_FORMAT_ABGR2101010,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 170                 { .format = DRM_FORMAT_RGBA1010102,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 171                 { .format = DRM_FORMAT_BGRA1010102,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 172                 { .format = DRM_FORMAT_ARGB8888,        .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 173                 { .format = DRM_FORMAT_ABGR8888,        .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 174                 { .format = DRM_FORMAT_RGBA8888,        .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 175                 { .format = DRM_FORMAT_BGRA8888,        .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 176                 { .format = DRM_FORMAT_XRGB16161616F,   .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
 177                 { .format = DRM_FORMAT_XBGR16161616F,   .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
 178                 { .format = DRM_FORMAT_ARGB16161616F,   .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 179                 { .format = DRM_FORMAT_ABGR16161616F,   .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 180                 { .format = DRM_FORMAT_AXBXGXRX106106106106, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 181                 { .format = DRM_FORMAT_RGB888_A8,       .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 182                 { .format = DRM_FORMAT_BGR888_A8,       .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 183                 { .format = DRM_FORMAT_XRGB8888_A8,     .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 184                 { .format = DRM_FORMAT_XBGR8888_A8,     .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 185                 { .format = DRM_FORMAT_RGBX8888_A8,     .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 186                 { .format = DRM_FORMAT_BGRX8888_A8,     .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 187                 { .format = DRM_FORMAT_YUV410,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
 188                 { .format = DRM_FORMAT_YVU410,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
 189                 { .format = DRM_FORMAT_YUV411,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
 190                 { .format = DRM_FORMAT_YVU411,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
 191                 { .format = DRM_FORMAT_YUV420,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
 192                 { .format = DRM_FORMAT_YVU420,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
 193                 { .format = DRM_FORMAT_YUV422,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 194                 { .format = DRM_FORMAT_YVU422,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 195                 { .format = DRM_FORMAT_YUV444,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 196                 { .format = DRM_FORMAT_YVU444,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 197                 { .format = DRM_FORMAT_NV12,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
 198                 { .format = DRM_FORMAT_NV21,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
 199                 { .format = DRM_FORMAT_NV16,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 200                 { .format = DRM_FORMAT_NV61,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 201                 { .format = DRM_FORMAT_NV24,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 202                 { .format = DRM_FORMAT_NV42,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 203                 { .format = DRM_FORMAT_YUYV,            .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 204                 { .format = DRM_FORMAT_YVYU,            .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 205                 { .format = DRM_FORMAT_UYVY,            .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 206                 { .format = DRM_FORMAT_VYUY,            .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 207                 { .format = DRM_FORMAT_XYUV8888,        .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 208                 { .format = DRM_FORMAT_VUY888,          .depth = 0,  .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 209                 { .format = DRM_FORMAT_AYUV,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
 210                 { .format = DRM_FORMAT_Y210,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 211                 { .format = DRM_FORMAT_Y212,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 212                 { .format = DRM_FORMAT_Y216,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 213                 { .format = DRM_FORMAT_Y410,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
 214                 { .format = DRM_FORMAT_Y412,            .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
 215                 { .format = DRM_FORMAT_Y416,            .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
 216                 { .format = DRM_FORMAT_XVYU2101010,     .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 217                 { .format = DRM_FORMAT_XVYU12_16161616, .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 218                 { .format = DRM_FORMAT_XVYU16161616,    .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 219                 { .format = DRM_FORMAT_Y0L0,            .depth = 0,  .num_planes = 1,
 220                   .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
 221                   .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
 222                 { .format = DRM_FORMAT_X0L0,            .depth = 0,  .num_planes = 1,
 223                   .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
 224                   .hsub = 2, .vsub = 2, .is_yuv = true },
 225                 { .format = DRM_FORMAT_Y0L2,            .depth = 0,  .num_planes = 1,
 226                   .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
 227                   .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
 228                 { .format = DRM_FORMAT_X0L2,            .depth = 0,  .num_planes = 1,
 229                   .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
 230                   .hsub = 2, .vsub = 2, .is_yuv = true },
 231                 { .format = DRM_FORMAT_P010,            .depth = 0,  .num_planes = 2,
 232                   .char_per_block = { 2, 4, 0 }, .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 },
 233                   .hsub = 2, .vsub = 2, .is_yuv = true},
 234                 { .format = DRM_FORMAT_P012,            .depth = 0,  .num_planes = 2,
 235                   .char_per_block = { 2, 4, 0 }, .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 },
 236                    .hsub = 2, .vsub = 2, .is_yuv = true},
 237                 { .format = DRM_FORMAT_P016,            .depth = 0,  .num_planes = 2,
 238                   .char_per_block = { 2, 4, 0 }, .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 },
 239                   .hsub = 2, .vsub = 2, .is_yuv = true},
 240                 { .format = DRM_FORMAT_P210,            .depth = 0,
 241                   .num_planes = 2, .char_per_block = { 2, 4, 0 },
 242                   .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 }, .hsub = 2,
 243                   .vsub = 1, .is_yuv = true },
 244                 { .format = DRM_FORMAT_VUY101010,       .depth = 0,
 245                   .num_planes = 1, .cpp = { 0, 0, 0 }, .hsub = 1, .vsub = 1,
 246                   .is_yuv = true },
 247                 { .format = DRM_FORMAT_YUV420_8BIT,     .depth = 0,
 248                   .num_planes = 1, .cpp = { 0, 0, 0 }, .hsub = 2, .vsub = 2,
 249                   .is_yuv = true },
 250                 { .format = DRM_FORMAT_YUV420_10BIT,    .depth = 0,
 251                   .num_planes = 1, .cpp = { 0, 0, 0 }, .hsub = 2, .vsub = 2,
 252                   .is_yuv = true },
 253                 { .format = DRM_FORMAT_NV15,            .depth = 0,
 254                   .num_planes = 2, .char_per_block = { 5, 5, 0 },
 255                   .block_w = { 4, 2, 0 }, .block_h = { 1, 1, 0 }, .hsub = 2,
 256                   .vsub = 2, .is_yuv = true },
 257                 { .format = DRM_FORMAT_Q410,            .depth = 0,
 258                   .num_planes = 3, .char_per_block = { 2, 2, 2 },
 259                   .block_w = { 1, 1, 1 }, .block_h = { 1, 1, 1 }, .hsub = 0,
 260                   .vsub = 0, .is_yuv = true },
 261                 { .format = DRM_FORMAT_Q401,            .depth = 0,
 262                   .num_planes = 3, .char_per_block = { 2, 2, 2 },
 263                   .block_w = { 1, 1, 1 }, .block_h = { 1, 1, 1 }, .hsub = 0,
 264                   .vsub = 0, .is_yuv = true },
 265         };
 266
 267         unsigned int i;
 268
 269         for (i = 0; i < ARRAY_SIZE(formats); ++i) {
 270                 if (formats[i].format == format)
 271                         return &formats[i];
 272         }
 273
 274         return NULL;
 275 }
 276
 277 /**
 278  * drm_format_info - query information for a given format
 279  * @format: pixel format (DRM_FORMAT_*)
 280  *
 281  * The caller should only pass a supported pixel format to this function.
 282  * Unsupported pixel formats will generate a warning in the kernel log.
 283  *
 284  * Returns:
 285  * The instance of struct drm_format_info that describes the pixel format, or
 286  * NULL if the format is unsupported.
 287  */
 288 const struct drm_format_info *drm_format_info(u32 format)
 289 {
 290         const struct drm_format_info *info;
 291
 292         info = __drm_format_info(format);
 293         WARN_ON(!info);
 294         return info;
 295 }
 296 EXPORT_SYMBOL(drm_format_info);
 297
 298 /**
 299  * drm_get_format_info - query information for a given framebuffer configuration
 300  * @dev: DRM device
 301  * @mode_cmd: metadata from the userspace fb creation request
 302  *
 303  * Returns:
 304  * The instance of struct drm_format_info that describes the pixel format, or
 305  * NULL if the format is unsupported.
 306  */
 307 const struct drm_format_info *
 308 drm_get_format_info(struct drm_device *dev,
 309                     const struct drm_mode_fb_cmd2 *mode_cmd)
 310 {
 311         const struct drm_format_info *info = NULL;
 312
 313         if (dev->mode_config.funcs->get_format_info)
 314                 info = dev->mode_config.funcs->get_format_info(mode_cmd);
 315
 316         if (!info)
 317                 info = drm_format_info(mode_cmd->pixel_format);
 318
 319         return info;
 320 }
 321 EXPORT_SYMBOL(drm_get_format_info);
 322
 323 /**
 324  * drm_format_info_block_width - width in pixels of block.
 325  * @info: pixel format info
 326  * @plane: plane index
 327  *
 328  * Returns:
 329  * The width in pixels of a block, depending on the plane index.
 330  */
 331 unsigned int drm_format_info_block_width(const struct drm_format_info *info,
 332                                          int plane)
 333 {
 334         if (!info || plane < 0 || plane >= info->num_planes)
 335                 return 0;
 336
 337         if (!info->block_w[plane])
 338                 return 1;
 339         return info->block_w[plane];
 340 }
 341 EXPORT_SYMBOL(drm_format_info_block_width);
 342
 343 /**
 344  * drm_format_info_block_height - height in pixels of a block
 345  * @info: pixel format info
 346  * @plane: plane index
 347  *
 348  * Returns:
 349  * The height in pixels of a block, depending on the plane index.
 350  */
 351 unsigned int drm_format_info_block_height(const struct drm_format_info *info,
 352                                           int plane)
 353 {
 354         if (!info || plane < 0 || plane >= info->num_planes)
 355                 return 0;
 356
 357         if (!info->block_h[plane])
 358                 return 1;
 359         return info->block_h[plane];
 360 }
 361 EXPORT_SYMBOL(drm_format_info_block_height);
 362
 363 /**
 364  * drm_format_info_min_pitch - computes the minimum required pitch in bytes
 365  * @info: pixel format info
 366  * @plane: plane index
 367  * @buffer_width: buffer width in pixels
 368  *
 369  * Returns:
 370  * The minimum required pitch in bytes for a buffer by taking into consideration
 371  * the pixel format information and the buffer width.
 372  */
 373 uint64_t drm_format_info_min_pitch(const struct drm_format_info *info,
 374                                    int plane, unsigned int buffer_width)
 375 {
 376         if (!info || plane < 0 || plane >= info->num_planes)
 377                 return 0;
 378
 379         return DIV_ROUND_UP_ULL((u64)buffer_width * info->char_per_block[plane],
 380                             drm_format_info_block_width(info, plane) *
 381                             drm_format_info_block_height(info, plane));
 382 }
 383 EXPORT_SYMBOL(drm_format_info_min_pitch);