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_get_format_name - fill a string with a drm fourcc format's name 100 * @format: format to compute name of 101 * @buf: caller-supplied buffer 102 */ 103 const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf) 104 { 105 snprintf(buf->str, sizeof(buf->str), 106 "%c%c%c%c %s-endian (0x%08x)", 107 printable_char(format & 0xff), 108 printable_char((format >> 8) & 0xff), 109 printable_char((format >> 16) & 0xff), 110 printable_char((format >> 24) & 0x7f), 111 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little", 112 format); 113 114 return buf->str; 115 } 116 EXPORT_SYMBOL(drm_get_format_name); 117 118 /* 119 * Internal function to query information for a given format. See 120 * drm_format_info() for the public API. 121 */ 122 const struct drm_format_info *__drm_format_info(u32 format) 123 { 124 static const struct drm_format_info formats[] = { 125 { .format = DRM_FORMAT_C8, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 }, 126 { .format = DRM_FORMAT_RGB332, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 }, 127 { .format = DRM_FORMAT_BGR233, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 }, 128 { .format = DRM_FORMAT_XRGB4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 129 { .format = DRM_FORMAT_XBGR4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 130 { .format = DRM_FORMAT_RGBX4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 131 { .format = DRM_FORMAT_BGRX4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 132 { .format = DRM_FORMAT_ARGB4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 133 { .format = DRM_FORMAT_ABGR4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 134 { .format = DRM_FORMAT_RGBA4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 135 { .format = DRM_FORMAT_BGRA4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 136 { .format = DRM_FORMAT_XRGB1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 137 { .format = DRM_FORMAT_XBGR1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 138 { .format = DRM_FORMAT_RGBX5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 139 { .format = DRM_FORMAT_BGRX5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 140 { .format = DRM_FORMAT_ARGB1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 141 { .format = DRM_FORMAT_ABGR1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 142 { .format = DRM_FORMAT_RGBA5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 143 { .format = DRM_FORMAT_BGRA5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 144 { .format = DRM_FORMAT_RGB565, .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 145 { .format = DRM_FORMAT_BGR565, .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 146 { .format = DRM_FORMAT_RGB888, .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 }, 147 { .format = DRM_FORMAT_BGR888, .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 }, 148 { .format = DRM_FORMAT_XRGB8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 149 { .format = DRM_FORMAT_XBGR8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 150 { .format = DRM_FORMAT_RGBX8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 151 { .format = DRM_FORMAT_BGRX8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 152 { .format = DRM_FORMAT_RGB565_A8, .depth = 24, .num_planes = 2, .cpp = { 2, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 153 { .format = DRM_FORMAT_BGR565_A8, .depth = 24, .num_planes = 2, .cpp = { 2, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 154 { .format = DRM_FORMAT_XRGB2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 155 { .format = DRM_FORMAT_XBGR2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 156 { .format = DRM_FORMAT_RGBX1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 157 { .format = DRM_FORMAT_BGRX1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 158 { .format = DRM_FORMAT_ARGB2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 159 { .format = DRM_FORMAT_ABGR2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 160 { .format = DRM_FORMAT_RGBA1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 161 { .format = DRM_FORMAT_BGRA1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 162 { .format = DRM_FORMAT_ARGB8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 163 { .format = DRM_FORMAT_ABGR8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 164 { .format = DRM_FORMAT_RGBA8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 165 { .format = DRM_FORMAT_BGRA8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 166 { .format = DRM_FORMAT_RGB888_A8, .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 167 { .format = DRM_FORMAT_BGR888_A8, .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 168 { .format = DRM_FORMAT_XRGB8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 169 { .format = DRM_FORMAT_XBGR8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 170 { .format = DRM_FORMAT_RGBX8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 171 { .format = DRM_FORMAT_BGRX8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true }, 172 { .format = DRM_FORMAT_YUV410, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true }, 173 { .format = DRM_FORMAT_YVU410, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true }, 174 { .format = DRM_FORMAT_YUV411, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true }, 175 { .format = DRM_FORMAT_YVU411, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true }, 176 { .format = DRM_FORMAT_YUV420, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true }, 177 { .format = DRM_FORMAT_YVU420, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true }, 178 { .format = DRM_FORMAT_YUV422, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true }, 179 { .format = DRM_FORMAT_YVU422, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true }, 180 { .format = DRM_FORMAT_YUV444, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true }, 181 { .format = DRM_FORMAT_YVU444, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true }, 182 { .format = DRM_FORMAT_NV12, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true }, 183 { .format = DRM_FORMAT_NV21, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true }, 184 { .format = DRM_FORMAT_NV16, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true }, 185 { .format = DRM_FORMAT_NV61, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true }, 186 { .format = DRM_FORMAT_NV24, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true }, 187 { .format = DRM_FORMAT_NV42, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true }, 188 { .format = DRM_FORMAT_YUYV, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true }, 189 { .format = DRM_FORMAT_YVYU, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true }, 190 { .format = DRM_FORMAT_UYVY, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true }, 191 { .format = DRM_FORMAT_VYUY, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true }, 192 { .format = DRM_FORMAT_AYUV, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true }, 193 }; 194 195 unsigned int i; 196 197 for (i = 0; i < ARRAY_SIZE(formats); ++i) { 198 if (formats[i].format == format) 199 return &formats[i]; 200 } 201 202 return NULL; 203 } 204 205 /** 206 * drm_format_info - query information for a given format 207 * @format: pixel format (DRM_FORMAT_*) 208 * 209 * The caller should only pass a supported pixel format to this function. 210 * Unsupported pixel formats will generate a warning in the kernel log. 211 * 212 * Returns: 213 * The instance of struct drm_format_info that describes the pixel format, or 214 * NULL if the format is unsupported. 215 */ 216 const struct drm_format_info *drm_format_info(u32 format) 217 { 218 const struct drm_format_info *info; 219 220 info = __drm_format_info(format); 221 WARN_ON(!info); 222 return info; 223 } 224 EXPORT_SYMBOL(drm_format_info); 225 226 /** 227 * drm_get_format_info - query information for a given framebuffer configuration 228 * @dev: DRM device 229 * @mode_cmd: metadata from the userspace fb creation request 230 * 231 * Returns: 232 * The instance of struct drm_format_info that describes the pixel format, or 233 * NULL if the format is unsupported. 234 */ 235 const struct drm_format_info * 236 drm_get_format_info(struct drm_device *dev, 237 const struct drm_mode_fb_cmd2 *mode_cmd) 238 { 239 const struct drm_format_info *info = NULL; 240 241 if (dev->mode_config.funcs->get_format_info) 242 info = dev->mode_config.funcs->get_format_info(mode_cmd); 243 244 if (!info) 245 info = drm_format_info(mode_cmd->pixel_format); 246 247 return info; 248 } 249 EXPORT_SYMBOL(drm_get_format_info); 250 251 /** 252 * drm_format_num_planes - get the number of planes for format 253 * @format: pixel format (DRM_FORMAT_*) 254 * 255 * Returns: 256 * The number of planes used by the specified pixel format. 257 */ 258 int drm_format_num_planes(uint32_t format) 259 { 260 const struct drm_format_info *info; 261 262 info = drm_format_info(format); 263 return info ? info->num_planes : 1; 264 } 265 EXPORT_SYMBOL(drm_format_num_planes); 266 267 /** 268 * drm_format_plane_cpp - determine the bytes per pixel value 269 * @format: pixel format (DRM_FORMAT_*) 270 * @plane: plane index 271 * 272 * Returns: 273 * The bytes per pixel value for the specified plane. 274 */ 275 int drm_format_plane_cpp(uint32_t format, int plane) 276 { 277 const struct drm_format_info *info; 278 279 info = drm_format_info(format); 280 if (!info || plane >= info->num_planes) 281 return 0; 282 283 return info->cpp[plane]; 284 } 285 EXPORT_SYMBOL(drm_format_plane_cpp); 286 287 /** 288 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor 289 * @format: pixel format (DRM_FORMAT_*) 290 * 291 * Returns: 292 * The horizontal chroma subsampling factor for the 293 * specified pixel format. 294 */ 295 int drm_format_horz_chroma_subsampling(uint32_t format) 296 { 297 const struct drm_format_info *info; 298 299 info = drm_format_info(format); 300 return info ? info->hsub : 1; 301 } 302 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling); 303 304 /** 305 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor 306 * @format: pixel format (DRM_FORMAT_*) 307 * 308 * Returns: 309 * The vertical chroma subsampling factor for the 310 * specified pixel format. 311 */ 312 int drm_format_vert_chroma_subsampling(uint32_t format) 313 { 314 const struct drm_format_info *info; 315 316 info = drm_format_info(format); 317 return info ? info->vsub : 1; 318 } 319 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling); 320 321 /** 322 * drm_format_plane_width - width of the plane given the first plane 323 * @width: width of the first plane 324 * @format: pixel format 325 * @plane: plane index 326 * 327 * Returns: 328 * The width of @plane, given that the width of the first plane is @width. 329 */ 330 int drm_format_plane_width(int width, uint32_t format, int plane) 331 { 332 const struct drm_format_info *info; 333 334 info = drm_format_info(format); 335 if (!info || plane >= info->num_planes) 336 return 0; 337 338 if (plane == 0) 339 return width; 340 341 return width / info->hsub; 342 } 343 EXPORT_SYMBOL(drm_format_plane_width); 344 345 /** 346 * drm_format_plane_height - height of the plane given the first plane 347 * @height: height of the first plane 348 * @format: pixel format 349 * @plane: plane index 350 * 351 * Returns: 352 * The height of @plane, given that the height of the first plane is @height. 353 */ 354 int drm_format_plane_height(int height, uint32_t format, int plane) 355 { 356 const struct drm_format_info *info; 357 358 info = drm_format_info(format); 359 if (!info || plane >= info->num_planes) 360 return 0; 361 362 if (plane == 0) 363 return height; 364 365 return height / info->vsub; 366 } 367 EXPORT_SYMBOL(drm_format_plane_height); 368