[dinguyen:svc_driver_updates_for_v4.20 3/6] htmldocs: include/linux/firmware/intel/stratix10-svc-client.h:149: warning: Excess enum value 'COMMAND_FCS_REQUEST_SERVICE' description in 'stratix10_svc_command_code'
From: kernel test robot
Date: Sat Jun 11 2022 - 23:13:50 EST
tree: https://git.kernel.org/pub/scm/linux/kernel/git/dinguyen/linux.git svc_driver_updates_for_v4.20
head: 107da326a0a3e7b6e81557c4225548db670a2647
commit: 389d4793ec9af06a6b3f110b309561cb98eaa013 [3/6] firmware: stratix10-svc: add new FCS commands
reproduce: make htmldocs
If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <lkp@xxxxxxxxx>
All warnings (new ones prefixed by >>):
>> include/linux/firmware/intel/stratix10-svc-client.h:149: warning: Excess enum value 'COMMAND_FCS_REQUEST_SERVICE' description in 'stratix10_svc_command_code'
>> include/linux/firmware/intel/stratix10-svc-client.h:149: warning: Excess enum value 'COMMAND_FCS_DATA_DECRYPTION' description in 'stratix10_svc_command_code'
>> include/linux/firmware/intel/stratix10-svc-client.h:149: warning: Excess enum value 'COMMAND_FCS_SEND_CERTIFICATE' description in 'stratix10_svc_command_code'
>> include/linux/firmware/intel/stratix10-svc-client.h:149: warning: Excess enum value 'COMMAND_FCS_GET_PROVISION_DATA' description in 'stratix10_svc_command_code'
>> include/linux/firmware/intel/stratix10-svc-client.h:149: warning: Excess enum value 'COMMAND_FCS_DATA_ENCRYPTION' description in 'stratix10_svc_command_code'
>> include/linux/firmware/intel/stratix10-svc-client.h:149: warning: Excess enum value 'COMMAND_FCS_RANDOM_NUMBER_GEN' description in 'stratix10_svc_command_code'
vim +149 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
389d4793ec9af0 Ang Tien Sung 2022-06-09 52 #define SVC_STATUS_INVALID_PARAM 7
389d4793ec9af0 Ang Tien Sung 2022-06-09 53 /**
7ca5ce896524f5 Richard Gong 2018-11-13 54 * Flag bit for COMMAND_RECONFIG
7ca5ce896524f5 Richard Gong 2018-11-13 55 *
7ca5ce896524f5 Richard Gong 2018-11-13 56 * COMMAND_RECONFIG_FLAG_PARTIAL:
36847f9e3e56c1 Richard Gong 2020-06-15 57 * Set to FPGA configuration type (full or partial).
7ca5ce896524f5 Richard Gong 2018-11-13 58 */
2e8496f31d0be8 Richard Gong 2021-02-09 59 #define COMMAND_RECONFIG_FLAG_PARTIAL 0
7ca5ce896524f5 Richard Gong 2018-11-13 60
e23bd83368af41 Mauro Carvalho Chehab 2021-01-14 61 /*
7ca5ce896524f5 Richard Gong 2018-11-13 62 * Timeout settings for service clients:
7ca5ce896524f5 Richard Gong 2018-11-13 63 * timeout value used in Stratix10 FPGA manager driver.
6b50d882d38d5a Richard Gong 2018-11-13 64 * timeout value used in RSU driver
7ca5ce896524f5 Richard Gong 2018-11-13 65 */
36847f9e3e56c1 Richard Gong 2020-06-15 66 #define SVC_RECONFIG_REQUEST_TIMEOUT_MS 300
36847f9e3e56c1 Richard Gong 2020-06-15 67 #define SVC_RECONFIG_BUFFER_TIMEOUT_MS 720
6b50d882d38d5a Richard Gong 2018-11-13 68 #define SVC_RSU_REQUEST_TIMEOUT_MS 300
389d4793ec9af0 Ang Tien Sung 2022-06-09 69 #define SVC_FCS_REQUEST_TIMEOUT_MS 2000
389d4793ec9af0 Ang Tien Sung 2022-06-09 70 #define SVC_COMPLETED_TIMEOUT_MS 30000
7ca5ce896524f5 Richard Gong 2018-11-13 71
7ca5ce896524f5 Richard Gong 2018-11-13 72 struct stratix10_svc_chan;
7ca5ce896524f5 Richard Gong 2018-11-13 73
7ca5ce896524f5 Richard Gong 2018-11-13 74 /**
7ca5ce896524f5 Richard Gong 2018-11-13 75 * enum stratix10_svc_command_code - supported service commands
7ca5ce896524f5 Richard Gong 2018-11-13 76 *
7ca5ce896524f5 Richard Gong 2018-11-13 77 * @COMMAND_NOOP: do 'dummy' request for integration/debug/trouble-shooting
7ca5ce896524f5 Richard Gong 2018-11-13 78 *
7ca5ce896524f5 Richard Gong 2018-11-13 79 * @COMMAND_RECONFIG: ask for FPGA configuration preparation, return status
7536ad8dbfcfd5 Richard Gong 2020-04-14 80 * is SVC_STATUS_OK
7ca5ce896524f5 Richard Gong 2018-11-13 81 *
7ca5ce896524f5 Richard Gong 2018-11-13 82 * @COMMAND_RECONFIG_DATA_SUBMIT: submit buffer(s) of bit-stream data for the
7536ad8dbfcfd5 Richard Gong 2020-04-14 83 * FPGA configuration, return status is SVC_STATUS_SUBMITTED or SVC_STATUS_ERROR
7ca5ce896524f5 Richard Gong 2018-11-13 84 *
7ca5ce896524f5 Richard Gong 2018-11-13 85 * @COMMAND_RECONFIG_DATA_CLAIM: check the status of the configuration, return
7536ad8dbfcfd5 Richard Gong 2020-04-14 86 * status is SVC_STATUS_COMPLETED, or SVC_STATUS_BUSY, or SVC_STATUS_ERROR
7ca5ce896524f5 Richard Gong 2018-11-13 87 *
7ca5ce896524f5 Richard Gong 2018-11-13 88 * @COMMAND_RECONFIG_STATUS: check the status of the configuration, return
7536ad8dbfcfd5 Richard Gong 2020-04-14 89 * status is SVC_STATUS_COMPLETED, or SVC_STATUS_BUSY, or SVC_STATUS_ERROR
6b50d882d38d5a Richard Gong 2018-11-13 90 *
6b50d882d38d5a Richard Gong 2018-11-13 91 * @COMMAND_RSU_STATUS: request remote system update boot log, return status
6b50d882d38d5a Richard Gong 2018-11-13 92 * is log data or SVC_STATUS_RSU_ERROR
6b50d882d38d5a Richard Gong 2018-11-13 93 *
6b50d882d38d5a Richard Gong 2018-11-13 94 * @COMMAND_RSU_UPDATE: set the offset of the bitstream to boot after reboot,
7536ad8dbfcfd5 Richard Gong 2020-04-14 95 * return status is SVC_STATUS_OK or SVC_STATUS_ERROR
b5dc75c915cdae Richard Gong 2019-09-03 96 *
b5dc75c915cdae Richard Gong 2019-09-03 97 * @COMMAND_RSU_NOTIFY: report the status of hard processor system
7536ad8dbfcfd5 Richard Gong 2020-04-14 98 * software to firmware, return status is SVC_STATUS_OK or
7536ad8dbfcfd5 Richard Gong 2020-04-14 99 * SVC_STATUS_ERROR
b5dc75c915cdae Richard Gong 2019-09-03 100 *
b5dc75c915cdae Richard Gong 2019-09-03 101 * @COMMAND_RSU_RETRY: query firmware for the current image's retry counter,
7536ad8dbfcfd5 Richard Gong 2020-04-14 102 * return status is SVC_STATUS_OK or SVC_STATUS_ERROR
bf0e5bf68a207b Richard Gong 2020-06-15 103 *
bf0e5bf68a207b Richard Gong 2020-06-15 104 * @COMMAND_RSU_MAX_RETRY: query firmware for the max retry value,
bf0e5bf68a207b Richard Gong 2020-06-15 105 * return status is SVC_STATUS_OK or SVC_STATUS_ERROR
bf0e5bf68a207b Richard Gong 2020-06-15 106 *
bf0e5bf68a207b Richard Gong 2020-06-15 107 * @COMMAND_RSU_DCMF_VERSION: query firmware for the DCMF version, return status
bf0e5bf68a207b Richard Gong 2020-06-15 108 * is SVC_STATUS_OK or SVC_STATUS_ERROR
085a884434f3e3 Richard Gong 2022-02-23 109 *
01fa95d63a56d2 Ang Tien Sung 2022-06-09 110 * @COMMAND_POLL_SERVICE_STATUS: poll if the service request is complete,
01fa95d63a56d2 Ang Tien Sung 2022-06-09 111 * return statis is SVC_STATUS_OK, SVC_STATUS_ERROR or SVC_STATUS_BUSY
01fa95d63a56d2 Ang Tien Sung 2022-06-09 112 *
085a884434f3e3 Richard Gong 2022-02-23 113 * @COMMAND_FIRMWARE_VERSION: query running firmware version, return status
085a884434f3e3 Richard Gong 2022-02-23 114 * is SVC_STATUS_OK or SVC_STATUS_ERROR
389d4793ec9af0 Ang Tien Sung 2022-06-09 115 *
389d4793ec9af0 Ang Tien Sung 2022-06-09 116 * @COMMAND_FCS_REQUEST_SERVICE: request validation of image from firmware,
389d4793ec9af0 Ang Tien Sung 2022-06-09 117 * return status is SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM
389d4793ec9af0 Ang Tien Sung 2022-06-09 118 *
389d4793ec9af0 Ang Tien Sung 2022-06-09 119 * @COMMAND_FCS_SEND_CERTIFICATE: send a certificate, return status is
389d4793ec9af0 Ang Tien Sung 2022-06-09 120 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SVC_STATUS_ERROR
389d4793ec9af0 Ang Tien Sung 2022-06-09 121 *
389d4793ec9af0 Ang Tien Sung 2022-06-09 122 * @COMMAND_FCS_GET_PROVISION_DATA: read the provisioning data, return status is
389d4793ec9af0 Ang Tien Sung 2022-06-09 123 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SVC_STATUS_ERROR
389d4793ec9af0 Ang Tien Sung 2022-06-09 124 *
389d4793ec9af0 Ang Tien Sung 2022-06-09 125 * @COMMAND_FCS_DATA_ENCRYPTION: encrypt the data, return status is
389d4793ec9af0 Ang Tien Sung 2022-06-09 126 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SVC_STATUS_ERROR
389d4793ec9af0 Ang Tien Sung 2022-06-09 127 *
389d4793ec9af0 Ang Tien Sung 2022-06-09 128 * @COMMAND_FCS_DATA_DECRYPTION: decrypt the data, return status is
389d4793ec9af0 Ang Tien Sung 2022-06-09 129 * SVC_STATUS_OK, SVC_STATUS_INVALID_PARAM, SVC_STATUS_ERROR
389d4793ec9af0 Ang Tien Sung 2022-06-09 130 *
389d4793ec9af0 Ang Tien Sung 2022-06-09 131 * @COMMAND_FCS_RANDOM_NUMBER_GEN: generate a random number, return status
389d4793ec9af0 Ang Tien Sung 2022-06-09 132 * is SVC_STATUS_OK, SVC_STATUS_ERROR
7ca5ce896524f5 Richard Gong 2018-11-13 133 */
7ca5ce896524f5 Richard Gong 2018-11-13 134 enum stratix10_svc_command_code {
7ca5ce896524f5 Richard Gong 2018-11-13 135 COMMAND_NOOP = 0,
7ca5ce896524f5 Richard Gong 2018-11-13 136 COMMAND_RECONFIG,
7ca5ce896524f5 Richard Gong 2018-11-13 137 COMMAND_RECONFIG_DATA_SUBMIT,
7ca5ce896524f5 Richard Gong 2018-11-13 138 COMMAND_RECONFIG_DATA_CLAIM,
6b50d882d38d5a Richard Gong 2018-11-13 139 COMMAND_RECONFIG_STATUS,
6b50d882d38d5a Richard Gong 2018-11-13 140 COMMAND_RSU_STATUS,
b5dc75c915cdae Richard Gong 2019-09-03 141 COMMAND_RSU_UPDATE,
b5dc75c915cdae Richard Gong 2019-09-03 142 COMMAND_RSU_NOTIFY,
b5dc75c915cdae Richard Gong 2019-09-03 143 COMMAND_RSU_RETRY,
bf0e5bf68a207b Richard Gong 2020-06-15 144 COMMAND_RSU_MAX_RETRY,
bf0e5bf68a207b Richard Gong 2020-06-15 145 COMMAND_RSU_DCMF_VERSION,
085a884434f3e3 Richard Gong 2022-02-23 146 COMMAND_FIRMWARE_VERSION,
01fa95d63a56d2 Ang Tien Sung 2022-06-09 147 /* for general status poll */
01fa95d63a56d2 Ang Tien Sung 2022-06-09 148 COMMAND_POLL_SERVICE_STATUS = 40,
7ca5ce896524f5 Richard Gong 2018-11-13 @149 };
7ca5ce896524f5 Richard Gong 2018-11-13 150
:::::: The code at line 149 was first introduced by commit
:::::: 7ca5ce896524f5292e610b27d168269e5ab74951 firmware: add Intel Stratix10 service layer driver
:::::: TO: Richard Gong <richard.gong@xxxxxxxxx>
:::::: CC: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
--
0-DAY CI Kernel Test Service
https://01.org/lkp