[PATCH] drm/amdkfd: Fix kdoc entry for 'get_wave_count()' function parameters

[Joshi, Mukul]

[AMD Official Use Only - AMD Internal Distribution Only]

With the description updated below, this patch is
Reviewed-by: Mukul Joshi <mukul.joshi at amd.com>

> -----Original Message-----
> From: amd-gfx <amd-gfx-bounces at lists.freedesktop.org> On Behalf Of
> Srinivasan Shanmugam
> Sent: Wednesday, September 25, 2024 11:00 AM
> To: Koenig, Christian <Christian.Koenig at amd.com>; Deucher, Alexander
> <Alexander.Deucher at amd.com>
> Cc: amd-gfx at lists.freedesktop.org; SHANMUGAM, SRINIVASAN
> <SRINIVASAN.SHANMUGAM at amd.com>; Errabolu, Ramesh
> <Ramesh.Errabolu at amd.com>; Kasiviswanathan, Harish
> <Harish.Kasiviswanathan at amd.com>; Kuehling, Felix
> <Felix.Kuehling at amd.com>
> Subject: [PATCH] drm/amdkfd: Fix kdoc entry for 'get_wave_count()' function
> parameters
>
> Caution: This message originated from an External Source. Use proper caution
> when opening attachments, clicking links, or responding.
>
>
> Update kdoc entries to reflect the function's parameters. The descriptor for
> the 'queue_cnt' parameter has been added, and the incorrect mentions of
> 'wave_cnt' and 'vmid', which are not parameters but local variables, have been
> removed.
>
> Fixes the below with gcc W=1:
> drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c:954: warning:
> Function parameter or struct member 'queue_cnt' not described in
> 'get_wave_count'
> drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c:954: warning:
> Excess function parameter 'wave_cnt' description in 'get_wave_count'
> drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c:954: warning:
> Excess function parameter 'vmid' description in 'get_wave_count'
>
> Cc: Ramesh Errabolu <Ramesh.Errabolu at amd.com>
> Cc: Harish Kasiviswanathan <Harish.Kasiviswanathan at amd.com>
> Cc: Felix Kuehling <felix.kuehling at amd.com>
> Cc: Christian König <christian.koenig at amd.com>
> Cc: Alex Deucher <alexander.deucher at amd.com>
> Signed-off-by: Srinivasan Shanmugam <srinivasan.shanmugam at amd.com>
> ---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c
> b/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c
> index 3bc0cbf45bc5..5dbb042d10e1 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c
> @@ -944,9 +944,7 @@ static void unlock_spi_csq_mutexes(struct
> amdgpu_device *adev)
>   *
>   * @adev: Handle of device whose registers are to be read
>   * @queue_idx: Index of queue in the queue-map bit-field
> - * @wave_cnt: Output parameter updated with number of waves in flight
> - * @vmid: Output parameter updated with VMID of queue whose wave
> count
> - *        is being collected
> + * @queue_cnt: Stores the count of active waves and usage data

Probably better to rephrase it as: "Stores the wave count and doorbell offset for an active queue."

Thanks,
Mukul

>   * @inst: xcc's instance number on a multi-XCC setup
>   */
>  static void get_wave_count(struct amdgpu_device *adev, int queue_idx,
> --
> 2.34.1