drm_colorop.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
/*
 * Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Authors: AMD
 *
 */
 
#ifndef __DRM_COLOROP_H__
#define __DRM_COLOROP_H__
 
#include <drm/drm_mode_object.h>
#include <drm/drm_mode.h>
#include <drm/drm_property.h>
 
/* DRM colorop flags */
#define DRM_COLOROP_FLAG_ALLOW_BYPASS   (1<<0)  /* Allow bypass on the drm_colorop */
 
enum drm_colorop_curve_1d_type {
    DRM_COLOROP_1D_CURVE_SRGB_EOTF,
 
    DRM_COLOROP_1D_CURVE_SRGB_INV_EOTF,
 
    DRM_COLOROP_1D_CURVE_PQ_125_EOTF,
 
    DRM_COLOROP_1D_CURVE_PQ_125_INV_EOTF,
 
    DRM_COLOROP_1D_CURVE_BT2020_INV_OETF,
 
    DRM_COLOROP_1D_CURVE_BT2020_OETF,
 
    DRM_COLOROP_1D_CURVE_GAMMA22,
 
    DRM_COLOROP_1D_CURVE_GAMMA22_INV,
    DRM_COLOROP_1D_CURVE_COUNT
};
 
struct drm_colorop_state {
    struct drm_colorop *colorop;
 
    /*
     * Color properties
     *
     * The following fields are not always valid, their usage depends
     * on the colorop type. See their associated comment for more
     * information.
     */
 
    bool bypass;
 
    enum drm_colorop_curve_1d_type curve_1d_type;
 
    uint64_t multiplier;
 
    struct drm_property_blob *data;
 
    enum drm_colorop_lut1d_interpolation_type lut1d_interpolation;
 
    enum drm_colorop_lut3d_interpolation_type lut3d_interpolation;
 
    struct drm_atomic_commit *state;
};
 
struct drm_colorop_funcs {
    void (*destroy)(struct drm_colorop *colorop);
};
 
struct drm_colorop {
    struct drm_device *dev;
 
    struct list_head head;
 
    unsigned int index;
 
    struct drm_mode_object base;
 
    struct drm_plane *plane;
 
    struct drm_colorop_state *state;
 
    /*
     * Color properties
     *
     * The following fields are not always valid, their usage depends
     * on the colorop type. See their associated comment for more
     * information.
     */
 
    struct drm_object_properties properties;
 
    enum drm_colorop_type type;
 
    struct drm_colorop *next;
 
    struct drm_property *type_property;
 
    struct drm_property *bypass_property;
 
    uint32_t size;
 
    struct drm_property *lut1d_interpolation_property;
 
    struct drm_property *curve_1d_type_property;
 
    struct drm_property *multiplier_property;
 
    struct drm_property *size_property;
 
    struct drm_property *lut3d_interpolation_property;
 
    struct drm_property *data_property;
 
    struct drm_property *next_property;
 
    const struct drm_colorop_funcs *funcs;
};
 
#define obj_to_colorop(x) container_of(x, struct drm_colorop, base)
 
static inline struct drm_colorop *drm_colorop_find(struct drm_device *dev,
                           struct drm_file *file_priv,
                           uint32_t id)
{
    struct drm_mode_object *mo;
 
    mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_COLOROP);
    return mo ? obj_to_colorop(mo) : NULL;
}
 
void drm_colorop_pipeline_destroy(struct drm_device *dev);
void drm_colorop_cleanup(struct drm_colorop *colorop);
 
int drm_plane_colorop_curve_1d_init(struct drm_device *dev, struct drm_colorop *colorop,
                    struct drm_plane *plane, const struct drm_colorop_funcs *funcs,
                    u64 supported_tfs, uint32_t flags);
int drm_plane_colorop_curve_1d_lut_init(struct drm_device *dev, struct drm_colorop *colorop,
                    struct drm_plane *plane,
                    const struct drm_colorop_funcs *funcs,
                    uint32_t lut_size,
                    enum drm_colorop_lut1d_interpolation_type interpolation,
                    uint32_t flags);
int drm_plane_colorop_ctm_3x4_init(struct drm_device *dev, struct drm_colorop *colorop,
                   struct drm_plane *plane, const struct drm_colorop_funcs *funcs,
                   uint32_t flags);
int drm_plane_colorop_mult_init(struct drm_device *dev, struct drm_colorop *colorop,
                struct drm_plane *plane, const struct drm_colorop_funcs *funcs,
                uint32_t flags);
int drm_plane_colorop_3dlut_init(struct drm_device *dev, struct drm_colorop *colorop,
                 struct drm_plane *plane, const struct drm_colorop_funcs *funcs,
                 uint32_t lut_size,
                 enum drm_colorop_lut3d_interpolation_type interpolation,
                 uint32_t flags);
 
struct drm_colorop_state *
drm_atomic_helper_colorop_duplicate_state(struct drm_colorop *colorop);
 
void drm_colorop_atomic_destroy_state(struct drm_colorop *colorop,
                      struct drm_colorop_state *state);
 
void drm_colorop_reset(struct drm_colorop *colorop);
 
void drm_colorop_destroy(struct drm_colorop *colorop);
 
static inline unsigned int drm_colorop_index(const struct drm_colorop *colorop)
{
    return colorop->index;
}
 
#define drm_for_each_colorop(colorop, dev) \
    list_for_each_entry(colorop, &(dev)->mode_config.colorop_list, head)
 
const char *drm_get_colorop_type_name(enum drm_colorop_type type);
 
const char *drm_get_colorop_curve_1d_type_name(enum drm_colorop_curve_1d_type type);
 
const char *
drm_get_colorop_lut1d_interpolation_name(enum drm_colorop_lut1d_interpolation_type type);
 
const char *
drm_get_colorop_lut3d_interpolation_name(enum drm_colorop_lut3d_interpolation_type type);
 
void drm_colorop_set_next_property(struct drm_colorop *colorop, struct drm_colorop *next);
 
#endif /* __DRM_COLOROP_H__ */