summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdam Izraelevitz2020-08-21 14:40:05 -0700
committerGitHub2020-08-21 21:40:05 +0000
commit52dcf10d59b88b026adab0f5d9f127bfac18b36a (patch)
tree2ba4cf902f6e21bf71e6137f3d600e66e978bb32 /docs
parent7edba2d10f980016462f917c6d21d64585ddfd6b (diff)
Move multi-clock to explanations (#1561)
Diffstat (limited to 'docs')
-rw-r--r--docs/src/explanations/multi-clock.md (renamed from docs/src/wiki-deprecated/multi-clock.md)25
1 files changed, 21 insertions, 4 deletions
diff --git a/docs/src/wiki-deprecated/multi-clock.md b/docs/src/explanations/multi-clock.md
index 528ba8a4..6e9afd5a 100644
--- a/docs/src/wiki-deprecated/multi-clock.md
+++ b/docs/src/explanations/multi-clock.md
@@ -7,7 +7,9 @@ Chisel 3 supports multiple clock domains as follows.
Note that in order to cross clock domains safely, you will need appropriate synchronization logic (such as an asynchronous FIFO). You can use the [AsyncQueue library](https://github.com/ucb-bar/asyncqueue) to do this easily.
-```scala
+```scala mdoc:silent:reset
+import chisel3._
+
class MultiClockModule extends Module {
val io = IO(new Bundle {
val clockB = Input(Clock())
@@ -33,7 +35,14 @@ class MultiClockModule extends Module {
You can also instantiate modules in another clock domain:
-```scala
+```scala mdoc:silent:reset
+import chisel3._
+
+class ChildModule extends Module {
+ val io = IO(new Bundle{
+ val in = Input(Bool())
+ })
+}
class MultiClockModule extends Module {
val io = IO(new Bundle {
val clockB = Input(Clock())
@@ -47,7 +56,9 @@ class MultiClockModule extends Module {
If you only want to connect your clock to a new clock domain and use the regular implicit reset signal, you can use `withClock(clock)` instead of `withClockAndReset`.
-```scala
+```scala mdoc:silent:reset
+import chisel3._
+
class MultiClockModule extends Module {
val io = IO(new Bundle {
val clockB = Input(Clock())
@@ -69,7 +80,7 @@ class MultiClockModule extends Module {
}
// Instantiate module in another clock domain with implicit reset.
-class MultiClockModule extends Module {
+class MultiClockModule2 extends Module {
val io = IO(new Bundle {
val clockB = Input(Clock())
val stuff = Input(Bool())
@@ -78,4 +89,10 @@ class MultiClockModule extends Module {
clockB_child.io.in := io.stuff
}
+class ChildModule extends Module {
+ val io = IO(new Bundle{
+ val in = Input(Bool())
+ })
+}
+
```