All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Christian König" <ckoenig.leichtzumerken@gmail.com>
To: dri-devel@lists.freedesktop.org
Cc: matthew.william.auld@gmail.com
Subject: [PATCH 3/8] drm/ttm: add kerneldoc for enum ttm_caching
Date: Tue,  7 Sep 2021 10:01:30 +0200	[thread overview]
Message-ID: <20210907080135.101452-3-christian.koenig@amd.com> (raw)
In-Reply-To: <20210907080135.101452-1-christian.koenig@amd.com>

Briefly describe what this is all about.

Signed-off-by: Christian König <christian.koenig@amd.com>
---
 Documentation/gpu/drm-mm.rst  |  3 +++
 include/drm/ttm/ttm_caching.h | 17 +++++++++++++++++
 2 files changed, 20 insertions(+)

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
 };
 
-- 
2.25.1


  parent reply	other threads:[~2021-09-07  8:01 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-07  8:01 [PATCH 1/8] drm/ttm: remove the outdated kerneldoc section Christian König
2021-09-07  8:01 ` [PATCH 2/8] drm/ttm: add some general module kerneldoc Christian König
2021-09-07 15:23   ` Alex Deucher
2021-09-07  8:01 ` Christian König [this message]
2021-09-07 15:24   ` [PATCH 3/8] drm/ttm: add kerneldoc for enum ttm_caching Alex Deucher
2021-09-07  8:01 ` [PATCH 4/8] drm/ttm: enable TTM device object kerneldoc Christian König
2021-09-07 15:28   ` Alex Deucher
2021-09-07  8:01 ` [PATCH 5/8] drm/ttm: enable TTM resource object kerneldoc v2 Christian König
2021-09-07 15:29   ` Alex Deucher
2021-09-07  8:01 ` [PATCH 6/8] drm/ttm: enable TTM placement kerneldoc Christian König
2021-09-07 15:29   ` Alex Deucher
2021-09-07  8:01 ` [PATCH 7/8] drm/ttm: enable TTM TT object kerneldoc v2 Christian König
2021-09-07 15:30   ` Alex Deucher
2021-09-07  8:01 ` [PATCH 8/8] drm/ttm: enable TTM page pool kerneldoc Christian König
2021-09-07 15:30   ` Alex Deucher
2021-09-07  8:39 ` [PATCH 1/8] drm/ttm: remove the outdated kerneldoc section Daniel Vetter
2021-09-08 13:29 Enabling TTM kerneldoc Christian König
2021-09-08 13:29 ` [PATCH 3/8] drm/ttm: add kerneldoc for enum ttm_caching Christian König

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210907080135.101452-3-christian.koenig@amd.com \
    --to=ckoenig.leichtzumerken@gmail.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=matthew.william.auld@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.