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 e4cf1a70fad3e2107503e99cfe9cc0c9cba19dad)
Signed-off-by: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>

diff --git a/drivers/gpu/drm/i915/gt/uc/intel_guc.h b/drivers/gpu/drm/i915/gt/uc/intel_guc.h
index e22c12ce245adf2e79e7623a9222797c13e62c97..813cc888e6fae3f602661840f726ccf8f8908ec2 100644 (file)
--- a/drivers/gpu/drm/i915/gt/uc/intel_guc.h
+++ b/drivers/gpu/drm/i915/gt/uc/intel_guc.h
@@ -105,61 +105,67 @@ struct intel_guc {
         */
        struct {
                /**
-                * @lock: protects everything in submission_state,
-                * ce->guc_id.id, and ce->guc_id.ref when transitioning in and
-                * out of zero
+                * @submission_state.lock: protects everything in
+                * submission_state, ce->guc_id.id, and ce->guc_id.ref
+                * when transitioning in and out of zero
                 */
                spinlock_t lock;
                /**
-                * @guc_ids: used to allocate new guc_ids, single-lrc
+                * @submission_state.guc_ids: used to allocate new
+                * guc_ids, single-lrc
                 */
                struct ida guc_ids;
                /**
-                * @num_guc_ids: Number of guc_ids, selftest feature to be able
-                * to reduce this number while testing.
+                * @submission_state.num_guc_ids: Number of guc_ids, selftest
+                * feature to be able to reduce this number while testing.
                 */
                int num_guc_ids;
                /**
-                * @guc_ids_bitmap: used to allocate new guc_ids, multi-lrc
+                * @submission_state.guc_ids_bitmap: used to allocate
+                * new guc_ids, multi-lrc
                 */
                unsigned long *guc_ids_bitmap;
                /**
-                * @guc_id_list: list of intel_context with valid guc_ids but no
-                * refs
+                * @submission_state.guc_id_list: list of intel_context
+                * with valid guc_ids but no refs
                 */
                struct list_head guc_id_list;
                /**
-                * @guc_ids_in_use: Number single-lrc guc_ids in use
+                * @submission_state.guc_ids_in_use: Number single-lrc
+                * guc_ids in use
                 */
                unsigned int guc_ids_in_use;
                /**
-                * @destroyed_contexts: list of contexts waiting to be destroyed
-                * (deregistered with the GuC)
+                * @submission_state.destroyed_contexts: list of contexts
+                * waiting to be destroyed (deregistered with the GuC)
                 */
                struct list_head destroyed_contexts;
                /**
-                * @destroyed_worker: worker to deregister contexts, need as we
-                * need to take a GT PM reference and can't from destroy
-                * function as it might be in an atomic context (no sleeping)
+                * @submission_state.destroyed_worker: worker to deregister
+                * contexts, need as we need to take a GT PM reference and
+                * can't from destroy function as it might be in an atomic
+                * context (no sleeping)
                 */
                struct work_struct destroyed_worker;
                /**
-                * @reset_fail_worker: worker to trigger a GT reset after an
-                * engine reset fails
+                * @submission_state.reset_fail_worker: worker to trigger
+                * a GT reset after an engine reset fails
                 */
                struct work_struct reset_fail_worker;
                /**
-                * @reset_fail_mask: mask of engines that failed to reset
+                * @submission_state.reset_fail_mask: mask of engines that
+                * failed to reset
                 */
                intel_engine_mask_t reset_fail_mask;
                /**
-                * @sched_disable_delay_ms: schedule disable delay, in ms, for
-                * contexts
+                * @submission_state.sched_disable_delay_ms: schedule
+                * disable delay, in ms, for contexts
                 */
                unsigned int sched_disable_delay_ms;
                /**
-                * @sched_disable_gucid_threshold: threshold of min remaining available
-                * guc_ids before we start bypassing the schedule disable delay
+                * @submission_state.sched_disable_gucid_threshold:
+                * threshold of min remaining available guc_ids before
+                * we start bypassing the schedule disable delay
                 */
                unsigned int sched_disable_gucid_threshold;
        } submission_state;
@@ -243,37 +249,40 @@ struct intel_guc {
         */
        struct {
                /**
-                * @lock: Lock protecting the below fields and the engine stats.
+                * @timestamp.lock: Lock protecting the below fields and
+                * the engine stats.
                 */
                spinlock_t lock;
 
                /**
-                * @gt_stamp: 64 bit extended value of the GT timestamp.
+                * @timestamp.gt_stamp: 64-bit extended value of the GT
+                * timestamp.
                 */
                u64 gt_stamp;
 
                /**
-                * @ping_delay: Period for polling the GT timestamp for
-                * overflow.
+                * @timestamp.ping_delay: Period for polling the GT
+                * timestamp for overflow.
                 */
                unsigned long ping_delay;
 
                /**
-                * @work: Periodic work to adjust GT timestamp, engine and
-                * context usage for overflows.
+                * @timestamp.work: Periodic work to adjust GT timestamp,
+                * engine and context usage for overflows.
                 */
                struct delayed_work work;
 
                /**
-                * @shift: Right shift value for the gpm timestamp
+                * @timestamp.shift: Right shift value for the gpm timestamp
                 */
                u32 shift;
 
                /**
-                * @last_stat_jiffies: jiffies at last actual stats collection time
-                * We use this timestamp to ensure we don't oversample the
-                * stats because runtime power management events can trigger
-                * stats collection at much higher rates than required.
+                * @timestamp.last_stat_jiffies: jiffies at last actual
+                * stats collection time. We use this timestamp to ensure
+                * we don't oversample the stats because runtime power
+                * management events can trigger stats collection at much
+                * higher rates than required.
                 */
                unsigned long last_stat_jiffies;
        } timestamp;