1 /* $NetBSD: drm_fourcc.h,v 1.2 2021/12/18 23:45:46 riastradh Exp $ */
2
3 /*
4 * Copyright (c) 2016 Laurent Pinchart <laurent.pinchart@ideasonboard.com>
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 #ifndef __DRM_FOURCC_H__
25 #define __DRM_FOURCC_H__
26
27 #include <linux/types.h>
28 #include <uapi/drm/drm_fourcc.h>
29
30 /*
31 * DRM formats are little endian. Define host endian variants for the
32 * most common formats here, to reduce the #ifdefs needed in drivers.
33 *
34 * Note that the DRM_FORMAT_BIG_ENDIAN flag should only be used in
35 * case the format can't be specified otherwise, so we don't end up
36 * with two values describing the same format.
37 */
38 #ifdef __BIG_ENDIAN
39 # define DRM_FORMAT_HOST_XRGB1555 (DRM_FORMAT_XRGB1555 | \
40 DRM_FORMAT_BIG_ENDIAN)
41 # define DRM_FORMAT_HOST_RGB565 (DRM_FORMAT_RGB565 | \
42 DRM_FORMAT_BIG_ENDIAN)
43 # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_BGRX8888
44 # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_BGRA8888
45 #else
46 # define DRM_FORMAT_HOST_XRGB1555 DRM_FORMAT_XRGB1555
47 # define DRM_FORMAT_HOST_RGB565 DRM_FORMAT_RGB565
48 # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_XRGB8888
49 # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_ARGB8888
50 #endif
51
52 struct drm_device;
53 struct drm_mode_fb_cmd2;
54
55 /**
56 * struct drm_format_info - information about a DRM format
57 */
58 struct drm_format_info {
59 /** @format: 4CC format identifier (DRM_FORMAT_*) */
60 u32 format;
61
62 /**
63 * @depth:
64 *
65 * Color depth (number of bits per pixel excluding padding bits),
66 * valid for a subset of RGB formats only. This is a legacy field, do
67 * not use in new code and set to 0 for new formats.
68 */
69 u8 depth;
70
71 /** @num_planes: Number of color planes (1 to 3) */
72 u8 num_planes;
73
74 union {
75 /**
76 * @cpp:
77 *
78 * Number of bytes per pixel (per plane), this is aliased with
79 * @char_per_block. It is deprecated in favour of using the
80 * triplet @char_per_block, @block_w, @block_h for better
81 * describing the pixel format.
82 */
83 u8 cpp[4];
84
85 /**
86 * @char_per_block:
87 *
88 * Number of bytes per block (per plane), where blocks are
89 * defined as a rectangle of pixels which are stored next to
90 * each other in a byte aligned memory region. Together with
91 * @block_w and @block_h this is used to properly describe tiles
92 * in tiled formats or to describe groups of pixels in packed
93 * formats for which the memory needed for a single pixel is not
94 * byte aligned.
95 *
96 * @cpp has been kept for historical reasons because there are
97 * a lot of places in drivers where it's used. In drm core for
98 * generic code paths the preferred way is to use
99 * @char_per_block, drm_format_info_block_width() and
100 * drm_format_info_block_height() which allows handling both
101 * block and non-block formats in the same way.
102 *
103 * For formats that are intended to be used only with non-linear
104 * modifiers both @cpp and @char_per_block must be 0 in the
105 * generic format table. Drivers could supply accurate
106 * information from their drm_mode_config.get_format_info hook
107 * if they want the core to be validating the pitch.
108 */
109 u8 char_per_block[4];
110 };
111
112 /**
113 * @block_w:
114 *
115 * Block width in pixels, this is intended to be accessed through
116 * drm_format_info_block_width()
117 */
118 u8 block_w[4];
119
120 /**
121 * @block_h:
122 *
123 * Block height in pixels, this is intended to be accessed through
124 * drm_format_info_block_height()
125 */
126 u8 block_h[4];
127
128 /** @hsub: Horizontal chroma subsampling factor */
129 u8 hsub;
130 /** @vsub: Vertical chroma subsampling factor */
131 u8 vsub;
132
133 /** @has_alpha: Does the format embeds an alpha component? */
134 bool has_alpha;
135
136 /** @is_yuv: Is it a YUV format? */
137 bool is_yuv;
138 };
139
140 /**
141 * struct drm_format_name_buf - name of a DRM format
142 * @str: string buffer containing the format name
143 */
144 struct drm_format_name_buf {
145 char str[32];
146 };
147
148 /**
149 * drm_format_info_is_yuv_packed - check that the format info matches a YUV
150 * format with data laid in a single plane
151 * @info: format info
152 *
153 * Returns:
154 * A boolean indicating whether the format info matches a packed YUV format.
155 */
156 static inline bool
drm_format_info_is_yuv_packed(const struct drm_format_info * info)157 drm_format_info_is_yuv_packed(const struct drm_format_info *info)
158 {
159 return info->is_yuv && info->num_planes == 1;
160 }
161
162 /**
163 * drm_format_info_is_yuv_semiplanar - check that the format info matches a YUV
164 * format with data laid in two planes (luminance and chrominance)
165 * @info: format info
166 *
167 * Returns:
168 * A boolean indicating whether the format info matches a semiplanar YUV format.
169 */
170 static inline bool
drm_format_info_is_yuv_semiplanar(const struct drm_format_info * info)171 drm_format_info_is_yuv_semiplanar(const struct drm_format_info *info)
172 {
173 return info->is_yuv && info->num_planes == 2;
174 }
175
176 /**
177 * drm_format_info_is_yuv_planar - check that the format info matches a YUV
178 * format with data laid in three planes (one for each YUV component)
179 * @info: format info
180 *
181 * Returns:
182 * A boolean indicating whether the format info matches a planar YUV format.
183 */
184 static inline bool
drm_format_info_is_yuv_planar(const struct drm_format_info * info)185 drm_format_info_is_yuv_planar(const struct drm_format_info *info)
186 {
187 return info->is_yuv && info->num_planes == 3;
188 }
189
190 /**
191 * drm_format_info_is_yuv_sampling_410 - check that the format info matches a
192 * YUV format with 4:1:0 sub-sampling
193 * @info: format info
194 *
195 * Returns:
196 * A boolean indicating whether the format info matches a YUV format with 4:1:0
197 * sub-sampling.
198 */
199 static inline bool
drm_format_info_is_yuv_sampling_410(const struct drm_format_info * info)200 drm_format_info_is_yuv_sampling_410(const struct drm_format_info *info)
201 {
202 return info->is_yuv && info->hsub == 4 && info->vsub == 4;
203 }
204
205 /**
206 * drm_format_info_is_yuv_sampling_411 - check that the format info matches a
207 * YUV format with 4:1:1 sub-sampling
208 * @info: format info
209 *
210 * Returns:
211 * A boolean indicating whether the format info matches a YUV format with 4:1:1
212 * sub-sampling.
213 */
214 static inline bool
drm_format_info_is_yuv_sampling_411(const struct drm_format_info * info)215 drm_format_info_is_yuv_sampling_411(const struct drm_format_info *info)
216 {
217 return info->is_yuv && info->hsub == 4 && info->vsub == 1;
218 }
219
220 /**
221 * drm_format_info_is_yuv_sampling_420 - check that the format info matches a
222 * YUV format with 4:2:0 sub-sampling
223 * @info: format info
224 *
225 * Returns:
226 * A boolean indicating whether the format info matches a YUV format with 4:2:0
227 * sub-sampling.
228 */
229 static inline bool
drm_format_info_is_yuv_sampling_420(const struct drm_format_info * info)230 drm_format_info_is_yuv_sampling_420(const struct drm_format_info *info)
231 {
232 return info->is_yuv && info->hsub == 2 && info->vsub == 2;
233 }
234
235 /**
236 * drm_format_info_is_yuv_sampling_422 - check that the format info matches a
237 * YUV format with 4:2:2 sub-sampling
238 * @info: format info
239 *
240 * Returns:
241 * A boolean indicating whether the format info matches a YUV format with 4:2:2
242 * sub-sampling.
243 */
244 static inline bool
drm_format_info_is_yuv_sampling_422(const struct drm_format_info * info)245 drm_format_info_is_yuv_sampling_422(const struct drm_format_info *info)
246 {
247 return info->is_yuv && info->hsub == 2 && info->vsub == 1;
248 }
249
250 /**
251 * drm_format_info_is_yuv_sampling_444 - check that the format info matches a
252 * YUV format with 4:4:4 sub-sampling
253 * @info: format info
254 *
255 * Returns:
256 * A boolean indicating whether the format info matches a YUV format with 4:4:4
257 * sub-sampling.
258 */
259 static inline bool
drm_format_info_is_yuv_sampling_444(const struct drm_format_info * info)260 drm_format_info_is_yuv_sampling_444(const struct drm_format_info *info)
261 {
262 return info->is_yuv && info->hsub == 1 && info->vsub == 1;
263 }
264
265 /**
266 * drm_format_info_plane_width - width of the plane given the first plane
267 * @info: pixel format info
268 * @width: width of the first plane
269 * @plane: plane index
270 *
271 * Returns:
272 * The width of @plane, given that the width of the first plane is @width.
273 */
274 static inline
drm_format_info_plane_width(const struct drm_format_info * info,int width,int plane)275 int drm_format_info_plane_width(const struct drm_format_info *info, int width,
276 int plane)
277 {
278 if (!info || plane >= info->num_planes)
279 return 0;
280
281 if (plane == 0)
282 return width;
283
284 return width / info->hsub;
285 }
286
287 /**
288 * drm_format_info_plane_height - height of the plane given the first plane
289 * @info: pixel format info
290 * @height: height of the first plane
291 * @plane: plane index
292 *
293 * Returns:
294 * The height of @plane, given that the height of the first plane is @height.
295 */
296 static inline
drm_format_info_plane_height(const struct drm_format_info * info,int height,int plane)297 int drm_format_info_plane_height(const struct drm_format_info *info, int height,
298 int plane)
299 {
300 if (!info || plane >= info->num_planes)
301 return 0;
302
303 if (plane == 0)
304 return height;
305
306 return height / info->vsub;
307 }
308
309 const struct drm_format_info *__drm_format_info(u32 format);
310 const struct drm_format_info *drm_format_info(u32 format);
311 const struct drm_format_info *
312 drm_get_format_info(struct drm_device *dev,
313 const struct drm_mode_fb_cmd2 *mode_cmd);
314 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
315 uint32_t drm_driver_legacy_fb_format(struct drm_device *dev,
316 uint32_t bpp, uint32_t depth);
317 unsigned int drm_format_info_block_width(const struct drm_format_info *info,
318 int plane);
319 unsigned int drm_format_info_block_height(const struct drm_format_info *info,
320 int plane);
321 uint64_t drm_format_info_min_pitch(const struct drm_format_info *info,
322 int plane, unsigned int buffer_width);
323 const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf);
324
325 #endif /* __DRM_FOURCC_H__ */
326