diff mbox series

[v2] xhci: Add missing parameter description to xhci_get_endpoint_index()

Message ID 20250506033101.206180-1-18255117159@163.com
State New
Headers show
Series [v2] xhci: Add missing parameter description to xhci_get_endpoint_index() | expand

Commit Message

Hans Zhang May 6, 2025, 3:31 a.m. UTC
Fix kernel-doc warning by documenting the @desc parameter:

drivers/usb/host/xhci.c:1369: warning: Function parameter or struct member 'desc' not described in 'xhci_get_endpoint_index'

Add detailed description of the @desc parameter and clarify the indexing
logic for control endpoints vs other types. This brings the documentation
in line with kernel-doc requirements while maintaining technical accuracy.

Fixes: d0e96f5a71a0 ("USB: xhci: Control transfer support.")
Signed-off-by: Hans Zhang <18255117159@163.com>
---
Changes for v2:
- Add Fixes.
---
 drivers/usb/host/xhci.c | 1 +
 1 file changed, 1 insertion(+)


base-commit: ca91b9500108d4cf083a635c2e11c884d5dd20ea
diff mbox series

Patch

diff --git a/drivers/usb/host/xhci.c b/drivers/usb/host/xhci.c
index 90eb491267b5..dbe6f41202ca 100644
--- a/drivers/usb/host/xhci.c
+++ b/drivers/usb/host/xhci.c
@@ -1359,6 +1359,7 @@  static void xhci_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
  * xhci_get_endpoint_index - Used for passing endpoint bitmasks between the core and
  * HCDs.  Find the index for an endpoint given its descriptor.  Use the return
  * value to right shift 1 for the bitmask.
+ * @desc: USB endpoint descriptor to determine index for
  *
  * Index  = (epnum * 2) + direction - 1,
  * where direction = 0 for OUT, 1 for IN.