浏览代码

USB: core: fix up kerneldoc comment

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>
Johan Hovold 8 年之前
父节点
当前提交
2e58cafa0b
共有 1 个文件被更改,包括 13 次插入2 次删除
  1. 13 2
      drivers/usb/core/usb.c

+ 13 - 2
drivers/usb/core/usb.c

@@ -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,