diff options
| author | Christian König <christian.koenig@amd.com> | 2021-09-07 09:14:43 +0200 |
|---|---|---|
| committer | Christian König <christian.koenig@amd.com> | 2021-09-09 13:26:43 +0200 |
| commit | be77a2f4cfd20aa4a28fc98227bfbfd5e0c232e2 (patch) | |
| tree | 9bc3b27f08b683f6a5b672823f326cef998f8a10 | |
| parent | drm/ttm: add some general module kerneldoc (diff) | |
| download | linux-be77a2f4cfd20aa4a28fc98227bfbfd5e0c232e2.tar.xz linux-be77a2f4cfd20aa4a28fc98227bfbfd5e0c232e2.zip | |
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
| -rw-r--r-- | Documentation/gpu/drm-mm.rst | 3 | ||||
| -rw-r--r-- | include/drm/ttm/ttm_caching.h | 17 |
2 files changed, 20 insertions, 0 deletions
diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst index 6b7717af4f88..f22c9f9a2c0e 100644 --- a/Documentation/gpu/drm-mm.rst +++ b/Documentation/gpu/drm-mm.rst @@ -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) ==================================== 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 }; |