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

usb: host: ehci-xilinx: adding description for return value

This patch resolves kernel-doc warnings to add return value description
in function comments.

Addressed warnings:

drivers/usb/host/ehci-xilinx-of.c:37: warning: No description found for return value of 'ehci_xilinx_port_handed_over'
drivers/usb/host/ehci-xilinx-of.c:117: warning: No description found for return value of 'ehci_hcd_xilinx_of_probe'
drivers/usb/host/ehci-xilinx-of.c:201: warning: No description found for return value of 'ehci_hcd_xilinx_of_remove'

Signed-off-by: Piyush Mehta <piyush.mehta@xilinx.com>
Link: https://lore.kernel.org/r/20220509170252.28271-1-piyush.mehta@xilinx.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Piyush Mehta and committed by
Greg Kroah-Hartman
72e28b70 b4b44897

+6
+6
drivers/usb/host/ehci-xilinx-of.c
··· 32 32 * There are cases when the host controller fails to enable the port due to, 33 33 * for example, insufficient power that can be supplied to the device from 34 34 * the USB bus. In those cases, the messages printed here are not helpful. 35 + * 36 + * Return: Always return 0 35 37 */ 36 38 static int ehci_xilinx_port_handed_over(struct usb_hcd *hcd, int portnum) 37 39 { ··· 112 110 * host controller. Because the Xilinx USB host controller can be configured 113 111 * as HS only or HS/FS only, it checks the configuration in the device tree 114 112 * entry, and sets an appropriate value for hcd->has_tt. 113 + * 114 + * Return: zero on success, negative error code otherwise 115 115 */ 116 116 static int ehci_hcd_xilinx_of_probe(struct platform_device *op) 117 117 { ··· 198 194 * 199 195 * Remove the hcd structure, and release resources that has been requested 200 196 * during probe. 197 + * 198 + * Return: Always return 0 201 199 */ 202 200 static int ehci_hcd_xilinx_of_remove(struct platform_device *op) 203 201 {