Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Johan Hovold and committed by
Greg Kroah-Hartman
2e58cafa 5370860a

+13 -2
+13 -2
drivers/usb/core/usb.c
··· 165 165 166 166 /** 167 167 * usb_find_common_endpoints_reverse() -- look up common endpoint descriptors 168 + * @alt: alternate setting to search 169 + * @bulk_in: pointer to descriptor pointer, or NULL 170 + * @bulk_out: pointer to descriptor pointer, or NULL 171 + * @int_in: pointer to descriptor pointer, or NULL 172 + * @int_out: pointer to descriptor pointer, or NULL 168 173 * 169 - * Same as usb_find_common_endpoints(), but the endpoint descriptors are 170 - * searched in reverse order (see usb_find_common_endpoints() for details). 174 + * Search the alternate setting's endpoint descriptors for the last bulk-in, 175 + * bulk-out, interrupt-in and interrupt-out endpoints and return them in the 176 + * provided pointers (unless they are NULL). 177 + * 178 + * If a requested endpoint is not found, the corresponding pointer is set to 179 + * NULL. 180 + * 181 + * Return: Zero if all requested descriptors were found, or -ENXIO otherwise. 171 182 */ 172 183 int usb_find_common_endpoints_reverse(struct usb_host_interface *alt, 173 184 struct usb_endpoint_descriptor **bulk_in,