Re: [PATCH 04/20] misc: habanalabs: pci: Fix a variety of kerneldoc issues

[Oded Gabbay]

On Mon, Jun 29, 2020 at 5:04 PM Lee Jones <lee.jones@xxxxxxxxxx> wrote:
>
> hl_pci_bars_map() has a miss-typed argument name in the function
> description.  hl_pci_elbi_write() was missing documented arguments.
> The headers for functions hl_pci_bars_unmap(), hl_pci_elbi_write()
> and hl_pci_reset_link_through_bridge() were written in kerneldoc
> format, but lack the kerneldoc identifier '/**'.  Let's promote
> them so they can gain access to the checker.
>
> These changes fix the following W=1 kernel build warnings:
>
>  drivers/misc/habanalabs/pci.c:27: warning: Function parameter or member 'name' not described in 'hl_pci_bars_map'
>  drivers/misc/habanalabs/pci.c:27: warning: Excess function parameter 'bar_name' description in 'hl_pci_bars_map'
>  drivers/misc/habanalabs/pci.c:147: warning: Function parameter or member 'addr' not described in 'hl_pci_iatu_write'
>  drivers/misc/habanalabs/pci.c:147: warning: Function parameter or member 'data' not described in 'hl_pci_iatu_write'
>  drivers/misc/habanalabs/pci.c:324: warning: Excess function parameter 'dma_mask' description in 'hl_pci_set_dma_mask'
>
> Cc: Oded Gabbay <oded.gabbay@xxxxxxxxx>
> Cc: Tomer Tayar <ttayar@xxxxxxxxx>
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> ---
>  drivers/misc/habanalabs/pci.c | 12 ++++++++----
>  1 file changed, 8 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/misc/habanalabs/pci.c b/drivers/misc/habanalabs/pci.c
> index 9f634ef6f5b37..24073e8eb8df9 100644
> --- a/drivers/misc/habanalabs/pci.c
> +++ b/drivers/misc/habanalabs/pci.c
> @@ -15,7 +15,7 @@
>  /**
>   * hl_pci_bars_map() - Map PCI BARs.
>   * @hdev: Pointer to hl_device structure.
> - * @bar_name: Array of BAR names.
> + * @name: Array of BAR names.
>   * @is_wc: Array with flag per BAR whether a write-combined mapping is needed.
>   *
>   * Request PCI regions and map them to kernel virtual addresses.
> @@ -61,7 +61,7 @@ int hl_pci_bars_map(struct hl_device *hdev, const char * const name[3],
>         return rc;
>  }
>
> -/*
> +/**
>   * hl_pci_bars_unmap() - Unmap PCI BARS.
>   * @hdev: Pointer to hl_device structure.
>   *
> @@ -80,9 +80,11 @@ static void hl_pci_bars_unmap(struct hl_device *hdev)
>         pci_release_regions(pdev);
>  }
>
> -/*
> +/**
>   * hl_pci_elbi_write() - Write through the ELBI interface.
>   * @hdev: Pointer to hl_device structure.
> + * @addr: Address to write to
> + * @data: Data to write
>   *
>   * Return: 0 on success, negative value for failure.
>   */
> @@ -140,6 +142,8 @@ static int hl_pci_elbi_write(struct hl_device *hdev, u64 addr, u32 data)
>  /**
>   * hl_pci_iatu_write() - iatu write routine.
>   * @hdev: Pointer to hl_device structure.
> + * @addr: Address to write to
> + * @data: Data to write
>   *
>   * Return: 0 on success, negative value for failure.
>   */
> @@ -161,7 +165,7 @@ int hl_pci_iatu_write(struct hl_device *hdev, u32 addr, u32 data)
>         return 0;
>  }
>
> -/*
> +/**
>   * hl_pci_reset_link_through_bridge() - Reset PCI link.
>   * @hdev: Pointer to hl_device structure.
>   */
> --
> 2.25.1
>

This patch is:
Reviewed-by: Oded Gabbay <oded.gabbay@xxxxxxxxx>