drivers/gpu/drm/drm_fourcc.c

   1 /*
   2  * Copyright (c) 2016 Laurent Pinchart <laurent.pinchart@ideasonboard.com>
   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/drmP.h>
  31 #include <drm/drm_fourcc.h>
  32
  33 static char printable_char(int c)
  34 {
  35         return isascii(c) && isprint(c) ? c : '?';
  36 }
  37
  38 /**
  39  * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
  40  * @bpp: bits per pixels
  41  * @depth: bit depth per pixel
  42  *
  43  * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
  44  * Useful in fbdev emulation code, since that deals in those values.
  45  */
  46 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
  47 {
  48         uint32_t fmt = DRM_FORMAT_INVALID;
  49
  50         switch (bpp) {
  51         case 8:
  52                 if (depth == 8)
  53                         fmt = DRM_FORMAT_C8;
  54                 break;
  55
  56         case 16:
  57                 switch (depth) {
  58                 case 15:
  59                         fmt = DRM_FORMAT_XRGB1555;
  60                         break;
  61                 case 16:
  62                         fmt = DRM_FORMAT_RGB565;
  63                         break;
  64                 default:
  65                         break;
  66                 }
  67                 break;
  68
  69         case 24:
  70                 if (depth == 24)
  71                         fmt = DRM_FORMAT_RGB888;
  72                 break;
  73
  74         case 32:
  75                 switch (depth) {
  76                 case 24:
  77                         fmt = DRM_FORMAT_XRGB8888;
  78                         break;
  79                 case 30:
  80                         fmt = DRM_FORMAT_XRGB2101010;
  81                         break;
  82                 case 32:
  83                         fmt = DRM_FORMAT_ARGB8888;
  84                         break;
  85                 default:
  86                         break;
  87                 }
  88                 break;
  89
  90         default:
  91                 break;
  92         }
  93
  94         return fmt;
  95 }
  96 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
  97
  98 /**
  99  * drm_driver_legacy_fb_format - compute drm fourcc code from legacy description
 100  * @dev: DRM device
 101  * @bpp: bits per pixels
 102  * @depth: bit depth per pixel
 103  *
 104  * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
 105  * Unlike drm_mode_legacy_fb_format() this looks at the drivers mode_config,
 106  * and depending on the &drm_mode_config.quirk_addfb_prefer_host_byte_order flag
 107  * it returns little endian byte order or host byte order framebuffer formats.
 108  */
 109 uint32_t drm_driver_legacy_fb_format(struct drm_device *dev,
 110                                      uint32_t bpp, uint32_t depth)
 111 {
 112         uint32_t fmt = drm_mode_legacy_fb_format(bpp, depth);
 113
 114         if (dev->mode_config.quirk_addfb_prefer_host_byte_order) {
 115                 if (fmt == DRM_FORMAT_XRGB8888)
 116                         fmt = DRM_FORMAT_HOST_XRGB8888;
 117                 if (fmt == DRM_FORMAT_ARGB8888)
 118                         fmt = DRM_FORMAT_HOST_ARGB8888;
 119                 if (fmt == DRM_FORMAT_RGB565)
 120                         fmt = DRM_FORMAT_HOST_RGB565;
 121                 if (fmt == DRM_FORMAT_XRGB1555)
 122                         fmt = DRM_FORMAT_HOST_XRGB1555;
 123         }
 124
 125         if (dev->mode_config.quirk_addfb_prefer_xbgr_30bpp &&
 126             fmt == DRM_FORMAT_XRGB2101010)
 127                 fmt = DRM_FORMAT_XBGR2101010;
 128
 129         return fmt;
 130 }
 131 EXPORT_SYMBOL(drm_driver_legacy_fb_format);
 132
 133 /**
 134  * drm_get_format_name - fill a string with a drm fourcc format's name
 135  * @format: format to compute name of
 136  * @buf: caller-supplied buffer
 137  */
 138 const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf)
 139 {
 140         snprintf(buf->str, sizeof(buf->str),
 141                  "%c%c%c%c %s-endian (0x%08x)",
 142                  printable_char(format & 0xff),
 143                  printable_char((format >> 8) & 0xff),
 144                  printable_char((format >> 16) & 0xff),
 145                  printable_char((format >> 24) & 0x7f),
 146                  format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
 147                  format);
 148
 149         return buf->str;
 150 }
 151 EXPORT_SYMBOL(drm_get_format_name);
 152
 153 /*
 154  * Internal function to query information for a given format. See
 155  * drm_format_info() for the public API.
 156  */
 157 const struct drm_format_info *__drm_format_info(u32 format)
 158 {
 159         static const struct drm_format_info formats[] = {
 160                 { .format = DRM_FORMAT_C8,              .depth = 8,  .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
 161                 { .format = DRM_FORMAT_RGB332,          .depth = 8,  .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
 162                 { .format = DRM_FORMAT_BGR233,          .depth = 8,  .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
 163                 { .format = DRM_FORMAT_XRGB4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 164                 { .format = DRM_FORMAT_XBGR4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 165                 { .format = DRM_FORMAT_RGBX4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 166                 { .format = DRM_FORMAT_BGRX4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 167                 { .format = DRM_FORMAT_ARGB4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 168                 { .format = DRM_FORMAT_ABGR4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 169                 { .format = DRM_FORMAT_RGBA4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 170                 { .format = DRM_FORMAT_BGRA4444,        .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 171                 { .format = DRM_FORMAT_XRGB1555,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 172                 { .format = DRM_FORMAT_XBGR1555,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 173                 { .format = DRM_FORMAT_RGBX5551,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 174                 { .format = DRM_FORMAT_BGRX5551,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 175                 { .format = DRM_FORMAT_ARGB1555,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 176                 { .format = DRM_FORMAT_ABGR1555,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 177                 { .format = DRM_FORMAT_RGBA5551,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 178                 { .format = DRM_FORMAT_BGRA5551,        .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 179                 { .format = DRM_FORMAT_RGB565,          .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 180                 { .format = DRM_FORMAT_BGR565,          .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
 181                 { .format = DRM_FORMAT_RGB888,          .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 },
 182                 { .format = DRM_FORMAT_BGR888,          .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 },
 183                 { .format = DRM_FORMAT_XRGB8888,        .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 184                 { .format = DRM_FORMAT_XBGR8888,        .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 185                 { .format = DRM_FORMAT_RGBX8888,        .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 186                 { .format = DRM_FORMAT_BGRX8888,        .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 187                 { .format = DRM_FORMAT_RGB565_A8,       .depth = 24, .num_planes = 2, .cpp = { 2, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 188                 { .format = DRM_FORMAT_BGR565_A8,       .depth = 24, .num_planes = 2, .cpp = { 2, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 189                 { .format = DRM_FORMAT_XRGB2101010,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 190                 { .format = DRM_FORMAT_XBGR2101010,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 191                 { .format = DRM_FORMAT_RGBX1010102,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 192                 { .format = DRM_FORMAT_BGRX1010102,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
 193                 { .format = DRM_FORMAT_ARGB2101010,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 194                 { .format = DRM_FORMAT_ABGR2101010,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 195                 { .format = DRM_FORMAT_RGBA1010102,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 196                 { .format = DRM_FORMAT_BGRA1010102,     .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 197                 { .format = DRM_FORMAT_ARGB8888,        .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 198                 { .format = DRM_FORMAT_ABGR8888,        .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 199                 { .format = DRM_FORMAT_RGBA8888,        .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 200                 { .format = DRM_FORMAT_BGRA8888,        .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 201                 { .format = DRM_FORMAT_RGB888_A8,       .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 202                 { .format = DRM_FORMAT_BGR888_A8,       .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 203                 { .format = DRM_FORMAT_XRGB8888_A8,     .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 204                 { .format = DRM_FORMAT_XBGR8888_A8,     .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 205                 { .format = DRM_FORMAT_RGBX8888_A8,     .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 206                 { .format = DRM_FORMAT_BGRX8888_A8,     .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
 207                 { .format = DRM_FORMAT_YUV410,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
 208                 { .format = DRM_FORMAT_YVU410,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
 209                 { .format = DRM_FORMAT_YUV411,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
 210                 { .format = DRM_FORMAT_YVU411,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
 211                 { .format = DRM_FORMAT_YUV420,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
 212                 { .format = DRM_FORMAT_YVU420,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
 213                 { .format = DRM_FORMAT_YUV422,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 214                 { .format = DRM_FORMAT_YVU422,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 215                 { .format = DRM_FORMAT_YUV444,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 216                 { .format = DRM_FORMAT_YVU444,          .depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 217                 { .format = DRM_FORMAT_NV12,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
 218                 { .format = DRM_FORMAT_NV21,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
 219                 { .format = DRM_FORMAT_NV16,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 220                 { .format = DRM_FORMAT_NV61,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 221                 { .format = DRM_FORMAT_NV24,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 222                 { .format = DRM_FORMAT_NV42,            .depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 223                 { .format = DRM_FORMAT_YUYV,            .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 224                 { .format = DRM_FORMAT_YVYU,            .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 225                 { .format = DRM_FORMAT_UYVY,            .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 226                 { .format = DRM_FORMAT_VYUY,            .depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
 227                 { .format = DRM_FORMAT_XYUV8888,        .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
 228                 { .format = DRM_FORMAT_AYUV,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
 229                 { .format = DRM_FORMAT_Y0L0,            .depth = 0,  .num_planes = 1,
 230                   .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
 231                   .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
 232                 { .format = DRM_FORMAT_X0L0,            .depth = 0,  .num_planes = 1,
 233                   .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
 234                   .hsub = 2, .vsub = 2, .is_yuv = true },
 235                 { .format = DRM_FORMAT_Y0L2,            .depth = 0,  .num_planes = 1,
 236                   .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
 237                   .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
 238                 { .format = DRM_FORMAT_X0L2,            .depth = 0,  .num_planes = 1,
 239                   .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
 240                   .hsub = 2, .vsub = 2, .is_yuv = true },
 241                 { .format = DRM_FORMAT_P010,            .depth = 0,  .num_planes = 2,
 242                   .char_per_block = { 2, 4, 0 }, .block_w = { 1, 0, 0 }, .block_h = { 1, 0, 0 },
 243                   .hsub = 2, .vsub = 2, .is_yuv = true},
 244                 { .format = DRM_FORMAT_P012,            .depth = 0,  .num_planes = 2,
 245                   .char_per_block = { 2, 4, 0 }, .block_w = { 1, 0, 0 }, .block_h = { 1, 0, 0 },
 246                    .hsub = 2, .vsub = 2, .is_yuv = true},
 247                 { .format = DRM_FORMAT_P016,            .depth = 0,  .num_planes = 2,
 248                   .char_per_block = { 2, 4, 0 }, .block_w = { 1, 0, 0 }, .block_h = { 1, 0, 0 },
 249                   .hsub = 2, .vsub = 2, .is_yuv = true},
 250         };
 251
 252         unsigned int i;
 253
 254         for (i = 0; i < ARRAY_SIZE(formats); ++i) {
 255                 if (formats[i].format == format)
 256                         return &formats[i];
 257         }
 258
 259         return NULL;
 260 }
 261
 262 /**
 263  * drm_format_info - query information for a given format
 264  * @format: pixel format (DRM_FORMAT_*)
 265  *
 266  * The caller should only pass a supported pixel format to this function.
 267  * Unsupported pixel formats will generate a warning in the kernel log.
 268  *
 269  * Returns:
 270  * The instance of struct drm_format_info that describes the pixel format, or
 271  * NULL if the format is unsupported.
 272  */
 273 const struct drm_format_info *drm_format_info(u32 format)
 274 {
 275         const struct drm_format_info *info;
 276
 277         info = __drm_format_info(format);
 278         WARN_ON(!info);
 279         return info;
 280 }
 281 EXPORT_SYMBOL(drm_format_info);
 282
 283 /**
 284  * drm_get_format_info - query information for a given framebuffer configuration
 285  * @dev: DRM device
 286  * @mode_cmd: metadata from the userspace fb creation request
 287  *
 288  * Returns:
 289  * The instance of struct drm_format_info that describes the pixel format, or
 290  * NULL if the format is unsupported.
 291  */
 292 const struct drm_format_info *
 293 drm_get_format_info(struct drm_device *dev,
 294                     const struct drm_mode_fb_cmd2 *mode_cmd)
 295 {
 296         const struct drm_format_info *info = NULL;
 297
 298         if (dev->mode_config.funcs->get_format_info)
 299                 info = dev->mode_config.funcs->get_format_info(mode_cmd);
 300
 301         if (!info)
 302                 info = drm_format_info(mode_cmd->pixel_format);
 303
 304         return info;
 305 }
 306 EXPORT_SYMBOL(drm_get_format_info);
 307
 308 /**
 309  * drm_format_num_planes - get the number of planes for format
 310  * @format: pixel format (DRM_FORMAT_*)
 311  *
 312  * Returns:
 313  * The number of planes used by the specified pixel format.
 314  */
 315 int drm_format_num_planes(uint32_t format)
 316 {
 317         const struct drm_format_info *info;
 318
 319         info = drm_format_info(format);
 320         return info ? info->num_planes : 1;
 321 }
 322 EXPORT_SYMBOL(drm_format_num_planes);
 323
 324 /**
 325  * drm_format_plane_cpp - determine the bytes per pixel value
 326  * @format: pixel format (DRM_FORMAT_*)
 327  * @plane: plane index
 328  *
 329  * Returns:
 330  * The bytes per pixel value for the specified plane.
 331  */
 332 int drm_format_plane_cpp(uint32_t format, int plane)
 333 {
 334         const struct drm_format_info *info;
 335
 336         info = drm_format_info(format);
 337         if (!info || plane >= info->num_planes)
 338                 return 0;
 339
 340         return info->cpp[plane];
 341 }
 342 EXPORT_SYMBOL(drm_format_plane_cpp);
 343
 344 /**
 345  * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
 346  * @format: pixel format (DRM_FORMAT_*)
 347  *
 348  * Returns:
 349  * The horizontal chroma subsampling factor for the
 350  * specified pixel format.
 351  */
 352 int drm_format_horz_chroma_subsampling(uint32_t format)
 353 {
 354         const struct drm_format_info *info;
 355
 356         info = drm_format_info(format);
 357         return info ? info->hsub : 1;
 358 }
 359 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
 360
 361 /**
 362  * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
 363  * @format: pixel format (DRM_FORMAT_*)
 364  *
 365  * Returns:
 366  * The vertical chroma subsampling factor for the
 367  * specified pixel format.
 368  */
 369 int drm_format_vert_chroma_subsampling(uint32_t format)
 370 {
 371         const struct drm_format_info *info;
 372
 373         info = drm_format_info(format);
 374         return info ? info->vsub : 1;
 375 }
 376 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
 377
 378 /**
 379  * drm_format_plane_width - width of the plane given the first plane
 380  * @width: width of the first plane
 381  * @format: pixel format
 382  * @plane: plane index
 383  *
 384  * Returns:
 385  * The width of @plane, given that the width of the first plane is @width.
 386  */
 387 int drm_format_plane_width(int width, uint32_t format, int plane)
 388 {
 389         const struct drm_format_info *info;
 390
 391         info = drm_format_info(format);
 392         if (!info || plane >= info->num_planes)
 393                 return 0;
 394
 395         if (plane == 0)
 396                 return width;
 397
 398         return width / info->hsub;
 399 }
 400 EXPORT_SYMBOL(drm_format_plane_width);
 401
 402 /**
 403  * drm_format_plane_height - height of the plane given the first plane
 404  * @height: height of the first plane
 405  * @format: pixel format
 406  * @plane: plane index
 407  *
 408  * Returns:
 409  * The height of @plane, given that the height of the first plane is @height.
 410  */
 411 int drm_format_plane_height(int height, uint32_t format, int plane)
 412 {
 413         const struct drm_format_info *info;
 414
 415         info = drm_format_info(format);
 416         if (!info || plane >= info->num_planes)
 417                 return 0;
 418
 419         if (plane == 0)
 420                 return height;
 421
 422         return height / info->vsub;
 423 }
 424 EXPORT_SYMBOL(drm_format_plane_height);
 425
 426 /**
 427  * drm_format_info_block_width - width in pixels of block.
 428  * @info: pixel format info
 429  * @plane: plane index
 430  *
 431  * Returns:
 432  * The width in pixels of a block, depending on the plane index.
 433  */
 434 unsigned int drm_format_info_block_width(const struct drm_format_info *info,
 435                                          int plane)
 436 {
 437         if (!info || plane < 0 || plane >= info->num_planes)
 438                 return 0;
 439
 440         if (!info->block_w[plane])
 441                 return 1;
 442         return info->block_w[plane];
 443 }
 444 EXPORT_SYMBOL(drm_format_info_block_width);
 445
 446 /**
 447  * drm_format_info_block_height - height in pixels of a block
 448  * @info: pixel format info
 449  * @plane: plane index
 450  *
 451  * Returns:
 452  * The height in pixels of a block, depending on the plane index.
 453  */
 454 unsigned int drm_format_info_block_height(const struct drm_format_info *info,
 455                                           int plane)
 456 {
 457         if (!info || plane < 0 || plane >= info->num_planes)
 458                 return 0;
 459
 460         if (!info->block_h[plane])
 461                 return 1;
 462         return info->block_h[plane];
 463 }
 464 EXPORT_SYMBOL(drm_format_info_block_height);
 465
 466 /**
 467  * drm_format_info_min_pitch - computes the minimum required pitch in bytes
 468  * @info: pixel format info
 469  * @plane: plane index
 470  * @buffer_width: buffer width in pixels
 471  *
 472  * Returns:
 473  * The minimum required pitch in bytes for a buffer by taking into consideration
 474  * the pixel format information and the buffer width.
 475  */
 476 uint64_t drm_format_info_min_pitch(const struct drm_format_info *info,
 477                                    int plane, unsigned int buffer_width)
 478 {
 479         if (!info || plane < 0 || plane >= info->num_planes)
 480                 return 0;
 481
 482         return DIV_ROUND_UP_ULL((u64)buffer_width * info->char_per_block[plane],
 483                             drm_format_info_block_width(info, plane) *
 484                             drm_format_info_block_height(info, plane));
 485 }
 486 EXPORT_SYMBOL(drm_format_info_min_pitch);