drm/xe: Document nested struct members according to guidelines
[linux-2.6-microblaze.git] / drivers / gpu / drm / xe / xe_guc_submit_types.h
index 649b0a8..72fc0f4 100644 (file)
@@ -102,9 +102,9 @@ struct xe_guc_submit_exec_queue_snapshot {
 
        /** @sched_props: scheduling properties */
        struct {
-               /** @timeslice_us: timeslice period in micro-seconds */
+               /** @sched_props.timeslice_us: timeslice period in micro-seconds */
                u32 timeslice_us;
-               /** @preempt_timeout_us: preemption timeout in micro-seconds */
+               /** @sched_props.preempt_timeout_us: preemption timeout in micro-seconds */
                u32 preempt_timeout_us;
        } sched_props;
 
@@ -118,11 +118,11 @@ struct xe_guc_submit_exec_queue_snapshot {
 
        /** @guc: GuC Engine Snapshot */
        struct {
-               /** @wqi_head: work queue item head */
+               /** @guc.wqi_head: work queue item head */
                u32 wqi_head;
-               /** @wqi_tail: work queue item tail */
+               /** @guc.wqi_tail: work queue item tail */
                u32 wqi_tail;
-               /** @id: GuC id for this exec_queue */
+               /** @guc.id: GuC id for this exec_queue */
                u16 id;
        } guc;
 
@@ -133,13 +133,13 @@ struct xe_guc_submit_exec_queue_snapshot {
        bool parallel_execution;
        /** @parallel: snapshot of the useful parallel scratch */
        struct {
-               /** @wq_desc: Workqueue description */
+               /** @parallel.wq_desc: Workqueue description */
                struct {
-                       /** @head: Workqueue Head */
+                       /** @parallel.wq_desc.head: Workqueue Head */
                        u32 head;
-                       /** @tail: Workqueue Tail */
+                       /** @parallel.wq_desc.tail: Workqueue Tail */
                        u32 tail;
-                       /** @status: Workqueue Status */
+                       /** @parallel.wq_desc.status: Workqueue Status */
                        u32 status;
                } wq_desc;
                /** @wq: Workqueue Items */