[PATCH 07/30] drm/amd/amdgpu/amdgpu_fence: Fix some issues pertaining to function documentation

[Alex Deucher]

On Thu, Nov 12, 2020 at 2:01 PM Lee Jones <lee.jones at linaro.org> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:139: warning: Function parameter or member 'flags' not described in 'amdgpu_fence_emit'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:197: warning: Function parameter or member 'timeout' not described in 'amdgpu_fence_emit_polling'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:302: warning: Function parameter or member 't' not described in 'amdgpu_fence_fallback'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:302: warning: Excess function parameter 'work' description in 'amdgpu_fence_fallback'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:320: warning: Excess function parameter 'adev' description in 'amdgpu_fence_wait_empty'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:649: warning: Function parameter or member 'f' not described in 'amdgpu_fence_enable_signaling'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:649: warning: Excess function parameter 'fence' description in 'amdgpu_fence_enable_signaling'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:684: warning: Function parameter or member 'f' not described in 'amdgpu_fence_release'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:684: warning: Excess function parameter 'fence' description in 'amdgpu_fence_release'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:749: warning: Function parameter or member 'm' not described in 'amdgpu_debugfs_gpu_recover'
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c:749: warning: Function parameter or member 'data' not described in 'amdgpu_debugfs_gpu_recover'
>
> Cc: Alex Deucher <alexander.deucher at amd.com>
> Cc: "Christian König" <christian.koenig at amd.com>
> Cc: David Airlie <airlied at linux.ie>
> Cc: Daniel Vetter <daniel at ffwll.ch>
> Cc: Sumit Semwal <sumit.semwal at linaro.org>
> Cc: Jerome Glisse <glisse at freedesktop.org>
> Cc: amd-gfx at lists.freedesktop.org
> Cc: dri-devel at lists.freedesktop.org
> Cc: linux-media at vger.kernel.org
> Cc: linaro-mm-sig at lists.linaro.org
> Signed-off-by: Lee Jones <lee.jones at linaro.org>

Applied.  Thanks!

Alex

> ---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c
> index fe2d495d08ab0..d56f4023ebb31 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_fence.c
> @@ -130,6 +130,7 @@ static u32 amdgpu_fence_read(struct amdgpu_ring *ring)
>   *
>   * @ring: ring the fence is associated with
>   * @f: resulting fence object
> + * @flags: flags to pass into the subordinate .emit_fence() call
>   *
>   * Emits a fence command on the requested ring (all asics).
>   * Returns 0 on success, -ENOMEM on failure.
> @@ -187,6 +188,7 @@ int amdgpu_fence_emit(struct amdgpu_ring *ring, struct dma_fence **f,
>   *
>   * @ring: ring the fence is associated with
>   * @s: resulting sequence number
> + * @timeout: the timeout for waiting in usecs
>   *
>   * Emits a fence command on the requested ring (all asics).
>   * Used For polling fence.
> @@ -294,7 +296,7 @@ bool amdgpu_fence_process(struct amdgpu_ring *ring)
>  /**
>   * amdgpu_fence_fallback - fallback for hardware interrupts
>   *
> - * @work: delayed work item
> + * @t: timer context used to obtain the pointer to ring structure
>   *
>   * Checks for fence activity.
>   */
> @@ -310,7 +312,6 @@ static void amdgpu_fence_fallback(struct timer_list *t)
>  /**
>   * amdgpu_fence_wait_empty - wait for all fences to signal
>   *
> - * @adev: amdgpu device pointer
>   * @ring: ring index the fence is associated with
>   *
>   * Wait for all fences on the requested ring to signal (all asics).
> @@ -639,7 +640,7 @@ static const char *amdgpu_fence_get_timeline_name(struct dma_fence *f)
>
>  /**
>   * amdgpu_fence_enable_signaling - enable signalling on fence
> - * @fence: fence
> + * @f: fence
>   *
>   * This function is called with fence_queue lock held, and adds a callback
>   * to fence_queue that checks if this fence is signaled, and if so it
> @@ -675,7 +676,7 @@ static void amdgpu_fence_free(struct rcu_head *rcu)
>  /**
>   * amdgpu_fence_release - callback that fence can be freed
>   *
> - * @fence: fence
> + * @f: fence
>   *
>   * This function is called when the reference count becomes zero.
>   * It just RCU schedules freeing up the fence.
> @@ -740,7 +741,7 @@ static int amdgpu_debugfs_fence_info(struct seq_file *m, void *data)
>         return 0;
>  }
>
> -/**
> +/*
>   * amdgpu_debugfs_gpu_recover - manually trigger a gpu reset & recover
>   *
>   * Manually trigger a gpu reset at the next fence wait.
> --
> 2.25.1
>
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel