summaryrefslogtreecommitdiff
path: root/docs/src/appendix
diff options
context:
space:
mode:
authormergify[bot]2022-06-17 04:34:16 +0000
committerGitHub2022-06-17 04:34:16 +0000
commit01100fa9af0e34b9a4ddb87b8060e6e3178d4272 (patch)
treeaef24ffd54b684b0f55f37113706cefd2f400dae /docs/src/appendix
parentd001b34f816f1f65d0625aebf33e5cfc5ba93e49 (diff)
[docs] Document partial register reset (#2582) (#2583)
(cherry picked from commit d54a37a51b16fb6e46093265d65fd47d5318f67f) Co-authored-by: Jack Koenig <koenig@sifive.com>
Diffstat (limited to 'docs/src/appendix')
-rw-r--r--docs/src/appendix/experimental-features.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/src/appendix/experimental-features.md b/docs/src/appendix/experimental-features.md
index eb91c190..a85704c2 100644
--- a/docs/src/appendix/experimental-features.md
+++ b/docs/src/appendix/experimental-features.md
@@ -10,6 +10,7 @@ Chisel has a number of new features that are worth checking out. This page is a
- [FixedPoint](#fixed-point)
- [Module Variants](#module-variants)
- [Bundle Literals](#bundle-literals)
+- [Vec Literals](#vec-literals)
- [Interval Type](#interval-type)
- [Loading Memories for simulation or FPGA initialization](#loading-memories)
@@ -52,7 +53,10 @@ class Example extends RawModule {
chisel3.stage.ChiselStage.emitVerilog(new Example)
```
-Partial specification is allowed, defaulting any unconnected fields to 0 (regardless of type).
+Partial specification is allowed, which results in "invalidated fields" as
+described in [Unconnected Wires](../explanations/unconnected-wires).
+Note that this can be used with `RegInit` to construct partially reset registers as
+described in the [Cookbook](../cookbooks/cookbook#how-do-i-partially-reset-an-aggregate-reg).
```scala mdoc
class Example2 extends RawModule {
@@ -122,9 +126,10 @@ chisel3.stage.ChiselStage.emitVerilog(new VecExample1a)
```
The following examples all use the explicit form.
-With the explicit form partial specification is allowed.
-When used with as a `Reg` `reset` value, only specified indices of the `Reg`'s `Vec`
-will be reset
+With the explicit form partial specification is allowed, which results in
+"invalidated fields" as described in [Unconnected Wires](../explanations/unconnected-wires).
+Note that this can be used with `RegInit` to construct partially reset registers as
+described in the [Cookbook](../cookbooks/cookbook#how-do-i-partially-reset-an-aggregate-reg).
```scala mdoc
class VecExample2 extends RawModule {