linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/6] phy: mvebu-cp110-utmi: Fix kernel-doc warns
@ 2021-11-16 10:39 Vinod Koul
  2021-11-16 10:39 ` [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
                   ` (4 more replies)
  0 siblings, 5 replies; 14+ messages in thread
From: Vinod Koul @ 2021-11-16 10:39 UTC (permalink / raw)
  To: Kishon Vijay Abraham I
  Cc: linux-phy, Vinod Koul, Konstantin Porotchkin, linux-kernel

Fix the format and add description for ops to fix the below warnings:

drivers/phy/marvell/phy-mvebu-cp110-utmi.c:94: warning: Function parameter or member 'syscon' not described in 'mvebu_cp110_utmi'
drivers/phy/marvell/phy-mvebu-cp110-utmi.c:94: warning: Function parameter or member 'ops' not described in 'mvebu_cp110_utmi'

Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
 drivers/phy/marvell/phy-mvebu-cp110-utmi.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/phy/marvell/phy-mvebu-cp110-utmi.c b/drivers/phy/marvell/phy-mvebu-cp110-utmi.c
index 08d178a4dc13..aa27c7994610 100644
--- a/drivers/phy/marvell/phy-mvebu-cp110-utmi.c
+++ b/drivers/phy/marvell/phy-mvebu-cp110-utmi.c
@@ -82,9 +82,9 @@
  * struct mvebu_cp110_utmi - PHY driver data
  *
  * @regs: PHY registers
- * @syscom: Regmap with system controller registers
+ * @syscon: Regmap with system controller registers
  * @dev: device driver handle
