From: Matthew Auld <matthew.auld@intel.com> To: intel-gfx@lists.freedesktop.org Cc: dri-devel@lists.freedesktop.org, "Thomas Hellström" <thomas.hellstrom@linux.intel.com>, "Christian König" <christian.koenig@amd.com> Subject: [PATCH v4 06/14] drm/ttm: add some kernel-doc for TTM_TT_FLAG_* Date: Tue, 21 Sep 2021 12:01:13 +0100 [thread overview] Message-ID: <20210921110121.3783395-6-matthew.auld@intel.com> (raw) In-Reply-To: <20210921110121.3783395-1-matthew.auld@intel.com> Move it to inline kernel-doc, otherwise we can't add empty lines it seems. Also drop the kernel-doc for pages_list, which doesn't seem to exist. Signed-off-by: Matthew Auld <matthew.auld@intel.com> Cc: Thomas Hellström <thomas.hellstrom@linux.intel.com> Cc: Christian König <christian.koenig@amd.com> --- include/drm/ttm/ttm_tt.h | 57 ++++++++++++++++++++++++++-------------- 1 file changed, 38 insertions(+), 19 deletions(-) diff --git a/include/drm/ttm/ttm_tt.h b/include/drm/ttm/ttm_tt.h index b023cd58ff38..f3ef568da651 100644 --- a/include/drm/ttm/ttm_tt.h +++ b/include/drm/ttm/ttm_tt.h @@ -38,35 +38,54 @@ struct ttm_resource; struct ttm_buffer_object; struct ttm_operation_ctx; -#define TTM_TT_FLAG_SWAPPED (1 << 0) -#define TTM_TT_FLAG_ZERO_ALLOC (1 << 1) -#define TTM_TT_FLAG_EXTERNAL (1 << 2) - -#define TTM_TT_FLAG_PRIV_POPULATED (1 << 31) - /** - * struct ttm_tt - * - * @pages: Array of pages backing the data. - * @page_flags: see TTM_TT_FLAG_* - * @num_pages: Number of pages in the page array. - * @sg: for SG objects via dma-buf - * @dma_address: The DMA (bus) addresses of the pages - * @swap_storage: Pointer to shmem struct file for swap storage. - * @pages_list: used by some page allocation backend - * @caching: The current caching state of the pages, see enum ttm_caching. - * - * This is a structure holding the pages, caching- and aperture binding - * status for a buffer object that isn't backed by fixed (VRAM / AGP) + * struct ttm_tt - This is a structure holding the pages, caching- and aperture + * binding status for a buffer object that isn't backed by fixed (VRAM / AGP) * memory. */ struct ttm_tt { + /** @pages: Array of pages backing the data. */ struct page **pages; + /** + * @page_flags: The page flags. + * + * Supported values: + * + * TTM_TT_FLAG_SWAPPED: Set if the pages have been swapped out. + * Calling ttm_tt_populate() will swap the pages back in, and unset the + * flag. + * + * TTM_TT_FLAG_ZERO_ALLOC: Set if the pages will be zeroed on + * allocation. + * + * TTM_TT_FLAG_EXTERNAL: Set if the underlying pages were allocated + * externally, like with dma-buf or userptr. This effectively disables + * TTM swapping out such pages. Also important is to prevent TTM from + * ever directly mapping these pages. + * + * Note that enum ttm_bo_type.ttm_bo_type_sg objects will always enable + * this flag. + * + * TTM_TT_FLAG_PRIV_POPULATED: TTM internal only. DO NOT USE. + */ +#define TTM_TT_FLAG_SWAPPED (1 << 0) +#define TTM_TT_FLAG_ZERO_ALLOC (1 << 1) +#define TTM_TT_FLAG_EXTERNAL (1 << 2) + +#define TTM_TT_FLAG_PRIV_POPULATED (1 << 31) uint32_t page_flags; + /** @num_pages: Number of pages in the page array. */ uint32_t num_pages; + /** @sg: for SG objects via dma-buf. */ struct sg_table *sg; + /** @dma_address: The DMA (bus) addresses of the pages. */ dma_addr_t *dma_address; + /** @swap_storage: Pointer to shmem struct file for swap storage. */ struct file *swap_storage; + /** + * @caching: The current caching state of the pages, see enum + * ttm_caching. + */ enum ttm_caching caching; }; -- 2.26.3
WARNING: multiple messages have this Message-ID (diff)
From: Matthew Auld <matthew.auld@intel.com> To: intel-gfx@lists.freedesktop.org Cc: dri-devel@lists.freedesktop.org, "Thomas Hellström" <thomas.hellstrom@linux.intel.com>, "Christian König" <christian.koenig@amd.com> Subject: [Intel-gfx] [PATCH v4 06/14] drm/ttm: add some kernel-doc for TTM_TT_FLAG_* Date: Tue, 21 Sep 2021 12:01:13 +0100 [thread overview] Message-ID: <20210921110121.3783395-6-matthew.auld@intel.com> (raw) In-Reply-To: <20210921110121.3783395-1-matthew.auld@intel.com> Move it to inline kernel-doc, otherwise we can't add empty lines it seems. Also drop the kernel-doc for pages_list, which doesn't seem to exist. Signed-off-by: Matthew Auld <matthew.auld@intel.com> Cc: Thomas Hellström <thomas.hellstrom@linux.intel.com> Cc: Christian König <christian.koenig@amd.com> --- include/drm/ttm/ttm_tt.h | 57 ++++++++++++++++++++++++++-------------- 1 file changed, 38 insertions(+), 19 deletions(-) diff --git a/include/drm/ttm/ttm_tt.h b/include/drm/ttm/ttm_tt.h index b023cd58ff38..f3ef568da651 100644 --- a/include/drm/ttm/ttm_tt.h +++ b/include/drm/ttm/ttm_tt.h @@ -38,35 +38,54 @@ struct ttm_resource; struct ttm_buffer_object; struct ttm_operation_ctx; -#define TTM_TT_FLAG_SWAPPED (1 << 0) -#define TTM_TT_FLAG_ZERO_ALLOC (1 << 1) -#define TTM_TT_FLAG_EXTERNAL (1 << 2) - -#define TTM_TT_FLAG_PRIV_POPULATED (1 << 31) - /** - * struct ttm_tt - * - * @pages: Array of pages backing the data. - * @page_flags: see TTM_TT_FLAG_* - * @num_pages: Number of pages in the page array. - * @sg: for SG objects via dma-buf - * @dma_address: The DMA (bus) addresses of the pages - * @swap_storage: Pointer to shmem struct file for swap storage. - * @pages_list: used by some page allocation backend - * @caching: The current caching state of the pages, see enum ttm_caching. - * - * This is a structure holding the pages, caching- and aperture binding - * status for a buffer object that isn't backed by fixed (VRAM / AGP) + * struct ttm_tt - This is a structure holding the pages, caching- and aperture + * binding status for a buffer object that isn't backed by fixed (VRAM / AGP) * memory. */ struct ttm_tt { + /** @pages: Array of pages backing the data. */ struct page **pages; + /** + * @page_flags: The page flags. + * + * Supported values: + * + * TTM_TT_FLAG_SWAPPED: Set if the pages have been swapped out. + * Calling ttm_tt_populate() will swap the pages back in, and unset the + * flag. + * + * TTM_TT_FLAG_ZERO_ALLOC: Set if the pages will be zeroed on + * allocation. + * + * TTM_TT_FLAG_EXTERNAL: Set if the underlying pages were allocated + * externally, like with dma-buf or userptr. This effectively disables + * TTM swapping out such pages. Also important is to prevent TTM from + * ever directly mapping these pages. + * + * Note that enum ttm_bo_type.ttm_bo_type_sg objects will always enable + * this flag. + * + * TTM_TT_FLAG_PRIV_POPULATED: TTM internal only. DO NOT USE. + */ +#define TTM_TT_FLAG_SWAPPED (1 << 0) +#define TTM_TT_FLAG_ZERO_ALLOC (1 << 1) +#define TTM_TT_FLAG_EXTERNAL (1 << 2) + +#define TTM_TT_FLAG_PRIV_POPULATED (1 << 31) uint32_t page_flags; + /** @num_pages: Number of pages in the page array. */ uint32_t num_pages; + /** @sg: for SG objects via dma-buf. */ struct sg_table *sg; + /** @dma_address: The DMA (bus) addresses of the pages. */ dma_addr_t *dma_address; + /** @swap_storage: Pointer to shmem struct file for swap storage. */ struct file *swap_storage; + /** + * @caching: The current caching state of the pages, see enum + * ttm_caching. + */ enum ttm_caching caching; }; -- 2.26.3
next prev parent reply other threads:[~2021-09-21 11:02 UTC|newest] Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-09-21 11:01 [PATCH v4 01/14] drm/ttm: stop calling tt_swapin in vm_access Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:01 ` [PATCH v4 02/14] drm/ttm: stop setting page->index for the ttm_tt Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:01 ` [PATCH v4 03/14] drm/ttm: move ttm_tt_{add, clear}_mapping into amdgpu Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:29 ` [PATCH v4 03/14] drm/ttm: move ttm_tt_{add,clear}_mapping " Christian König 2021-09-21 11:29 ` [Intel-gfx] [PATCH v4 03/14] drm/ttm: move ttm_tt_{add, clear}_mapping " Christian König 2021-09-21 11:01 ` [PATCH v4 04/14] drm/ttm: remove TTM_PAGE_FLAG_NO_RETRY Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:01 ` [PATCH v4 05/14] drm/ttm: s/FLAG_SG/FLAG_EXTERNAL/ Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:30 ` Christian König 2021-09-21 11:30 ` [Intel-gfx] " Christian König 2021-09-21 11:01 ` Matthew Auld [this message] 2021-09-21 11:01 ` [Intel-gfx] [PATCH v4 06/14] drm/ttm: add some kernel-doc for TTM_TT_FLAG_* Matthew Auld 2021-09-21 11:33 ` Christian König 2021-09-21 11:33 ` [Intel-gfx] " Christian König 2021-09-21 11:01 ` [PATCH v4 07/14] drm/ttm: add TTM_TT_FLAG_EXTERNAL_MAPPABLE Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:01 ` [PATCH v4 08/14] drm/i915/gem: Break out some shmem backend utils Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:01 ` [PATCH v4 09/14] drm/i915/ttm: add tt shmem backend Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-22 12:14 ` Thomas Hellström 2021-09-22 12:14 ` [Intel-gfx] " Thomas Hellström 2021-09-21 11:01 ` [PATCH v4 10/14] drm/i915/ttm: hide shmem objects from TTM LRU Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:48 ` Christian König 2021-09-21 11:48 ` [Intel-gfx] " Christian König 2021-09-22 13:34 ` Matthew Auld 2021-09-22 13:34 ` [Intel-gfx] " Matthew Auld 2021-09-22 13:59 ` Christian König 2021-09-22 13:59 ` [Intel-gfx] " Christian König 2021-09-21 11:01 ` [PATCH v4 11/14] drm/i915/ttm: use cached system pages when evicting lmem Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:01 ` [PATCH v4 12/14] drm/i915: try to simplify make_{un}shrinkable Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:01 ` [PATCH v4 13/14] drm/i915/ttm: make evicted shmem pages visible to the shrinker Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:01 ` [PATCH v4 14/14] drm/i915/ttm: enable shmem tt backend Matthew Auld 2021-09-21 11:01 ` [Intel-gfx] " Matthew Auld 2021-09-21 11:28 ` [PATCH v4 01/14] drm/ttm: stop calling tt_swapin in vm_access Christian König 2021-09-21 11:28 ` [Intel-gfx] " Christian König 2021-09-21 11:37 ` Thomas Hellström 2021-09-21 11:37 ` [Intel-gfx] " Thomas Hellström 2021-09-21 11:42 ` Christian König 2021-09-21 11:42 ` [Intel-gfx] " Christian König 2021-09-21 12:59 ` [Intel-gfx] ✗ Fi.CI.CHECKPATCH: warning for series starting with [v4,01/14] " Patchwork 2021-09-21 13:01 ` [Intel-gfx] ✗ Fi.CI.SPARSE: " Patchwork 2021-09-21 13:30 ` [Intel-gfx] ✓ Fi.CI.BAT: success " Patchwork 2021-09-21 16:03 ` [Intel-gfx] ✓ Fi.CI.IGT: " Patchwork
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=20210921110121.3783395-6-matthew.auld@intel.com \ --to=matthew.auld@intel.com \ --cc=christian.koenig@amd.com \ --cc=dri-devel@lists.freedesktop.org \ --cc=intel-gfx@lists.freedesktop.org \ --cc=thomas.hellstrom@linux.intel.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: linkBe 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.