]> git.itanic.dy.fi Git - linux-stable/commitdiff
drm/imagination: pvr_device.h: fix all kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Sun, 31 Dec 2023 05:49:10 +0000 (21:49 -0800)
committerMaxime Ripard <mripard@kernel.org>
Tue, 2 Jan 2024 10:50:05 +0000 (11:50 +0100)
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
drivers/gpu/drm/imagination/pvr_device.h

index 2ca7e535799fefcd29261f6f20e4aff8a86fc10f..ecdd5767d8ef535dd8ced7ab2f7d3d3539aff263 100644 (file)
@@ -193,13 +193,14 @@ struct pvr_device {
         * @queues: Queue-related fields.
         */
        struct {
-               /** @active: Active queue list. */
+               /** @queues.active: Active queue list. */
                struct list_head active;
 
-               /** @idle: Idle queue list. */
+               /** @queues.idle: Idle queue list. */
                struct list_head idle;
 
-               /** @lock: Lock protecting access to the active/idle lists. */
+               /** @queues.lock: Lock protecting access to the active/idle
+                *  lists. */
                struct mutex lock;
        } queues;
 
@@ -207,18 +208,18 @@ struct pvr_device {
         * @watchdog: Watchdog for communications with firmware.
         */
        struct {
-               /** @work: Work item for watchdog callback. */
+               /** @watchdog.work: Work item for watchdog callback. */
                struct delayed_work work;
 
                /**
-                * @old_kccb_cmds_executed: KCCB command execution count at last
-                * watchdog poll.
+                * @watchdog.old_kccb_cmds_executed: KCCB command execution
+                * count at last watchdog poll.
                 */
                u32 old_kccb_cmds_executed;
 
                /**
-                * @kccb_stall_count: Number of watchdog polls KCCB has been
-                * stalled for.
+                * @watchdog.kccb_stall_count: Number of watchdog polls
+                * KCCB has been stalled for.
                 */
                u32 kccb_stall_count;
        } watchdog;
@@ -227,43 +228,46 @@ struct pvr_device {
         * @kccb: Circular buffer for communications with firmware.
         */
        struct {
-               /** @ccb: Kernel CCB. */
+               /** @kccb.ccb: Kernel CCB. */
                struct pvr_ccb ccb;
 
-               /** @rtn_q: Waitqueue for KCCB command return waiters. */
+               /** @kccb.rtn_q: Waitqueue for KCCB command return waiters. */
                wait_queue_head_t rtn_q;
 
-               /** @rtn_obj: Object representing KCCB return slots. */
+               /** @kccb.rtn_obj: Object representing KCCB return slots. */
                struct pvr_fw_object *rtn_obj;
 
                /**
-                * @rtn: Pointer to CPU mapping of KCCB return slots. Must be
-                * accessed by READ_ONCE()/WRITE_ONCE().
+                * @kccb.rtn: Pointer to CPU mapping of KCCB return slots.
+                * Must be accessed by READ_ONCE()/WRITE_ONCE().
                 */
                u32 *rtn;
 
-               /** @slot_count: Total number of KCCB slots available. */
+               /** @kccb.slot_count: Total number of KCCB slots available. */
                u32 slot_count;
 
-               /** @reserved_count: Number of KCCB slots reserved for future use. */
+               /** @kccb.reserved_count: Number of KCCB slots reserved for
+                *  future use. */
                u32 reserved_count;
 
                /**
-                * @waiters: List of KCCB slot waiters.
+                * @kccb.waiters: List of KCCB slot waiters.
                 */
                struct list_head waiters;
 
-               /** @fence_ctx: KCCB fence context. */
+               /** @kccb.fence_ctx: KCCB fence context. */
                struct {
-                       /** @id: KCCB fence context ID allocated with dma_fence_context_alloc(). */
+                       /** @kccb.fence_ctx.id: KCCB fence context ID
+                        *  allocated with dma_fence_context_alloc(). */
                        u64 id;
 
-                       /** @seqno: Sequence number incremented each time a fence is created. */
+                       /** @kccb.fence_ctx.seqno: Sequence number incremented
+                        *  each time a fence is created. */
                        atomic_t seqno;
 
                        /**
-                        * @lock: Lock used to synchronize access to fences allocated by this
-                        * context.
+                        * @kccb.fence_ctx.lock: Lock used to synchronize
+                        * access to fences allocated by this context.
                         */
                        spinlock_t lock;
                } fence_ctx;