Commit 90315cd2 authored by Luca Ceresoli's avatar Luca Ceresoli
Browse files

drm/bridge: adapt drm_bridge_add/remove() docs, mention the lingering list 



The role of drm_bridge_add/remove() is more complex now after having added
the lingering list. Update the kdoc accordingly.

Also stop mentioning the global list(s) in the first line of the docs: the
most important thing to mention here is that bridges are registered and
deregistered, lists are just the type of container used to implement such
(de)registration.

Reviewed-by: default avatarMaxime Ripard <mripard@kernel.org>
Link: https://lore.kernel.org/r/20250915-drm-bridge-debugfs-removed-v9-3-6e5c0aff5de9@bootlin.com


Signed-off-by: default avatarLuca Ceresoli <luca.ceresoli@bootlin.com>
parent 27312a8f

drivers/gpu/drm/drm_bridge.c

+10 −2
Original line number Diff line number Diff line
@@ -294,10 +294,13 @@ void *__devm_drm_bridge_alloc(struct device *dev, size_t size, size_t offset, 
EXPORT_SYMBOL(__devm_drm_bridge_alloc);



/**

 * drm_bridge_add - add the given bridge to the global bridge list

 * drm_bridge_add - register a bridge

 *

 * @bridge: bridge control structure

 *

 * Add the given bridge to the global list of bridges, where they can be

 * found by users via of_drm_find_bridge().

 *

 * The bridge to be added must have been allocated by

 * devm_drm_bridge_alloc().

 */
@@ -352,9 +355,14 @@ int devm_drm_bridge_add(struct device *dev, struct drm_bridge *bridge) 
EXPORT_SYMBOL(devm_drm_bridge_add);



/**

 * drm_bridge_remove - remove the given bridge from the global bridge list

 * drm_bridge_remove - unregister a bridge

 *

 * @bridge: bridge control structure

 *

 * Remove the given bridge from the global list of registered bridges, so

 * it won't be found by users via of_drm_find_bridge(), and add it to the

 * lingering bridge list, to keep track of it until its allocated memory is

 * eventually freed.

 */

void drm_bridge_remove(struct drm_bridge *bridge)

{