drm/xe/uapi: Document drm_xe_query_gt

Split drm_xe_query_gt out of the gt list one in order to better
document it.

No functional change at this point. Any actual change to the
uapi should come in follow-up additions.

v2: s/maks/mask

Cc: Matt Roper <matthew.d.roper@intel.com>
Signed-off-by: Francois Dugast <francois.dugast@intel.com>
Signed-off-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
Reviewed-by: Matthew Brost <matthew.brost@intel.com>

diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
index 4dc103aa00f11fb0291bef3051aefa277459ed52..53b7b2ddf3042fccc024140ca8663b66ef8ce9b4 100644 (file)
--- a/include/uapi/drm/xe_drm.h
+++ b/include/uapi/drm/xe_drm.h
@@ -334,6 +334,47 @@ struct drm_xe_query_config {
        __u64 info[];
 };
 
+/**
+ * struct drm_xe_query_gt - describe an individual GT.
+ *
+ * To be used with drm_xe_query_gts, which will return a list with all the
+ * existing GT individual descriptions.
+ * Graphics Technology (GT) is a subset of a GPU/tile that is responsible for
+ * implementing graphics and/or media operations.
+ */
+struct drm_xe_query_gt {
+#define XE_QUERY_GT_TYPE_MAIN          0
+#define XE_QUERY_GT_TYPE_REMOTE                1
+#define XE_QUERY_GT_TYPE_MEDIA         2
+       /** @type: GT type: Main, Remote, or Media */
+       __u16 type;
+       /** @instance: Instance of this GT in the GT list */
+       __u16 instance;
+       /** @clock_freq: A clock frequency for timestamp */
+       __u32 clock_freq;
+       /** @features: Reserved for future information about GT features */
+       __u64 features;
+       /**
+        * @native_mem_regions: Bit mask of instances from
+        * drm_xe_query_mem_usage that lives on the same GPU/Tile and have
+        * direct access.
+        */
+       __u64 native_mem_regions;
+       /**
+        * @slow_mem_regions: Bit mask of instances from
+        * drm_xe_query_mem_usage that this GT can indirectly access, although
+        * they live on a different GPU/Tile.
+        */
+       __u64 slow_mem_regions;
+       /**
+        * @inaccessible_mem_regions: Bit mask of instances from
+        * drm_xe_query_mem_usage that is not accessible by this GT at all.
+        */
+       __u64 inaccessible_mem_regions;
+       /** @reserved: Reserved */
+       __u64 reserved[8];
+};
+
 /**
  * struct drm_xe_query_gts - describe GTs
  *
@@ -344,30 +385,10 @@ struct drm_xe_query_config {
 struct drm_xe_query_gts {
        /** @num_gt: number of GTs returned in gts */
        __u32 num_gt;
-
        /** @pad: MBZ */
        __u32 pad;
-
-       /**
-        * @gts: The GTs returned for this device
-        *
-        * TODO: convert drm_xe_query_gt to proper kernel-doc.
-        * TODO: Perhaps info about every mem region relative to this GT? e.g.
-        * bandwidth between this GT and remote region?
-        */
-       struct drm_xe_query_gt {
-#define XE_QUERY_GT_TYPE_MAIN          0
-#define XE_QUERY_GT_TYPE_REMOTE                1
-#define XE_QUERY_GT_TYPE_MEDIA         2
-               __u16 type;
-               __u16 instance;
-               __u32 clock_freq;
-               __u64 features;
-               __u64 native_mem_regions;       /* bit mask of instances from drm_xe_query_mem_usage */
-               __u64 slow_mem_regions;         /* bit mask of instances from drm_xe_query_mem_usage */
-               __u64 inaccessible_mem_regions; /* bit mask of instances from drm_xe_query_mem_usage */
-               __u64 reserved[8];
-       } gts[];
+       /** @gts: The GT list returned for this device */
+       struct drm_xe_query_gt gts[];
 };
 
 /**