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; 49 50 switch (bpp) { 51 case 8: 52 fmt = DRM_FORMAT_C8; 53 break; 54 case 16: 55 if (depth == 15) 56 fmt = DRM_FORMAT_XRGB1555; 57 else 58 fmt = DRM_FORMAT_RGB565; 59 break; 60 case 24: 61 fmt = DRM_FORMAT_RGB888; 62 break; 63 case 32: 64 if (depth == 24) 65 fmt = DRM_FORMAT_XRGB8888; 66 else if (depth == 30) 67 fmt = DRM_FORMAT_XRGB2101010; 68 else 69 fmt = DRM_FORMAT_ARGB8888; 70 break; 71 default: 72 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n"); 73 fmt = DRM_FORMAT_XRGB8888; 74 break; 75 } 76 77 return fmt; 78 } 79 EXPORT_SYMBOL(drm_mode_legacy_fb_format); 80 81 /** 82 * drm_get_format_name - return a string for drm fourcc format 83 * @format: format to compute name of 84 * 85 * Note that the buffer returned by this function is owned by the caller 86 * and will need to be freed using kfree(). 87 */ 88 char *drm_get_format_name(uint32_t format) 89 { 90 char *buf = kmalloc(32, GFP_KERNEL); 91 92 snprintf(buf, 32, 93 "%c%c%c%c %s-endian (0x%08x)", 94 printable_char(format & 0xff), 95 printable_char((format >> 8) & 0xff), 96 printable_char((format >> 16) & 0xff), 97 printable_char((format >> 24) & 0x7f), 98 format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little", 99 format); 100 101 return buf; 102 } 103 EXPORT_SYMBOL(drm_get_format_name); 104 105 /* 106 * Internal function to query information for a given format. See 107 * drm_format_info() for the public API. 108 */ 109 const struct drm_format_info *__drm_format_info(u32 format) 110 { 111 static const struct drm_format_info formats[] = { 112 { .format = DRM_FORMAT_C8, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 }, 113 { .format = DRM_FORMAT_RGB332, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 }, 114 { .format = DRM_FORMAT_BGR233, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 }, 115 { .format = DRM_FORMAT_XRGB4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 116 { .format = DRM_FORMAT_XBGR4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 117 { .format = DRM_FORMAT_RGBX4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 118 { .format = DRM_FORMAT_BGRX4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 119 { .format = DRM_FORMAT_ARGB4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 120 { .format = DRM_FORMAT_ABGR4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 121 { .format = DRM_FORMAT_RGBA4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 122 { .format = DRM_FORMAT_BGRA4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 123 { .format = DRM_FORMAT_XRGB1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 124 { .format = DRM_FORMAT_XBGR1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 125 { .format = DRM_FORMAT_RGBX5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 126 { .format = DRM_FORMAT_BGRX5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 127 { .format = DRM_FORMAT_ARGB1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 128 { .format = DRM_FORMAT_ABGR1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 129 { .format = DRM_FORMAT_RGBA5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 130 { .format = DRM_FORMAT_BGRA5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 131 { .format = DRM_FORMAT_RGB565, .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 132 { .format = DRM_FORMAT_BGR565, .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 }, 133 { .format = DRM_FORMAT_RGB888, .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 }, 134 { .format = DRM_FORMAT_BGR888, .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 }, 135 { .format = DRM_FORMAT_XRGB8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 136 { .format = DRM_FORMAT_XBGR8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 137 { .format = DRM_FORMAT_RGBX8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 138 { .format = DRM_FORMAT_BGRX8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 139 { .format = DRM_FORMAT_XRGB2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 140 { .format = DRM_FORMAT_XBGR2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 141 { .format = DRM_FORMAT_RGBX1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 142 { .format = DRM_FORMAT_BGRX1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 143 { .format = DRM_FORMAT_ARGB2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 144 { .format = DRM_FORMAT_ABGR2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 145 { .format = DRM_FORMAT_RGBA1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 146 { .format = DRM_FORMAT_BGRA1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 147 { .format = DRM_FORMAT_ARGB8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 148 { .format = DRM_FORMAT_ABGR8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 149 { .format = DRM_FORMAT_RGBA8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 150 { .format = DRM_FORMAT_BGRA8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 151 { .format = DRM_FORMAT_YUV410, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4 }, 152 { .format = DRM_FORMAT_YVU410, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4 }, 153 { .format = DRM_FORMAT_YUV411, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1 }, 154 { .format = DRM_FORMAT_YVU411, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1 }, 155 { .format = DRM_FORMAT_YUV420, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2 }, 156 { .format = DRM_FORMAT_YVU420, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2 }, 157 { .format = DRM_FORMAT_YUV422, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1 }, 158 { .format = DRM_FORMAT_YVU422, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1 }, 159 { .format = DRM_FORMAT_YUV444, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1 }, 160 { .format = DRM_FORMAT_YVU444, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1 }, 161 { .format = DRM_FORMAT_NV12, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2 }, 162 { .format = DRM_FORMAT_NV21, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2 }, 163 { .format = DRM_FORMAT_NV16, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1 }, 164 { .format = DRM_FORMAT_NV61, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1 }, 165 { .format = DRM_FORMAT_NV24, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1 }, 166 { .format = DRM_FORMAT_NV42, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1 }, 167 { .format = DRM_FORMAT_YUYV, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1 }, 168 { .format = DRM_FORMAT_YVYU, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1 }, 169 { .format = DRM_FORMAT_UYVY, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1 }, 170 { .format = DRM_FORMAT_VYUY, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1 }, 171 { .format = DRM_FORMAT_AYUV, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 }, 172 }; 173 174 unsigned int i; 175 176 for (i = 0; i < ARRAY_SIZE(formats); ++i) { 177 if (formats[i].format == format) 178 return &formats[i]; 179 } 180 181 return NULL; 182 } 183 184 /** 185 * drm_format_info - query information for a given format 186 * @format: pixel format (DRM_FORMAT_*) 187 * 188 * The caller should only pass a supported pixel format to this function. 189 * Unsupported pixel formats will generate a warning in the kernel log. 190 * 191 * Returns: 192 * The instance of struct drm_format_info that describes the pixel format, or 193 * NULL if the format is unsupported. 194 */ 195 const struct drm_format_info *drm_format_info(u32 format) 196 { 197 const struct drm_format_info *info; 198 199 info = __drm_format_info(format); 200 WARN_ON(!info); 201 return info; 202 } 203 EXPORT_SYMBOL(drm_format_info); 204 205 /** 206 * drm_format_num_planes - get the number of planes for format 207 * @format: pixel format (DRM_FORMAT_*) 208 * 209 * Returns: 210 * The number of planes used by the specified pixel format. 211 */ 212 int drm_format_num_planes(uint32_t format) 213 { 214 const struct drm_format_info *info; 215 216 info = drm_format_info(format); 217 return info ? info->num_planes : 1; 218 } 219 EXPORT_SYMBOL(drm_format_num_planes); 220 221 /** 222 * drm_format_plane_cpp - determine the bytes per pixel value 223 * @format: pixel format (DRM_FORMAT_*) 224 * @plane: plane index 225 * 226 * Returns: 227 * The bytes per pixel value for the specified plane. 228 */ 229 int drm_format_plane_cpp(uint32_t format, int plane) 230 { 231 const struct drm_format_info *info; 232 233 info = drm_format_info(format); 234 if (!info || plane >= info->num_planes) 235 return 0; 236 237 return info->cpp[plane]; 238 } 239 EXPORT_SYMBOL(drm_format_plane_cpp); 240 241 /** 242 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor 243 * @format: pixel format (DRM_FORMAT_*) 244 * 245 * Returns: 246 * The horizontal chroma subsampling factor for the 247 * specified pixel format. 248 */ 249 int drm_format_horz_chroma_subsampling(uint32_t format) 250 { 251 const struct drm_format_info *info; 252 253 info = drm_format_info(format); 254 return info ? info->hsub : 1; 255 } 256 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling); 257 258 /** 259 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor 260 * @format: pixel format (DRM_FORMAT_*) 261 * 262 * Returns: 263 * The vertical chroma subsampling factor for the 264 * specified pixel format. 265 */ 266 int drm_format_vert_chroma_subsampling(uint32_t format) 267 { 268 const struct drm_format_info *info; 269 270 info = drm_format_info(format); 271 return info ? info->vsub : 1; 272 } 273 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling); 274 275 /** 276 * drm_format_plane_width - width of the plane given the first plane 277 * @width: width of the first plane 278 * @format: pixel format 279 * @plane: plane index 280 * 281 * Returns: 282 * The width of @plane, given that the width of the first plane is @width. 283 */ 284 int drm_format_plane_width(int width, uint32_t format, int plane) 285 { 286 const struct drm_format_info *info; 287 288 info = drm_format_info(format); 289 if (!info || plane >= info->num_planes) 290 return 0; 291 292 if (plane == 0) 293 return width; 294 295 return width / info->hsub; 296 } 297 EXPORT_SYMBOL(drm_format_plane_width); 298 299 /** 300 * drm_format_plane_height - height of the plane given the first plane 301 * @height: height of the first plane 302 * @format: pixel format 303 * @plane: plane index 304 * 305 * Returns: 306 * The height of @plane, given that the height of the first plane is @height. 307 */ 308 int drm_format_plane_height(int height, uint32_t format, int plane) 309 { 310 const struct drm_format_info *info; 311 312 info = drm_format_info(format); 313 if (!info || plane >= info->num_planes) 314 return 0; 315 316 if (plane == 0) 317 return height; 318 319 return height / info->vsub; 320 } 321 EXPORT_SYMBOL(drm_format_plane_height); 322