]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
drm/xe: Fix xe_pt_stage_bind_walk kerneldoc
authorThomas Hellström <thomas.hellstrom@linux.intel.com>
Wed, 2 Apr 2025 12:29:24 +0000 (14:29 +0200)
committerThomas Hellström <thomas.hellstrom@linux.intel.com>
Thu, 3 Apr 2025 10:23:28 +0000 (12:23 +0200)
The structure was missing a proper kerneldoc header and once
that was added a number of typos and errors became obvious.
Fix those.

Reported-by: Lucas De Marchi <lucas.demarchi@intel.com>
Closes: https://lore.kernel.org/intel-xe/x53tcs5bjldw6lcorjemuheklxcmepdvr2u7lvt3hpqrzqoc4h@nsu6hs25taqj/
Fixes: b2d4b03b03a7 ("drm/xe: Make the PT code handle placement per PTE rather than per vma / range")
Signed-off-by: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Reviewed-by: Lucas De Marchi <lucas.demarchi@intel.com>
Link: https://lore.kernel.org/r/20250402122924.25526-1-thomas.hellstrom@linux.intel.com
drivers/gpu/drm/xe/xe_pt.c

index 82ae159feed120ca0c6f4546ff218c963216a965..33839b25d7086625b22ef14aa6714c91be3633fb 100644 (file)
@@ -269,8 +269,11 @@ struct xe_pt_update {
        bool preexisting;
 };
 
+/**
+ * struct xe_pt_stage_bind_walk - Walk state for the stage_bind walk.
+ */
 struct xe_pt_stage_bind_walk {
-       /** base: The base class. */
+       /** @base: The base class. */
        struct xe_pt_walk base;
 
        /* Input parameters for the walk */
@@ -278,14 +281,14 @@ struct xe_pt_stage_bind_walk {
        struct xe_vm *vm;
        /** @tile: The tile we're building for. */
        struct xe_tile *tile;
-       /** @default_pte: PTE flag only template for VRAM. No address is associated */
+       /** @default_vram_pte: PTE flag only template for VRAM. No address is associated */
        u64 default_vram_pte;
-       /** @default_pte: PTE flag only template for VRAM. No address is associated */
+       /** @default_system_pte: PTE flag only template for System. No address is associated */
        u64 default_system_pte;
        /** @dma_offset: DMA offset to add to the PTE. */
        u64 dma_offset;
        /**
-        * @needs_64k: This address range enforces 64K alignment and
+        * @needs_64K: This address range enforces 64K alignment and
         * granularity on VRAM.
         */
        bool needs_64K;
@@ -301,6 +304,7 @@ struct xe_pt_stage_bind_walk {
        u64 va_curs_start;
 
        /* Output */
+       /** @wupd: Walk output data for page-table updates. */
        struct xe_walk_update {
                /** @wupd.entries: Caller provided storage. */
                struct xe_vm_pgtable_update *entries;
@@ -318,7 +322,7 @@ struct xe_pt_stage_bind_walk {
        u64 l0_end_addr;
        /** @addr_64K: The start address of the current 64K chunk. */
        u64 addr_64K;
-       /** @found_64: Whether @add_64K actually points to a 64K chunk. */
+       /** @found_64K: Whether @add_64K actually points to a 64K chunk. */
        bool found_64K;
 };