include/drm/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
  30 struct drm_crtc;
  31 struct 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.
  41  */
  42 static inline u32 drm_color_lut_extract(u32 user_input, int bit_precision)
  43 {
  44         u32 val = user_input;
  45         u32 max = 0xffff >> (16 - bit_precision);
  46
  47         /* Round only if we're not using full precision. */
  48         if (bit_precision < 16) {
  49                 val += 1UL << (16 - bit_precision - 1);
  50                 val >>= 16 - bit_precision;
  51         }
  52
  53         return clamp_val(val, 0, max);
  54 }
  55
  56 u64 drm_color_ctm_s31_32_to_qm_n(u64 user_input, u32 m, u32 n);
  57
  58 void drm_crtc_enable_color_mgmt(struct drm_crtc *crtc,
  59                                 uint degamma_lut_size,
  60                                 bool has_ctm,
  61                                 uint gamma_lut_size);
  62
  63 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
  64                                  int gamma_size);
  65
  66 /**
  67  * drm_color_lut_size - calculate the number of entries in the LUT
  68  * @blob: blob containing the LUT
  69  *
  70  * Returns:
  71  * The number of entries in the color LUT stored in @blob.
  72  */
  73 static inline int drm_color_lut_size(const struct drm_property_blob *blob)
  74 {
  75         return blob->length / sizeof(struct drm_color_lut);
  76 }
  77
  78 enum drm_color_encoding {
  79         DRM_COLOR_YCBCR_BT601,
  80         DRM_COLOR_YCBCR_BT709,
  81         DRM_COLOR_YCBCR_BT2020,
  82         DRM_COLOR_ENCODING_MAX,
  83 };
  84
  85 enum drm_color_range {
  86         DRM_COLOR_YCBCR_LIMITED_RANGE,
  87         DRM_COLOR_YCBCR_FULL_RANGE,
  88         DRM_COLOR_RANGE_MAX,
  89 };
  90
  91 int drm_plane_create_color_properties(struct drm_plane *plane,
  92                                       u32 supported_encodings,
  93                                       u32 supported_ranges,
  94                                       enum drm_color_encoding default_encoding,
  95                                       enum drm_color_range default_range);
  96
  97 /**
  98  * enum drm_color_lut_tests - hw-specific LUT tests to perform
  99  *
 100  * The drm_color_lut_check() function takes a bitmask of the values here to
 101  * determine which tests to apply to a userspace-provided LUT.
 102  */
 103 enum drm_color_lut_tests {
 104         /**
 105          * @DRM_COLOR_LUT_EQUAL_CHANNELS:
 106          *
 107          * Checks whether the entries of a LUT all have equal values for the
 108          * red, green, and blue channels.  Intended for hardware that only
 109          * accepts a single value per LUT entry and assumes that value applies
 110          * to all three color components.
 111          */
 112         DRM_COLOR_LUT_EQUAL_CHANNELS = BIT(0),
 113
 114         /**
 115          * @DRM_COLOR_LUT_NON_DECREASING:
 116          *
 117          * Checks whether the entries of a LUT are always flat or increasing
 118          * (never decreasing).
 119          */
 120         DRM_COLOR_LUT_NON_DECREASING = BIT(1),
 121 };
 122
 123 int drm_color_lut_check(const struct drm_property_blob *lut, u32 tests);
 124 #endif