Skip to content

Commit eeb8117

Browse files
hghimiralucasdemarchi
authored andcommitted
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: 4188078 ("drm/xe/uapi: Add UAPI for querying VMA count and memory attributes") Fixes: 231bb0e ("drm/xe/uapi: Add madvise interface") Cc: Matthew Brost <matthew.brost@intel.com> Cc: Lucas De Marchi <lucas.demarchi@intel.com> Signed-off-by: Himal Prasad Ghimiray <himal.prasad.ghimiray@intel.com> Reviewed-by: Lucas De Marchi <lucas.demarchi@intel.com> Link: https://lore.kernel.org/r/20250828071516.3838110-1-himal.prasad.ghimiray@intel.com Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
1 parent ed906b7 commit eeb8117

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

include/uapi/drm/xe_drm.h

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1997,23 +1997,23 @@ struct drm_xe_query_eu_stall {
19971997
* union member is used to provide additional parameters for @type.
19981998
*
19991999
* Supported attribute types:
2000-
* - DRM_XE_MEM_RANGE_ATTR_PREFERRED_LOC: Set preferred memory location.
2001-
* - DRM_XE_MEM_RANGE_ATTR_ATOMIC: Set atomic access policy.
2002-
* - DRM_XE_MEM_RANGE_ATTR_PAT: Set page attribute table index.
2000+
* - DRM_XE_MEM_RANGE_ATTR_PREFERRED_LOC: Set preferred memory location.
2001+
* - DRM_XE_MEM_RANGE_ATTR_ATOMIC: Set atomic access policy.
2002+
* - DRM_XE_MEM_RANGE_ATTR_PAT: Set page attribute table index.
20032003
*
20042004
* Example:
20052005
*
20062006
* .. code-block:: C
20072007
*
2008-
* struct drm_xe_madvise madvise = {
2009-
*          .vm_id = vm_id,
2010-
*          .start = 0x100000,
2011-
*          .range = 0x2000,
2012-
*          .type = DRM_XE_MEM_RANGE_ATTR_ATOMIC,
2013-
*         .atomic_val = DRM_XE_ATOMIC_DEVICE,
2014-
* };
2008+
* struct drm_xe_madvise madvise = {
2009+
* .vm_id = vm_id,
2010+
* .start = 0x100000,
2011+
* .range = 0x2000,
2012+
* .type = DRM_XE_MEM_RANGE_ATTR_ATOMIC,
2013+
* .atomic_val = DRM_XE_ATOMIC_DEVICE,
2014+
* };
20152015
*
2016-
* ioctl(fd, DRM_IOCTL_XE_MADVISE, &madvise);
2016+
* ioctl(fd, DRM_IOCTL_XE_MADVISE, &madvise);
20172017
*
20182018
*/
20192019
struct drm_xe_madvise {
@@ -2042,12 +2042,12 @@ struct drm_xe_madvise {
20422042
* Used when @type == DRM_XE_MEM_RANGE_ATTR_PREFERRED_LOC
20432043
*
20442044
* Supported values for @preferred_mem_loc.devmem_fd:
2045-
* - DRM_XE_PREFERRED_LOC_DEFAULT_DEVICE: set vram of faulting tile as preferred loc
2046-
* - DRM_XE_PREFERRED_LOC_DEFAULT_SYSTEM: set smem as preferred loc
2045+
* - DRM_XE_PREFERRED_LOC_DEFAULT_DEVICE: set vram of fault tile as preferred loc
2046+
* - DRM_XE_PREFERRED_LOC_DEFAULT_SYSTEM: set smem as preferred loc
20472047
*
20482048
* Supported values for @preferred_mem_loc.migration_policy:
2049-
* - DRM_XE_MIGRATE_ALL_PAGES
2050-
* - DRM_XE_MIGRATE_ONLY_SYSTEM_PAGES
2049+
* - DRM_XE_MIGRATE_ALL_PAGES
2050+
* - DRM_XE_MIGRATE_ONLY_SYSTEM_PAGES
20512051
*/
20522052
struct {
20532053
#define DRM_XE_PREFERRED_LOC_DEFAULT_DEVICE 0
@@ -2073,12 +2073,12 @@ struct drm_xe_madvise {
20732073
* Used when @type == DRM_XE_MEM_RANGE_ATTR_ATOMIC.
20742074
*
20752075
* Supported values for @atomic.val:
2076-
* - DRM_XE_ATOMIC_UNDEFINED: Undefined or default behaviour
2077-
* Support both GPU and CPU atomic operations for system allocator
2078-
* Support GPU atomic operations for normal(bo) allocator
2079-
* - DRM_XE_ATOMIC_DEVICE: Support GPU atomic operations
2080-
* - DRM_XE_ATOMIC_GLOBAL: Support both GPU and CPU atomic operations
2081-
* - DRM_XE_ATOMIC_CPU: Support CPU atomic
2076+
* - DRM_XE_ATOMIC_UNDEFINED: Undefined or default behaviour.
2077+
* Support both GPU and CPU atomic operations for system allocator.
2078+
* Support GPU atomic operations for normal(bo) allocator.
2079+
* - DRM_XE_ATOMIC_DEVICE: Support GPU atomic operations.
2080+
* - DRM_XE_ATOMIC_GLOBAL: Support both GPU and CPU atomic operations.
2081+
* - DRM_XE_ATOMIC_CPU: Support CPU atomic only, no GPU atomics supported.
20822082
*/
20832083
struct {
20842084
#define DRM_XE_ATOMIC_UNDEFINED 0
@@ -2196,6 +2196,7 @@ struct drm_xe_mem_range_attr {
21962196
* Example:
21972197
*
21982198
* .. code-block:: C
2199+
*
21992200
* struct drm_xe_vm_query_mem_range_attr query = {
22002201
* .vm_id = vm_id,
22012202
* .start = 0x100000,

0 commit comments

Comments
 (0)