[PATCH] phy: rockchip: inno-usb2: fix missing kernel-doc

[PATCH] phy: rockchip: inno-usb2: fix missing kernel-doc

[Vinod Koul]

Commit 2775541de058 ("phy: rockchip: inno-usb2: Add clkout_ctl_phy
support") added clkout_ctl_phy variable but missed to describe it,
leading to warning

Warning: drivers/phy/rockchip/phy-rockchip-inno-usb2.c:184
	struct member 'clkout_ctl_phy' not described in 'rockchip_usb2phy_cfg'

Document this variable

Fixes: 2775541de058 ("phy: rockchip: inno-usb2: Add clkout_ctl_phy support")"
Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
 drivers/phy/rockchip/phy-rockchip-inno-usb2.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
index 133cfd6624e8..120b4a7433c3 100644
--- a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
+++ b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
@@ -171,6 +171,7 @@ struct rockchip_usb2phy_port_cfg {
  * @num_ports: specify how many ports that the phy has.
  * @phy_tuning: phy default parameters tuning.
  * @clkout_ctl: keep on/turn off output clk of phy.
+ * @clkout_ctl_phy: output clk phy registers
  * @port_cfgs: usb-phy port configurations.
  * @chg_det: charger detection registers.
  */
-- 
2.43.0


-- 
linux-phy mailing list
linux-phy@lists.infradead.org
https://lists.infradead.org/mailman/listinfo/linux-phy

Re: [PATCH] phy: rockchip: inno-usb2: fix missing kernel-doc

[sashiko-bot]

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Low] The commit adds a kernel-doc description for a struct member `clkout_ctl_phy` that does not exist in `struct rockchip_usb2phy_cfg`.
- [Low] The `Fixes:` tag in the commit message is malformed due to an extraneous trailing double quote.
--

commit 532f790b604de504c1843006c2bda7a4bcb6937e
Author: Vinod Koul <vkoul@kernel.org>

phy: rockchip: inno-usb2: fix missing kernel-doc

This commit documents the clkout_ctl_phy variable in the kernel-doc block
to resolve a missing description warning.

> Fixes: 2775541de058 ("phy: rockchip: inno-usb2: Add clkout_ctl_phy support")"

This isn't a bug, but there is an extraneous trailing double quote at the end
of the Fixes tag.

> diff --git a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
> index 8f4c08e599aa2..a69e7dbe18195 100644
> --- a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
> +++ b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
> @@ -171,6 +171,7 @@ struct rockchip_usb2phy_port_cfg {
>   * @num_ports: specify how many ports that the phy has.
>   * @phy_tuning: phy default parameters tuning.
>   * @clkout_ctl: keep on/turn off output clk of phy.
> + * @clkout_ctl_phy: output clk phy registers

Is the clkout_ctl_phy field present in the structure definition here?

If the structure is missing this member, adding the description will
trigger an excess struct member warning instead.

>   * @port_cfgs: usb-phy port configurations.
>   * @chg_det: charger detection registers.
>   */

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260519110134.282428-1-vkoul@kernel.org?part=1

-- 
linux-phy mailing list
linux-phy@lists.infradead.org
https://lists.infradead.org/mailman/listinfo/linux-phy

Re: [PATCH] phy: rockchip: inno-usb2: fix missing kernel-doc

[Vinod Koul]

On 19-05-26, 11:19, sashiko-bot@kernel.org wrote:
> Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
> - [Low] The commit adds a kernel-doc description for a struct member `clkout_ctl_phy` that does not exist in `struct rockchip_usb2phy_cfg`.
> - [Low] The `Fixes:` tag in the commit message is malformed due to an extraneous trailing double quote.

Thanks for reporting this. fixed.
> --
> 
> commit 532f790b604de504c1843006c2bda7a4bcb6937e
> Author: Vinod Koul <vkoul@kernel.org>
> 
> phy: rockchip: inno-usb2: fix missing kernel-doc
> 
> This commit documents the clkout_ctl_phy variable in the kernel-doc block
> to resolve a missing description warning.
> 
> > Fixes: 2775541de058 ("phy: rockchip: inno-usb2: Add clkout_ctl_phy support")"
> 
> This isn't a bug, but there is an extraneous trailing double quote at the end
> of the Fixes tag.
> 
> > diff --git a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
> > index 8f4c08e599aa2..a69e7dbe18195 100644
> > --- a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
> > +++ b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
> > @@ -171,6 +171,7 @@ struct rockchip_usb2phy_port_cfg {
> >   * @num_ports: specify how many ports that the phy has.
> >   * @phy_tuning: phy default parameters tuning.
> >   * @clkout_ctl: keep on/turn off output clk of phy.
> > + * @clkout_ctl_phy: output clk phy registers
> 
> Is the clkout_ctl_phy field present in the structure definition here?
> 
> If the structure is missing this member, adding the description will
> trigger an excess struct member warning instead.

Ideally right but in this case it add the missing one which should have
been clear from the change log

> 
> >   * @port_cfgs: usb-phy port configurations.
> >   * @chg_det: charger detection registers.
> >   */
> 
> -- 
> Sashiko AI review · https://sashiko.dev/#/patchset/20260519110134.282428-1-vkoul@kernel.org?part=1

-- 
~Vinod

-- 
linux-phy mailing list
linux-phy@lists.infradead.org
https://lists.infradead.org/mailman/listinfo/linux-phy