[jic23-iio:testing 62/78] drivers/iio/adc/ad7380.c:389: warning: Function parameter or struct member 'st' not described in 'ad7380_update_xfers'

[jic23-iio:testing 62/78] drivers/iio/adc/ad7380.c:389: warning: Function parameter or struct member 'st' not described in 'ad7380_update_xfers'

[kernel test robot]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git testing
head:   f63207dfc09b1aec17b264e5ae62a49ceba05f50
commit: a6717bfbc3423a935f0dfd3626fe339488ba57f4 [62/78] iio: adc: ad7380: add oversampling support
config: m68k-allmodconfig (https://download.01.org/0day-ci/archive/20240602/202406022123.UCiKiwtQ-lkp@intel.com/config)
compiler: m68k-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240602/202406022123.UCiKiwtQ-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/202406022123.UCiKiwtQ-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/iio/adc/ad7380.c:389: warning: Function parameter or struct member 'st' not described in 'ad7380_update_xfers'
>> drivers/iio/adc/ad7380.c:389: warning: Function parameter or struct member 'scan_type' not described in 'ad7380_update_xfers'
>> drivers/iio/adc/ad7380.c:389: warning: Excess function parameter 'indio_dev' description in 'ad7380_update_xfers'
>> drivers/iio/adc/ad7380.c:389: warning: Excess function parameter 'chan' description in 'ad7380_update_xfers'


vim +389 drivers/iio/adc/ad7380.c

   381	
   382	/**
   383	 * ad7380_update_xfers - update the SPI transfers base on the current scan type
   384	 * @indio_dev:	IIO device structure
   385	 * @chan:	IIO channel
   386	 */
   387	static void ad7380_update_xfers(struct ad7380_state *st,
   388					const struct iio_scan_type *scan_type)
 > 389	{
   390		/*
   391		 * First xfer only triggers conversion and has to be long enough for
   392		 * all conversions to complete, which can be multiple conversion in the
   393		 * case of oversampling. Technically T_CONVERT_X_NS is lower for some
   394		 * chips, but we use the maximum value for simplicity for now.
   395		 */
   396		if (st->oversampling_ratio > 1)
   397			st->xfer[0].delay.value = T_CONVERT_0_NS + T_CONVERT_X_NS *
   398							(st->oversampling_ratio - 1);
   399		else
   400			st->xfer[0].delay.value = T_CONVERT_NS;
   401	
   402		st->xfer[0].delay.unit = SPI_DELAY_UNIT_NSECS;
   403	
   404		/*
   405		 * Second xfer reads all channels. Data size depends on if resolution
   406		 * boost is enabled or not.
   407		 */
   408		st->xfer[1].bits_per_word = scan_type->realbits;
   409		st->xfer[1].len = BITS_TO_BYTES(scan_type->storagebits) *
   410				  (st->chip_info->num_channels - 1);
   411	}
   412	

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

Re: [jic23-iio:testing 62/78] drivers/iio/adc/ad7380.c:389: warning: Function parameter or struct member 'st' not described in 'ad7380_update_xfers'

[Jonathan Cameron]

On Sun, 2 Jun 2024 21:09:56 +0800
kernel test robot <lkp@intel.com> wrote:

> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git testing
> head:   f63207dfc09b1aec17b264e5ae62a49ceba05f50
> commit: a6717bfbc3423a935f0dfd3626fe339488ba57f4 [62/78] iio: adc: ad7380: add oversampling support
> config: m68k-allmodconfig (https://download.01.org/0day-ci/archive/20240602/202406022123.UCiKiwtQ-lkp@intel.com/config)
> compiler: m68k-linux-gcc (GCC) 13.2.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240602/202406022123.UCiKiwtQ-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/202406022123.UCiKiwtQ-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
> >> drivers/iio/adc/ad7380.c:389: warning: Function parameter or struct member 'st' not described in 'ad7380_update_xfers'
> >> drivers/iio/adc/ad7380.c:389: warning: Function parameter or struct member 'scan_type' not described in 'ad7380_update_xfers'
> >> drivers/iio/adc/ad7380.c:389: warning: Excess function parameter 'indio_dev' description in 'ad7380_update_xfers'
> >> drivers/iio/adc/ad7380.c:389: warning: Excess function parameter 'chan' description in 'ad7380_update_xfers'  
> 
Hmm. Too much going on yesterday so I guess I missed the warning in local builds.

Anyhow, 0-day to the rescue :)  I'll fix up once I'm on the right machine (probably this evening)

Jonathan

> 
> vim +389 drivers/iio/adc/ad7380.c
> 
>    381	
>    382	/**
>    383	 * ad7380_update_xfers - update the SPI transfers base on the current scan type
>    384	 * @indio_dev:	IIO device structure
>    385	 * @chan:	IIO channel
>    386	 */
>    387	static void ad7380_update_xfers(struct ad7380_state *st,
>    388					const struct iio_scan_type *scan_type)
>  > 389	{  
>    390		/*
>    391		 * First xfer only triggers conversion and has to be long enough for
>    392		 * all conversions to complete, which can be multiple conversion in the
>    393		 * case of oversampling. Technically T_CONVERT_X_NS is lower for some
>    394		 * chips, but we use the maximum value for simplicity for now.
>    395		 */
>    396		if (st->oversampling_ratio > 1)
>    397			st->xfer[0].delay.value = T_CONVERT_0_NS + T_CONVERT_X_NS *
>    398							(st->oversampling_ratio - 1);
>    399		else
>    400			st->xfer[0].delay.value = T_CONVERT_NS;
>    401	
>    402		st->xfer[0].delay.unit = SPI_DELAY_UNIT_NSECS;
>    403	
>    404		/*
>    405		 * Second xfer reads all channels. Data size depends on if resolution
>    406		 * boost is enabled or not.
>    407		 */
>    408		st->xfer[1].bits_per_word = scan_type->realbits;
>    409		st->xfer[1].len = BITS_TO_BYTES(scan_type->storagebits) *
>    410				  (st->chip_info->num_channels - 1);
>    411	}
>    412	
>