blob: 9163e807579ad947be7d0a73c65b97c649552aeb [file] [log] [blame]
Laurent Pinchartae4df112016-06-09 12:54:08 +03001/*
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
33static char printable_char(int c)
34{
35 return isascii(c) && isprint(c) ? c : '?';
36}
37
38/**
Daniel Vetterec5e3042016-08-29 10:27:54 +020039 * 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{
Chris Wilson70109352018-09-05 16:31:16 +010048 uint32_t fmt = DRM_FORMAT_INVALID;
Daniel Vetterec5e3042016-08-29 10:27:54 +020049
50 switch (bpp) {
51 case 8:
Chris Wilson70109352018-09-05 16:31:16 +010052 if (depth == 8)
53 fmt = DRM_FORMAT_C8;
Daniel Vetterec5e3042016-08-29 10:27:54 +020054 break;
Chris Wilson70109352018-09-05 16:31:16 +010055
Daniel Vetterec5e3042016-08-29 10:27:54 +020056 case 16:
Chris Wilson70109352018-09-05 16:31:16 +010057 switch (depth) {
58 case 15:
Daniel Vetterec5e3042016-08-29 10:27:54 +020059 fmt = DRM_FORMAT_XRGB1555;
Chris Wilson70109352018-09-05 16:31:16 +010060 break;
61 case 16:
Daniel Vetterec5e3042016-08-29 10:27:54 +020062 fmt = DRM_FORMAT_RGB565;
Chris Wilson70109352018-09-05 16:31:16 +010063 break;
64 default:
65 break;
66 }
Daniel Vetterec5e3042016-08-29 10:27:54 +020067 break;
Chris Wilson70109352018-09-05 16:31:16 +010068
Daniel Vetterec5e3042016-08-29 10:27:54 +020069 case 24:
Daniel Vetterec5e3042016-08-29 10:27:54 +020070 if (depth == 24)
Chris Wilson70109352018-09-05 16:31:16 +010071 fmt = DRM_FORMAT_RGB888;
Daniel Vetterec5e3042016-08-29 10:27:54 +020072 break;
Chris Wilson70109352018-09-05 16:31:16 +010073
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
Daniel Vetterec5e3042016-08-29 10:27:54 +020090 default:
Daniel Vetterec5e3042016-08-29 10:27:54 +020091 break;
92 }
93
94 return fmt;
95}
96EXPORT_SYMBOL(drm_mode_legacy_fb_format);
97
98/**
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +020099 * drm_driver_legacy_fb_format - compute drm fourcc code from legacy description
Daniel Vetter4af67de2018-10-04 22:24:44 +0200100 * @dev: DRM device
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +0200101 * @bpp: bits per pixels
102 * @depth: bit depth per pixel
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +0200103 *
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,
Daniel Vetter4af67de2018-10-04 22:24:44 +0200106 * 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.
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +0200108 */
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 }
Gerd Hoffmann9dd3cb22018-09-21 15:47:04 +0200124
125 if (dev->mode_config.quirk_addfb_prefer_xbgr_30bpp &&
126 fmt == DRM_FORMAT_XRGB2101010)
127 fmt = DRM_FORMAT_XBGR2101010;
128
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +0200129 return fmt;
130}
131EXPORT_SYMBOL(drm_driver_legacy_fb_format);
132
133/**
Eric Engestromb3c11ac2016-11-12 01:12:56 +0000134 * drm_get_format_name - fill a string with a drm fourcc format's name
Laurent Pinchartae4df112016-06-09 12:54:08 +0300135 * @format: format to compute name of
Eric Engestromb3c11ac2016-11-12 01:12:56 +0000136 * @buf: caller-supplied buffer
Laurent Pinchartae4df112016-06-09 12:54:08 +0300137 */
Eric Engestromb3c11ac2016-11-12 01:12:56 +0000138const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf)
Laurent Pinchartae4df112016-06-09 12:54:08 +0300139{
Eric Engestromb3c11ac2016-11-12 01:12:56 +0000140 snprintf(buf->str, sizeof(buf->str),
Laurent Pinchartae4df112016-06-09 12:54:08 +0300141 "%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
Eric Engestromb3c11ac2016-11-12 01:12:56 +0000149 return buf->str;
Laurent Pinchartae4df112016-06-09 12:54:08 +0300150}
151EXPORT_SYMBOL(drm_get_format_name);
152
Laurent Pinchart333d2da2016-10-18 01:41:12 +0300153/*
154 * Internal function to query information for a given format. See
155 * drm_format_info() for the public API.
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300156 */
Laurent Pinchart333d2da2016-10-18 01:41:12 +0300157const struct drm_format_info *__drm_format_info(u32 format)
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300158{
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 },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100167 { .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 },
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300171 { .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 },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100175 { .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 },
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300179 { .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 },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100187 { .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 },
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300189 { .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 },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100193 { .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 },
Kevin Strasser88ab9c72019-03-12 17:38:30 -0700201 { .format = DRM_FORMAT_XRGB16161616F, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
202 { .format = DRM_FORMAT_XBGR16161616F, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
203 { .format = DRM_FORMAT_ARGB16161616F, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
204 { .format = DRM_FORMAT_ABGR16161616F, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100205 { .format = DRM_FORMAT_RGB888_A8, .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
206 { .format = DRM_FORMAT_BGR888_A8, .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
207 { .format = DRM_FORMAT_XRGB8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
208 { .format = DRM_FORMAT_XBGR8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
209 { .format = DRM_FORMAT_RGBX8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
210 { .format = DRM_FORMAT_BGRX8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
Ayan Kumar Halderce2d5462018-07-17 18:13:42 +0100211 { .format = DRM_FORMAT_YUV410, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
212 { .format = DRM_FORMAT_YVU410, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
213 { .format = DRM_FORMAT_YUV411, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
214 { .format = DRM_FORMAT_YVU411, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
215 { .format = DRM_FORMAT_YUV420, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
216 { .format = DRM_FORMAT_YVU420, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
217 { .format = DRM_FORMAT_YUV422, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
218 { .format = DRM_FORMAT_YVU422, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
219 { .format = DRM_FORMAT_YUV444, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
220 { .format = DRM_FORMAT_YVU444, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
221 { .format = DRM_FORMAT_NV12, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
222 { .format = DRM_FORMAT_NV21, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
223 { .format = DRM_FORMAT_NV16, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
224 { .format = DRM_FORMAT_NV61, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
225 { .format = DRM_FORMAT_NV24, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
226 { .format = DRM_FORMAT_NV42, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
227 { .format = DRM_FORMAT_YUYV, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
228 { .format = DRM_FORMAT_YVYU, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
229 { .format = DRM_FORMAT_UYVY, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
230 { .format = DRM_FORMAT_VYUY, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
Stanislav Lisovskiy61e49392018-11-09 11:39:15 +0200231 { .format = DRM_FORMAT_XYUV8888, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
Ayan Kumar Halderce2d5462018-07-17 18:13:42 +0100232 { .format = DRM_FORMAT_AYUV, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
Swati Sharma50bf5d72019-03-04 17:26:33 +0530233 { .format = DRM_FORMAT_Y210, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
234 { .format = DRM_FORMAT_Y212, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
235 { .format = DRM_FORMAT_Y216, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
236 { .format = DRM_FORMAT_Y410, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
237 { .format = DRM_FORMAT_Y412, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
238 { .format = DRM_FORMAT_Y416, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
Alexandru Gheorghe697b6b82018-11-01 15:11:30 +0000239 { .format = DRM_FORMAT_Y0L0, .depth = 0, .num_planes = 1,
240 .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
241 .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
242 { .format = DRM_FORMAT_X0L0, .depth = 0, .num_planes = 1,
243 .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
244 .hsub = 2, .vsub = 2, .is_yuv = true },
245 { .format = DRM_FORMAT_Y0L2, .depth = 0, .num_planes = 1,
246 .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
247 .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
248 { .format = DRM_FORMAT_X0L2, .depth = 0, .num_planes = 1,
249 .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
250 .hsub = 2, .vsub = 2, .is_yuv = true },
Randy Li05f8bc82019-01-10 03:57:09 +0800251 { .format = DRM_FORMAT_P010, .depth = 0, .num_planes = 2,
252 .char_per_block = { 2, 4, 0 }, .block_w = { 1, 0, 0 }, .block_h = { 1, 0, 0 },
253 .hsub = 2, .vsub = 2, .is_yuv = true},
254 { .format = DRM_FORMAT_P012, .depth = 0, .num_planes = 2,
255 .char_per_block = { 2, 4, 0 }, .block_w = { 1, 0, 0 }, .block_h = { 1, 0, 0 },
256 .hsub = 2, .vsub = 2, .is_yuv = true},
257 { .format = DRM_FORMAT_P016, .depth = 0, .num_planes = 2,
258 .char_per_block = { 2, 4, 0 }, .block_w = { 1, 0, 0 }, .block_h = { 1, 0, 0 },
259 .hsub = 2, .vsub = 2, .is_yuv = true},
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300260 };
261
262 unsigned int i;
263
264 for (i = 0; i < ARRAY_SIZE(formats); ++i) {
265 if (formats[i].format == format)
266 return &formats[i];
267 }
268
269 return NULL;
270}
Laurent Pinchart333d2da2016-10-18 01:41:12 +0300271
272/**
273 * drm_format_info - query information for a given format
274 * @format: pixel format (DRM_FORMAT_*)
275 *
276 * The caller should only pass a supported pixel format to this function.
277 * Unsupported pixel formats will generate a warning in the kernel log.
278 *
279 * Returns:
280 * The instance of struct drm_format_info that describes the pixel format, or
281 * NULL if the format is unsupported.
282 */
283const struct drm_format_info *drm_format_info(u32 format)
284{
285 const struct drm_format_info *info;
286
287 info = __drm_format_info(format);
288 WARN_ON(!info);
289 return info;
290}
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300291EXPORT_SYMBOL(drm_format_info);
292
293/**
Ville Syrjälä6a0f9eb2017-03-21 20:12:16 +0200294 * drm_get_format_info - query information for a given framebuffer configuration
295 * @dev: DRM device
296 * @mode_cmd: metadata from the userspace fb creation request
297 *
298 * Returns:
299 * The instance of struct drm_format_info that describes the pixel format, or
300 * NULL if the format is unsupported.
301 */
302const struct drm_format_info *
303drm_get_format_info(struct drm_device *dev,
304 const struct drm_mode_fb_cmd2 *mode_cmd)
305{
306 const struct drm_format_info *info = NULL;
307
308 if (dev->mode_config.funcs->get_format_info)
309 info = dev->mode_config.funcs->get_format_info(mode_cmd);
310
311 if (!info)
312 info = drm_format_info(mode_cmd->pixel_format);
313
314 return info;
315}
316EXPORT_SYMBOL(drm_get_format_info);
317
318/**
Laurent Pinchartae4df112016-06-09 12:54:08 +0300319 * drm_format_num_planes - get the number of planes for format
320 * @format: pixel format (DRM_FORMAT_*)
321 *
322 * Returns:
323 * The number of planes used by the specified pixel format.
324 */
325int drm_format_num_planes(uint32_t format)
326{
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300327 const struct drm_format_info *info;
328
329 info = drm_format_info(format);
330 return info ? info->num_planes : 1;
Laurent Pinchartae4df112016-06-09 12:54:08 +0300331}
332EXPORT_SYMBOL(drm_format_num_planes);
333
334/**
335 * drm_format_plane_cpp - determine the bytes per pixel value
336 * @format: pixel format (DRM_FORMAT_*)
337 * @plane: plane index
338 *
339 * Returns:
340 * The bytes per pixel value for the specified plane.
341 */
342int drm_format_plane_cpp(uint32_t format, int plane)
343{
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300344 const struct drm_format_info *info;
Laurent Pinchartae4df112016-06-09 12:54:08 +0300345
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300346 info = drm_format_info(format);
347 if (!info || plane >= info->num_planes)
Laurent Pinchartae4df112016-06-09 12:54:08 +0300348 return 0;
349
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300350 return info->cpp[plane];
Laurent Pinchartae4df112016-06-09 12:54:08 +0300351}
352EXPORT_SYMBOL(drm_format_plane_cpp);
353
354/**
355 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
356 * @format: pixel format (DRM_FORMAT_*)
357 *
358 * Returns:
359 * The horizontal chroma subsampling factor for the
360 * specified pixel format.
361 */
362int drm_format_horz_chroma_subsampling(uint32_t format)
363{
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300364 const struct drm_format_info *info;
365
366 info = drm_format_info(format);
367 return info ? info->hsub : 1;
Laurent Pinchartae4df112016-06-09 12:54:08 +0300368}
369EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
370
371/**
372 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
373 * @format: pixel format (DRM_FORMAT_*)
374 *
375 * Returns:
376 * The vertical chroma subsampling factor for the
377 * specified pixel format.
378 */
379int drm_format_vert_chroma_subsampling(uint32_t format)
380{
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300381 const struct drm_format_info *info;
382
383 info = drm_format_info(format);
384 return info ? info->vsub : 1;
Laurent Pinchartae4df112016-06-09 12:54:08 +0300385}
386EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
387
388/**
389 * drm_format_plane_width - width of the plane given the first plane
390 * @width: width of the first plane
391 * @format: pixel format
392 * @plane: plane index
393 *
394 * Returns:
395 * The width of @plane, given that the width of the first plane is @width.
396 */
397int drm_format_plane_width(int width, uint32_t format, int plane)
398{
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300399 const struct drm_format_info *info;
400
401 info = drm_format_info(format);
402 if (!info || plane >= info->num_planes)
Laurent Pinchartae4df112016-06-09 12:54:08 +0300403 return 0;
404
405 if (plane == 0)
406 return width;
407
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300408 return width / info->hsub;
Laurent Pinchartae4df112016-06-09 12:54:08 +0300409}
410EXPORT_SYMBOL(drm_format_plane_width);
411
412/**
413 * drm_format_plane_height - height of the plane given the first plane
414 * @height: height of the first plane
415 * @format: pixel format
416 * @plane: plane index
417 *
418 * Returns:
419 * The height of @plane, given that the height of the first plane is @height.
420 */
421int drm_format_plane_height(int height, uint32_t format, int plane)
422{
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300423 const struct drm_format_info *info;
424
425 info = drm_format_info(format);
426 if (!info || plane >= info->num_planes)
Laurent Pinchartae4df112016-06-09 12:54:08 +0300427 return 0;
428
429 if (plane == 0)
430 return height;
431
Laurent Pinchart86c238a2016-10-18 01:41:10 +0300432 return height / info->vsub;
Laurent Pinchartae4df112016-06-09 12:54:08 +0300433}
434EXPORT_SYMBOL(drm_format_plane_height);
Alexandru Gheorghe042bf752018-11-01 17:02:05 +0000435
436/**
437 * drm_format_info_block_width - width in pixels of block.
438 * @info: pixel format info
439 * @plane: plane index
440 *
441 * Returns:
442 * The width in pixels of a block, depending on the plane index.
443 */
444unsigned int drm_format_info_block_width(const struct drm_format_info *info,
445 int plane)
446{
447 if (!info || plane < 0 || plane >= info->num_planes)
448 return 0;
449
450 if (!info->block_w[plane])
451 return 1;
452 return info->block_w[plane];
453}
454EXPORT_SYMBOL(drm_format_info_block_width);
455
456/**
457 * drm_format_info_block_height - height in pixels of a block
458 * @info: pixel format info
459 * @plane: plane index
460 *
461 * Returns:
462 * The height in pixels of a block, depending on the plane index.
463 */
464unsigned int drm_format_info_block_height(const struct drm_format_info *info,
465 int plane)
466{
467 if (!info || plane < 0 || plane >= info->num_planes)
468 return 0;
469
470 if (!info->block_h[plane])
471 return 1;
472 return info->block_h[plane];
473}
474EXPORT_SYMBOL(drm_format_info_block_height);
475
476/**
477 * drm_format_info_min_pitch - computes the minimum required pitch in bytes
478 * @info: pixel format info
479 * @plane: plane index
480 * @buffer_width: buffer width in pixels
481 *
482 * Returns:
483 * The minimum required pitch in bytes for a buffer by taking into consideration
484 * the pixel format information and the buffer width.
485 */
486uint64_t drm_format_info_min_pitch(const struct drm_format_info *info,
487 int plane, unsigned int buffer_width)
488{
489 if (!info || plane < 0 || plane >= info->num_planes)
490 return 0;
491
492 return DIV_ROUND_UP_ULL((u64)buffer_width * info->char_per_block[plane],
493 drm_format_info_block_width(info, plane) *
494 drm_format_info_block_height(info, plane));
495}
496EXPORT_SYMBOL(drm_format_info_min_pitch);