[PATCH v1 07/14] drm/xe/uapi: Replace BO with GEM in documentation

[Matthew Auld]

On Thu, 7 Dec 2023 at 14:27, Francois Dugast <francois.dugast at intel.com> wrote:
>
> Align documentation with names of constants and structs, which
> use GEM instead of BO.

AFAIK GEM means Graphics Execution Manager, which is just a memory
management backend. Maybe "GEM BO" would be better here? IMO saying "A
mask of memory instances of where GEM can be placed" doesn't sound
correct.

>
> Signed-off-by: Francois Dugast <francois.dugast at intel.com>
> ---
>  include/uapi/drm/xe_drm.h | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
> index e608a8e7dd76..f9178fe024a5 100644
> --- a/include/uapi/drm/xe_drm.h
> +++ b/include/uapi/drm/xe_drm.h
> @@ -610,14 +610,14 @@ struct drm_xe_gem_create {
>          */
>         __u64 size;
>
> -       /** @placement: A mask of memory instances of where BO can be placed. */
> +       /** @placement: A mask of memory instances of where GEM can be placed. */
>         __u32 placement;
>
>  #define DRM_XE_GEM_CREATE_FLAG_DEFER_BACKING           (1 << 0)
>  #define DRM_XE_GEM_CREATE_FLAG_SCANOUT                 (1 << 1)
>  #define DRM_XE_GEM_CREATE_FLAG_NEEDS_VISIBLE_VRAM      (1 << 2)
>         /**
> -        * @flags: Flags, currently a mask of memory instances of where BO can
> +        * @flags: Flags, currently a mask of memory instances of where GEM can
>          * be placed
>          */
>         __u32 flags;
> @@ -625,7 +625,7 @@ struct drm_xe_gem_create {
>         /**
>          * @vm_id: Attached VM, if any
>          *
> -        * If a VM is specified, this BO must:
> +        * If a VM is specified, this GEM must:
>          *
>          *  1. Only ever be bound to that VM.
>          *  2. Cannot be exported as a PRIME fd.
> @@ -768,8 +768,8 @@ struct drm_xe_vm_destroy {
>   *  - %DRM_XE_VM_BIND_FLAG_NULL - When the NULL flag is set, the page
>   *    tables are setup with a special bit which indicates writes are
>   *    dropped and all reads return zero. In the future, the NULL flags
> - *    will only be valid for DRM_XE_VM_BIND_OP_MAP operations, the BO
> - *    handle MBZ, and the BO offset MBZ. This flag is intended to
> + *    will only be valid for DRM_XE_VM_BIND_OP_MAP operations, the GEM
> + *    handle MBZ, and the GEM offset MBZ. This flag is intended to
>   *    implement VK sparse bindings.
>   */
>  struct drm_xe_vm_bind_op {
> --
> 2.34.1
>