spmi: document spmi_device_from_of() refcounting

jhovold · lag-linaro · commit ade7941a478e · 2023-11-01T10:02:18.000Z
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@kernel.org> Acked-by: Stephen Boyd <sboyd@kernel.org> Link: https://lore.kernel.org/r/20231003152927.15000-5-johan+linaro@kernel.org Signed-off-by: Lee Jones <lee@kernel.org>
diff --git 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)

Original file line number	Diff line number	Diff line change
`@@ -392,6 +392,9 @@ static struct bus_type spmi_bus_type = {`
`392`	`392`	`*`
`393`	`393`	`* @np: device node`
`394`	`394`	`*`
	`395`	`+ * Takes a reference to the embedded struct device which needs to be dropped`
	`396`	`+ * after use.`
	`397`	`+ *`
`395`	`398`	`* Returns the struct spmi_device associated with a device node or NULL.`
`396`	`399`	`*/`
`397`	`400`	`struct spmi_device spmi_device_from_of(struct device_node np)`