[PATCH 02/12] drm/xe/pf: Fix documentation formatting

[Piotr Piórkowski]

Michal Wajdeczko <michal.wajdeczko at intel.com> wrote on pią [2024-sie-09 18:51:49 +0200]:
> Current formatting of "The VF FLR Flow with GuC" only looks fine,
> but it will not render properly when included in htmldocs due to:
> 
>   WARNING: Block quote ends without a blank line; unexpected unindent.
>   CRITICAL: Missing matching underline for section title overline.
> 
> Fix that by adding proper indent and using list markup.
> 
> Signed-off-by: Michal Wajdeczko <michal.wajdeczko at intel.com>
> ---
>  drivers/gpu/drm/xe/xe_gt_sriov_pf_control.c | 54 +++++++++++----------
>  1 file changed, 28 insertions(+), 26 deletions(-)
> 
> diff --git a/drivers/gpu/drm/xe/xe_gt_sriov_pf_control.c b/drivers/gpu/drm/xe/xe_gt_sriov_pf_control.c
> index ebf06e037750..d11839d9e7d4 100644
> --- a/drivers/gpu/drm/xe/xe_gt_sriov_pf_control.c
> +++ b/drivers/gpu/drm/xe/xe_gt_sriov_pf_control.c
> @@ -153,33 +153,35 @@ int xe_gt_sriov_pf_control_trigger_flr(struct xe_gt *gt, unsigned int vfid)
>  /**
>   * DOC: The VF FLR Flow with GuC
>   *
> - *          PF                        GUC             PCI
> - * ========================================================
> - *          |                          |               |
> - * (1)      |                         [ ] <----- FLR --|
> - *          |                         [ ]              :
> - * (2)     [ ] <-------- NOTIFY FLR --[ ]
> - *         [ ]                         |
> - * (3)     [ ]                         |
> - *         [ ]                         |
> - *         [ ]-- START FLR ---------> [ ]
> - *          |                         [ ]
> - * (4)      |                         [ ]
> - *          |                         [ ]
> - *         [ ] <--------- FLR DONE -- [ ]
> - *         [ ]                         |
> - * (5)     [ ]                         |
> - *         [ ]                         |
> - *         [ ]-- FINISH FLR --------> [ ]
> - *          |                          |
> + * The VF FLR flow includes several steps::
>   *
> - * Step 1: PCI HW generates interrupt to the GuC about VF FLR
> - * Step 2: GuC FW sends G2H notification to the PF about VF FLR
> - * Step 2a: on some platforms G2H is only received from root GuC
> - * Step 3: PF sends H2G request to the GuC to start VF FLR sequence
> - * Step 3a: on some platforms PF must send H2G to all other GuCs
> - * Step 4: GuC FW performs VF FLR cleanups and notifies the PF when done
> - * Step 5: PF performs VF FLR cleanups and notifies the GuC FW when finished
> + *	         PF                        GUC             PCI
> + *	========================================================
> + *	         |                          |               |
> + *	(1)      |                         [ ] <----- FLR --|
> + *	         |                         [ ]              :
> + *	(2)     [ ] <-------- NOTIFY FLR --[ ]
> + *	        [ ]                         |
> + *	(3)     [ ]                         |
> + *	        [ ]                         |
> + *	        [ ]-- START FLR ---------> [ ]
> + *	         |                         [ ]
> + *	(4)      |                         [ ]
> + *	         |                         [ ]
> + *	        [ ] <--------- FLR DONE -- [ ]
> + *	        [ ]                         |
> + *	(5)     [ ]                         |
> + *	        [ ]                         |
> + *	        [ ]-- FINISH FLR --------> [ ]
> + *	         |                          |
> + *
> + * * Step 1: PCI HW generates interrupt to the GuC about VF FLR
> + * * Step 2: GuC FW sends G2H notification to the PF about VF FLR
> + * * Step 2a: on some platforms G2H is only received from root GuC
> + * * Step 3: PF sends H2G request to the GuC to start VF FLR sequence
> + * * Step 3a: on some platforms PF must send H2G to all other GuCs
> + * * Step 4: GuC FW performs VF FLR cleanups and notifies the PF when done
> + * * Step 5: PF performs VF FLR cleanups and notifies the GuC FW when finished
>   */
>  
>  static bool needs_dispatch_flr(struct xe_device *xe)
> -- 
> 2.43.0

LGTM:
Reviewed-by: Piotr Piórkowski <piotr.piorkowski at intel.com>
> 

--