Commit df7e8b52 authored by Thomas Zimmermann's avatar Thomas Zimmermann
Browse files

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: default avatarThomas Zimmermann <tzimmermann@suse.de>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
Cc: Tvrtko Ursulin <tursulin@ursulin.net>
Cc: Karol Herbst <kherbst@redhat.com>
Cc: Lyude Paul <lyude@redhat.com>
Cc: Danilo Krummrich <dakr@redhat.com>
Reviewed-by: default avatarJonathan Cavitt <jonathan.cavitt@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20241014085740.582287-7-tzimmermann@suse.de
parent 8058944f

Documentation/gpu/drm-client.rst

+3 −0
Original line number Diff line number Diff line
@@ -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:

drivers/gpu/drm/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -41,6 +41,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 \

drivers/gpu/drm/drm_client.c

+0 −121
Original line number Diff line number Diff line
@@ -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

drivers/gpu/drm/drm_client_event.c

0 → 100644
+135 −0
Original line number Diff line number Diff line 
// 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

drivers/gpu/drm/drm_drv.c

+1 −1
Original line number Diff line number Diff line
@@ -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>