diff mbox series

[v7,6/6] drm/xe/guc: Update comments on GuC-Err-Capture flows

Message ID 20250210233254.419587-7-alan.previn.teres.alexis@intel.com (mailing list archive)
State New, archived
Headers show
Series Maintenence of devcoredump <-> GuC-Err-Capture plumbing | expand

Commit Message

Alan Previn Feb. 10, 2025, 11:32 p.m. UTC
Update the comments on GuC-Err-Capture flows with the
updated function names.

Signed-off-by: Alan Previn <alan.previn.teres.alexis@intel.com>
---
 drivers/gpu/drm/xe/xe_guc_capture.c | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

Comments

Dong, Zhanjun Feb. 11, 2025, 11:09 p.m. UTC | #1
On 2025-02-10 6:32 p.m., Alan Previn wrote:
> Update the comments on GuC-Err-Capture flows with the
> updated function names.
> 
> Signed-off-by: Alan Previn <alan.previn.teres.alexis@intel.com>
> ---
>   drivers/gpu/drm/xe/xe_guc_capture.c | 19 +++++++++++--------
>   1 file changed, 11 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/gpu/drm/xe/xe_guc_capture.c b/drivers/gpu/drm/xe/xe_guc_capture.c
> index 746d3b21b18b..15f9b08ff7bb 100644
> --- a/drivers/gpu/drm/xe/xe_guc_capture.c
> +++ b/drivers/gpu/drm/xe/xe_guc_capture.c
> @@ -905,22 +905,25 @@ guc_capture_init_node(struct xe_guc *guc, struct xe_guc_capture_snapshot *node)
>    *                   list. This list is used for matchup and printout by xe_devcoredump_read
>    *                   and xe_engine_snapshot_print, (when user invokes the devcoredump sysfs).
>    *
> - * GUC --> notify context reset:
> - * -----------------------------
> + * DRM Scheduler job-timeout OR GuC-notify guc-id reset:
> + * -----------------------------------------------------
>    *     --> guc_exec_queue_timedout_job
> - *                   L--> xe_devcoredump
> + *               L--> xe_guc_capture_snapshot_store_manual_job (if GuC didn't report an
> + *                    error capture node for this job)
> + *               L--> xe_devcoredump
>    *                          L--> devcoredump_snapshot
> - *                               --> xe_hw_engine_snapshot_capture
> - *                               --> xe_engine_manual_capture(For manual capture)
> + *                               --> xe_engine_snapshot_capture_for_queue
>    *
> - * User Sysfs / Debugfs
> - * --------------------
> - *      --> xe_devcoredump_read->
> + * User Devcoredump Sysfs
> + * ----------------------
> + *      --> xe_devcoredump_read-> (user cats devcoredump)
>    *             L--> xxx_snapshot_print
>    *                    L--> xe_hw_engine_print --> xe_hw_engine_snapshot_print
>    *                          L--> xe_guc_capture_snapshot_print
				L--> hw_engine_snapshot_capture
     				     xe_guc_capture_snapshot_manual_hwe
				     // The new function which do manual capture without job
And, for debugfs, it did not calls xe_devcoredump_read...
instead, by "hw_engines". Shall we mention debugfs call 
xe_hw_engine_print directly?

Other than that, LGTM
Reviewed-by: Zhanjun Dong <zhanjun.dong@intel.com>


>    *                               Print register lists values saved in matching
>    *                               node from guc->capture->outlist
> + *      --> xe_devcoredump_free (when user clears the dump)
> + *             L--> xe_devcoredump_snapshot_free --> xe_guc_capture_put_matched_nodes
>    *
>    */
>
Alan Previn Feb. 12, 2025, 6:54 p.m. UTC | #2
On Tue, 2025-02-11 at 18:09 -0500, Dong, Zhanjun wrote:
> 
> > 
alan:snip
> >    *
> > - * User Sysfs / Debugfs
> > - * --------------------
> > - *      --> xe_devcoredump_read->
> > + * User Devcoredump Sysfs
> > + * ----------------------
> > + *      --> xe_devcoredump_read-> (user cats devcoredump)
> >    *             L--> xxx_snapshot_print
> >    *                    L--> xe_hw_engine_print --> xe_hw_engine_snapshot_print
> >    *                          L--> xe_guc_capture_snapshot_print
>                                 L--> hw_engine_snapshot_capture
>                                      xe_guc_capture_snapshot_manual_hwe
>                                      // The new function which do manual capture without job
> And, for debugfs, it did not calls xe_devcoredump_read...
> instead, by "hw_engines". Shall we mention debugfs call 
> xe_hw_engine_print directly?
> 
> Other than that, LGTM
> Reviewed-by: Zhanjun Dong <zhanjun.dong@intel.com>
> 

alan: thanks - i will add a new section to differentiate
"User->sysfs devcore dump" vs "User->debugfs engine dump" - both with similiar endpoints ending with
xe_hw_engine_snapshot_print->xe_guc_capture_snapshot_print
diff mbox series

Patch

diff --git a/drivers/gpu/drm/xe/xe_guc_capture.c b/drivers/gpu/drm/xe/xe_guc_capture.c
index 746d3b21b18b..15f9b08ff7bb 100644
--- a/drivers/gpu/drm/xe/xe_guc_capture.c
+++ b/drivers/gpu/drm/xe/xe_guc_capture.c
@@ -905,22 +905,25 @@  guc_capture_init_node(struct xe_guc *guc, struct xe_guc_capture_snapshot *node)
  *                   list. This list is used for matchup and printout by xe_devcoredump_read
  *                   and xe_engine_snapshot_print, (when user invokes the devcoredump sysfs).
  *
- * GUC --> notify context reset:
- * -----------------------------
+ * DRM Scheduler job-timeout OR GuC-notify guc-id reset:
+ * -----------------------------------------------------
  *     --> guc_exec_queue_timedout_job
- *                   L--> xe_devcoredump
+ *               L--> xe_guc_capture_snapshot_store_manual_job (if GuC didn't report an
+ *                    error capture node for this job)
+ *               L--> xe_devcoredump
  *                          L--> devcoredump_snapshot
- *                               --> xe_hw_engine_snapshot_capture
- *                               --> xe_engine_manual_capture(For manual capture)
+ *                               --> xe_engine_snapshot_capture_for_queue
  *
- * User Sysfs / Debugfs
- * --------------------
- *      --> xe_devcoredump_read->
+ * User Devcoredump Sysfs
+ * ----------------------
+ *      --> xe_devcoredump_read-> (user cats devcoredump)
  *             L--> xxx_snapshot_print
  *                    L--> xe_hw_engine_print --> xe_hw_engine_snapshot_print
  *                          L--> xe_guc_capture_snapshot_print
  *                               Print register lists values saved in matching
  *                               node from guc->capture->outlist
+ *      --> xe_devcoredump_free (when user clears the dump)
+ *             L--> xe_devcoredump_snapshot_free --> xe_guc_capture_put_matched_nodes
  *
  */