diff options
| author |   Christian König <christian.koenig@amd.com> | 2021-09-07 09:07:29 +0200 |
|---|---|---|
| committer | Christian König <christian.koenig@amd.com> | 2021-09-09 13:25:45 +0200 |
| commit | fcd0bbd619b349a03fcf132bfd65ce8bffc581b7 (patch) | |
| tree | 1aac7794f67936be1c7850f14c048b40b46bd55e | |
| parent | drm/ttm: remove the outdated kerneldoc section (diff) | |
| download | linux-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
| -rw-r--r-- | Documentation/gpu/drm-mm.rst | 3 | ||||
| -rw-r--r-- | drivers/gpu/drm/ttm/ttm_module.c | 12 |
2 files changed, 14 insertions, 1 deletions
diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst index 8ca981065e1a..6b7717af4f88 100644 --- a/Documentation/gpu/drm-mm.rst +++ b/Documentation/gpu/drm-mm.rst @@ -28,7 +28,8 @@ UMA devices. The Translation Table Manager (TTM) =================================== -TTM design background and information belongs here. +.. kernel-doc:: drivers/gpu/drm/ttm/ttm_module.c + :doc: TTM The Graphics Execution Manager (GEM) ==================================== 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 |