summaryrefslogtreecommitdiffstats
path: root/include/drm/ttm
diff options
context:
space:
mode:
authorChristian König <christian.koenig@amd.com>2021-09-07 09:14:43 +0200
committerChristian König <christian.koenig@amd.com>2021-09-09 13:26:43 +0200
commitbe77a2f4cfd20aa4a28fc98227bfbfd5e0c232e2 (patch)
tree9bc3b27f08b683f6a5b672823f326cef998f8a10 /include/drm/ttm
parentfcd0bbd619b349a03fcf132bfd65ce8bffc581b7 (diff)
downloadlinux-be77a2f4cfd20aa4a28fc98227bfbfd5e0c232e2.tar.bz2
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
Diffstat (limited to 'include/drm/ttm')
-rw-r--r--include/drm/ttm/ttm_caching.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/include/drm/ttm/ttm_caching.h b/include/drm/ttm/ttm_caching.h
index 3c9dd65f5aaf..235a743d90e1 100644
--- a/include/drm/ttm/ttm_caching.h
+++ b/include/drm/ttm/ttm_caching.h
@@ -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
};