[PATCH] usb: dwc3: core: Fix incorrect kernel-doc comment for dwc3_alloc_event_buffers

[PATCH] usb: dwc3: core: Fix incorrect kernel-doc comment for dwc3_alloc_event_buffers

[Shuping Bu]

The kernel-doc comment for dwc3_alloc_event_buffers states that the
function "Allocates @num event buffers", but the function does not have
a @num parameter and only allocates a single event buffer.

Remove the misleading "@num" reference from the brief description to
accurately reflect the function's behavior.

Signed-off-by: Shuping Bu <bushuping007@163.com>
---
 drivers/usb/dwc3/core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/usb/dwc3/core.c b/drivers/usb/dwc3/core.c
index 65213896de99..a2587f9f0bb8 100644
--- a/drivers/usb/dwc3/core.c
+++ b/drivers/usb/dwc3/core.c
@@ -525,7 +525,7 @@ static void dwc3_free_event_buffers(struct dwc3 *dwc)
 }
 
 /**
- * dwc3_alloc_event_buffers - Allocates @num event buffers of size @length
+ * dwc3_alloc_event_buffers - Allocate one event buffer of size @length
  * @dwc: pointer to our controller context structure
  * @length: size of event buffer
  *
-- 
2.25.1

Re: [PATCH] usb: dwc3: core: Fix incorrect kernel-doc comment for dwc3_alloc_event_buffers

[Thinh Nguyen]

On Wed, May 20, 2026, Shuping Bu wrote:
> The kernel-doc comment for dwc3_alloc_event_buffers states that the
> function "Allocates @num event buffers", but the function does not have
> a @num parameter and only allocates a single event buffer.
> 
> Remove the misleading "@num" reference from the brief description to
> accurately reflect the function's behavior.
> 
> Signed-off-by: Shuping Bu <bushuping007@163.com>
> ---
>  drivers/usb/dwc3/core.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/usb/dwc3/core.c b/drivers/usb/dwc3/core.c
> index 65213896de99..a2587f9f0bb8 100644
> --- a/drivers/usb/dwc3/core.c
> +++ b/drivers/usb/dwc3/core.c
> @@ -525,7 +525,7 @@ static void dwc3_free_event_buffers(struct dwc3 *dwc)
>  }
>  
>  /**
> - * dwc3_alloc_event_buffers - Allocates @num event buffers of size @length
> + * dwc3_alloc_event_buffers - Allocate one event buffer of size @length
>   * @dwc: pointer to our controller context structure
>   * @length: size of event buffer
>   *
> -- 
> 2.25.1
> 

Please also include the Fixes tag. It can probably go back as far as
here:

Fixes: 9f622b2a407d ("usb: dwc3: calculate number of event buffers dynamically")

This patch doesn't need to go to stable. After adding the tag above and
resubmit, you can include my Acked-by tag:

Acked-by: Thinh Nguyen <Thinh.Nguyen@synopsys.com>

Thanks,
Thinh