[PATCH] drm/ttm: Doc the unit of ttm_resource_manager.usage

[PATCH] drm/ttm: Doc the unit of ttm_resource_manager.usage

[Nirmoy Das]

Document the unit of ttm_resource_manager.usage which was
missing before.

Cc: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: Anshuman Gupta <anshuman.gupta@intel.com>

Signed-off-by: Nirmoy Das <nirmoy.das@intel.com>
---
 include/drm/ttm/ttm_resource.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/drm/ttm/ttm_resource.h b/include/drm/ttm/ttm_resource.h
index 78a226eba953..32d6b9c91c40 100644
--- a/include/drm/ttm/ttm_resource.h
+++ b/include/drm/ttm/ttm_resource.h
@@ -145,6 +145,7 @@ struct ttm_resource_manager_func {
  * @move_lock: lock for move fence
  * @move: The fence of the last pipelined move operation.
  * @lru: The lru list for this memory type.
+ * @usage: How much of the resources are used, in bytes.
  *
  * This structure is used to identify and manage memory types for a device.
  */
@@ -170,8 +171,7 @@ struct ttm_resource_manager {
 	struct list_head lru[TTM_MAX_BO_PRIORITY];
 
 	/**
-	 * @usage: How much of the resources are used, protected by the
-	 * bdev->lru_lock.
+	 * Protected by the bdev->lru_lock.
 	 */
 	uint64_t usage;
 };
-- 
2.39.0

Re: [PATCH] drm/ttm: Doc the unit of ttm_resource_manager.usage

[Karolina Stolarek]

Hi Nirmoy,

On 9.05.2023 16:03, Nirmoy Das wrote:
> Document the unit of ttm_resource_manager.usage which was
> missing before.
> 
> Cc: Thomas Hellström <thomas.hellstrom@linux.intel.com>
> Cc: Christian König <christian.koenig@amd.com>
> Cc: Anshuman Gupta <anshuman.gupta@intel.com>
> 
> Signed-off-by: Nirmoy Das <nirmoy.das@intel.com>
> ---
>   include/drm/ttm/ttm_resource.h | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/drm/ttm/ttm_resource.h b/include/drm/ttm/ttm_resource.h
> index 78a226eba953..32d6b9c91c40 100644
> --- a/include/drm/ttm/ttm_resource.h
> +++ b/include/drm/ttm/ttm_resource.h
> @@ -145,6 +145,7 @@ struct ttm_resource_manager_func {
>    * @move_lock: lock for move fence
>    * @move: The fence of the last pipelined move operation.
>    * @lru: The lru list for this memory type.
> + * @usage: How much of the resources are used, in bytes.

That's a very helpful addition, thanks for the patch:

Reviewed-by: Karolina Stolarek <karolina.stolarek@intel.com>

>    *
>    * This structure is used to identify and manage memory types for a device.
>    */
> @@ -170,8 +171,7 @@ struct ttm_resource_manager {
>   	struct list_head lru[TTM_MAX_BO_PRIORITY];
>   
>   	/**
> -	 * @usage: How much of the resources are used, protected by the
> -	 * bdev->lru_lock.
> +	 * Protected by the bdev->lru_lock.
>   	 */
>   	uint64_t usage;
>   };