History

drm/xe/uapi: Fix wrong names and references in xe_drm.h

Fix incorrect field names, struct names, ioctl names, and descriptions in doc comments: - probed_size -> @cpu_visible_size (correct field name) - @flags description was copy of @placement -> fix to reference DRM_XE_GEM_CREATE_FLAG_* - %XE_PXP_HWDRM_DEFAULT_SESSION -> %DRM_XE_PXP_HWDRM_DEFAULT_SESSION (missing DRM_ prefix) - Remove undefined %DRM_XE_UFENCE_WAIT_FLAG_SOFT_OP - &DRM_XE_OBSERVATION -> &DRM_IOCTL_XE_OBSERVATION - id's/struct's -> IDs/structs (fix incorrect possessive forms) - drm_xe_query_oa_units -> drm_xe_oa_unit - DRM_IOCTL_XE_VM_QUERY_MEM_RANGES_ATTRS -> DRM_IOCTL_XE_VM_QUERY_MEM_RANGE_ATTRS - DRM_IOCTL_XE_VM_QUERY_MEM_ATTRIBUTES -> DRM_IOCTL_XE_VM_QUERY_MEM_RANGE_ATTRS - @sizeof_mem_ranges_attr -> @sizeof_mem_range_attr - @vector_of_vma_mem_attr -> @vector_of_mem_attr v3: id -> ID. (Xin) split cross-reference fix to seperate patch.

Shuicheng Lin committed 7 months ago

Commit ea842c21 parent 65d53c11 file · +12 −14Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

