From: =?UTF-8?q?Jonathan=20Neusch=C3=A4fer?= Subject: [PATCH] drm/i915: Add Sphinx-compatible references to struct fields Date: Thu, 3 Oct 2019 19:28:23 +0200 Message-ID: <20191003172823.8955-1-j.neuschaefer@gmx.net> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Return-path: Sender: linux-kernel-owner@vger.kernel.org To: intel-gfx@lists.freedesktop.org Cc: =?UTF-8?q?Jonathan=20Neusch=C3=A4fer?= , Jani Nikula , Joonas Lahtinen , Rodrigo Vivi , David Airlie , Daniel Vetter , dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org List-Id: dri-devel@lists.freedesktop.org This fixes the following kernel-doc warnings and makes the corrsponding fi= elds show up in the generated HTML: ./drivers/gpu/drm/i915/i915_drv.h:1143: warning: Incorrect use of kernel-d= oc format: * State of the OA buffer. ./drivers/gpu/drm/i915/i915_drv.h:1154: warning: Incorrect use of kernel-d= oc format: * Locks reads and writes to all head/tail stat= e ./drivers/gpu/drm/i915/i915_drv.h:1176: warning: Incorrect use of kernel-d= oc 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-d= oc 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-d= oc format: * A monotonic timestamp for when the current a= ging tail pointer ./drivers/gpu/drm/i915/i915_drv.h:1199: warning: Incorrect use of kernel-d= oc format: * Although we can always read back the head po= inter register, Signed-off-by: Jonathan Neusch=C3=A4fer =2D-- 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_d= rv.h index 772154e4073e..55782e78f026 100644 =2D-- 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 =2D- 2.20.1