History

drm/i915/uapi: convert drm_i915_gem_userptr to kernel doc

Add the missing kernel-doc.

Matthew Auld committed 5 years ago

Commit aef7b671 parent e7737b61 file · +39 −1Browse files

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

Unified · Split

include/uapi/drm/i915_drm.h+39−1
@@ -2141,14 +2141,52 @@ struct drm_i915_reset_stats { · 2140 unmodified lines
2141 __u32 pad;2141 __u32 pad;
2142};2142};
2143 2143
2144/**
2145 * struct drm_i915_gem_userptr - Create GEM object from user allocated memory.
2146 *
2147 * Userptr objects have several restrictions on what ioctls can be used with the
2148 * object handle.
2149 */
2144struct drm_i915_gem_userptr {2150struct drm_i915_gem_userptr {
2151 /**
2152 * @user_ptr: The pointer to the allocated memory.
2153 *
2154 * Needs to be aligned to PAGE_SIZE.
2155 */
2145 __u64 user_ptr;2156 __u64 user_ptr;
2157
2158 /**
2159 * @user_size:
2160 *
2161 * The size in bytes for the allocated memory. This will also become the
2162 * object size.
2163 *
2164 * Needs to be aligned to PAGE_SIZE, and should be at least PAGE_SIZE,
2165 * or larger.
2166 */
2146 __u64 user_size;2167 __u64 user_size;
2168
2169 /**
2170 * @flags:
2171 *
2172 * Supported flags:
2173 *
2174 * I915_USERPTR_READ_ONLY:
2175 *
2176 * Mark the object as readonly, this also means GPU access can only be
2177 * readonly. This is only supported on HW which supports readonly access
2178 * through the GTT. If the HW can't support readonly access, an error is
2179 * returned.
2180 *
2181 * I915_USERPTR_UNSYNCHRONIZED:
2182 *
2183 * NOT USED. Setting this flag will result in an error.
2184 */
2147 __u32 flags;2185 __u32 flags;
2148#define I915_USERPTR_READ_ONLY 0x12186#define I915_USERPTR_READ_ONLY 0x1
2149#define I915_USERPTR_UNSYNCHRONIZED 0x800000002187#define I915_USERPTR_UNSYNCHRONIZED 0x80000000
2150 /**2188 /**
2151 * Returned handle for the object.2189 * @handle: Returned handle for the object.
2152 *2190 *
2153 * Object handles are nonzero.2191 * Object handles are nonzero.
2154 */2192 */