[PATCH] drm/xe/uapi: Correct sync type definition in comments

[Lucas De Marchi]

On Sat, Jun 07, 2025 at 02:34:42AM +0000, Shuicheng Lin wrote:
>DRM_XE_SYNC_FLAG_SYNCOBJ is renamed to DRM_XE_SYNC_TYPE_SYNCOBJ.
>DRM_XE_SYNC_FLAG_TIMELINE_SYNCOBJ is renamed to DRM_XE_SYNC_TYPE_TIMELINE_SYNCOBJ.
>DRM_XE_SYNC_FLAG_DMA_BUF is removed.

This can be seen by the diff. Here it'd be better to explain why, not
what:

>
>Fixes: dc787f8931af ("drm/xe/uapi: Split xe_sync types from flags")

this is not really correct. The rename happened in that commit, but the
commits using the old names came later. So I think the commit message 
should be something like this:

Commit dc787f8931af ("drm/xe/uapi: Split xe_sync types from flags")
renamed some DRM_XE_SYNC_* defines but later commits kept using the
old names.


Fixes: 9329f0667215 ("drm/xe/uapi: Use LR abbrev for long-running vms")
Fixes: 4b437893a826 ("drm/xe/uapi: More uAPI documentation additions and cosmetic updates")

with that,  Reviewed-by: Lucas De Marchi <lucas.demarchi at intel.com>


thanks
Lucas De Marchi

>Cc: Rodrigo Vivi <rodrigo.vivi at intel.com>
>Cc: Francois Dugast <francois.dugast at intel.com>
>Cc: Zongyao Bai <zongyao.bai at intel.com>
>Signed-off-by: Shuicheng Lin <shuicheng.lin at intel.com>
>---
> include/uapi/drm/xe_drm.h | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
>diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
>index 6a702ba7817c..5f1524f466a7 100644
>--- a/include/uapi/drm/xe_drm.h
>+++ b/include/uapi/drm/xe_drm.h
>@@ -925,9 +925,9 @@ struct drm_xe_gem_mmap_offset {
>  *  - %DRM_XE_VM_CREATE_FLAG_LR_MODE - An LR, or Long Running VM accepts
>  *    exec submissions to its exec_queues that don't have an upper time
>  *    limit on the job execution time. But exec submissions to these
>- *    don't allow any of the flags DRM_XE_SYNC_FLAG_SYNCOBJ,
>- *    DRM_XE_SYNC_FLAG_TIMELINE_SYNCOBJ, DRM_XE_SYNC_FLAG_DMA_BUF,
>- *    used as out-syncobjs, that is, together with DRM_XE_SYNC_FLAG_SIGNAL.
>+ *    don't allow any of the sync types DRM_XE_SYNC_TYPE_SYNCOBJ,
>+ *    DRM_XE_SYNC_TYPE_TIMELINE_SYNCOBJ, used as out-syncobjs, that is,
>+ *    together with sync flag DRM_XE_SYNC_FLAG_SIGNAL.
>  *    LR VMs can be created in recoverable page-fault mode using
>  *    DRM_XE_VM_CREATE_FLAG_FAULT_MODE, if the device supports it.
>  *    If that flag is omitted, the UMD can not rely on the slightly
>@@ -1394,7 +1394,7 @@ struct drm_xe_sync {
>
> 	/**
> 	 * @timeline_value: Input for the timeline sync object. Needs to be
>-	 * different than 0 when used with %DRM_XE_SYNC_FLAG_TIMELINE_SYNCOBJ.
>+	 * different than 0 when used with %DRM_XE_SYNC_TYPE_TIMELINE_SYNCOBJ.
> 	 */
> 	__u64 timeline_value;
>
>-- 
>2.25.1
>