Skip to content

Commit eee7068

Browse files
rddunlapmripard
rddunlap
authored and
mripard
committed
drm/imagination: pvr_device.h: fix all kernel-doc warnings
Correct all kernel-doc notation on pvr_device.h so that there are no kernel-doc warnings remaining. pvr_device.h:292: warning: Excess struct member 'active' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'idle' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'lock' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'work' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'old_kccb_cmds_executed' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'kccb_stall_count' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'ccb' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'rtn_q' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'rtn_obj' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'rtn' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'slot_count' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'reserved_count' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'waiters' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'fence_ctx' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'id' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'seqno' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'lock' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'active' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'idle' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'lock' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'work' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'old_kccb_cmds_executed' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'kccb_stall_count' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'ccb' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'rtn_q' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'rtn_obj' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'rtn' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'slot_count' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'reserved_count' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'waiters' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'fence_ctx' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'id' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'seqno' description in 'pvr_device' pvr_device.h:292: warning: Excess struct member 'lock' description in 'pvr_device' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Frank Binns <frank.binns@imgtec.com> Cc: Donald Robson <donald.robson@imgtec.com> Cc: Matt Coster <matt.coster@imgtec.com> Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com> Cc: Maxime Ripard <mripard@kernel.org> Cc: Thomas Zimmermann <tzimmermann@suse.de> Cc: David Airlie <airlied@gmail.com> Cc: Daniel Vetter <daniel@ffwll.ch> Cc: dri-devel@lists.freedesktop.org Cc: Jonathan Corbet <corbet@lwn.net> Cc: Vegard Nossum <vegard.nossum@oracle.com> Signed-off-by: Maxime Ripard <mripard@kernel.org> Link: https://patchwork.freedesktop.org/patch/msgid/20231231054910.31805-1-rdunlap@infradead.org
1 parent 200a6b3 commit eee7068

1 file changed

Lines changed: 25 additions & 21 deletions

File tree

‎drivers/gpu/drm/imagination/pvr_device.h‎

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -193,32 +193,33 @@ struct pvr_device {
193193
* @queues: Queue-related fields.
194194
*/
195195
struct {
196-
/** @active: Active queue list. */
196+
/** @queues.active: Active queue list. */
197197
struct list_head active;
198198

199-
/** @idle: Idle queue list. */
199+
/** @queues.idle: Idle queue list. */
200200
struct list_head idle;
201201

202-
/** @lock: Lock protecting access to the active/idle lists. */
202+
/** @queues.lock: Lock protecting access to the active/idle
203+
* lists. */
203204
struct mutex lock;
204205
} queues;
205206

206207
/**
207208
* @watchdog: Watchdog for communications with firmware.
208209
*/
209210
struct {
210-
/** @work: Work item for watchdog callback. */
211+
/** @watchdog.work: Work item for watchdog callback. */
211212
struct delayed_work work;
212213

213214
/**
214-
* @old_kccb_cmds_executed: KCCB command execution count at last
215-
* watchdog poll.
215+
* @watchdog.old_kccb_cmds_executed: KCCB command execution
216+
* count at last watchdog poll.
216217
*/
217218
u32 old_kccb_cmds_executed;
218219

219220
/**
220-
* @kccb_stall_count: Number of watchdog polls KCCB has been
221-
* stalled for.
221+
* @watchdog.kccb_stall_count: Number of watchdog polls
222+
* KCCB has been stalled for.
222223
*/
223224
u32 kccb_stall_count;
224225
} watchdog;
@@ -227,43 +228,46 @@ struct pvr_device {
227228
* @kccb: Circular buffer for communications with firmware.
228229
*/
229230
struct {
230-
/** @ccb: Kernel CCB. */
231+
/** @kccb.ccb: Kernel CCB. */
231232
struct pvr_ccb ccb;
232233

233-
/** @rtn_q: Waitqueue for KCCB command return waiters. */
234+
/** @kccb.rtn_q: Waitqueue for KCCB command return waiters. */
234235
wait_queue_head_t rtn_q;
235236

236-
/** @rtn_obj: Object representing KCCB return slots. */
237+
/** @kccb.rtn_obj: Object representing KCCB return slots. */
237238
struct pvr_fw_object *rtn_obj;
238239

239240
/**
240-
* @rtn: Pointer to CPU mapping of KCCB return slots. Must be
241-
* accessed by READ_ONCE()/WRITE_ONCE().
241+
* @kccb.rtn: Pointer to CPU mapping of KCCB return slots.
242+
* Must be accessed by READ_ONCE()/WRITE_ONCE().
242243
*/
243244
u32 *rtn;
244245

245-
/** @slot_count: Total number of KCCB slots available. */
246+
/** @kccb.slot_count: Total number of KCCB slots available. */
246247
u32 slot_count;
247248

248-
/** @reserved_count: Number of KCCB slots reserved for future use. */
249+
/** @kccb.reserved_count: Number of KCCB slots reserved for
250+
* future use. */
249251
u32 reserved_count;
250252

251253
/**
252-
* @waiters: List of KCCB slot waiters.
254+
* @kccb.waiters: List of KCCB slot waiters.
253255
*/
254256
struct list_head waiters;
255257

256-
/** @fence_ctx: KCCB fence context. */
258+
/** @kccb.fence_ctx: KCCB fence context. */
257259
struct {
258-
/** @id: KCCB fence context ID allocated with dma_fence_context_alloc(). */
260+
/** @kccb.fence_ctx.id: KCCB fence context ID
261+
* allocated with dma_fence_context_alloc(). */
259262
u64 id;
260263

261-
/** @seqno: Sequence number incremented each time a fence is created. */
264+
/** @kccb.fence_ctx.seqno: Sequence number incremented
265+
* each time a fence is created. */
262266
atomic_t seqno;
263267

264268
/**
265-
* @lock: Lock used to synchronize access to fences allocated by this
266-
* context.
269+
* @kccb.fence_ctx.lock: Lock used to synchronize
270+
* access to fences allocated by this context.
267271
*/
268272
spinlock_t lock;
269273
} fence_ctx;

0 commit comments

Comments
 (0)