Commit eeb8117f authored by Himal Prasad Ghimiray's avatar Himal Prasad Ghimiray Committed by Lucas De Marchi
Browse files

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: 41880786 ("drm/xe/uapi: Add UAPI for querying VMA count and memory attributes")
Fixes: 231bb0ee ("drm/xe/uapi: Add madvise interface")
Cc: Matthew Brost <matthew.brost@intel.com>
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
Signed-off-by: default avatarHimal Prasad Ghimiray <himal.prasad.ghimiray@intel.com>
Reviewed-by: default avatarLucas De Marchi <lucas.demarchi@intel.com>
Link: https://lore.kernel.org/r/20250828071516.3838110-1-himal.prasad.ghimiray@intel.com


Signed-off-by: default avatarLucas De Marchi <lucas.demarchi@intel.com>
parent ed906b70

include/uapi/drm/xe_drm.h

+22 −21
Original line number Diff line number Diff line
@@ -2006,11 +2006,11 @@ struct drm_xe_query_eu_stall { 
 * .. 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,

 *         .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);
@@ -2042,7 +2042,7 @@ 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_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:
@@ -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,