Re: drivers/pinctrl/pinctrl-at91-pio4.c:136: warning: Function parameter or member 'pm_suspend_backup.imr' not described in 'atmel_pioctrl'

From: Philip Li
Date: Thu Sep 12 2024 - 09:20:49 EST

On Thu, Sep 12, 2024 at 09:05:49PM +0800, kernel test robot wrote:
> Hi Matthew,
>
> FYI, the error/warning still remains.

Sorry, kindly ignore this report, the commit is not the root cause
of issue.

>
> tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> head: 77f587896757708780a7e8792efe62939f25a5ab
> commit: 3a025e1d1c2ea42fa497c9c6b21c284e0f69e28b Add optional check for bad kernel-doc comments
> date: 7 years ago
> config: arm-randconfig-002-20240912 (https://download.01.org/0day-ci/archive/20240912/202409122134.crk22zBA-lkp@xxxxxxxxx/config)
> compiler: arm-linux-gnueabi-gcc (GCC) 14.1.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240912/202409122134.crk22zBA-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/202409122134.crk22zBA-lkp@xxxxxxxxx/
>
> All warnings (new ones prefixed by >>):
>
> drivers/pinctrl/pinctrl-at91-pio4.c:136: warning: Function parameter or member 'pm_wakeup_sources' not described in 'atmel_pioctrl'
> drivers/pinctrl/pinctrl-at91-pio4.c:136: warning: Function parameter or member 'pm_suspend_backup' not described in 'atmel_pioctrl'
> >> drivers/pinctrl/pinctrl-at91-pio4.c:136: warning: Function parameter or member 'pm_suspend_backup.imr' not described in 'atmel_pioctrl'
> >> drivers/pinctrl/pinctrl-at91-pio4.c:136: warning: Function parameter or member 'pm_suspend_backup.odsr' not described in 'atmel_pioctrl'
> >> drivers/pinctrl/pinctrl-at91-pio4.c:136: warning: Function parameter or member 'pm_suspend_backup.cfgr' not described in 'atmel_pioctrl'
>
>
> vim +136 drivers/pinctrl/pinctrl-at91-pio4.c
>
> 776180848b574c Ludovic Desroches 2015-09-16 95
> 776180848b574c Ludovic Desroches 2015-09-16 96 /**
> 776180848b574c Ludovic Desroches 2015-09-16 97 * struct atmel_pioctrl - Atmel PIO controller (pinmux + gpio)
> 776180848b574c Ludovic Desroches 2015-09-16 98 * @reg_base: base address of the controller.
> 776180848b574c Ludovic Desroches 2015-09-16 99 * @clk: clock of the controller.
> 776180848b574c Ludovic Desroches 2015-09-16 100 * @nbanks: number of PIO groups, it can vary depending on the SoC.
> 776180848b574c Ludovic Desroches 2015-09-16 101 * @pinctrl_dev: pinctrl device registered.
> 776180848b574c Ludovic Desroches 2015-09-16 102 * @groups: groups table to provide group name and pin in the group to pinctrl.
> 776180848b574c Ludovic Desroches 2015-09-16 103 * @group_names: group names table to provide all the group/pin names to
> 776180848b574c Ludovic Desroches 2015-09-16 104 * pinctrl or gpio.
> 776180848b574c Ludovic Desroches 2015-09-16 105 * @pins: pins table used for both pinctrl and gpio. pin_id, bank and line
> 776180848b574c Ludovic Desroches 2015-09-16 106 * fields are set at probe time. Other ones are set when parsing dt
> 776180848b574c Ludovic Desroches 2015-09-16 107 * pinctrl.
> 776180848b574c Ludovic Desroches 2015-09-16 108 * @npins: number of pins.
> 776180848b574c Ludovic Desroches 2015-09-16 109 * @gpio_chip: gpio chip registered.
> 776180848b574c Ludovic Desroches 2015-09-16 110 * @irq_domain: irq domain for the gpio controller.
> 776180848b574c Ludovic Desroches 2015-09-16 111 * @irqs: table containing the hw irq number of the bank. The index of the
> 776180848b574c Ludovic Desroches 2015-09-16 112 * table is the bank id.
> 776180848b574c Ludovic Desroches 2015-09-16 113 * @dev: device entry for the Atmel PIO controller.
> 776180848b574c Ludovic Desroches 2015-09-16 114 * @node: node of the Atmel PIO controller.
> 776180848b574c Ludovic Desroches 2015-09-16 115 */
> 776180848b574c Ludovic Desroches 2015-09-16 116 struct atmel_pioctrl {
> 776180848b574c Ludovic Desroches 2015-09-16 117 void __iomem *reg_base;
> 776180848b574c Ludovic Desroches 2015-09-16 118 struct clk *clk;
> 776180848b574c Ludovic Desroches 2015-09-16 119 unsigned nbanks;
> 776180848b574c Ludovic Desroches 2015-09-16 120 struct pinctrl_dev *pinctrl_dev;
> 776180848b574c Ludovic Desroches 2015-09-16 121 struct atmel_group *groups;
> 776180848b574c Ludovic Desroches 2015-09-16 122 const char * const *group_names;
> 776180848b574c Ludovic Desroches 2015-09-16 123 struct atmel_pin **pins;
> 776180848b574c Ludovic Desroches 2015-09-16 124 unsigned npins;
> 776180848b574c Ludovic Desroches 2015-09-16 125 struct gpio_chip *gpio_chip;
> 776180848b574c Ludovic Desroches 2015-09-16 126 struct irq_domain *irq_domain;
> 776180848b574c Ludovic Desroches 2015-09-16 127 int *irqs;
> de4e882f3fbef5 Ludovic Desroches 2015-09-25 128 unsigned *pm_wakeup_sources;
> ba9e7f2794d815 Alexandre Belloni 2017-04-06 129 struct {
> ba9e7f2794d815 Alexandre Belloni 2017-04-06 130 u32 imr;
> ba9e7f2794d815 Alexandre Belloni 2017-04-06 131 u32 odsr;
> ba9e7f2794d815 Alexandre Belloni 2017-04-06 132 u32 cfgr[ATMEL_PIO_NPINS_PER_BANK];
> ba9e7f2794d815 Alexandre Belloni 2017-04-06 133 } *pm_suspend_backup;
> 776180848b574c Ludovic Desroches 2015-09-16 134 struct device *dev;
> 776180848b574c Ludovic Desroches 2015-09-16 135 struct device_node *node;
> 776180848b574c Ludovic Desroches 2015-09-16 @136 };
> 776180848b574c Ludovic Desroches 2015-09-16 137
>
> :::::: The code at line 136 was first introduced by commit
> :::::: 776180848b574c9c01217fa958f10843ffce584f pinctrl: introduce driver for Atmel PIO4 controller
>
> :::::: TO: Ludovic Desroches <ludovic.desroches@xxxxxxxxx>
> :::::: CC: Linus Walleij <linus.walleij@xxxxxxxxxx>
>
> --
> 0-DAY CI Kernel Test Service
> https://github.com/intel/lkp-tests/wiki
>