2 * Copyright (c) 2016 Laurent Pinchart <laurent.pinchart@ideasonboard.com>
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
22 #ifndef __DRM_FOURCC_H__
23 #define __DRM_FOURCC_H__
25 #include <linux/types.h>
26 #include <uapi/drm/drm_fourcc.h>
29 * DRM formats are little endian. Define host endian variants for the
30 * most common formats here, to reduce the #ifdefs needed in drivers.
32 * Note that the DRM_FORMAT_BIG_ENDIAN flag should only be used in
33 * case the format can't be specified otherwise, so we don't end up
34 * with two values describing the same format.
37 # define DRM_FORMAT_HOST_XRGB1555 (DRM_FORMAT_XRGB1555 | \
38 DRM_FORMAT_BIG_ENDIAN)
39 # define DRM_FORMAT_HOST_RGB565 (DRM_FORMAT_RGB565 | \
40 DRM_FORMAT_BIG_ENDIAN)
41 # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_BGRX8888
42 # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_BGRA8888
44 # define DRM_FORMAT_HOST_XRGB1555 DRM_FORMAT_XRGB1555
45 # define DRM_FORMAT_HOST_RGB565 DRM_FORMAT_RGB565
46 # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_XRGB8888
47 # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_ARGB8888
51 struct drm_mode_fb_cmd2;
54 * struct drm_format_info - information about a DRM format
56 struct drm_format_info {
57 /** @format: 4CC format identifier (DRM_FORMAT_*) */
63 * Color depth (number of bits per pixel excluding padding bits),
64 * valid for a subset of RGB formats only. This is a legacy field, do
65 * not use in new code and set to 0 for new formats.
69 /** @num_planes: Number of color planes (1 to 3) */
76 * Number of bytes per pixel (per plane), this is aliased with
77 * @char_per_block. It is deprecated in favour of using the
78 * triplet @char_per_block, @block_w, @block_h for better
79 * describing the pixel format.
86 * Number of bytes per block (per plane), where blocks are
87 * defined as a rectangle of pixels which are stored next to
88 * each other in a byte aligned memory region. Together with
89 * @block_w and @block_h this is used to properly describe tiles
90 * in tiled formats or to describe groups of pixels in packed
91 * formats for which the memory needed for a single pixel is not
94 * @cpp has been kept for historical reasons because there are
95 * a lot of places in drivers where it's used. In drm core for
96 * generic code paths the preferred way is to use
97 * @char_per_block, drm_format_info_block_width() and
98 * drm_format_info_block_height() which allows handling both
99 * block and non-block formats in the same way.
101 * For formats that are intended to be used only with non-linear
102 * modifiers both @cpp and @char_per_block must be 0 in the
103 * generic format table. Drivers could supply accurate
104 * information from their drm_mode_config.get_format_info hook
105 * if they want the core to be validating the pitch.
107 u8 char_per_block[4];
113 * Block width in pixels, this is intended to be accessed through
114 * drm_format_info_block_width()
121 * Block height in pixels, this is intended to be accessed through
122 * drm_format_info_block_height()
126 /** @hsub: Horizontal chroma subsampling factor */
128 /** @vsub: Vertical chroma subsampling factor */
131 /** @has_alpha: Does the format embeds an alpha component? */
134 /** @is_yuv: Is it a YUV format? */
139 * drm_format_info_is_yuv_packed - check that the format info matches a YUV
140 * format with data laid in a single plane
144 * A boolean indicating whether the format info matches a packed YUV format.
147 drm_format_info_is_yuv_packed(const struct drm_format_info *info)
149 return info->is_yuv && info->num_planes == 1;
153 * drm_format_info_is_yuv_semiplanar - check that the format info matches a YUV
154 * format with data laid in two planes (luminance and chrominance)
158 * A boolean indicating whether the format info matches a semiplanar YUV format.
161 drm_format_info_is_yuv_semiplanar(const struct drm_format_info *info)
163 return info->is_yuv && info->num_planes == 2;
167 * drm_format_info_is_yuv_planar - check that the format info matches a YUV
168 * format with data laid in three planes (one for each YUV component)
172 * A boolean indicating whether the format info matches a planar YUV format.
175 drm_format_info_is_yuv_planar(const struct drm_format_info *info)
177 return info->is_yuv && info->num_planes == 3;
181 * drm_format_info_is_yuv_sampling_410 - check that the format info matches a
182 * YUV format with 4:1:0 sub-sampling
186 * A boolean indicating whether the format info matches a YUV format with 4:1:0
190 drm_format_info_is_yuv_sampling_410(const struct drm_format_info *info)
192 return info->is_yuv && info->hsub == 4 && info->vsub == 4;
196 * drm_format_info_is_yuv_sampling_411 - check that the format info matches a
197 * YUV format with 4:1:1 sub-sampling
201 * A boolean indicating whether the format info matches a YUV format with 4:1:1
205 drm_format_info_is_yuv_sampling_411(const struct drm_format_info *info)
207 return info->is_yuv && info->hsub == 4 && info->vsub == 1;
211 * drm_format_info_is_yuv_sampling_420 - check that the format info matches a
212 * YUV format with 4:2:0 sub-sampling
216 * A boolean indicating whether the format info matches a YUV format with 4:2:0
220 drm_format_info_is_yuv_sampling_420(const struct drm_format_info *info)
222 return info->is_yuv && info->hsub == 2 && info->vsub == 2;
226 * drm_format_info_is_yuv_sampling_422 - check that the format info matches a
227 * YUV format with 4:2:2 sub-sampling
231 * A boolean indicating whether the format info matches a YUV format with 4:2:2
235 drm_format_info_is_yuv_sampling_422(const struct drm_format_info *info)
237 return info->is_yuv && info->hsub == 2 && info->vsub == 1;
241 * drm_format_info_is_yuv_sampling_444 - check that the format info matches a
242 * YUV format with 4:4:4 sub-sampling
246 * A boolean indicating whether the format info matches a YUV format with 4:4:4
250 drm_format_info_is_yuv_sampling_444(const struct drm_format_info *info)
252 return info->is_yuv && info->hsub == 1 && info->vsub == 1;
256 * drm_format_info_plane_width - width of the plane given the first plane
257 * @info: pixel format info
258 * @width: width of the first plane
259 * @plane: plane index
262 * The width of @plane, given that the width of the first plane is @width.
265 int drm_format_info_plane_width(const struct drm_format_info *info, int width,
268 if (!info || plane >= info->num_planes)
274 return width / info->hsub;
278 * drm_format_info_plane_height - height of the plane given the first plane
279 * @info: pixel format info
280 * @height: height of the first plane
281 * @plane: plane index
284 * The height of @plane, given that the height of the first plane is @height.
287 int drm_format_info_plane_height(const struct drm_format_info *info, int height,
290 if (!info || plane >= info->num_planes)
296 return height / info->vsub;
299 const struct drm_format_info *__drm_format_info(u32 format);
300 const struct drm_format_info *drm_format_info(u32 format);
301 const struct drm_format_info *
302 drm_get_format_info(struct drm_device *dev,
303 const struct drm_mode_fb_cmd2 *mode_cmd);
304 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
305 uint32_t drm_driver_legacy_fb_format(struct drm_device *dev,
306 uint32_t bpp, uint32_t depth);
307 unsigned int drm_format_info_block_width(const struct drm_format_info *info,
309 unsigned int drm_format_info_block_height(const struct drm_format_info *info,
311 uint64_t drm_format_info_min_pitch(const struct drm_format_info *info,
312 int plane, unsigned int buffer_width);
314 #endif /* __DRM_FOURCC_H__ */