[Intel-gfx] [PATCH v2 12/39] drm/i915: gem: add kernel-doc description for some function parameters

[Das, Nirmoy]

|Reviewed-by: Nirmoy Das <nirmoy.das at intel.com>|

On 7/13/2022 10:12 AM, Mauro Carvalho Chehab wrote:
> There are some parameters missing at the kernel-doc markups on
> some gem files. Some of those are trivial enough to be added.
>
> Document them.
>
> Signed-off-by: Mauro Carvalho Chehab<mchehab at kernel.org>
> ---
>
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v2 00/39] at:https://lore.kernel.org/all/cover.1657699522.git.mchehab@kernel.org/
>
>   drivers/gpu/drm/i915/gem/i915_gem_object.c   | 2 ++
>   drivers/gpu/drm/i915/gem/i915_gem_ttm.h      | 1 +
>   drivers/gpu/drm/i915/gem/i915_gem_ttm_move.c | 2 ++
>   3 files changed, 5 insertions(+)
>
> diff --git a/drivers/gpu/drm/i915/gem/i915_gem_object.c b/drivers/gpu/drm/i915/gem/i915_gem_object.c
> index ccec4055fde3..b5dd43405355 100644
> --- a/drivers/gpu/drm/i915/gem/i915_gem_object.c
> +++ b/drivers/gpu/drm/i915/gem/i915_gem_object.c
> @@ -820,6 +820,8 @@ int i915_gem_object_wait_moving_fence(struct drm_i915_gem_object *obj,
>    * in an unknown_state. This means that userspace must NEVER be allowed to touch
>    * the pages, with either the GPU or CPU.
>    *
> + * @obj: The object to check its state.
> + *
>    * ONLY valid to be called after ensuring that all kernel fences have signalled
>    * (in particular the fence for moving/clearing the object).
>    */
> diff --git a/drivers/gpu/drm/i915/gem/i915_gem_ttm.h b/drivers/gpu/drm/i915/gem/i915_gem_ttm.h
> index e4842b4296fc..64151f40098f 100644
> --- a/drivers/gpu/drm/i915/gem/i915_gem_ttm.h
> +++ b/drivers/gpu/drm/i915/gem/i915_gem_ttm.h
> @@ -30,6 +30,7 @@ void i915_ttm_bo_destroy(struct ttm_buffer_object *bo);
>   /**
>    * i915_ttm_to_gem - Convert a struct ttm_buffer_object to an embedding
>    * struct drm_i915_gem_object.
> + * @bo: The ttm buffer object.
>    *
>    * Return: Pointer to the embedding struct ttm_buffer_object, or NULL
>    * if the object was not an i915 ttm object.
> diff --git a/drivers/gpu/drm/i915/gem/i915_gem_ttm_move.c b/drivers/gpu/drm/i915/gem/i915_gem_ttm_move.c
> index 9a7e50534b84..56217d324a9b 100644
> --- a/drivers/gpu/drm/i915/gem/i915_gem_ttm_move.c
> +++ b/drivers/gpu/drm/i915/gem/i915_gem_ttm_move.c
> @@ -237,6 +237,7 @@ static struct dma_fence *i915_ttm_accel_move(struct ttm_buffer_object *bo,
>    * @_src_iter: Storage space for the source kmap iterator.
>    * @dst_iter: Pointer to the destination kmap iterator.
>    * @src_iter: Pointer to the source kmap iterator.
> + * @num_pages: Number of pages to copy or to be cleared.
>    * @clear: Whether to clear instead of copy.
>    * @src_rsgt: Refcounted scatter-gather list of source memory.
>    * @dst_rsgt: Refcounted scatter-gather list of destination memory.
> @@ -541,6 +542,7 @@ __i915_ttm_move(struct ttm_buffer_object *bo,
>    * i915_ttm_move - The TTM move callback used by i915.
>    * @bo: The buffer object.
>    * @evict: Whether this is an eviction.
> + * @ctx: Pointer to a struct ttm_operation_ctx
>    * @dst_mem: The destination ttm resource.
>    * @hop: If we need multihop, what temporary memory type to move to.
>    *
Intel Deutschland GmbH
Registered Address: Am Campeon 10, 85579 Neubiberg, Germany
Tel: +49 89 99 8853-0, www.intel.de <http://www.intel.de>
Managing Directors: Christin Eisenschmid, Sharon Heck, Tiffany Doon Silva  
Chairperson of the Supervisory Board: Nicole Lau
Registered Office: Munich
Commercial Register: Amtsgericht Muenchen HRB 186928
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/intel-gfx/attachments/20220713/2f652756/attachment-0001.htm>