[PATCH] drm/ttm_bo_api: update the description for @placement and @sg

[PATCH] drm/ttm_bo_api: update the description for @placement and @sg

[Amos Kong]

Correct the argument name of @placement and added @sg description for
ttm_bo_init() and ttm_bo_init_reserved().

Argument @flags was replaced to @placement by Jerome in commit
09855acb1c2e3779f25317ec9a8ffe1b1784a4a8

Argument @sg was added by Dave in commit
129b78bfca591e736e56a294f0e357d73d938f7e

Signed-off-by: Amos Kong <amos@sietium.com>
Cc: Jerome Glisse <jglisse@redhat.com>
Cc: Dave Airlie <airlied@redhat.com>
---
 include/drm/ttm/ttm_bo_api.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/drm/ttm/ttm_bo_api.h b/include/drm/ttm/ttm_bo_api.h
index f681bbdbc698..eb27bbee9888 100644
--- a/include/drm/ttm/ttm_bo_api.h
+++ b/include/drm/ttm/ttm_bo_api.h
@@ -363,9 +363,10 @@ bool ttm_bo_eviction_valuable(struct ttm_buffer_object *bo,
  * @bo: Pointer to a ttm_buffer_object to be initialized.
  * @size: Requested size of buffer object.
  * @type: Requested type of buffer object.
- * @flags: Initial placement flags.
+ * @placement: Initial placement for buffer object.
  * @page_alignment: Data alignment in pages.
  * @ctx: TTM operation context for memory allocation.
+ * @sg: Scatter-gather table.
  * @resv: Pointer to a dma_resv, or NULL to let ttm allocate one.
  * @destroy: Destroy function. Use NULL for kfree().
  *
@@ -406,7 +407,7 @@ int ttm_bo_init_reserved(struct ttm_device *bdev,
  * @bo: Pointer to a ttm_buffer_object to be initialized.
  * @size: Requested size of buffer object.
  * @type: Requested type of buffer object.
- * @flags: Initial placement flags.
+ * @placement: Initial placement for buffer object.
  * @page_alignment: Data alignment in pages.
  * @interruptible: If needing to sleep to wait for GPU resources,
  * sleep interruptible.
@@ -414,6 +415,7 @@ int ttm_bo_init_reserved(struct ttm_device *bdev,
  * holds a pointer to a persistent shmem object. Typically, this would
  * point to the shmem object backing a GEM object if TTM is used to back a
  * GEM user interface.
+ * @sg: Scatter-gather table.
  * @resv: Pointer to a dma_resv, or NULL to let ttm allocate one.
  * @destroy: Destroy function. Use NULL for kfree().
  *
-- 
2.31.1

Re: [PATCH] drm/ttm_bo_api: update the description for @placement and @sg

[Christian König]

Am 05.10.21 um 21:35 schrieb Amos Kong:
> Correct the argument name of @placement and added @sg description for
> ttm_bo_init() and ttm_bo_init_reserved().
>
> Argument @flags was replaced to @placement by Jerome in commit
> 09855acb1c2e3779f25317ec9a8ffe1b1784a4a8
>
> Argument @sg was added by Dave in commit
> 129b78bfca591e736e56a294f0e357d73d938f7e
>
> Signed-off-by: Amos Kong <amos@sietium.com>
> Cc: Jerome Glisse <jglisse@redhat.com>
> Cc: Dave Airlie <airlied@redhat.com>

Reviewed-by: Christian König <christian.koenig@amd.com>

Going to push that to drm-misc-next later today.

> ---
>   include/drm/ttm/ttm_bo_api.h | 6 ++++--
>   1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/include/drm/ttm/ttm_bo_api.h b/include/drm/ttm/ttm_bo_api.h
> index f681bbdbc698..eb27bbee9888 100644
> --- a/include/drm/ttm/ttm_bo_api.h
> +++ b/include/drm/ttm/ttm_bo_api.h
> @@ -363,9 +363,10 @@ bool ttm_bo_eviction_valuable(struct ttm_buffer_object *bo,
>    * @bo: Pointer to a ttm_buffer_object to be initialized.
>    * @size: Requested size of buffer object.
>    * @type: Requested type of buffer object.
> - * @flags: Initial placement flags.
> + * @placement: Initial placement for buffer object.
>    * @page_alignment: Data alignment in pages.
>    * @ctx: TTM operation context for memory allocation.
> + * @sg: Scatter-gather table.
>    * @resv: Pointer to a dma_resv, or NULL to let ttm allocate one.
>    * @destroy: Destroy function. Use NULL for kfree().
>    *
> @@ -406,7 +407,7 @@ int ttm_bo_init_reserved(struct ttm_device *bdev,
>    * @bo: Pointer to a ttm_buffer_object to be initialized.
>    * @size: Requested size of buffer object.
>    * @type: Requested type of buffer object.
> - * @flags: Initial placement flags.
> + * @placement: Initial placement for buffer object.
>    * @page_alignment: Data alignment in pages.
>    * @interruptible: If needing to sleep to wait for GPU resources,
>    * sleep interruptible.
> @@ -414,6 +415,7 @@ int ttm_bo_init_reserved(struct ttm_device *bdev,
>    * holds a pointer to a persistent shmem object. Typically, this would
>    * point to the shmem object backing a GEM object if TTM is used to back a
>    * GEM user interface.
> + * @sg: Scatter-gather table.
>    * @resv: Pointer to a dma_resv, or NULL to let ttm allocate one.
>    * @destroy: Destroy function. Use NULL for kfree().
>    *