* [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
@ 2018-03-22 23:59 Jackie Li
2018-03-23 0:39 ` ✓ Fi.CI.BAT: success for drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev4) Patchwork
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Jackie Li @ 2018-03-22 23:59 UTC (permalink / raw)
To: intel-gfx
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
v4:
- Added WOPCM layout and GuC address space docs into i915.rst (Joonas)
Signed-off-by: Jackie Li <yaodong.li@intel.com>
Cc: Michal Wajdeczko <michal.wajdeczko@intel.com>
Cc: Sagar Arun Kamble <sagar.a.kamble@intel.com>
Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
---
Documentation/gpu/i915.rst | 15 ++++++++++
drivers/gpu/drm/i915/intel_guc.c | 56 ++++++++++++++++++++------------------
drivers/gpu/drm/i915/intel_wopcm.c | 44 ++++++++++++++++--------------
3 files changed, 67 insertions(+), 48 deletions(-)
diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index 41dc881..7ecad71 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentation/gpu/i915.rst
@@ -335,6 +335,15 @@ objects, which has the goal to make space in gpu virtual address spaces.
.. kernel-doc:: drivers/gpu/drm/i915/i915_gem_shrinker.c
:internal:
+WOPCM
+=====
+
+WOPCM Layout
+------------
+
+.. kernel-doc:: drivers/gpu/drm/i915/intel_wopcm.c
+ :doc: WOPCM Layout
+
GuC
===
@@ -359,6 +368,12 @@ GuC Firmware Layout
.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fwif.h
:doc: GuC Firmware Layout
+GuC Address Space
+-----------------
+
+.. kernel-doc:: drivers/gpu/drm/i915/intel_guc.c
+ :doc: GuC Address Space
+
Tracing
=======
diff --git a/drivers/gpu/drm/i915/intel_guc.c b/drivers/gpu/drm/i915/intel_guc.c
index 8f93f5b..c5f64c7 100644
--- a/drivers/gpu/drm/i915/intel_guc.c
+++ b/drivers/gpu/drm/i915/intel_guc.c
@@ -494,35 +494,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.
*/
/**
diff --git a/drivers/gpu/drm/i915/intel_wopcm.c b/drivers/gpu/drm/i915/intel_wopcm.c
index 4117886..74bf76f 100644
--- a/drivers/gpu/drm/i915/intel_wopcm.c
+++ b/drivers/gpu/drm/i915/intel_wopcm.c
@@ -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
--
2.7.4
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
^ permalink raw reply related [flat|nested] 5+ messages in thread
* ✓ Fi.CI.BAT: success for drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev4)
2018-03-22 23:59 [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams Jackie Li
@ 2018-03-23 0:39 ` Patchwork
2018-03-23 4:50 ` ✓ Fi.CI.IGT: " Patchwork
2018-03-28 11:27 ` [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams Joonas Lahtinen
2 siblings, 0 replies; 5+ messages in thread
From: Patchwork @ 2018-03-23 0:39 UTC (permalink / raw)
To: Jackie Li; +Cc: intel-gfx
== Series Details ==
Series: drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev4)
URL : https://patchwork.freedesktop.org/series/39979/
State : success
== Summary ==
Series 39979v4 drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
https://patchwork.freedesktop.org/api/1.0/series/39979/revisions/4/mbox/
---- Known issues:
Test kms_flip:
Subgroup basic-flip-vs-wf_vblank:
pass -> FAIL (fi-skl-6770hq) fdo#100368
Test kms_pipe_crc_basic:
Subgroup suspend-read-crc-pipe-b:
pass -> INCOMPLETE (fi-snb-2520m) fdo#103713
fdo#100368 https://bugs.freedesktop.org/show_bug.cgi?id=100368
fdo#103713 https://bugs.freedesktop.org/show_bug.cgi?id=103713
fi-bdw-5557u total:285 pass:264 dwarn:0 dfail:0 fail:0 skip:21 time:436s
fi-bdw-gvtdvm total:285 pass:261 dwarn:0 dfail:0 fail:0 skip:24 time:445s
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:539s
fi-bwr-2160 total:285 pass:180 dwarn:0 dfail:0 fail:0 skip:105 time:299s
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:517s
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:509s
fi-cfl-8700k total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:412s
fi-cfl-u total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:511s
fi-cnl-drrs total:285 pass:254 dwarn:3 dfail:0 fail:0 skip:28 time:522s
fi-cnl-y3 total:285 pass:259 dwarn:0 dfail:0 fail:0 skip:26 time:587s
fi-elk-e7500 total:285 pass:225 dwarn:1 dfail:0 fail:0 skip:59 time:428s
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:406s
fi-ilk-650 total:285 pass:225 dwarn:0 dfail:0 fail:0 skip:60 time:422s
fi-ivb-3520m total:285 pass:256 dwarn:0 dfail:0 fail:0 skip:29 time:483s
fi-ivb-3770 total:285 pass:252 dwarn:0 dfail:0 fail:0 skip:33 time:434s
fi-kbl-7500u total:285 pass:260 dwarn:1 dfail:0 fail:0 skip:24 time:484s
fi-kbl-7567u total:285 pass:265 dwarn:0 dfail:0 fail:0 skip:20 time:472s
fi-kbl-r total:285 pass:258 dwarn:0 dfail:0 fail:0 skip:27 time:517s
fi-pnv-d510 total:285 pass:219 dwarn:1 dfail:0 fail:0 skip:65 time:648s
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:538s
fi-skl-6700k2 total:285 pass:261 dwarn:0 dfail:0 fail:0 skip:24 time:510s
fi-skl-6770hq total:285 pass:264 dwarn:0 dfail:0 fail:1 skip:20 time:494s
fi-skl-guc total:285 pass:257 dwarn:0 dfail:0 fail:0 skip:28 time:429s
fi-skl-gvtdvm total:285 pass:262 dwarn:0 dfail:0 fail:0 skip:23 time:447s
fi-snb-2520m total:242 pass:208 dwarn:0 dfail:0 fail:0 skip:33
fi-snb-2600 total:285 pass:245 dwarn:0 dfail:0 fail:0 skip:40 time:409s
fi-cfl-s3 failed to connect after reboot
9e3f06af248708774c765efd55bf8e883f24fbfd drm-tip: 2018y-03m-22d-21h-17m-42s UTC integration manifest
843f01e2c67b 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_8462/issues.html
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
^ permalink raw reply [flat|nested] 5+ messages in thread
* ✓ Fi.CI.IGT: success for drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev4)
2018-03-22 23:59 [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams Jackie Li
2018-03-23 0:39 ` ✓ Fi.CI.BAT: success for drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev4) Patchwork
@ 2018-03-23 4:50 ` Patchwork
2018-03-28 11:27 ` [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams Joonas Lahtinen
2 siblings, 0 replies; 5+ messages in thread
From: Patchwork @ 2018-03-23 4:50 UTC (permalink / raw)
To: Jackie Li; +Cc: intel-gfx
== Series Details ==
Series: drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev4)
URL : https://patchwork.freedesktop.org/series/39979/
State : success
== Summary ==
---- Known issues:
Test kms_cursor_legacy:
Subgroup 2x-long-flip-vs-cursor-atomic:
fail -> PASS (shard-hsw) fdo#104873
Test kms_flip:
Subgroup plain-flip-ts-check-interruptible:
pass -> FAIL (shard-hsw) fdo#100368
Test kms_sysfs_edid_timing:
pass -> WARN (shard-apl) fdo#100047
Test prime_vgem:
Subgroup basic-fence-flip:
pass -> FAIL (shard-apl) fdo#104008
fdo#104873 https://bugs.freedesktop.org/show_bug.cgi?id=104873
fdo#100368 https://bugs.freedesktop.org/show_bug.cgi?id=100368
fdo#100047 https://bugs.freedesktop.org/show_bug.cgi?id=100047
fdo#104008 https://bugs.freedesktop.org/show_bug.cgi?id=104008
shard-apl total:3484 pass:1819 dwarn:1 dfail:0 fail:8 skip:1655 time:13065s
shard-hsw total:3484 pass:1773 dwarn:1 dfail:0 fail:2 skip:1707 time:11825s
shard-snb total:3484 pass:1363 dwarn:1 dfail:0 fail:3 skip:2117 time:7232s
Blacklisted hosts:
shard-kbl total:3484 pass:1943 dwarn:1 dfail:0 fail:9 skip:1531 time:9960s
== Logs ==
For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_8462/shards.html
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
2018-03-22 23:59 [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams Jackie Li
2018-03-23 0:39 ` ✓ Fi.CI.BAT: success for drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev4) Patchwork
2018-03-23 4:50 ` ✓ Fi.CI.IGT: " Patchwork
@ 2018-03-28 11:27 ` Joonas Lahtinen
2018-03-28 12:19 ` Joonas Lahtinen
2 siblings, 1 reply; 5+ messages in thread
From: Joonas Lahtinen @ 2018-03-28 11:27 UTC (permalink / raw)
To: Jackie Li, intel-gfx
Quoting Jackie Li (2018-03-23 01:59:22)
> 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
>
> v4:
> - Added WOPCM layout and GuC address space docs into i915.rst (Joonas)
>
> Signed-off-by: Jackie Li <yaodong.li@intel.com>
> Cc: Michal Wajdeczko <michal.wajdeczko@intel.com>
> Cc: Sagar Arun Kamble <sagar.a.kamble@intel.com>
> Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
Looks good. Thanks for the patch, I'll proceed to merge it.
Reviewed-by: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
Regards, Joonas
> ---
> Documentation/gpu/i915.rst | 15 ++++++++++
> drivers/gpu/drm/i915/intel_guc.c | 56 ++++++++++++++++++++------------------
> drivers/gpu/drm/i915/intel_wopcm.c | 44 ++++++++++++++++--------------
> 3 files changed, 67 insertions(+), 48 deletions(-)
>
> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> index 41dc881..7ecad71 100644
> --- a/Documentation/gpu/i915.rst
> +++ b/Documentation/gpu/i915.rst
> @@ -335,6 +335,15 @@ objects, which has the goal to make space in gpu virtual address spaces.
> .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_shrinker.c
> :internal:
>
> +WOPCM
> +=====
> +
> +WOPCM Layout
> +------------
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/intel_wopcm.c
> + :doc: WOPCM Layout
> +
> GuC
> ===
>
> @@ -359,6 +368,12 @@ GuC Firmware Layout
> .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fwif.h
> :doc: GuC Firmware Layout
>
> +GuC Address Space
> +-----------------
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/intel_guc.c
> + :doc: GuC Address Space
> +
> Tracing
> =======
>
> diff --git a/drivers/gpu/drm/i915/intel_guc.c b/drivers/gpu/drm/i915/intel_guc.c
> index 8f93f5b..c5f64c7 100644
> --- a/drivers/gpu/drm/i915/intel_guc.c
> +++ b/drivers/gpu/drm/i915/intel_guc.c
> @@ -494,35 +494,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.
> */
>
> /**
> diff --git a/drivers/gpu/drm/i915/intel_wopcm.c b/drivers/gpu/drm/i915/intel_wopcm.c
> index 4117886..74bf76f 100644
> --- a/drivers/gpu/drm/i915/intel_wopcm.c
> +++ b/drivers/gpu/drm/i915/intel_wopcm.c
> @@ -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
> --
> 2.7.4
>
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams
2018-03-28 11:27 ` [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams Joonas Lahtinen
@ 2018-03-28 12:19 ` Joonas Lahtinen
0 siblings, 0 replies; 5+ messages in thread
From: Joonas Lahtinen @ 2018-03-28 12:19 UTC (permalink / raw)
To: Jackie Li, intel-gfx
Quoting Joonas Lahtinen (2018-03-28 14:27:19)
> Quoting Jackie Li (2018-03-23 01:59:22)
> > 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
> >
> > v4:
> > - Added WOPCM layout and GuC address space docs into i915.rst (Joonas)
> >
> > Signed-off-by: Jackie Li <yaodong.li@intel.com>
> > Cc: Michal Wajdeczko <michal.wajdeczko@intel.com>
> > Cc: Sagar Arun Kamble <sagar.a.kamble@intel.com>
> > Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
>
> Looks good. Thanks for the patch, I'll proceed to merge it.
For future reference, please use a single canonical name in patches (especially
the Signed-off-by: field as it is the most important one:
https://www.kernel.org/doc/html/v4.13/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
). It'll also help when looking at the statistics, too. In this case our
S-o-b checking tool complained that the patch author has not signed off
their work (due to the difference in writing).
Regards, Joonas
>
> Reviewed-by: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
>
> Regards, Joonas
>
> > ---
> > Documentation/gpu/i915.rst | 15 ++++++++++
> > drivers/gpu/drm/i915/intel_guc.c | 56 ++++++++++++++++++++------------------
> > drivers/gpu/drm/i915/intel_wopcm.c | 44 ++++++++++++++++--------------
> > 3 files changed, 67 insertions(+), 48 deletions(-)
> >
> > diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> > index 41dc881..7ecad71 100644
> > --- a/Documentation/gpu/i915.rst
> > +++ b/Documentation/gpu/i915.rst
> > @@ -335,6 +335,15 @@ objects, which has the goal to make space in gpu virtual address spaces.
> > .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_shrinker.c
> > :internal:
> >
> > +WOPCM
> > +=====
> > +
> > +WOPCM Layout
> > +------------
> > +
> > +.. kernel-doc:: drivers/gpu/drm/i915/intel_wopcm.c
> > + :doc: WOPCM Layout
> > +
> > GuC
> > ===
> >
> > @@ -359,6 +368,12 @@ GuC Firmware Layout
> > .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fwif.h
> > :doc: GuC Firmware Layout
> >
> > +GuC Address Space
> > +-----------------
> > +
> > +.. kernel-doc:: drivers/gpu/drm/i915/intel_guc.c
> > + :doc: GuC Address Space
> > +
> > Tracing
> > =======
> >
> > diff --git a/drivers/gpu/drm/i915/intel_guc.c b/drivers/gpu/drm/i915/intel_guc.c
> > index 8f93f5b..c5f64c7 100644
> > --- a/drivers/gpu/drm/i915/intel_guc.c
> > +++ b/drivers/gpu/drm/i915/intel_guc.c
> > @@ -494,35 +494,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.
> > */
> >
> > /**
> > diff --git a/drivers/gpu/drm/i915/intel_wopcm.c b/drivers/gpu/drm/i915/intel_wopcm.c
> > index 4117886..74bf76f 100644
> > --- a/drivers/gpu/drm/i915/intel_wopcm.c
> > +++ b/drivers/gpu/drm/i915/intel_wopcm.c
> > @@ -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
> > --
> > 2.7.4
> >
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2018-03-28 12:19 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-03-22 23:59 [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams Jackie Li
2018-03-23 0:39 ` ✓ Fi.CI.BAT: success for drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams (rev4) Patchwork
2018-03-23 4:50 ` ✓ Fi.CI.IGT: " Patchwork
2018-03-28 11:27 ` [PATCH v4] drm/i915: Use correct reST syntax for WOPCM and GuC kernel-doc diagrams Joonas Lahtinen
2018-03-28 12:19 ` Joonas Lahtinen
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.