drm/ttm: add kerneldoc for enum ttm_caching

Briefly describe what this is all about.

Signed-off-by: Christian König <christian.koenig@amd.com>
Reviewed-by: Alex Deucher <alexander.deucher@amd.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20210908132933.3269-4-christian.koenig@amd.com
This commit is contained in:
Christian König 2021-09-07 09:14:43 +02:00
parent fcd0bbd619
commit be77a2f4cf
2 changed files with 20 additions and 0 deletions

View File

@ -31,6 +31,9 @@ The Translation Table Manager (TTM)
.. kernel-doc:: drivers/gpu/drm/ttm/ttm_module.c
:doc: TTM
.. kernel-doc:: include/drm/ttm/ttm_caching.h
:internal:
The Graphics Execution Manager (GEM)
====================================

View File

@ -27,9 +27,26 @@
#define TTM_NUM_CACHING_TYPES 3
/**
* enum ttm_caching - CPU caching and BUS snooping behavior.
*/
enum ttm_caching {
/**
* @ttm_uncached: Most defensive option for device mappings,
* don't even allow write combining.
*/
ttm_uncached,
/**
* @ttm_write_combined: Don't cache read accesses, but allow at least
* writes to be combined.
*/
ttm_write_combined,
/**
* @ttm_cached: Fully cached like normal system memory, requires that
* devices snoop the CPU cache on accesses.
*/
ttm_cached
};