Commit 85b495bb authored Nov 06, 2024 by Srinivasan Shanmugam Committed by Alex Deucher Dec 10, 2024

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

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@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Srinivasan Shanmugam <srinivasan.shanmugam@amd.com>
Reviewed-by: Boyuan Zhang <Boyuan.Zhang@amd.com>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>

parent 9346e2e0

drivers/gpu/drm/amd/amdgpu/vcn_v4_0.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -2011,7 +2011,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
		@@ -2042,7 +2042,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

drivers/gpu/drm/amd/amdgpu/vcn_v4_0_3.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -1620,7 +1620,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
		@@ -1648,7 +1648,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

drivers/gpu/drm/amd/amdgpu/vcn_v4_0_5.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -1496,7 +1496,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
		@@ -1527,7 +1527,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

drivers/gpu/drm/amd/amdgpu/vcn_v5_0_0.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -1233,7 +1233,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
		@@ -1264,7 +1264,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