[PATCH] usb:dwc:core.h Fixed warning of documentation

[PATCH] usb:dwc:core.h Fixed warning of documentation

[Piyush Thange]

While compiling documentation a following warning is generated.
Function parameter or member 'resume_hs_terminations' not described 
in 'dwc3'

One more warning arises in the same file as follows
Function parameter or member 'gfladj_refclk_lpm_sel' not described 
in 'dwc3'

I need some insights on this.

Signed-off-by: Piyush Thange <pthange19@gmail.com>
---
 drivers/usb/dwc3/core.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index 582ebd9cf9c2..4743e918dcaf 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -1098,7 +1098,7 @@ struct dwc3_scratchpad_array {
  *			change quirk.
  * @dis_tx_ipgap_linecheck_quirk: set if we disable u2mac linestate
  *			check during HS transmit.
- * @resume-hs-terminations: Set if we enable quirk for fixing improper crc
+ * @resume_hs_terminations: Set if we enable quirk for fixing improper crc
  *			generation after resume from suspend.
  * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
  *			instances in park mode.
-- 
2.40.0

Re: [PATCH] usb:dwc:core.h Fixed warning of documentation

[Randy Dunlap]

Hi--

On 3/28/23 20:29, Piyush Thange wrote:
> While compiling documentation a following warning is generated.
> Function parameter or member 'resume_hs_terminations' not described 
> in 'dwc3'

This one appears to be fixed already.

> One more warning arises in the same file as follows
> Function parameter or member 'gfladj_refclk_lpm_sel' not described 
> in 'dwc3'
> 
> I need some insights on this.

The second one needs a line added, probably just after:

 * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
 *			instances in park mode.

like

 * @gfladj_refclk_lpm_sel: {some description here}

Thanks.

> Signed-off-by: Piyush Thange <pthange19@gmail.com>
> ---
>  drivers/usb/dwc3/core.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
> index 582ebd9cf9c2..4743e918dcaf 100644
> --- a/drivers/usb/dwc3/core.h
> +++ b/drivers/usb/dwc3/core.h
> @@ -1098,7 +1098,7 @@ struct dwc3_scratchpad_array {
>   *			change quirk.
>   * @dis_tx_ipgap_linecheck_quirk: set if we disable u2mac linestate
>   *			check during HS transmit.
> - * @resume-hs-terminations: Set if we enable quirk for fixing improper crc
> + * @resume_hs_terminations: Set if we enable quirk for fixing improper crc
>   *			generation after resume from suspend.
>   * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
>   *			instances in park mode.

-- 
~Randy