[daniel-lezcano:timers/drivers/next 4/9] drivers/platform/x86/intel/pmc/core.c:1213: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

[kernel test robot <lkp@intel.com>]

tree:   http://git.linaro.org/people/daniel.lezcano/linux timers/drivers/next
head:   8f8b0349aa312eb7e67e623ed1f296a04126fe7f
commit: 2d167560d43c809c66e6389b6cc651b77fcbf951 [4/9] platform/x86:intel/pmc: Enable the ACPI PM Timer to be turned off when suspended
config: i386-allmodconfig (https://download.01.org/0day-ci/archive/20240903/202409031410.a9beukFc-lkp@intel.com/config)
compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240903/202409031410.a9beukFc-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@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202409031410.a9beukFc-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/platform/x86/intel/pmc/core.c:1213: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Enable or disable ACPI PM Timer


vim +1213 drivers/platform/x86/intel/pmc/core.c

  1211	
  1212	/**
> 1213	 * Enable or disable ACPI PM Timer
  1214	 *
  1215	 * This function is intended to be a callback for ACPI PM suspend/resume event.
  1216	 * The ACPI PM Timer is enabled on resume only if it was enabled during suspend.
  1217	 */
  1218	static void pmc_core_acpi_pm_timer_suspend_resume(void *data, bool suspend)
  1219	{
  1220		struct pmc_dev *pmcdev = data;
  1221		struct pmc *pmc = pmcdev->pmcs[PMC_IDX_MAIN];
  1222		const struct pmc_reg_map *map = pmc->map;
  1223		bool enabled;
  1224		u32 reg;
  1225	
  1226		if (!map->acpi_pm_tmr_ctl_offset)
  1227			return;
  1228	
  1229		guard(mutex)(&pmcdev->lock);
  1230	
  1231		if (!suspend && !pmcdev->enable_acpi_pm_timer_on_resume)
  1232			return;
  1233	
  1234		reg = pmc_core_reg_read(pmc, map->acpi_pm_tmr_ctl_offset);
  1235		enabled = !(reg & map->acpi_pm_tmr_disable_bit);
  1236		if (suspend)
  1237			reg |= map->acpi_pm_tmr_disable_bit;
  1238		else
  1239			reg &= ~map->acpi_pm_tmr_disable_bit;
  1240		pmc_core_reg_write(pmc, map->acpi_pm_tmr_ctl_offset, reg);
  1241	
  1242		pmcdev->enable_acpi_pm_timer_on_resume = suspend && enabled;
  1243	}
  1244	

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