[PATCH] drm/amdgpu: Fix up kdoc in sdma_v4_4_2.c

[Alex Deucher]

On Thu, May 25, 2023 at 1:08 PM Srinivasan Shanmugam
<srinivasan.shanmugam at amd.com> wrote:
>
> Address a bunch of kdoc warnings:
>
> gcc with W=1
> drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c:426: warning: Function parameter or member 'inst_mask' not described in 'sdma_v4_4_2_inst_gfx_stop'
> drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c:457: warning: Function parameter or member 'inst_mask' not described in 'sdma_v4_4_2_inst_rlc_stop'
> drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c:470: warning: Function parameter or member 'inst_mask' not described in 'sdma_v4_4_2_inst_page_stop'
> drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c:506: warning: Function parameter or member 'inst_mask' not described in 'sdma_v4_4_2_inst_ctx_switch_enable'
> drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c:794: warning: Function parameter or member 'inst_mask' not described in 'sdma_v4_4_2_inst_rlc_resume'
> drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c:810: warning: Function parameter or member 'inst_mask' not described in 'sdma_v4_4_2_inst_load_microcode'
> drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c:854: warning: Function parameter or member 'inst_mask' not described in 'sdma_v4_4_2_inst_start'

I thought someone already landed a patch for this.  If not,

Reviewed-by: Alex Deucher <alexander.deucher 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/sdma_v4_4_2.c | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c b/drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c
> index ff41fb577cdd..8eebf9c2bbcd 100644
> --- a/drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c
> +++ b/drivers/gpu/drm/amd/amdgpu/sdma_v4_4_2.c
> @@ -418,6 +418,7 @@ static void sdma_v4_4_2_ring_emit_fence(struct amdgpu_ring *ring, u64 addr, u64
>   * sdma_v4_4_2_inst_gfx_stop - stop the gfx async dma engines
>   *
>   * @adev: amdgpu_device pointer
> + * @inst_mask: mask of dma engine instances to be disabled
>   *
>   * Stop the gfx async dma ring buffers.
>   */
> @@ -449,6 +450,7 @@ static void sdma_v4_4_2_inst_gfx_stop(struct amdgpu_device *adev,
>   * sdma_v4_4_2_inst_rlc_stop - stop the compute async dma engines
>   *
>   * @adev: amdgpu_device pointer
> + * @inst_mask: mask of dma engine instances to be disabled
>   *
>   * Stop the compute async dma queues.
>   */
> @@ -462,6 +464,7 @@ static void sdma_v4_4_2_inst_rlc_stop(struct amdgpu_device *adev,
>   * sdma_v4_4_2_inst_page_stop - stop the page async dma engines
>   *
>   * @adev: amdgpu_device pointer
> + * @inst_mask: mask of dma engine instances to be disabled
>   *
>   * Stop the page async dma ring buffers.
>   */
> @@ -498,6 +501,7 @@ static void sdma_v4_4_2_inst_page_stop(struct amdgpu_device *adev,
>   *
>   * @adev: amdgpu_device pointer
>   * @enable: enable/disable the DMA MEs context switch.
> + * @inst_mask: mask of dma engine instances to be enabled
>   *
>   * Halt or unhalt the async dma engines context switch.
>   */
> @@ -785,6 +789,7 @@ static void sdma_v4_4_2_init_pg(struct amdgpu_device *adev)
>   * sdma_v4_4_2_inst_rlc_resume - setup and start the async dma engines
>   *
>   * @adev: amdgpu_device pointer
> + * @inst_mask: mask of dma engine instances to be enabled
>   *
>   * Set up the compute DMA queues and enable them.
>   * Returns 0 for success, error for failure.
> @@ -801,6 +806,7 @@ static int sdma_v4_4_2_inst_rlc_resume(struct amdgpu_device *adev,
>   * sdma_v4_4_2_inst_load_microcode - load the sDMA ME ucode
>   *
>   * @adev: amdgpu_device pointer
> + * @inst_mask: mask of dma engine instances to be enabled
>   *
>   * Loads the sDMA0/1 ucode.
>   * Returns 0 for success, -EINVAL if the ucode is not available.
> @@ -845,6 +851,7 @@ static int sdma_v4_4_2_inst_load_microcode(struct amdgpu_device *adev,
>   * sdma_v4_4_2_inst_start - setup and start the async dma engines
>   *
>   * @adev: amdgpu_device pointer
> + * @inst_mask: mask of dma engine instances to be enabled
>   *
>   * Set up the DMA engines and enable them.
>   * Returns 0 for success, error for failure.
> --
> 2.25.1
>