[Intel-xe] [PATCH] fixup! drm/xe: Make DRM_XE_DEVICE_QUERY_ENGINES future proof

[Intel-xe] [PATCH] fixup! drm/xe: Make DRM_XE_DEVICE_QUERY_ENGINES future proof

[Lucas De Marchi]

Fix kerneldoc build, as being warned by CI with the Hooks execution.

	$ find drivers/gpu/drm/xe/ -name '*.[ch]' -not -path 'drivers/gpu/drm/xe/display/*' | \
		xargs ./scripts/kernel-doc -Werror -none include/uapi/drm/xe_drm.h
	include/uapi/drm/xe_drm.h:152: warning: Function parameter or member 'engine_class' not described in 'drm_xe_engine_class_instance'
	include/uapi/drm/xe_drm.h:152: warning: Function parameter or member 'engine_instance' not described in 'drm_xe_engine_class_instance'
	include/uapi/drm/xe_drm.h:152: warning: Function parameter or member 'gt_id' not described in 'drm_xe_engine_class_instance'
	3 warnings as Errors

Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
---
 include/uapi/drm/xe_drm.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
index eb03a49c17a1..0895e4d2a981 100644
--- a/include/uapi/drm/xe_drm.h
+++ b/include/uapi/drm/xe_drm.h
@@ -129,7 +129,6 @@ struct xe_user_extension {
  * It is returned as part of the @drm_xe_engine, but it also is used as
  * the input of engine selection for both @drm_xe_exec_queue_create and
  * @drm_xe_query_engine_cycles
- *
  */
 struct drm_xe_engine_class_instance {
 #define DRM_XE_ENGINE_CLASS_RENDER		0
@@ -143,9 +142,11 @@ struct drm_xe_engine_class_instance {
 	 */
 #define DRM_XE_ENGINE_CLASS_VM_BIND_ASYNC	5
 #define DRM_XE_ENGINE_CLASS_VM_BIND_SYNC	6
+	/** @engine_class: engine class id */
 	__u16 engine_class;
-
+	/** @engine_instance: engine instance id */
 	__u16 engine_instance;
+	/** @gt_id: Unique ID of this GT within the PCI Device */
 	__u16 gt_id;
 	/** @pad: MBZ */
 	__u16 pad;
-- 
2.40.1

Re: [Intel-xe] [PATCH] fixup! drm/xe: Make DRM_XE_DEVICE_QUERY_ENGINES future proof

[Francois Dugast]

On Tue, Dec 05, 2023 at 09:43:49AM -0800, Lucas De Marchi wrote:
> Fix kerneldoc build, as being warned by CI with the Hooks execution.
> 
> 	$ find drivers/gpu/drm/xe/ -name '*.[ch]' -not -path 'drivers/gpu/drm/xe/display/*' | \
> 		xargs ./scripts/kernel-doc -Werror -none include/uapi/drm/xe_drm.h
> 	include/uapi/drm/xe_drm.h:152: warning: Function parameter or member 'engine_class' not described in 'drm_xe_engine_class_instance'
> 	include/uapi/drm/xe_drm.h:152: warning: Function parameter or member 'engine_instance' not described in 'drm_xe_engine_class_instance'
> 	include/uapi/drm/xe_drm.h:152: warning: Function parameter or member 'gt_id' not described in 'drm_xe_engine_class_instance'
> 	3 warnings as Errors
> 
> Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>

Thanks. FYI kerneldoc series is in preparation to fix a few more things.

Reviewed-by: Francois Dugast <francois.dugast@intel.com>

> ---
>  include/uapi/drm/xe_drm.h | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
> index eb03a49c17a1..0895e4d2a981 100644
> --- a/include/uapi/drm/xe_drm.h
> +++ b/include/uapi/drm/xe_drm.h
> @@ -129,7 +129,6 @@ struct xe_user_extension {
>   * It is returned as part of the @drm_xe_engine, but it also is used as
>   * the input of engine selection for both @drm_xe_exec_queue_create and
>   * @drm_xe_query_engine_cycles
> - *
>   */
>  struct drm_xe_engine_class_instance {
>  #define DRM_XE_ENGINE_CLASS_RENDER		0
> @@ -143,9 +142,11 @@ struct drm_xe_engine_class_instance {
>  	 */
>  #define DRM_XE_ENGINE_CLASS_VM_BIND_ASYNC	5
>  #define DRM_XE_ENGINE_CLASS_VM_BIND_SYNC	6
> +	/** @engine_class: engine class id */
>  	__u16 engine_class;
> -
> +	/** @engine_instance: engine instance id */
>  	__u16 engine_instance;
> +	/** @gt_id: Unique ID of this GT within the PCI Device */
>  	__u16 gt_id;
>  	/** @pad: MBZ */
>  	__u16 pad;
> -- 
> 2.40.1
> 

[Intel-xe] ✗ CI.Patch_applied: failure for fixup! drm/xe: Make DRM_XE_DEVICE_QUERY_ENGINES future proof

[Patchwork]

== Series Details ==

Series: fixup! drm/xe: Make DRM_XE_DEVICE_QUERY_ENGINES future proof
URL   : https://patchwork.freedesktop.org/series/127373/
State : failure

== Summary ==

=== Applying kernel patches on branch 'drm-xe-next' with base: ===
Base commit: 6ac758520 drm/xe/kunit: Test WAs for MTL and LNL
=== git am output follows ===
error: patch failed: include/uapi/drm/xe_drm.h:129
error: include/uapi/drm/xe_drm.h: patch does not apply
hint: Use 'git am --show-current-patch' to see the failed patch
Applying: fixup! drm/xe: Make DRM_XE_DEVICE_QUERY_ENGINES future proof
Patch failed at 0001 fixup! drm/xe: Make DRM_XE_DEVICE_QUERY_ENGINES future proof
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".