drivers/hsi/clients/cmt_speech.c:831: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

[kernel test robot]

Hi Aditya,

FYI, the error/warning still remains.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   1746f4db513563bb22e0ba0c419d0c90912dfae1
commit: 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf scripts: kernel-doc: add warning for comment not following kernel-doc syntax
date:   5 months ago
config: arm-buildonly-randconfig-r004-20210812 (attached as .config)
compiler: arm-linux-gnueabi-gcc (GCC) 10.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-10.3.0 make.cross ARCH=arm 

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/hsi/clients/cmt_speech.c:831: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Block until pending data transfers have completed.


vim +831 drivers/hsi/clients/cmt_speech.c

7f62fe8a5851db Kai Vehmanen 2010-06-02  829  
7f62fe8a5851db Kai Vehmanen 2010-06-02  830  /**
7f62fe8a5851db Kai Vehmanen 2010-06-02 @831   * Block until pending data transfers have completed.
7f62fe8a5851db Kai Vehmanen 2010-06-02  832   */
7f62fe8a5851db Kai Vehmanen 2010-06-02  833  static int cs_hsi_data_sync(struct cs_hsi_iface *hi)
7f62fe8a5851db Kai Vehmanen 2010-06-02  834  {
7f62fe8a5851db Kai Vehmanen 2010-06-02  835  	int r = 0;
7f62fe8a5851db Kai Vehmanen 2010-06-02  836  
7f62fe8a5851db Kai Vehmanen 2010-06-02  837  	spin_lock_bh(&hi->lock);
7f62fe8a5851db Kai Vehmanen 2010-06-02  838  
7f62fe8a5851db Kai Vehmanen 2010-06-02  839  	if (!cs_state_xfer_active(hi->data_state)) {
7f62fe8a5851db Kai Vehmanen 2010-06-02  840  		dev_dbg(&hi->cl->device, "hsi_data_sync break, idle\n");
7f62fe8a5851db Kai Vehmanen 2010-06-02  841  		goto out;
7f62fe8a5851db Kai Vehmanen 2010-06-02  842  	}
7f62fe8a5851db Kai Vehmanen 2010-06-02  843  
7f62fe8a5851db Kai Vehmanen 2010-06-02  844  	for (;;) {
7f62fe8a5851db Kai Vehmanen 2010-06-02  845  		int s;
7f62fe8a5851db Kai Vehmanen 2010-06-02  846  		DEFINE_WAIT(wait);
7f62fe8a5851db Kai Vehmanen 2010-06-02  847  		if (!cs_state_xfer_active(hi->data_state))
7f62fe8a5851db Kai Vehmanen 2010-06-02  848  			goto out;
7f62fe8a5851db Kai Vehmanen 2010-06-02  849  		if (signal_pending(current)) {
7f62fe8a5851db Kai Vehmanen 2010-06-02  850  			r = -ERESTARTSYS;
7f62fe8a5851db Kai Vehmanen 2010-06-02  851  			goto out;
7f62fe8a5851db Kai Vehmanen 2010-06-02  852  		}
7f62fe8a5851db Kai Vehmanen 2010-06-02  853  		/**
7f62fe8a5851db Kai Vehmanen 2010-06-02  854  		 * prepare_to_wait must be called with hi->lock held
7f62fe8a5851db Kai Vehmanen 2010-06-02  855  		 * so that callbacks can check for waitqueue_active()
7f62fe8a5851db Kai Vehmanen 2010-06-02  856  		 */
7f62fe8a5851db Kai Vehmanen 2010-06-02  857  		prepare_to_wait(&hi->datawait, &wait, TASK_INTERRUPTIBLE);
7f62fe8a5851db Kai Vehmanen 2010-06-02  858  		spin_unlock_bh(&hi->lock);
7f62fe8a5851db Kai Vehmanen 2010-06-02  859  		s = schedule_timeout(
7f62fe8a5851db Kai Vehmanen 2010-06-02  860  			msecs_to_jiffies(CS_HSI_TRANSFER_TIMEOUT_MS));
7f62fe8a5851db Kai Vehmanen 2010-06-02  861  		spin_lock_bh(&hi->lock);
7f62fe8a5851db Kai Vehmanen 2010-06-02  862  		finish_wait(&hi->datawait, &wait);
7f62fe8a5851db Kai Vehmanen 2010-06-02  863  		if (!s) {
7f62fe8a5851db Kai Vehmanen 2010-06-02  864  			dev_dbg(&hi->cl->device,
7f62fe8a5851db Kai Vehmanen 2010-06-02  865  				"hsi_data_sync timeout after %d ms\n",
7f62fe8a5851db Kai Vehmanen 2010-06-02  866  				CS_HSI_TRANSFER_TIMEOUT_MS);
7f62fe8a5851db Kai Vehmanen 2010-06-02  867  			r = -EIO;
7f62fe8a5851db Kai Vehmanen 2010-06-02  868  			goto out;
7f62fe8a5851db Kai Vehmanen 2010-06-02  869  		}
7f62fe8a5851db Kai Vehmanen 2010-06-02  870  	}
7f62fe8a5851db Kai Vehmanen 2010-06-02  871  
7f62fe8a5851db Kai Vehmanen 2010-06-02  872  out:
7f62fe8a5851db Kai Vehmanen 2010-06-02  873  	spin_unlock_bh(&hi->lock);
7f62fe8a5851db Kai Vehmanen 2010-06-02  874  	dev_dbg(&hi->cl->device, "hsi_data_sync done with res %d\n", r);
7f62fe8a5851db Kai Vehmanen 2010-06-02  875  
7f62fe8a5851db Kai Vehmanen 2010-06-02  876  	return r;
7f62fe8a5851db Kai Vehmanen 2010-06-02  877  }
7f62fe8a5851db Kai Vehmanen 2010-06-02  878  

:::::: The code at line 831 was first introduced by commit
:::::: 7f62fe8a5851db94e10d8d956c123d4011aaeed9 HSI: cmt_speech: Add cmt-speech driver

:::::: TO: Kai Vehmanen <kai.vehmanen@xxxxxxxxx>
:::::: CC: Sebastian Reichel <sre@xxxxxxxxxx>

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

Attachment: .config.gz
Description: application/gzip