drivers/hid/intel-ish-hid/ishtp-fw-loader.c:267: 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 Sep 27 2021 - 10:46:17 EST

Next message: Pierre-Louis Bossart: "Re: [PATCH] ASoC: intel: sof_rt5682: update platform device name for Maxim amplifier"
Previous message: kernel test robot: "arch/powerpc/platforms/52xx/lite5200_pm.c:215:9: error: implicit declaration of function 'enable_kernel_fp'"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: 92477dd1faa650e50bd3bb35a6c0b8d09198cc35
commit: 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf scripts: kernel-doc: add warning for comment not following kernel-doc syntax
date: 6 months ago
config: x86_64-randconfig-a011-20210927 (attached as .config)
compiler: clang version 14.0.0 (https://github.com/llvm/llvm-project dc6e8dfdfe7efecfda318d43a06fae18b40eb498)
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=clang make.cross W=1 ARCH=x86_64

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

All warnings (new ones prefixed by >>):

drivers/hid/intel-ish-hid/ishtp-fw-loader.c:46: warning: Enum value 'LOADER_CMD_XFER_QUERY' not described in enum 'ish_loader_commands'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:46: warning: Enum value 'LOADER_CMD_XFER_FRAGMENT' not described in enum 'ish_loader_commands'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:46: warning: Enum value 'LOADER_CMD_START' not described in enum 'ish_loader_commands'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:108: warning: Function parameter or member 'reserved' not described in 'loader_msg_hdr'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'data' not described in 'response_info'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'max_size' not described in 'response_info'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'size' not described in 'response_info'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'error' not described in 'response_info'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'received' not described in 'response_info'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'wait_queue' not described in 'response_info'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'loader_ishtp_cl' not described in 'ishtp_cl_data'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'cl_device' not described in 'ishtp_cl_data'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'response' not described in 'ishtp_cl_data'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'flag_retry' not described in 'ishtp_cl_data'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'retry_count' not described in 'ishtp_cl_data'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:252: warning: Function parameter or member 'client_data' not described in 'get_firmware_variant'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:252: warning: Function parameter or member 'filename' not described in 'get_firmware_variant'
>> drivers/hid/intel-ish-hid/ishtp-fw-loader.c:267: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* loader_cl_send() Send message from host to firmware
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:445: warning: Function parameter or member 'cl_device' not described in 'loader_cl_event_cb'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:445: warning: Excess function parameter 'device' description in 'loader_cl_event_cb'
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:539: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* ish_fw_xfer_ishtp() Loads ISH firmware using ishtp interface
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:736: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* ish_fw_start() Start executing ISH main firmware
drivers/hid/intel-ish-hid/ishtp-fw-loader.c:759: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* load_fw_from_host() Loads ISH firmware from host
--
drivers/net/wireless/intel/ipw2x00/ipw2100.c:5375: warning: expecting prototype for Set a the wep key(). Prototype was for ipw2100_set_key() instead
>> drivers/net/wireless/intel/ipw2x00/ipw2100.c:6533: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Initialize the ipw2100 driver/module
drivers/net/wireless/intel/ipw2x00/ipw2100.c:6568: warning: expecting prototype for Cleanup ipw2100 driver registration(). Prototype was for ipw2100_exit() instead

vim +267 drivers/hid/intel-ish-hid/ishtp-fw-loader.c

91b228107da3e4 Rushikesh S Kadam 2019-04-02 265
91b228107da3e4 Rushikesh S Kadam 2019-04-02 266 /**
91b228107da3e4 Rushikesh S Kadam 2019-04-02 @267 * loader_cl_send() Send message from host to firmware
91b228107da3e4 Rushikesh S Kadam 2019-04-02 268 * @client_data: Client data instance
91b228107da3e4 Rushikesh S Kadam 2019-04-02 269 * @out_msg Message buffer to be sent to firmware
91b228107da3e4 Rushikesh S Kadam 2019-04-02 270 * @out_size Size of out going message
91b228107da3e4 Rushikesh S Kadam 2019-04-02 271 * @in_msg Message buffer where the incoming data copied.
91b228107da3e4 Rushikesh S Kadam 2019-04-02 272 * This buffer is allocated by calling
91b228107da3e4 Rushikesh S Kadam 2019-04-02 273 * @in_size Max size of incoming message
91b228107da3e4 Rushikesh S Kadam 2019-04-02 274 *
91b228107da3e4 Rushikesh S Kadam 2019-04-02 275 * Return: Number of bytes copied in the in_msg on success, negative
91b228107da3e4 Rushikesh S Kadam 2019-04-02 276 * error code on failure.
91b228107da3e4 Rushikesh S Kadam 2019-04-02 277 */
91b228107da3e4 Rushikesh S Kadam 2019-04-02 278 static int loader_cl_send(struct ishtp_cl_data *client_data,
91b228107da3e4 Rushikesh S Kadam 2019-04-02 279 u8 *out_msg, size_t out_size,
91b228107da3e4 Rushikesh S Kadam 2019-04-02 280 u8 *in_msg, size_t in_size)
91b228107da3e4 Rushikesh S Kadam 2019-04-02 281 {
91b228107da3e4 Rushikesh S Kadam 2019-04-02 282 int rv;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 283 struct loader_msg_hdr *out_hdr = (struct loader_msg_hdr *)out_msg;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 284 struct ishtp_cl *loader_ishtp_cl = client_data->loader_ishtp_cl;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 285
91b228107da3e4 Rushikesh S Kadam 2019-04-02 286 dev_dbg(cl_data_to_dev(client_data),
91b228107da3e4 Rushikesh S Kadam 2019-04-02 287 "%s: command=%02lx is_response=%u status=%02x\n",
91b228107da3e4 Rushikesh S Kadam 2019-04-02 288 __func__,
91b228107da3e4 Rushikesh S Kadam 2019-04-02 289 out_hdr->command & CMD_MASK,
91b228107da3e4 Rushikesh S Kadam 2019-04-02 290 out_hdr->command & IS_RESPONSE ? 1 : 0,
91b228107da3e4 Rushikesh S Kadam 2019-04-02 291 out_hdr->status);
91b228107da3e4 Rushikesh S Kadam 2019-04-02 292
91b228107da3e4 Rushikesh S Kadam 2019-04-02 293 /* Setup in coming buffer & size */
91b228107da3e4 Rushikesh S Kadam 2019-04-02 294 client_data->response.data = in_msg;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 295 client_data->response.max_size = in_size;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 296 client_data->response.error = 0;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 297 client_data->response.received = false;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 298
91b228107da3e4 Rushikesh S Kadam 2019-04-02 299 rv = ishtp_cl_send(loader_ishtp_cl, out_msg, out_size);
91b228107da3e4 Rushikesh S Kadam 2019-04-02 300 if (rv < 0) {
91b228107da3e4 Rushikesh S Kadam 2019-04-02 301 dev_err(cl_data_to_dev(client_data),
91b228107da3e4 Rushikesh S Kadam 2019-04-02 302 "ishtp_cl_send error %d\n", rv);
91b228107da3e4 Rushikesh S Kadam 2019-04-02 303 return rv;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 304 }
91b228107da3e4 Rushikesh S Kadam 2019-04-02 305
91b228107da3e4 Rushikesh S Kadam 2019-04-02 306 wait_event_interruptible_timeout(client_data->response.wait_queue,
91b228107da3e4 Rushikesh S Kadam 2019-04-02 307 client_data->response.received,
91b228107da3e4 Rushikesh S Kadam 2019-04-02 308 ISHTP_SEND_TIMEOUT);
91b228107da3e4 Rushikesh S Kadam 2019-04-02 309 if (!client_data->response.received) {
91b228107da3e4 Rushikesh S Kadam 2019-04-02 310 dev_err(cl_data_to_dev(client_data),
91b228107da3e4 Rushikesh S Kadam 2019-04-02 311 "Timed out for response to command=%02lx",
91b228107da3e4 Rushikesh S Kadam 2019-04-02 312 out_hdr->command & CMD_MASK);
91b228107da3e4 Rushikesh S Kadam 2019-04-02 313 return -ETIMEDOUT;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 314 }
91b228107da3e4 Rushikesh S Kadam 2019-04-02 315
91b228107da3e4 Rushikesh S Kadam 2019-04-02 316 if (client_data->response.error < 0)
91b228107da3e4 Rushikesh S Kadam 2019-04-02 317 return client_data->response.error;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 318
91b228107da3e4 Rushikesh S Kadam 2019-04-02 319 return client_data->response.size;
91b228107da3e4 Rushikesh S Kadam 2019-04-02 320 }
91b228107da3e4 Rushikesh S Kadam 2019-04-02 321

:::::: The code at line 267 was first introduced by commit
:::::: 91b228107da3e41558449a62cd93816b47b3b4b5 HID: intel-ish-hid: ISH firmware loader client driver

:::::: TO: Rushikesh S Kadam <rushikesh.s.kadam@xxxxxxxxx>
:::::: CC: Jiri Kosina <jkosina@xxxxxxx>

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

Attachment: .config.gz
Description: application/gzip

Next message: Pierre-Louis Bossart: "Re: [PATCH] ASoC: intel: sof_rt5682: update platform device name for Maxim amplifier"
Previous message: kernel test robot: "arch/powerpc/platforms/52xx/lite5200_pm.c:215:9: error: implicit declaration of function 'enable_kernel_fp'"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]