On Tue, Sep 7, 2021 at 4:01 AM Christian König <ckoenig.leichtzumerken@xxxxxxxxx> wrote: > > For now just a brief description of what TTM is all about. > > Signed-off-by: Christian König <christian.koenig@xxxxxxx> > --- > Documentation/gpu/drm-mm.rst | 3 ++- > drivers/gpu/drm/ttm/ttm_module.c | 12 ++++++++++++ > 2 files changed, 14 insertions(+), 1 deletion(-) > > 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..11b59cf03ec3 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 graphics devices with dedicated video memory. Maybe say "accelerator devices with dedicated memory" since this could just as easily be applicable to compute only devices. Alex > + * > + * 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 > -- > 2.25.1 >
