Commit 7831f710 authored by Johan Hovold's avatar Johan Hovold Committed by Greg Kroah-Hartman
Browse files

slimbus: core: fix of_slim_get_device() kernel doc 



Unlike slim_get_device() the of_slim_get_device() helper does not
allocate and register any slimbus devices in case lookup fails.

Update the of_slim_get_device() kernel doc to reflect this and add a
comment about the helper taking a reference to the returned device.

Fixes: e0772de8 ("slimbus: core: add of_slim_device_get() helper")
Signed-off-by: default avatarJohan Hovold <johan@kernel.org>
Link: https://patch.msgid.link/20251126145329.5022-6-johan@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 4c6da2fd

drivers/slimbus/core.c

+5 −3
Original line number Diff line number Diff line
@@ -408,11 +408,13 @@ static struct slim_device *of_find_slim_device(struct slim_controller *ctrl, 
/**

 * of_slim_get_device() - get handle to a device using dt node.

 *

 * @ctrl: Controller on which this device will be added/queried

 * @ctrl: Controller on which this device will be queried

 * @np: node pointer to device

 *

 * Return: pointer to a device if it has already reported. Creates a new

 * device and returns pointer to it if the device has not yet enumerated.

 * Takes a reference to the embedded struct device which needs to be dropped

 * after use.

 *

 * Return: pointer to a device if it has been registered, otherwise NULL.

 */

struct slim_device *of_slim_get_device(struct slim_controller *ctrl,

				       struct device_node *np)