History

drm/xe/uapi: Fix typos and spelling errors in xe_drm.h documentation

Fix the following typos and spelling errors in doc comments: - creaed -> created (drm_xe_query_config) - mmaping -> mmapping (drm_xe_gem_create) - 0xdeadbeaf -> 0xdeadbeef (drm_xe_gem_mmap_offset) - x2 and xe3 platform -> Xe2 and Xe3 platforms - flat -> flag (drm_xe_wait_user_fence) - MONOTONIC_CLOCK -> CLOCK_MONOTONIC (correct POSIX name) - neverending -> never ending (drm_xe_wait_user_fence)

Shuicheng Lin committed 7 months ago

Commit 3233db71 parent 2b923201 file · +8 −8Browse files

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

Unified · Split

include/uapi/drm/xe_drm.h+8−8
@@ -410,7 +410,7 @@ struct drm_xe_query_mem_regions { · 409 unmodified lines
410 * device supports the userspace hint %DRM_XE_GEM_CREATE_FLAG_NO_COMPRESSION.410 * device supports the userspace hint %DRM_XE_GEM_CREATE_FLAG_NO_COMPRESSION.
411 * This is exposed only on Xe2+.411 * This is exposed only on Xe2+.
412 * - %DRM_XE_QUERY_CONFIG_FLAG_HAS_DISABLE_STATE_CACHE_PERF_FIX - Flag is set412 * - %DRM_XE_QUERY_CONFIG_FLAG_HAS_DISABLE_STATE_CACHE_PERF_FIX - Flag is set
413 * if a queue can be creaed with413 * if a queue can be created with
414 * %DRM_XE_EXEC_QUEUE_SET_DISABLE_STATE_CACHE_PERF_FIX414 * %DRM_XE_EXEC_QUEUE_SET_DISABLE_STATE_CACHE_PERF_FIX
415 * - %DRM_XE_QUERY_CONFIG_MIN_ALIGNMENT - Minimal memory alignment415 * - %DRM_XE_QUERY_CONFIG_MIN_ALIGNMENT - Minimal memory alignment
416 * required by this device, typically SZ_4K or SZ_64K416 * required by this device, typically SZ_4K or SZ_64K
@@ -888,7 +888,7 @@ struct drm_xe_gem_create { · 471 unmodified lines
888#define DRM_XE_GEM_CPU_CACHING_WC 2888#define DRM_XE_GEM_CPU_CACHING_WC 2
889 /**889 /**
890 * @cpu_caching: The CPU caching mode to select for this object. If890 * @cpu_caching: The CPU caching mode to select for this object. If
891 * mmaping the object the mode selected here will also be used. The891 * mmapping the object the mode selected here will also be used. The
892 * exception is when mapping system memory (including data evicted892 * exception is when mapping system memory (including data evicted
893 * to system) on discrete GPUs. The caching mode selected will893 * to system) on discrete GPUs. The caching mode selected will
894 * then be overridden to DRM_XE_GEM_CPU_CACHING_WB, and coherency894 * then be overridden to DRM_XE_GEM_CPU_CACHING_WB, and coherency
@@ -931,7 +931,7 @@ struct drm_xe_gem_create { · 36 unmodified lines
931 *931 *
932 * err = ioctl(fd, DRM_IOCTL_XE_GEM_MMAP_OFFSET, &mmo);932 * err = ioctl(fd, DRM_IOCTL_XE_GEM_MMAP_OFFSET, &mmo);
933 * map = mmap(NULL, size, PROT_WRITE, MAP_SHARED, fd, mmo.offset);933 * map = mmap(NULL, size, PROT_WRITE, MAP_SHARED, fd, mmo.offset);
934 * map[i] = 0xdeadbeaf; // issue barrier934 * map[i] = 0xdeadbeef; // issue barrier
935 */935 */
936struct drm_xe_gem_mmap_offset {936struct drm_xe_gem_mmap_offset {
937 /** @extensions: Pointer to the first extension struct, if any */937 /** @extensions: Pointer to the first extension struct, if any */
@@ -958,8 +958,8 @@ struct drm_xe_gem_mmap_offset { · 20 unmodified lines
958 * - %DRM_XE_VM_CREATE_FLAG_SCRATCH_PAGE - Map the whole virtual address958 * - %DRM_XE_VM_CREATE_FLAG_SCRATCH_PAGE - Map the whole virtual address
959 * space of the VM to scratch page. A vm_bind would overwrite the scratch959 * space of the VM to scratch page. A vm_bind would overwrite the scratch
960 * page mapping. This flag is mutually exclusive with the960 * page mapping. This flag is mutually exclusive with the
961 * %DRM_XE_VM_CREATE_FLAG_FAULT_MODE flag, with an exception of on x2 and961 * %DRM_XE_VM_CREATE_FLAG_FAULT_MODE flag, with an exception on Xe2 and
962 * xe3 platform.962 * Xe3 platforms.
963 * - %DRM_XE_VM_CREATE_FLAG_LR_MODE - An LR, or Long Running VM accepts963 * - %DRM_XE_VM_CREATE_FLAG_LR_MODE - An LR, or Long Running VM accepts
964 * exec submissions to its exec_queues that don't have an upper time964 * exec submissions to its exec_queues that don't have an upper time
965 * limit on the job execution time. But exec submissions to these965 * limit on the job execution time. But exec submissions to these
@@ -1695,9 +1695,9 @@ struct drm_xe_wait_user_fence { · 729 unmodified lines
1695 * Without DRM_XE_UFENCE_WAIT_FLAG_ABSTIME flag set (relative timeout)1695 * Without DRM_XE_UFENCE_WAIT_FLAG_ABSTIME flag set (relative timeout)
1696 * it contains timeout expressed in nanoseconds to wait (fence will1696 * it contains timeout expressed in nanoseconds to wait (fence will
1697 * expire at now() + timeout).1697 * expire at now() + timeout).
1698 * When DRM_XE_UFENCE_WAIT_FLAG_ABSTIME flat is set (absolute timeout) wait1698 * When DRM_XE_UFENCE_WAIT_FLAG_ABSTIME flag is set (absolute timeout) wait
1699 * will end at timeout (uses system MONOTONIC_CLOCK).1699 * will end at timeout (uses system CLOCK_MONOTONIC).
1700 * Passing negative timeout leads to neverending wait.1700 * Passing negative timeout leads to never ending wait.
1701 *1701 *
1702 * On relative timeout this value is updated with timeout left1702 * On relative timeout this value is updated with timeout left
1703 * (for restarting the call in case of signal delivery).1703 * (for restarting the call in case of signal delivery).