From: Johan Hovold <johan@kernel.org>
To: Srinivas Kandagatla <srini@kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
linux-sound@vger.kernel.org, linux-kernel@vger.kernel.org,
Johan Hovold <johan@kernel.org>
Subject: [PATCH 5/6] slimbus: core: fix of_slim_get_device() kernel doc
Date: Wed, 26 Nov 2025 15:53:28 +0100 [thread overview]
Message-ID: <20251126145329.5022-6-johan@kernel.org> (raw)
In-Reply-To: <20251126145329.5022-1-johan@kernel.org>
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: e0772de8a48b ("slimbus: core: add of_slim_device_get() helper")
Signed-off-by: Johan Hovold <johan@kernel.org>
---
drivers/slimbus/core.c | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/drivers/slimbus/core.c b/drivers/slimbus/core.c
index 9402950e7ebd..a2c243e3ad52 100644
--- a/drivers/slimbus/core.c
+++ b/drivers/slimbus/core.c
@@ -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)
--
2.51.2
next prev parent reply other threads:[~2025-11-26 14:54 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-26 14:53 [PATCH 0/6] slimbus: core: fix device, OF node and rpm leaks Johan Hovold
2025-11-26 14:53 ` [PATCH 1/6] slimbus: core: fix OF node leak on registration failure Johan Hovold
2025-11-26 14:53 ` [PATCH 2/6] slimbus: core: fix runtime PM imbalance on report present Johan Hovold
2025-11-26 14:53 ` [PATCH 3/6] slimbus: core: fix device reference leak " Johan Hovold
2025-11-26 14:53 ` [PATCH 4/6] slimbus: core: amend slim_get_device() kernel doc Johan Hovold
2025-11-26 14:53 ` Johan Hovold [this message]
2025-11-26 14:53 ` [PATCH 6/6] slimbus: core: clean up of_slim_get_device() Johan Hovold
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251126145329.5022-6-johan@kernel.org \
--to=johan@kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-sound@vger.kernel.org \
--cc=srini@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.