[PATCH] phy: rockchip: inno-usb2: Add missing clkout_ctl_phy kerneldoc

[PATCH] phy: rockchip: inno-usb2: Add missing clkout_ctl_phy kerneldoc

[Heiko Stuebner]

Add the missing documentation for the newly added clkout_ctl_phy field.

Fixes: 2775541de058 ("phy: rockchip: inno-usb2: Add clkout_ctl_phy support")
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202605150315.MyBNQOPB-lkp@intel.com/
Signed-off-by: Heiko Stuebner <heiko@sntech.de>
---
 drivers/phy/rockchip/phy-rockchip-inno-usb2.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
index 133cfd6624e8..7d8a533f24ae 100644
--- a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
+++ b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
@@ -170,7 +170,8 @@ struct rockchip_usb2phy_port_cfg {
  * @reg: the address offset of grf for usb-phy config.
  * @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: register to enable output clk of phy, when set in GRF
+ * @clkout_ctl_phy: register to enable output clk of phy, when set inside phy
  * @port_cfgs: usb-phy port configurations.
  * @chg_det: charger detection registers.
  */
-- 
2.47.3


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

Re: [PATCH] phy: rockchip: inno-usb2: Add missing clkout_ctl_phy kerneldoc

[sashiko-bot]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] The patch adds a kernel-doc description for a non-existent struct member `clkout_ctl_phy`, causing a documentation build warning.
--

commit f1dbf7fe726d10232258e61a8deb0085a6686e19
Author: Heiko Stuebner <heiko@sntech.de>

phy: rockchip: inno-usb2: Add missing clkout_ctl_phy kerneldoc

Add the missing documentation for the newly added clkout_ctl_phy field.

Closes: https://lore.kernel.org/oe-kbuild-all/202605150315.MyBNQOPB-lkp@intel.com/

> diff --git a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
> index 8f4c08e599aa2..2dd651624e6d4 100644
> --- a/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
> +++ b/drivers/phy/rockchip/phy-rockchip-inno-usb2.c
> @@ -170,7 +170,8 @@ struct rockchip_usb2phy_port_cfg {
>   * @reg: the address offset of grf for usb-phy config.
>   * @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: register to enable output clk of phy, when set in GRF
> + * @clkout_ctl_phy: register to enable output clk of phy, when set inside phy

[Severity: Low]
Will this cause an excess struct member warning during the documentation build?

Looking at struct rockchip_usb2phy_cfg in this file, it does not contain a
clkout_ctl_phy field:

struct rockchip_usb2phy_cfg {
	unsigned int	reg;
	unsigned int	num_ports;
	int (*phy_tuning)(struct rockchip_usb2phy *rphy);
	struct usb2phy_reg	clkout_ctl;
	const struct rockchip_usb2phy_port_cfg	port_cfgs[USB2PHY_NUM_PORTS];
	const struct rockchip_chg_det_reg	chg_det;
};

Does this code document a member that does not exist in the structure
definition on this branch?

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

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260520102859.1357411-1-heiko@sntech.de?part=1

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