drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
Subsystems (2)
PATCH v2 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
--- drivers/gpu/drm/i915/intel_guc.c | 52 ++++++++++++++++++++------------------ drivers/gpu/drm/i915/intel_wopcm.c | 44 +++++++++++++++++--------------- 2 files changed, 50 insertions(+), 46 deletions(-)
drivers/gpu/drm/i915/intel_guc.c +27 -25
@@ -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 +* :: +* +* +==============> +====================+ <== 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. +* the GuC ggtt_pin_bias is determined by the GuC WOPCM size which is set in +* GUC_WOPCM_SIZE register. */ /**
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
Quoted 79 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 descriptionSigned-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 | 52 ++++++++++++++++++++------------------ drivers/gpu/drm/i915/intel_wopcm.c | 44 +++++++++++++++++--------------- 2 files changed, 50 insertions(+), 46 deletions(-)drivers/gpu/drm/i915/intel_guc.c +25
-23@@ -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 +* :: +* +* +==============> +====================+ <== 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
Quoted 2 lines
consists of
* GuC WOPCM and WOPCM reserved for other usage (e.g.RC6 context). The
hmm, "lower part [...)" is little ambiguous here, as one may look for "upper part [...)", so maybe better to be explicit:
"The lower part of GuC Address Space ie. [0, ggtt_pin_bias) is mapped to WOPCM, while upper part of GuC Address Space ie. [ggtt_pin_bias, GUC_GGTT_TOP) is mapped to DRAM."
Quoted 8 lines
value of
- * the GuCggtt_pin_biasis determined by the actually GuC WOPCM size which is
- * set inGUC_WOPCM_SIZEregister.
+ * the GuCggtt_pin_biasis determined by the GuC WOPCM size which is set in
+ *GUC_WOPCM_SIZEregister.
*/
hmm, I'm not sure that above statement is correct, compare your diagram and calculation:
guc->ggtt_pin_bias = i915->wopcm.size - i915->wopcm.guc.base;
also I would not mention registers here, as we don't read them while calculating bias, so maybe something like this:
"The value of ggtt_pin_bias is determined by the WOPCM size and actual GuC WOPCM base."
/Michal
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Quoted 87 lines · Michal Wajdeczko
Quoted 71 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 descriptionSigned-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 | 52
++++++++++++++++++++------------------
drivers/gpu/drm/i915/intel_wopcm.c | 44
+++++++++++++++++---------------2 files changed, 50 insertions(+), 46 deletions(-)drivers/gpu/drm/i915/intel_guc.c +18
-23@@ -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 +* :: +* +* +==============> +====================+ <== 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 | drivers/gpu/drm/i915/intel_guc.c int intel_guc_resume(struct intel_guc *guc) · line 526
Quoted 10 lines
drivers/gpu/drm/i915/intel_guc.c +7
-0+ * | | 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). Thehmm, "lower part [...)" is little ambiguous here, as one may look for "upper part [...)", so maybe better to be explicit:
Quoted 4 lines
"The lower part of GuC Address Space ie. [0,
ggtt_pin_bias) is mapped to WOPCM, while upper part of GuC Address Space ie. [ggtt_pin_bias,GUC_GGTT_TOP) is mapped to DRAM."
Agree. it's more clear in this way. but I think we should remove "ie." update it to "The lower part of GuC Address Space [0, ggtt_pin_bias) is mapped to WOPCM"?
Quoted 12 lines
Quoted 8 lines
value of
- * the GuCggtt_pin_biasis determined by the actually GuC WOPCM size which is
- * set inGUC_WOPCM_SIZEregister.
+ * the GuCggtt_pin_biasis determined by the GuC WOPCM size which is set in
+ *GUC_WOPCM_SIZEregister.
*/hmm, I'm not sure that above statement is correct, compare your diagram and calculation:
Quoted 8 lines
guc->ggtt_pin_bias =
i915->wopcm.size-i915->wopcm.guc.base;also I would not mention registers here, as we don't read them while calculating bias, so maybe something like this:
"The value of
ggtt_pin_biasis determined by the WOPCM size and actual GuC WOPCM base."
Thanks. Will update it.
Regards,
-Jackie
_______________________________________________
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 (rev2)
In reply to Jackie Li== Series Details ==
== Series Details ==
Series: drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev2)
URL : https://patchwork.freedesktop.org/series/39979/
State : success
== Summary ==
Series 39979v2 drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
https://patchwork.freedesktop.org/api/1.0/series/39979/revisions/2/mbox/
---- Possible new issues:
Test kms_flip:
Subgroup basic-flip-vs-wf_vblank:
fail -> PASS (fi-skl-6770hq)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:441s fi-blb-e6850 total:285 pass:220 dwarn:1 dfail:0 fail:0 skip:64 time:383s 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:516s fi-byt-j1900 total:285 pass:250 dwarn:0 dfail:0 fail:0 skip:35 time:515s 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:406s fi-cfl-s2 total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:584s fi-cfl-u total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:511s fi-cnl-y3 total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:587s fi-elk-e7500 total:285 pass:226 dwarn:0 dfail:0 fail:0 skip:59 time:426s fi-gdg-551 total:285 pass:176 dwarn:0 dfail:0 fail:1 skip:108 time:314s fi-glk-1 total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:538s fi-hsw-4770 total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:402s fi-ilk-650 total:285 pass:225 dwarn:0 dfail:0 fail:0 skip:60 time:420s fi-ivb-3520m total:285 pass:256 dwarn:0 dfail:0 fail:0 skip:29 time:474s fi-ivb-3770 total:285 pass:252 dwarn:0 dfail:0 fail:0 skip:33 time:433s fi-kbl-7500u total:285 pass:260 dwarn:1 dfail:0 fail:0 skip:24 time:475s fi-kbl-7567u total:285 pass:265 dwarn:0 dfail:0 fail:0 skip:20 time:467s fi-kbl-r total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:511s fi-pnv-d510 total:285 pass:219 dwarn:1 dfail:0 fail:0 skip:65 time:659s fi-skl-6260u total:285 pass:265 dwarn:0 dfail:0 fail:0 skip:20 time:438s fi-skl-6600u total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:528s fi-skl-6700hq total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:540s fi-skl-6700k2 total:285 pass:261 dwarn:0 dfail:0 fail:0 skip:24 time:502s fi-skl-6770hq total:285 pass:265 dwarn:0 dfail:0 fail:0 skip:20 time:490s fi-skl-guc total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:430s fi-skl-gvtdvm total:285 pass:262 dwarn:0 dfail:0 fail:0 skip:23 time:446s fi-snb-2520m total:285 pass:245 dwarn:0 dfail:0 fail:0 skip:40 time:564s fi-snb-2600 total:285 pass:245 dwarn:0 dfail:0 fail:0 skip:40 time:399s
Blacklisted hosts:
fi-cnl-drrs total:285 pass:254 dwarn:3 dfail:0 fail:0 skip:28 time:533s
86e964296fe8bc85fdb624fa75b4cd83fcfb58cd drm-tip: 2018y-03m-14d-17h-40m-20s UTC integration manifest d844e97e5304 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_8351/issues.html
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Patchwork
CI✗ Fi.CI.IGT: failure for drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev2)
In reply to Jackie Li== Series Details ==
== Series Details ==
Series: drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev2)
URL : https://patchwork.freedesktop.org/series/39979/
State : failure
== Summary ==
---- Possible new issues:
Test gem_exec_capture:
Subgroup capture-vebox:
pass -> FAIL (shard-apl)
Test kms_frontbuffer_tracking:
Subgroup fbc-1p-primscrn-pri-indfb-draw-mmap-wc:
pass -> FAIL (shard-apl)
Subgroup fbc-1p-primscrn-spr-indfb-draw-pwrite:
pass -> FAIL (shard-apl)
Test kms_vblank:
Subgroup pipe-a-ts-continuation-suspend:
skip -> PASS (shard-snb)---- Known issues:
Test gem_eio:
Subgroup in-flight-contexts:
pass -> INCOMPLETE (shard-apl) fdo#105341
Test kms_flip:
Subgroup plain-flip-fb-recreate-interruptible:
fail -> PASS (shard-hsw) fdo#100368 +1
Test kms_sysfs_edid_timing:
warn -> PASS (shard-apl) fdo#100047fdo#105341 https://bugs.freedesktop.org/show_bug.cgi?id=105341
fdo#100368 https://bugs.freedesktop.org/show_bug.cgi?id=100368
fdo#100047 https://bugs.freedesktop.org/show_bug.cgi?id=100047
shard-apl total:3286 pass:1721 dwarn:1 dfail:0 fail:9 skip:1553 time:11853s shard-hsw total:3441 pass:1766 dwarn:1 dfail:0 fail:1 skip:1672 time:11890s shard-snb total:3441 pass:1356 dwarn:1 dfail:0 fail:3 skip:2081 time:7165s
Blacklisted hosts:
shard-kbl total:3425 pass:1925 dwarn:1 dfail:0 fail:9 skip:1488 time:9042s
== Logs ==
For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_8351/shards.html
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Are we required to add reference to intel_guc.c and intel_wopcm.c in Documentation/gpu/i915.rst?
Quoted 142 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 descriptionSigned-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 | 52 ++++++++++++++++++++------------------ drivers/gpu/drm/i915/intel_wopcm.c | 44 +++++++++++++++++--------------- 2 files changed, 50 insertions(+), 46 deletions(-)drivers/gpu/drm/i915/intel_guc.c +27
-25@@ -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 +* :: +* +* +==============> +====================+ <== 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. +* the GuC ggtt_pin_bias is determined by the GuC WOPCM size which is set in +* GUC_WOPCM_SIZE register. */ /** 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
Quoted 2 lines · Sagar Arun Kamble
Are we required to add reference to
intel_guc.candintel_wopcm.cinDocumentation/gpu/i915.rst?
hmm, I have the same question too:-). Can I modify the i915.rst to include kernel-doc from WOPCM and GuC WOPCM related changes? or someone would decide what contents should be included in i915 kernel doc?
From my point of view, I think it would make the kernel-doc more comprehensible (at least for the wopcm part) if these diagrams were exported as a part of kernel-doc.
Thanks,
-Jackie
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx