Skip to content

Commit 65fe961

Browse files
committed
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: Michal Wajdeczko <[email protected]> Reviewed-by: Piotr Piórkowski <[email protected]> Link: https://patchwork.freedesktop.org/patch/msgid/[email protected]
1 parent 16ba2b2 commit 65fe961

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

drivers/gpu/drm/xe/xe_gt_sriov_pf_control.c

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -153,33 +153,35 @@ int xe_gt_sriov_pf_control_trigger_flr(struct xe_gt *gt, unsigned int vfid)
153153
/**
154154
* DOC: The VF FLR Flow with GuC
155155
*
156-
* PF GUC PCI
157-
* ========================================================
158-
* | | |
159-
* (1) | [ ] <----- FLR --|
160-
* | [ ] :
161-
* (2) [ ] <-------- NOTIFY FLR --[ ]
162-
* [ ] |
163-
* (3) [ ] |
164-
* [ ] |
165-
* [ ]-- START FLR ---------> [ ]
166-
* | [ ]
167-
* (4) | [ ]
168-
* | [ ]
169-
* [ ] <--------- FLR DONE -- [ ]
170-
* [ ] |
171-
* (5) [ ] |
172-
* [ ] |
173-
* [ ]-- FINISH FLR --------> [ ]
174-
* | |
156+
* The VF FLR flow includes several steps::
175157
*
176-
* Step 1: PCI HW generates interrupt to the GuC about VF FLR
177-
* Step 2: GuC FW sends G2H notification to the PF about VF FLR
178-
* Step 2a: on some platforms G2H is only received from root GuC
179-
* Step 3: PF sends H2G request to the GuC to start VF FLR sequence
180-
* Step 3a: on some platforms PF must send H2G to all other GuCs
181-
* Step 4: GuC FW performs VF FLR cleanups and notifies the PF when done
182-
* Step 5: PF performs VF FLR cleanups and notifies the GuC FW when finished
158+
* PF GUC PCI
159+
* ========================================================
160+
* | | |
161+
* (1) | [ ] <----- FLR --|
162+
* | [ ] :
163+
* (2) [ ] <-------- NOTIFY FLR --[ ]
164+
* [ ] |
165+
* (3) [ ] |
166+
* [ ] |
167+
* [ ]-- START FLR ---------> [ ]
168+
* | [ ]
169+
* (4) | [ ]
170+
* | [ ]
171+
* [ ] <--------- FLR DONE -- [ ]
172+
* [ ] |
173+
* (5) [ ] |
174+
* [ ] |
175+
* [ ]-- FINISH FLR --------> [ ]
176+
* | |
177+
*
178+
* * Step 1: PCI HW generates interrupt to the GuC about VF FLR
179+
* * Step 2: GuC FW sends G2H notification to the PF about VF FLR
180+
* * Step 2a: on some platforms G2H is only received from root GuC
181+
* * Step 3: PF sends H2G request to the GuC to start VF FLR sequence
182+
* * Step 3a: on some platforms PF must send H2G to all other GuCs
183+
* * Step 4: GuC FW performs VF FLR cleanups and notifies the PF when done
184+
* * Step 5: PF performs VF FLR cleanups and notifies the GuC FW when finished
183185
*/
184186

185187
static bool needs_dispatch_flr(struct xe_device *xe)

0 commit comments

Comments
 (0)