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
55 * @format: 4CC format identifier (DRM_FORMAT_*)
56 * @depth: Color depth (number of bits per pixel excluding padding bits),
57 * valid for a subset of RGB formats only. This is a legacy field, do not
58 * use in new code and set to 0 for new formats.
59 * @num_planes: Number of color planes (1 to 3)
60 * @cpp: Number of bytes per pixel (per plane)
61 * @hsub: Horizontal chroma subsampling factor
62 * @vsub: Vertical chroma subsampling factor
63 * @has_alpha: Does the format embeds an alpha component?
64 * @is_yuv: Is it a YUV format?
66 struct drm_format_info {
78 * struct drm_format_name_buf - name of a DRM format
79 * @str: string buffer containing the format name
81 struct drm_format_name_buf {
85 const struct drm_format_info *__drm_format_info(u32 format);
86 const struct drm_format_info *drm_format_info(u32 format);
87 const struct drm_format_info *
88 drm_get_format_info(struct drm_device *dev,
89 const struct drm_mode_fb_cmd2 *mode_cmd);
90 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
91 uint32_t drm_driver_legacy_fb_format(struct drm_device *dev,
92 uint32_t bpp, uint32_t depth);
93 int drm_format_num_planes(uint32_t format);
94 int drm_format_plane_cpp(uint32_t format, int plane);
95 int drm_format_horz_chroma_subsampling(uint32_t format);
96 int drm_format_vert_chroma_subsampling(uint32_t format);
97 int drm_format_plane_width(int width, uint32_t format, int plane);
98 int drm_format_plane_height(int height, uint32_t format, int plane);
99 const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf);
101 #endif /* __DRM_FOURCC_H__ */