Re: [PATCH 31/42] drm/ttm/ttm_bo: Fix one function header - demote lots of kernel-doc abuses

From: Daniel Vetter
Date: Tue Nov 17 2020 - 14:12:09 EST

On Mon, Nov 16, 2020 at 09:33:48PM +0100, Christian König wrote:
> Am 16.11.20 um 18:41 schrieb Lee Jones:
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/gpu/drm/ttm/ttm_bo.c:51: warning: Function parameter or member 'ttm_global_mutex' not described in 'DEFINE_MUTEX'
> > drivers/gpu/drm/ttm/ttm_bo.c:286: warning: Function parameter or member 'bo' not described in 'ttm_bo_cleanup_memtype_use'
> > drivers/gpu/drm/ttm/ttm_bo.c:359: warning: Function parameter or member 'bo' not described in 'ttm_bo_cleanup_refs'
> > drivers/gpu/drm/ttm/ttm_bo.c:359: warning: Function parameter or member 'interruptible' not described in 'ttm_bo_cleanup_refs'
> > drivers/gpu/drm/ttm/ttm_bo.c:359: warning: Function parameter or member 'no_wait_gpu' not described in 'ttm_bo_cleanup_refs'
> > drivers/gpu/drm/ttm/ttm_bo.c:359: warning: Function parameter or member 'unlock_resv' not described in 'ttm_bo_cleanup_refs'
> > drivers/gpu/drm/ttm/ttm_bo.c:424: warning: Function parameter or member 'bdev' not described in 'ttm_bo_delayed_delete'
> > drivers/gpu/drm/ttm/ttm_bo.c:424: warning: Function parameter or member 'remove_all' not described in 'ttm_bo_delayed_delete'
> > drivers/gpu/drm/ttm/ttm_bo.c:635: warning: Function parameter or member 'bo' not described in 'ttm_bo_evict_swapout_allowable'
> > drivers/gpu/drm/ttm/ttm_bo.c:635: warning: Function parameter or member 'ctx' not described in 'ttm_bo_evict_swapout_allowable'
> > drivers/gpu/drm/ttm/ttm_bo.c:635: warning: Function parameter or member 'locked' not described in 'ttm_bo_evict_swapout_allowable'
> > drivers/gpu/drm/ttm/ttm_bo.c:635: warning: Function parameter or member 'busy' not described in 'ttm_bo_evict_swapout_allowable'
> > drivers/gpu/drm/ttm/ttm_bo.c:769: warning: Function parameter or member 'bo' not described in 'ttm_bo_add_move_fence'
> > drivers/gpu/drm/ttm/ttm_bo.c:769: warning: Function parameter or member 'man' not described in 'ttm_bo_add_move_fence'
> > drivers/gpu/drm/ttm/ttm_bo.c:769: warning: Function parameter or member 'mem' not described in 'ttm_bo_add_move_fence'
> > drivers/gpu/drm/ttm/ttm_bo.c:769: warning: Function parameter or member 'no_wait_gpu' not described in 'ttm_bo_add_move_fence'
> > drivers/gpu/drm/ttm/ttm_bo.c:806: warning: Function parameter or member 'bo' not described in 'ttm_bo_mem_force_space'
> > drivers/gpu/drm/ttm/ttm_bo.c:806: warning: Function parameter or member 'place' not described in 'ttm_bo_mem_force_space'
> > drivers/gpu/drm/ttm/ttm_bo.c:806: warning: Function parameter or member 'mem' not described in 'ttm_bo_mem_force_space'
> > drivers/gpu/drm/ttm/ttm_bo.c:806: warning: Function parameter or member 'ctx' not described in 'ttm_bo_mem_force_space'
> > drivers/gpu/drm/ttm/ttm_bo.c:872: warning: Function parameter or member 'bo' not described in 'ttm_bo_mem_space'
> > drivers/gpu/drm/ttm/ttm_bo.c:872: warning: Function parameter or member 'placement' not described in 'ttm_bo_mem_space'
> > drivers/gpu/drm/ttm/ttm_bo.c:872: warning: Function parameter or member 'mem' not described in 'ttm_bo_mem_space'
> > drivers/gpu/drm/ttm/ttm_bo.c:872: warning: Function parameter or member 'ctx' not described in 'ttm_bo_mem_space'
> > drivers/gpu/drm/ttm/ttm_bo.c:1387: warning: Function parameter or member 'ctx' not described in 'ttm_bo_swapout'
> >
> > Cc: Christian Koenig <christian.koenig@xxxxxxx>
> > Cc: Huang Rui <ray.huang@xxxxxxx>
> > Cc: David Airlie <airlied@xxxxxxxx>
> > Cc: Daniel Vetter <daniel@xxxxxxxx>
> > Cc: Sumit Semwal <sumit.semwal@xxxxxxxxxx>
> > Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
> > Cc: linux-media@xxxxxxxxxxxxxxx
> > Cc: linaro-mm-sig@xxxxxxxxxxxxxxxx
> > Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
>
> Reviewed-by: Christian König <christian.koenig@xxxxxxx>
>
> Going to pick that one up for upstreaming.

