diff mbox series

[03/20] misc: habanalabs: firmware_if: Add missing 'fw_name' and 'dst' entries to function header

Message ID 20200629140442.1043957-4-lee.jones@linaro.org (mailing list archive)
State New, archived
Headers show
Series Fix a bunch more W=1 warnings in Misc | expand

Commit Message

Lee Jones June 29, 2020, 2:04 p.m. UTC
Looks as though documentation for these function arguments have
been missing since the driver's inception last year.

Fixes the following W=1 kernel build warnings:

 drivers/misc/habanalabs/firmware_if.c:26: warning: Function parameter or member 'fw_name' not described in 'hl_fw_load_fw_to_device'
 drivers/misc/habanalabs/firmware_if.c:26: warning: Function parameter or member 'dst' not described in 'hl_fw_load_fw_to_device'

Cc: Oded Gabbay <oded.gabbay@gmail.com>
Cc: Tomer Tayar <ttayar@habana.ai>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/misc/habanalabs/firmware_if.c | 3 +++
 1 file changed, 3 insertions(+)

Comments

Oded Gabbay June 29, 2020, 2:57 p.m. UTC | #1
On Mon, Jun 29, 2020 at 5:04 PM Lee Jones <lee.jones@linaro.org> wrote:
>
> Looks as though documentation for these function arguments have
> been missing since the driver's inception last year.
>
> Fixes the following W=1 kernel build warnings:
>
>  drivers/misc/habanalabs/firmware_if.c:26: warning: Function parameter or member 'fw_name' not described in 'hl_fw_load_fw_to_device'
>  drivers/misc/habanalabs/firmware_if.c:26: warning: Function parameter or member 'dst' not described in 'hl_fw_load_fw_to_device'
>
> Cc: Oded Gabbay <oded.gabbay@gmail.com>
> Cc: Tomer Tayar <ttayar@habana.ai>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  drivers/misc/habanalabs/firmware_if.c | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/drivers/misc/habanalabs/firmware_if.c b/drivers/misc/habanalabs/firmware_if.c
> index baf790cf4b787..15e0793da6554 100644
> --- a/drivers/misc/habanalabs/firmware_if.c
> +++ b/drivers/misc/habanalabs/firmware_if.c
> @@ -15,7 +15,10 @@
>
>  /**
>   * hl_fw_load_fw_to_device() - Load F/W code to device's memory.
> + *
>   * @hdev: pointer to hl_device structure.
> + * @fw_name: the firmware image name
> + * @dst: IO memory mapped address space to copy firmware to
>   *
>   * Copy fw code from firmware file to device memory.
>   *
> --
> 2.25.1
>
This patch is:
Reviewed-by: Oded Gabbay <oded.gabbay@gmail.com>
diff mbox series

Patch

diff --git a/drivers/misc/habanalabs/firmware_if.c b/drivers/misc/habanalabs/firmware_if.c
index baf790cf4b787..15e0793da6554 100644
--- a/drivers/misc/habanalabs/firmware_if.c
+++ b/drivers/misc/habanalabs/firmware_if.c
@@ -15,7 +15,10 @@ 
 
 /**
  * hl_fw_load_fw_to_device() - Load F/W code to device's memory.
+ *
  * @hdev: pointer to hl_device structure.
+ * @fw_name: the firmware image name
+ * @dst: IO memory mapped address space to copy firmware to
  *
  * Copy fw code from firmware file to device memory.
  *