[PATCH] drm/amdgpu: Fix correct parameter desc for VCN idle check functions

[Alex Deucher]

On Mon, Feb 24, 2025 at 7:24 AM Srinivasan Shanmugam
<srinivasan.shanmugam at amd.com> wrote:
>
> Fixes the kdoc for the following VCN idle check functions by updating
> the parameter description from 'handle' to 'ip_block':
>
> - vcn_v4_0_is_idle
> - vcn_v4_0_3_is_idle
> - vcn_v4_0_5_is_idle
> - vcn_v5_0_1_is_idle
>
> Fixes the below with gcc W=1:
> drivers/gpu/drm/amd/amdgpu/vcn_v5_0_1.c:935: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v5_0_1_is_idle'
> drivers/gpu/drm/amd/amdgpu/vcn_v5_0_1.c:935: warning: Excess function parameter 'handle' description in 'vcn_v5_0_1_is_idle'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c:1972: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v4_0_is_idle'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c:1972: warning: Excess function parameter 'handle' description in 'vcn_v4_0_is_idle'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c:1583: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v4_0_3_is_idle'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c:1583: warning: Excess function parameter 'handle' description in 'vcn_v4_0_3_is_idle'
> drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c:1200: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v5_0_0_is_idle'
> drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c:1200: warning: Excess function parameter 'handle' description in 'vcn_v5_0_0_is_idle'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c:1460: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v4_0_5_is_idle'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c:1460: warning: Excess function parameter 'handle' description in 'vcn_v4_0_5_is_idle'
>
> 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>

Reviewed-by: Alex Deucher <alexander.deucher at amd.com>

> ---
>  drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c   | 2 +-
>  drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c | 2 +-
>  drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c | 2 +-
>  drivers/gpu/drm/amd/amdgpu/vcn_v5_0_1.c | 2 +-
>  4 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c
> index fe539f7957f0..0dd844243531 100644
> --- a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c
> +++ b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c
> @@ -1964,7 +1964,7 @@ static void vcn_v4_0_set_unified_ring_funcs(struct amdgpu_device *adev)
>  /**
>   * vcn_v4_0_is_idle - check VCN block is idle
>   *
> - * @handle: amdgpu_device pointer
> + * @ip_block: Pointer to the amdgpu_ip_block structure
>   *
>   * Check whether VCN block is idle
>   */
> diff --git a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c
> index dda5ee187948..c936bd08963e 100644
> --- a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c
> +++ b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c
> @@ -1575,7 +1575,7 @@ static void vcn_v4_0_3_set_unified_ring_funcs(struct amdgpu_device *adev)
>  /**
>   * vcn_v4_0_3_is_idle - check VCN block is idle
>   *
> - * @handle: amdgpu_device pointer
> + * @ip_block: Pointer to the amdgpu_ip_block structure
>   *
>   * Check whether VCN block is idle
>   */
> diff --git a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c
> index a482658cbf86..5e6ad825cc47 100644
> --- a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c
> +++ b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c
> @@ -1452,7 +1452,7 @@ static void vcn_v4_0_5_set_unified_ring_funcs(struct amdgpu_device *adev)
>  /**
>   * vcn_v4_0_5_is_idle - check VCN block is idle
>   *
> - * @handle: amdgpu_device pointer
> + * @ip_block: Pointer to the amdgpu_ip_block structure
>   *
>   * Check whether VCN block is idle
>   */
> diff --git a/drivers/gpu/drm/amd/amdgpu/vcn_v5_0_1.c b/drivers/gpu/drm/amd/amdgpu/vcn_v5_0_1.c
> index 721c29f52451..40f36c9a4132 100644
> --- a/drivers/gpu/drm/amd/amdgpu/vcn_v5_0_1.c
> +++ b/drivers/gpu/drm/amd/amdgpu/vcn_v5_0_1.c
> @@ -927,7 +927,7 @@ static void vcn_v5_0_1_set_unified_ring_funcs(struct amdgpu_device *adev)
>  /**
>   * vcn_v5_0_1_is_idle - check VCN block is idle
>   *
> - * @handle: amdgpu_device pointer
> + * @ip_block: Pointer to the amdgpu_ip_block structure
>   *
>   * Check whether VCN block is idle
>   */
> --
> 2.34.1
>