aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTvrtko Ursulin <[email protected]>2022-03-25 09:49:16 +0000
committerTvrtko Ursulin <[email protected]>2022-03-25 16:21:07 +0000
commit034d47b25b2ce627f1e1b04242d72db4180f3525 (patch)
tree4a94ee97dd7bd1db2239db8b1ffd04ecdc72e02e
parenta0f1f7b4f74fc6eaee0b6783af40dacf431df7b4 (diff)
drm/i915/uapi: Document DRM_I915_QUERY_HWCONFIG_BLOB
UAPI with absolutely no documentation should not have been added - clarify blob format and content will be described externally. Fixes: 78e1fb3112c0 ("drm/i915/uapi: Add query for hwconfig blob") Signed-off-by: Tvrtko Ursulin <[email protected]> Co-developed-by: Jordan Justen <[email protected]> Cc: Jon Bloomfield <[email protected]> Cc: Daniel Vetter <[email protected]> Cc: John Harrison <[email protected]> Cc: Jon Ewins <[email protected]> Cc: Joonas Lahtinen <[email protected]> Cc: Rodrigo Vivi <[email protected]> Reviewed-by: Daniel Vetter <[email protected]> Link: https://patchwork.freedesktop.org/patch/msgid/[email protected] [tursulin: Fixed spelling s/meading/meaning/.]
-rw-r--r--include/uapi/drm/i915_drm.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/include/uapi/drm/i915_drm.h b/include/uapi/drm/i915_drm.h
index 071ffd9d51f1..9ab021c4d632 100644
--- a/include/uapi/drm/i915_drm.h
+++ b/include/uapi/drm/i915_drm.h
@@ -2683,6 +2683,9 @@ struct drm_i915_perf_oa_config {
*
* The behaviour is determined by the @query_id. Note that exactly what
* @data_ptr is also depends on the specific @query_id.
+ *
+ * For specific queries see:
+ * * `GuC HWCONFIG blob uAPI`_
*/
struct drm_i915_query_item {
/** @query_id: The id for this query */
@@ -3136,6 +3139,16 @@ struct drm_i915_query_memory_regions {
};
/**
+ * DOC: GuC HWCONFIG blob uAPI
+ *
+ * The GuC produces a blob with information about the current device.
+ * i915 reads this blob from GuC and makes it available via this uAPI.
+ *
+ * The format and meaning of the blob content are documented in the
+ * Programmer's Reference Manual.
+ */
+
+/**
* struct drm_i915_gem_create_ext - Existing gem_create behaviour, with added
* extension support using struct i915_user_extension.
*