Re: [PATCH] drm/xe/uapi: Add documentation for DRM_XE_GEM_CREATE_FLAG_SCANOUT

[Matthew Auld <matthew.auld@intel.com>]

On 14/10/2025 15:28, Sanjay Yadav wrote:
> Add documentation for drm_xe_gem_create structure flag
> DRM_XE_GEM_CREATE_FLAG_SCANOUT.
> 
> Signed-off-by: Sanjay Yadav <sanjay.kumar.yadav@intel.com>
Reviewed-by: Matthew Auld <matthew.auld@intel.com>

> ---
>   include/uapi/drm/xe_drm.h | 6 +++++-
>   1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
> index 40ff19f52a8d..2d7945cda739 100644
> --- a/include/uapi/drm/xe_drm.h
> +++ b/include/uapi/drm/xe_drm.h
> @@ -771,7 +771,11 @@ struct drm_xe_device_query {
>    *    until the object is either bound to a virtual memory region via
>    *    VM_BIND or accessed by the CPU. As a result, no backing memory is
>    *    reserved at the time of GEM object creation.
> - *  - %DRM_XE_GEM_CREATE_FLAG_SCANOUT
> + *  - %DRM_XE_GEM_CREATE_FLAG_SCANOUT - Indicates that the GEM object is
> + *    intended for scanout via the display engine. When set, kernel ensures
> + *    that the allocation is placed in a memory region compatible with the
> + *    display engine requirements. This may impose restrictions on tiling,
> + *    alignment, and memory placement to guarantee proper display functionality.
>    *  - %DRM_XE_GEM_CREATE_FLAG_NEEDS_VISIBLE_VRAM - When using VRAM as a
>    *    possible placement, ensure that the corresponding VRAM allocation
>    *    will always use the CPU accessible part of VRAM. This is important