Skip to content

Commit af3cfca

Browse files
rddunlapjlahtine-intel
rddunlap
authored and
jlahtine-intel
committed
drm/i915/guc: reconcile Excess struct member kernel-doc warnings
Document nested struct members with full names as described in Documentation/doc-guide/kernel-doc.rst. intel_guc.h:305: warning: Excess struct member 'lock' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'guc_ids' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'num_guc_ids' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'guc_ids_bitmap' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'guc_id_list' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'guc_ids_in_use' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'destroyed_contexts' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'destroyed_worker' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'reset_fail_worker' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'reset_fail_mask' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'sched_disable_delay_ms' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'sched_disable_gucid_threshold' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'lock' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'gt_stamp' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'ping_delay' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'work' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'shift' description in 'intel_guc' intel_guc.h:305: warning: Excess struct member 'last_stat_jiffies' description in 'intel_guc' 18 warnings as Errors Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jani Nikula <jani.nikula@linux.intel.com> Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com> Cc: Rodrigo Vivi <rodrigo.vivi@intel.com> Cc: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com> Cc: intel-gfx@lists.freedesktop.org Cc: Jonathan Corbet <corbet@lwn.net> Cc: dri-devel@lists.freedesktop.org Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com> Reviewed-by: Andi Shyti <andi.shyti@linux.intel.com> Signed-off-by: Andi Shyti <andi.shyti@linux.intel.com> Link: https://patchwork.freedesktop.org/patch/msgid/20231226195432.10891-3-rdunlap@infradead.org (cherry picked from commit e4cf1a7) Signed-off-by: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
1 parent 53cd65a commit af3cfca

File tree

1 file changed

+42
-33
lines changed

1 file changed

+42
-33
lines changed

‎drivers/gpu/drm/i915/gt/uc/intel_guc.h

Lines changed: 42 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -105,61 +105,67 @@ struct intel_guc {
105105
*/
106106
struct {
107107
/**
108-
* @lock: protects everything in submission_state,
109-
* ce->guc_id.id, and ce->guc_id.ref when transitioning in and
110-
* out of zero
108+
* @submission_state.lock: protects everything in
109+
* submission_state, ce->guc_id.id, and ce->guc_id.ref
110+
* when transitioning in and out of zero
111111
*/
112112
spinlock_t lock;
113113
/**
114-
* @guc_ids: used to allocate new guc_ids, single-lrc
114+
* @submission_state.guc_ids: used to allocate new
115+
* guc_ids, single-lrc
115116
*/
116117
struct ida guc_ids;
117118
/**
118-
* @num_guc_ids: Number of guc_ids, selftest feature to be able
119-
* to reduce this number while testing.
119+
* @submission_state.num_guc_ids: Number of guc_ids, selftest
120+
* feature to be able to reduce this number while testing.
120121
*/
121122
int num_guc_ids;
122123
/**
123-
* @guc_ids_bitmap: used to allocate new guc_ids, multi-lrc
124+
* @submission_state.guc_ids_bitmap: used to allocate
125+
* new guc_ids, multi-lrc
124126
*/
125127
unsigned long *guc_ids_bitmap;
126128
/**
127-
* @guc_id_list: list of intel_context with valid guc_ids but no
128-
* refs
129+
* @submission_state.guc_id_list: list of intel_context
130+
* with valid guc_ids but no refs
129131
*/
130132
struct list_head guc_id_list;
131133
/**
132-
* @guc_ids_in_use: Number single-lrc guc_ids in use
134+
* @submission_state.guc_ids_in_use: Number single-lrc
135+
* guc_ids in use
133136
*/
134137
unsigned int guc_ids_in_use;
135138
/**
136-
* @destroyed_contexts: list of contexts waiting to be destroyed
137-
* (deregistered with the GuC)
139+
* @submission_state.destroyed_contexts: list of contexts
140+
* waiting to be destroyed (deregistered with the GuC)
138141
*/
139142
struct list_head destroyed_contexts;
140143
/**
141-
* @destroyed_worker: worker to deregister contexts, need as we
142-
* need to take a GT PM reference and can't from destroy
143-
* function as it might be in an atomic context (no sleeping)
144+
* @submission_state.destroyed_worker: worker to deregister
145+
* contexts, need as we need to take a GT PM reference and
146+
* can't from destroy function as it might be in an atomic
147+
* context (no sleeping)
144148
*/
145149
struct work_struct destroyed_worker;
146150
/**
147-
* @reset_fail_worker: worker to trigger a GT reset after an
148-
* engine reset fails
151+
* @submission_state.reset_fail_worker: worker to trigger
152+
* a GT reset after an engine reset fails
149153
*/
150154
struct work_struct reset_fail_worker;
151155
/**
152-
* @reset_fail_mask: mask of engines that failed to reset
156+
* @submission_state.reset_fail_mask: mask of engines that
157+
* failed to reset
153158
*/
154159
intel_engine_mask_t reset_fail_mask;
155160
/**
156-
* @sched_disable_delay_ms: schedule disable delay, in ms, for
157-
* contexts
161+
* @submission_state.sched_disable_delay_ms: schedule
162+
* disable delay, in ms, for contexts
158163
*/
159164
unsigned int sched_disable_delay_ms;
160165
/**
161-
* @sched_disable_gucid_threshold: threshold of min remaining available
162-
* guc_ids before we start bypassing the schedule disable delay
166+
* @submission_state.sched_disable_gucid_threshold:
167+
* threshold of min remaining available guc_ids before
168+
* we start bypassing the schedule disable delay
163169
*/
164170
unsigned int sched_disable_gucid_threshold;
165171
} submission_state;
@@ -243,37 +249,40 @@ struct intel_guc {
243249
*/
244250
struct {
245251
/**
246-
* @lock: Lock protecting the below fields and the engine stats.
252+
* @timestamp.lock: Lock protecting the below fields and
253+
* the engine stats.
247254
*/
248255
spinlock_t lock;
249256

250257
/**
251-
* @gt_stamp: 64 bit extended value of the GT timestamp.
258+
* @timestamp.gt_stamp: 64-bit extended value of the GT
259+
* timestamp.
252260
*/
253261
u64 gt_stamp;
254262

255263
/**
256-
* @ping_delay: Period for polling the GT timestamp for
257-
* overflow.
264+
* @timestamp.ping_delay: Period for polling the GT
265+
* timestamp for overflow.
258266
*/
259267
unsigned long ping_delay;
260268

261269
/**
262-
* @work: Periodic work to adjust GT timestamp, engine and
263-
* context usage for overflows.
270+
* @timestamp.work: Periodic work to adjust GT timestamp,
271+
* engine and context usage for overflows.
264272
*/
265273
struct delayed_work work;
266274

267275
/**
268-
* @shift: Right shift value for the gpm timestamp
276+
* @timestamp.shift: Right shift value for the gpm timestamp
269277
*/
270278
u32 shift;
271279

272280
/**
273-
* @last_stat_jiffies: jiffies at last actual stats collection time
274-
* We use this timestamp to ensure we don't oversample the
275-
* stats because runtime power management events can trigger
276-
* stats collection at much higher rates than required.
281+
* @timestamp.last_stat_jiffies: jiffies at last actual
282+
* stats collection time. We use this timestamp to ensure
283+
* we don't oversample the stats because runtime power
284+
* management events can trigger stats collection at much
285+
* higher rates than required.
277286
*/
278287
unsigned long last_stat_jiffies;
279288
} timestamp;

0 commit comments

Comments
 (0)