linux-kernel - drivers/net/phy/aquantia/aquantia_main.c:353: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <202504262247.1UBrDBVN-lkp@intel.com>
Date: Sat, 26 Apr 2025 22:14:54 +0800
From: kernel test robot <lkp@...el.com>
To: Aryan Srivastava <aryan.srivastava@...iedtelesis.co.nz>
Cc: llvm@...ts.linux.dev, oe-kbuild-all@...ts.linux.dev,
	linux-kernel@...r.kernel.org, Jakub Kicinski <kuba@...nel.org>,
	Andrew Lunn <andrew@...n.ch>, linux-doc@...r.kernel.org
Subject: drivers/net/phy/aquantia/aquantia_main.c:353: warning: This comment
 starts with '/**', but isn't a kernel-doc comment. Refer
 Documentation/doc-guide/kernel-doc.rst

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   02ddfb981de88a2c15621115dd7be2431252c568
commit: 7e5b547cac7a56515b2838b496923e52ec4eeddd net: phy: aquantia: poll status register
date:   7 months ago
config: riscv-randconfig-002-20250426 (https://download.01.org/0day-ci/archive/20250426/202504262247.1UBrDBVN-lkp@intel.com/config)
compiler: clang version 21.0.0git (https://github.com/llvm/llvm-project f819f46284f2a79790038e1f6649172789734ae8)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20250426/202504262247.1UBrDBVN-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@...el.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202504262247.1UBrDBVN-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/net/phy/aquantia/aquantia_main.c:353: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
            * The status register is not immediately correct on line side link up.


vim +353 drivers/net/phy/aquantia/aquantia_main.c

   340	
   341	static int aqr107_read_status(struct phy_device *phydev)
   342	{
   343		int val, ret;
   344	
   345		ret = aqr_read_status(phydev);
   346		if (ret)
   347			return ret;
   348	
   349		if (!phydev->link || phydev->autoneg == AUTONEG_DISABLE)
   350			return 0;
   351	
   352		/**
 > 353		 * The status register is not immediately correct on line side link up.
   354		 * Poll periodically until it reflects the correct ON state.
   355		 * Only return fail for read error, timeout defaults to OFF state.
   356		 */
   357		ret = phy_read_mmd_poll_timeout(phydev, MDIO_MMD_PHYXS,
   358						MDIO_PHYXS_VEND_IF_STATUS, val,
   359						(FIELD_GET(MDIO_PHYXS_VEND_IF_STATUS_TYPE_MASK, val) !=
   360						MDIO_PHYXS_VEND_IF_STATUS_TYPE_OFF),
   361						AQR107_OP_IN_PROG_SLEEP,
   362						AQR107_OP_IN_PROG_TIMEOUT, false);
   363		if (ret && ret != -ETIMEDOUT)
   364			return ret;
   365	
   366		switch (FIELD_GET(MDIO_PHYXS_VEND_IF_STATUS_TYPE_MASK, val)) {
   367		case MDIO_PHYXS_VEND_IF_STATUS_TYPE_KR:
   368			phydev->interface = PHY_INTERFACE_MODE_10GKR;
   369			break;
   370		case MDIO_PHYXS_VEND_IF_STATUS_TYPE_KX:
   371			phydev->interface = PHY_INTERFACE_MODE_1000BASEKX;
   372			break;
   373		case MDIO_PHYXS_VEND_IF_STATUS_TYPE_XFI:
   374			phydev->interface = PHY_INTERFACE_MODE_10GBASER;
   375			break;
   376		case MDIO_PHYXS_VEND_IF_STATUS_TYPE_USXGMII:
   377			phydev->interface = PHY_INTERFACE_MODE_USXGMII;
   378			break;
   379		case MDIO_PHYXS_VEND_IF_STATUS_TYPE_XAUI:
   380			phydev->interface = PHY_INTERFACE_MODE_XAUI;
   381			break;
   382		case MDIO_PHYXS_VEND_IF_STATUS_TYPE_SGMII:
   383			phydev->interface = PHY_INTERFACE_MODE_SGMII;
   384			break;
   385		case MDIO_PHYXS_VEND_IF_STATUS_TYPE_RXAUI:
   386			phydev->interface = PHY_INTERFACE_MODE_RXAUI;
   387			break;
   388		case MDIO_PHYXS_VEND_IF_STATUS_TYPE_OCSGMII:
   389			phydev->interface = PHY_INTERFACE_MODE_2500BASEX;
   390			break;
   391		case MDIO_PHYXS_VEND_IF_STATUS_TYPE_OFF:
   392		default:
   393			phydev->link = false;
   394			phydev->interface = PHY_INTERFACE_MODE_NA;
   395			break;
   396		}
   397	
   398		/* Read possibly downshifted rate from vendor register */
   399		return aqr107_read_rate(phydev);
   400	}
   401	

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki