From: Himal Prasad Ghimiray Date: Thu, 28 Aug 2025 07:15:16 +0000 (+0530) Subject: drm/xe/uapi: Fix kernel-doc formatting for madvise and vma_query X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=eeb8117f5f1c2e8e625e5cb39dbccd21d395caad;p=users%2Fhch%2Fmisc.git drm/xe/uapi: Fix kernel-doc formatting for madvise and vma_query Correct kernel-doc formatting issues in the UAPI definitions for madvise and VMA query interfaces to resolve docutils warnings during documentation build. Fixes: 418807860e94 ("drm/xe/uapi: Add UAPI for querying VMA count and memory attributes") Fixes: 231bb0ee7aa5 ("drm/xe/uapi: Add madvise interface") Cc: Matthew Brost Cc: Lucas De Marchi Signed-off-by: Himal Prasad Ghimiray Reviewed-by: Lucas De Marchi Link: https://lore.kernel.org/r/20250828071516.3838110-1-himal.prasad.ghimiray@intel.com Signed-off-by: Lucas De Marchi --- diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h index 7dedd45ab995..40ff19f52a8d 100644 --- a/include/uapi/drm/xe_drm.h +++ b/include/uapi/drm/xe_drm.h @@ -1997,23 +1997,23 @@ struct drm_xe_query_eu_stall { * union member is used to provide additional parameters for @type. * * Supported attribute types: - * - DRM_XE_MEM_RANGE_ATTR_PREFERRED_LOC: Set preferred memory location. - * - DRM_XE_MEM_RANGE_ATTR_ATOMIC: Set atomic access policy. - * - DRM_XE_MEM_RANGE_ATTR_PAT: Set page attribute table index. + * - DRM_XE_MEM_RANGE_ATTR_PREFERRED_LOC: Set preferred memory location. + * - DRM_XE_MEM_RANGE_ATTR_ATOMIC: Set atomic access policy. + * - DRM_XE_MEM_RANGE_ATTR_PAT: Set page attribute table index. * * Example: * * .. code-block:: C * - * struct drm_xe_madvise madvise = { - *          .vm_id = vm_id, - *          .start = 0x100000, - *          .range = 0x2000, - *          .type = DRM_XE_MEM_RANGE_ATTR_ATOMIC, - *         .atomic_val = DRM_XE_ATOMIC_DEVICE, - * }; + * struct drm_xe_madvise madvise = { + * .vm_id = vm_id, + * .start = 0x100000, + * .range = 0x2000, + * .type = DRM_XE_MEM_RANGE_ATTR_ATOMIC, + * .atomic_val = DRM_XE_ATOMIC_DEVICE, + * }; * - * ioctl(fd, DRM_IOCTL_XE_MADVISE, &madvise); + * ioctl(fd, DRM_IOCTL_XE_MADVISE, &madvise); * */ struct drm_xe_madvise { @@ -2042,12 +2042,12 @@ struct drm_xe_madvise { * Used when @type == DRM_XE_MEM_RANGE_ATTR_PREFERRED_LOC * * Supported values for @preferred_mem_loc.devmem_fd: - * - DRM_XE_PREFERRED_LOC_DEFAULT_DEVICE: set vram of faulting tile as preferred loc - * - DRM_XE_PREFERRED_LOC_DEFAULT_SYSTEM: set smem as preferred loc + * - DRM_XE_PREFERRED_LOC_DEFAULT_DEVICE: set vram of fault tile as preferred loc + * - DRM_XE_PREFERRED_LOC_DEFAULT_SYSTEM: set smem as preferred loc * * Supported values for @preferred_mem_loc.migration_policy: - * - DRM_XE_MIGRATE_ALL_PAGES - * - DRM_XE_MIGRATE_ONLY_SYSTEM_PAGES + * - DRM_XE_MIGRATE_ALL_PAGES + * - DRM_XE_MIGRATE_ONLY_SYSTEM_PAGES */ struct { #define DRM_XE_PREFERRED_LOC_DEFAULT_DEVICE 0 @@ -2073,12 +2073,12 @@ struct drm_xe_madvise { * Used when @type == DRM_XE_MEM_RANGE_ATTR_ATOMIC. * * Supported values for @atomic.val: - * - DRM_XE_ATOMIC_UNDEFINED: Undefined or default behaviour - * Support both GPU and CPU atomic operations for system allocator - * Support GPU atomic operations for normal(bo) allocator - * - DRM_XE_ATOMIC_DEVICE: Support GPU atomic operations - * - DRM_XE_ATOMIC_GLOBAL: Support both GPU and CPU atomic operations - * - DRM_XE_ATOMIC_CPU: Support CPU atomic + * - DRM_XE_ATOMIC_UNDEFINED: Undefined or default behaviour. + * Support both GPU and CPU atomic operations for system allocator. + * Support GPU atomic operations for normal(bo) allocator. + * - DRM_XE_ATOMIC_DEVICE: Support GPU atomic operations. + * - DRM_XE_ATOMIC_GLOBAL: Support both GPU and CPU atomic operations. + * - DRM_XE_ATOMIC_CPU: Support CPU atomic only, no GPU atomics supported. */ struct { #define DRM_XE_ATOMIC_UNDEFINED 0 @@ -2196,6 +2196,7 @@ struct drm_xe_mem_range_attr { * Example: * * .. code-block:: C + * * struct drm_xe_vm_query_mem_range_attr query = { * .vm_id = vm_id, * .start = 0x100000,