drivers/thermal/max77620_thermal.c:48: warning: Function parameter or member 'tz' not described in 'max77620_thermal_read_temp'

From: kernel test robot
Date: Tue Oct 17 2023 - 12:17:48 EST


Hi Daniel,

FYI, the error/warning was bisected to this commit, please ignore it if it's irrelevant.

tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: 213f891525c222e8ed145ce1ce7ae1f47921cb9c
commit: ae11d6a87c3e742418baa591be1e719a95788059 thermal/drivers/maxim: Switch to new of API
date: 1 year, 2 months ago
config: x86_64-randconfig-003-20231014 (https://download.01.org/0day-ci/archive/20231018/202310180055.CFOZ3gLO-lkp@xxxxxxxxx/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/20231018/202310180055.CFOZ3gLO-lkp@xxxxxxxxx/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@xxxxxxxxx>
| Closes: https://lore.kernel.org/oe-kbuild-all/202310180055.CFOZ3gLO-lkp@xxxxxxxxx/

All warnings (new ones prefixed by >>):

>> drivers/thermal/max77620_thermal.c:48: warning: Function parameter or member 'tz' not described in 'max77620_thermal_read_temp'
>> drivers/thermal/max77620_thermal.c:48: warning: Excess function parameter 'data' description in 'max77620_thermal_read_temp'


vim +48 drivers/thermal/max77620_thermal.c

ec4664b3fd6d56 Laxman Dewangan 2016-08-23 32
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 33 /**
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 34 * max77620_thermal_read_temp: Read PMIC die temperatue.
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 35 * @data: Device specific data.
0f43e646dddd60 Amit Kucheria 2019-11-20 36 * @temp: Temperature in millidegrees Celsius
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 37 *
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 38 * The actual temperature of PMIC die is not available from PMIC.
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 39 * PMIC only tells the status if it has crossed or not the threshold level
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 40 * of 120degC or 140degC.
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 41 * If threshold has not been crossed then assume die temperature as 100degC
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 42 * else 120degC or 140deG based on the PMIC die temp threshold status.
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 43 *
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 44 * Return 0 on success otherwise error number to show reason of failure.
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 45 */
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 46
ae11d6a87c3e74 Daniel Lezcano 2022-08-05 47 static int max77620_thermal_read_temp(struct thermal_zone_device *tz, int *temp)
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 @48 {
ae11d6a87c3e74 Daniel Lezcano 2022-08-05 49 struct max77620_therm_info *mtherm = tz->devdata;
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 50 unsigned int val;
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 51 int ret;
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 52
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 53 ret = regmap_read(mtherm->rmap, MAX77620_REG_STATLBT, &val);
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 54 if (ret < 0) {
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 55 dev_err(mtherm->dev, "Failed to read STATLBT: %d\n", ret);
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 56 return ret;
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 57 }
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 58
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 59 if (val & MAX77620_IRQ_TJALRM2_MASK)
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 60 *temp = MAX77620_TJALARM2_TEMP;
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 61 else if (val & MAX77620_IRQ_TJALRM1_MASK)
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 62 *temp = MAX77620_TJALARM1_TEMP;
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 63 else
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 64 *temp = MAX77620_NORMAL_OPERATING_TEMP;
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 65
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 66 return 0;
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 67 }
ec4664b3fd6d56 Laxman Dewangan 2016-08-23 68

:::::: The code at line 48 was first introduced by commit
:::::: ec4664b3fd6d565a79eb562e4339528f74eb1cca thermal: max77620: Add thermal driver for reporting junction temp

:::::: TO: Laxman Dewangan <ldewangan@xxxxxxxxxx>
:::::: CC: Zhang Rui <rui.zhang@xxxxxxxxx>

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