Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-10 06:01:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

drm/xe/pf: Fix documentation formatting

Browse Source 
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@intel.com>
Reviewed-by: Piotr Piórkowski <piotr.piorkowski@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240828210809.1528-3-michal.wajdeczko@intel.com
This commit is contained in:
Michal Wajdeczko 2024-08-28 23:08:07 +02:00
parent 16ba2b28df
commit 65fe9617a1
1 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
drivers/gpu/drm/xe/xe_gt_sriov_pf_control.c
View File

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