History

drm/i915/uapi: fix kernel doc warnings

Fix the cases where it is almost already valid kernel doc, for the others just nerf the warnings for now.

Matthew Auld committed 5 years ago

Commit 2ef6a011 parent 399cd971 file · +16 −16Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

include/uapi/drm/i915_drm.h+16−16
@@ -1054,12 +1054,12 @@ struct drm_i915_gem_exec_fence { · 1053 unmodified lines
10541054 __u32 flags;
10551055 };
10561056
1057−/**
1057+/*
10581058 * See drm_i915_gem_execbuffer_ext_timeline_fences.
10591059 */
10601060 #define DRM_I915_GEM_EXECBUFFER_EXT_TIMELINE_FENCES 0
10611061
1062−/**
1062+/*
10631063 * This structure describes an array of drm_syncobj and associated points for
10641064 * timeline variants of drm_syncobj. It is invalid to append this structure to
10651065 * the execbuf if I915_EXEC_FENCE_ARRAY is set.
@@ -1700,7 +1700,7 @@ struct drm_i915_gem_context_param { · 634 unmodified lines
17001700 __u64 value;
17011701 };
17021702
1703−/**
1703+/*
17041704 * Context SSEU programming
17051705 *
17061706 * It may be necessary for either functional or performance reason to configure
@@ -2067,7 +2067,7 @@ struct drm_i915_perf_open_param { · 360 unmodified lines
20672067 __u64 properties_ptr;
20682068 };
20692069
2070−/**
2070+/*
20712071 * Enable data capture for a stream that was either opened in a disabled state
20722072 * via I915_PERF_FLAG_DISABLED or was later disabled via
20732073 * I915_PERF_IOCTL_DISABLE.
@@ -2081,7 +2081,7 @@ struct drm_i915_perf_open_param { · 7 unmodified lines
20812081 */
20822082 #define I915_PERF_IOCTL_ENABLE _IO('i', 0x0)
20832083
2084−/**
2084+/*
20852085 * Disable data capture for a stream.
20862086 *
20872087 * It is an error to try and read a stream that is disabled.
@@ -2090,7 +2090,7 @@ struct drm_i915_perf_open_param { · 2 unmodified lines
20902090 */
20912091 #define I915_PERF_IOCTL_DISABLE _IO('i', 0x1)
20922092
2093−/**
2093+/*
20942094 * Change metrics_set captured by a stream.
20952095 *
20962096 * If the stream is bound to a specific context, the configuration change
@@ -2103,7 +2103,7 @@ struct drm_i915_perf_open_param { · 6 unmodified lines
21032103 */
21042104 #define I915_PERF_IOCTL_CONFIG _IO('i', 0x2)
21052105
2106−/**
2106+/*
21072107 * Common to all i915 perf records
21082108 */
21092109 struct drm_i915_perf_record_header {
@@ -2151,7 +2151,7 @@ enum drm_i915_perf_record_type { · 41 unmodified lines
21512151 DRM_I915_PERF_RECORD_MAX /* non-ABI */
21522152 };
21532153
2154−/**
2154+/*
21552155 * Structure to upload perf dynamic configuration into the kernel.
21562156 */
21572157 struct drm_i915_perf_oa_config {
@@ -2292,21 +2292,21 @@ struct drm_i915_query_topology_info { · 134 unmodified lines
22922292 * Describes one engine and it's capabilities as known to the driver.
22932293 */
22942294 struct drm_i915_engine_info {
2295− /** Engine class and instance. */
2295+ /** @engine: Engine class and instance. */
22962296 struct i915_engine_class_instance engine;
22972297
2298− /** Reserved field. */
2298+ /** @rsvd0: Reserved field. */
22992299 __u32 rsvd0;
23002300
2301− /** Engine flags. */
2301+ /** @flags: Engine flags. */
23022302 __u64 flags;
23032303
2304− /** Capabilities of this engine. */
2304+ /** @capabilities: Capabilities of this engine. */
23052305 __u64 capabilities;
23062306 #define I915_VIDEO_CLASS_CAPABILITY_HEVC (1 << 0)
23072307 #define I915_VIDEO_AND_ENHANCE_CLASS_CAPABILITY_SFC (1 << 1)
23082308
2309− /** Reserved fields. */
2309+ /** @rsvd1: Reserved fields. */
23102310 __u64 rsvd1[4];
23112311 };
23122312
@@ -2317,13 +2317,13 @@ struct drm_i915_engine_info { · 4 unmodified lines
23172317 * an array of struct drm_i915_engine_info structures.
23182318 */
23192319 struct drm_i915_query_engine_info {
2320− /** Number of struct drm_i915_engine_info structs following. */
2320+ /** @num_engines: Number of struct drm_i915_engine_info structs following. */
23212321 __u32 num_engines;
23222322
2323− /** MBZ */
2323+ /** @rsvd: MBZ */
23242324 __u32 rsvd[3];
23252325
2326− /** Marker for drm_i915_engine_info structures. */
2326+ /** @engines: Marker for drm_i915_engine_info structures. */
23272327 struct drm_i915_engine_info engines[];
23282328 };
23292329