blob: 07741b678798b0f1293d7c324896dd209cc9fce0 [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
Sam Ravnborg0500c042019-05-26 19:35:35 +020030#include <drm/drm_device.h>
Laurent Pinchartae4df112016-06-09 12:54:08 +030031#include <drm/drm_fourcc.h>
32
Laurent Pinchartae4df112016-06-09 12:54:08 +030033/**
Daniel Vetterec5e3042016-08-29 10:27:54 +020034 * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
35 * @bpp: bits per pixels
36 * @depth: bit depth per pixel
37 *
38 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
39 * Useful in fbdev emulation code, since that deals in those values.
40 */
41uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
42{
Chris Wilson70109352018-09-05 16:31:16 +010043 uint32_t fmt = DRM_FORMAT_INVALID;
Daniel Vetterec5e3042016-08-29 10:27:54 +020044
45 switch (bpp) {
46 case 8:
Chris Wilson70109352018-09-05 16:31:16 +010047 if (depth == 8)
48 fmt = DRM_FORMAT_C8;
Daniel Vetterec5e3042016-08-29 10:27:54 +020049 break;
Chris Wilson70109352018-09-05 16:31:16 +010050
Daniel Vetterec5e3042016-08-29 10:27:54 +020051 case 16:
Chris Wilson70109352018-09-05 16:31:16 +010052 switch (depth) {
53 case 15:
Daniel Vetterec5e3042016-08-29 10:27:54 +020054 fmt = DRM_FORMAT_XRGB1555;
Chris Wilson70109352018-09-05 16:31:16 +010055 break;
56 case 16:
Daniel Vetterec5e3042016-08-29 10:27:54 +020057 fmt = DRM_FORMAT_RGB565;
Chris Wilson70109352018-09-05 16:31:16 +010058 break;
59 default:
60 break;
61 }
Daniel Vetterec5e3042016-08-29 10:27:54 +020062 break;
Chris Wilson70109352018-09-05 16:31:16 +010063
Daniel Vetterec5e3042016-08-29 10:27:54 +020064 case 24:
Daniel Vetterec5e3042016-08-29 10:27:54 +020065 if (depth == 24)
Chris Wilson70109352018-09-05 16:31:16 +010066 fmt = DRM_FORMAT_RGB888;
Daniel Vetterec5e3042016-08-29 10:27:54 +020067 break;
Chris Wilson70109352018-09-05 16:31:16 +010068
69 case 32:
70 switch (depth) {
71 case 24:
72 fmt = DRM_FORMAT_XRGB8888;
73 break;
74 case 30:
75 fmt = DRM_FORMAT_XRGB2101010;
76 break;
77 case 32:
78 fmt = DRM_FORMAT_ARGB8888;
79 break;
80 default:
81 break;
82 }
83 break;
84
Daniel Vetterec5e3042016-08-29 10:27:54 +020085 default:
Daniel Vetterec5e3042016-08-29 10:27:54 +020086 break;
87 }
88
89 return fmt;
90}
91EXPORT_SYMBOL(drm_mode_legacy_fb_format);
92
93/**
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +020094 * drm_driver_legacy_fb_format - compute drm fourcc code from legacy description
Daniel Vetter4af67de2018-10-04 22:24:44 +020095 * @dev: DRM device
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +020096 * @bpp: bits per pixels
97 * @depth: bit depth per pixel
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +020098 *
99 * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
100 * Unlike drm_mode_legacy_fb_format() this looks at the drivers mode_config,
Daniel Vetter4af67de2018-10-04 22:24:44 +0200101 * and depending on the &drm_mode_config.quirk_addfb_prefer_host_byte_order flag
102 * it returns little endian byte order or host byte order framebuffer formats.
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +0200103 */
104uint32_t drm_driver_legacy_fb_format(struct drm_device *dev,
105 uint32_t bpp, uint32_t depth)
106{
107 uint32_t fmt = drm_mode_legacy_fb_format(bpp, depth);
108
109 if (dev->mode_config.quirk_addfb_prefer_host_byte_order) {
110 if (fmt == DRM_FORMAT_XRGB8888)
111 fmt = DRM_FORMAT_HOST_XRGB8888;
112 if (fmt == DRM_FORMAT_ARGB8888)
113 fmt = DRM_FORMAT_HOST_ARGB8888;
114 if (fmt == DRM_FORMAT_RGB565)
115 fmt = DRM_FORMAT_HOST_RGB565;
116 if (fmt == DRM_FORMAT_XRGB1555)
117 fmt = DRM_FORMAT_HOST_XRGB1555;
118 }
Gerd Hoffmann9dd3cb22018-09-21 15:47:04 +0200119
120 if (dev->mode_config.quirk_addfb_prefer_xbgr_30bpp &&
121 fmt == DRM_FORMAT_XRGB2101010)
122 fmt = DRM_FORMAT_XBGR2101010;
123
Gerd Hoffmann059b5eb2018-09-21 15:46:59 +0200124 return fmt;
125}
126EXPORT_SYMBOL(drm_driver_legacy_fb_format);
127
Laurent Pinchart333d2da2016-10-18 01:41:12 +0300128/*
129 * Internal function to query information for a given format. See
130 * drm_format_info() for the public API.
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300131 */
Laurent Pinchart333d2da2016-10-18 01:41:12 +0300132const struct drm_format_info *__drm_format_info(u32 format)
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300133{
134 static const struct drm_format_info formats[] = {
135 { .format = DRM_FORMAT_C8, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
Noralf Trønnesa0b1d352021-09-29 21:11:56 +0200136 { .format = DRM_FORMAT_R8, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
Laurent Pinchart31fa8cb2021-10-28 02:31:40 +0300137 { .format = DRM_FORMAT_R10, .depth = 10, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
138 { .format = DRM_FORMAT_R12, .depth = 12, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300139 { .format = DRM_FORMAT_RGB332, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
140 { .format = DRM_FORMAT_BGR233, .depth = 8, .num_planes = 1, .cpp = { 1, 0, 0 }, .hsub = 1, .vsub = 1 },
141 { .format = DRM_FORMAT_XRGB4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
142 { .format = DRM_FORMAT_XBGR4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
143 { .format = DRM_FORMAT_RGBX4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
144 { .format = DRM_FORMAT_BGRX4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100145 { .format = DRM_FORMAT_ARGB4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
146 { .format = DRM_FORMAT_ABGR4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
147 { .format = DRM_FORMAT_RGBA4444, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
148 { .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 +0300149 { .format = DRM_FORMAT_XRGB1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
150 { .format = DRM_FORMAT_XBGR1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
151 { .format = DRM_FORMAT_RGBX5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
152 { .format = DRM_FORMAT_BGRX5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100153 { .format = DRM_FORMAT_ARGB1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
154 { .format = DRM_FORMAT_ABGR1555, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
155 { .format = DRM_FORMAT_RGBA5551, .depth = 15, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
156 { .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 +0300157 { .format = DRM_FORMAT_RGB565, .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
158 { .format = DRM_FORMAT_BGR565, .depth = 16, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 1, .vsub = 1 },
159 { .format = DRM_FORMAT_RGB888, .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 },
160 { .format = DRM_FORMAT_BGR888, .depth = 24, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1 },
161 { .format = DRM_FORMAT_XRGB8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
162 { .format = DRM_FORMAT_XBGR8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
163 { .format = DRM_FORMAT_RGBX8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
164 { .format = DRM_FORMAT_BGRX8888, .depth = 24, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100165 { .format = DRM_FORMAT_RGB565_A8, .depth = 24, .num_planes = 2, .cpp = { 2, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
166 { .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 +0300167 { .format = DRM_FORMAT_XRGB2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
168 { .format = DRM_FORMAT_XBGR2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
169 { .format = DRM_FORMAT_RGBX1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
170 { .format = DRM_FORMAT_BGRX1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1 },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100171 { .format = DRM_FORMAT_ARGB2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
172 { .format = DRM_FORMAT_ABGR2101010, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
173 { .format = DRM_FORMAT_RGBA1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
174 { .format = DRM_FORMAT_BGRA1010102, .depth = 30, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
175 { .format = DRM_FORMAT_ARGB8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
176 { .format = DRM_FORMAT_ABGR8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
177 { .format = DRM_FORMAT_RGBA8888, .depth = 32, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
178 { .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 -0700179 { .format = DRM_FORMAT_XRGB16161616F, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
180 { .format = DRM_FORMAT_XBGR16161616F, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
181 { .format = DRM_FORMAT_ARGB16161616F, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
182 { .format = DRM_FORMAT_ABGR16161616F, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
Matteo Franchin47170f82020-10-12 17:40:43 +0100183 { .format = DRM_FORMAT_AXBXGXRX106106106106, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
Mario Kleinerff92ecf2021-03-19 22:03:13 +0100184 { .format = DRM_FORMAT_XRGB16161616, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
185 { .format = DRM_FORMAT_XBGR16161616, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1 },
186 { .format = DRM_FORMAT_ARGB16161616, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
187 { .format = DRM_FORMAT_ABGR16161616, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
Maxime Ripard4cc4e1b2017-12-22 15:29:26 +0100188 { .format = DRM_FORMAT_RGB888_A8, .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
189 { .format = DRM_FORMAT_BGR888_A8, .depth = 32, .num_planes = 2, .cpp = { 3, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
190 { .format = DRM_FORMAT_XRGB8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
191 { .format = DRM_FORMAT_XBGR8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
192 { .format = DRM_FORMAT_RGBX8888_A8, .depth = 32, .num_planes = 2, .cpp = { 4, 1, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true },
193 { .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 +0100194 { .format = DRM_FORMAT_YUV410, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
195 { .format = DRM_FORMAT_YVU410, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 4, .is_yuv = true },
196 { .format = DRM_FORMAT_YUV411, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
197 { .format = DRM_FORMAT_YVU411, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 4, .vsub = 1, .is_yuv = true },
198 { .format = DRM_FORMAT_YUV420, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
199 { .format = DRM_FORMAT_YVU420, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 2, .is_yuv = true },
200 { .format = DRM_FORMAT_YUV422, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
201 { .format = DRM_FORMAT_YVU422, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 2, .vsub = 1, .is_yuv = true },
202 { .format = DRM_FORMAT_YUV444, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
203 { .format = DRM_FORMAT_YVU444, .depth = 0, .num_planes = 3, .cpp = { 1, 1, 1 }, .hsub = 1, .vsub = 1, .is_yuv = true },
204 { .format = DRM_FORMAT_NV12, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
205 { .format = DRM_FORMAT_NV21, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 2, .is_yuv = true },
206 { .format = DRM_FORMAT_NV16, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
207 { .format = DRM_FORMAT_NV61, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
208 { .format = DRM_FORMAT_NV24, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
209 { .format = DRM_FORMAT_NV42, .depth = 0, .num_planes = 2, .cpp = { 1, 2, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
210 { .format = DRM_FORMAT_YUYV, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
211 { .format = DRM_FORMAT_YVYU, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
212 { .format = DRM_FORMAT_UYVY, .depth = 0, .num_planes = 1, .cpp = { 2, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
213 { .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 +0200214 { .format = DRM_FORMAT_XYUV8888, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
Brian Starkey7ba0fee2018-10-05 10:27:00 +0100215 { .format = DRM_FORMAT_VUY888, .depth = 0, .num_planes = 1, .cpp = { 3, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
Ayan Kumar Halderce2d5462018-07-17 18:13:42 +0100216 { .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 +0530217 { .format = DRM_FORMAT_Y210, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
218 { .format = DRM_FORMAT_Y212, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
219 { .format = DRM_FORMAT_Y216, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 2, .vsub = 1, .is_yuv = true },
Maarten Lankhorstff01e692019-03-19 13:17:02 +0100220 { .format = DRM_FORMAT_Y410, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
221 { .format = DRM_FORMAT_Y412, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
222 { .format = DRM_FORMAT_Y416, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .has_alpha = true, .is_yuv = true },
223 { .format = DRM_FORMAT_XVYU2101010, .depth = 0, .num_planes = 1, .cpp = { 4, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
224 { .format = DRM_FORMAT_XVYU12_16161616, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
225 { .format = DRM_FORMAT_XVYU16161616, .depth = 0, .num_planes = 1, .cpp = { 8, 0, 0 }, .hsub = 1, .vsub = 1, .is_yuv = true },
Alexandru Gheorghe697b6b82018-11-01 15:11:30 +0000226 { .format = DRM_FORMAT_Y0L0, .depth = 0, .num_planes = 1,
227 .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
228 .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
229 { .format = DRM_FORMAT_X0L0, .depth = 0, .num_planes = 1,
230 .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
231 .hsub = 2, .vsub = 2, .is_yuv = true },
232 { .format = DRM_FORMAT_Y0L2, .depth = 0, .num_planes = 1,
233 .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
234 .hsub = 2, .vsub = 2, .has_alpha = true, .is_yuv = true },
235 { .format = DRM_FORMAT_X0L2, .depth = 0, .num_planes = 1,
236 .char_per_block = { 8, 0, 0 }, .block_w = { 2, 0, 0 }, .block_h = { 2, 0, 0 },
237 .hsub = 2, .vsub = 2, .is_yuv = true },
Randy Li05f8bc82019-01-10 03:57:09 +0800238 { .format = DRM_FORMAT_P010, .depth = 0, .num_planes = 2,
Daniel Vetter836b1312019-11-26 10:14:13 +0100239 .char_per_block = { 2, 4, 0 }, .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 },
Randy Li05f8bc82019-01-10 03:57:09 +0800240 .hsub = 2, .vsub = 2, .is_yuv = true},
241 { .format = DRM_FORMAT_P012, .depth = 0, .num_planes = 2,
Daniel Vetter836b1312019-11-26 10:14:13 +0100242 .char_per_block = { 2, 4, 0 }, .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 },
Randy Li05f8bc82019-01-10 03:57:09 +0800243 .hsub = 2, .vsub = 2, .is_yuv = true},
244 { .format = DRM_FORMAT_P016, .depth = 0, .num_planes = 2,
Daniel Vetter836b1312019-11-26 10:14:13 +0100245 .char_per_block = { 2, 4, 0 }, .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 },
Randy Li05f8bc82019-01-10 03:57:09 +0800246 .hsub = 2, .vsub = 2, .is_yuv = true},
Brian Starkey7ba0fee2018-10-05 10:27:00 +0100247 { .format = DRM_FORMAT_P210, .depth = 0,
248 .num_planes = 2, .char_per_block = { 2, 4, 0 },
Daniel Vetter96227282019-11-26 10:14:14 +0100249 .block_w = { 1, 1, 0 }, .block_h = { 1, 1, 0 }, .hsub = 2,
Brian Starkey7ba0fee2018-10-05 10:27:00 +0100250 .vsub = 1, .is_yuv = true },
251 { .format = DRM_FORMAT_VUY101010, .depth = 0,
252 .num_planes = 1, .cpp = { 0, 0, 0 }, .hsub = 1, .vsub = 1,
253 .is_yuv = true },
254 { .format = DRM_FORMAT_YUV420_8BIT, .depth = 0,
255 .num_planes = 1, .cpp = { 0, 0, 0 }, .hsub = 2, .vsub = 2,
256 .is_yuv = true },
257 { .format = DRM_FORMAT_YUV420_10BIT, .depth = 0,
258 .num_planes = 1, .cpp = { 0, 0, 0 }, .hsub = 2, .vsub = 2,
259 .is_yuv = true },
Ben Davis94b292b2020-06-01 17:28:17 +0100260 { .format = DRM_FORMAT_NV15, .depth = 0,
261 .num_planes = 2, .char_per_block = { 5, 5, 0 },
262 .block_w = { 4, 2, 0 }, .block_h = { 1, 1, 0 }, .hsub = 2,
263 .vsub = 2, .is_yuv = true },
264 { .format = DRM_FORMAT_Q410, .depth = 0,
265 .num_planes = 3, .char_per_block = { 2, 2, 2 },
266 .block_w = { 1, 1, 1 }, .block_h = { 1, 1, 1 }, .hsub = 0,
267 .vsub = 0, .is_yuv = true },
268 { .format = DRM_FORMAT_Q401, .depth = 0,
269 .num_planes = 3, .char_per_block = { 2, 2, 2 },
270 .block_w = { 1, 1, 1 }, .block_h = { 1, 1, 1 }, .hsub = 0,
271 .vsub = 0, .is_yuv = true },
Dave Stevenson006ea1b2021-12-15 10:17:37 +0100272 { .format = DRM_FORMAT_P030, .depth = 0, .num_planes = 2,
273 .char_per_block = { 4, 8, 0 }, .block_w = { 3, 3, 0 }, .block_h = { 1, 1, 0 },
274 .hsub = 2, .vsub = 2, .is_yuv = true},
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300275 };
276
277 unsigned int i;
278
279 for (i = 0; i < ARRAY_SIZE(formats); ++i) {
280 if (formats[i].format == format)
281 return &formats[i];
282 }
283
284 return NULL;
285}
Laurent Pinchart333d2da2016-10-18 01:41:12 +0300286
287/**
288 * drm_format_info - query information for a given format
289 * @format: pixel format (DRM_FORMAT_*)
290 *
291 * The caller should only pass a supported pixel format to this function.
292 * Unsupported pixel formats will generate a warning in the kernel log.
293 *
294 * Returns:
295 * The instance of struct drm_format_info that describes the pixel format, or
296 * NULL if the format is unsupported.
297 */
298const struct drm_format_info *drm_format_info(u32 format)
299{
300 const struct drm_format_info *info;
301
302 info = __drm_format_info(format);
303 WARN_ON(!info);
304 return info;
305}
Laurent Pinchart84770cc2016-10-18 01:41:09 +0300306EXPORT_SYMBOL(drm_format_info);
307
308/**
Ville Syrjälä6a0f9eb2017-03-21 20:12:16 +0200309 * drm_get_format_info - query information for a given framebuffer configuration
310 * @dev: DRM device
311 * @mode_cmd: metadata from the userspace fb creation request
312 *
313 * Returns:
314 * The instance of struct drm_format_info that describes the pixel format, or
315 * NULL if the format is unsupported.
316 */
317const struct drm_format_info *
318drm_get_format_info(struct drm_device *dev,
319 const struct drm_mode_fb_cmd2 *mode_cmd)
320{
321 const struct drm_format_info *info = NULL;
322
323 if (dev->mode_config.funcs->get_format_info)
324 info = dev->mode_config.funcs->get_format_info(mode_cmd);
325
326 if (!info)
327 info = drm_format_info(mode_cmd->pixel_format);
328
329 return info;
330}
331EXPORT_SYMBOL(drm_get_format_info);
332
333/**
Alexandru Gheorghe042bf752018-11-01 17:02:05 +0000334 * drm_format_info_block_width - width in pixels of block.
335 * @info: pixel format info
336 * @plane: plane index
337 *
338 * Returns:
339 * The width in pixels of a block, depending on the plane index.
340 */
341unsigned int drm_format_info_block_width(const struct drm_format_info *info,
342 int plane)
343{
344 if (!info || plane < 0 || plane >= info->num_planes)
345 return 0;
346
347 if (!info->block_w[plane])
348 return 1;
349 return info->block_w[plane];
350}
351EXPORT_SYMBOL(drm_format_info_block_width);
352
353/**
354 * drm_format_info_block_height - height in pixels of a block
355 * @info: pixel format info
356 * @plane: plane index
357 *
358 * Returns:
359 * The height in pixels of a block, depending on the plane index.
360 */
361unsigned int drm_format_info_block_height(const struct drm_format_info *info,
362 int plane)
363{
364 if (!info || plane < 0 || plane >= info->num_planes)
365 return 0;
366
367 if (!info->block_h[plane])
368 return 1;
369 return info->block_h[plane];
370}
371EXPORT_SYMBOL(drm_format_info_block_height);
372
373/**
374 * drm_format_info_min_pitch - computes the minimum required pitch in bytes
375 * @info: pixel format info
376 * @plane: plane index
377 * @buffer_width: buffer width in pixels
378 *
379 * Returns:
380 * The minimum required pitch in bytes for a buffer by taking into consideration
381 * the pixel format information and the buffer width.
382 */
383uint64_t drm_format_info_min_pitch(const struct drm_format_info *info,
384 int plane, unsigned int buffer_width)
385{
386 if (!info || plane < 0 || plane >= info->num_planes)
387 return 0;
388
389 return DIV_ROUND_UP_ULL((u64)buffer_width * info->char_per_block[plane],
390 drm_format_info_block_width(info, plane) *
391 drm_format_info_block_height(info, plane));
392}
393EXPORT_SYMBOL(drm_format_info_min_pitch);