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/drm_device.h>
31#include <drm/drm_fourcc.h>
32
33static 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 */
46uint32_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}
96EXPORT_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 */
109uint32_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}
131EXPORT_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 */
138const 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}
151EXPORT_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 */
157const 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#ifdef __BIG_ENDIAN
182		{ .format = DRM_FORMAT_XRGB1555 | DRM_FORMAT_BIG_ENDIAN, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
183		{ .format = DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN, .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
184#endif
185		{ .format = DRM_FORMAT_RGB888,		.depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 },
186		{ .format = DRM_FORMAT_BGR888,		.depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 },
187		{ .format = DRM_FORMAT_XRGB8888,	.depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
188		{ .format = DRM_FORMAT_XBGR8888,	.depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
189		{ .format = DRM_FORMAT_RGBX8888,	.depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
190		{ .format = DRM_FORMAT_BGRX8888,	.depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
191		{ .format = DRM_FORMAT_RGB565_A8,	.depth = 24, .num_planes = 2, .cpp = { 2, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
192		{ .format = DRM_FORMAT_BGR565_A8,	.depth = 24, .num_planes = 2, .cpp = { 2, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
193		{ .format = DRM_FORMAT_XRGB2101010,	.depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
194		{ .format = DRM_FORMAT_XBGR2101010,	.depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
195		{ .format = DRM_FORMAT_RGBX1010102,	.depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
196		{ .format = DRM_FORMAT_BGRX1010102,	.depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
197		{ .format = DRM_FORMAT_ARGB2101010,	.depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
198		{ .format = DRM_FORMAT_ABGR2101010,	.depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
199		{ .format = DRM_FORMAT_RGBA1010102,	.depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
200		{ .format = DRM_FORMAT_BGRA1010102,	.depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
201		{ .format = DRM_FORMAT_ARGB8888,	.depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
202		{ .format = DRM_FORMAT_ABGR8888,	.depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
203		{ .format = DRM_FORMAT_RGBA8888,	.depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
204		{ .format = DRM_FORMAT_BGRA8888,	.depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
205		{ .format = DRM_FORMAT_XRGB16161616F,	.depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
206		{ .format = DRM_FORMAT_XBGR16161616F,	.depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
207		{ .format = DRM_FORMAT_ARGB16161616F,	.depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
208		{ .format = DRM_FORMAT_ABGR16161616F,	.depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
209		{ .format = DRM_FORMAT_RGB888_A8,	.depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
210		{ .format = DRM_FORMAT_BGR888_A8,	.depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
211		{ .format = DRM_FORMAT_XRGB8888_A8,	.depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
212		{ .format = DRM_FORMAT_XBGR8888_A8,	.depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
213		{ .format = DRM_FORMAT_RGBX8888_A8,	.depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
214		{ .format = DRM_FORMAT_BGRX8888_A8,	.depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
215		{ .format = DRM_FORMAT_YUV410,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
216		{ .format = DRM_FORMAT_YVU410,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
217		{ .format = DRM_FORMAT_YUV411,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
218		{ .format = DRM_FORMAT_YVU411,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
219		{ .format = DRM_FORMAT_YUV420,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
220		{ .format = DRM_FORMAT_YVU420,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
221		{ .format = DRM_FORMAT_YUV422,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
222		{ .format = DRM_FORMAT_YVU422,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
223		{ .format = DRM_FORMAT_YUV444,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
224		{ .format = DRM_FORMAT_YVU444,		.depth = 0,  .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
225		{ .format = DRM_FORMAT_NV12,		.depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
226		{ .format = DRM_FORMAT_NV21,		.depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
227		{ .format = DRM_FORMAT_NV16,		.depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
228		{ .format = DRM_FORMAT_NV61,		.depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
229		{ .format = DRM_FORMAT_NV24,		.depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
230		{ .format = DRM_FORMAT_NV42,		.depth = 0,  .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
231		{ .format = DRM_FORMAT_YUYV,		.depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
232		{ .format = DRM_FORMAT_YVYU,		.depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
233		{ .format = DRM_FORMAT_UYVY,		.depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
234		{ .format = DRM_FORMAT_VYUY,		.depth = 0,  .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
235		{ .format = DRM_FORMAT_XYUV8888,	.depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
236		{ .format = DRM_FORMAT_VUY888,          .depth = 0,  .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
237		{ .format = DRM_FORMAT_AYUV,		.depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
238		{ .format = DRM_FORMAT_Y210,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
239		{ .format = DRM_FORMAT_Y212,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
240		{ .format = DRM_FORMAT_Y216,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
241		{ .format = DRM_FORMAT_Y410,            .depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
242		{ .format = DRM_FORMAT_Y412,            .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
243		{ .format = DRM_FORMAT_Y416,            .depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
244		{ .format = DRM_FORMAT_XVYU2101010,	.depth = 0,  .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
245		{ .format = DRM_FORMAT_XVYU12_16161616,	.depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
246		{ .format = DRM_FORMAT_XVYU16161616,	.depth = 0,  .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
247		{ .format = DRM_FORMAT_Y0L0,		.depth = 0,  .num_planes = 1,
248		  .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
249		  .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
250		{ .format = DRM_FORMAT_X0L0,		.depth = 0,  .num_planes = 1,
251		  .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
252		  .hsub = 2, .vsub = 2, .is_yuv = true },
253		{ .format = DRM_FORMAT_Y0L2,		.depth = 0,  .num_planes = 1,
254		  .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
255		  .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
256		{ .format = DRM_FORMAT_X0L2,		.depth = 0,  .num_planes = 1,
257		  .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
258		  .hsub = 2, .vsub = 2, .is_yuv = true },
259		{ .format = DRM_FORMAT_P010,            .depth = 0,  .num_planes = 2,
260		  .char_per_block = { 2, 4, 0 }, .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 },
261		  .hsub = 2, .vsub = 2, .is_yuv = true},
262		{ .format = DRM_FORMAT_P012,		.depth = 0,  .num_planes = 2,
263		  .char_per_block = { 2, 4, 0 }, .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 },
264		   .hsub = 2, .vsub = 2, .is_yuv = true},
265		{ .format = DRM_FORMAT_P016,		.depth = 0,  .num_planes = 2,
266		  .char_per_block = { 2, 4, 0 }, .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 },
267		  .hsub = 2, .vsub = 2, .is_yuv = true},
268		{ .format = DRM_FORMAT_P210,		.depth = 0,
269		  .num_planes = 2, .char_per_block = { 2, 4, 0 },
270		  .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 }, .hsub = 2,
271		  .vsub = 1, .is_yuv = true },
272		{ .format = DRM_FORMAT_VUY101010,	.depth = 0,
273		  .num_planes = 1, .cpp = { 0, 0, 0 }, .hsub = 1, .vsub = 1,
274		  .is_yuv = true },
275		{ .format = DRM_FORMAT_YUV420_8BIT,     .depth = 0,
276		  .num_planes = 1, .cpp = { 0, 0, 0 }, .hsub = 2, .vsub = 2,
277		  .is_yuv = true },
278		{ .format = DRM_FORMAT_YUV420_10BIT,    .depth = 0,
279		  .num_planes = 1, .cpp = { 0, 0, 0 }, .hsub = 2, .vsub = 2,
280		  .is_yuv = true },
281		{ .format = DRM_FORMAT_NV15,		.depth = 0,
282		  .num_planes = 2, .char_per_block = { 5, 5, 0 },
283		  .block_w = { 4, 2, 0 }, .block_h = { 1, 1, 0 }, .hsub = 2,
284		  .vsub = 2, .is_yuv = true },
285		{ .format = DRM_FORMAT_Q410,		.depth = 0,
286		  .num_planes = 3, .char_per_block = { 2, 2, 2 },
287		  .block_w = { 1, 1, 1 }, .block_h = { 1, 1, 1 }, .hsub = 1,
288		  .vsub = 1, .is_yuv = true },
289		{ .format = DRM_FORMAT_Q401,		.depth = 0,
290		  .num_planes = 3, .char_per_block = { 2, 2, 2 },
291		  .block_w = { 1, 1, 1 }, .block_h = { 1, 1, 1 }, .hsub = 1,
292		  .vsub = 1, .is_yuv = true },
293		{ .format = DRM_FORMAT_P030,            .depth = 0,  .num_planes = 2,
294		  .char_per_block = { 4, 8, 0 }, .block_w = { 3, 3, 0 }, .block_h = { 1, 1, 0 },
295		  .hsub = 2, .vsub = 2, .is_yuv = true},
296	};
297
298	unsigned int i;
299
300	for (i = 0; i < ARRAY_SIZE(formats); ++i) {
301		if (formats[i].format == format)
302			return &formats[i];
303	}
304
305	return NULL;
306}
307
308/**
309 * drm_format_info - query information for a given format
310 * @format: pixel format (DRM_FORMAT_*)
311 *
312 * The caller should only pass a supported pixel format to this function.
313 * Unsupported pixel formats will generate a warning in the kernel log.
314 *
315 * Returns:
316 * The instance of struct drm_format_info that describes the pixel format, or
317 * NULL if the format is unsupported.
318 */
319const struct drm_format_info *drm_format_info(u32 format)
320{
321	const struct drm_format_info *info;
322
323	info = __drm_format_info(format);
324	WARN_ON(!info);
325	return info;
326}
327EXPORT_SYMBOL(drm_format_info);
328
329/**
330 * drm_get_format_info - query information for a given framebuffer configuration
331 * @dev: DRM device
332 * @mode_cmd: metadata from the userspace fb creation request
333 *
334 * Returns:
335 * The instance of struct drm_format_info that describes the pixel format, or
336 * NULL if the format is unsupported.
337 */
338const struct drm_format_info *
339drm_get_format_info(struct drm_device *dev,
340		    const struct drm_mode_fb_cmd2 *mode_cmd)
341{
342	const struct drm_format_info *info = NULL;
343
344	if (dev->mode_config.funcs->get_format_info)
345		info = dev->mode_config.funcs->get_format_info(mode_cmd);
346
347	if (!info)
348		info = drm_format_info(mode_cmd->pixel_format);
349
350	return info;
351}
352EXPORT_SYMBOL(drm_get_format_info);
353
354/**
355 * drm_format_info_block_width - width in pixels of block.
356 * @info: pixel format info
357 * @plane: plane index
358 *
359 * Returns:
360 * The width in pixels of a block, depending on the plane index.
361 */
362unsigned int drm_format_info_block_width(const struct drm_format_info *info,
363					 int plane)
364{
365	if (!info || plane < 0 || plane >= info->num_planes)
366		return 0;
367
368	if (!info->block_w[plane])
369		return 1;
370	return info->block_w[plane];
371}
372EXPORT_SYMBOL(drm_format_info_block_width);
373
374/**
375 * drm_format_info_block_height - height in pixels of a block
376 * @info: pixel format info
377 * @plane: plane index
378 *
379 * Returns:
380 * The height in pixels of a block, depending on the plane index.
381 */
382unsigned int drm_format_info_block_height(const struct drm_format_info *info,
383					  int plane)
384{
385	if (!info || plane < 0 || plane >= info->num_planes)
386		return 0;
387
388	if (!info->block_h[plane])
389		return 1;
390	return info->block_h[plane];
391}
392EXPORT_SYMBOL(drm_format_info_block_height);
393
394/**
395 * drm_format_info_min_pitch - computes the minimum required pitch in bytes
396 * @info: pixel format info
397 * @plane: plane index
398 * @buffer_width: buffer width in pixels
399 *
400 * Returns:
401 * The minimum required pitch in bytes for a buffer by taking into consideration
402 * the pixel format information and the buffer width.
403 */
404uint64_t drm_format_info_min_pitch(const struct drm_format_info *info,
405				   int plane, unsigned int buffer_width)
406{
407	if (!info || plane < 0 || plane >= info->num_planes)
408		return 0;
409
410	return DIV_ROUND_UP_ULL((u64)buffer_width * info->char_per_block[plane],
411			    drm_format_info_block_width(info, plane) *
412			    drm_format_info_block_height(info, plane));
413}
414EXPORT_SYMBOL(drm_format_info_min_pitch);
415