drm/colorop: Introduce new drm_colorop mode object

This patches introduces a new drm_colorop mode object. This
object represents color transformations and can be used to
define color pipelines.

We also introduce the drm_colorop_state here, as well as
various helpers and state tracking bits.

Reviewed-by: Simon Ser <contact@emersion.fr>
Signed-off-by: Alex Hung <alex.hung@amd.com>
Signed-off-by: Harry Wentland <harry.wentland@amd.com>
Reviewed-by: Daniel Stone <daniels@collabora.com>
Reviewed-by: Melissa Wen <mwen@igalia.com>
Reviewed-by: Sebastian Wick <sebastian.wick@redhat.com>
Signed-off-by: Simon Ser <contact@emersion.fr>
Link: https://patch.msgid.link/20251115000237.3561250-5-alex.hung@amd.com
This commit is contained in:
Harry Wentland 2025-11-14 17:01:29 -07:00 committed by Simon Ser
parent bcaefdaaeb
commit cfc27680ee
12 changed files with 504 additions and 0 deletions

View File

@ -41,6 +41,7 @@ drm-y := \
drm_bridge.o \
drm_cache.o \
drm_color_mgmt.o \
drm_colorop.o \
drm_connector.o \
drm_crtc.o \
drm_displayid.o \

View File

@ -42,6 +42,7 @@
#include <drm/drm_mode.h>
#include <drm/drm_print.h>
#include <drm/drm_writeback.h>
#include <drm/drm_colorop.h>
#include "drm_crtc_internal.h"
#include "drm_internal.h"
@ -107,6 +108,7 @@ void drm_atomic_state_default_release(struct drm_atomic_state *state)
kfree(state->connectors);
kfree(state->crtcs);
kfree(state->planes);
kfree(state->colorops);
kfree(state->private_objs);
}
EXPORT_SYMBOL(drm_atomic_state_default_release);
@ -138,6 +140,10 @@ drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state)
sizeof(*state->planes), GFP_KERNEL);
if (!state->planes)
goto fail;
state->colorops = kcalloc(dev->mode_config.num_colorop,
sizeof(*state->colorops), GFP_KERNEL);
if (!state->colorops)
goto fail;
/*
* Because drm_atomic_state can be committed asynchronously we need our
@ -251,6 +257,20 @@ void drm_atomic_state_default_clear(struct drm_atomic_state *state)
state->planes[i].new_state = NULL;
}
for (i = 0; i < config->num_colorop; i++) {
struct drm_colorop *colorop = state->colorops[i].ptr;
if (!colorop)
continue;
drm_colorop_atomic_destroy_state(colorop,
state->colorops[i].state);
state->colorops[i].ptr = NULL;
state->colorops[i].state = NULL;
state->colorops[i].old_state = NULL;
state->colorops[i].new_state = NULL;
}
for (i = 0; i < state->num_private_objs; i++) {
struct drm_private_obj *obj = state->private_objs[i].ptr;
@ -572,6 +592,55 @@ drm_atomic_get_plane_state(struct drm_atomic_state *state,
}
EXPORT_SYMBOL(drm_atomic_get_plane_state);
/**
* drm_atomic_get_colorop_state - get colorop state
* @state: global atomic state object
* @colorop: colorop to get state object for
*
* This function returns the colorop state for the given colorop, allocating it
* if needed. It will also grab the relevant plane lock to make sure that the
* state is consistent.
*
* Returns:
*
* Either the allocated state or the error code encoded into the pointer. When
* the error is EDEADLK then the w/w mutex code has detected a deadlock and the
* entire atomic sequence must be restarted. All other errors are fatal.
*/
struct drm_colorop_state *
drm_atomic_get_colorop_state(struct drm_atomic_state *state,
struct drm_colorop *colorop)
{
int ret, index = drm_colorop_index(colorop);
struct drm_colorop_state *colorop_state;
WARN_ON(!state->acquire_ctx);
colorop_state = drm_atomic_get_new_colorop_state(state, colorop);
if (colorop_state)
return colorop_state;
ret = drm_modeset_lock(&colorop->plane->mutex, state->acquire_ctx);
if (ret)
return ERR_PTR(ret);
colorop_state = drm_atomic_helper_colorop_duplicate_state(colorop);
if (!colorop_state)
return ERR_PTR(-ENOMEM);
state->colorops[index].state = colorop_state;
state->colorops[index].ptr = colorop;
state->colorops[index].old_state = colorop->state;
state->colorops[index].new_state = colorop_state;
colorop_state->state = state;
drm_dbg_atomic(colorop->dev, "Added [COLOROP:%d] %p state to %p\n",
colorop->base.id, colorop_state, state);
return colorop_state;
}
EXPORT_SYMBOL(drm_atomic_get_colorop_state);
static bool
plane_switching_crtc(const struct drm_plane_state *old_plane_state,
const struct drm_plane_state *new_plane_state)

