drm_color_mgmt.h

  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 <linux/math64.h>
 28#include <drm/drm_property.h>
 29
 30struct drm_crtc;
 31struct drm_plane;
 32
 33/**
 34 * drm_color_lut_extract - clamp and round LUT entries
 35 * @user_input: input value
 36 * @bit_precision: number of bits the hw LUT supports
 37 *
 38 * Extract a degamma/gamma LUT value provided by user (in the form of
 39 * &drm_color_lut entries) and round it to the precision supported by the
 40 * hardware, following OpenGL int<->float conversion rules
 41 * (see eg. OpenGL 4.6 specification - 2.3.5 Fixed-Point Data Conversions).
 42 */
 43static inline u32 drm_color_lut_extract(u32 user_input, int bit_precision)
 44{
 45	if (bit_precision > 16)
 46		return DIV_ROUND_CLOSEST_ULL(mul_u32_u32(user_input, (1 << bit_precision) - 1),
 47					     (1 << 16) - 1);
 48	else
 49		return DIV_ROUND_CLOSEST(user_input * ((1 << bit_precision) - 1),
 50					 (1 << 16) - 1);
 51}
 52
 53/**
 54 * drm_color_lut32_extract - clamp and round LUT entries
 55 * @user_input: input value
 56 * @bit_precision: number of bits the hw LUT supports
 57 *
 58 * Extract U0.bit_precision from a U0.32 LUT value.
 59 *
 60 */
 61static inline u32 drm_color_lut32_extract(u32 user_input, int bit_precision)
 62{
 63	u64 max = (bit_precision >= 64) ? ~0ULL : (1ULL << bit_precision) - 1;
 64
 65	return DIV_ROUND_CLOSEST_ULL((u64)user_input * max,
 66				     (1ULL << 32) - 1);
 67}
 68
 69u64 drm_color_ctm_s31_32_to_qm_n(u64 user_input, u32 m, u32 n);
 70
 71void drm_crtc_enable_color_mgmt(struct drm_crtc *crtc,
 72				uint degamma_lut_size,
 73				bool has_ctm,
 74				uint gamma_lut_size);
 75
 76int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
 77				 int gamma_size);
 78
 79/**
 80 * drm_color_lut_size - calculate the number of entries in the LUT
 81 * @blob: blob containing the LUT
 82 *
 83 * Returns:
 84 * The number of entries in the color LUT stored in @blob.
 85 */
 86static inline int drm_color_lut_size(const struct drm_property_blob *blob)
 87{
 88	return blob->length / sizeof(struct drm_color_lut);
 89}
 90
 91/**
 92 * drm_color_lut32_size - calculate the number of entries in the extended LUT
 93 * @blob: blob containing the LUT
 94 *
 95 * Returns:
 96 * The number of entries in the color LUT stored in @blob.
 97 */
 98static inline int drm_color_lut32_size(const struct drm_property_blob *blob)
 99{
100	return blob->length / sizeof(struct drm_color_lut32);
101}
102
103enum drm_color_encoding {
104	DRM_COLOR_YCBCR_BT601,
105	DRM_COLOR_YCBCR_BT709,
106	DRM_COLOR_YCBCR_BT2020,
107	DRM_COLOR_ENCODING_MAX,
108};
109
110enum drm_color_range {
111	DRM_COLOR_YCBCR_LIMITED_RANGE,
112	DRM_COLOR_YCBCR_FULL_RANGE,
113	DRM_COLOR_RANGE_MAX,
114};
115
116int drm_plane_create_color_properties(struct drm_plane *plane,
117				      u32 supported_encodings,
118				      u32 supported_ranges,
119				      enum drm_color_encoding default_encoding,
120				      enum drm_color_range default_range);
121
122/**
123 * enum drm_color_lut_tests - hw-specific LUT tests to perform
124 *
125 * The drm_color_lut_check() function takes a bitmask of the values here to
126 * determine which tests to apply to a userspace-provided LUT.
127 */
128enum drm_color_lut_tests {
129	/**
130	 * @DRM_COLOR_LUT_EQUAL_CHANNELS:
131	 *
132	 * Checks whether the entries of a LUT all have equal values for the
133	 * red, green, and blue channels.  Intended for hardware that only
134	 * accepts a single value per LUT entry and assumes that value applies
135	 * to all three color components.
136	 */
137	DRM_COLOR_LUT_EQUAL_CHANNELS = BIT(0),
138
139	/**
140	 * @DRM_COLOR_LUT_NON_DECREASING:
141	 *
142	 * Checks whether the entries of a LUT are always flat or increasing
143	 * (never decreasing).
144	 */
145	DRM_COLOR_LUT_NON_DECREASING = BIT(1),
146};
147
148int drm_color_lut_check(const struct drm_property_blob *lut, u32 tests);
149
150/*
151 * Gamma-LUT programming
152 */
153
154typedef void (*drm_crtc_set_lut_func)(struct drm_crtc *, unsigned int, u16, u16, u16);
155
156void drm_crtc_load_gamma_888(struct drm_crtc *crtc, const struct drm_color_lut *lut,
157			     drm_crtc_set_lut_func set_gamma);
158void drm_crtc_load_gamma_565_from_888(struct drm_crtc *crtc, const struct drm_color_lut *lut,
159				      drm_crtc_set_lut_func set_gamma);
160void drm_crtc_load_gamma_555_from_888(struct drm_crtc *crtc, const struct drm_color_lut *lut,
161				      drm_crtc_set_lut_func set_gamma);
162
163void drm_crtc_fill_gamma_888(struct drm_crtc *crtc, drm_crtc_set_lut_func set_gamma);
164void drm_crtc_fill_gamma_565(struct drm_crtc *crtc, drm_crtc_set_lut_func set_gamma);
165void drm_crtc_fill_gamma_555(struct drm_crtc *crtc, drm_crtc_set_lut_func set_gamma);
166
167/*
168 * Color-LUT programming
169 */
170
171void drm_crtc_load_palette_8(struct drm_crtc *crtc, const struct drm_color_lut *lut,
172			     drm_crtc_set_lut_func set_palette);
173
174void drm_crtc_fill_palette_332(struct drm_crtc *crtc, drm_crtc_set_lut_func set_palette);
175void drm_crtc_fill_palette_8(struct drm_crtc *crtc, drm_crtc_set_lut_func set_palette);
176
177int drm_color_lut32_check(const struct drm_property_blob *lut, u32 tests);
178#endif