drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
Subsystems (2)
PATCH 1/1 drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
GuC Address Space and WOPCM Layout diagrams won't be generated correctly by sphinx build if not using proper reST syntax.
This patch uses reST literal blocks to make sure GuC Address Space and WOPCM Layout diagrams to be generated correctly.
--- drivers/gpu/drm/i915/intel_guc.c | 46 ++++++++++++++++++++------------------ drivers/gpu/drm/i915/intel_wopcm.c | 40 +++++++++++++++++---------------- 2 files changed, 45 insertions(+), 41 deletions(-)
drivers/gpu/drm/i915/intel_guc.c +24 -22
@@ -497,28 +497,30 @@ int intel_guc_resume(struct intel_guc *guc)* * The layout of GuC address space is shown as below: * -* +==============> +====================+ <== GUC_GGTT_TOP -* ^ | | -* | | | -* | | DRAM | -* | | Memory | -* | | | -* GuC | | -* Address +========> +====================+ <== WOPCM Top -* Space ^ | HW contexts RSVD | -* | | | WOPCM | -* | | +==> +--------------------+ <== GuC WOPCM Top -* | GuC ^ | | -* | GGTT | | | -* | Pin GuC | GuC | -* | Bias WOPCM | WOPCM | -* | | Size | | -* | | | | | -* v v v | | -* +=====+=====+==> +====================+ <== GuC WOPCM Base -* | Non-GuC WOPCM | -* | (HuC/Reserved) | -* +====================+ <== WOPCM Base +* :: +* +* +==============> +====================+ <== GUC_GGTT_TOP +* ^ | | +* | | | +* | | DRAM | +* | | Memory | +* | | | +* GuC | | +* Address +========> +====================+ <== WOPCM Top +* Space ^ | HW contexts RSVD | +* | | | WOPCM | +* | | +==> +--------------------+ <== GuC WOPCM Top +* | GuC ^ | | +* | GGTT | | | +* | Pin GuC | GuC | +* | Bias WOPCM | WOPCM | +* | | Size | | +* | | | | | +* v v v | | +* +=====+=====+==> +====================+ <== GuC WOPCM Base +* | Non-GuC WOPCM | +* | (HuC/Reserved) | +* +====================+ <== WOPCM Base * * The lower part [0, GuC ggtt_pin_bias) is mapped to WOPCM which consists of * GuC WOPCM and WOPCM reserved for other usage (e.g.RC6 context). The value of
drivers/gpu/drm/i915/intel_wopcm.c +21 -19
@@ -14,25 +14,27 @@* offset registers whose are calculated are determined by size of HuC/GuC * firmware size and set of hw requirements/restrictions as shown below: * -* +=========> +====================+ <== WOPCM Top -* ^ | HW contexts RSVD | -* | +===> +====================+ <== GuC WOPCM Top -* | ^ | | -* | | | | -* | | | | -* | GuC | | -* | WOPCM | | -* | Size +--------------------+ -* WOPCM | | GuC FW RSVD | -* | | +--------------------+ -* | | | GuC Stack RSVD | -* | | +------------------- + -* | v | GuC WOPCM RSVD | -* | +===> +====================+ <== GuC WOPCM base -* | | WOPCM RSVD | -* | +------------------- + <== HuC Firmware Top -* v | HuC FW | -* +=========> +====================+ <== WOPCM Base +* :: +* +* +=========> +====================+ <== WOPCM Top +* ^ | HW contexts RSVD | +* | +===> +====================+ <== GuC WOPCM Top +* | ^ | | +* | | | | +* | | | | +* | GuC | | +* | WOPCM | | +* | Size +--------------------+ +* WOPCM | | GuC FW RSVD | +* | | +--------------------+ +* | | | GuC Stack RSVD | +* | | +------------------- + +* | v | GuC WOPCM RSVD | +* | +===> +====================+ <== GuC WOPCM base +* | | WOPCM RSVD | +* | +------------------- + <== HuC Firmware Top +* v | HuC FW | +* +=========> +====================+ <== WOPCM Base * * GuC accessible WOPCM starts at GuC WOPCM base and ends at GuC WOPCM top. * The top part of the WOPCM is reserved for hardware contexts (e.g. RC6
Signature · 6 lines
2.7.4 _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Patchwork
CI✓ Fi.CI.BAT: success for drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
== Series Details ==
== Series Details ==
Series: drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
URL : https://patchwork.freedesktop.org/series/39979/
State : success
== Summary ==
Series 39979v1 drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
https://patchwork.freedesktop.org/api/1.0/series/39979/revisions/1/mbox/
---- Possible new issues:
Test kms_flip:
Subgroup basic-flip-vs-wf_vblank:
fail -> PASS (fi-skl-6770hq)---- Known issues:
Test kms_pipe_crc_basic:
Subgroup suspend-read-crc-pipe-c:
pass -> FAIL (fi-cnl-y3) fdo#104951fdo#104951 https://bugs.freedesktop.org/show_bug.cgi?id=104951
fi-bdw-5557u total:285 pass:264 dwarn:0 dfail:0 fail:0 skip:21 time:428s fi-bdw-gvtdvm total:285 pass:261 dwarn:0 dfail:0 fail:0 skip:24 time:439s fi-blb-e6850 total:285 pass:220 dwarn:1 dfail:0 fail:0 skip:64 time:379s fi-bsw-n3050 total:285 pass:239 dwarn:0 dfail:0 fail:0 skip:46 time:536s fi-bwr-2160 total:285 pass:180 dwarn:0 dfail:0 fail:0 skip:105 time:297s fi-bxt-dsi total:285 pass:255 dwarn:0 dfail:0 fail:0 skip:30 time:512s fi-byt-j1900 total:285 pass:250 dwarn:0 dfail:0 fail:0 skip:35 time:514s fi-byt-n2820 total:285 pass:246 dwarn:0 dfail:0 fail:0 skip:39 time:501s fi-cfl-8700k total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:408s fi-cfl-s2 total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:583s fi-cfl-u total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:511s fi-cnl-y3 total:285 pass:258 dwarn:0 dfail:0 fail:1 skip:26 time:574s fi-elk-e7500 total:285 pass:226 dwarn:0 dfail:0 fail:0 skip:59 time:424s fi-gdg-551 total:285 pass:176 dwarn:0 dfail:0 fail:1 skip:108 time:311s fi-glk-1 total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:534s fi-hsw-4770 total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:404s fi-ilk-650 total:285 pass:225 dwarn:0 dfail:0 fail:0 skip:60 time:421s fi-ivb-3520m total:285 pass:256 dwarn:0 dfail:0 fail:0 skip:29 time:476s fi-ivb-3770 total:285 pass:252 dwarn:0 dfail:0 fail:0 skip:33 time:428s fi-kbl-7500u total:285 pass:260 dwarn:1 dfail:0 fail:0 skip:24 time:471s fi-kbl-7567u total:285 pass:265 dwarn:0 dfail:0 fail:0 skip:20 time:465s fi-kbl-r total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:514s fi-pnv-d510 total:285 pass:219 dwarn:1 dfail:0 fail:0 skip:65 time:658s fi-skl-6260u total:285 pass:265 dwarn:0 dfail:0 fail:0 skip:20 time:442s fi-skl-6600u total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:525s fi-skl-6700hq total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:539s fi-skl-6700k2 total:285 pass:261 dwarn:0 dfail:0 fail:0 skip:24 time:507s fi-skl-6770hq total:285 pass:265 dwarn:0 dfail:0 fail:0 skip:20 time:495s fi-skl-guc total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:435s fi-skl-gvtdvm total:285 pass:262 dwarn:0 dfail:0 fail:0 skip:23 time:444s fi-snb-2520m total:285 pass:245 dwarn:0 dfail:0 fail:0 skip:40 time:592s fi-snb-2600 total:285 pass:245 dwarn:0 dfail:0 fail:0 skip:40 time:400s
Blacklisted hosts:
fi-cnl-drrs total:285 pass:254 dwarn:3 dfail:0 fail:0 skip:28 time:517s
86e964296fe8bc85fdb624fa75b4cd83fcfb58cd drm-tip: 2018y-03m-14d-17h-40m-20s UTC integration manifest c729cf26691d drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
== Logs ==
For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_8348/issues.html
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Jani Nikula
maintainerQuoted 36 lines · Jackie Li
GuC Address Space and WOPCM Layout diagrams won't be generated correctly by sphinx build if not using proper reST syntax.
This patch uses reST literal blocks to make sure GuC Address Space and WOPCM Layout diagrams to be generated correctly.
Signed-off-by Jackie Li <[email protected]>Cc Michal Wajdeczko <[email protected]>Cc Sagar Arun Kamble <[email protected]>Cc Joonas Lahtinen <[email protected]>--- drivers/gpu/drm/i915/intel_guc.c | 46 ++++++++++++++++++++------------------ drivers/gpu/drm/i915/intel_wopcm.c | 40 +++++++++++++++++---------------- 2 files changed, 45 insertions(+), 41 deletions(-)drivers/gpu/drm/i915/intel_guc.c +0
-13@@ -497,28 +497,30 @@ int intel_guc_resume(struct intel_guc *guc)* * The layout of GuC address space is shown as below: * -* +==============> +====================+ <== GUC_GGTT_TOP -* ^ | | -* | | | -* | | DRAM | -* | | Memory | -* | | | -* GuC | | -* Address +========> +====================+ <== WOPCM Top -* Space ^ | HW contexts RSVD | -* | | | WOPCM | -* | | +==> +--------------------+ <== GuC WOPCM Top -* | GuC ^ | | -* | GGTT | | |
drivers/gpu/drm/i915/intel_guc.c int intel_guc_resume(struct intel_guc *guc) · line 500
Quoted 10 lines
drivers/gpu/drm/i915/intel_guc.c +1
-9-* | Pin GuC | GuC | -* | Bias WOPCM | WOPCM | -* | | Size | | -* | | | | | -* v v v | | -* +=====+=====+==> +====================+ <== GuC WOPCM Base -* | Non-GuC WOPCM | -* | (HuC/Reserved) | -* +====================+ <== WOPCM Base +* ::
Nitpick, you could add that to the end of the preceding paragraph as a double colon.
"As a convenience, the "::" is recognized at the end of any paragraph. If immediately preceded by whitespace, both colons will be removed from the output (this is the "partially minimized" form). When text immediately precedes the "::", one colon will be removed from the output, leaving only one colon visible (i.e., "::" will be replaced by ":"; this is the "fully minimized" form)."
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks
BR,
Jani.
Quoted 77 lines
drivers/gpu/drm/i915/intel_guc.c +23
-0+* +* +==============> +====================+ <== GUC_GGTT_TOP +* ^ | | +* | | | +* | | DRAM | +* | | Memory | +* | | | +* GuC | | +* Address +========> +====================+ <== WOPCM Top +* Space ^ | HW contexts RSVD | +* | | | WOPCM | +* | | +==> +--------------------+ <== GuC WOPCM Top +* | GuC ^ | | +* | GGTT | | | +* | Pin GuC | GuC | +* | Bias WOPCM | WOPCM | +* | | Size | | +* | | | | | +* v v v | | +* +=====+=====+==> +====================+ <== GuC WOPCM Base +* | Non-GuC WOPCM | +* | (HuC/Reserved) | +* +====================+ <== WOPCM Base * * The lower part [0, GuC ggtt_pin_bias) is mapped to WOPCM which consists of * GuC WOPCM and WOPCM reserved for other usage (e.g.RC6 context). The value of drivers/gpu/drm/i915/intel_wopcm.c +21
-19@@ -14,25 +14,27 @@* offset registers whose are calculated are determined by size of HuC/GuC * firmware size and set of hw requirements/restrictions as shown below: * -* +=========> +====================+ <== WOPCM Top -* ^ | HW contexts RSVD | -* | +===> +====================+ <== GuC WOPCM Top -* | ^ | | -* | | | | -* | | | | -* | GuC | | -* | WOPCM | | -* | Size +--------------------+ -* WOPCM | | GuC FW RSVD | -* | | +--------------------+ -* | | | GuC Stack RSVD | -* | | +------------------- + -* | v | GuC WOPCM RSVD | -* | +===> +====================+ <== GuC WOPCM base -* | | WOPCM RSVD | -* | +------------------- + <== HuC Firmware Top -* v | HuC FW | -* +=========> +====================+ <== WOPCM Base +* :: +* +* +=========> +====================+ <== WOPCM Top +* ^ | HW contexts RSVD | +* | +===> +====================+ <== GuC WOPCM Top +* | ^ | | +* | | | | +* | | | | +* | GuC | | +* | WOPCM | | +* | Size +--------------------+ +* WOPCM | | GuC FW RSVD | +* | | +--------------------+ +* | | | GuC Stack RSVD | +* | | +------------------- + +* | v | GuC WOPCM RSVD | +* | +===> +====================+ <== GuC WOPCM base +* | | WOPCM RSVD | +* | +------------------- + <== HuC Firmware Top +* v | HuC FW | +* +=========> +====================+ <== WOPCM Base * * GuC accessible WOPCM starts at GuC WOPCM base and ends at GuC WOPCM top. * The top part of the WOPCM is reserved for hardware contexts (e.g. RC6
Signature · 5 lines
Jani Nikula, Intel Open Source Technology Center _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx