Commit aef7b67a authored by Matthew Auld's avatar Matthew Auld
Browse files

drm/i915/uapi: convert drm_i915_gem_userptr to kernel doc 



Add the missing kernel-doc.

Signed-off-by: default avatarMatthew Auld <matthew.auld@intel.com>
Cc: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Kenneth Graunke <kenneth@whitecape.org>
Cc: Jason Ekstrand <jason@jlekstrand.net>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Ramalingam C <ramalingam.c@intel.com>
Reviewed-by: default avatarMaarten Lankhorst <maarten.lankhorst@linux.intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20210715101536.2606307-3-matthew.auld@intel.com
parent e7737b67

include/uapi/drm/i915_drm.h

+39 −1
Original line number Diff line number Diff line
@@ -2141,14 +2141,52 @@ struct drm_i915_reset_stats { 
	__u32 pad;

};



/**

 * struct drm_i915_gem_userptr - Create GEM object from user allocated memory.

 *

 * Userptr objects have several restrictions on what ioctls can be used with the

 * object handle.

 */

struct drm_i915_gem_userptr {

	/**

	 * @user_ptr: The pointer to the allocated memory.

	 *

	 * Needs to be aligned to PAGE_SIZE.

	 */

	__u64 user_ptr;



	/**

	 * @user_size:

	 *

	 * The size in bytes for the allocated memory. This will also become the

	 * object size.

	 *

	 * Needs to be aligned to PAGE_SIZE, and should be at least PAGE_SIZE,

	 * or larger.

	 */

	__u64 user_size;



	/**

	 * @flags:

	 *

	 * Supported flags:

	 *

	 * I915_USERPTR_READ_ONLY:

	 *

	 * Mark the object as readonly, this also means GPU access can only be

	 * readonly. This is only supported on HW which supports readonly access

	 * through the GTT. If the HW can't support readonly access, an error is

	 * returned.

	 *

	 * I915_USERPTR_UNSYNCHRONIZED:

	 *

	 * NOT USED. Setting this flag will result in an error.

	 */

	__u32 flags;

#define I915_USERPTR_READ_ONLY 0x1

#define I915_USERPTR_UNSYNCHRONIZED 0x80000000

	/**

	 * Returned handle for the object.

	 * @handle: Returned handle for the object.

	 *

	 * Object handles are nonzero.

	 */