include/uapi/drm/xe_drm.h+12−14
@@ -349,7 +349,7 @@ struct drm_xe_mem_region { · 348 unmodified lines
349349 * is smaller than @total_size then this is referred to as a
350350 * small BAR system.
351351 *
352− * On systems without small BAR (full BAR), the probed_size will
352+ * On systems without small BAR (full BAR), the @cpu_visible_size will
353353 * always equal the @total_size, since all of it will be CPU
354354 * accessible.
355355 *
@@ -862,8 +862,7 @@ struct drm_xe_gem_create { · 506 unmodified lines
862862 #define DRM_XE_GEM_CREATE_FLAG_NEEDS_VISIBLE_VRAM (1 << 2)
863863 #define DRM_XE_GEM_CREATE_FLAG_NO_COMPRESSION (1 << 3)
864864 /**
865− * @flags: Flags, currently a mask of memory instances of where BO can
866− * be placed
865+ * @flags: Flags for the GEM object, see DRM_XE_GEM_CREATE_FLAG_*
867866 */
868867 __u32 flags;
869868
@@ -1366,7 +1365,7 @@ struct drm_xe_vm_get_property { · 496 unmodified lines
13661365 * drm_xe_pxp_session_type. %DRM_XE_PXP_TYPE_NONE is the default behavior, so
13671366 * there is no need to explicitly set that. When a queue of type
13681367 * %DRM_XE_PXP_TYPE_HWDRM is created, the PXP default HWDRM session
1369− * (%XE_PXP_HWDRM_DEFAULT_SESSION) will be started, if it isn't already running.
1368+ * (%DRM_XE_PXP_HWDRM_DEFAULT_SESSION) will be started, if it isn't already running.
13701369 * The user is expected to query the PXP status via the query ioctl (see
13711370 * %DRM_XE_DEVICE_QUERY_PXP_STATUS) and to wait for PXP to be ready before
13721371 * attempting to create a queue with this property. When a queue is created
@@ -1651,7 +1650,6 @@ struct drm_xe_exec { · 278 unmodified lines
16511650 *
16521651 * and the @flags can be:
16531652 * - %DRM_XE_UFENCE_WAIT_FLAG_ABSTIME
1654− * - %DRM_XE_UFENCE_WAIT_FLAG_SOFT_OP
16551653 *
16561654 * The @mask values can be for example:
16571655 * - 0xffu for u8
@@ -1741,7 +1739,7 @@ enum drm_xe_observation_op { · 83 unmodified lines
17411739 };
17421740
17431741 /**
1744− * struct drm_xe_observation_param - Input of &DRM_XE_OBSERVATION
1742+ * struct drm_xe_observation_param - Input of &DRM_IOCTL_XE_OBSERVATION
17451743 *
17461744 * The observation layer enables multiplexing observation streams of
17471745 * multiple types. The actual params for a particular stream operation are
@@ -1902,10 +1900,10 @@ enum drm_xe_oa_format_type { · 154 unmodified lines
19021900 };
19031901
19041902 /**
1905− * enum drm_xe_oa_property_id - OA stream property id's
1903+ * enum drm_xe_oa_property_id - OA stream property IDs
19061904 *
19071905 * Stream params are specified as a chain of @drm_xe_ext_set_property
1908− * struct's, with @property values from enum @drm_xe_oa_property_id and
1906+ * structs, with @property values from enum @drm_xe_oa_property_id and
19091907 * @drm_xe_user_extension base.name set to @DRM_XE_OA_EXTENSION_SET_PROPERTY.
19101908 * @param field in struct @drm_xe_observation_param points to the first
19111909 * @drm_xe_ext_set_property struct.
@@ -1919,7 +1917,7 @@ enum drm_xe_oa_property_id { · 7 unmodified lines
19191917 /**
19201918 * @DRM_XE_OA_PROPERTY_OA_UNIT_ID: ID of the OA unit on which to open
19211919 * the OA stream, see @oa_unit_id in 'struct
1922− * drm_xe_query_oa_units'. Defaults to 0 if not provided.
1920+ * drm_xe_oa_unit'. Defaults to 0 if not provided.
19231921 */
19241922 DRM_XE_OA_PROPERTY_OA_UNIT_ID = 1,
19251923
@@ -2369,10 +2367,10 @@ struct drm_xe_madvise { · 443 unmodified lines
23692367 };
23702368
23712369 /**
2372− * struct drm_xe_mem_range_attr - Output of &DRM_IOCTL_XE_VM_QUERY_MEM_RANGES_ATTRS
2370+ * struct drm_xe_mem_range_attr - Output of &DRM_IOCTL_XE_VM_QUERY_MEM_RANGE_ATTRS
23732371 *
23742372 * This structure is provided by userspace and filled by KMD in response to the
2375− * DRM_IOCTL_XE_VM_QUERY_MEM_RANGES_ATTRS ioctl. It describes memory attributes of
2373+ * DRM_IOCTL_XE_VM_QUERY_MEM_RANGE_ATTRS ioctl. It describes memory attributes of
23762374 * memory ranges within a user specified address range in a VM.
23772375 *
23782376 * The structure includes information such as atomic access policy,
@@ -2427,7 +2425,7 @@ struct drm_xe_mem_range_attr { · 48 unmodified lines
24272425 };
24282426
24292427 /**
2430− * struct drm_xe_vm_query_mem_range_attr - Input of &DRM_IOCTL_XE_VM_QUERY_MEM_ATTRIBUTES
2428+ * struct drm_xe_vm_query_mem_range_attr - Input of &DRM_IOCTL_XE_VM_QUERY_MEM_RANGE_ATTRS
24312429 *
24322430 * This structure is used to query memory attributes of memory regions
24332431 * within a user specified address range in a VM. It provides detailed
@@ -2435,14 +2433,14 @@ struct drm_xe_mem_range_attr { · 1 unmodified line
24352433 * page attribute table (PAT) index, and preferred memory location.
24362434 *
24372435 * Userspace first calls the ioctl with @num_mem_ranges = 0,
2438− * @sizeof_mem_ranges_attr = 0 and @vector_of_vma_mem_attr = NULL to retrieve
2436+ * @sizeof_mem_range_attr = 0 and @vector_of_mem_attr = NULL to retrieve
24392437 * the number of memory regions and size of each memory range attribute.
24402438 * Then, it allocates a buffer of that size and calls the ioctl again to fill
24412439 * the buffer with memory range attributes.
24422440 *
24432441 * If second call fails with -ENOSPC, it means memory ranges changed between
24442442 * first call and now, retry IOCTL again with @num_mem_ranges = 0,
2445− * @sizeof_mem_ranges_attr = 0 and @vector_of_vma_mem_attr = NULL followed by
2443+ * @sizeof_mem_range_attr = 0 and @vector_of_mem_attr = NULL followed by
24462444 * second ioctl call.
24472445 *
24482446 * Example: