xhci: Add missing parameter description to xhci_get_endpoint_index()

Hans Zhang · gregkh · commit 85c4aa0a4564 · 2025-05-21T12:37:22.000+02:00
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. Signed-off-by: Hans Zhang <18255117159@163.com> Link: https://lore.kernel.org/r/20250506033101.206180-1-18255117159@163.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
diff --git a/drivers/usb/host/xhci.c b/drivers/usb/host/xhci.c
@@ -1457,6 +1457,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.

Original file line number	Diff line number	Diff line change
`@@ -1457,6 +1457,7 @@ static void xhci_unmap_urb_for_dma(struct usb_hcd hcd, struct urb urb)`
`1457`	`1457`	`* xhci_get_endpoint_index - Used for passing endpoint bitmasks between the core and`
`1458`	`1458`	`* HCDs. Find the index for an endpoint given its descriptor. Use the return`
`1459`	`1459`	`* value to right shift 1 for the bitmask.`
	`1460`	`+ * @desc: USB endpoint descriptor to determine index for`
`1460`	`1461`	`*`
`1461`	`1462`	`* Index = (epnum * 2) + direction - 1,`
`1462`	`1463`	`* where direction = 0 for OUT, 1 for IN.`