Commit e9711213 authored by Jani Nikula's avatar Jani Nikula
Browse files

drm/i915/vma: fix struct i915_vma_bindinfo kernel-doc 



You can't document both a sub-struct type and a struct member at the
same time. Separate them.

drivers/gpu/drm/i915/i915_vma_resource.h:91: warning: Incorrect use of kernel-doc format:          * struct i915_vma_bindinfo - Information needed for async bind
drivers/gpu/drm/i915/i915_vma_resource.h:129: warning: Function parameter or member 'bi' not described in 'i915_vma_resource'

Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
Reviewed-by: default avatarRodrigo Vivi <rodrigo.vivi@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/89ab5cf179566c429383cc57db746038f75cba0d.1683041799.git.jani.nikula@intel.com
parent 31cc65b4

drivers/gpu/drm/i915/i915_vma_resource.h

+27 −18
Original line number Diff line number Diff line
@@ -33,6 +33,27 @@ struct i915_page_sizes { 
	unsigned int sg;

};



/**

 * struct i915_vma_bindinfo - Information needed for async bind

 * only but that can be dropped after the bind has taken place.

 * Consider making this a separate argument to the bind_vma

 * op, coalescing with other arguments like vm, stash, cache_level

 * and flags

 * @pages: The pages sg-table.

 * @page_sizes: Page sizes of the pages.

 * @pages_rsgt: Refcounted sg-table when delayed object destruction

 * is supported. May be NULL.

 * @readonly: Whether the vma should be bound read-only.

 * @lmem: Whether the vma points to lmem.

 */

struct i915_vma_bindinfo {

	struct sg_table *pages;

	struct i915_page_sizes page_sizes;

	struct i915_refct_sgt *pages_rsgt;

	bool readonly:1;

	bool lmem:1;

};



/**

 * struct i915_vma_resource - Snapshotted unbind information.

 * @unbind_fence: Fence to mark unbinding complete. Note that this fence
@@ -89,25 +110,13 @@ struct i915_vma_resource { 
	intel_wakeref_t wakeref;



	/**

	 * struct i915_vma_bindinfo - Information needed for async bind

	 * only but that can be dropped after the bind has taken place.

	 * Consider making this a separate argument to the bind_vma

	 * op, coalescing with other arguments like vm, stash, cache_level

	 * and flags

	 * @pages: The pages sg-table.

	 * @page_sizes: Page sizes of the pages.

	 * @pages_rsgt: Refcounted sg-table when delayed object destruction

	 * is supported. May be NULL.

	 * @readonly: Whether the vma should be bound read-only.

	 * @lmem: Whether the vma points to lmem.

	 * @bi: Information needed for async bind only but that can be dropped

	 * after the bind has taken place.

	 *

	 * Consider making this a separate argument to the bind_vma op,

	 * coalescing with other arguments like vm, stash, cache_level and flags

	 */

	struct i915_vma_bindinfo {

		struct sg_table *pages;

		struct i915_page_sizes page_sizes;

		struct i915_refct_sgt *pages_rsgt;

		bool readonly:1;

		bool lmem:1;

	} bi;

	struct i915_vma_bindinfo bi;



#if IS_ENABLED(CONFIG_DRM_I915_CAPTURE_ERROR)

	struct intel_memory_region *mr;