[PATCH] drm/amd/amdgpu: Add missing kdoc 'inst' parameter in 'smu_dpm_set_power_gate' function

[PATCH] drm/amd/amdgpu: Add missing kdoc 'inst' parameter in 'smu_dpm_set_power_gate' function

[Srinivasan Shanmugam]

This commit adds the missing kdoc parameter descriptor for 'inst' in the
smu_dpm_set_power_gate function.

The 'inst' parameter, which specifies the instance of the IP block to
power gate/ungate.

Fixes the below with gcc W=1:
drivers/gpu/drm/amd/amdgpu/../pm/swsmu/amdgpu_smu.c:359: warning: Function parameter or struct member 'inst' not described in 'smu_dpm_set_power_gate'

Cc: Christian König <christian.koenig@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Srinivasan Shanmugam <srinivasan.shanmugam@amd.com>
---
 drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c b/drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c
index d08c61cddede..0a82fd5a8cbb 100644
--- a/drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c
+++ b/drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c
@@ -342,8 +342,9 @@ static int smu_set_mall_enable(struct smu_context *smu)
  * smu_dpm_set_power_gate - power gate/ungate the specific IP block
  *
  * @handle:        smu_context pointer
- * @block_type: the IP block to power gate/ungate
- * @gate:       to power gate if true, ungate otherwise
+ * @block_type:    the IP block to power gate/ungate
+ * @gate:          to power gate if true, ungate otherwise
+ * @inst:          the instance of the IP block to power gate/ungate
  *
  * This API uses no smu->mutex lock protection due to:
  * 1. It is either called by other IP block(gfx/sdma/vcn/uvd/vce).
-- 
2.34.1

Re: [PATCH] drm/amd/amdgpu: Add missing kdoc 'inst' parameter in 'smu_dpm_set_power_gate' function

[Boyuan Zhang]

[-- Attachment #1: Type: text/plain, Size: 1653 bytes --]

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

On 2024-11-05 21:16, Srinivasan Shanmugam wrote:
> This commit adds the missing kdoc parameter descriptor for 'inst' in the
> smu_dpm_set_power_gate function.
>
> The 'inst' parameter, which specifies the instance of the IP block to
> power gate/ungate.
>
> Fixes the below with gcc W=1:
> drivers/gpu/drm/amd/amdgpu/../pm/swsmu/amdgpu_smu.c:359: warning: Function parameter or struct member 'inst' not described in 'smu_dpm_set_power_gate'
>
> Cc: Christian König<christian.koenig@amd.com>
> Cc: Alex Deucher<alexander.deucher@amd.com>
> Signed-off-by: Srinivasan Shanmugam<srinivasan.shanmugam@amd.com>
> ---
>   drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c | 5 +++--
>   1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c b/drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c
> index d08c61cddede..0a82fd5a8cbb 100644
> --- a/drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c
> +++ b/drivers/gpu/drm/amd/pm/swsmu/amdgpu_smu.c
> @@ -342,8 +342,9 @@ static int smu_set_mall_enable(struct smu_context *smu)
>    * smu_dpm_set_power_gate - power gate/ungate the specific IP block
>    *
>    * @handle:        smu_context pointer
> - * @block_type: the IP block to power gate/ungate
> - * @gate:       to power gate if true, ungate otherwise
> + * @block_type:    the IP block to power gate/ungate
> + * @gate:          to power gate if true, ungate otherwise
> + * @inst:          the instance of the IP block to power gate/ungate
>    *
>    * This API uses no smu->mutex lock protection due to:
>    * 1. It is either called by other IP block(gfx/sdma/vcn/uvd/vce).

[-- Attachment #2: Type: text/html, Size: 2583 bytes --]