LinuxLists.cc - [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

2022-06-11 21:45:03

Subject: [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

tree: https://git.kernel.org/pub/scm/linux/kernel/git/dinguyen/linux.git svc_driver_updates_for_v4.20
557c4225548db670a2647
673263c09ad77be157a09 [1/6] firmware: stratix10-svc: Add support for FCS
kindly add following tag where applicable
test robot <[email protected]>
ones prefixed by >>):
ware/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
are/intel/stratix10-svc-client.h
2018-11-13 8
Carvalho Chehab 2021-01-14 9 /*
2018-11-13 10 * Service layer driver supports client names
2018-11-13 11 *
2018-11-13 12 * fpga: for FPGA configuration
2018-11-13 13 * rsu: for remote status update
2018-11-13 14 */
2018-11-13 15 #define SVC_CLIENT_FPGA "fpga"
2018-11-13 16 #define SVC_CLIENT_RSU "rsu"
2022-03-15 17 #define SVC_CLIENT_FCS "fcs"
2022-03-15 18 /**
2018-11-13 @19 * Status of the sent command, in bit number
2018-11-13 20 *
2020-04-14 21 * SVC_STATUS_OK:
2020-04-14 22 * Secure firmware accepts the request issued by one of service clients.
2018-11-13 23 *
2020-04-14 24 * SVC_STATUS_BUFFER_SUBMITTED:
2020-04-14 25 * Service client successfully submits data buffer to secure firmware.
2018-11-13 26 *
2020-04-14 27 * SVC_STATUS_BUFFER_DONE:
2018-11-13 28 * Secure firmware completes data process, ready to accept the
2018-11-13 29 * next WRITE transaction.
2018-11-13 30 *
2020-04-14 31 * SVC_STATUS_COMPLETED:
2020-04-14 32 * Secure firmware completes service request successfully. In case of
2020-04-14 33 * FPGA configuration, FPGA should be in user mode.
2018-11-13 34 *
2020-04-14 35 * SVC_COMMAND_STATUS_BUSY:
2020-04-14 36 * Service request is still in process.
2018-11-13 37 *
2020-04-14 38 * SVC_COMMAND_STATUS_ERROR:
2020-04-14 39 * Error encountered during the process of the service request.
2018-11-13 40 *
2020-04-14 41 * SVC_STATUS_NO_SUPPORT:
2020-04-14 42 * Secure firmware doesn't support requested features such as RSU retry
2020-04-14 43 * or RSU notify.
2018-11-13 44 */
2020-04-14 45 #define SVC_STATUS_OK 0
2020-04-14 46 #define SVC_STATUS_BUFFER_SUBMITTED 1
2020-04-14 47 #define SVC_STATUS_BUFFER_DONE 2
2020-04-14 48 #define SVC_STATUS_COMPLETED 3
2020-04-14 49 #define SVC_STATUS_BUSY 4
2020-04-14 50 #define SVC_STATUS_ERROR 5
2020-04-14 51 #define SVC_STATUS_NO_SUPPORT 6
2019-11-04 52
line 19 was first introduced by commit
0b27d168269e5ab74951 firmware: add Intel Stratix10 service layer driver
Gong <[email protected]>
<[email protected]>
p">https://01.org/lkp

2022-06-12 06:41:24

by Bagas Sanjaya

[permalink] [raw]

Subject: [PATCH] firmware: stratix10-svc: remove extraneous asterisk from #define comments

kernel test robot reported kernel-doc warning:

>> 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

The warning above is because comments above #define statements are prefixed
with double asterisk, which kernel-doc script mistook these as actual
kernel-doc comment.

Remove extraneouse asterisk from these comments.

Link: https://lore.kernel.org/lkml/[email protected]/
Fixes: 88f42ac48b8968 ("firmware: stratix10-svc: Add support for FCS")
Reported-by: kernel test robot <[email protected]>
Cc: Ang Tien Sung <[email protected]>
Cc: Richard Gong <[email protected]>
Cc: Dinh Nguyen <[email protected]>
Cc: [email protected]
Signed-off-by: Bagas Sanjaya <[email protected]>
---
include/linux/firmware/intel/stratix10-svc-client.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h
index 5098dbba138d0f..63927aba0b5699 100644
--- a/include/linux/firmware/intel/stratix10-svc-client.h
+++ b/include/linux/firmware/intel/stratix10-svc-client.h
@@ -15,7 +15,7 @@
#define SVC_CLIENT_FPGA "fpga"
#define SVC_CLIENT_RSU "rsu"
#define SVC_CLIENT_FCS "fcs"
-/**
+/*
* Status of the sent command, in bit number
*
* SVC_STATUS_OK:
@@ -50,7 +50,7 @@
#define SVC_STATUS_ERROR 5
#define SVC_STATUS_NO_SUPPORT 6
#define SVC_STATUS_INVALID_PARAM 7
-/**
+/*
* Flag bit for COMMAND_RECONFIG
*
* COMMAND_RECONFIG_FLAG_PARTIAL:

base-commit: 107da326a0a3e7b6e81557c4225548db670a2647
--
An old man doll... just what I always wanted! - Clara

2022-06-12 12:52:45

by Randy Dunlap

[permalink] [raw]

Subject: Re: [PATCH] firmware: stratix10-svc: remove extraneous asterisk from #define comments

Hi,

On 6/11/22 18:22, Bagas Sanjaya wrote:
> kernel test robot reported kernel-doc warning:
>
>>> 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
>
> The warning above is because comments above #define statements are prefixed
> with double asterisk, which kernel-doc script mistook these as actual
> kernel-doc comment.
>
> Remove extraneouse asterisk from these comments.

extraneous

>
> Link: https://lore.kernel.org/lkml/[email protected]/
> Fixes: 88f42ac48b8968 ("firmware: stratix10-svc: Add support for FCS")
> Reported-by: kernel test robot <[email protected]>
> Cc: Ang Tien Sung <[email protected]>
> Cc: Richard Gong <[email protected]>
> Cc: Dinh Nguyen <[email protected]>
> Cc: [email protected]
> Signed-off-by: Bagas Sanjaya <[email protected]>

Acked-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> include/linux/firmware/intel/stratix10-svc-client.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h
> index 5098dbba138d0f..63927aba0b5699 100644
> --- a/include/linux/firmware/intel/stratix10-svc-client.h
> +++ b/include/linux/firmware/intel/stratix10-svc-client.h
> @@ -15,7 +15,7 @@
> #define SVC_CLIENT_FPGA "fpga"
> #define SVC_CLIENT_RSU "rsu"
> #define SVC_CLIENT_FCS "fcs"
> -/**
> +/*
> * Status of the sent command, in bit number
> *
> * SVC_STATUS_OK:
> @@ -50,7 +50,7 @@
> #define SVC_STATUS_ERROR 5
> #define SVC_STATUS_NO_SUPPORT 6
> #define SVC_STATUS_INVALID_PARAM 7
> -/**
> +/*
> * Flag bit for COMMAND_RECONFIG
> *
> * COMMAND_RECONFIG_FLAG_PARTIAL:
>
> base-commit: 107da326a0a3e7b6e81557c4225548db670a2647

--
~Randy

2022-06-13 18:36:46

by Dinh Nguyen

[permalink] [raw]

Subject: Re: [PATCH] firmware: stratix10-svc: remove extraneous asterisk from #define comments

On 6/11/22 20:31, Randy Dunlap wrote:
> Hi,
>
> On 6/11/22 18:22, Bagas Sanjaya wrote:
>> kernel test robot reported kernel-doc warning:
>>
>>>> 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
>>
>> The warning above is because comments above #define statements are prefixed
>> with double asterisk, which kernel-doc script mistook these as actual
>> kernel-doc comment.
>>
>> Remove extraneouse asterisk from these comments.
>
> extraneous
>
>>
>> Link: https://lore.kernel.org/lkml/[email protected]/
>> Fixes: 88f42ac48b8968 ("firmware: stratix10-svc: Add support for FCS")
>> Reported-by: kernel test robot <[email protected]>
>> Cc: Ang Tien Sung <[email protected]>
>> Cc: Richard Gong <[email protected]>
>> Cc: Dinh Nguyen <[email protected]>
>> Cc: [email protected]
>> Signed-off-by: Bagas Sanjaya <[email protected]>
>
> Acked-by: Randy Dunlap <[email protected]>
>
> Thanks.
>
>> ---
>> include/linux/firmware/intel/stratix10-svc-client.h | 4 ++--
>> 1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h
>> index 5098dbba138d0f..63927aba0b5699 100644
>> --- a/include/linux/firmware/intel/stratix10-svc-client.h
>> +++ b/include/linux/firmware/intel/stratix10-svc-client.h
>> @@ -15,7 +15,7 @@
>> #define SVC_CLIENT_FPGA "fpga"
>> #define SVC_CLIENT_RSU "rsu"
>> #define SVC_CLIENT_FCS "fcs"
>> -/**
>> +/*
>> * Status of the sent command, in bit number
>> *
>> * SVC_STATUS_OK:
>> @@ -50,7 +50,7 @@
>> #define SVC_STATUS_ERROR 5
>> #define SVC_STATUS_NO_SUPPORT 6
>> #define SVC_STATUS_INVALID_PARAM 7
>> -/**
>> +/*
>> * Flag bit for COMMAND_RECONFIG
>> *
>> * COMMAND_RECONFIG_FLAG_PARTIAL:
>>
>> base-commit: 107da326a0a3e7b6e81557c4225548db670a2647
>

Applied!

Thanks,
Dinh