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

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
...@@ -153,33 +153,35 @@ int xe_gt_sriov_pf_control_trigger_flr(struct xe_gt *gt, unsigned int vfid) ...@@ -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 * DOC: The VF FLR Flow with GuC
* *
* PF GUC PCI * The VF FLR flow includes several steps::
* ========================================================
* | | |
* (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 * PF GUC PCI
* 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 * (1) | [ ] <----- FLR --|
* 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 * (2) [ ] <-------- NOTIFY FLR --[ ]
* Step 5: PF performs VF FLR cleanups and notifies the GuC FW when finished * [ ] |
* (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) static bool needs_dispatch_flr(struct xe_device *xe)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment