[dinguyen:svc_driver_updates_for_v4.20 1/6] htmldocs: include/linux/firmware/intel/stratix10-svc-client.h:19: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

kernel test robot
2022-06-11T20:30:49Z

tree: https://git.kernel.org/pub/scm/linux/kernel/git/dinguyen/linux.git svc_driver_updates_for_v4.20
head: 107da326a0a3e7b6e81557c4225548db670a2647
commit: 88f42ac48b89689a3e8673263c09ad77be157a09 [1/6] firmware: stratix10-svc: Add support for FCS
reproduce: make htmldocs

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

All warnings (new ones prefixed by >>):

>> include/linux/firmware/intel/stratix10-svc-client.h:19: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

vim +19 include/linux/firmware/intel/stratix10-svc-client.h

7ca5ce896524f5 Richard Gong 2018-11-13 8
e23bd83368af41 Mauro Carvalho Chehab 2021-01-14 9 /*
7ca5ce896524f5 Richard Gong 2018-11-13 10 * Service layer driver supports client names
7ca5ce896524f5 Richard Gong 2018-11-13 11 *
7ca5ce896524f5 Richard Gong 2018-11-13 12 * fpga: for FPGA configuration
6b50d882d38d5a Richard Gong 2018-11-13 13 * rsu: for remote status update
7ca5ce896524f5 Richard Gong 2018-11-13 14 */
7ca5ce896524f5 Richard Gong 2018-11-13 15 #define SVC_CLIENT_FPGA "fpga"
6b50d882d38d5a Richard Gong 2018-11-13 16 #define SVC_CLIENT_RSU "rsu"
88f42ac48b8968 Ang Tien Sung 2022-03-15 17 #define SVC_CLIENT_FCS "fcs"
88f42ac48b8968 Ang Tien Sung 2022-03-15 18 /**
7ca5ce896524f5 Richard Gong 2018-11-13 @19 * Status of the sent command, in bit number
7ca5ce896524f5 Richard Gong 2018-11-13 20 *
7536ad8dbfcfd5 Richard Gong 2020-04-14 21 * SVC_STATUS_OK:
7536ad8dbfcfd5 Richard Gong 2020-04-14 22 * Secure firmware accepts the request issued by one of service clients.
7ca5ce896524f5 Richard Gong 2018-11-13 23 *
7536ad8dbfcfd5 Richard Gong 2020-04-14 24 * SVC_STATUS_BUFFER_SUBMITTED:
7536ad8dbfcfd5 Richard Gong 2020-04-14 25 * Service client successfully submits data buffer to secure firmware.
7ca5ce896524f5 Richard Gong 2018-11-13 26 *
7536ad8dbfcfd5 Richard Gong 2020-04-14 27 * SVC_STATUS_BUFFER_DONE:
7ca5ce896524f5 Richard Gong 2018-11-13 28 * Secure firmware completes data process, ready to accept the
7ca5ce896524f5 Richard Gong 2018-11-13 29 * next WRITE transaction.
7ca5ce896524f5 Richard Gong 2018-11-13 30 *
7536ad8dbfcfd5 Richard Gong 2020-04-14 31 * SVC_STATUS_COMPLETED:
7536ad8dbfcfd5 Richard Gong 2020-04-14 32 * Secure firmware completes service request successfully. In case of
7536ad8dbfcfd5 Richard Gong 2020-04-14 33 * FPGA configuration, FPGA should be in user mode.
7ca5ce896524f5 Richard Gong 2018-11-13 34 *
7536ad8dbfcfd5 Richard Gong 2020-04-14 35 * SVC_COMMAND_STATUS_BUSY:
7536ad8dbfcfd5 Richard Gong 2020-04-14 36 * Service request is still in process.
7ca5ce896524f5 Richard Gong 2018-11-13 37 *
7536ad8dbfcfd5 Richard Gong 2020-04-14 38 * SVC_COMMAND_STATUS_ERROR:
7536ad8dbfcfd5 Richard Gong 2020-04-14 39 * Error encountered during the process of the service request.
6b50d882d38d5a Richard Gong 2018-11-13 40 *
7536ad8dbfcfd5 Richard Gong 2020-04-14 41 * SVC_STATUS_NO_SUPPORT:
7536ad8dbfcfd5 Richard Gong 2020-04-14 42 * Secure firmware doesn't support requested features such as RSU retry
7536ad8dbfcfd5 Richard Gong 2020-04-14 43 * or RSU notify.
7ca5ce896524f5 Richard Gong 2018-11-13 44 */
7536ad8dbfcfd5 Richard Gong 2020-04-14 45 #define SVC_STATUS_OK 0
7536ad8dbfcfd5 Richard Gong 2020-04-14 46 #define SVC_STATUS_BUFFER_SUBMITTED 1
7536ad8dbfcfd5 Richard Gong 2020-04-14 47 #define SVC_STATUS_BUFFER_DONE 2
7536ad8dbfcfd5 Richard Gong 2020-04-14 48 #define SVC_STATUS_COMPLETED 3
7536ad8dbfcfd5 Richard Gong 2020-04-14 49 #define SVC_STATUS_BUSY 4
7536ad8dbfcfd5 Richard Gong 2020-04-14 50 #define SVC_STATUS_ERROR 5
7536ad8dbfcfd5 Richard Gong 2020-04-14 51 #define SVC_STATUS_NO_SUPPORT 6
e9cb0497b1c801 Richard Gong 2019-11-04 52

:::::: The code at line 19 was first introduced by commit
:::::: 7ca5ce896524f5292e610b27d168269e5ab74951 firmware: add Intel Stratix10 service layer driver

:::::: TO: Richard Gong <richard.gong@intel.com>
:::::: CC: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

--
0-DAY CI Kernel Test Service