arch/mips/netlogic/xlr/fmn-config.c:106: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

From: kernel test robot
Date: Sun Jun 27 2021 - 07:37:36 EST

Hi Aditya,

FYI, the error/warning still remains.

tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: 625acffd7ae2c52898d249e6c5c39f348db0d8df
commit: 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf scripts: kernel-doc: add warning for comment not following kernel-doc syntax
date: 3 months ago
config: mips-randconfig-r021-20210627 (attached as .config)
compiler: mips64-linux-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 ARCH=mips

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

All warnings (new ones prefixed by >>):

>> arch/mips/netlogic/xlr/fmn-config.c:106: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Configure bucket size and credits for a device. 'size' is the size of
arch/mips/netlogic/xlr/fmn-config.c:181: warning: expecting prototype for Setup the FMN details for each devices according to the device available(). Prototype was for xlr_board_info_setup() instead


vim +106 arch/mips/netlogic/xlr/fmn-config.c

ed21cfe207276e Ganesan Ramalingam 2012-10-31 104
ed21cfe207276e Ganesan Ramalingam 2012-10-31 105 /**
ed21cfe207276e Ganesan Ramalingam 2012-10-31 @106 * Configure bucket size and credits for a device. 'size' is the size of
ed21cfe207276e Ganesan Ramalingam 2012-10-31 107 * the buckets for the device. This size is distributed among all the CPUs
ed21cfe207276e Ganesan Ramalingam 2012-10-31 108 * so that all of them can send messages to the device.
ed21cfe207276e Ganesan Ramalingam 2012-10-31 109 *
ed21cfe207276e Ganesan Ramalingam 2012-10-31 110 * The device is also given 'cpu_credits' to send messages to the CPUs
ed21cfe207276e Ganesan Ramalingam 2012-10-31 111 *
ed21cfe207276e Ganesan Ramalingam 2012-10-31 112 * @dev_info: FMN information structure for each devices
ed21cfe207276e Ganesan Ramalingam 2012-10-31 113 * @start_stn_id: Starting station id of dev_info
ed21cfe207276e Ganesan Ramalingam 2012-10-31 114 * @end_stn_id: End station id of dev_info
ed21cfe207276e Ganesan Ramalingam 2012-10-31 115 * @num_buckets: Total number of buckets for den_info
ed21cfe207276e Ganesan Ramalingam 2012-10-31 116 * @cpu_credits: Allowed credits to cpu for each devices pointing by dev_info
ed21cfe207276e Ganesan Ramalingam 2012-10-31 117 * @size: Size of the each buckets in the device station
ed21cfe207276e Ganesan Ramalingam 2012-10-31 118 */
ed21cfe207276e Ganesan Ramalingam 2012-10-31 119 static void setup_fmn_cc(struct xlr_fmn_info *dev_info, int start_stn_id,
ed21cfe207276e Ganesan Ramalingam 2012-10-31 120 int end_stn_id, int num_buckets, int cpu_credits, int size)
ed21cfe207276e Ganesan Ramalingam 2012-10-31 121 {
ed21cfe207276e Ganesan Ramalingam 2012-10-31 122 int i, j, num_core, n, credits_per_cpu;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 123 struct xlr_fmn_info *cpu = xlr_board_fmn_config.cpu;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 124
ed21cfe207276e Ganesan Ramalingam 2012-10-31 125 num_core = hweight32(nlm_current_node()->coremask);
ed21cfe207276e Ganesan Ramalingam 2012-10-31 126 dev_info->num_buckets = num_buckets;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 127 dev_info->start_stn_id = start_stn_id;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 128 dev_info->end_stn_id = end_stn_id;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 129
ed21cfe207276e Ganesan Ramalingam 2012-10-31 130 n = num_core;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 131 if (num_core == 3)
ed21cfe207276e Ganesan Ramalingam 2012-10-31 132 n = 4;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 133
ed21cfe207276e Ganesan Ramalingam 2012-10-31 134 for (i = start_stn_id; i <= end_stn_id; i++) {
ed21cfe207276e Ganesan Ramalingam 2012-10-31 135 xlr_board_fmn_config.bucket_size[i] = size;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 136
ed21cfe207276e Ganesan Ramalingam 2012-10-31 137 /* Dividing device credits equally to cpus */
ed21cfe207276e Ganesan Ramalingam 2012-10-31 138 credits_per_cpu = size / n;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 139 for (j = 0; j < num_core; j++)
ed21cfe207276e Ganesan Ramalingam 2012-10-31 140 cpu[j].credit_config[i] = credits_per_cpu;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 141
ed21cfe207276e Ganesan Ramalingam 2012-10-31 142 /* credits left to distribute */
ed21cfe207276e Ganesan Ramalingam 2012-10-31 143 credits_per_cpu = size - (credits_per_cpu * num_core);
ed21cfe207276e Ganesan Ramalingam 2012-10-31 144
ed21cfe207276e Ganesan Ramalingam 2012-10-31 145 /* distribute the remaining credits (if any), among cores */
ed21cfe207276e Ganesan Ramalingam 2012-10-31 146 for (j = 0; (j < num_core) && (credits_per_cpu >= 4); j++) {
ed21cfe207276e Ganesan Ramalingam 2012-10-31 147 cpu[j].credit_config[i] += 4;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 148 credits_per_cpu -= 4;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 149 }
ed21cfe207276e Ganesan Ramalingam 2012-10-31 150 }
ed21cfe207276e Ganesan Ramalingam 2012-10-31 151
ed21cfe207276e Ganesan Ramalingam 2012-10-31 152 /* Distributing cpu per bucket credits to devices */
ed21cfe207276e Ganesan Ramalingam 2012-10-31 153 for (i = 0; i < num_core; i++) {
ed21cfe207276e Ganesan Ramalingam 2012-10-31 154 for (j = 0; j < FMN_CORE_NBUCKETS; j++)
ed21cfe207276e Ganesan Ramalingam 2012-10-31 155 dev_info->credit_config[(i * 8) + j] = cpu_credits;
ed21cfe207276e Ganesan Ramalingam 2012-10-31 156 }
ed21cfe207276e Ganesan Ramalingam 2012-10-31 157 }
ed21cfe207276e Ganesan Ramalingam 2012-10-31 158

:::::: The code at line 106 was first introduced by commit
:::::: ed21cfe207276e2d2883173399dd0380db372e18 MIPS: Netlogic: Support for XLR/XLS Fast Message Network

:::::: TO: Ganesan Ramalingam <ganesanr@xxxxxxxxxxxx>
:::::: CC: John Crispin <blogic@xxxxxxxxxxx>

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

Attachment: .config.gz
Description: application/gzip