This fixes the following kernel-doc warnings and makes the corrsponding fields show up in the generated HTML:
./drivers/gpu/drm/i915/i915_drv.h:1143: warning: Incorrect use of kernel-doc format: * State of the OA buffer. ./drivers/gpu/drm/i915/i915_drv.h:1154: warning: Incorrect use of kernel-doc format: * Locks reads and writes to all head/tail state ./drivers/gpu/drm/i915/i915_drv.h:1176: warning: Incorrect use of kernel-doc format: * One 'aging' tail pointer and one 'aged' tail pointer ready to ./drivers/gpu/drm/i915/i915_drv.h:1188: warning: Incorrect use of kernel-doc format: * Index for the aged tail ready to read() data up to. ./drivers/gpu/drm/i915/i915_drv.h:1193: warning: Incorrect use of kernel-doc format: * A monotonic timestamp for when the current aging tail pointer ./drivers/gpu/drm/i915/i915_drv.h:1199: warning: Incorrect use of kernel-doc format: * Although we can always read back the head pointer register,
Signed-off-by: Jonathan Neuschäfer j.neuschaefer@gmx.net --- drivers/gpu/drm/i915/i915_drv.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/drivers/gpu/drm/i915/i915_drv.h b/drivers/gpu/drm/i915/i915_drv.h index 772154e4073e..55782e78f026 100644 --- a/drivers/gpu/drm/i915/i915_drv.h +++ b/drivers/gpu/drm/i915/i915_drv.h @@ -1140,7 +1140,7 @@ struct i915_perf_stream { int period_exponent;
/** - * State of the OA buffer. + * @oa_buffer: State of the OA buffer. */ struct { struct i915_vma *vma; @@ -1151,6 +1151,7 @@ struct i915_perf_stream { int size_exponent;
/** + * @oa_buffer.ptr_lock: * Locks reads and writes to all head/tail state * * Consider: the head and tail pointer state needs to be read @@ -1173,6 +1174,7 @@ struct i915_perf_stream { spinlock_t ptr_lock;
/** + * @oa_buffer.tails: * One 'aging' tail pointer and one 'aged' tail pointer ready to * used for reading. * @@ -1185,17 +1187,20 @@ struct i915_perf_stream { } tails[2];
/** + * @oa_buffer.aged_tail_idx: * Index for the aged tail ready to read() data up to. */ unsigned int aged_tail_idx;
/** + * @oa_buffer.aging_timestamp: * A monotonic timestamp for when the current aging tail pointer * was read; used to determine when it is old enough to trust. */ u64 aging_timestamp;
/** + * @oa_buffer.head: * Although we can always read back the head pointer register, * we prefer to avoid trusting the HW state, just to avoid any * risk that some hardware condition could * somehow bump the -- 2.20.1