Commit 1c671ad7 authored by Matt Roper's avatar Matt Roper
Browse files

drm/i915/doc: Link query items to their uapi structs 



Document the possible options for drm_i915_query_item.query_id with
links to the corresponding uapi structures.

Signed-off-by: default avatarMatt Roper <matthew.d.roper@intel.com>
Reviewed-by: default avatarFrancisco Jerez <currojerez@riseup.net>
Link: https://patchwork.freedesktop.org/patch/msgid/20220414192230.749771-3-matthew.d.roper@intel.com
parent a2e54026

include/uapi/drm/i915_drm.h

+20 −14
Original line number Diff line number Diff line
@@ -2724,12 +2724,18 @@ 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 */

	/**

	 * @query_id:

	 *

	 * The id for this query.  Currently accepted query IDs are:

	 *  - %DRM_I915_QUERY_TOPOLOGY_INFO (see struct drm_i915_query_topology_info)

	 *  - %DRM_I915_QUERY_ENGINE_INFO (see struct drm_i915_engine_info)

	 *  - %DRM_I915_QUERY_PERF_CONFIG (see struct drm_i915_query_perf_config)

	 *  - %DRM_I915_QUERY_MEMORY_REGIONS (see struct drm_i915_query_memory_regions)

	 *  - %DRM_I915_QUERY_HWCONFIG_BLOB (see `GuC HWCONFIG blob uAPI`)

	 */

	__u64 query_id;

#define DRM_I915_QUERY_TOPOLOGY_INFO		1

#define DRM_I915_QUERY_ENGINE_INFO		2
@@ -2751,14 +2757,14 @@ struct drm_i915_query_item { 
	/**

	 * @flags:

	 *

	 * When query_id == DRM_I915_QUERY_TOPOLOGY_INFO, must be 0.

	 * When &query_id == %DRM_I915_QUERY_TOPOLOGY_INFO, must be 0.

	 *

	 * When query_id == DRM_I915_QUERY_PERF_CONFIG, must be one of the

	 * When &query_id == %DRM_I915_QUERY_PERF_CONFIG, must be one of the

	 * following:

	 *

	 *	- DRM_I915_QUERY_PERF_CONFIG_LIST

	 *      - DRM_I915_QUERY_PERF_CONFIG_DATA_FOR_UUID

	 *      - DRM_I915_QUERY_PERF_CONFIG_FOR_UUID

	 *	- %DRM_I915_QUERY_PERF_CONFIG_LIST

	 *      - %DRM_I915_QUERY_PERF_CONFIG_DATA_FOR_UUID

	 *      - %DRM_I915_QUERY_PERF_CONFIG_FOR_UUID

	 */

	__u32 flags;

#define DRM_I915_QUERY_PERF_CONFIG_LIST          1