Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Jani Nikula <jani.nikula@intel.com>
Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/89ab5cf179566c429383cc57db746038f75cba0d.1683041799.git.jani.nikula@intel.com

+27 -18
+27 -18
drivers/gpu/drm/i915/i915_vma_resource.h
··· 34 34 }; 35 35 36 36 /** 37 + * struct i915_vma_bindinfo - Information needed for async bind 38 + * only but that can be dropped after the bind has taken place. 39 + * Consider making this a separate argument to the bind_vma 40 + * op, coalescing with other arguments like vm, stash, cache_level 41 + * and flags 42 + * @pages: The pages sg-table. 43 + * @page_sizes: Page sizes of the pages. 44 + * @pages_rsgt: Refcounted sg-table when delayed object destruction 45 + * is supported. May be NULL. 46 + * @readonly: Whether the vma should be bound read-only. 47 + * @lmem: Whether the vma points to lmem. 48 + */ 49 + struct i915_vma_bindinfo { 50 + struct sg_table *pages; 51 + struct i915_page_sizes page_sizes; 52 + struct i915_refct_sgt *pages_rsgt; 53 + bool readonly:1; 54 + bool lmem:1; 55 + }; 56 + 57 + /** 37 58 * struct i915_vma_resource - Snapshotted unbind information. 38 59 * @unbind_fence: Fence to mark unbinding complete. Note that this fence 39 60 * is not considered published until unbind is scheduled, and as such it ··· 110 89 intel_wakeref_t wakeref; 111 90 112 91 /** 113 - * struct i915_vma_bindinfo - Information needed for async bind 114 - * only but that can be dropped after the bind has taken place. 115 - * Consider making this a separate argument to the bind_vma 116 - * op, coalescing with other arguments like vm, stash, cache_level 117 - * and flags 118 - * @pages: The pages sg-table. 119 - * @page_sizes: Page sizes of the pages. 120 - * @pages_rsgt: Refcounted sg-table when delayed object destruction 121 - * is supported. May be NULL. 122 - * @readonly: Whether the vma should be bound read-only. 123 - * @lmem: Whether the vma points to lmem. 92 + * @bi: Information needed for async bind only but that can be dropped 93 + * after the bind has taken place. 94 + * 95 + * Consider making this a separate argument to the bind_vma op, 96 + * coalescing with other arguments like vm, stash, cache_level and flags 124 97 */ 125 - struct i915_vma_bindinfo { 126 - struct sg_table *pages; 127 - struct i915_page_sizes page_sizes; 128 - struct i915_refct_sgt *pages_rsgt; 129 - bool readonly:1; 130 - bool lmem:1; 131 - } bi; 98 + struct i915_vma_bindinfo bi; 132 99 133 100 #if IS_ENABLED(CONFIG_DRM_I915_CAPTURE_ERROR) 134 101 struct intel_memory_region *mr;