]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
drm/xe: Fix type and parameter name mismatches in kernel-doc references
authorShuicheng Lin <shuicheng.lin@intel.com>
Tue, 14 Apr 2026 22:54:33 +0000 (22:54 +0000)
committerShuicheng Lin <shuicheng.lin@intel.com>
Thu, 16 Apr 2026 15:32:00 +0000 (08:32 -0700)
Fix kernel-doc references that point to wrong type or parameter names:

- xe_guc_capture_types.h: register_data_type ->
  capture_register_data_type to match actual enum name
- xe_oa_types.h: enum @drm_xe_oa_format_type ->
  enum drm_xe_oa_format_type (spurious '@' before type name)
- xe_pt_walk.h: @sizes -> @shifts to match actual struct member,
  @start -> @addr to match actual parameter name,
  page.table. -> page table. (typo)

Assisted-by: GitHub Copilot:claude-sonnet-4.6
Reviewed-by: Brian Nguyen <brian3.nguyen@intel.com>
Link: https://patch.msgid.link/20260414225457.3687449-5-shuicheng.lin@intel.com
Signed-off-by: Shuicheng Lin <shuicheng.lin@intel.com>
drivers/gpu/drm/xe/xe_guc_capture_types.h
drivers/gpu/drm/xe/xe_oa_types.h
drivers/gpu/drm/xe/xe_pt_walk.h

index af7e21777b06b695e106f2aaf5934506529b08f1..058a3f2eadce9fb6fd8db55b6ad9ac7214819705 100644 (file)
@@ -32,7 +32,7 @@ struct __guc_mmio_reg_descr {
        /**
         * @data_type: data type of the register
         * Could be 32 bit, low or hi dword of a 64 bit, see enum
-        * register_data_type
+        * capture_register_data_type
         */
        enum capture_register_data_type data_type;
        /** @flags: Flags for the register */
index 0c48c1e0c2c68863a405ee1e5c92c2a63b30bb0b..8906c3084b5f885deef805d454805b155346cbec 100644 (file)
@@ -67,7 +67,7 @@ struct xe_oa_format {
        u32 counter_select;
        /** @size: record size as written by HW (multiple of 64 byte cachelines) */
        int size;
-       /** @type: of enum @drm_xe_oa_format_type */
+       /** @type: of enum drm_xe_oa_format_type */
        int type;
        /** @header: 32 or 64 bit report headers */
        enum xe_oa_report_header header;
index dcedfc9a28df694c956782a0a17cc79a2f6c688f..e91995fa703b0347710c9aaa17406ba72afb6322 100644 (file)
@@ -34,7 +34,7 @@ struct xe_pt_walk {
         * changed during the walk.
         */
        const u64 *shifts;
-       /** @max_level: Highest populated level in @sizes */
+       /** @max_level: Highest populated level in @shifts */
        unsigned int max_level;
        /**
         * @shared_pt_mode: Whether to skip all entries that are private
@@ -49,7 +49,7 @@ struct xe_pt_walk {
 
 /**
  * typedef xe_pt_entry_fn - gpu page-table-walk callback-function
- * @parent: The parent page.table.
+ * @parent: The parent page table.
  * @offset: The offset (number of entries) into the page table.
  * @level: The level of @parent.
  * @addr: The virtual address.
@@ -118,7 +118,7 @@ static inline bool xe_pt_covers(u64 addr, u64 end, unsigned int level,
  * @level: Page table level.
  * @walk: Walk info.
  *
- * Return: The number of page table entries at this level between @start and
+ * Return: The number of page table entries at this level between @addr and
  * @end.
  */
 static inline pgoff_t