| Message ID | 20170530162554.26159-3-johan@kernel.org (mailing list archive) |
|---|---|
| State | Not Applicable, archived |
| Headers | show |
On 05/30/2017 09:25 AM, Johan Hovold wrote: > 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@kernel.org> > --- > 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. I would use the same blurb used throughout drivers/of/* for consistency. * Returns a node pointer with refcount incremented, use * of_node_put() on it when done. */ Just my 2-cents -Tyrel > */ > struct device_node *usb_of_get_child_node(struct device_node *parent, >
On Tue, May 30, 2017 at 03:40:03PM -0700, Tyrel Datwyler wrote: > On 05/30/2017 09:25 AM, Johan Hovold wrote: > > 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@kernel.org> > > --- > > 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. > > I would use the same blurb used throughout drivers/of/* for consistency. > > * Returns a node pointer with refcount incremented, use > * of_node_put() on it when done. > */ > > Just my 2-cents I updated the comment to use a version of this also found in drivers/of: * Return: A pointer to the node with incremented refcount if found, or * %NULL otherwise. which is on kernel-doc format. I don't think we need to explicitly mention which function to manipulate the refcount with in every header. Thanks, Johan
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,
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@kernel.org> --- drivers/usb/core/of.c | 3 +++ 1 file changed, 3 insertions(+)