Re: [PATCH v2 10/34] drm/xe/guc: Document GuC submission backend

[Matthew Brost <matthew.brost@intel.com>]

On Wed, Sep 24, 2025 at 11:35:23AM +0200, Michal Wajdeczko wrote:
> 
> 
> On 9/24/2025 3:15 AM, Matthew Brost wrote:
> > Add kernel-doc to xe_guc_submit.c describing the submission path,
> > the per-queue single-threaded model with pause/resume, the driver shadow
> > state machine and lost-H2G replay, job timeout handling, recovery flows
> > (GT reset, PM resume, VF resume), and reclaim constraints.
> 
> can we split this patch into "general doc of submission path" that could be
> reviewed and merged separately from the "VF recovery" doc that will stay
> in this series ?
> 

I don't really see the why here? Ofc merging this patch as part of this
series is a blocker but included it as largely explains everything this
series does + overall design of GuC submission which was entirely in my
head prior to this patch.

Matt

> > 
> > v2:
> >  - Mirror tweaks for clarity
> >  - Add new doc to Xe rst files
> > v3:
> >  - Clarify global vs per-queue stop / start
> >  - Clarify VF resume flow
> >  - Add section for 'Waiters during VF resume'
> >  - Add section for 'Page-faulting queues during VF migration'
> >  - Add section for 'GuC-ID assignment'
> >  - Add section for 'Reference counting and final queue destruction'
> > v4:
> >  - s/VF resume/VF post migration recovery (Tomasz)
> > 
> > Signed-off-by: Matthew Brost <matthew.brost@intel.com>
> > ---
> >  Documentation/gpu/xe/index.rst     |   1 +
> >  drivers/gpu/drm/xe/xe_guc_submit.c | 282 +++++++++++++++++++++++++++++