From: Christian König Date: Tue, 7 Sep 2021 07:07:29 +0000 (+0200) Subject: drm/ttm: add some general module kerneldoc X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=fcd0bbd619b349a03fcf132bfd65ce8bffc581b7;p=linux.git 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 Reviewed-by: Matthew Auld Link: https://patchwork.freedesktop.org/patch/msgid/20210908132933.3269-3-christian.koenig@amd.com --- diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst index 8ca981065e1aa..6b7717af4f88b 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 997c458f68a9a..6c19290f7ea99 100644 --- a/drivers/gpu/drm/ttm/ttm_module.c +++ b/drivers/gpu/drm/ttm/ttm_module.c @@ -39,6 +39,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