-----Original Message-----
From: Intel-xe <intel-xe-bounces@xxxxxxxxxxxxxxxxxxxxx> On Behalf Of Thomas Zimmermann
Sent: Tuesday, October 8, 2024 4:59 AM
To: simona@xxxxxxxx; airlied@xxxxxxxxx; javierm@xxxxxxxxxx; jfalempe@xxxxxxxxxx
Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx; amd-gfx@xxxxxxxxxxxxxxxxxxxxx; intel-gfx@xxxxxxxxxxxxxxxxxxxxx; intel-xe@xxxxxxxxxxxxxxxxxxxxx; Thomas Zimmermann <tzimmermann@xxxxxxx>; Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx>; Vivi, Rodrigo <rodrigo.vivi@xxxxxxxxx>; Joonas Lahtinen <joonas.lahtinen@xxxxxxxxxxxxxxx>; Tvrtko Ursulin <tursulin@xxxxxxxxxxx>; Karol Herbst <kherbst@xxxxxxxxxx>; Lyude Paul <lyude@xxxxxxxxxx>; Danilo Krummrich <dakr@xxxxxxxxxx>
Subject: [PATCH v3 06/12] drm/client: Move client event handlers to drm_client_event.c
>
> A number of DRM-client functions serve as entry points from device
> operations to client code. Moving them info a separate file will later
> allow for a more fine-grained kernel configuration. For most of the
> users it is sufficient to include <drm/drm_client_event.h> instead of
> the full driver-side interface in <drm/drm_client.h>
>
> v2:
> - rename new files to drm_client_event.{c,h}
>
> Signed-off-by: Thomas Zimmermann <tzimmermann@xxxxxxx>
> Cc: Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx>
> Cc: Rodrigo Vivi <rodrigo.vivi@xxxxxxxxx>
> Cc: Joonas Lahtinen <joonas.lahtinen@xxxxxxxxxxxxxxx>
> Cc: Tvrtko Ursulin <tursulin@xxxxxxxxxxx>
> Cc: Karol Herbst <kherbst@xxxxxxxxxx>
> Cc: Lyude Paul <lyude@xxxxxxxxxx>
> Cc: Danilo Krummrich <dakr@xxxxxxxxxx>
LGTM.
Reviewed-by: Jonathan Cavitt <jonathan.cavitt@xxxxxxxxx>
-Jonathan Cavitt
> ---
> Documentation/gpu/drm-client.rst | 3 +
> drivers/gpu/drm/Makefile | 1 +
> drivers/gpu/drm/drm_client.c | 121 ----------------
> drivers/gpu/drm/drm_client_event.c | 135 ++++++++++++++++++
> drivers/gpu/drm/drm_drv.c | 2 +-
> drivers/gpu/drm/drm_file.c | 2 +-
> drivers/gpu/drm/drm_probe_helper.c | 2 +-
> .../drm/i915/display/intel_display_driver.c | 2 +-
> drivers/gpu/drm/nouveau/nouveau_vga.c | 2 +-
> include/drm/drm_client.h | 4 -
> include/drm/drm_client_event.h | 12 ++
> 11 files changed, 156 insertions(+), 130 deletions(-)
> create mode 100644 drivers/gpu/drm/drm_client_event.c
> create mode 100644 include/drm/drm_client_event.h
>
> diff --git a/Documentation/gpu/drm-client.rst b/Documentation/gpu/drm-client.rst
> index 58b5a1d1219d..cbcfe30de777 100644
> --- a/Documentation/gpu/drm-client.rst
> +++ b/Documentation/gpu/drm-client.rst
> @@ -13,3 +13,6 @@ Kernel clients
>
> .. kernel-doc:: drivers/gpu/drm/drm_client_modeset.c
> :export:
> +
> +.. kernel-doc:: drivers/gpu/drm/drm_client_event.c
> + :export:
> diff --git a/drivers/gpu/drm/Makefile b/drivers/gpu/drm/Makefile
> index 3894f43f6d47..6b7d168ca790 100644
> --- a/drivers/gpu/drm/Makefile
> +++ b/drivers/gpu/drm/Makefile
> @@ -42,6 +42,7 @@ drm-y := \
> drm_bridge.o \
> drm_cache.o \
> drm_client.o \
> + drm_client_event.o \
> drm_client_modeset.o \
> drm_color_mgmt.o \
> drm_connector.o \
> diff --git a/drivers/gpu/drm/drm_client.c b/drivers/gpu/drm/drm_client.c
> index bfedcbf516db..549b28a5918c 100644
> --- a/drivers/gpu/drm/drm_client.c
> +++ b/drivers/gpu/drm/drm_client.c
> @@ -10,7 +10,6 @@
> #include <linux/slab.h>
>
> #include <drm/drm_client.h>
> -#include <drm/drm_debugfs.h>
> #include <drm/drm_device.h>
> #include <drm/drm_drv.h>
> #include <drm/drm_file.h>
> @@ -172,99 +171,6 @@ void drm_client_release(struct drm_client_dev *client)
> }
> EXPORT_SYMBOL(drm_client_release);
>
> -/**
> - * drm_client_dev_unregister - Unregister clients
> - * @dev: DRM device
> - *
> - * This function releases all clients by calling each client's
> - * &drm_client_funcs.unregister callback. The callback function
> - * is responsibe for releaseing all resources including the client
> - * itself.
> - *
> - * The helper drm_dev_unregister() calls this function. Drivers
> - * that use it don't need to call this function themselves.
> - */
> -void drm_client_dev_unregister(struct drm_device *dev)
> -{
> - struct drm_client_dev *client, *tmp;
> -
> - if (!drm_core_check_feature(dev, DRIVER_MODESET))
> - return;
> -
> - mutex_lock(&dev->clientlist_mutex);
> - list_for_each_entry_safe(client, tmp, &dev->clientlist, list) {
> - list_del(&client->list);
> - if (client->funcs && client->funcs->unregister) {
> - client->funcs->unregister(client);
> - } else {
> - drm_client_release(client);
> - kfree(client);
> - }
> - }
> - mutex_unlock(&dev->clientlist_mutex);
> -}
> -EXPORT_SYMBOL(drm_client_dev_unregister);
> -
> -/**
> - * drm_client_dev_hotplug - Send hotplug event to clients
> - * @dev: DRM device
> - *
> - * This function calls the &drm_client_funcs.hotplug callback on the attached clients.
> - *
> - * drm_kms_helper_hotplug_event() calls this function, so drivers that use it
> - * don't need to call this function themselves.
> - */
> -void drm_client_dev_hotplug(struct drm_device *dev)
> -{
> - struct drm_client_dev *client;
> - int ret;
> -
> - if (!drm_core_check_feature(dev, DRIVER_MODESET))
> - return;
> -
> - if (!dev->mode_config.num_connector) {
> - drm_dbg_kms(dev, "No connectors found, will not send hotplug events!\n");
> - return;
> - }
> -
> - mutex_lock(&dev->clientlist_mutex);
> - list_for_each_entry(client, &dev->clientlist, list) {
> - if (!client->funcs || !client->funcs->hotplug)
> - continue;
> -
> - if (client->hotplug_failed)
> - continue;
> -
> - ret = client->funcs->hotplug(client);
> - drm_dbg_kms(dev, "%s: ret=%d\n", client->name, ret);
> - if (ret)
> - client->hotplug_failed = true;
> - }
> - mutex_unlock(&dev->clientlist_mutex);
> -}
> -EXPORT_SYMBOL(drm_client_dev_hotplug);
> -
> -void drm_client_dev_restore(struct drm_device *dev)
> -{
> - struct drm_client_dev *client;
> - int ret;
> -
> - if (!drm_core_check_feature(dev, DRIVER_MODESET))
> - return;
> -
> - mutex_lock(&dev->clientlist_mutex);
> - list_for_each_entry(client, &dev->clientlist, list) {
> - if (!client->funcs || !client->funcs->restore)
> - continue;
> -
> - ret = client->funcs->restore(client);
> - drm_dbg_kms(dev, "%s: ret=%d\n", client->name, ret);
> - if (!ret) /* The first one to return zero gets the privilege to restore */
> - break;
> - }
> - mutex_unlock(&dev->clientlist_mutex);
> -}
> -
> static void drm_client_buffer_delete(struct drm_client_buffer *buffer)
> {
> if (buffer->gem) {
> @@ -584,30 +490,3 @@ int drm_client_framebuffer_flush(struct drm_client_buffer *buffer, struct drm_re
> 0, 0, NULL, 0);
> }
> EXPORT_SYMBOL(drm_client_framebuffer_flush);
> -
> -#ifdef CONFIG_DEBUG_FS
> -static int drm_client_debugfs_internal_clients(struct seq_file *m, void *data)
> -{
> - struct drm_debugfs_entry *entry = m->private;
> - struct drm_device *dev = entry->dev;
> - struct drm_printer p = drm_seq_file_printer(m);
> - struct drm_client_dev *client;
> -
> - mutex_lock(&dev->clientlist_mutex);
> - list_for_each_entry(client, &dev->clientlist, list)
> - drm_printf(&p, "%s\n", client->name);
> - mutex_unlock(&dev->clientlist_mutex);
> -
> - return 0;
> -}
> -
> -static const struct drm_debugfs_info drm_client_debugfs_list[] = {
> - { "internal_clients", drm_client_debugfs_internal_clients, 0 },
> -};
> -
> -void drm_client_debugfs_init(struct drm_device *dev)
> -{
> - drm_debugfs_add_files(dev, drm_client_debugfs_list,
> - ARRAY_SIZE(drm_client_debugfs_list));
> -}
> -#endif
> diff --git a/drivers/gpu/drm/drm_client_event.c b/drivers/gpu/drm/drm_client_event.c
> new file mode 100644
> index 000000000000..d13d44320c5c
> --- /dev/null
> +++ b/drivers/gpu/drm/drm_client_event.c
> @@ -0,0 +1,135 @@
> +// SPDX-License-Identifier: GPL-2.0 or MIT
> +/*
> + * Copyright 2018 Noralf Trønnes
> + */
> +
> +#include <linux/list.h>
> +#include <linux/mutex.h>
> +#include <linux/seq_file.h>
> +
> +#include <drm/drm_client.h>
> +#include <drm/drm_client_event.h>
> +#include <drm/drm_debugfs.h>
> +#include <drm/drm_device.h>
> +#include <drm/drm_drv.h>
> +#include <drm/drm_print.h>
> +
> +/**
> + * drm_client_dev_unregister - Unregister clients
> + * @dev: DRM device
> + *
> + * This function releases all clients by calling each client's
> + * &drm_client_funcs.unregister callback. The callback function
> + * is responsibe for releaseing all resources including the client
> + * itself.
> + *
> + * The helper drm_dev_unregister() calls this function. Drivers
> + * that use it don't need to call this function themselves.
> + */
> +void drm_client_dev_unregister(struct drm_device *dev)
> +{
> + struct drm_client_dev *client, *tmp;
> +
> + if (!drm_core_check_feature(dev, DRIVER_MODESET))
> + return;
> +
> + mutex_lock(&dev->clientlist_mutex);
> + list_for_each_entry_safe(client, tmp, &dev->clientlist, list) {
> + list_del(&client->list);
> + if (client->funcs && client->funcs->unregister) {
> + client->funcs->unregister(client);
> + } else {
> + drm_client_release(client);
> + kfree(client);
> + }
> + }
> + mutex_unlock(&dev->clientlist_mutex);
> +}
> +EXPORT_SYMBOL(drm_client_dev_unregister);
> +
> +/**
> + * drm_client_dev_hotplug - Send hotplug event to clients
> + * @dev: DRM device
> + *
> + * This function calls the &drm_client_funcs.hotplug callback on the attached clients.
> + *
> + * drm_kms_helper_hotplug_event() calls this function, so drivers that use it
> + * don't need to call this function themselves.
> + */
> +void drm_client_dev_hotplug(struct drm_device *dev)
> +{
> + struct drm_client_dev *client;
> + int ret;
> +
> + if (!drm_core_check_feature(dev, DRIVER_MODESET))
> + return;
> +
> + if (!dev->mode_config.num_connector) {
> + drm_dbg_kms(dev, "No connectors found, will not send hotplug events!\n");
> + return;
> + }
> +
> + mutex_lock(&dev->clientlist_mutex);
> + list_for_each_entry(client, &dev->clientlist, list) {
> + if (!client->funcs || !client->funcs->hotplug)
> + continue;
> +
> + if (client->hotplug_failed)
> + continue;
> +
> + ret = client->funcs->hotplug(client);
> + drm_dbg_kms(dev, "%s: ret=%d\n", client->name, ret);
> + if (ret)
> + client->hotplug_failed = true;
> + }
> + mutex_unlock(&dev->clientlist_mutex);
> +}
> +EXPORT_SYMBOL(drm_client_dev_hotplug);
> +
> +void drm_client_dev_restore(struct drm_device *dev)
> +{
> + struct drm_client_dev *client;
> + int ret;
> +
> + if (!drm_core_check_feature(dev, DRIVER_MODESET))
> + return;
> +
> + mutex_lock(&dev->clientlist_mutex);
> + list_for_each_entry(client, &dev->clientlist, list) {
> + if (!client->funcs || !client->funcs->restore)
> + continue;
> +
> + ret = client->funcs->restore(client);
> + drm_dbg_kms(dev, "%s: ret=%d\n", client->name, ret);
> + if (!ret) /* The first one to return zero gets the privilege to restore */
> + break;
> + }
> + mutex_unlock(&dev->clientlist_mutex);
> +}
> +
> +#ifdef CONFIG_DEBUG_FS
> +static int drm_client_debugfs_internal_clients(struct seq_file *m, void *data)
> +{
> + struct drm_debugfs_entry *entry = m->private;
> + struct drm_device *dev = entry->dev;
> + struct drm_printer p = drm_seq_file_printer(m);
> + struct drm_client_dev *client;
> +
> + mutex_lock(&dev->clientlist_mutex);
> + list_for_each_entry(client, &dev->clientlist, list)
> + drm_printf(&p, "%s\n", client->name);
> + mutex_unlock(&dev->clientlist_mutex);
> +
> + return 0;
> +}
> +
> +static const struct drm_debugfs_info drm_client_debugfs_list[] = {
> + { "internal_clients", drm_client_debugfs_internal_clients, 0 },
> +};
> +
> +void drm_client_debugfs_init(struct drm_device *dev)
> +{
> + drm_debugfs_add_files(dev, drm_client_debugfs_list,
> + ARRAY_SIZE(drm_client_debugfs_list));
> +}
> +#endif
> diff --git a/drivers/gpu/drm/drm_drv.c b/drivers/gpu/drm/drm_drv.c
> index ac30b0ec9d93..c2c172eb25df 100644
> --- a/drivers/gpu/drm/drm_drv.c
> +++ b/drivers/gpu/drm/drm_drv.c
> @@ -38,7 +38,7 @@
>
> #include <drm/drm_accel.h>
> #include <drm/drm_cache.h>
> -#include <drm/drm_client.h>
> +#include <drm/drm_client_event.h>
> #include <drm/drm_color_mgmt.h>
> #include <drm/drm_drv.h>
> #include <drm/drm_file.h>
> diff --git a/drivers/gpu/drm/drm_file.c b/drivers/gpu/drm/drm_file.c
> index ad1dc638c83b..7415abb7faca 100644
> --- a/drivers/gpu/drm/drm_file.c
> +++ b/drivers/gpu/drm/drm_file.c
> @@ -40,7 +40,7 @@
> #include <linux/slab.h>
> #include <linux/vga_switcheroo.h>
>
> -#include <drm/drm_client.h>
> +#include <drm/drm_client_event.h>
> #include <drm/drm_drv.h>
> #include <drm/drm_file.h>
> #include <drm/drm_gem.h>
> diff --git a/drivers/gpu/drm/drm_probe_helper.c b/drivers/gpu/drm/drm_probe_helper.c
> index 92f21764246f..96b266b37ba4 100644
> --- a/drivers/gpu/drm/drm_probe_helper.c
> +++ b/drivers/gpu/drm/drm_probe_helper.c
> @@ -33,7 +33,7 @@
> #include <linux/moduleparam.h>
>
> #include <drm/drm_bridge.h>
> -#include <drm/drm_client.h>
> +#include <drm/drm_client_event.h>
> #include <drm/drm_crtc.h>
> #include <drm/drm_edid.h>
> #include <drm/drm_fourcc.h>
> diff --git a/drivers/gpu/drm/i915/display/intel_display_driver.c b/drivers/gpu/drm/i915/display/intel_display_driver.c
> index c106fb2dd20b..673f9b965494 100644
> --- a/drivers/gpu/drm/i915/display/intel_display_driver.c
> +++ b/drivers/gpu/drm/i915/display/intel_display_driver.c
> @@ -11,7 +11,7 @@
> #include <acpi/video.h>
> #include <drm/display/drm_dp_mst_helper.h>
> #include <drm/drm_atomic_helper.h>
> -#include <drm/drm_client.h>
> +#include <drm/drm_client_event.h>
> #include <drm/drm_mode_config.h>
> #include <drm/drm_privacy_screen_consumer.h>
> #include <drm/drm_probe_helper.h>
> diff --git a/drivers/gpu/drm/nouveau/nouveau_vga.c b/drivers/gpu/drm/nouveau/nouveau_vga.c
> index ab4e11dc0b8a..a6c375a24154 100644
> --- a/drivers/gpu/drm/nouveau/nouveau_vga.c
> +++ b/drivers/gpu/drm/nouveau/nouveau_vga.c
> @@ -2,7 +2,7 @@
> #include <linux/vgaarb.h>
> #include <linux/vga_switcheroo.h>
>
> -#include <drm/drm_fb_helper.h>
> +#include <drm/drm_client_event.h>
>
> #include "nouveau_drv.h"
> #include "nouveau_acpi.h"
> diff --git a/include/drm/drm_client.h b/include/drm/drm_client.h
> index bc0e66f9c425..dfd5afcc9463 100644
> --- a/include/drm/drm_client.h
> +++ b/include/drm/drm_client.h
> @@ -121,10 +121,6 @@ int drm_client_init(struct drm_device *dev, struct drm_client_dev *client,
> void drm_client_release(struct drm_client_dev *client);
> void drm_client_register(struct drm_client_dev *client);
>
> -void drm_client_dev_unregister(struct drm_device *dev);
> -void drm_client_dev_hotplug(struct drm_device *dev);
> -void drm_client_dev_restore(struct drm_device *dev);
> -
> /**
> * struct drm_client_buffer - DRM client buffer
> */
> diff --git a/include/drm/drm_client_event.h b/include/drm/drm_client_event.h
> new file mode 100644
> index 000000000000..2c8915241120
> --- /dev/null
> +++ b/include/drm/drm_client_event.h
> @@ -0,0 +1,12 @@
> +/* SPDX-License-Identifier: GPL-2.0 or MIT */
> +
> +#ifndef _DRM_CLIENT_EVENT_H_
> +#define _DRM_CLIENT_EVENT_H_
> +
> +struct drm_device;
> +
> +void drm_client_dev_unregister(struct drm_device *dev);
> +void drm_client_dev_hotplug(struct drm_device *dev);
> +void drm_client_dev_restore(struct drm_device *dev);
> +
> +#endif
> --
> 2.46.0
>
>