View File

@ -3184,6 +3184,8 @@ int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
struct drm_crtc_state *old_crtc_state, *new_crtc_state;
struct drm_plane *plane;
struct drm_plane_state *old_plane_state, *new_plane_state;
struct drm_colorop *colorop;
struct drm_colorop_state *old_colorop_state, *new_colorop_state;
struct drm_crtc_commit *commit;
struct drm_private_obj *obj;
struct drm_private_state *old_obj_state, *new_obj_state;
@ -3261,6 +3263,16 @@ int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
}
}
for_each_oldnew_colorop_in_state(state, colorop, old_colorop_state, new_colorop_state, i) {
WARN_ON(colorop->state != old_colorop_state);
old_colorop_state->state = state;
new_colorop_state->state = NULL;
state->colorops[i].state = old_colorop_state;
colorop->state = new_colorop_state;
}
drm_panic_lock(state->dev, flags);
for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
WARN_ON(plane->state != old_plane_state);

View File

@ -35,6 +35,7 @@
#include <drm/drm_drv.h>
#include <drm/drm_writeback.h>
#include <drm/drm_vblank.h>
#include <drm/drm_colorop.h>
#include <linux/export.h>
#include <linux/dma-fence.h>
@ -648,6 +649,26 @@ drm_atomic_plane_get_property(struct drm_plane *plane,
return 0;
}
static int drm_atomic_colorop_set_property(struct drm_colorop *colorop,
struct drm_colorop_state *state,
struct drm_file *file_priv,
struct drm_property *property,
uint64_t val)
{
drm_dbg_atomic(colorop->dev,
"[COLOROP:%d] unknown property [PROP:%d:%s]]\n",
colorop->base.id, property->base.id, property->name);
return -EINVAL;
}
static int
drm_atomic_colorop_get_property(struct drm_colorop *colorop,
const struct drm_colorop_state *state,
struct drm_property *property, uint64_t *val)
{
return -EINVAL;
}
static int drm_atomic_set_writeback_fb_for_connector(
struct drm_connector_state *conn_state,
struct drm_framebuffer *fb)
@ -914,6 +935,15 @@ int drm_atomic_get_property(struct drm_mode_object *obj,
plane->state, property, val);
break;
}
case DRM_MODE_OBJECT_COLOROP: {
struct drm_colorop *colorop = obj_to_colorop(obj);
if (colorop->plane)
WARN_ON(!drm_modeset_is_locked(&colorop->plane->mutex));
ret = drm_atomic_colorop_get_property(colorop, colorop->state, property, val);
break;
}
default:
drm_dbg_atomic(dev, "[OBJECT:%d] has no properties\n", obj->id);
ret = -EINVAL;
@ -1111,6 +1141,21 @@ int drm_atomic_set_property(struct drm_atomic_state *state,
ret = drm_atomic_plane_set_property(plane,
plane_state, file_priv,
prop, prop_value);
break;
}
case DRM_MODE_OBJECT_COLOROP: {
struct drm_colorop *colorop = obj_to_colorop(obj);
struct drm_colorop_state *colorop_state;
colorop_state = drm_atomic_get_colorop_state(state, colorop);
if (IS_ERR(colorop_state)) {
ret = PTR_ERR(colorop_state);
break;
}
ret = drm_atomic_colorop_set_property(colorop, colorop_state,
file_priv, prop, prop_value);
break;
}
default:

View File

