[PATCH] drm/amd/amdgpu/vcn: Fix kdoc entries for VCN clock/power gating functions

[Boyuan Zhang]

Reviewed-by: Boyuan Zhang <Boyuan.Zhang at amd.com>

On 2024-11-05 21:09, Srinivasan Shanmugam wrote:
> This commit corrects the descriptors for the
> vcn_v4_0/v4_0_3/v4_0_5/v5_0_0 _set_clockgating_state and
> vcn_v4_0/v4_0_3/v4_0_5/v5_0_0 _set_powergating_state functions in the
> amdgpu driver.
>
> The parameter descriptors in the comments were mismatched with the
> actual function parameters. The non-existent 'handle' parameter has been
> replaced with the correct 'ip_block' parameter in the comments to
> accurately reflect the function signatures and to resolving the below
> with gcc W=1:
>
> drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c:1232: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v5_0_0_set_clockgating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c:1232: warning: Excess function parameter 'handle' description in 'vcn_v5_0_0_set_clockgating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c:1263: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v5_0_0_set_powergating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c:1263: warning: Excess function parameter 'handle' description in 'vcn_v5_0_0_set_powergating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c:2012: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v4_0_set_clockgating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c:2012: warning: Excess function parameter 'handle' description in 'vcn_v4_0_set_clockgating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c:2043: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v4_0_set_powergating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c:2043: warning: Excess function parameter 'handle' description in 'vcn_v4_0_set_powergating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c:1505: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v4_0_5_set_clockgating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c:1505: warning: Excess function parameter 'handle' description in 'vcn_v4_0_5_set_clockgating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c:1536: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v4_0_5_set_powergating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c:1536: warning: Excess function parameter 'handle' description in 'vcn_v4_0_5_set_powergating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c:1629: warning: Function parameter or struct member 'ip_block' not described in 'vcn_v4_0_3_set_powergating_state'
> drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c:1629: warning: Excess function parameter 'handle' description in 'vcn_v4_0_3_set_powergating_state'
>
> 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/vcn_v4_0.c   | 4 ++--
>   drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c | 4 ++--
>   drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c | 4 ++--
>   drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c | 4 ++--
>   4 files changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c
> index 87c8f1c084a5..385596df47aa 100644
> --- a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c
> +++ b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c
> @@ -2002,7 +2002,7 @@ static int vcn_v4_0_wait_for_idle(struct amdgpu_ip_block *ip_block)
>   /**
>    * vcn_v4_0_set_clockgating_state - set VCN block clockgating state
>    *
> - * @handle: amdgpu_device pointer
> + * @ip_block: amdgpu_ip_block pointer
>    * @state: clock gating state
>    *
>    * Set VCN block clockgating state
> @@ -2033,7 +2033,7 @@ static int vcn_v4_0_set_clockgating_state(struct amdgpu_ip_block *ip_block,
>   /**
>    * vcn_v4_0_set_powergating_state - set VCN block powergating state
>    *
> - * @handle: amdgpu_device pointer
> + * @ip_block: amdgpu_ip_block pointer
>    * @state: power gating state
>    *
>    * Set VCN block powergating state
> 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 7b0f350d5fca..ac0e76cbaa2d 100644
> --- a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c
> +++ b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c
> @@ -1591,7 +1591,7 @@ static int vcn_v4_0_3_wait_for_idle(struct amdgpu_ip_block *ip_block)
>   
>   /* vcn_v4_0_3_set_clockgating_state - set VCN block clockgating state
>    *
> - * @handle: amdgpu_device pointer
> + * @ip_block: amdgpu_ip_block pointer
>    * @state: clock gating state
>    *
>    * Set VCN block clockgating state
> @@ -1619,7 +1619,7 @@ static int vcn_v4_0_3_set_clockgating_state(struct amdgpu_ip_block *ip_block,
>   /**
>    * vcn_v4_0_3_set_powergating_state - set VCN block powergating state
>    *
> - * @handle: amdgpu_device pointer
> + * @ip_block: amdgpu_ip_block pointer
>    * @state: power gating state
>    *
>    * Set VCN block powergating state
> 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 9c5257f370f2..98d0ee299c74 100644
> --- a/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c
> +++ b/drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c
> @@ -1495,7 +1495,7 @@ static int vcn_v4_0_5_wait_for_idle(struct amdgpu_ip_block *ip_block)
>   /**
>    * vcn_v4_0_5_set_clockgating_state - set VCN block clockgating state
>    *
> - * @handle: amdgpu_device pointer
> + * @ip_block: amdgpu_ip_block pointer
>    * @state: clock gating state
>    *
>    * Set VCN block clockgating state
> @@ -1526,7 +1526,7 @@ static int vcn_v4_0_5_set_clockgating_state(struct amdgpu_ip_block *ip_block,
>   /**
>    * vcn_v4_0_5_set_powergating_state - set VCN block powergating state
>    *
> - * @handle: amdgpu_device pointer
> + * @ip_block: amdgpu_ip_block pointer
>    * @state: power gating state
>    *
>    * Set VCN block powergating state
> diff --git a/drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c b/drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c
> index 4ecf0aea156f..9cd4d70058ea 100644
> --- a/drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c
> +++ b/drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c
> @@ -1222,7 +1222,7 @@ static int vcn_v5_0_0_wait_for_idle(struct amdgpu_ip_block *ip_block)
>   /**
>    * vcn_v5_0_0_set_clockgating_state - set VCN block clockgating state
>    *
> - * @handle: amdgpu_device pointer
> + * @ip_block: amdgpu_ip_block pointer
>    * @state: clock gating state
>    *
>    * Set VCN block clockgating state
> @@ -1253,7 +1253,7 @@ static int vcn_v5_0_0_set_clockgating_state(struct amdgpu_ip_block *ip_block,
>   /**
>    * vcn_v5_0_0_set_powergating_state - set VCN block powergating state
>    *
> - * @handle: amdgpu_device pointer
> + * @ip_block: amdgpu_ip_block pointer
>    * @state: power gating state
>    *
>    * Set VCN block powergating state
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/amd-gfx/attachments/20241106/ba07bacb/attachment.htm>