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