drivers/gpio/gpio-pca9570.c:42: warning: Function parameter or member 'chip_data' not described in 'pca9570'

drivers/gpio/gpio-pca9570.c:42: warning: Function parameter or member 'chip_data' not described in 'pca9570'

[kernel test robot]

Hi Bartosz,

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:   4853c74bd7ab7fdb83f319bd9ace8a08c031e9b6
commit: a3f7c1d6ddcbd487964c58ff246506a781e5be8f gpio: pca9570: rename platform_data to chip_data
date:   7 months ago
config: i386-randconfig-i015-20230817 (https://download.01.org/0day-ci/archive/20230817/202308171538.nKKUOtbg-lkp@intel.com/config)
compiler: gcc-7 (Ubuntu 7.5.0-6ubuntu2) 7.5.0
reproduce: (https://download.01.org/0day-ci/archive/20230817/202308171538.nKKUOtbg-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/202308171538.nKKUOtbg-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/gpio/gpio-pca9570.c:42: warning: Function parameter or member 'chip_data' not described in 'pca9570'


vim +42 drivers/gpio/gpio-pca9570.c

b8a34582c7f7f2 Shubhrajyoti Datta  2022-10-26  29  
16d44b6085c1d9 Sungbo Eo           2020-07-09  30  /**
16d44b6085c1d9 Sungbo Eo           2020-07-09  31   * struct pca9570 - GPIO driver data
16d44b6085c1d9 Sungbo Eo           2020-07-09  32   * @chip: GPIO controller chip
b8a34582c7f7f2 Shubhrajyoti Datta  2022-10-26  33   * @p_data: GPIO controller platform data
16d44b6085c1d9 Sungbo Eo           2020-07-09  34   * @lock: Protects write sequences
16d44b6085c1d9 Sungbo Eo           2020-07-09  35   * @out: Buffer for device register
16d44b6085c1d9 Sungbo Eo           2020-07-09  36   */
16d44b6085c1d9 Sungbo Eo           2020-07-09  37  struct pca9570 {
16d44b6085c1d9 Sungbo Eo           2020-07-09  38  	struct gpio_chip chip;
a3f7c1d6ddcbd4 Bartosz Golaszewski 2022-12-30  39  	const struct pca9570_chip_data *chip_data;
16d44b6085c1d9 Sungbo Eo           2020-07-09  40  	struct mutex lock;
16d44b6085c1d9 Sungbo Eo           2020-07-09  41  	u8 out;
16d44b6085c1d9 Sungbo Eo           2020-07-09 @42  };
16d44b6085c1d9 Sungbo Eo           2020-07-09  43  

:::::: The code at line 42 was first introduced by commit
:::::: 16d44b6085c1d90884b264deb938a34ab85a9c6d gpio: pca9570: add GPO driver for PCA9570

:::::: TO: Sungbo Eo <mans0n@gorani.run>
:::::: CC: Linus Walleij <linus.walleij@linaro.org>

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

Re: drivers/gpio/gpio-pca9570.c:42: warning: Function parameter or member 'chip_data' not described in 'pca9570'

[Andy Shevchenko]

On Thu, Aug 17, 2023 at 03:11:09PM +0800, kernel test robot wrote:
> Hi Bartosz,

...

> >> drivers/gpio/gpio-pca9570.c:42: warning: Function parameter or member 'chip_data' not described in 'pca9570'

Blame Bart for this :-)

> b8a34582c7f7f2 Shubhrajyoti Datta  2022-10-26  29  
> 16d44b6085c1d9 Sungbo Eo           2020-07-09  30  /**
> 16d44b6085c1d9 Sungbo Eo           2020-07-09  31   * struct pca9570 - GPIO driver data
> 16d44b6085c1d9 Sungbo Eo           2020-07-09  32   * @chip: GPIO controller chip
> b8a34582c7f7f2 Shubhrajyoti Datta  2022-10-26  33   * @p_data: GPIO controller platform data


So, should be @chip_data...

> 16d44b6085c1d9 Sungbo Eo           2020-07-09  34   * @lock: Protects write sequences
> 16d44b6085c1d9 Sungbo Eo           2020-07-09  35   * @out: Buffer for device register
> 16d44b6085c1d9 Sungbo Eo           2020-07-09  36   */
> 16d44b6085c1d9 Sungbo Eo           2020-07-09  37  struct pca9570 {
> 16d44b6085c1d9 Sungbo Eo           2020-07-09  38  	struct gpio_chip chip;
> a3f7c1d6ddcbd4 Bartosz Golaszewski 2022-12-30  39  	const struct pca9570_chip_data *chip_data;
> 16d44b6085c1d9 Sungbo Eo           2020-07-09  40  	struct mutex lock;
> 16d44b6085c1d9 Sungbo Eo           2020-07-09  41  	u8 out;
> 16d44b6085c1d9 Sungbo Eo           2020-07-09 @42  };

-- 
With Best Regards,
Andy Shevchenko