- * @caps: PHY capabilities
+ * @ops: phy ops
  */
 struct mvebu_cp110_utmi {
 	void __iomem *regs;
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style
  2021-11-16 10:39 [PATCH 1/6] phy: mvebu-cp110-utmi: Fix kernel-doc warns Vinod Koul
@ 2021-11-16 10:39 ` Vinod Koul
  2021-11-16 23:38   ` Randy Dunlap
  2021-11-18  0:18   ` Bjorn Andersson
  2021-11-16 10:39 ` [PATCH 3/6] phy: qualcomm: qmp: Add missing struct documentation Vinod Koul
                   ` (3 subsequent siblings)
  4 siblings, 2 replies; 14+ messages in thread
From: Vinod Koul @ 2021-11-16 10:39 UTC (permalink / raw)
  To: Kishon Vijay Abraham I
  Cc: linux-phy, Vinod Koul, Andy Gross, Bjorn Andersson,
	linux-arm-msm, linux-kernel

The functions are documented but there were style issues, so fix
the style and add missing description for phy_dwc3

drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:130:
drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:174:
drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:212: warning:
This comment starts with '/**', but isn't a kernel-doc comment.
Refer Documentation/doc-guide/kernel-doc.rst

Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
 drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c | 26 +++++++++++----------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c b/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c
index bfff0c8c9130..e1b8fa911416 100644
--- a/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c
+++ b/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c
@@ -127,12 +127,13 @@ struct phy_drvdata {
 };
 
 /**
- * Write register and read back masked value to confirm it is written
+ * usb_phy_write_readback - Write register and read back masked value to
+ * confirm it is written
  *
- * @base - QCOM DWC3 PHY base virtual address.
- * @offset - register offset.
- * @mask - register bitmask specifying what should be updated
- * @val - value to write.
+ * @phy_dwc3: QCOM DWC3 PHY base virtual address.
+ * @offset: register offset.
+ * @mask: register bitmask specifying what should be updated
+ * @val: value to write.
  */
 static inline void usb_phy_write_readback(struct usb_phy *phy_dwc3,
 					  u32 offset,
@@ -171,11 +172,11 @@ static int wait_for_latch(void __iomem *addr)
 }
 
 /**
- * Write SSPHY register
+ * usb_ss_write_phycreg - Write SSPHY register
  *
- * @base - QCOM DWC3 PHY base virtual address.
- * @addr - SSPHY address to write.
- * @val - value to write.
+ * @phy_dwc3: QCOM DWC3 PHY base virtual address.
+ * @addr: SSPHY address to write.
+ * @val: value to write.
  */
 static int usb_ss_write_phycreg(struct usb_phy *phy_dwc3,
 				u32 addr, u32 val)
@@ -209,10 +210,11 @@ static int usb_ss_write_phycreg(struct usb_phy *phy_dwc3,
 }
 
 /**
- * Read SSPHY register.
+ * usb_ss_read_phycreg - Read SSPHY register.
  *
- * @base - QCOM DWC3 PHY base virtual address.
- * @addr - SSPHY address to read.
+ * @phy_dwc3: QCOM DWC3 PHY base virtual address.
+ * @addr: SSPHY address to read.
+ * @val: pointer in which read is store.
  */
 static int usb_ss_read_phycreg(struct usb_phy *phy_dwc3,
 			       u32 addr, u32 *val)
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* [PATCH 3/6] phy: qualcomm: qmp: Add missing struct documentation
  2021-11-16 10:39 [PATCH 1/6] phy: mvebu-cp110-utmi: Fix kernel-doc warns Vinod Koul
  2021-11-16 10:39 ` [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
@ 2021-11-16 10:39 ` Vinod Koul
  2021-11-18  0:19   ` Bjorn Andersson
  2021-11-16 10:39 ` [PATCH 4/6] phy: qualcomm: usb-hsic: Fix the kernel-doc warn Vinod Koul
                   ` (2 subsequent siblings)
  4 siblings, 1 reply; 14+ messages in thread
From: Vinod Koul @ 2021-11-16 10:39 UTC (permalink / raw)
  To: Kishon Vijay Abraham I
  Cc: linux-phy, Vinod Koul, Andy Gross, Bjorn Andersson,
	linux-arm-msm, linux-kernel

dp-* members were added to qmp_phy_combo_cfg but documentation was
missed, so add that.

drivers/phy/qualcomm/phy-qcom-qmp.c:2995: warning: Function parameter or member 'dp_aux_cfg' not described in 'qmp_phy'
drivers/phy/qualcomm/phy-qcom-qmp.c:2995: warning: Function parameter or member 'dp_opts' not described in 'qmp_phy'
drivers/phy/qualcomm/phy-qcom-qmp.c:2995: warning: Function parameter or member 'dp_clks' not described in 'qmp_phy'

Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
 drivers/phy/qualcomm/phy-qcom-qmp.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/drivers/phy/qualcomm/phy-qcom-qmp.c b/drivers/phy/qualcomm/phy-qcom-qmp.c
index 456a59d8c7d0..c96639d5f581 100644
--- a/drivers/phy/qualcomm/phy-qcom-qmp.c
+++ b/drivers/phy/qualcomm/phy-qcom-qmp.c
@@ -2973,6 +2973,9 @@ struct qmp_phy_combo_cfg {
  * @qmp: QMP phy to which this lane belongs
  * @lane_rst: lane's reset controller
  * @mode: current PHY mode
+ * @dp_aux_cfg: Display port aux config
+ * @dp_opts: Display port optional config
+ * @dp_clks: Display port clocks
  */
 struct qmp_phy {
 	struct phy *phy;
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* [PATCH 4/6] phy: qualcomm: usb-hsic: Fix the kernel-doc warn
  2021-11-16 10:39 [PATCH 1/6] phy: mvebu-cp110-utmi: Fix kernel-doc warns Vinod Koul
  2021-11-16 10:39 ` [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
  2021-11-16 10:39 ` [PATCH 3/6] phy: qualcomm: qmp: Add missing struct documentation Vinod Koul
@ 2021-11-16 10:39 ` Vinod Koul
  2021-11-18  0:20   ` Bjorn Andersson
  2021-11-16 10:39 ` [PATCH 5/6] phy: ti: omap-usb2: Fix the kernel-doc style Vinod Koul
  2021-11-16 10:39 ` [PATCH 6/6] phy: ti: tusb1210: Fix the kernel-doc warn Vinod Koul
  4 siblings, 1 reply; 14+ messages in thread
From: Vinod Koul @ 2021-11-16 10:39 UTC (permalink / raw)
  To: Kishon Vijay Abraham I
  Cc: linux-phy, Vinod Koul, Andy Gross, Bjorn Andersson,
	linux-arm-msm, linux-kernel

The comment is not kernel-doc one and starts with /**, so fix that.

drivers/phy/qualcomm/phy-qcom-usb-hsic.c:3: warning:
This comment starts with '/**', but isn't a kernel-doc comment.
Refer Documentation/doc-guide/kernel-doc.rst

Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
 drivers/phy/qualcomm/phy-qcom-usb-hsic.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/phy/qualcomm/phy-qcom-usb-hsic.c b/drivers/phy/qualcomm/phy-qcom-usb-hsic.c
index 04d18d52f700..716a77748ed8 100644
--- a/drivers/phy/qualcomm/phy-qcom-usb-hsic.c
+++ b/drivers/phy/qualcomm/phy-qcom-usb-hsic.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * Copyright (C) 2016 Linaro Ltd
  */
 #include <linux/module.h>
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* [PATCH 5/6] phy: ti: omap-usb2: Fix the kernel-doc style
  2021-11-16 10:39 [PATCH 1/6] phy: mvebu-cp110-utmi: Fix kernel-doc warns Vinod Koul
                   ` (2 preceding siblings ...)
  2021-11-16 10:39 ` [PATCH 4/6] phy: qualcomm: usb-hsic: Fix the kernel-doc warn Vinod Koul
@ 2021-11-16 10:39 ` Vinod Koul
  2021-11-16 16:43   ` Liam Beguin
  2021-11-20 17:10   ` Liam Beguin
  2021-11-16 10:39 ` [PATCH 6/6] phy: ti: tusb1210: Fix the kernel-doc warn Vinod Koul
  4 siblings, 2 replies; 14+ messages in thread
From: Vinod Koul @ 2021-11-16 10:39 UTC (permalink / raw)
  To: Kishon Vijay Abraham I
  Cc: linux-phy, Vinod Koul, Roger Quadros, Liam Beguin, linux-kernel

The documentation uses incorrect style, so fix that.

drivers/phy/ti/phy-omap-usb2.c:102: warning: Function parameter or member 'comparator' not described in 'omap_usb2_set_comparator'

While at it, use a single line for function description

Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
 drivers/phy/ti/phy-omap-usb2.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/phy/ti/phy-omap-usb2.c b/drivers/phy/ti/phy-omap-usb2.c
index ebceb1520ce8..2102b7f73ffa 100644
--- a/drivers/phy/ti/phy-omap-usb2.c
+++ b/drivers/phy/ti/phy-omap-usb2.c
@@ -89,9 +89,9 @@ static inline void omap_usb_writel(void __iomem *addr, unsigned int offset,
 }
 
 /**
- * omap_usb2_set_comparator - links the comparator present in the system with
- *	this phy
- * @comparator - the companion phy(comparator) for this phy
+ * omap_usb2_set_comparator - links the comparator present in the system with this phy
+ *
+ * @comparator:  the companion phy(comparator) for this phy
  *
  * The phy companion driver should call this API passing the phy_companion
  * filled with set_vbus and start_srp to be used by usb phy.
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* [PATCH 6/6] phy: ti: tusb1210: Fix the kernel-doc warn
  2021-11-16 10:39 [PATCH 1/6] phy: mvebu-cp110-utmi: Fix kernel-doc warns Vinod Koul
                   ` (3 preceding siblings ...)
  2021-11-16 10:39 ` [PATCH 5/6] phy: ti: omap-usb2: Fix the kernel-doc style Vinod Koul
@ 2021-11-16 10:39 ` Vinod Koul
  2021-11-16 16:39   ` Liam Beguin
  4 siblings, 1 reply; 14+ messages in thread
From: Vinod Koul @ 2021-11-16 10:39 UTC (permalink / raw)
  To: Kishon Vijay Abraham I
  Cc: linux-phy, Vinod Koul, Roger Quadros, Liam Beguin, linux-kernel

The comment is not kernel-doc one and starts with /**, so fix that.

drivers/phy/ti/phy-tusb1210.c:16: warning: expecting prototype for tusb1210.c(). Prototype was for TUSB1210_VENDOR_SPECIFIC2() instead

Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
 drivers/phy/ti/phy-tusb1210.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/phy/ti/phy-tusb1210.c b/drivers/phy/ti/phy-tusb1210.c
index a63213f5972a..15c1c79e5c29 100644
--- a/drivers/phy/ti/phy-tusb1210.c
+++ b/drivers/phy/ti/phy-tusb1210.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * tusb1210.c - TUSB1210 USB ULPI PHY driver
  *
  * Copyright (C) 2015 Intel Corporation
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread

* Re: [PATCH 6/6] phy: ti: tusb1210: Fix the kernel-doc warn
  2021-11-16 10:39 ` [PATCH 6/6] phy: ti: tusb1210: Fix the kernel-doc warn Vinod Koul
@ 2021-11-16 16:39   ` Liam Beguin
  0 siblings, 0 replies; 14+ messages in thread
From: Liam Beguin @ 2021-11-16 16:39 UTC (permalink / raw)
  To: Vinod Koul
  Cc: Kishon Vijay Abraham I, linux-phy, Roger Quadros, Liam Beguin,
	linux-kernel

On Tue, Nov 16, 2021 at 04:09:51PM +0530, Vinod Koul wrote:
> The comment is not kernel-doc one and starts with /**, so fix that.
> 
> drivers/phy/ti/phy-tusb1210.c:16: warning: expecting prototype for tusb1210.c(). Prototype was for TUSB1210_VENDOR_SPECIFIC2() instead
> 
> Signed-off-by: Vinod Koul <vkoul@kernel.org>

Reviewed-by: Liam Beguin <liambeguin@gmail.com>

> ---
>  drivers/phy/ti/phy-tusb1210.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/phy/ti/phy-tusb1210.c b/drivers/phy/ti/phy-tusb1210.c
> index a63213f5972a..15c1c79e5c29 100644
> --- a/drivers/phy/ti/phy-tusb1210.c
> +++ b/drivers/phy/ti/phy-tusb1210.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * tusb1210.c - TUSB1210 USB ULPI PHY driver
>   *
>   * Copyright (C) 2015 Intel Corporation
> -- 
> 2.31.1
> 

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 5/6] phy: ti: omap-usb2: Fix the kernel-doc style
  2021-11-16 10:39 ` [PATCH 5/6] phy: ti: omap-usb2: Fix the kernel-doc style Vinod Koul
@ 2021-11-16 16:43   ` Liam Beguin
  2021-11-20 17:10   ` Liam Beguin
  1 sibling, 0 replies; 14+ messages in thread
From: Liam Beguin @ 2021-11-16 16:43 UTC (permalink / raw)
  To: Vinod Koul
  Cc: Kishon Vijay Abraham I, linux-phy, Roger Quadros, Liam Beguin,
	linux-kernel

Hi Vinod,

On Tue, Nov 16, 2021 at 04:09:50PM +0530, Vinod Koul wrote:
> The documentation uses incorrect style, so fix that.
> 
> drivers/phy/ti/phy-omap-usb2.c:102: warning: Function parameter or member 'comparator' not described in 'omap_usb2_set_comparator'
> 
> While at it, use a single line for function description
> 
> Signed-off-by: Vinod Koul <vkoul@kernel.org>

Minor nit below.

Reviewed-by: Liam Beguin <liambeguin@gmail.com>

> ---
>  drivers/phy/ti/phy-omap-usb2.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/phy/ti/phy-omap-usb2.c b/drivers/phy/ti/phy-omap-usb2.c
> index ebceb1520ce8..2102b7f73ffa 100644
> --- a/drivers/phy/ti/phy-omap-usb2.c
> +++ b/drivers/phy/ti/phy-omap-usb2.c
> @@ -89,9 +89,9 @@ static inline void omap_usb_writel(void __iomem *addr, unsigned int offset,
>  }
>  
>  /**
> - * omap_usb2_set_comparator - links the comparator present in the system with
> - *	this phy
> - * @comparator - the companion phy(comparator) for this phy
> + * omap_usb2_set_comparator - links the comparator present in the system with this phy
> + *
> + * @comparator:  the companion phy(comparator) for this phy

There's an extra space after the colon here.

Cheers,
Liam

>   *
>   * The phy companion driver should call this API passing the phy_companion
>   * filled with set_vbus and start_srp to be used by usb phy.
> -- 
> 2.31.1
> 
> 
> -- 
> linux-phy mailing list
> linux-phy@lists.infradead.org
> https://lists.infradead.org/mailman/listinfo/linux-phy

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style
  2021-11-16 10:39 ` [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
@ 2021-11-16 23:38   ` Randy Dunlap
  2021-11-18  0:18   ` Bjorn Andersson
  1 sibling, 0 replies; 14+ messages in thread
From: Randy Dunlap @ 2021-11-16 23:38 UTC (permalink / raw)
  To: Vinod Koul, Kishon Vijay Abraham I
  Cc: linux-phy, Andy Gross, Bjorn Andersson, linux-arm-msm, linux-kernel

On 11/16/21 2:39 AM, Vinod Koul wrote:
> The functions are documented but there were style issues, so fix
> the style and add missing description for phy_dwc3
> 
> drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:130:
> drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:174:
> drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:212: warning:
> This comment starts with '/**', but isn't a kernel-doc comment.
> Refer Documentation/doc-guide/kernel-doc.rst
> 
> Signed-off-by: Vinod Koul <vkoul@kernel.org>
> ---
>   drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c | 26 +++++++++++----------
>   1 file changed, 14 insertions(+), 12 deletions(-)
> 

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

thanks.
-- 
~Randy

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style
  2021-11-16 10:39 ` [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
  2021-11-16 23:38   ` Randy Dunlap
@ 2021-11-18  0:18   ` Bjorn Andersson
  2021-11-20  6:00     ` Vinod Koul
  1 sibling, 1 reply; 14+ messages in thread
From: Bjorn Andersson @ 2021-11-18  0:18 UTC (permalink / raw)
  To: Vinod Koul
  Cc: Kishon Vijay Abraham I, linux-phy, Andy Gross, linux-arm-msm,
	linux-kernel

On Tue 16 Nov 04:39 CST 2021, Vinod Koul wrote:

> The functions are documented but there were style issues, so fix
> the style and add missing description for phy_dwc3
> 
> drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:130:
> drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:174:
> drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:212: warning:
> This comment starts with '/**', but isn't a kernel-doc comment.
> Refer Documentation/doc-guide/kernel-doc.rst
> 
> Signed-off-by: Vinod Koul <vkoul@kernel.org>
> ---
>  drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c | 26 +++++++++++----------
>  1 file changed, 14 insertions(+), 12 deletions(-)
> 
> diff --git a/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c b/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c
> index bfff0c8c9130..e1b8fa911416 100644
> --- a/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c
> +++ b/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c
> @@ -127,12 +127,13 @@ struct phy_drvdata {
>  };
>  
>  /**
> - * Write register and read back masked value to confirm it is written
> + * usb_phy_write_readback - Write register and read back masked value to

"Writing kernel-doc" indicates that you should have some parenthesis
after that function.

> + * confirm it is written
>   *
> - * @base - QCOM DWC3 PHY base virtual address.
> - * @offset - register offset.
> - * @mask - register bitmask specifying what should be updated
> - * @val - value to write.
> + * @phy_dwc3: QCOM DWC3 PHY base virtual address.

I guess this was "base" at some point? As you're fixing up the
kerneldoc, it would be nice to correct this to say something like
"usb_phy context".

Regards,
Bjorn

> + * @offset: register offset.
> + * @mask: register bitmask specifying what should be updated
> + * @val: value to write.
>   */
>  static inline void usb_phy_write_readback(struct usb_phy *phy_dwc3,
>  					  u32 offset,
> @@ -171,11 +172,11 @@ static int wait_for_latch(void __iomem *addr)
>  }
>  
>  /**
> - * Write SSPHY register
> + * usb_ss_write_phycreg - Write SSPHY register
>   *
> - * @base - QCOM DWC3 PHY base virtual address.
> - * @addr - SSPHY address to write.
> - * @val - value to write.
> + * @phy_dwc3: QCOM DWC3 PHY base virtual address.
> + * @addr: SSPHY address to write.
> + * @val: value to write.
>   */
>  static int usb_ss_write_phycreg(struct usb_phy *phy_dwc3,
>  				u32 addr, u32 val)
> @@ -209,10 +210,11 @@ static int usb_ss_write_phycreg(struct usb_phy *phy_dwc3,
>  }
>  
>  /**
> - * Read SSPHY register.
> + * usb_ss_read_phycreg - Read SSPHY register.
>   *
> - * @base - QCOM DWC3 PHY base virtual address.
> - * @addr - SSPHY address to read.
> + * @phy_dwc3: QCOM DWC3 PHY base virtual address.
> + * @addr: SSPHY address to read.
> + * @val: pointer in which read is store.
>   */
>  static int usb_ss_read_phycreg(struct usb_phy *phy_dwc3,
>  			       u32 addr, u32 *val)
> -- 
> 2.31.1
> 

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 3/6] phy: qualcomm: qmp: Add missing struct documentation
  2021-11-16 10:39 ` [PATCH 3/6] phy: qualcomm: qmp: Add missing struct documentation Vinod Koul
@ 2021-11-18  0:19   ` Bjorn Andersson
  0 siblings, 0 replies; 14+ messages in thread
From: Bjorn Andersson @ 2021-11-18  0:19 UTC (permalink / raw)
  To: Vinod Koul
  Cc: Kishon Vijay Abraham I, linux-phy, Andy Gross, linux-arm-msm,
	linux-kernel

On Tue 16 Nov 04:39 CST 2021, Vinod Koul wrote:

> dp-* members were added to qmp_phy_combo_cfg but documentation was
> missed, so add that.
> 
> drivers/phy/qualcomm/phy-qcom-qmp.c:2995: warning: Function parameter or member 'dp_aux_cfg' not described in 'qmp_phy'
> drivers/phy/qualcomm/phy-qcom-qmp.c:2995: warning: Function parameter or member 'dp_opts' not described in 'qmp_phy'
> drivers/phy/qualcomm/phy-qcom-qmp.c:2995: warning: Function parameter or member 'dp_clks' not described in 'qmp_phy'
> 

Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>

Regards,
Bjorn

> Signed-off-by: Vinod Koul <vkoul@kernel.org>
> ---
>  drivers/phy/qualcomm/phy-qcom-qmp.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/phy/qualcomm/phy-qcom-qmp.c b/drivers/phy/qualcomm/phy-qcom-qmp.c
> index 456a59d8c7d0..c96639d5f581 100644
> --- a/drivers/phy/qualcomm/phy-qcom-qmp.c
> +++ b/drivers/phy/qualcomm/phy-qcom-qmp.c
> @@ -2973,6 +2973,9 @@ struct qmp_phy_combo_cfg {
>   * @qmp: QMP phy to which this lane belongs
>   * @lane_rst: lane's reset controller
>   * @mode: current PHY mode
> + * @dp_aux_cfg: Display port aux config
> + * @dp_opts: Display port optional config
> + * @dp_clks: Display port clocks
>   */
>  struct qmp_phy {
>  	struct phy *phy;
> -- 
> 2.31.1
> 

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 4/6] phy: qualcomm: usb-hsic: Fix the kernel-doc warn
  2021-11-16 10:39 ` [PATCH 4/6] phy: qualcomm: usb-hsic: Fix the kernel-doc warn Vinod Koul
@ 2021-11-18  0:20   ` Bjorn Andersson
  0 siblings, 0 replies; 14+ messages in thread
From: Bjorn Andersson @ 2021-11-18  0:20 UTC (permalink / raw)
  To: Vinod Koul
  Cc: Kishon Vijay Abraham I, linux-phy, Andy Gross, linux-arm-msm,
	linux-kernel

On Tue 16 Nov 04:39 CST 2021, Vinod Koul wrote:

> The comment is not kernel-doc one and starts with /**, so fix that.
> 
> drivers/phy/qualcomm/phy-qcom-usb-hsic.c:3: warning:
> This comment starts with '/**', but isn't a kernel-doc comment.
> Refer Documentation/doc-guide/kernel-doc.rst

Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>

> 
> Signed-off-by: Vinod Koul <vkoul@kernel.org>
> ---
>  drivers/phy/qualcomm/phy-qcom-usb-hsic.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/phy/qualcomm/phy-qcom-usb-hsic.c b/drivers/phy/qualcomm/phy-qcom-usb-hsic.c
> index 04d18d52f700..716a77748ed8 100644
> --- a/drivers/phy/qualcomm/phy-qcom-usb-hsic.c
> +++ b/drivers/phy/qualcomm/phy-qcom-usb-hsic.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (C) 2016 Linaro Ltd
>   */
>  #include <linux/module.h>
> -- 
> 2.31.1
> 

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style
  2021-11-18  0:18   ` Bjorn Andersson
@ 2021-11-20  6:00     ` Vinod Koul
  0 siblings, 0 replies; 14+ messages in thread
From: Vinod Koul @ 2021-11-20  6:00 UTC (permalink / raw)
  To: Bjorn Andersson
  Cc: Kishon Vijay Abraham I, linux-phy, Andy Gross, linux-arm-msm,
	linux-kernel

On 17-11-21, 18:18, Bjorn Andersson wrote:
> On Tue 16 Nov 04:39 CST 2021, Vinod Koul wrote:
> 
> > The functions are documented but there were style issues, so fix
> > the style and add missing description for phy_dwc3
> > 
> > drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:130:
> > drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:174:
> > drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c:212: warning:
> > This comment starts with '/**', but isn't a kernel-doc comment.
> > Refer Documentation/doc-guide/kernel-doc.rst
> > 
> > Signed-off-by: Vinod Koul <vkoul@kernel.org>
> > ---
> >  drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c | 26 +++++++++++----------
> >  1 file changed, 14 insertions(+), 12 deletions(-)
> > 
> > diff --git a/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c b/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c
> > index bfff0c8c9130..e1b8fa911416 100644
> > --- a/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c
> > +++ b/drivers/phy/qualcomm/phy-qcom-ipq806x-usb.c
> > @@ -127,12 +127,13 @@ struct phy_drvdata {
> >  };
> >  
> >  /**
> > - * Write register and read back masked value to confirm it is written
> > + * usb_phy_write_readback - Write register and read back masked value to
> 
> "Writing kernel-doc" indicates that you should have some parenthesis
> after that function.

Heh, it does not warn :(, will update this
> 
> > + * confirm it is written
> >   *
> > - * @base - QCOM DWC3 PHY base virtual address.
> > - * @offset - register offset.
> > - * @mask - register bitmask specifying what should be updated
> > - * @val - value to write.
> > + * @phy_dwc3: QCOM DWC3 PHY base virtual address.
> 
> I guess this was "base" at some point? As you're fixing up the
> kerneldoc, it would be nice to correct this to say something like
> "usb_phy context".

Why did I miss this one :(, yeah will update this

-- 
~Vinod

^ permalink raw reply	[flat|nested] 14+ messages in thread

* Re: [PATCH 5/6] phy: ti: omap-usb2: Fix the kernel-doc style
  2021-11-16 10:39 ` [PATCH 5/6] phy: ti: omap-usb2: Fix the kernel-doc style Vinod Koul
  2021-11-16 16:43   ` Liam Beguin
@ 2021-11-20 17:10   ` Liam Beguin
  1 sibling, 0 replies; 14+ messages in thread
From: Liam Beguin @ 2021-11-20 17:10 UTC (permalink / raw)
  To: Vinod Koul
  Cc: Kishon Vijay Abraham I, linux-phy, Roger Quadros, Liam Beguin,
	linux-kernel

Hi Vinod,

On Tue, Nov 16, 2021 at 04:09:50PM +0530, Vinod Koul wrote:
> The documentation uses incorrect style, so fix that.
> 
> drivers/phy/ti/phy-omap-usb2.c:102: warning: Function parameter or member 'comparator' not described in 'omap_usb2_set_comparator'
> 
> While at it, use a single line for function description
> 
> Signed-off-by: Vinod Koul <vkoul@kernel.org>
> ---
>  drivers/phy/ti/phy-omap-usb2.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/phy/ti/phy-omap-usb2.c b/drivers/phy/ti/phy-omap-usb2.c
> index ebceb1520ce8..2102b7f73ffa 100644
> --- a/drivers/phy/ti/phy-omap-usb2.c
> +++ b/drivers/phy/ti/phy-omap-usb2.c
> @@ -89,9 +89,9 @@ static inline void omap_usb_writel(void __iomem *addr, unsigned int offset,
>  }
>  
>  /**
> - * omap_usb2_set_comparator - links the comparator present in the system with
> - *	this phy
> - * @comparator - the companion phy(comparator) for this phy
> + * omap_usb2_set_comparator - links the comparator present in the system with this phy

I missed it before but as Bjorn pointed out in this thread, it appears
the function name should end with parentheses.

Cheers,
Liam

> + *
> + * @comparator:  the companion phy(comparator) for this phy
>   *
>   * The phy companion driver should call this API passing the phy_companion
>   * filled with set_vbus and start_srp to be used by usb phy.
> -- 
> 2.31.1
> 
> 
> -- 
> linux-phy mailing list
> linux-phy@lists.infradead.org
> https://lists.infradead.org/mailman/listinfo/linux-phy

^ permalink raw reply	[flat|nested] 14+ messages in thread

end of thread, other threads:[~2021-11-20 17:10 UTC | newest]

Thread overview: 14+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-16 10:39 [PATCH 1/6] phy: mvebu-cp110-utmi: Fix kernel-doc warns Vinod Koul
2021-11-16 10:39 ` [PATCH 2/6] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
2021-11-16 23:38   ` Randy Dunlap
2021-11-18  0:18   ` Bjorn Andersson
2021-11-20  6:00     ` Vinod Koul
2021-11-16 10:39 ` [PATCH 3/6] phy: qualcomm: qmp: Add missing struct documentation Vinod Koul
2021-11-18  0:19   ` Bjorn Andersson
2021-11-16 10:39 ` [PATCH 4/6] phy: qualcomm: usb-hsic: Fix the kernel-doc warn Vinod Koul
2021-11-18  0:20   ` Bjorn Andersson
2021-11-16 10:39 ` [PATCH 5/6] phy: ti: omap-usb2: Fix the kernel-doc style Vinod Koul
2021-11-16 16:43   ` Liam Beguin
2021-11-20 17:10   ` Liam Beguin
2021-11-16 10:39 ` [PATCH 6/6] phy: ti: tusb1210: Fix the kernel-doc warn Vinod Koul
2021-11-16 16:39   ` Liam Beguin

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).