linux-kernel - drivers/net/ethernet/wangxun/libwx/wx_ptp.c:415: 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: <202504270243.xykBkzwC-lkp@intel.com>
Date: Sun, 27 Apr 2025 02:12:42 +0800
From: kernel test robot <lkp@...el.com>
To: Jiawen Wu <jiawenwu@...stnetic.com>
Cc: llvm@...ts.linux.dev, oe-kbuild-all@...ts.linux.dev,
	linux-kernel@...r.kernel.org, Jakub Kicinski <kuba@...nel.org>,
	linux-doc@...r.kernel.org
Subject: drivers/net/ethernet/wangxun/libwx/wx_ptp.c:415: 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: 2d8967e86c9b12e7b8a82a531572186b2b97e804 net: ngbe: Add support for 1PPS and TOD
date:   9 weeks ago
config: arm64-randconfig-001-20250426 (https://download.01.org/0day-ci/archive/20250427/202504270243.xykBkzwC-lkp@intel.com/config)
compiler: clang version 16.0.6 (https://github.com/llvm/llvm-project 7cbf1a2591520c2491aa35339f227775f4d3adf6)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20250427/202504270243.xykBkzwC-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/202504270243.xykBkzwC-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/net/ethernet/wangxun/libwx/wx_ptp.c:415: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
            * When PPS is enabled, unmask the interrupt for the ClockOut


vim +415 drivers/net/ethernet/wangxun/libwx/wx_ptp.c

   408	
   409	static int wx_ptp_feature_enable(struct ptp_clock_info *ptp,
   410					 struct ptp_clock_request *rq, int on)
   411	{
   412		struct wx *wx = container_of(ptp, struct wx, ptp_caps);
   413	
   414		/**
 > 415		 * When PPS is enabled, unmask the interrupt for the ClockOut
   416		 * feature, so that the interrupt handler can send the PPS
   417		 * event when the clock SDP triggers. Clear mask when PPS is
   418		 * disabled
   419		 */
   420		if (rq->type != PTP_CLK_REQ_PEROUT || !wx->ptp_setup_sdp)
   421			return -EOPNOTSUPP;
   422	
   423		/* Reject requests with unsupported flags */
   424		if (rq->perout.flags & ~(PTP_PEROUT_DUTY_CYCLE |
   425					 PTP_PEROUT_PHASE))
   426			return -EOPNOTSUPP;
   427	
   428		if (rq->perout.phase.sec || rq->perout.phase.nsec) {
   429			wx_err(wx, "Absolute start time not supported.\n");
   430			return -EINVAL;
   431		}
   432	
   433		if (rq->perout.period.sec != 1 || rq->perout.period.nsec) {
   434			wx_err(wx, "Only 1pps is supported.\n");
   435			return -EINVAL;
   436		}
   437	
   438		if (rq->perout.flags & PTP_PEROUT_DUTY_CYCLE) {
   439			struct timespec64 ts_on;
   440	
   441			ts_on.tv_sec = rq->perout.on.sec;
   442			ts_on.tv_nsec = rq->perout.on.nsec;
   443			wx->pps_width = timespec64_to_ns(&ts_on);
   444		} else {
   445			wx->pps_width = 120000000;
   446		}
   447	
   448		if (on)
   449			set_bit(WX_FLAG_PTP_PPS_ENABLED, wx->flags);
   450		else
   451			clear_bit(WX_FLAG_PTP_PPS_ENABLED, wx->flags);
   452	
   453		return wx->ptp_setup_sdp(wx);
   454	}
   455	

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