diff mbox series

[v3] usb: dwc3: document gfladj_refclk_lpm_sel field

Message ID 20231002210137.209382-1-swarupkotikalapudi@gmail.com (mailing list archive)
State Accepted
Commit e24bc293a6a6d29a2df235056094574ba37acc04
Headers show
Series [v3] usb: dwc3: document gfladj_refclk_lpm_sel field | expand

Commit Message

swarup Oct. 2, 2023, 9:01 p.m. UTC
Avoid a kernel-doc warning by documenting it:
	drivers/usb/dwc3/core.h:1343: warning:
	  Function parameter or member 'gfladj_refclk_lpm_sel'
          not described in 'dwc3'

Fixes: a6fc2f1b0927 ("usb: dwc3: core: add gfladj_refclk_lpm_sel quirk")
Signed-off-by: Swarup Laxman Kotiaklapudi <swarupkotikalapudi@gmail.com>
---
 Changes in V3:
 - Include correct Fixes tag as suggested by Thinh
 - Update the commit message
 - Update the commit log
 - Change wording of document warning fix
 
 Changes in V2:
 - Include Fixes tag as suggested by Greg

 Changes in V1:
 - Fix document warning

 drivers/usb/dwc3/core.h | 2 ++
 1 file changed, 2 insertions(+)

Comments

Thinh Nguyen Oct. 2, 2023, 9:41 p.m. UTC | #1
On Tue, Oct 03, 2023, Swarup Laxman Kotiaklapudi wrote:
> Avoid a kernel-doc warning by documenting it:
> 	drivers/usb/dwc3/core.h:1343: warning:
> 	  Function parameter or member 'gfladj_refclk_lpm_sel'
>           not described in 'dwc3'
> 
> Fixes: a6fc2f1b0927 ("usb: dwc3: core: add gfladj_refclk_lpm_sel quirk")
> Signed-off-by: Swarup Laxman Kotiaklapudi <swarupkotikalapudi@gmail.com>
> ---
>  Changes in V3:
>  - Include correct Fixes tag as suggested by Thinh
>  - Update the commit message
>  - Update the commit log
>  - Change wording of document warning fix
>  
>  Changes in V2:
>  - Include Fixes tag as suggested by Greg
> 
>  Changes in V1:
>  - Fix document warning
> 
>  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..96685391696d 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 SOF/ITP counter
> + *                          running based on ref_clk
>   * @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
> 

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

Thanks,
Thinh
diff mbox series

Patch

diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index a69ac67d89fe..96685391696d 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 SOF/ITP counter
+ *                          running based on ref_clk
  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
  * @tx_de_emphasis: Tx de-emphasis value
  *	0	- -6dB de-emphasis