usb: dwc3: Document nostream_work member in dwc3_ep struct

[PATCH] usb: dwc3: Document nostream_work member in dwc3_ep struct

Posted by Purva Yeshi 10 months, 1 week ago

Added description for the 'nostream_work' member in struct dwc3_ep to 
resolve the kerneldoc warning when running 'make htmldocs'.

Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com>
---
 drivers/usb/dwc3/core.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index ac7c730f8..9095878d7 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -717,6 +717,7 @@ struct dwc3_event_buffer {
 /**
  * struct dwc3_ep - device side endpoint representation
  * @endpoint: usb endpoint
+ * @nostream_work: delayed work structure for handling no-stream events
  * @cancelled_list: list of cancelled requests for this endpoint
  * @pending_list: list of pending requests for this endpoint
  * @started_list: list of started requests on this endpoint
-- 
2.34.1

Re: [PATCH] usb: dwc3: Document nostream_work member in dwc3_ep struct

Posted by Thinh Nguyen 10 months ago

On Thu, Feb 06, 2025, Purva Yeshi wrote:
> Added description for the 'nostream_work' member in struct dwc3_ep to 
> resolve the kerneldoc warning when running 'make htmldocs'.
> 
> Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com>
> ---
>  drivers/usb/dwc3/core.h | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
> index ac7c730f8..9095878d7 100644
> --- a/drivers/usb/dwc3/core.h
> +++ b/drivers/usb/dwc3/core.h
> @@ -717,6 +717,7 @@ struct dwc3_event_buffer {
>  /**
>   * struct dwc3_ep - device side endpoint representation
>   * @endpoint: usb endpoint
> + * @nostream_work: delayed work structure for handling no-stream events
>   * @cancelled_list: list of cancelled requests for this endpoint
>   * @pending_list: list of pending requests for this endpoint
>   * @started_list: list of started requests on this endpoint
> -- 
> 2.34.1
> 

I believe this fix was already added to Greg's usb-linus branch.

BR,
Thinh

Re: [PATCH] usb: dwc3: Document nostream_work member in dwc3_ep struct

Posted by Purva Yeshi 10 months ago

On 11/02/25 08:50, Thinh Nguyen wrote:
> On Thu, Feb 06, 2025, Purva Yeshi wrote:
>> Added description for the 'nostream_work' member in struct dwc3_ep to
>> resolve the kerneldoc warning when running 'make htmldocs'.
>>
>> Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com>
>> ---
>>   drivers/usb/dwc3/core.h | 1 +
>>   1 file changed, 1 insertion(+)
>>
>> diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
>> index ac7c730f8..9095878d7 100644
>> --- a/drivers/usb/dwc3/core.h
>> +++ b/drivers/usb/dwc3/core.h
>> @@ -717,6 +717,7 @@ struct dwc3_event_buffer {
>>   /**
>>    * struct dwc3_ep - device side endpoint representation
>>    * @endpoint: usb endpoint
>> + * @nostream_work: delayed work structure for handling no-stream events
>>    * @cancelled_list: list of cancelled requests for this endpoint
>>    * @pending_list: list of pending requests for this endpoint
>>    * @started_list: list of started requests on this endpoint
>> -- 
>> 2.34.1
>>
> 
> I believe this fix was already added to Greg's usb-linus branch.
> 
> BR,
> Thinh

Thank you for the update. I was not aware that this fix had already been 
included.

Best regards,
Purva Yeshi