arch/mips/sgi-ip27/ip27-hubio.c:30: warning: Function parameter or member 'nasid' not described in 'hub_pio_map'

From: kernel test robot
Date: Sun Dec 10 2023 - 09:39:43 EST


Hi Thomas,

FYI, the error/warning still remains.

tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: c527f5606aa545233a4d2c6d5c636ed82b8633ef
commit: 4bf841ebf17aaa0f7712623896c699b44fa92f44 MIPS: SGI-IP27: get rid of compact node ids
date: 4 years, 2 months ago
config: mips-randconfig-r035-20210927 (https://download.01.org/0day-ci/archive/20231210/202312102220.S53XPqT0-lkp@xxxxxxxxx/config)
compiler: mips64-linux-gcc (GCC) 12.3.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231210/202312102220.S53XPqT0-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/202312102220.S53XPqT0-lkp@xxxxxxxxx/

All warnings (new ones prefixed by >>):

>> arch/mips/sgi-ip27/ip27-hubio.c:30: warning: Function parameter or member 'nasid' not described in 'hub_pio_map'
arch/mips/sgi-ip27/ip27-hubio.c:30: warning: Excess function parameter 'hub' description in 'hub_pio_map'


vim +30 arch/mips/sgi-ip27/ip27-hubio.c

^1da177e4c3f41 Linus Torvalds 2005-04-16 18
^1da177e4c3f41 Linus Torvalds 2005-04-16 19 /**
^1da177e4c3f41 Linus Torvalds 2005-04-16 20 * hub_pio_map - establish a HUB PIO mapping
^1da177e4c3f41 Linus Torvalds 2005-04-16 21 *
^1da177e4c3f41 Linus Torvalds 2005-04-16 22 * @hub: hub to perform PIO mapping on
^1da177e4c3f41 Linus Torvalds 2005-04-16 23 * @widget: widget ID to perform PIO mapping for
^1da177e4c3f41 Linus Torvalds 2005-04-16 24 * @xtalk_addr: xtalk_address that needs to be mapped
^1da177e4c3f41 Linus Torvalds 2005-04-16 25 * @size: size of the PIO mapping
^1da177e4c3f41 Linus Torvalds 2005-04-16 26 *
^1da177e4c3f41 Linus Torvalds 2005-04-16 27 **/
4bf841ebf17aaa Thomas Bogendoerfer 2019-10-03 28 unsigned long hub_pio_map(nasid_t nasid, xwidgetnum_t widget,
^1da177e4c3f41 Linus Torvalds 2005-04-16 29 unsigned long xtalk_addr, size_t size)
^1da177e4c3f41 Linus Torvalds 2005-04-16 @30 {
^1da177e4c3f41 Linus Torvalds 2005-04-16 31 unsigned i;
^1da177e4c3f41 Linus Torvalds 2005-04-16 32
^1da177e4c3f41 Linus Torvalds 2005-04-16 33 /* use small-window mapping if possible */
^1da177e4c3f41 Linus Torvalds 2005-04-16 34 if ((xtalk_addr % SWIN_SIZE) + size <= SWIN_SIZE)
^1da177e4c3f41 Linus Torvalds 2005-04-16 35 return NODE_SWIN_BASE(nasid, widget) + (xtalk_addr % SWIN_SIZE);
^1da177e4c3f41 Linus Torvalds 2005-04-16 36
^1da177e4c3f41 Linus Torvalds 2005-04-16 37 if ((xtalk_addr % BWIN_SIZE) + size > BWIN_SIZE) {
^1da177e4c3f41 Linus Torvalds 2005-04-16 38 printk(KERN_WARNING "PIO mapping at hub %d widget %d addr 0x%lx"
^1da177e4c3f41 Linus Torvalds 2005-04-16 39 " too big (%ld)\n",
^1da177e4c3f41 Linus Torvalds 2005-04-16 40 nasid, widget, xtalk_addr, size);
^1da177e4c3f41 Linus Torvalds 2005-04-16 41 return 0;
^1da177e4c3f41 Linus Torvalds 2005-04-16 42 }
^1da177e4c3f41 Linus Torvalds 2005-04-16 43
^1da177e4c3f41 Linus Torvalds 2005-04-16 44 xtalk_addr &= ~(BWIN_SIZE-1);
^1da177e4c3f41 Linus Torvalds 2005-04-16 45 for (i = 0; i < HUB_NUM_BIG_WINDOW; i++) {
4bf841ebf17aaa Thomas Bogendoerfer 2019-10-03 46 if (test_and_set_bit(i, hub_data(nasid)->h_bigwin_used))
^1da177e4c3f41 Linus Torvalds 2005-04-16 47 continue;
^1da177e4c3f41 Linus Torvalds 2005-04-16 48
^1da177e4c3f41 Linus Torvalds 2005-04-16 49 /*
^1da177e4c3f41 Linus Torvalds 2005-04-16 50 * The code below does a PIO write to setup an ITTE entry.
^1da177e4c3f41 Linus Torvalds 2005-04-16 51 *
^1da177e4c3f41 Linus Torvalds 2005-04-16 52 * We need to prevent other CPUs from seeing our updated
^1da177e4c3f41 Linus Torvalds 2005-04-16 53 * memory shadow of the ITTE (in the piomap) until the ITTE
^1da177e4c3f41 Linus Torvalds 2005-04-16 54 * entry is actually set up; otherwise, another CPU might
^1da177e4c3f41 Linus Torvalds 2005-04-16 55 * attempt a PIO prematurely.
^1da177e4c3f41 Linus Torvalds 2005-04-16 56 *
^1da177e4c3f41 Linus Torvalds 2005-04-16 57 * Also, the only way we can know that an entry has been
^1da177e4c3f41 Linus Torvalds 2005-04-16 58 * received by the hub and can be used by future PIO reads/
^1da177e4c3f41 Linus Torvalds 2005-04-16 59 * writes is by reading back the ITTE entry after writing it.
^1da177e4c3f41 Linus Torvalds 2005-04-16 60 *
^1da177e4c3f41 Linus Torvalds 2005-04-16 61 * For these two reasons, we PIO read back the ITTE entry
^1da177e4c3f41 Linus Torvalds 2005-04-16 62 * after we write it.
^1da177e4c3f41 Linus Torvalds 2005-04-16 63 */
^1da177e4c3f41 Linus Torvalds 2005-04-16 64 IIO_ITTE_PUT(nasid, i, HUB_PIO_MAP_TO_MEM, widget, xtalk_addr);
db0e7d4e42b055 Thomas Bogendoerfer 2019-02-19 65 __raw_readq(IIO_ITTE_GET(nasid, i));
^1da177e4c3f41 Linus Torvalds 2005-04-16 66
^1da177e4c3f41 Linus Torvalds 2005-04-16 67 return NODE_BWIN_BASE(nasid, widget) + (xtalk_addr % BWIN_SIZE);
^1da177e4c3f41 Linus Torvalds 2005-04-16 68 }
^1da177e4c3f41 Linus Torvalds 2005-04-16 69
^1da177e4c3f41 Linus Torvalds 2005-04-16 70 printk(KERN_WARNING "unable to establish PIO mapping for at"
^1da177e4c3f41 Linus Torvalds 2005-04-16 71 " hub %d widget %d addr 0x%lx\n",
^1da177e4c3f41 Linus Torvalds 2005-04-16 72 nasid, widget, xtalk_addr);
^1da177e4c3f41 Linus Torvalds 2005-04-16 73 return 0;
^1da177e4c3f41 Linus Torvalds 2005-04-16 74 }
^1da177e4c3f41 Linus Torvalds 2005-04-16 75

:::::: The code at line 30 was first introduced by commit
:::::: 1da177e4c3f41524e886b7f1b8a0c1fc7321cac2 Linux-2.6.12-rc2

:::::: TO: Linus Torvalds <torvalds@xxxxxxxxxxxxxxx>
:::::: CC: Linus Torvalds <torvalds@xxxxxxxxxxxxxxx>

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