drm_color_mgmt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting documentation, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THIS SOFTWARE.
 */
 
#ifndef __DRM_COLOR_MGMT_H__
#define __DRM_COLOR_MGMT_H__
 
#include <linux/ctype.h>
#include <linux/math64.h>
#include <drm/drm_property.h>
 
struct drm_crtc;
struct drm_plane;
 
static inline u32 drm_color_lut_extract(u32 user_input, int bit_precision)
{
    if (bit_precision > 16)
        return DIV_ROUND_CLOSEST_ULL(mul_u32_u32(user_input, (1 << bit_precision) - 1),
                         (1 << 16) - 1);
    else
        return DIV_ROUND_CLOSEST(user_input * ((1 << bit_precision) - 1),
                     (1 << 16) - 1);
}
 
static inline u32 drm_color_lut32_extract(u32 user_input, int bit_precision)
{
    u64 max = (bit_precision >= 64) ? ~0ULL : (1ULL << bit_precision) - 1;
 
    return DIV_ROUND_CLOSEST_ULL((u64)user_input * max,
                     (1ULL << 32) - 1);
}
 
u64 drm_color_ctm_s31_32_to_qm_n(u64 user_input, u32 m, u32 n);
 
void drm_crtc_enable_color_mgmt(struct drm_crtc *crtc,
                uint degamma_lut_size,
                bool has_ctm,
                uint gamma_lut_size);
 
int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
                 int gamma_size);
 
static inline int drm_color_lut_size(const struct drm_property_blob *blob)
{
    return blob->length / sizeof(struct drm_color_lut);
}
 
static inline int drm_color_lut32_size(const struct drm_property_blob *blob)
{
    return blob->length / sizeof(struct drm_color_lut32);
}
 
enum drm_color_encoding {
    DRM_COLOR_YCBCR_BT601,
    DRM_COLOR_YCBCR_BT709,
    DRM_COLOR_YCBCR_BT2020,
    DRM_COLOR_ENCODING_MAX,
};
 
enum drm_color_range {
    DRM_COLOR_YCBCR_LIMITED_RANGE,
    DRM_COLOR_YCBCR_FULL_RANGE,
    DRM_COLOR_RANGE_MAX,
};
 
int drm_plane_create_color_properties(struct drm_plane *plane,
                      u32 supported_encodings,
                      u32 supported_ranges,
                      enum drm_color_encoding default_encoding,
                      enum drm_color_range default_range);
 
enum drm_color_lut_tests {
    DRM_COLOR_LUT_EQUAL_CHANNELS = BIT(0),
 
    DRM_COLOR_LUT_NON_DECREASING = BIT(1),
};
 
int drm_color_lut_check(const struct drm_property_blob *lut, u32 tests);
 
/*
 * Gamma-LUT programming
 */
 
typedef void (*drm_crtc_set_lut_func)(struct drm_crtc *, unsigned int, u16, u16, u16);
 
void drm_crtc_load_gamma_888(struct drm_crtc *crtc, const struct drm_color_lut *lut,
                 drm_crtc_set_lut_func set_gamma);
void drm_crtc_load_gamma_565_from_888(struct drm_crtc *crtc, const struct drm_color_lut *lut,
                      drm_crtc_set_lut_func set_gamma);
void drm_crtc_load_gamma_555_from_888(struct drm_crtc *crtc, const struct drm_color_lut *lut,
                      drm_crtc_set_lut_func set_gamma);
 
void drm_crtc_fill_gamma_888(struct drm_crtc *crtc, drm_crtc_set_lut_func set_gamma);
void drm_crtc_fill_gamma_565(struct drm_crtc *crtc, drm_crtc_set_lut_func set_gamma);
void drm_crtc_fill_gamma_555(struct drm_crtc *crtc, drm_crtc_set_lut_func set_gamma);
 
/*
 * Color-LUT programming
 */
 
void drm_crtc_load_palette_8(struct drm_crtc *crtc, const struct drm_color_lut *lut,
                 drm_crtc_set_lut_func set_palette);
 
void drm_crtc_fill_palette_332(struct drm_crtc *crtc, drm_crtc_set_lut_func set_palette);
void drm_crtc_fill_palette_8(struct drm_crtc *crtc, drm_crtc_set_lut_func set_palette);
 
int drm_color_lut32_check(const struct drm_property_blob *lut, u32 tests);
#endif