@ -0,0 +1,103 @@
// 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
*
*/
#include <drm/drm_colorop.h>
#include <drm/drm_print.h>
#include <drm/drm_drv.h>
#include <drm/drm_plane.h>
#include "drm_crtc_internal.h"
static void __drm_atomic_helper_colorop_duplicate_state(struct drm_colorop *colorop,
struct drm_colorop_state *state)
{
memcpy(state, colorop->state, sizeof(*state));
}
struct drm_colorop_state *
drm_atomic_helper_colorop_duplicate_state(struct drm_colorop *colorop)
{
struct drm_colorop_state *state;
if (WARN_ON(!colorop->state))
return NULL;
state = kmalloc(sizeof(*state), GFP_KERNEL);
if (state)
__drm_atomic_helper_colorop_duplicate_state(colorop, state);
return state;
}
void drm_colorop_atomic_destroy_state(struct drm_colorop *colorop,
struct drm_colorop_state *state)
{
kfree(state);
}
/**
* __drm_colorop_state_reset - resets colorop state to default values
* @colorop_state: atomic colorop state, must not be NULL
* @colorop: colorop object, must not be NULL
*
* Initializes the newly allocated @colorop_state with default
* values. This is useful for drivers that subclass the CRTC state.
*/
static void __drm_colorop_state_reset(struct drm_colorop_state *colorop_state,
struct drm_colorop *colorop)
{
colorop_state->colorop = colorop;
}
/**
* __drm_colorop_reset - reset state on colorop
* @colorop: drm colorop
* @colorop_state: colorop state to assign
*
* Initializes the newly allocated @colorop_state and assigns it to
* the &drm_crtc->state pointer of @colorop, usually required when
* initializing the drivers or when called from the &drm_colorop_funcs.reset
* hook.
*
* This is useful for drivers that subclass the colorop state.
*/
static void __drm_colorop_reset(struct drm_colorop *colorop,
struct drm_colorop_state *colorop_state)
{
if (colorop_state)
__drm_colorop_state_reset(colorop_state, colorop);
colorop->state = colorop_state;
}
void drm_colorop_reset(struct drm_colorop *colorop)
{
kfree(colorop->state);
colorop->state = kzalloc(sizeof(*colorop->state), GFP_KERNEL);
if (colorop->state)
__drm_colorop_reset(colorop, colorop->state);
}

View File

