diff mbox series

[v2] usb: fix kernel-doc warning

Message ID 20231002170515.207633-1-swarupkotikalapudi@gmail.com (mailing list archive)
State New, archived
Headers show
Series [v2] usb: fix kernel-doc warning | expand

Commit Message

swarup Oct. 2, 2023, 5:05 p.m. UTC
Fix kernel-doc warnings discovered in usb driver.

Fixes this warning:
warning: Function parameter or member 'gfladj_refclk_lpm_sel'
         not described in 'dwc3'

Fixes: cf1202418e0b ("usb: fix kernel-doc warning")
Signed-off-by: Swarup Laxman Kotiaklapudi <swarupkotikalapudi@gmail.com>
---
 drivers/usb/dwc3/core.h | 2 ++
 1 file changed, 2 insertions(+)

Comments

Thinh Nguyen Oct. 2, 2023, 6:26 p.m. UTC | #1
On Mon, Oct 02, 2023, Swarup Laxman Kotiaklapudi wrote:
> Fix kernel-doc warnings discovered in usb driver.
> 
> Fixes this warning:
> warning: Function parameter or member 'gfladj_refclk_lpm_sel'
>          not described in 'dwc3'
> 
> Fixes: cf1202418e0b ("usb: fix kernel-doc warning")

This id doesn't match anything in the mainline kernel.

> Signed-off-by: Swarup Laxman Kotiaklapudi <swarupkotikalapudi@gmail.com>
> ---

Please note changes since v1 here.

>  drivers/usb/dwc3/core.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
> index a69ac67d89fe..078edfe0f88e 100644
> --- a/drivers/usb/dwc3/core.h
> +++ b/drivers/usb/dwc3/core.h
> @@ -1106,6 +1106,8 @@ struct dwc3_scratchpad_array {
>   *			instances in park mode.
>   * @parkmode_disable_hs_quirk: set if we need to disable all HishSpeed
>   *			instances in park mode.
> + * @gfladj_refclk_lpm_sel: set if we need to enable reference clock for LPM in
> + *                         Global Frame Length Adjustment register
>   * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
>   * @tx_de_emphasis: Tx de-emphasis value
>   *	0	- -6dB de-emphasis
> -- 
> 2.34.1
> 

Also, please prefix $subject line with "usb: dwc3:"

Thanks,
Thinh
diff mbox series

Patch

diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index a69ac67d89fe..078edfe0f88e 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -1106,6 +1106,8 @@  struct dwc3_scratchpad_array {
  *			instances in park mode.
  * @parkmode_disable_hs_quirk: set if we need to disable all HishSpeed
  *			instances in park mode.
+ * @gfladj_refclk_lpm_sel: set if we need to enable reference clock for LPM in
+ *                         Global Frame Length Adjustment register
  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
  * @tx_de_emphasis: Tx de-emphasis value
  *	0	- -6dB de-emphasis