[PATCH 2/7] USB: of: document reference taken by child-lookup helper

From: Johan Hovold
Date: Tue May 30 2017 - 12:30:59 EST


Document that the child-node lookup helper takes a reference to the
device-tree node which needs to be dropped after use.

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

diff --git a/drivers/usb/core/of.c b/drivers/usb/core/of.c
index d563cbcf76cf..17a4af02cf5b 100644
--- a/drivers/usb/core/of.c
+++ b/drivers/usb/core/of.c
@@ -28,6 +28,9 @@
*
* Find the node from device tree according to its port number.
*
+ * Takes a reference to the returned device-tree node, which needs to be
+ * dropped after use.
+ *
* Return: On success, a pointer to the device node, %NULL on failure.
*/
struct device_node *usb_of_get_child_node(struct device_node *parent,
--
2.13.0