@ -30,6 +30,7 @@
#include <drm/drm_managed.h>
#include <drm/drm_mode_config.h>
#include <drm/drm_print.h>
#include <drm/drm_colorop.h>
#include <linux/dma-resv.h>
#include "drm_crtc_internal.h"
@ -192,11 +193,15 @@ int drm_mode_getresources(struct drm_device *dev, void *data,
void drm_mode_config_reset(struct drm_device *dev)
{
struct drm_crtc *crtc;
struct drm_colorop *colorop;
struct drm_plane *plane;
struct drm_encoder *encoder;
struct drm_connector *connector;
struct drm_connector_list_iter conn_iter;
drm_for_each_colorop(colorop, dev)
drm_colorop_reset(colorop);
drm_for_each_plane(plane, dev)
if (plane->funcs->reset)
plane->funcs->reset(plane);
@ -437,6 +442,7 @@ int drmm_mode_config_init(struct drm_device *dev)
INIT_LIST_HEAD(&dev->mode_config.property_list);
INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
INIT_LIST_HEAD(&dev->mode_config.plane_list);
INIT_LIST_HEAD(&dev->mode_config.colorop_list);
INIT_LIST_HEAD(&dev->mode_config.privobj_list);
idr_init_base(&dev->mode_config.object_idr, 1);
idr_init_base(&dev->mode_config.tile_idr, 1);
@ -458,6 +464,7 @@ int drmm_mode_config_init(struct drm_device *dev)
dev->mode_config.num_crtc = 0;
dev->mode_config.num_encoder = 0;
dev->mode_config.num_total_plane = 0;
dev->mode_config.num_colorop = 0;
if (IS_ENABLED(CONFIG_LOCKDEP)) {
struct drm_modeset_acquire_ctx modeset_ctx;

View File

@ -30,6 +30,7 @@
#include <drm/drm_crtc.h>
#include <drm/drm_util.h>
#include <drm/drm_colorop.h>
/**
* struct drm_crtc_commit - track modeset commits on a CRTC
@ -157,6 +158,11 @@ struct drm_crtc_commit {
bool abort_completion;
};
struct __drm_colorops_state {
struct drm_colorop *ptr;
struct drm_colorop_state *state, *old_state, *new_state;
};
struct __drm_planes_state {
struct drm_plane *ptr;
@ -531,6 +537,14 @@ struct drm_atomic_state {
*/
bool checked : 1;
/**
* @colorops:
*
* Pointer to array of @drm_colorop and @drm_colorop_state part of this
* update.
*/
struct __drm_colorops_state *colorops;
/**
* @planes:
*
@ -672,6 +686,9 @@ drm_atomic_get_crtc_state(struct drm_atomic_state *state,
struct drm_plane_state * __must_check
drm_atomic_get_plane_state(struct drm_atomic_state *state,
struct drm_plane *plane);
struct drm_colorop_state *
drm_atomic_get_colorop_state(struct drm_atomic_state *state,
struct drm_colorop *colorop);
struct drm_connector_state * __must_check
drm_atomic_get_connector_state(struct drm_atomic_state *state,
struct drm_connector *connector);
@ -768,6 +785,36 @@ drm_atomic_get_new_plane_state(const struct drm_atomic_state *state,
return state->planes[drm_plane_index(plane)].new_state;
}
/**
* drm_atomic_get_old_colorop_state - get colorop state, if it exists
* @state: global atomic state object
* @colorop: colorop to grab
*
* This function returns the old colorop state for the given colorop, or
* NULL if the colorop is not part of the global atomic state.
*/
static inline struct drm_colorop_state *
drm_atomic_get_old_colorop_state(struct drm_atomic_state *state,
struct drm_colorop *colorop)
{
return state->colorops[drm_colorop_index(colorop)].old_state;
}
/**
* drm_atomic_get_new_colorop_state - get colorop state, if it exists
* @state: global atomic state object
* @colorop: colorop to grab
*
* This function returns the new colorop state for the given colorop, or
* NULL if the colorop is not part of the global atomic state.
*/
static inline struct drm_colorop_state *
drm_atomic_get_new_colorop_state(struct drm_atomic_state *state,
struct drm_colorop *colorop)
{
return state->colorops[drm_colorop_index(colorop)].new_state;
}
/**
* drm_atomic_get_old_connector_state - get connector state, if it exists
* @state: global atomic state object
@ -998,6 +1045,29 @@ void drm_state_dump(struct drm_device *dev, struct drm_printer *p);
(new_crtc_state) = (__state)->crtcs[__i].new_state, \
(void)(new_crtc_state) /* Only to avoid unused-but-set-variable warning */, 1))
/**
* for_each_oldnew_colorop_in_state - iterate over all colorops in an atomic update
* @__state: &struct drm_atomic_state pointer
* @colorop: &struct drm_colorop iteration cursor
* @old_colorop_state: &struct drm_colorop_state iteration cursor for the old state
* @new_colorop_state: &struct drm_colorop_state iteration cursor for the new state
* @__i: int iteration cursor, for macro-internal use
*
* This iterates over all colorops in an atomic update, tracking both old and
* new state. This is useful in places where the state delta needs to be
* considered, for example in atomic check functions.
*/
#define for_each_oldnew_colorop_in_state(__state, colorop, old_colorop_state, \
new_colorop_state, __i) \
for ((__i) = 0; \
(__i) < (__state)->dev->mode_config.num_colorop; \
(__i)++) \
for_each_if ((__state)->colorops[__i].ptr && \
((colorop) = (__state)->colorops[__i].ptr, \
(void)(colorop) /* Only to avoid unused-but-set-variable warning */, \
(old_colorop_state) = (__state)->colorops[__i].old_state,\
(new_colorop_state) = (__state)->colorops[__i].new_state, 1))
/**
* for_each_oldnew_plane_in_state - iterate over all planes in an atomic update
* @__state: &struct drm_atomic_state pointer

View File

@ -37,6 +37,7 @@ struct drm_crtc;
struct drm_connector_state;
struct dma_fence;
struct drm_framebuffer;
struct drm_colorop;
int __must_check
drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,

169
include/drm/drm_colorop.h Normal file
View File

@ -0,0 +1,169 @@
/* 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>
/**
* struct drm_colorop_state - mutable colorop state
*/
struct drm_colorop_state {
/** @colorop: backpointer to the colorop */
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.
*/
/** @state: backpointer to global drm_atomic_state */
struct drm_atomic_state *state;
};
/**
* struct drm_colorop - DRM color operation control structure
*
* A colorop represents one color operation. They can be chained via
* the 'next' pointer to build a color pipeline.
*
* Since colorops cannot stand-alone and are used to describe colorop
* operations on a plane they don't have their own locking mechanism but
* are locked and programmed along with their associated &drm_plane.
*
*/
struct drm_colorop {
/** @dev: parent DRM device */
struct drm_device *dev;
/**
* @head:
*
* List of all colorops on @dev, linked from &drm_mode_config.colorop_list.
* Invariant over the lifetime of @dev and therefore does not need
* locking.
*/
struct list_head head;
/**
* @index: Position inside the mode_config.list, can be used as an array
* index. It is invariant over the lifetime of the colorop.
*/
unsigned int index;
/** @base: base mode object */
struct drm_mode_object base;
/**
* @plane:
*
* The plane on which the colorop sits. A drm_colorop is always unique
* to a plane.
*/
struct drm_plane *plane;
/**
* @state:
*
* Current atomic state for this colorop.
*
* This is protected by @mutex. Note that nonblocking atomic commits
* access the current colorop state without taking locks.
*/
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.
*/
/** @properties: property tracking for this colorop */
struct drm_object_properties properties;
};
#define obj_to_colorop(x) container_of(x, struct drm_colorop, base)
/**
* drm_colorop_find - look up a Colorop object from its ID
* @dev: DRM device
* @file_priv: drm file to check for lease against.
* @id: &drm_mode_object ID
*
* This can be used to look up a Colorop from its userspace ID. Only used by
* drivers for legacy IOCTLs and interface, nowadays extensions to the KMS
* userspace interface should be done using &drm_property.
*/
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;
}
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);
/**
* drm_colorop_reset - reset colorop atomic state
* @colorop: drm colorop
*
* Resets the atomic state for @colorop by freeing the state pointer (which might
* be NULL, e.g. at driver load time) and allocating a new empty state object.
*/
void drm_colorop_reset(struct drm_colorop *colorop);
/**
* drm_colorop_index - find the index of a registered colorop
* @colorop: colorop to find index for
*
* Given a registered colorop, return the index of that colorop within a DRM
* device's list of colorops.
*/
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)
#endif /* __DRM_COLOROP_H__ */

