aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gpu/drm/ttm/ttm_module.c
diff options
context:
space:
mode:
authorChristian König <christian.koenig@amd.com>2021-09-07 09:07:29 +0200
committerChristian König <christian.koenig@amd.com>2021-09-09 13:25:45 +0200
commitfcd0bbd619b349a03fcf132bfd65ce8bffc581b7 (patch)
tree1aac7794f67936be1c7850f14c048b40b46bd55e /drivers/gpu/drm/ttm/ttm_module.c
parentdrm/ttm: remove the outdated kerneldoc section (diff)
downloadlinux-dev-fcd0bbd619b349a03fcf132bfd65ce8bffc581b7.tar.xz
linux-dev-fcd0bbd619b349a03fcf132bfd65ce8bffc581b7.zip
drm/ttm: add some general module kerneldoc
For now just a brief description of what TTM is all about. Signed-off-by: Christian König <christian.koenig@amd.com> Reviewed-by: Matthew Auld <matthew.auld@intel.com> Link: https://patchwork.freedesktop.org/patch/msgid/20210908132933.3269-3-christian.koenig@amd.com
Diffstat (limited to 'drivers/gpu/drm/ttm/ttm_module.c')
-rw-r--r--drivers/gpu/drm/ttm/ttm_module.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/drivers/gpu/drm/ttm/ttm_module.c b/drivers/gpu/drm/ttm/ttm_module.c
index 997c458f68a9..6c19290f7ea9 100644
--- a/drivers/gpu/drm/ttm/ttm_module.c
+++ b/drivers/gpu/drm/ttm/ttm_module.c
@@ -40,6 +40,18 @@
#include "ttm_module.h"
/**
+ * DOC: TTM
+ *
+ * TTM is a memory manager for accelerator devices with dedicated memory.
+ *
+ * The basic idea is that resources are grouped together in buffer objects of
+ * certain size and TTM handles lifetime, movement and CPU mappings of those
+ * objects.
+ *
+ * TODO: Add more design background and information here.
+ */
+
+/**
* ttm_prot_from_caching - Modify the page protection according to the
* ttm cacing mode
* @caching: The ttm caching mode