linux-kernel - drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'reg_ops' not described in 'uartlite

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:   Mon, 6 Nov 2023 14:13:17 +0800
From:   kernel test robot <yujie.liu@...el.com>
To:     Sean Anderson <sean.anderson@...o.com>
CC:     <oe-kbuild-all@...ts.linux.dev>, <linux-kernel@...r.kernel.org>
Subject: drivers/tty/serial/uartlite.c:79: warning: Function parameter or
 member 'reg_ops' not described in 'uartlite_data'

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   77fa2fbe87fc605c4bfa87dff87be9bfded0e9a3
commit: ea017f5853e9a6a11cfa9bdc61ba823a1ed54ee8 tty: serial: uartlite: Prevent changing fixed parameters
date:   2 years, 2 months ago
config: i386-randconfig-004-20231101 (https://download.01.org/0day-ci/archive/20231106/202311061059.NUeUar9b-lkp@intel.com/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/20231106/202311061059.NUeUar9b-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 <yujie.liu@...el.com>
| Closes: https://lore.kernel.org/r/202311061059.NUeUar9b-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'reg_ops' not described in 'uartlite_data'
>> drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'clk' not described in 'uartlite_data'
   drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'baud' not described in 'uartlite_data'
   drivers/tty/serial/uartlite.c:79: warning: Function parameter or member 'cflags' not described in 'uartlite_data'


vim +79 drivers/tty/serial/uartlite.c

deeb33e8fdd834 Shubhrajyoti Datta 2018-08-06  66  
ea017f5853e9a6 Sean Anderson      2021-08-26  67  /**
ea017f5853e9a6 Sean Anderson      2021-08-26  68   * struct uartlite_data: Driver private data
ea017f5853e9a6 Sean Anderson      2021-08-26  69   * reg_ops: Functions to read/write registers
ea017f5853e9a6 Sean Anderson      2021-08-26  70   * clk: Our parent clock, if present
ea017f5853e9a6 Sean Anderson      2021-08-26  71   * baud: The baud rate configured when this device was synthesized
ea017f5853e9a6 Sean Anderson      2021-08-26  72   * cflags: The cflags for parity and data bits
ea017f5853e9a6 Sean Anderson      2021-08-26  73   */

"@" is required before each struct member.

da7bf20e775804 Shubhrajyoti Datta 2018-07-21  74  struct uartlite_data {
da7bf20e775804 Shubhrajyoti Datta 2018-07-21  75  	const struct uartlite_reg_ops *reg_ops;
14288befeb572b Shubhrajyoti Datta 2018-07-21  76  	struct clk *clk;
ea017f5853e9a6 Sean Anderson      2021-08-26  77  	unsigned int baud;
ea017f5853e9a6 Sean Anderson      2021-08-26  78  	tcflag_t cflags;
da7bf20e775804 Shubhrajyoti Datta 2018-07-21 @79  };
da7bf20e775804 Shubhrajyoti Datta 2018-07-21  80  

:::::: The code at line 79 was first introduced by commit
:::::: da7bf20e7758042eb3931ff68fc96bdfaf94d881 tty: serial: uartlite: Add structure for private data

:::::: TO: Shubhrajyoti Datta <shubhrajyoti.datta@...inx.com>
:::::: CC: Greg Kroah-Hartman <gregkh@...uxfoundation.org>

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