Documentation/gpu: Document the situation with unqualified drm-memory-
authorTvrtko Ursulin <tvrtko.ursulin@igalia.com>
Tue, 13 Aug 2024 13:57:11 +0000 (14:57 +0100)
committerAlex Deucher <alexander.deucher@amd.com>
Mon, 7 Oct 2024 18:32:23 +0000 (14:32 -0400)
commit2c04742b04ee35ab75ffdbf4fe1a6ef1792775af
tree778771b2a80a3e93e82dedcebb094562e1d07d0f
parenta3ab2d45b9887ee609cd3bea39f668236935774c
Documentation/gpu: Document the situation with unqualified drm-memory-

Currently it is not well defined what is drm-memory- compared to other
categories.

In practice the only driver which emits these keys is amdgpu and in them
exposes the current resident buffer object memory (including shared).

To prevent any confusion, document that drm-memory- is deprecated and an
alias for drm-resident-memory-.

While at it also clarify that the reserved sub-string 'memory' refers to
the memory region component, and also clarify the intended semantics of
other memory categories.

v2:
 * Also mark drm-memory- as deprecated.
 * Add some more text describing memory categories. (Alex)

v3:
 * Semantics of the amdgpu drm-memory is actually as drm-resident.

Reviewed-by: Rob Clark <robdclark@gmail.com>
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Reviewed-by: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Tvrtko Ursulin <tvrtko.ursulin@igalia.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Christian König <christian.keonig@amd.com>
Cc: Rob Clark <robdclark@chromium.org>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>
Documentation/gpu/drm-usage-stats.rst