drivers/iommu/fsl_pamu.c:586: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

From: kernel test robot
Date: Mon Feb 27 2023 - 22:37:25 EST


Hi Aditya,

FYI, the error/warning still remains.

tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: ae3419fbac845b4d3f3a9fae4cc80c68d82cdf6e
commit: 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf scripts: kernel-doc: add warning for comment not following kernel-doc syntax
date: 1 year, 11 months ago
config: powerpc-randconfig-r002-20230227 (https://download.01.org/0day-ci/archive/20230228/202302281151.B1WtZvSC-lkp@xxxxxxxxx/config)
compiler: clang version 17.0.0 (https://github.com/llvm/llvm-project db89896bbbd2251fff457699635acbbedeead27f)
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
# install powerpc cross compiling tool for clang build
# apt-get install binutils-powerpc-linux-gnu
# 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 config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=powerpc olddefconfig
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=powerpc SHELL=/bin/bash drivers/iommu/

If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@xxxxxxxxx>
| Link: https://lore.kernel.org/oe-kbuild-all/202302281151.B1WtZvSC-lkp@xxxxxxxxx/

All warnings (new ones prefixed by >>):

drivers/iommu/fsl_pamu.c:325: warning: Function parameter or member 'win_size' not described in 'pamu_config_ppaace'
drivers/iommu/fsl_pamu.c:325: warning: expecting prototype for pamu_config_paace(). Prototype was for pamu_config_ppaace() instead
drivers/iommu/fsl_pamu.c:493: warning: Function parameter or member 'omi_index' not described in 'get_ome_index'
drivers/iommu/fsl_pamu.c:493: warning: Function parameter or member 'dev' not described in 'get_ome_index'
>> drivers/iommu/fsl_pamu.c:586: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Setup operation mapping and stash destinations for QMAN and QMAN portal.
drivers/iommu/fsl_pamu.c:615: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Setup the operation mapping table for various devices. This is a static


vim +586 drivers/iommu/fsl_pamu.c

695093e38c3ef6 Varun Sethi 2013-07-15 584
695093e38c3ef6 Varun Sethi 2013-07-15 585 /**
695093e38c3ef6 Varun Sethi 2013-07-15 @586 * Setup operation mapping and stash destinations for QMAN and QMAN portal.
695093e38c3ef6 Varun Sethi 2013-07-15 587 * Memory accesses to QMAN and BMAN private memory need not be coherent, so
695093e38c3ef6 Varun Sethi 2013-07-15 588 * clear the PAACE entry coherency attribute for them.
695093e38c3ef6 Varun Sethi 2013-07-15 589 */
57fb907da89977 Emil Medve 2015-03-25 590 static void setup_qbman_paace(struct paace *ppaace, int paace_type)
695093e38c3ef6 Varun Sethi 2013-07-15 591 {
695093e38c3ef6 Varun Sethi 2013-07-15 592 switch (paace_type) {
695093e38c3ef6 Varun Sethi 2013-07-15 593 case QMAN_PAACE:
695093e38c3ef6 Varun Sethi 2013-07-15 594 set_bf(ppaace->impl_attr, PAACE_IA_OTM, PAACE_OTM_INDEXED);
695093e38c3ef6 Varun Sethi 2013-07-15 595 ppaace->op_encode.index_ot.omi = OMI_QMAN_PRIV;
695093e38c3ef6 Varun Sethi 2013-07-15 596 /* setup QMAN Private data stashing for the L3 cache */
695093e38c3ef6 Varun Sethi 2013-07-15 597 set_bf(ppaace->impl_attr, PAACE_IA_CID, get_stash_id(PAMU_ATTR_CACHE_L3, 0));
695093e38c3ef6 Varun Sethi 2013-07-15 598 set_bf(ppaace->domain_attr.to_host.coherency_required, PAACE_DA_HOST_CR,
695093e38c3ef6 Varun Sethi 2013-07-15 599 0);
695093e38c3ef6 Varun Sethi 2013-07-15 600 break;
695093e38c3ef6 Varun Sethi 2013-07-15 601 case QMAN_PORTAL_PAACE:
695093e38c3ef6 Varun Sethi 2013-07-15 602 set_bf(ppaace->impl_attr, PAACE_IA_OTM, PAACE_OTM_INDEXED);
695093e38c3ef6 Varun Sethi 2013-07-15 603 ppaace->op_encode.index_ot.omi = OMI_QMAN;
695093e38c3ef6 Varun Sethi 2013-07-15 604 /* Set DQRR and Frame stashing for the L3 cache */
695093e38c3ef6 Varun Sethi 2013-07-15 605 set_bf(ppaace->impl_attr, PAACE_IA_CID, get_stash_id(PAMU_ATTR_CACHE_L3, 0));
695093e38c3ef6 Varun Sethi 2013-07-15 606 break;
695093e38c3ef6 Varun Sethi 2013-07-15 607 case BMAN_PAACE:
695093e38c3ef6 Varun Sethi 2013-07-15 608 set_bf(ppaace->domain_attr.to_host.coherency_required, PAACE_DA_HOST_CR,
695093e38c3ef6 Varun Sethi 2013-07-15 609 0);
695093e38c3ef6 Varun Sethi 2013-07-15 610 break;
695093e38c3ef6 Varun Sethi 2013-07-15 611 }
695093e38c3ef6 Varun Sethi 2013-07-15 612 }
695093e38c3ef6 Varun Sethi 2013-07-15 613

:::::: The code at line 586 was first introduced by commit
:::::: 695093e38c3ef63fcb43a2840ed865efa20671d5 iommu/fsl: Freescale PAMU driver and iommu implementation.

:::::: TO: Varun Sethi <Varun.Sethi@xxxxxxxxxxxxx>
:::::: CC: Joerg Roedel <joro@xxxxxxxxxx>

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