drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
Subsystems (2)
PATCH v3 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, and it also corrects some errors in the diagram description.
v2:
- Fixed errors in diagram description
v3:
- Updated GuC Address Space kernel-doc based on Michal's suggestion
--- drivers/gpu/drm/i915/intel_guc.c | 56 ++++++++++++++++++++------------------ drivers/gpu/drm/i915/intel_wopcm.c | 44 ++++++++++++++++-------------- 2 files changed, 52 insertions(+), 48 deletions(-)
drivers/gpu/drm/i915/intel_guc.c +29 -27
@@ -495,35 +495,37 @@ int intel_guc_resume(struct intel_guc *guc)/** * DOC: GuC Address Space * -* The layout of GuC address space is shown as below: +* The layout of GuC address space is shown 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 +* :: * -* 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 -* the GuC ggtt_pin_bias is determined by the actually GuC WOPCM size which is -* set in GUC_WOPCM_SIZE register. +* +==============> +====================+ <== 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 of GuC Address Space [0, ggtt_pin_bias) is mapped to WOPCM +* while upper part of GuC Address Space [ggtt_pin_bias, GUC_GGTT_TOP) is mapped +* to DRAM. The value of the GuC ggtt_pin_bias is determined by WOPCM size and +* actual GuC WOPCM size. */ /**
drivers/gpu/drm/i915/intel_wopcm.c +23 -21
51 lines not on this page · raw message
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 (rev3)
== Series Details ==
== Series Details ==
Series: drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev3)
URL : https://patchwork.freedesktop.org/series/39979/
State : success
== Summary ==
Series 39979v3 drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
https://patchwork.freedesktop.org/api/1.0/series/39979/revisions/3/mbox/
---- Known issues:
Test debugfs_test:
Subgroup read_all_entries:
incomplete -> PASS (fi-snb-2520m) fdo#103713
Test kms_pipe_crc_basic:
Subgroup suspend-read-crc-pipe-c:
pass -> DMESG-WARN (fi-cnl-y3) fdo#104951fdo#103713 https://bugs.freedesktop.org/show_bug.cgi?id=103713
fdo#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:433s fi-bdw-gvtdvm total:285 pass:261 dwarn:0 dfail:0 fail:0 skip:24 time:441s fi-blb-e6850 total:285 pass:220 dwarn:1 dfail:0 fail:0 skip:64 time:381s 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:300s fi-bxt-dsi total:285 pass:255 dwarn:0 dfail:0 fail:0 skip:30 time:513s fi-bxt-j4205 total:285 pass:256 dwarn:0 dfail:0 fail:0 skip:29 time:512s fi-byt-j1900 total:285 pass:250 dwarn:0 dfail:0 fail:0 skip:35 time:523s fi-byt-n2820 total:285 pass:246 dwarn:0 dfail:0 fail:0 skip:39 time:507s fi-cfl-8700k total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:411s fi-cfl-s2 total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:576s fi-cfl-u total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:512s fi-cnl-drrs total:285 pass:254 dwarn:3 dfail:0 fail:0 skip:28 time:530s fi-cnl-y3 total:285 pass:258 dwarn:1 dfail:0 fail:0 skip:26 time:588s fi-elk-e7500 total:285 pass:226 dwarn:0 dfail:0 fail:0 skip:59 time:425s fi-gdg-551 total:285 pass:177 dwarn:0 dfail:0 fail:0 skip:108 time:316s fi-glk-1 total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:537s fi-hsw-4770 total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:403s fi-ilk-650 total:285 pass:225 dwarn:0 dfail:0 fail:0 skip:60 time:418s fi-ivb-3520m total:285 pass:256 dwarn:0 dfail:0 fail:0 skip:29 time:478s 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:477s fi-kbl-7567u total:285 pass:265 dwarn:0 dfail:0 fail:0 skip:20 time:468s fi-kbl-r total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:520s fi-pnv-d510 total:285 pass:219 dwarn:1 dfail:0 fail:0 skip:65 time:655s fi-skl-6260u total:285 pass:265 dwarn:0 dfail:0 fail:0 skip:20 time:447s fi-skl-6600u total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:532s 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:494s fi-skl-guc total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:432s fi-skl-gvtdvm total:285 pass:262 dwarn:0 dfail:0 fail:0 skip:23 time:447s fi-snb-2520m total:285 pass:245 dwarn:0 dfail:0 fail:0 skip:40 time:590s fi-snb-2600 total:285 pass:245 dwarn:0 dfail:0 fail:0 skip:40 time:400s
3b4800f0237f9422817a1a9695d742598d2fb868 drm-tip: 2018y-03m-15d-15h-48m-56s UTC integration manifest 7ac0518f687e 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_8369/issues.html
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Patchwork
CI✓ Fi.CI.IGT: success for drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev3)
In reply to Jackie Li== Series Details ==
== Series Details ==
Series: drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev3)
URL : https://patchwork.freedesktop.org/series/39979/
State : success
== Summary ==
---- Known issues:
Test kms_cursor_crc:
Subgroup cursor-256x256-suspend:
skip -> PASS (shard-snb) fdo#103375
Test kms_flip:
Subgroup 2x-flip-vs-expired-vblank:
pass -> FAIL (shard-hsw) fdo#102887
Subgroup 2x-plain-flip-ts-check:
pass -> FAIL (shard-hsw) fdo#100368fdo#103375 https://bugs.freedesktop.org/show_bug.cgi?id=103375
fdo#102887 https://bugs.freedesktop.org/show_bug.cgi?id=102887
fdo#100368 https://bugs.freedesktop.org/show_bug.cgi?id=100368
shard-apl total:3442 pass:1814 dwarn:1 dfail:0 fail:7 skip:1619 time:13064s shard-hsw total:3442 pass:1766 dwarn:1 dfail:0 fail:3 skip:1671 time:11848s shard-snb total:3442 pass:1357 dwarn:1 dfail:0 fail:3 skip:2081 time:7250s
Blacklisted hosts:
shard-kbl total:2040 pass:1140 dwarn:0 dfail:0 fail:5 skip:892 time:5410s
== Logs ==
For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_8369/shards.html
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Joonas suggests to include these files guc.c and wopcm.c in i915.rst with WOPCM being separate section from GuC. Also ensure make htmldocs generates proper/expected documentation.
Thanks,
Sagar
Quoted 147 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, and it also corrects some errors in the diagram description.
v2:
- Fixed errors in diagram descriptionv3:
- Updated GuC Address Space kernel-doc based on Michal's suggestionSigned-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 | 56 ++++++++++++++++++++------------------ drivers/gpu/drm/i915/intel_wopcm.c | 44 ++++++++++++++++-------------- 2 files changed, 52 insertions(+), 48 deletions(-)drivers/gpu/drm/i915/intel_guc.c +29
-27@@ -495,35 +495,37 @@ int intel_guc_resume(struct intel_guc *guc)/** * DOC: GuC Address Space * -* The layout of GuC address space is shown as below: +* The layout of GuC address space is shown 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 +* :: * -* 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 -* the GuC ggtt_pin_bias is determined by the actually GuC WOPCM size which is -* set in GUC_WOPCM_SIZE register. +* +==============> +====================+ <== 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 of GuC Address Space [0, ggtt_pin_bias) is mapped to WOPCM +* while upper part of GuC Address Space [ggtt_pin_bias, GUC_GGTT_TOP) is mapped +* to DRAM. The value of the GuC ggtt_pin_bias is determined by WOPCM size and +* actual GuC WOPCM size. */ /** drivers/gpu/drm/i915/intel_wopcm.c +23
-21@@ -11,28 +11,30 @@* DOC: WOPCM Layout * * The layout of the WOPCM will be fixed after writing to GuC WOPCM size and -* offset registers whose are calculated are determined by size of HuC/GuC -* firmware size and set of hw requirements/restrictions as shown below: +* offset registers whose values are calculated and determined by HuC/GuC +* firmware size and set of hardware 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 · 7 lines
Thanks, Sagar _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Thanks Sagar and Joonas! I probably need reconfigure my email client.
I will add these docs to i915.rst. Since we've already had a GuC chapter defined in i915.rst,
so I will include these doc like:
WOPCM
WOPCM Layout doc
GuC
<existing GuC doc sections>
GuC Address Space doc
Please let me know if I misunderstood anything.
Thanks,
-Jackie
Quoted 156 lines · Sagar Arun Kamble
Joonas suggests to include these files
guc.candwopcm.cini915.rstwith WOPCM being separate section from GuC. Also ensure make htmldocs generates proper/expected documentation.Thanks,
SagarQuoted 149 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, and it also corrects some errors in the diagram description.
v2:
- Fixed errors in diagram descriptionv3:
- Updated GuC Address Space kernel-doc based on Michal's suggestionSigned-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 | 56
++++++++++++++++++++------------------
drivers/gpu/drm/i915/intel_wopcm.c| 44 ++++++++++++++++--------------2 files changed, 52 insertions(+), 48 deletions(-)drivers/gpu/drm/i915/intel_guc.c +2
-24@@ -495,35 +495,37 @@ int intel_guc_resume(struct intel_guc *guc) /*** DOC: GuC Address Space * -* The layout of GuC address space is shown as below: +* The layout of GuC address space is shown 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 +* :: * -* 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
- * the GuCggtt_pin_biasis determined by the actually GuC WOPCM size which is
- * set inGUC_WOPCM_SIZEregister.
+ * +==============> +====================+ <==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 of GuC Address Space [0,ggtt_pin_bias) is mapped to WOPCM
+ * while upper part of GuC Address Space [ggtt_pin_bias,GUC_GGTT_TOP) is mapped
+ * to DRAM. The value of the GuCggtt_pin_biasis determined by WOPCM size and
+ * actual GuC WOPCM size.
*/
/**drivers/gpu/drm/i915/intel_wopcm.c +0
-1@@ -11,28 +11,30 @@ * DOC: WOPCM Layout * * The layout of the WOPCM will be fixed after writing to GuC WOPCM size and - * offset registers whose are calculated are determined by size ofHuC/GuC
- * firmware size and set of hw requirements/restrictions as shown below:
+ * offset registers whose values are calculated and determined by HuC/GuC
+ * firmware size and set of hardware 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 |
Quoted 9 lines
Quoted 8 lines
+ * | +===> +====================+ <== 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
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx