Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

+20
+3
Documentation/gpu/drm-mm.rst
··· 31 31 .. kernel-doc:: drivers/gpu/drm/ttm/ttm_module.c 32 32 :doc: TTM 33 33 34 + .. kernel-doc:: include/drm/ttm/ttm_caching.h 35 + :internal: 36 + 34 37 The Graphics Execution Manager (GEM) 35 38 ==================================== 36 39
+17
include/drm/ttm/ttm_caching.h
··· 27 27 28 28 #define TTM_NUM_CACHING_TYPES 3 29 29 30 + /** 31 + * enum ttm_caching - CPU caching and BUS snooping behavior. 32 + */ 30 33 enum ttm_caching { 34 + /** 35 + * @ttm_uncached: Most defensive option for device mappings, 36 + * don't even allow write combining. 37 + */ 31 38 ttm_uncached, 39 + 40 + /** 41 + * @ttm_write_combined: Don't cache read accesses, but allow at least 42 + * writes to be combined. 43 + */ 32 44 ttm_write_combined, 45 + 46 + /** 47 + * @ttm_cached: Fully cached like normal system memory, requires that 48 + * devices snoop the CPU cache on accesses. 49 + */ 33 50 ttm_cached 34 51 }; 35 52