]> git.kernelconcepts.de Git - karo-tx-linux.git/commitdiff
USB: core: fix up kerneldoc comment
authorJohan Hovold <johan@kernel.org>
Fri, 24 Mar 2017 15:25:34 +0000 (16:25 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 24 Mar 2017 16:22:22 +0000 (17:22 +0100)
Make the kerneldoc comment for usb_find_common_endpoints_reverse()
self-contained by adding a full description and removing the reference
to usb_find_common_endpoints().

Reported-by: kbuild test robot <fengguang.wu@intel.com>
Signed-off-by: Johan Hovold <johan@kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/usb/core/usb.c

index 1ec9d248781eb3d90d7c148a0cada21ada2dd2e8..28b053cacc90556acf7df562fdc502c51b25a02e 100644 (file)
@@ -165,9 +165,20 @@ EXPORT_SYMBOL_GPL(usb_find_common_endpoints);
 
 /**
  * usb_find_common_endpoints_reverse() -- look up common endpoint descriptors
+ * @alt:       alternate setting to search
+ * @bulk_in:   pointer to descriptor pointer, or NULL
+ * @bulk_out:  pointer to descriptor pointer, or NULL
+ * @int_in:    pointer to descriptor pointer, or NULL
+ * @int_out:   pointer to descriptor pointer, or NULL
+ *
+ * Search the alternate setting's endpoint descriptors for the last bulk-in,
+ * bulk-out, interrupt-in and interrupt-out endpoints and return them in the
+ * provided pointers (unless they are NULL).
+ *
+ * If a requested endpoint is not found, the corresponding pointer is set to
+ * NULL.
  *
- * Same as usb_find_common_endpoints(), but the endpoint descriptors are
- * searched in reverse order (see usb_find_common_endpoints() for details).
+ * Return: Zero if all requested descriptors were found, or -ENXIO otherwise.
  */
 int usb_find_common_endpoints_reverse(struct usb_host_interface *alt,
                struct usb_endpoint_descriptor **bulk_in,