summaryrefslogtreecommitdiff
path: root/docs/src/explanations/ports.md
diff options
context:
space:
mode:
authorMegan Wachs2021-03-18 16:47:58 -0700
committerGitHub2021-03-18 16:47:58 -0700
commitf1ad5b58e8a749d558758288d03ce75bf6b8ff9c (patch)
tree2150d6f41a55f81c9f4cf3b037b715cb75ea617f /docs/src/explanations/ports.md
parent2a56c6540e914611ac12647e157aec4c5c595758 (diff)
Reorganize website docs (#1806)
Updates to chisel3 documentation for website: * guard code examples with mdoc and fix errors encountered along the way * move some website content here vs splitting the content across two repos * Bring in the interval-types and loading memories content so that it will be visible from the website * remove all references to the wiki (deprecated) * Remove reference to Wiki from the README * fix tabbing and compile of chisel3-vs-chisel2 section * Appendix: faqs now guarded and compile * FAQs: move to resources section
Diffstat (limited to 'docs/src/explanations/ports.md')
-rw-r--r--docs/src/explanations/ports.md67
1 files changed, 67 insertions, 0 deletions
diff --git a/docs/src/explanations/ports.md b/docs/src/explanations/ports.md
new file mode 100644
index 00000000..ce38cf22
--- /dev/null
+++ b/docs/src/explanations/ports.md
@@ -0,0 +1,67 @@
+---
+layout: docs
+title: "Ports"
+section: "chisel3"
+---
+
+# Ports
+
+Ports are used as interfaces to hardware components. A port is simply
+any `Data` object that has directions assigned to its members.
+
+Chisel provides port constructors to allow a direction to be added
+(input or output) to an object at construction time. Primitive port
+constructors wrap the type of the port in `Input` or `Output`.
+
+An example port declaration is as follows:
+```scala mdoc:invisible
+import chisel3._
+```
+```scala mdoc
+class Decoupled extends Bundle {
+ val ready = Output(Bool())
+ val data = Input(UInt(32.W))
+ val valid = Input(Bool())
+}
+```
+
+After defining ```Decoupled```, it becomes a new type that can be
+used as needed for module interfaces or for named collections of
+wires.
+
+By folding directions into the object declarations, Chisel is able to
+provide powerful wiring constructs described later.
+
+## Inspecting Module ports
+
+(Chisel 3.2+)
+
+Chisel 3.2 introduced `DataMirror.modulePorts` which can be used to inspect the IOs of any Chisel module (this includes modules in both `import chisel3._` and `import Chisel._`, as well as BlackBoxes from each package).
+Here is an example of how to use this API:
+
+```scala mdoc
+import chisel3.experimental.DataMirror
+import chisel3.stage.{ChiselGeneratorAnnotation, ChiselStage}
+
+class Adder extends Module {
+ val a = IO(Input(UInt(8.W)))
+ val b = IO(Input(UInt(8.W)))
+ val c = IO(Output(UInt(8.W)))
+ c := a +& b
+}
+
+class Test extends Module {
+ val adder = Module(new Adder)
+ // for debug only
+ adder.a := DontCare
+ adder.b := DontCare
+
+ // Inspect ports of adder
+ // See the result below.
+ DataMirror.modulePorts(adder).foreach { case (name, port) => {
+ println(s"Found port $name: $port")
+ }}
+}
+
+(new ChiselStage).execute(Array.empty, Seq(ChiselGeneratorAnnotation(() => new Test)))
+``` \ No newline at end of file