Skip to contentSkip to conversation

drm/i915: Add Sphinx-compatible references to struct fields

PATCH In review Jonathan Neuschäfer 3 participants 5 messages Oct 3, 2019 – Oct 7, 2019

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/i915: Add Sphinx-compatible references to struct fields

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,
---
 drivers/gpu/drm/i915/i915_drv.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
drivers/gpu/drm/i915/i915_drv.h +6 -1
index 772154e4073e..55782e78f026 100644
@@ -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

#1 lore raw

✗ Fi.CI.BUILD: failure for drm/i915: Add Sphinx-compatible references to struct fields

== Series Details ==

== Series Details ==

Series: drm/i915: Add Sphinx-compatible references to struct fields
URL : https://patchwork.freedesktop.org/series/67550/
State : failure

== Summary ==

Applying: drm/i915: Add Sphinx-compatible references to struct fields Using index info to reconstruct a base tree...
M drivers/gpu/drm/i915/i915_drv.h
Falling back to patching base and 3-way merge...
Auto-merging drivers/gpu/drm/i915/i915_drv.h
CONFLICT (content): Merge conflict in drivers/gpu/drm/i915/i915_drv.h
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch' to see the failed patch Patch failed at 0001 drm/i915: Add Sphinx-compatible references to struct fields When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

#2 lore raw

Re: ✗ Fi.CI.BUILD: failure for drm/i915: Add Sphinx-compatible references to struct fields

Quoted 6 lines · Patchwork

== Series Details ==

Series: drm/i915: Add Sphinx-compatible references to struct fields
URL : https://patchwork.freedesktop.org/series/67550/
State : failure

Quoted 8 lines

== Summary ==

Applying: drm/i915: Add Sphinx-compatible references to struct fields Using index info to reconstruct a base tree...
M drivers/gpu/drm/i915/i915_drv.h
Falling back to patching base and 3-way merge... Auto-merging drivers/gpu/drm/i915/i915_drv.h
CONFLICT (content): Merge conflict in drivers/gpu/drm/i915/i915_drv.h

I'm not sure what's wrong here. The patch applies cleanly to v5.4-rc1 and linux-next. Maybe patchwork is applying it to an older base?

Thanks,
Jonathan Neuschäfer

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

maintainer
#3 lore raw

Re: ✗ Fi.CI.BUILD: failure for drm/i915: Add Sphinx-compatible references to struct fields

Quoted 16 lines · Jonathan Neuschäfer
Quoted 6 lines · Patchwork

== Series Details ==

Series: drm/i915: Add Sphinx-compatible references to struct fields
URL : https://patchwork.freedesktop.org/series/67550/
State : failure

Quoted 8 lines

== Summary ==

Applying: drm/i915: Add Sphinx-compatible references to struct fields Using index info to reconstruct a base tree...
M drivers/gpu/drm/i915/i915_drv.h
Falling back to patching base and 3-way merge... Auto-merging drivers/gpu/drm/i915/i915_drv.h
CONFLICT (content): Merge conflict in drivers/gpu/drm/i915/i915_drv.h

Quoted 2 lines

I'm not sure what's wrong here. The patch applies cleanly to v5.4-rc1 and linux-next. Maybe patchwork is applying it to an older base?

On the contrary, to a much newer base. Try drm-tip branch of [1].

BR,
Jani.

[1] https://cgit.freedesktop.org/drm/drm-tip

Quoted 8 lines

Thanks,
Jonathan Neuschäfer
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Signature · 5 lines
Jani Nikula, Intel Open Source Graphics Center
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#4 lore raw

Re: ✗ Fi.CI.BUILD: failure for drm/i915: Add Sphinx-compatible references to struct fields

Quoted 1 line · Jani Nikula

On Fri, 04 Oct 2019, Jonathan Neuschäfer <[email protected]> wrote:

[...]

Quoted 9 lines
Quoted 2 lines

I'm not sure what's wrong here. The patch applies cleanly to v5.4-rc1 and linux-next. Maybe patchwork is applying it to an older base?

On the contrary, to a much newer base. Try drm-tip branch of [1].

BR,
Jani.

[1] https://cgit.freedesktop.org/drm/drm-tip

Thanks for the hint!

Turns out someone already sent a similar fix, commit 56316cbc9c98 ("drm/i915/perf: Fix use of kernel-doc format in structure members").

Jonathan Neuschäfer

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx