2023-05-12 06:56:19

by Yang Li

Subject: [PATCH -next] habanalabs: Fix some kernel-doc comments

Make the description of @regs_range_array and @regs_range_array_size
to @user_regs_range_array and @user_regs_range_array_size to silence
the warnings:

drivers/accel/habanalabs/common/security.c:506: warning: Function parameter or member 'user_regs_range_array' not described in 'hl_init_pb_ranges_single_dcore'
drivers/accel/habanalabs/common/security.c:506: warning: Function parameter or member 'user_regs_range_array_size' not described in 'hl_init_pb_ranges_single_dcore'
drivers/accel/habanalabs/common/security.c:506: warning: Excess function parameter 'regs_range_array' description in 'hl_init_pb_ranges_single_dcore'
drivers/accel/habanalabs/common/security.c:506: warning: Excess function parameter 'regs_range_array_size' description in 'hl_init_pb_ranges_single_dcore'

Reported-by: Abaci Robot <[email protected]>
Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=4940
Signed-off-by: Yang Li <[email protected]>
---
drivers/accel/habanalabs/common/security.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/accel/habanalabs/common/security.c b/drivers/accel/habanalabs/common/security.c
index 297e6e44fd0c..dc23ff57c91a 100644
--- a/drivers/accel/habanalabs/common/security.c
+++ b/drivers/accel/habanalabs/common/security.c
@@ -495,8 +495,8 @@ int hl_init_pb_single_dcore(struct hl_device *hdev, u32 dcore_offset,
* @instance_offset: offset between instances
* @pb_blocks: blocks array
* @blocks_array_size: blocks array size
- * @regs_range_array: register range array
- * @regs_range_array_size: register range array size
+ * @user_regs_range_array: register range array
+ * @user_regs_range_array_size: register range array size
*
*/
int hl_init_pb_ranges_single_dcore(struct hl_device *hdev, u32 dcore_offset,
--
2.20.1.7.g153144c

2023-05-16 06:54:00

by Oded Gabbay

Subject: Re: [PATCH -next] habanalabs: Fix some kernel-doc comments

On Fri, May 12, 2023 at 9:47 AM Yang Li <[email protected]> wrote:
>
> Make the description of @regs_range_array and @regs_range_array_size
> to @user_regs_range_array and @user_regs_range_array_size to silence
> the warnings:
>
> drivers/accel/habanalabs/common/security.c:506: warning: Function parameter or member 'user_regs_range_array' not described in 'hl_init_pb_ranges_single_dcore'
> drivers/accel/habanalabs/common/security.c:506: warning: Function parameter or member 'user_regs_range_array_size' not described in 'hl_init_pb_ranges_single_dcore'
> drivers/accel/habanalabs/common/security.c:506: warning: Excess function parameter 'regs_range_array' description in 'hl_init_pb_ranges_single_dcore'
> drivers/accel/habanalabs/common/security.c:506: warning: Excess function parameter 'regs_range_array_size' description in 'hl_init_pb_ranges_single_dcore'
>
> Reported-by: Abaci Robot <[email protected]>
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=4940
> Signed-off-by: Yang Li <[email protected]>
> ---
> drivers/accel/habanalabs/common/security.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/accel/habanalabs/common/security.c b/drivers/accel/habanalabs/common/security.c
> index 297e6e44fd0c..dc23ff57c91a 100644
> --- a/drivers/accel/habanalabs/common/security.c
> +++ b/drivers/accel/habanalabs/common/security.c
> @@ -495,8 +495,8 @@ int hl_init_pb_single_dcore(struct hl_device *hdev, u32 dcore_offset,
> * @instance_offset: offset between instances
> * @pb_blocks: blocks array
> * @blocks_array_size: blocks array size
> - * @regs_range_array: register range array
> - * @regs_range_array_size: register range array size
> + * @user_regs_range_array: register range array
> + * @user_regs_range_array_size: register range array size
> *
> */
> int hl_init_pb_ranges_single_dcore(struct hl_device *hdev, u32 dcore_offset,
> --
> 2.20.1.7.g153144c
>
Reviewed-by: Oded Gabbay <[email protected]>
Applied to -next.
Thanks,
Oded