Commit 65fe9617 authored by Michal Wajdeczko's avatar Michal Wajdeczko
Browse files

drm/xe/pf: Fix documentation formatting 



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: default avatarMichal Wajdeczko <michal.wajdeczko@intel.com>
Reviewed-by: default avatarPiotr Piórkowski <piotr.piorkowski@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240828210809.1528-3-michal.wajdeczko@intel.com
parent 16ba2b28

drivers/gpu/drm/xe/xe_gt_sriov_pf_control.c

+28 −26
Original line number Diff line number Diff line
@@ -153,6 +153,8 @@ int xe_gt_sriov_pf_control_trigger_flr(struct xe_gt *gt, unsigned int vfid) 
/**

 * DOC: The VF FLR Flow with GuC

 *

 * The VF FLR flow includes several steps::

 *

 *	         PF                        GUC             PCI

 *	========================================================

 *	         |                          |               |
@@ -173,13 +175,13 @@ int xe_gt_sriov_pf_control_trigger_flr(struct xe_gt *gt, unsigned int vfid) 
 *	        [ ]-- 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

 * * 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)