[PATCH 4/5] spmi: document spmi_device_from_of() refcounting

From: Johan Hovold
Date: Tue Oct 03 2023 - 11:29:51 EST


Add a comment documenting that the spmi_device_from_of() takes a
reference to the embedded struct device that needs to be dropped after
use.

Signed-off-by: Johan Hovold <johan+linaro@xxxxxxxxxx>
---
drivers/spmi/spmi.c | 3 +++
1 file changed, 3 insertions(+)

diff --git a/drivers/spmi/spmi.c b/drivers/spmi/spmi.c
index 7313d4c18a04..ca2fd4d72fa6 100644
--- a/drivers/spmi/spmi.c
+++ b/drivers/spmi/spmi.c
@@ -392,6 +392,9 @@ static struct bus_type spmi_bus_type = {
*
* @np: device node
*
+ * Takes a reference to the embedded struct device which needs to be dropped
+ * after use.
+ *
* Returns the struct spmi_device associated with a device node or NULL.
*/
struct spmi_device *spmi_device_from_of(struct device_node *np)
--
2.41.0