I mass applied this pile, so also this one. Thanks for patch&review.
-Daniel

>
> Thanks,
> Christian.
>
> > ---
> > drivers/gpu/drm/ttm/ttm_bo.c | 23 ++++++++++++-----------
> > 1 file changed, 12 insertions(+), 11 deletions(-)
> >
> > diff --git a/drivers/gpu/drm/ttm/ttm_bo.c b/drivers/gpu/drm/ttm/ttm_bo.c
> > index e6bcbfe530ecc..9a03c7834b1ed 100644
> > --- a/drivers/gpu/drm/ttm/ttm_bo.c
> > +++ b/drivers/gpu/drm/ttm/ttm_bo.c
> > @@ -45,7 +45,7 @@
> > static void ttm_bo_global_kobj_release(struct kobject *kobj);
> > -/**
> > +/*
> > * ttm_global_mutex - protecting the global BO state
> > */
> > DEFINE_MUTEX(ttm_global_mutex);
> > @@ -278,7 +278,7 @@ static int ttm_bo_handle_move_mem(struct ttm_buffer_object *bo,
> > return ret;
> > }
> > -/**
> > +/*
> > * Call bo::reserved.
> > * Will release GPU memory type usage on destruction.
> > * This is the place to put in driver specific hooks to release
> > @@ -352,9 +352,10 @@ static void ttm_bo_flush_all_fences(struct ttm_buffer_object *bo)
> > * Must be called with lru_lock and reservation held, this function
> > * will drop the lru lock and optionally the reservation lock before returning.
> > *
> > - * @interruptible Any sleeps should occur interruptibly.
> > - * @no_wait_gpu Never wait for gpu. Return -EBUSY instead.
> > - * @unlock_resv Unlock the reservation lock as well.
> > + * @bo: The buffer object to clean-up
> > + * @interruptible: Any sleeps should occur interruptibly.
> > + * @no_wait_gpu: Never wait for gpu. Return -EBUSY instead.
> > + * @unlock_resv: Unlock the reservation lock as well.
> > */
> > static int ttm_bo_cleanup_refs(struct ttm_buffer_object *bo,
> > @@ -420,7 +421,7 @@ static int ttm_bo_cleanup_refs(struct ttm_buffer_object *bo,
> > return 0;
> > }
> > -/**
> > +/*
> > * Traverse the delayed list, and call ttm_bo_cleanup_refs on all
> > * encountered buffers.
> > */
> > @@ -628,7 +629,7 @@ bool ttm_bo_eviction_valuable(struct ttm_buffer_object *bo,
> > }
> > EXPORT_SYMBOL(ttm_bo_eviction_valuable);
> > -/**
> > +/*
> > * Check the target bo is allowable to be evicted or swapout, including cases:
> > *
> > * a. if share same reservation object with ctx->resv, have assumption
> > @@ -767,7 +768,7 @@ int ttm_mem_evict_first(struct ttm_bo_device *bdev,
> > return ret;
> > }
> > -/**
> > +/*
> > * Add the last move fence to the BO and reserve a new shared slot.
> > */
> > static int ttm_bo_add_move_fence(struct ttm_buffer_object *bo,
> > @@ -803,7 +804,7 @@ static int ttm_bo_add_move_fence(struct ttm_buffer_object *bo,
> > return 0;
> > }
> > -/**
> > +/*
> > * Repeatedly evict memory from the LRU for @mem_type until we create enough
> > * space, or we've evicted everything and there isn't enough space.
> > */
> > @@ -865,7 +866,7 @@ static int ttm_bo_mem_placement(struct ttm_buffer_object *bo,
> > return 0;
> > }
> > -/**
> > +/*
> > * Creates space for memory region @mem according to its type.
> > *
> > * This function first searches for free space in compatible memory types in
> > @@ -1430,7 +1431,7 @@ int ttm_bo_wait(struct ttm_buffer_object *bo,
> > }
> > EXPORT_SYMBOL(ttm_bo_wait);
> > -/**
> > +/*
> > * A buffer object shrink method that tries to swap out the first
> > * buffer object on the bo_global::swap_lru list.
> > */
>

--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch