[Intel-xe] [RFC v1 10/17] fixup! drm/xe: Add uAPI to query micro-controler firmware version

Francois Dugast francois.dugast at intel.com
Wed Oct 11 13:59:19 UTC 2023


Remove warnings below when building documentation:

    ./include/uapi/drm/xe_drm.h:491: warning: Function parameter or member 'uc_type' not described in 'drm_xe_query_uc_fw_version'
    ./include/uapi/drm/xe_drm.h:491: warning: Function parameter or member 'major_ver' not described in 'drm_xe_query_uc_fw_version'
    ./include/uapi/drm/xe_drm.h:491: warning: Function parameter or member 'minor_ver' not described in 'drm_xe_query_uc_fw_version'
    ./include/uapi/drm/xe_drm.h:491: warning: Function parameter or member 'patch_ver' not described in 'drm_xe_query_uc_fw_version'
    ./include/uapi/drm/xe_drm.h:491: warning: Function parameter or member 'branch_ver' not described in 'drm_xe_query_uc_fw_version'

Signed-off-by: Francois Dugast <francois.dugast at intel.com>
---
 include/uapi/drm/xe_drm.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
index 4755aa5e73f2..f0c32da829b9 100644
--- a/include/uapi/drm/xe_drm.h
+++ b/include/uapi/drm/xe_drm.h
@@ -466,7 +466,7 @@ struct drm_xe_query_topology_mask {
  * of the micro-controller firmware.
  */
 struct drm_xe_query_uc_fw_version {
-	/** @uc: The micro-controller type to query firmware version */
+	/** @uc_type: The micro-controller type to query firmware version */
 #define DRM_XE_QUERY_UC_TYPE_GUC	0
 #define DRM_XE_QUERY_UC_TYPE_HUC	1
 	__u16 uc_type;
@@ -474,13 +474,13 @@ struct drm_xe_query_uc_fw_version {
 	/** @pad: MBZ */
 	__u16 pad;
 
-	/* @major_ver: major uc fw version */
+	/** @major_ver: major uc fw version */
 	__u32 major_ver;
-	/* @minor_ver: minor uc fw version */
+	/** @minor_ver: minor uc fw version */
 	__u32 minor_ver;
-	/* @patch_ver: patch uc fw version */
+	/** @patch_ver: patch uc fw version */
 	__u32 patch_ver;
-	/* @branch_ver: branch uc fw version */
+	/** @branch_ver: branch uc fw version */
 	__u32 branch_ver;
 
 	/** @pad2: MBZ */
-- 
2.34.1



More information about the Intel-xe mailing list