View File

@ -500,6 +500,24 @@ struct drm_mode_config {
*/
struct raw_spinlock panic_lock;
/**
* @num_colorop:
*
* Number of colorop objects on this device.
* This is invariant over the lifetime of a device and hence doesn't
* need any locks.
*/
int num_colorop;
/**
* @colorop_list:
*
* List of colorop objects linked with &drm_colorop.head. This is
* invariant over the lifetime of a device and hence doesn't need any
* locks.
*/
struct list_head colorop_list;
/**
* @num_crtc:
*

View File

@ -243,6 +243,14 @@ struct drm_plane_state {
*/
enum drm_scaling_filter scaling_filter;
/**
* @color_pipeline:
*
* The first colorop of the active color pipeline, or NULL, if no
* color pipeline is active.
*/
struct drm_colorop *color_pipeline;
/**
* @commit: Tracks the pending commit to prevent use-after-free conditions,
* and for async plane updates.

View File

@ -629,6 +629,7 @@ struct drm_mode_connector_set_property {
#define DRM_MODE_OBJECT_FB 0xfbfbfbfb
#define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
#define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
#define DRM_MODE_OBJECT_COLOROP 0xfafafafa
#define DRM_MODE_OBJECT_ANY 0
struct drm_mode_obj_get_properties {