drivers/pinctrl/aspeed/pinmux-aspeed.c:61: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

drivers/pinctrl/aspeed/pinmux-aspeed.c:61: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

[kernel test robot]

[-- Attachment #1: Type: text/plain, Size: 6191 bytes --]

Hi Aditya,

FYI, the error/warning still remains.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   6efb943b8616ec53a5e444193dccf1af9ad627b5
commit: 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf scripts: kernel-doc: add warning for comment not following kernel-doc syntax
date:   6 weeks ago
config: arm-randconfig-r021-20210510 (attached as .config)
compiler: arm-linux-gnueabi-gcc (GCC) 9.3.0
reproduce (this is a W=1 build):
        wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
        chmod +x ~/bin/make.cross
        # https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf
        git remote add linus https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
        git fetch --no-tags linus master
        git checkout 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf
        # save the attached .config to linux build tree
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross W=1 ARCH=arm 

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@intel.com>

All warnings (new ones prefixed by >>):

   drivers/pinctrl/aspeed/pinmux-aspeed.c:42: warning: expecting prototype for Query the enabled or disabled state of a signal descriptor(). Prototype was for aspeed_sig_desc_eval() instead
>> drivers/pinctrl/aspeed/pinmux-aspeed.c:61: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Query the enabled or disabled state for a mux function's signal on a pin
--
>> drivers/pinctrl/aspeed/pinctrl-aspeed.c:111: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Disable a signal on a pin by disabling all provided signal expressions.
   drivers/pinctrl/aspeed/pinctrl-aspeed.c:135: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Search for the signal expression needed to enable the pin's signal for the
--
>> drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c:2700: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Configure a pin's signal by applying an expression's descriptor state for
--
>> drivers/pinctrl/aspeed/pinctrl-aspeed-g6.c:2614: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Configure a pin's signal by applying an expression's descriptor state for


vim +61 drivers/pinctrl/aspeed/pinmux-aspeed.c

efa5623981b72f Andrew Jeffery 2019-06-28  22  
efa5623981b72f Andrew Jeffery 2019-06-28  23  /**
efa5623981b72f Andrew Jeffery 2019-06-28  24   * Query the enabled or disabled state of a signal descriptor
efa5623981b72f Andrew Jeffery 2019-06-28  25   *
efa5623981b72f Andrew Jeffery 2019-06-28  26   * @desc: The signal descriptor of interest
efa5623981b72f Andrew Jeffery 2019-06-28  27   * @enabled: True to query the enabled state, false to query disabled state
efa5623981b72f Andrew Jeffery 2019-06-28  28   * @map: The IP block's regmap instance
efa5623981b72f Andrew Jeffery 2019-06-28  29   *
efa5623981b72f Andrew Jeffery 2019-06-28  30   * Return: 1 if the descriptor's bitfield is configured to the state
efa5623981b72f Andrew Jeffery 2019-06-28  31   * selected by @enabled, 0 if not, and less than zero if an unrecoverable
efa5623981b72f Andrew Jeffery 2019-06-28  32   * failure occurred
efa5623981b72f Andrew Jeffery 2019-06-28  33   *
efa5623981b72f Andrew Jeffery 2019-06-28  34   * Evaluation of descriptor state is non-trivial in that it is not a binary
efa5623981b72f Andrew Jeffery 2019-06-28  35   * outcome: The bitfields can be greater than one bit in size and thus can take
efa5623981b72f Andrew Jeffery 2019-06-28  36   * a value that is neither the enabled nor disabled state recorded in the
efa5623981b72f Andrew Jeffery 2019-06-28  37   * descriptor (typically this means a different function to the one of interest
efa5623981b72f Andrew Jeffery 2019-06-28  38   * is enabled). Thus we must explicitly test for either condition as required.
efa5623981b72f Andrew Jeffery 2019-06-28  39   */
efa5623981b72f Andrew Jeffery 2019-06-28  40  int aspeed_sig_desc_eval(const struct aspeed_sig_desc *desc,
efa5623981b72f Andrew Jeffery 2019-06-28  41  			 bool enabled, struct regmap *map)
efa5623981b72f Andrew Jeffery 2019-06-28 @42  {
efa5623981b72f Andrew Jeffery 2019-06-28  43  	int ret;
efa5623981b72f Andrew Jeffery 2019-06-28  44  	unsigned int raw;
efa5623981b72f Andrew Jeffery 2019-06-28  45  	u32 want;
efa5623981b72f Andrew Jeffery 2019-06-28  46  
efa5623981b72f Andrew Jeffery 2019-06-28  47  	if (!map)
efa5623981b72f Andrew Jeffery 2019-06-28  48  		return -ENODEV;
efa5623981b72f Andrew Jeffery 2019-06-28  49  
efa5623981b72f Andrew Jeffery 2019-06-28  50  	ret = regmap_read(map, desc->reg, &raw);
efa5623981b72f Andrew Jeffery 2019-06-28  51  	if (ret)
efa5623981b72f Andrew Jeffery 2019-06-28  52  		return ret;
efa5623981b72f Andrew Jeffery 2019-06-28  53  
efa5623981b72f Andrew Jeffery 2019-06-28  54  	aspeed_sig_desc_print_val(desc, enabled, raw);
efa5623981b72f Andrew Jeffery 2019-06-28  55  	want = enabled ? desc->enable : desc->disable;
efa5623981b72f Andrew Jeffery 2019-06-28  56  
efa5623981b72f Andrew Jeffery 2019-06-28  57  	return ((raw & desc->mask) >> __ffs(desc->mask)) == want;
efa5623981b72f Andrew Jeffery 2019-06-28  58  }
efa5623981b72f Andrew Jeffery 2019-06-28  59  
efa5623981b72f Andrew Jeffery 2019-06-28  60  /**
efa5623981b72f Andrew Jeffery 2019-06-28 @61   * Query the enabled or disabled state for a mux function's signal on a pin

:::::: The code at line 61 was first introduced by commit
:::::: efa5623981b72f6b5f95933d1c36ed2518c2ee4e pinctrl: aspeed: Split out pinmux from general pinctrl

:::::: TO: Andrew Jeffery <andrew@aj.id.au>
:::::: CC: Linus Walleij <linus.walleij@linaro.org>

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org

[-- Attachment #2: .config.gz --]
[-- Type: application/gzip, Size: 45806 bytes --]