GNU Linux-libre 4.19.211-gnu1
[releases.git] / include / drm / drm_fourcc.h
1 /*
2  * Copyright (c) 2016 Laurent Pinchart <laurent.pinchart@ideasonboard.com>
3  *
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.
13  *
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
20  * OF THIS SOFTWARE.
21  */
22 #ifndef __DRM_FOURCC_H__
23 #define __DRM_FOURCC_H__
24
25 #include <linux/types.h>
26 #include <uapi/drm/drm_fourcc.h>
27
28 struct drm_device;
29 struct drm_mode_fb_cmd2;
30
31 /**
32  * struct drm_format_info - information about a DRM format
33  * @format: 4CC format identifier (DRM_FORMAT_*)
34  * @depth: Color depth (number of bits per pixel excluding padding bits),
35  *      valid for a subset of RGB formats only. This is a legacy field, do not
36  *      use in new code and set to 0 for new formats.
37  * @num_planes: Number of color planes (1 to 3)
38  * @cpp: Number of bytes per pixel (per plane)
39  * @hsub: Horizontal chroma subsampling factor
40  * @vsub: Vertical chroma subsampling factor
41  * @has_alpha: Does the format embeds an alpha component?
42  * @is_yuv: Is it a YUV format?
43  */
44 struct drm_format_info {
45         u32 format;
46         u8 depth;
47         u8 num_planes;
48         u8 cpp[3];
49         u8 hsub;
50         u8 vsub;
51         bool has_alpha;
52         bool is_yuv;
53 };
54
55 /**
56  * struct drm_format_name_buf - name of a DRM format
57  * @str: string buffer containing the format name
58  */
59 struct drm_format_name_buf {
60         char str[32];
61 };
62
63 const struct drm_format_info *__drm_format_info(u32 format);
64 const struct drm_format_info *drm_format_info(u32 format);
65 const struct drm_format_info *
66 drm_get_format_info(struct drm_device *dev,
67                     const struct drm_mode_fb_cmd2 *mode_cmd);
68 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
69 int drm_format_num_planes(uint32_t format);
70 int drm_format_plane_cpp(uint32_t format, int plane);
71 int drm_format_horz_chroma_subsampling(uint32_t format);
72 int drm_format_vert_chroma_subsampling(uint32_t format);
73 int drm_format_plane_width(int width, uint32_t format, int plane);
74 int drm_format_plane_height(int height, uint32_t format, int plane);
75 const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf);
76
77 #endif /* __DRM_FOURCC_H__ */