xref: /openbmc/linux/include/drm/drm_color_mgmt.h (revision 7ca7fcef)
1 /*
2  * Copyright (c) 2016 Intel Corporation
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 
23 #ifndef __DRM_COLOR_MGMT_H__
24 #define __DRM_COLOR_MGMT_H__
25 
26 #include <linux/ctype.h>
27 #include <drm/drm_property.h>
28 
29 struct drm_crtc;
30 struct drm_plane;
31 
32 uint32_t drm_color_lut_extract(uint32_t user_input, uint32_t bit_precision);
33 u64 drm_color_ctm_s31_32_to_qm_n(u64 user_input, u32 m, u32 n);
34 
35 void drm_crtc_enable_color_mgmt(struct drm_crtc *crtc,
36 				uint degamma_lut_size,
37 				bool has_ctm,
38 				uint gamma_lut_size);
39 
40 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
41 				 int gamma_size);
42 
43 /**
44  * drm_color_lut_size - calculate the number of entries in the LUT
45  * @blob: blob containing the LUT
46  *
47  * Returns:
48  * The number of entries in the color LUT stored in @blob.
49  */
50 static inline int drm_color_lut_size(const struct drm_property_blob *blob)
51 {
52 	return blob->length / sizeof(struct drm_color_lut);
53 }
54 
55 enum drm_color_encoding {
56 	DRM_COLOR_YCBCR_BT601,
57 	DRM_COLOR_YCBCR_BT709,
58 	DRM_COLOR_YCBCR_BT2020,
59 	DRM_COLOR_ENCODING_MAX,
60 };
61 
62 enum drm_color_range {
63 	DRM_COLOR_YCBCR_LIMITED_RANGE,
64 	DRM_COLOR_YCBCR_FULL_RANGE,
65 	DRM_COLOR_RANGE_MAX,
66 };
67 
68 int drm_plane_create_color_properties(struct drm_plane *plane,
69 				      u32 supported_encodings,
70 				      u32 supported_ranges,
71 				      enum drm_color_encoding default_encoding,
72 				      enum drm_color_range default_range);
73 
74 /**
75  * enum drm_color_lut_tests - hw-specific LUT tests to perform
76  *
77  * The drm_color_lut_check() function takes a bitmask of the values here to
78  * determine which tests to apply to a userspace-provided LUT.
79  */
80 enum drm_color_lut_tests {
81 	/**
82 	 * @DRM_COLOR_LUT_EQUAL_CHANNELS:
83 	 *
84 	 * Checks whether the entries of a LUT all have equal values for the
85 	 * red, green, and blue channels.  Intended for hardware that only
86 	 * accepts a single value per LUT entry and assumes that value applies
87 	 * to all three color components.
88 	 */
89 	DRM_COLOR_LUT_EQUAL_CHANNELS = BIT(0),
90 
91 	/**
92 	 * @DRM_COLOR_LUT_NON_DECREASING:
93 	 *
94 	 * Checks whether the entries of a LUT are always flat or increasing
95 	 * (never decreasing).
96 	 */
97 	DRM_COLOR_LUT_NON_DECREASING = BIT(1),
98 };
99 
100 int drm_color_lut_check(const struct drm_property_blob *lut, u32 tests);
101 #endif
102