* [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix kernel-doc style
@ 2021-11-20 6:15 Vinod Koul
2021-11-20 6:15 ` [PATCH v2 2/2] phy: ti: omap-usb2: Fix the " Vinod Koul
` (2 more replies)
0 siblings, 3 replies; 6+ messages in thread
From: Vinod Koul @ 2021-11-20 6:15 UTC (permalink / raw)
To: Kishon Vijay Abraham I
Cc: linux-phy, Vinod Koul, Andy Gross, Bjorn Andersson,
linux-arm-msm, linux-kernel, Randy Dunlap
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
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
Changes in v2: use () for function names
update description of @phy_dwc3
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..fec1da470d26 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 context
+ * @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 context
+ * @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 context
+ * @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] 6+ messages in thread
* [PATCH v2 2/2] phy: ti: omap-usb2: Fix the kernel-doc style
2021-11-20 6:15 [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
@ 2021-11-20 6:15 ` Vinod Koul
2021-11-20 17:21 ` Liam Beguin
2021-11-20 23:20 ` [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix " Bjorn Andersson
2021-11-23 5:08 ` Vinod Koul
2 siblings, 1 reply; 6+ messages in thread
From: Vinod Koul @ 2021-11-20 6:15 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>
---
Changes in v2: use () for function names
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..3a505fe5715a 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] 6+ messages in thread
* Re: [PATCH v2 2/2] phy: ti: omap-usb2: Fix the kernel-doc style
2021-11-20 6:15 ` [PATCH v2 2/2] phy: ti: omap-usb2: Fix the " Vinod Koul
@ 2021-11-20 17:21 ` Liam Beguin
2021-11-25 5:13 ` Vinod Koul
0 siblings, 1 reply; 6+ messages in thread
From: Liam Beguin @ 2021-11-20 17:21 UTC (permalink / raw)
To: Vinod Koul
Cc: Kishon Vijay Abraham I, linux-phy, Roger Quadros, Liam Beguin,
linux-kernel
Hi Vinod,
On Sat, Nov 20, 2021 at 11:45:31AM +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>
> ---
> Changes in v2: use () for function names
>
> 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..3a505fe5715a 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
My apologies for the noise, I just noticed your v2.
Reviewed-by: Liam Beguin <liambeguin@gmail.com>
> + *
> + * @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 [flat|nested] 6+ messages in thread
* Re: [PATCH v2 2/2] phy: ti: omap-usb2: Fix the kernel-doc style
2021-11-20 17:21 ` Liam Beguin
@ 2021-11-25 5:13 ` Vinod Koul
0 siblings, 0 replies; 6+ messages in thread
From: Vinod Koul @ 2021-11-25 5:13 UTC (permalink / raw)
To: Liam Beguin
Cc: Kishon Vijay Abraham I, linux-phy, Roger Quadros, Liam Beguin,
linux-kernel
On 20-11-21, 12:21, Liam Beguin wrote:
> Hi Vinod,
>
> On Sat, Nov 20, 2021 at 11:45:31AM +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>
> > ---
> > Changes in v2: use () for function names
> >
> > 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..3a505fe5715a 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
>
> My apologies for the noise, I just noticed your v2.
No worries :)
>
> Reviewed-by: Liam Beguin <liambeguin@gmail.com>
Thanks
--
~Vinod
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix kernel-doc style
2021-11-20 6:15 [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
2021-11-20 6:15 ` [PATCH v2 2/2] phy: ti: omap-usb2: Fix the " Vinod Koul
@ 2021-11-20 23:20 ` Bjorn Andersson
2021-11-23 5:08 ` Vinod Koul
2 siblings, 0 replies; 6+ messages in thread
From: Bjorn Andersson @ 2021-11-20 23:20 UTC (permalink / raw)
To: Vinod Koul
Cc: Kishon Vijay Abraham I, linux-phy, Andy Gross, linux-arm-msm,
linux-kernel, Randy Dunlap
On Fri 19 Nov 22:15 PST 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
>
Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> Signed-off-by: Vinod Koul <vkoul@kernel.org>
> ---
>
> Changes in v2: use () for function names
> update description of @phy_dwc3
>
> 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..fec1da470d26 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 context
> + * @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 context
> + * @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 context
> + * @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] 6+ messages in thread
* Re: [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix kernel-doc style
2021-11-20 6:15 [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
2021-11-20 6:15 ` [PATCH v2 2/2] phy: ti: omap-usb2: Fix the " Vinod Koul
2021-11-20 23:20 ` [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix " Bjorn Andersson
@ 2021-11-23 5:08 ` Vinod Koul
2 siblings, 0 replies; 6+ messages in thread
From: Vinod Koul @ 2021-11-23 5:08 UTC (permalink / raw)
To: Kishon Vijay Abraham I
Cc: linux-phy, Andy Gross, Bjorn Andersson, linux-arm-msm,
linux-kernel, Randy Dunlap
On 20-11-21, 11:45, 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
Applied both, thanks
--
~Vinod
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-11-25 5:15 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-20 6:15 [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
2021-11-20 6:15 ` [PATCH v2 2/2] phy: ti: omap-usb2: Fix the " Vinod Koul
2021-11-20 17:21 ` Liam Beguin
2021-11-25 5:13 ` Vinod Koul
2021-11-20 23:20 ` [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix " Bjorn Andersson
2021-11-23 5:08 ` Vinod Koul
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).