From 1eb6ee981267250511f146d92632ae41a7a6dcd4 Mon Sep 17 00:00:00 2001
From: seldridge <seldridge@users.noreply.github.com>
Date: Fri, 10 Jan 2025 23:18:49 +0000
Subject: [PATCH] deploy: ba4e01c3872667faaa37314ccc44aebdb47ef351

---
 404.html                                      |  2 +-
 api.html                                      |  4 +--
 api/chisel3/latest.html                       |  2 +-
 ...d133b.aa1509dc.js => 17dd133b.e4c62b60.js} |  2 +-
 assets/js/1ce89024.2296292d.js                |  1 +
 assets/js/1ce89024.76afd8dc.js                |  1 -
 assets/js/67ffb541.4805b36a.js                |  1 -
 assets/js/67ffb541.51383dc4.js                |  1 +
 ...bfa87.77e370fe.js => 7b5bfa87.1c5fc558.js} |  2 +-
 ...2f0dc.54852e76.js => 7cc2f0dc.97f33e9d.js} |  2 +-
 ...e4a75.b8ae9443.js => 7e1e4a75.51497e19.js} |  2 +-
 assets/js/868241d3.1a857a9d.js                |  1 +
 assets/js/868241d3.2d32cef4.js                |  1 -
 assets/js/916cecd1.90b255c9.js                |  1 -
 assets/js/916cecd1.94aedafa.js                |  1 +
 ...a0ee0.e62af188.js => 98ca0ee0.8b580311.js} |  2 +-
 ...82c73.a31650d1.js => a8f82c73.a44bdfa5.js} |  2 +-
 assets/js/c48de377.33b512d1.js                |  1 +
 assets/js/c48de377.f67a205e.js                |  1 -
 ...66d49.4bc58ceb.js => c7666d49.edd1fd74.js} |  2 +-
 assets/js/cdcdfbab.6031edb9.js                |  1 -
 assets/js/cdcdfbab.953ede6d.js                |  1 +
 assets/js/d1e6e3d8.83eacef3.js                |  1 -
 assets/js/d1e6e3d8.b6d39183.js                |  1 +
 assets/js/d4b6d0e6.de292a95.js                |  1 +
 assets/js/d4b6d0e6.f68aedf5.js                |  1 -
 assets/js/d50fb5c7.3da5f25c.js                |  1 -
 assets/js/d50fb5c7.99b64109.js                |  1 +
 assets/js/f10ce86b.4ffec15d.js                |  1 +
 assets/js/f10ce86b.aefbb291.js                |  1 -
 ...n.ecc71767.js => runtime~main.6f6687cd.js} |  2 +-
 blog.html                                     |  2 +-
 blog/archive.html                             |  2 +-
 blog/authors.html                             |  2 +-
 blog/authors/seldridge.html                   |  2 +-
 blog/restarting-the-blog.html                 |  2 +-
 blog/tags.html                                |  2 +-
 blog/tags/miscellaneous.html                  |  2 +-
 community.html                                |  2 +-
 docs.html                                     |  2 +-
 docs/appendix.html                            |  2 +-
 docs/appendix/experimental-features.html      | 18 +++++-----
 docs/appendix/migrating-from-chiseltest.html  |  2 +-
 docs/appendix/upgrading-from-chisel-3-4.html  |  2 +-
 docs/appendix/upgrading-from-scala-2-11.html  |  2 +-
 docs/appendix/versioning.html                 |  2 +-
 docs/category/getting-started.html            |  2 +-
 docs/cookbooks.html                           |  2 +-
 docs/cookbooks/cookbook.html                  | 18 +++++-----
 docs/cookbooks/dataview.html                  |  6 ++--
 docs/cookbooks/hierarchy.html                 | 12 +++----
 docs/cookbooks/naming.html                    | 10 +++---
 docs/cookbooks/objectmodel.html               |  2 +-
 docs/cookbooks/serialization.html             |  2 +-
 docs/cookbooks/troubleshooting.html           |  2 +-
 docs/developers.html                          |  2 +-
 docs/developers/lit-test.html                 |  2 +-
 docs/developers/scaladoc.html                 |  2 +-
 docs/developers/style.html                    |  2 +-
 docs/developers/test-coverage.html            |  2 +-
 docs/explanations.html                        |  2 +-
 docs/explanations/annotations.html            |  2 +-
 docs/explanations/blackboxes.html             |  2 +-
 docs/explanations/bundles-and-vecs.html       |  4 +--
 docs/explanations/chisel-enum.html            |  4 +--
 .../chisel-type-vs-scala-type.html            |  6 ++--
 docs/explanations/combinational-circuits.html |  2 +-
 docs/explanations/connectable.html            | 34 +++++++++----------
 docs/explanations/connection-operators.html   | 14 ++++----
 docs/explanations/data-types.html             |  2 +-
 docs/explanations/dataview.html               | 14 ++++----
 docs/explanations/decoder.html                |  2 +-
 docs/explanations/functional-abstraction.html |  2 +-
 .../functional-module-creation.html           |  2 +-
 docs/explanations/instchoice.html             |  2 +-
 .../interfaces-and-connections.html           |  2 +-
 docs/explanations/intrinsics.html             |  2 +-
 docs/explanations/layers.html                 |  8 ++---
 docs/explanations/memories.html               |  2 +-
 docs/explanations/moduleprefix.html           |  2 +-
 docs/explanations/modules.html                |  2 +-
 docs/explanations/motivation.html             |  2 +-
 docs/explanations/multi-clock.html            |  2 +-
 .../muxes-and-input-selection.html            |  2 +-
 docs/explanations/naming.html                 | 26 +++++++-------
 docs/explanations/operators.html              |  2 +-
 .../polymorphism-and-parameterization.html    |  4 +--
 docs/explanations/ports.html                  |  2 +-
 docs/explanations/printing.html               |  2 +-
 docs/explanations/properties.html             |  2 +-
 docs/explanations/reset.html                  |  2 +-
 docs/explanations/sequential-circuits.html    |  2 +-
 docs/explanations/source-locators.html        |  2 +-
 docs/explanations/supported-hardware.html     |  2 +-
 docs/explanations/unconnected-wires.html      |  2 +-
 docs/explanations/warnings.html               |  2 +-
 docs/explanations/width-inference.html        |  2 +-
 docs/installation.html                        |  2 +-
 docs/resources.html                           |  2 +-
 docs/resources/faqs.html                      |  4 +--
 generated/contributors.html                   |  2 +-
 generated/scaladoc_links.html                 |  4 +--
 index.html                                    |  2 +-
 search.html                                   |  2 +-
 104 files changed, 172 insertions(+), 172 deletions(-)
 rename assets/js/{17dd133b.aa1509dc.js => 17dd133b.e4c62b60.js} (55%)
 create mode 100644 assets/js/1ce89024.2296292d.js
 delete mode 100644 assets/js/1ce89024.76afd8dc.js
 delete mode 100644 assets/js/67ffb541.4805b36a.js
 create mode 100644 assets/js/67ffb541.51383dc4.js
 rename assets/js/{7b5bfa87.77e370fe.js => 7b5bfa87.1c5fc558.js} (96%)
 rename assets/js/{7cc2f0dc.54852e76.js => 7cc2f0dc.97f33e9d.js} (87%)
 rename assets/js/{7e1e4a75.b8ae9443.js => 7e1e4a75.51497e19.js} (66%)
 create mode 100644 assets/js/868241d3.1a857a9d.js
 delete mode 100644 assets/js/868241d3.2d32cef4.js
 delete mode 100644 assets/js/916cecd1.90b255c9.js
 create mode 100644 assets/js/916cecd1.94aedafa.js
 rename assets/js/{98ca0ee0.e62af188.js => 98ca0ee0.8b580311.js} (95%)
 rename assets/js/{a8f82c73.a31650d1.js => a8f82c73.a44bdfa5.js} (55%)
 create mode 100644 assets/js/c48de377.33b512d1.js
 delete mode 100644 assets/js/c48de377.f67a205e.js
 rename assets/js/{c7666d49.4bc58ceb.js => c7666d49.edd1fd74.js} (60%)
 delete mode 100644 assets/js/cdcdfbab.6031edb9.js
 create mode 100644 assets/js/cdcdfbab.953ede6d.js
 delete mode 100644 assets/js/d1e6e3d8.83eacef3.js
 create mode 100644 assets/js/d1e6e3d8.b6d39183.js
 create mode 100644 assets/js/d4b6d0e6.de292a95.js
 delete mode 100644 assets/js/d4b6d0e6.f68aedf5.js
 delete mode 100644 assets/js/d50fb5c7.3da5f25c.js
 create mode 100644 assets/js/d50fb5c7.99b64109.js
 create mode 100644 assets/js/f10ce86b.4ffec15d.js
 delete mode 100644 assets/js/f10ce86b.aefbb291.js
 rename assets/js/{runtime~main.ecc71767.js => runtime~main.6f6687cd.js} (88%)

diff --git a/404.html b/404.html
index e6debc7c80..d384014675 100644
--- a/404.html
+++ b/404.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/api.html b/api.html
index 390a92d93e..fa0edb3cb5 100644
--- a/api.html
+++ b/api.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -17,7 +17,7 @@
 <p>Please see the page about <a href="/docs/appendix/versioning">Versioning</a> for more information about major and minor versioning and binary compatibility.</p>
 <ul>
 <li><a href="/api/latest/index.html" target="_blank" rel="noopener noreferrer">Latest (6.6.0)</a></li>
-<li><a href="https://s01.oss.sonatype.org/service/local/repositories/snapshots/archive/org/chipsalliance/chisel_2.13/7.0.0-M2+285-e12935ed-SNAPSHOT/chisel_2.13-7.0.0-M2+285-e12935ed-SNAPSHOT-javadoc.jar/!/index.html" target="_blank" rel="noopener noreferrer">Snapshot</a></li>
+<li><a href="https://s01.oss.sonatype.org/service/local/repositories/snapshots/archive/org/chipsalliance/chisel_2.13/7.0.0-M2+286-ba4e01c3-SNAPSHOT/chisel_2.13-7.0.0-M2+286-ba4e01c3-SNAPSHOT-javadoc.jar/!/index.html" target="_blank" rel="noopener noreferrer">Snapshot</a></li>
 <li><a href="https://javadoc.io/doc/org.chipsalliance/chisel_2.13/7.0.0-M2" target="_blank" rel="noopener noreferrer">7.0.0-M2</a></li>
 <li><a href="https://javadoc.io/doc/org.chipsalliance/chisel_2.13/6.6.0" target="_blank" rel="noopener noreferrer">6.6.0</a></li>
 <li><a href="https://javadoc.io/doc/org.chipsalliance/chisel_2.13/5.3.0" target="_blank" rel="noopener noreferrer">5.3.0</a></li>
diff --git a/api/chisel3/latest.html b/api/chisel3/latest.html
index 977f9f8d43..f026e0b568 100644
--- a/api/chisel3/latest.html
+++ b/api/chisel3/latest.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/assets/js/17dd133b.aa1509dc.js b/assets/js/17dd133b.e4c62b60.js
similarity index 55%
rename from assets/js/17dd133b.aa1509dc.js
rename to assets/js/17dd133b.e4c62b60.js
index 103d254ea0..3aeb6c283d 100644
--- a/assets/js/17dd133b.aa1509dc.js
+++ b/assets/js/17dd133b.e4c62b60.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[8316],{9690:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>d});var l=n(4848),o=n(8453);const r={layout:"docs",title:"Frequently Asked Questions",section:"chisel3"},s="Frequently Asked Questions",t={id:"resources/faqs",title:"Frequently Asked Questions",description:"* Where should I start if I want to learn Chisel?",source:"@site/docs/resources/faqs.md",sourceDirName:"resources",slug:"/resources/faqs",permalink:"/docs/resources/faqs",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/resources/faqs.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Frequently Asked Questions",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Chisel Resources",permalink:"/docs/resources"}},a={},d=[{value:"Where should I start if I want to learn Chisel?",id:"where-should-i-start-if-i-want-to-learn-chisel",level:3},{value:"How do I do ... (e.g. like that in Verilog) in Chisel?",id:"how-do-i-do--eg-like-that-in-verilog-in-chisel",level:3},{value:"What versions of the various projects work together?",id:"what-versions-of-the-various-projects-work-together",level:3},{value:"How can I contribute to Chisel?",id:"how-can-i-contribute-to-chisel",level:3},{value:"Why DecoupledIO instead of ReadyValidIO?",id:"why-decoupledio-instead-of-readyvalidio",level:3},{value:"Why do I have to wrap module instantiations in <code>Module(...)</code>?",id:"why-do-i-have-to-wrap-module-instantiations-in-module",level:3},{value:"Why Chisel?",id:"why-chisel",level:3},{value:"Does Chisel support X and Z logic values",id:"does-chisel-support-x-and-z-logic-values",level:3},{value:"Get me Verilog",id:"get-me-verilog",level:3},{value:"Get me FIRRTL",id:"get-me-firrtl",level:3},{value:"Why doesn&#39;t Chisel tell me which wires aren&#39;t connected?",id:"why-doesnt-chisel-tell-me-which-wires-arent-connected",level:3},{value:"What does <code>Reference ... is not fully initialized.</code> mean?",id:"what-does-reference--is-not-fully-initialized-mean",level:3},{value:"Can I specify behavior before and after generated initial blocks?",id:"can-i-specify-behavior-before-and-after-generated-initial-blocks",level:3}];function c(e){const i={a:"a",code:"code",em:"em",h1:"h1",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(i.header,{children:(0,l.jsx)(i.h1,{id:"frequently-asked-questions",children:"Frequently Asked Questions"})}),"\n",(0,l.jsxs)(i.ul,{children:["\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#where-should-i-start-if-i-want-to-learn-chisel",children:"Where should I start if I want to learn Chisel?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#how-do-i-do--eg-like-that-in-verilog-in-chisel",children:"How do I ... in Chisel?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#what-versions-of-the-various-projects-work-together",children:"What versions of the various projects work together?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#how-can-i-contribute-to-chisel",children:"How can I contribute to Chisel?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#why-decoupledio-instead-of-readyvalidio",children:"Why DecoupledIO instead of ReadyValidIO?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsxs)(i.a,{href:"#why-do-i-have-to-wrap-module-instantiations-in-module",children:["Why do I have to wrap module instantiations in ",(0,l.jsx)(i.code,{children:"Module(...)"}),"?"]})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#why-chisel",children:"Why Chisel?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#does-chisel-support-x-and-z-logic-values",children:"Does Chisel support X and Z logic values?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#get-me-verilog",children:"I just want some Verilog; what do I do?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#get-me-firrtl",children:"I just want some FIRRTL; what do I do?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#why-doesnt-chisel-tell-me-which-wires-arent-connected",children:"Why doesn't Chisel tell me which wires aren't connected?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsxs)(i.a,{href:"#what-does-reference--is-not-fully-initialized-mean",children:["What does ",(0,l.jsx)(i.code,{children:"Reference ... is not fully initialized."})," mean?"]})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#can-i-specify-behavior-before-and-after-generated-initial-blocks",children:"Can I specify behavior before and after generated initial blocks?"})}),"\n"]}),"\n",(0,l.jsx)(i.h3,{id:"where-should-i-start-if-i-want-to-learn-chisel",children:"Where should I start if I want to learn Chisel?"}),"\n",(0,l.jsxs)(i.p,{children:["We recommend the ",(0,l.jsx)(i.a,{href:"https://github.com/freechipsproject/chisel-bootcamp",children:"Chisel Bootcamp"})," for getting started with Chisel."]}),"\n",(0,l.jsx)(i.h3,{id:"how-do-i-do--eg-like-that-in-verilog-in-chisel",children:"How do I do ... (e.g. like that in Verilog) in Chisel?"}),"\n",(0,l.jsxs)(i.p,{children:["See the ",(0,l.jsx)(i.a,{href:"../cookbooks/cookbook",children:"cookbooks"}),"."]}),"\n",(0,l.jsx)(i.h3,{id:"what-versions-of-the-various-projects-work-together",children:"What versions of the various projects work together?"}),"\n",(0,l.jsxs)(i.p,{children:["See ",(0,l.jsx)(i.a,{href:"../appendix/versioning",children:"Chisel Project Versioning"}),"."]}),"\n",(0,l.jsx)(i.h3,{id:"how-can-i-contribute-to-chisel",children:"How can I contribute to Chisel?"}),"\n",(0,l.jsxs)(i.p,{children:["Check out the ",(0,l.jsx)(i.a,{href:"https://github.com/chipsalliance/chisel3#contributor-documentation",children:"Contributor Documentation"})," in the chisel3 repository."]}),"\n",(0,l.jsx)(i.h3,{id:"why-decoupledio-instead-of-readyvalidio",children:"Why DecoupledIO instead of ReadyValidIO?"}),"\n",(0,l.jsx)(i.p,{children:"There are multiple kinds of Ready/Valid interfaces that impose varying restrictions on the producers and consumers. Chisel currently provides the following:"}),"\n",(0,l.jsxs)(i.ul,{children:["\n",(0,l.jsxs)(i.li,{children:[(0,l.jsx)(i.a,{href:"https://chisel.eecs.berkeley.edu/api/index.html#chisel3.util.DecoupledIO",children:"DecoupledIO"})," - No guarantees"]}),"\n",(0,l.jsxs)(i.li,{children:[(0,l.jsx)(i.a,{href:"https://chisel.eecs.berkeley.edu/api/index.html#chisel3.util.IrrevocableIO",children:"IrrevocableIO"})," - Producer promises to not change the value of 'bits' after a cycle where 'valid' is high and 'ready' is low. Additionally, once 'valid' is raised it will never be lowered until after 'ready' has also been raised."]}),"\n"]}),"\n",(0,l.jsxs)(i.h3,{id:"why-do-i-have-to-wrap-module-instantiations-in-module",children:["Why do I have to wrap module instantiations in ",(0,l.jsx)(i.code,{children:"Module(...)"}),"?"]}),"\n",(0,l.jsx)(i.p,{children:"In short: Limitations of Scala"}),"\n",(0,l.jsxs)(i.p,{children:["Chisel Modules are written by defining a ",(0,l.jsx)(i.a,{href:"http://docs.scala-lang.org/tutorials/tour/classes.html",children:"Scala class"})," and implementing its constructor. As elaboration runs, Chisel constructs a hardware AST from these Modules. The compiler needs hooks to run before and after the actual construction of the Module object. In Scala, superclasses are fully initialized before subclasses, so by extending Module, Chisel has the ability to run some initialization code before the user's Module is constructed. However, there is no such hook to run after the Module object is initialized. By wrapping Module instantiations in the Module object's apply method (ie. ",(0,l.jsx)(i.code,{children:"Module(...)"}),"), Chisel is able to perform post-initialization actions. There is a ",(0,l.jsx)(i.a,{href:"https://issues.scala-lang.org/browse/SI-4330",children:"proposed solution"}),", so eventually this requirement will be lifted, but for now, wrap those Modules!"]}),"\n",(0,l.jsx)(i.h3,{id:"why-chisel",children:"Why Chisel?"}),"\n",(0,l.jsxs)(i.p,{children:["Please see ",(0,l.jsx)(i.a,{href:"../explanations/motivation",children:"Chisel Motivation"})]}),"\n",(0,l.jsx)(i.h3,{id:"does-chisel-support-x-and-z-logic-values",children:"Does Chisel support X and Z logic values"}),"\n",(0,l.jsxs)(i.p,{children:["Chisel does not directly support Verilog logic values ",(0,l.jsx)(i.code,{children:"x"})," ",(0,l.jsx)(i.em,{children:"unknown"})," and ",(0,l.jsx)(i.code,{children:"z"})," ",(0,l.jsx)(i.em,{children:"high-impedance"}),".  There are a number of reasons to want to avoid these values.  See:",(0,l.jsx)(i.a,{href:"http://infocenter.arm.com/help/topic/com.arm.doc.arp0009a/Verilog_X_Bugs.pdf",children:"The Dangers of Living With An X"})," and ",(0,l.jsx)(i.a,{href:"http://ieeexplore.ieee.org/document/7827620/",children:"Malicious LUT: A stealthy FPGA Trojan injected and triggered by the design flow"}),".  Chisel has its own eco-system of unit and functional testers that limit the need for ",(0,l.jsx)(i.code,{children:"x"})," and ",(0,l.jsx)(i.code,{children:"z"})," and their omission simplify language implementation, design, and testing.  The circuits created by chisel do not preclude developers from using ",(0,l.jsx)(i.code,{children:"x"})," and ",(0,l.jsx)(i.code,{children:"z"})," in downstream toolchains as they see fit."]}),"\n",(0,l.jsx)(i.h3,{id:"get-me-verilog",children:"Get me Verilog"}),"\n",(0,l.jsx)(i.p,{children:"I wrote a module and I want to see the Verilog; what do I do?"}),"\n",(0,l.jsx)(i.p,{children:"Here's a simple hello world module in a file HelloWorld.scala."}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"package intro\n"})}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:'import chisel3._\nclass HelloWorld extends Module {\n  val io = IO(new Bundle{})\n  printf("hello world\\n")\n}\n'})}),"\n",(0,l.jsx)(i.p,{children:"Add the following"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"import circt.stage.ChiselStage\nobject VerilogMain extends App {\n  ChiselStage.emitSystemVerilog(new HelloWorld)\n}\n"})}),"\n",(0,l.jsx)(i.p,{children:"Now you can get some Verilog. Start sbt:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"bash> sbt\n> run-main intro.VerilogMain\n[info] Running intro.VerilogMain\n[info] [0.004] Elaborating design...\n[info] [0.100] Done elaborating.\n[success] Total time: 1 s, completed Jan 12, 2017 6:24:03 PM\n"})}),"\n",(0,l.jsx)(i.p,{children:"or as a one-liner:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"bash> sbt 'runMain intro.VerilogMain'\n"})}),"\n",(0,l.jsx)(i.p,{children:"After either of the above there will be a HelloWorld.v file in the current directory:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-verilog",children:'// Generated by CIRCT firtool-1.99.2\nmodule HelloWorld(\t// faqs.md:11:7\n  input clock,\t// faqs.md:11:7\n        reset\t// faqs.md:11:7\n);\n\nendmodule\n\n\n// ----- 8< ----- FILE "verification/cover/layers-HelloWorld-Verification-Cover.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n`include "verification/layers-HelloWorld-Verification.sv"\n`ifndef layers_HelloWorld_Verification_Cover\n`define layers_HelloWorld_Verification_Cover\t// <stdin>:6:5\n`endif // layers_HelloWorld_Verification_Cover\t// <stdin>:6:5\n\n// ----- 8< ----- FILE "verification/assume/layers-HelloWorld-Verification-Assume.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n`include "verification/layers-HelloWorld-Verification.sv"\n`ifndef layers_HelloWorld_Verification_Assume\n`define layers_HelloWorld_Verification_Assume\t// <stdin>:5:5\n`endif // layers_HelloWorld_Verification_Assume\t// <stdin>:5:5\n\n// ----- 8< ----- FILE "verification/assert/layers-HelloWorld-Verification-Assert.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n`include "verification/layers-HelloWorld-Verification.sv"\n`ifndef layers_HelloWorld_Verification_Assert\n`define layers_HelloWorld_Verification_Assert\t// <stdin>:4:5\n`endif // layers_HelloWorld_Verification_Assert\t// <stdin>:4:5\n\n// ----- 8< ----- FILE "verification/layers-HelloWorld-Verification.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n`ifndef layers_HelloWorld_Verification\n`define layers_HelloWorld_Verification\t// <stdin>:3:3\nbind HelloWorld HelloWorld_Verification verification (\n  .reset (reset),\n  .clock (clock)\n);\n`endif // layers_HelloWorld_Verification\t// <stdin>:3:3\n\n// ----- 8< ----- FILE "verification/HelloWorld_Verification.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n\n// Users can define \'PRINTF_COND\' to add an extra gate to prints.\n`ifndef PRINTF_COND_\n  `ifdef PRINTF_COND\n    `define PRINTF_COND_ (`PRINTF_COND)\n  `else  // PRINTF_COND\n    `define PRINTF_COND_ 1\n  `endif // PRINTF_COND\n`endif // not def PRINTF_COND_\nmodule HelloWorld_Verification(\t// faqs.md:13:9\n  input reset,\t// faqs.md:13:9\n        clock\t// faqs.md:13:9\n);\n\n  `ifndef SYNTHESIS\t// faqs.md:13:9\n    always @(posedge clock) begin\t// faqs.md:13:9\n      if ((`PRINTF_COND_) & ~reset)\t// faqs.md:13:9\n        $fwrite(32\'h80000002, "hello world\\n");\t// faqs.md:13:9\n    end // always @(posedge)\n  `endif // not def SYNTHESIS\nendmodule\n\n\n'})}),"\n",(0,l.jsx)(i.p,{children:"You can see additional options with"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"bash> sbt 'runMain intro.HelloWorld --help'\n"})}),"\n",(0,l.jsx)(i.p,{children:"This will return a comprehensive usage line with available options."}),"\n",(0,l.jsx)(i.p,{children:"For example to place the output in a directory name buildstuff use"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"bash> sbt 'runMain intro.HelloWorld --target-dir buildstuff --top-name HelloWorld'\n"})}),"\n",(0,l.jsx)(i.p,{children:"Alternatively, you can also use the sbt console to invoke the Verilog driver:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:'$ sbt\n> console\n[info] Starting scala interpreter...\nWelcome to Scala 2.12.13 (OpenJDK 64-Bit Server VM, Java 1.8.0_275).\nType in expressions for evaluation. Or try :help.\n\nscala> (new circt.stage.ChiselStage).emitSystemVerilog(new HelloWorld())\nchisel3.Driver.execute(Array[String](), () => new HelloWorld)\nElaborating design...\nDone elaborating.\nres1: String =\n"module HelloWorld(\n  input   clock,\n  input   reset\n);\n...\n'})}),"\n",(0,l.jsx)(i.p,{children:"As before, there should be a HelloWorld.v file in the current directory."}),"\n",(0,l.jsxs)(i.p,{children:["Note: Using the following, without the ",(0,l.jsx)(i.code,{children:"new"}),",\nwill ONLY return the string representation, and will not emit a ",(0,l.jsx)(i.code,{children:".v"})," file:"]}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"ChiselStage.emitSystemVerilog(new HelloWorld())\n"})}),"\n",(0,l.jsx)(i.h3,{id:"get-me-firrtl",children:"Get me FIRRTL"}),"\n",(0,l.jsx)(i.p,{children:"If for some reason you don't want the Verilog (e.g. maybe you want to run some custom transformations before exporting to Verilog), then use something along these lines:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"package intro\n"})}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"\nimport chisel3._\nimport circt.stage.ChiselStage\n\nclass MyFirrtlModule extends Module {\n  val io = IO(new Bundle{})\n}\n\nobject FirrtlMain extends App {\n  ChiselStage.emitCHIRRTL(new MyFirrtlModule)\n}\n"})}),"\n",(0,l.jsx)(i.p,{children:"Run it with:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"sbt 'runMain intro.FirrtlMain'\n"})}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:'FIRRTL version 4.2.0\ncircuit MyFirrtlModule :\n  layer Verification, bind, "verification" :\n    layer Assert, bind, "verification/assert" :\n    layer Assume, bind, "verification/assume" :\n    layer Cover, bind, "verification/cover" :\n  public module MyFirrtlModule : @[faqs.md 64:7]\n    input clock : Clock @[faqs.md 64:7]\n    input reset : UInt<1> @[faqs.md 64:7]\n    output io : { } @[faqs.md 65:14]\n\n    skip\n\n\n'})}),"\n",(0,l.jsx)(i.p,{children:"Alternatively, you can also use the sbt console to invoke the FIRRTL driver directly (replace MyFirrtlModule with your module name):"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"$ sbt\n> console\n[info] Starting scala interpreter...\nWelcome to Scala 2.12.13 (OpenJDK 64-Bit Server VM, Java 1.8.0_275).\nType in expressions for evaluation. Or try :help.\n\nscala> circt.stage.ChiselStage.emitCHIRRTL(new MyFirrtlModule)\nElaborating design...\nDone elaborating.\nres3: String = ...\n"})}),"\n",(0,l.jsx)(i.h3,{id:"why-doesnt-chisel-tell-me-which-wires-arent-connected",children:"Why doesn't Chisel tell me which wires aren't connected?"}),"\n",(0,l.jsxs)(i.p,{children:["As long as your code uses ",(0,l.jsx)(i.code,{children:"import chisel3._"})," (and not ",(0,l.jsx)(i.code,{children:"import Chisel._"}),"), it does!\nSee ",(0,l.jsx)(i.a,{href:"../explanations/unconnected-wires",children:"Unconnected Wires"})," for details."]}),"\n",(0,l.jsxs)(i.h3,{id:"what-does-reference--is-not-fully-initialized-mean",children:["What does ",(0,l.jsx)(i.code,{children:"Reference ... is not fully initialized."})," mean?"]}),"\n",(0,l.jsx)(i.p,{children:"It means that you have unconnected wires in your design which could be an indication of a design bug."}),"\n",(0,l.jsxs)(i.p,{children:["In Chisel2 compatibility mode (",(0,l.jsx)(i.code,{children:"NotStrict"})," compile options), chisel generates firrtl code that disables firrtl's initialized wire checks.\nIn pure chisel3 (",(0,l.jsx)(i.code,{children:"Strict"})," compile options), the generated firrtl code does not contain these disablers (",(0,l.jsx)(i.code,{children:"is invalid"}),").\nOutput wires that are not driven (not connected) are reported by firrtl as ",(0,l.jsx)(i.code,{children:"not fully initialized"}),".\nRead more at ",(0,l.jsx)(i.a,{href:"../explanations/unconnected-wires",children:"Unconnected Wires"})," for details on solving the problem."]}),"\n",(0,l.jsx)(i.h3,{id:"can-i-specify-behavior-before-and-after-generated-initial-blocks",children:"Can I specify behavior before and after generated initial blocks?"}),"\n",(0,l.jsx)(i.p,{children:"Users may define the following macros if they wish to specify behavior before or after emitted initial blocks."}),"\n",(0,l.jsxs)(i.ul,{children:["\n",(0,l.jsxs)(i.li,{children:[(0,l.jsx)(i.code,{children:"BEFORE_INITIAL"}),", which is called before the emitted (non-empty) initial block if it is defined"]}),"\n",(0,l.jsxs)(i.li,{children:[(0,l.jsx)(i.code,{children:"AFTER_INITIAL"}),", which is called after the emitted (non-empty) initial block if it is defined"]}),"\n"]}),"\n",(0,l.jsx)(i.p,{children:"These macros may be useful for turning coverage on and off."})]})}function h(e={}){const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,l.jsx)(i,{...e,children:(0,l.jsx)(c,{...e})}):c(e)}},8453:(e,i,n)=>{n.d(i,{R:()=>s,x:()=>t});var l=n(6540);const o={},r=l.createContext(o);function s(e){const i=l.useContext(r);return l.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function t(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),l.createElement(r.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[8316],{9690:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>d});var l=n(4848),o=n(8453);const r={layout:"docs",title:"Frequently Asked Questions",section:"chisel3"},s="Frequently Asked Questions",t={id:"resources/faqs",title:"Frequently Asked Questions",description:"* Where should I start if I want to learn Chisel?",source:"@site/docs/resources/faqs.md",sourceDirName:"resources",slug:"/resources/faqs",permalink:"/docs/resources/faqs",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/resources/faqs.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Frequently Asked Questions",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Chisel Resources",permalink:"/docs/resources"}},a={},d=[{value:"Where should I start if I want to learn Chisel?",id:"where-should-i-start-if-i-want-to-learn-chisel",level:3},{value:"How do I do ... (e.g. like that in Verilog) in Chisel?",id:"how-do-i-do--eg-like-that-in-verilog-in-chisel",level:3},{value:"What versions of the various projects work together?",id:"what-versions-of-the-various-projects-work-together",level:3},{value:"How can I contribute to Chisel?",id:"how-can-i-contribute-to-chisel",level:3},{value:"Why DecoupledIO instead of ReadyValidIO?",id:"why-decoupledio-instead-of-readyvalidio",level:3},{value:"Why do I have to wrap module instantiations in <code>Module(...)</code>?",id:"why-do-i-have-to-wrap-module-instantiations-in-module",level:3},{value:"Why Chisel?",id:"why-chisel",level:3},{value:"Does Chisel support X and Z logic values",id:"does-chisel-support-x-and-z-logic-values",level:3},{value:"Get me Verilog",id:"get-me-verilog",level:3},{value:"Get me FIRRTL",id:"get-me-firrtl",level:3},{value:"Why doesn&#39;t Chisel tell me which wires aren&#39;t connected?",id:"why-doesnt-chisel-tell-me-which-wires-arent-connected",level:3},{value:"What does <code>Reference ... is not fully initialized.</code> mean?",id:"what-does-reference--is-not-fully-initialized-mean",level:3},{value:"Can I specify behavior before and after generated initial blocks?",id:"can-i-specify-behavior-before-and-after-generated-initial-blocks",level:3}];function c(e){const i={a:"a",code:"code",em:"em",h1:"h1",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(i.header,{children:(0,l.jsx)(i.h1,{id:"frequently-asked-questions",children:"Frequently Asked Questions"})}),"\n",(0,l.jsxs)(i.ul,{children:["\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#where-should-i-start-if-i-want-to-learn-chisel",children:"Where should I start if I want to learn Chisel?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#how-do-i-do--eg-like-that-in-verilog-in-chisel",children:"How do I ... in Chisel?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#what-versions-of-the-various-projects-work-together",children:"What versions of the various projects work together?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#how-can-i-contribute-to-chisel",children:"How can I contribute to Chisel?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#why-decoupledio-instead-of-readyvalidio",children:"Why DecoupledIO instead of ReadyValidIO?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsxs)(i.a,{href:"#why-do-i-have-to-wrap-module-instantiations-in-module",children:["Why do I have to wrap module instantiations in ",(0,l.jsx)(i.code,{children:"Module(...)"}),"?"]})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#why-chisel",children:"Why Chisel?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#does-chisel-support-x-and-z-logic-values",children:"Does Chisel support X and Z logic values?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#get-me-verilog",children:"I just want some Verilog; what do I do?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#get-me-firrtl",children:"I just want some FIRRTL; what do I do?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#why-doesnt-chisel-tell-me-which-wires-arent-connected",children:"Why doesn't Chisel tell me which wires aren't connected?"})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsxs)(i.a,{href:"#what-does-reference--is-not-fully-initialized-mean",children:["What does ",(0,l.jsx)(i.code,{children:"Reference ... is not fully initialized."})," mean?"]})}),"\n",(0,l.jsx)(i.li,{children:(0,l.jsx)(i.a,{href:"#can-i-specify-behavior-before-and-after-generated-initial-blocks",children:"Can I specify behavior before and after generated initial blocks?"})}),"\n"]}),"\n",(0,l.jsx)(i.h3,{id:"where-should-i-start-if-i-want-to-learn-chisel",children:"Where should I start if I want to learn Chisel?"}),"\n",(0,l.jsxs)(i.p,{children:["We recommend the ",(0,l.jsx)(i.a,{href:"https://github.com/freechipsproject/chisel-bootcamp",children:"Chisel Bootcamp"})," for getting started with Chisel."]}),"\n",(0,l.jsx)(i.h3,{id:"how-do-i-do--eg-like-that-in-verilog-in-chisel",children:"How do I do ... (e.g. like that in Verilog) in Chisel?"}),"\n",(0,l.jsxs)(i.p,{children:["See the ",(0,l.jsx)(i.a,{href:"../cookbooks/cookbook",children:"cookbooks"}),"."]}),"\n",(0,l.jsx)(i.h3,{id:"what-versions-of-the-various-projects-work-together",children:"What versions of the various projects work together?"}),"\n",(0,l.jsxs)(i.p,{children:["See ",(0,l.jsx)(i.a,{href:"../appendix/versioning",children:"Chisel Project Versioning"}),"."]}),"\n",(0,l.jsx)(i.h3,{id:"how-can-i-contribute-to-chisel",children:"How can I contribute to Chisel?"}),"\n",(0,l.jsxs)(i.p,{children:["Check out the ",(0,l.jsx)(i.a,{href:"https://github.com/chipsalliance/chisel3#contributor-documentation",children:"Contributor Documentation"})," in the chisel3 repository."]}),"\n",(0,l.jsx)(i.h3,{id:"why-decoupledio-instead-of-readyvalidio",children:"Why DecoupledIO instead of ReadyValidIO?"}),"\n",(0,l.jsx)(i.p,{children:"There are multiple kinds of Ready/Valid interfaces that impose varying restrictions on the producers and consumers. Chisel currently provides the following:"}),"\n",(0,l.jsxs)(i.ul,{children:["\n",(0,l.jsxs)(i.li,{children:[(0,l.jsx)(i.a,{href:"https://chisel.eecs.berkeley.edu/api/index.html#chisel3.util.DecoupledIO",children:"DecoupledIO"})," - No guarantees"]}),"\n",(0,l.jsxs)(i.li,{children:[(0,l.jsx)(i.a,{href:"https://chisel.eecs.berkeley.edu/api/index.html#chisel3.util.IrrevocableIO",children:"IrrevocableIO"})," - Producer promises to not change the value of 'bits' after a cycle where 'valid' is high and 'ready' is low. Additionally, once 'valid' is raised it will never be lowered until after 'ready' has also been raised."]}),"\n"]}),"\n",(0,l.jsxs)(i.h3,{id:"why-do-i-have-to-wrap-module-instantiations-in-module",children:["Why do I have to wrap module instantiations in ",(0,l.jsx)(i.code,{children:"Module(...)"}),"?"]}),"\n",(0,l.jsx)(i.p,{children:"In short: Limitations of Scala"}),"\n",(0,l.jsxs)(i.p,{children:["Chisel Modules are written by defining a ",(0,l.jsx)(i.a,{href:"http://docs.scala-lang.org/tutorials/tour/classes.html",children:"Scala class"})," and implementing its constructor. As elaboration runs, Chisel constructs a hardware AST from these Modules. The compiler needs hooks to run before and after the actual construction of the Module object. In Scala, superclasses are fully initialized before subclasses, so by extending Module, Chisel has the ability to run some initialization code before the user's Module is constructed. However, there is no such hook to run after the Module object is initialized. By wrapping Module instantiations in the Module object's apply method (ie. ",(0,l.jsx)(i.code,{children:"Module(...)"}),"), Chisel is able to perform post-initialization actions. There is a ",(0,l.jsx)(i.a,{href:"https://issues.scala-lang.org/browse/SI-4330",children:"proposed solution"}),", so eventually this requirement will be lifted, but for now, wrap those Modules!"]}),"\n",(0,l.jsx)(i.h3,{id:"why-chisel",children:"Why Chisel?"}),"\n",(0,l.jsxs)(i.p,{children:["Please see ",(0,l.jsx)(i.a,{href:"../explanations/motivation",children:"Chisel Motivation"})]}),"\n",(0,l.jsx)(i.h3,{id:"does-chisel-support-x-and-z-logic-values",children:"Does Chisel support X and Z logic values"}),"\n",(0,l.jsxs)(i.p,{children:["Chisel does not directly support Verilog logic values ",(0,l.jsx)(i.code,{children:"x"})," ",(0,l.jsx)(i.em,{children:"unknown"})," and ",(0,l.jsx)(i.code,{children:"z"})," ",(0,l.jsx)(i.em,{children:"high-impedance"}),".  There are a number of reasons to want to avoid these values.  See:",(0,l.jsx)(i.a,{href:"http://infocenter.arm.com/help/topic/com.arm.doc.arp0009a/Verilog_X_Bugs.pdf",children:"The Dangers of Living With An X"})," and ",(0,l.jsx)(i.a,{href:"http://ieeexplore.ieee.org/document/7827620/",children:"Malicious LUT: A stealthy FPGA Trojan injected and triggered by the design flow"}),".  Chisel has its own eco-system of unit and functional testers that limit the need for ",(0,l.jsx)(i.code,{children:"x"})," and ",(0,l.jsx)(i.code,{children:"z"})," and their omission simplify language implementation, design, and testing.  The circuits created by chisel do not preclude developers from using ",(0,l.jsx)(i.code,{children:"x"})," and ",(0,l.jsx)(i.code,{children:"z"})," in downstream toolchains as they see fit."]}),"\n",(0,l.jsx)(i.h3,{id:"get-me-verilog",children:"Get me Verilog"}),"\n",(0,l.jsx)(i.p,{children:"I wrote a module and I want to see the Verilog; what do I do?"}),"\n",(0,l.jsx)(i.p,{children:"Here's a simple hello world module in a file HelloWorld.scala."}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"package intro\n"})}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:'import chisel3._\nclass HelloWorld extends Module {\n  val io = IO(new Bundle{})\n  printf("hello world\\n")\n}\n'})}),"\n",(0,l.jsx)(i.p,{children:"Add the following"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"import circt.stage.ChiselStage\nobject VerilogMain extends App {\n  ChiselStage.emitSystemVerilog(new HelloWorld)\n}\n"})}),"\n",(0,l.jsx)(i.p,{children:"Now you can get some Verilog. Start sbt:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"bash> sbt\n> run-main intro.VerilogMain\n[info] Running intro.VerilogMain\n[info] [0.004] Elaborating design...\n[info] [0.100] Done elaborating.\n[success] Total time: 1 s, completed Jan 12, 2017 6:24:03 PM\n"})}),"\n",(0,l.jsx)(i.p,{children:"or as a one-liner:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"bash> sbt 'runMain intro.VerilogMain'\n"})}),"\n",(0,l.jsx)(i.p,{children:"After either of the above there will be a HelloWorld.v file in the current directory:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-verilog",children:'// Generated by CIRCT firtool-1.100.0\nmodule HelloWorld(\t// faqs.md:11:7\n  input clock,\t// faqs.md:11:7\n        reset\t// faqs.md:11:7\n);\n\nendmodule\n\n\n// ----- 8< ----- FILE "verification/cover/layers-HelloWorld-Verification-Cover.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n`include "verification/layers-HelloWorld-Verification.sv"\n`ifndef layers_HelloWorld_Verification_Cover\n`define layers_HelloWorld_Verification_Cover\t// <stdin>:6:5\n`endif // layers_HelloWorld_Verification_Cover\t// <stdin>:6:5\n\n// ----- 8< ----- FILE "verification/assume/layers-HelloWorld-Verification-Assume.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n`include "verification/layers-HelloWorld-Verification.sv"\n`ifndef layers_HelloWorld_Verification_Assume\n`define layers_HelloWorld_Verification_Assume\t// <stdin>:5:5\n`endif // layers_HelloWorld_Verification_Assume\t// <stdin>:5:5\n\n// ----- 8< ----- FILE "verification/assert/layers-HelloWorld-Verification-Assert.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n`include "verification/layers-HelloWorld-Verification.sv"\n`ifndef layers_HelloWorld_Verification_Assert\n`define layers_HelloWorld_Verification_Assert\t// <stdin>:4:5\n`endif // layers_HelloWorld_Verification_Assert\t// <stdin>:4:5\n\n// ----- 8< ----- FILE "verification/layers-HelloWorld-Verification.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n`ifndef layers_HelloWorld_Verification\n`define layers_HelloWorld_Verification\t// <stdin>:3:3\nbind HelloWorld HelloWorld_Verification verification (\n  .reset (reset),\n  .clock (clock)\n);\n`endif // layers_HelloWorld_Verification\t// <stdin>:3:3\n\n// ----- 8< ----- FILE "verification/HelloWorld_Verification.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n\n// Users can define \'PRINTF_FD\' to add a specified fd to prints.\n`ifndef PRINTF_FD_\n  `ifdef PRINTF_FD\n    `define PRINTF_FD_ (`PRINTF_FD)\n  `else  // PRINTF_FD\n    `define PRINTF_FD_ 32\'h80000002\n  `endif // PRINTF_FD\n`endif // not def PRINTF_FD_\n\n// Users can define \'PRINTF_COND\' to add an extra gate to prints.\n`ifndef PRINTF_COND_\n  `ifdef PRINTF_COND\n    `define PRINTF_COND_ (`PRINTF_COND)\n  `else  // PRINTF_COND\n    `define PRINTF_COND_ 1\n  `endif // PRINTF_COND\n`endif // not def PRINTF_COND_\nmodule HelloWorld_Verification(\t// faqs.md:13:9\n  input reset,\t// faqs.md:13:9\n        clock\t// faqs.md:13:9\n);\n\n  `ifndef SYNTHESIS\t// faqs.md:13:9\n    always @(posedge clock) begin\t// faqs.md:13:9\n      if ((`PRINTF_COND_) & ~reset)\t// faqs.md:13:9\n        $fwrite(`PRINTF_FD_, "hello world\\n");\t// faqs.md:13:9\n    end // always @(posedge)\n  `endif // not def SYNTHESIS\nendmodule\n\n\n'})}),"\n",(0,l.jsx)(i.p,{children:"You can see additional options with"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"bash> sbt 'runMain intro.HelloWorld --help'\n"})}),"\n",(0,l.jsx)(i.p,{children:"This will return a comprehensive usage line with available options."}),"\n",(0,l.jsx)(i.p,{children:"For example to place the output in a directory name buildstuff use"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"bash> sbt 'runMain intro.HelloWorld --target-dir buildstuff --top-name HelloWorld'\n"})}),"\n",(0,l.jsx)(i.p,{children:"Alternatively, you can also use the sbt console to invoke the Verilog driver:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:'$ sbt\n> console\n[info] Starting scala interpreter...\nWelcome to Scala 2.12.13 (OpenJDK 64-Bit Server VM, Java 1.8.0_275).\nType in expressions for evaluation. Or try :help.\n\nscala> (new circt.stage.ChiselStage).emitSystemVerilog(new HelloWorld())\nchisel3.Driver.execute(Array[String](), () => new HelloWorld)\nElaborating design...\nDone elaborating.\nres1: String =\n"module HelloWorld(\n  input   clock,\n  input   reset\n);\n...\n'})}),"\n",(0,l.jsx)(i.p,{children:"As before, there should be a HelloWorld.v file in the current directory."}),"\n",(0,l.jsxs)(i.p,{children:["Note: Using the following, without the ",(0,l.jsx)(i.code,{children:"new"}),",\nwill ONLY return the string representation, and will not emit a ",(0,l.jsx)(i.code,{children:".v"})," file:"]}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"ChiselStage.emitSystemVerilog(new HelloWorld())\n"})}),"\n",(0,l.jsx)(i.h3,{id:"get-me-firrtl",children:"Get me FIRRTL"}),"\n",(0,l.jsx)(i.p,{children:"If for some reason you don't want the Verilog (e.g. maybe you want to run some custom transformations before exporting to Verilog), then use something along these lines:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"package intro\n"})}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{className:"language-scala",children:"\nimport chisel3._\nimport circt.stage.ChiselStage\n\nclass MyFirrtlModule extends Module {\n  val io = IO(new Bundle{})\n}\n\nobject FirrtlMain extends App {\n  ChiselStage.emitCHIRRTL(new MyFirrtlModule)\n}\n"})}),"\n",(0,l.jsx)(i.p,{children:"Run it with:"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"sbt 'runMain intro.FirrtlMain'\n"})}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:'FIRRTL version 4.2.0\ncircuit MyFirrtlModule :\n  layer Verification, bind, "verification" :\n    layer Assert, bind, "verification/assert" :\n    layer Assume, bind, "verification/assume" :\n    layer Cover, bind, "verification/cover" :\n  public module MyFirrtlModule : @[faqs.md 64:7]\n    input clock : Clock @[faqs.md 64:7]\n    input reset : UInt<1> @[faqs.md 64:7]\n    output io : { } @[faqs.md 65:14]\n\n    skip\n\n\n'})}),"\n",(0,l.jsx)(i.p,{children:"Alternatively, you can also use the sbt console to invoke the FIRRTL driver directly (replace MyFirrtlModule with your module name):"}),"\n",(0,l.jsx)(i.pre,{children:(0,l.jsx)(i.code,{children:"$ sbt\n> console\n[info] Starting scala interpreter...\nWelcome to Scala 2.12.13 (OpenJDK 64-Bit Server VM, Java 1.8.0_275).\nType in expressions for evaluation. Or try :help.\n\nscala> circt.stage.ChiselStage.emitCHIRRTL(new MyFirrtlModule)\nElaborating design...\nDone elaborating.\nres3: String = ...\n"})}),"\n",(0,l.jsx)(i.h3,{id:"why-doesnt-chisel-tell-me-which-wires-arent-connected",children:"Why doesn't Chisel tell me which wires aren't connected?"}),"\n",(0,l.jsxs)(i.p,{children:["As long as your code uses ",(0,l.jsx)(i.code,{children:"import chisel3._"})," (and not ",(0,l.jsx)(i.code,{children:"import Chisel._"}),"), it does!\nSee ",(0,l.jsx)(i.a,{href:"../explanations/unconnected-wires",children:"Unconnected Wires"})," for details."]}),"\n",(0,l.jsxs)(i.h3,{id:"what-does-reference--is-not-fully-initialized-mean",children:["What does ",(0,l.jsx)(i.code,{children:"Reference ... is not fully initialized."})," mean?"]}),"\n",(0,l.jsx)(i.p,{children:"It means that you have unconnected wires in your design which could be an indication of a design bug."}),"\n",(0,l.jsxs)(i.p,{children:["In Chisel2 compatibility mode (",(0,l.jsx)(i.code,{children:"NotStrict"})," compile options), chisel generates firrtl code that disables firrtl's initialized wire checks.\nIn pure chisel3 (",(0,l.jsx)(i.code,{children:"Strict"})," compile options), the generated firrtl code does not contain these disablers (",(0,l.jsx)(i.code,{children:"is invalid"}),").\nOutput wires that are not driven (not connected) are reported by firrtl as ",(0,l.jsx)(i.code,{children:"not fully initialized"}),".\nRead more at ",(0,l.jsx)(i.a,{href:"../explanations/unconnected-wires",children:"Unconnected Wires"})," for details on solving the problem."]}),"\n",(0,l.jsx)(i.h3,{id:"can-i-specify-behavior-before-and-after-generated-initial-blocks",children:"Can I specify behavior before and after generated initial blocks?"}),"\n",(0,l.jsx)(i.p,{children:"Users may define the following macros if they wish to specify behavior before or after emitted initial blocks."}),"\n",(0,l.jsxs)(i.ul,{children:["\n",(0,l.jsxs)(i.li,{children:[(0,l.jsx)(i.code,{children:"BEFORE_INITIAL"}),", which is called before the emitted (non-empty) initial block if it is defined"]}),"\n",(0,l.jsxs)(i.li,{children:[(0,l.jsx)(i.code,{children:"AFTER_INITIAL"}),", which is called after the emitted (non-empty) initial block if it is defined"]}),"\n"]}),"\n",(0,l.jsx)(i.p,{children:"These macros may be useful for turning coverage on and off."})]})}function h(e={}){const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,l.jsx)(i,{...e,children:(0,l.jsx)(c,{...e})}):c(e)}},8453:(e,i,n)=>{n.d(i,{R:()=>s,x:()=>t});var l=n(6540);const o={},r=l.createContext(o);function s(e){const i=l.useContext(r);return l.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function t(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),l.createElement(r.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/1ce89024.2296292d.js b/assets/js/1ce89024.2296292d.js
new file mode 100644
index 0000000000..2b48cda519
--- /dev/null
+++ b/assets/js/1ce89024.2296292d.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[741],{3519:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>r});var t=i(4848),a=i(8453),s=i(1871);const o={sidebar_position:2},l="Hierarchy Cookbook",c={id:"cookbooks/hierarchy",title:"Hierarchy Cookbook",description:"How do I instantiate multiple instances with the same module parameterization?",source:"@site/docs/cookbooks/hierarchy.md",sourceDirName:"cookbooks",slug:"/cookbooks/hierarchy",permalink:"/docs/cookbooks/hierarchy",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/hierarchy.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"chiselSidebar",previous:{title:"Naming Cookbook",permalink:"/docs/cookbooks/naming"},next:{title:"DataView Cookbook",permalink:"/docs/cookbooks/dataview"}},d={},r=[{value:"How do I instantiate multiple instances with the same module parameterization?",id:"how-do-i-instantiate-multiple-instances-with-the-same-module-parameterization",level:2},{value:"Using Definition and Instance",id:"using-definition-and-instance",level:3},{value:"Using Instantiate",id:"using-instantiate",level:3},{value:"How do I access internal fields of an instance?",id:"how-do-i-access-internal-fields-of-an-instance",level:2},{value:"How do I make my fields accessible from an instance?",id:"how-do-i-make-my-fields-accessible-from-an-instance",level:2},{value:"How do I make case classes containing Data or Modules accessible from an instance?",id:"how-do-i-make-case-classes-containing-data-or-modules-accessible-from-an-instance",level:2},{value:"How do I make type parameterized case classes accessible from an instance?",id:"how-do-i-make-type-parameterized-case-classes-accessible-from-an-instance",level:2},{value:"How do I make case classes with lots of fields accessible from an instance?",id:"how-do-i-make-case-classes-with-lots-of-fields-accessible-from-an-instance",level:2},{value:"How do I look up fields from a Definition, if I don&#39;t want to instantiate it?",id:"how-do-i-look-up-fields-from-a-definition-if-i-dont-want-to-instantiate-it",level:2},{value:"How do I parameterize a module by its children instances?",id:"how-do-i-parameterize-a-module-by-its-children-instances",level:2},{value:"How do I use the new hierarchy-specific Select functions?",id:"how-do-i-use-the-new-hierarchy-specific-select-functions",level:2}];function h(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"hierarchy-cookbook",children:"Hierarchy Cookbook"})}),"\n","\n",(0,t.jsx)(s.A,{toc:r}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-instantiate-multiple-instances-with-the-same-module-parameterization",children:"How do I instantiate multiple instances with the same module parameterization?"}),"\n",(0,t.jsx)(n.p,{children:'Prior to this package, Chisel users relied on deduplication in a FIRRTL compiler to combine\nstructurally equivalent modules into one module (aka "deduplication").\nThis package introduces the following new APIs to enable multiply-instantiated modules directly in Chisel.'}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Definition(...)"})," enables elaborating a module, but does not actually instantiate that module.\nInstead, it returns a ",(0,t.jsx)(n.code,{children:"Definition"})," class which represents that module's definition."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Instance(...)"})," takes a ",(0,t.jsx)(n.code,{children:"Definition"})," and instantiates it, returning an ",(0,t.jsx)(n.code,{children:"Instance"})," object."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Instantiate(...)"})," provides an API similar to ",(0,t.jsx)(n.code,{children:"Module(...)"}),", except it uses\n",(0,t.jsx)(n.code,{children:"Definition"})," and ",(0,t.jsx)(n.code,{children:"Instance"})," to only elaborate modules once for a given set of\nparameters. It returns an ",(0,t.jsx)(n.code,{children:"Instance"})," object."]}),"\n",(0,t.jsxs)(n.p,{children:["Modules (classes or traits) which will be used with the ",(0,t.jsx)(n.code,{children:"Definition"}),"/",(0,t.jsx)(n.code,{children:"Instance"})," api should be marked\nwith the ",(0,t.jsx)(n.code,{children:"@instantiable"})," annotation at the class/trait definition."]}),"\n",(0,t.jsxs)(n.p,{children:["To make a Module's members variables accessible from an ",(0,t.jsx)(n.code,{children:"Instance"})," object, they must be annotated\nwith the ",(0,t.jsx)(n.code,{children:"@public"})," annotation. Note that this is only accessible from a Scala sense\u2014this is not\nin and of itself a mechanism for cross-module references."]}),"\n",(0,t.jsx)(n.h3,{id:"using-definition-and-instance",children:"Using Definition and Instance"}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, use ",(0,t.jsx)(n.code,{children:"Definition"}),", ",(0,t.jsx)(n.code,{children:"Instance"}),", ",(0,t.jsx)(n.code,{children:"@instantiable"})," and ",(0,t.jsx)(n.code,{children:"@public"})," to create\nmultiple instances of one specific parameterization of a module, ",(0,t.jsx)(n.code,{children:"AddOne"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass AddOne(width: Int) extends Module {\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass AddTwo(width: Int) extends Module {\n  val in  = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt(width.W)))\n  val addOneDef = Definition(new AddOne(width))\n  val i0 = Instance(addOneDef)\n  val i1 = Instance(addOneDef)\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule AddOne(\n  input  [9:0] in,\n  output [9:0] out\n);\n\n  assign out = in + 10'h1;\nendmodule\n\nmodule AddTwo(\n  input        clock,\n               reset,\n  input  [9:0] in,\n  output [9:0] out\n);\n\n  wire [9:0] _i0_out;\n  AddOne i0 (\n    .in  (in),\n    .out (_i0_out)\n  );\n  AddOne i1 (\n    .in  (_i0_out),\n    .out (out)\n  );\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"using-instantiate",children:"Using Instantiate"}),"\n",(0,t.jsxs)(n.p,{children:["Similar to the above, the following example uses ",(0,t.jsx)(n.code,{children:"Instantiate"})," to create\nmultiple instances of ",(0,t.jsx)(n.code,{children:"AddOne"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.hierarchy.Instantiate\n\nclass AddTwoInstantiate(width: Int) extends Module {\n  val in  = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt(width.W)))\n  val i0 = Instantiate(new AddOne(width))\n  val i1 = Instantiate(new AddOne(width))\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule AddOne(\n  input  [15:0] in,\n  output [15:0] out\n);\n\n  assign out = in + 16'h1;\nendmodule\n\nmodule AddTwoInstantiate(\n  input         clock,\n                reset,\n  input  [15:0] in,\n  output [15:0] out\n);\n\n  wire [15:0] _i0_out;\n  AddOne i0 (\n    .in  (in),\n    .out (_i0_out)\n  );\n  AddOne i1 (\n    .in  (_i0_out),\n    .out (out)\n  );\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-access-internal-fields-of-an-instance",children:"How do I access internal fields of an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["You can mark internal members of a Module class or trait marked with ",(0,t.jsx)(n.code,{children:"@instantiable"})," with the ",(0,t.jsx)(n.code,{children:"@public"})," annotation.\nThe requirements are that the field is publicly accessible, is a ",(0,t.jsx)(n.code,{children:"val"})," or ",(0,t.jsx)(n.code,{children:"lazy val"}),", and must have an implementation of ",(0,t.jsx)(n.code,{children:"Lookupable"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"Types that are supported by default are:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"Data"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"BaseModule"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"MemBase"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"IsLookupable"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Iterable"}),"/",(0,t.jsx)(n.code,{children:"Option"}),"/",(0,t.jsx)(n.code,{children:"Either"})," containing a type that meets these requirements"]}),"\n",(0,t.jsxs)(n.li,{children:["Basic type like ",(0,t.jsx)(n.code,{children:"String"}),", ",(0,t.jsx)(n.code,{children:"Int"}),", ",(0,t.jsx)(n.code,{children:"BigInt"}),", ",(0,t.jsx)(n.code,{children:"Unit"}),", etc."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["To mark a superclass's member as ",(0,t.jsx)(n.code,{children:"@public"}),", use the following pattern (shown with ",(0,t.jsx)(n.code,{children:"val clock"}),")."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{instantiable, public}\n\n@instantiable\nclass MyModule extends Module {\n  @public val clock = clock\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["You'll get the following error message for improperly marking something as ",(0,t.jsx)(n.code,{children:"@public"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{instantiable, public}\n\nobject NotValidType\n\n@instantiable\nclass MyModule extends Module {\n  @public val x = NotValidType\n}\n// error: @public is only legal within a class or trait marked @instantiable, and only on vals of types that have a Lookupable implementation. Chisel types like Data, BaseModule, and MemBase are supported, as are common Scala types like String, Int, Boolean, Iterable, Option, Either, and Tuples. Please implement Lookupable for MdocApp1.this.NotValidType.type.\n//   @public val x = ParameterizedUserDefinedType("foo", wire)\n//               ^\n'})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-my-fields-accessible-from-an-instance",children:"How do I make my fields accessible from an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["If an instance's fields are simple (e.g. ",(0,t.jsx)(n.code,{children:"Int"}),", ",(0,t.jsx)(n.code,{children:"String"})," etc.) they can be marked directly with ",(0,t.jsx)(n.code,{children:"@public"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Often, fields are more complicated (e.g. a user-defined case class).\nIf a case class is only made up of simple types (i.e. it does ",(0,t.jsx)(n.em,{children:"not"})," contain any ",(0,t.jsx)(n.code,{children:"Data"}),", ",(0,t.jsx)(n.code,{children:"BaseModules"}),", memories, or ",(0,t.jsx)(n.code,{children:"Instances"}),"),\nit can extend the ",(0,t.jsx)(n.code,{children:"IsLookupable"})," trait.\nThis indicates to Chisel that instances of the ",(0,t.jsx)(n.code,{children:"IsLookupable"})," class may be accessed from within instances.\n(If the class ",(0,t.jsx)(n.em,{children:"does"})," contain things like ",(0,t.jsx)(n.code,{children:"Data"})," or modules, ",(0,t.jsx)(n.a,{href:"#how-do-i-make-case-classes-containing-data-or-modules-accessible-from-an-instance",children:"the section below"}),".)"]}),"\n",(0,t.jsxs)(n.p,{children:["However, ensure that these parameters are true for ",(0,t.jsx)(n.strong,{children:"all"})," instances of a definition.\nFor example, if our parameters contained an id field which was instance-specific but defaulted to zero,\nthen the definition's id would be returned for all instances.\nThis change in behavior could lead to bugs if other code presumed the id field was correct."]}),"\n",(0,t.jsxs)(n.p,{children:["Thus, it is important that when converting normal modules to use this package,\nyou are careful about what you mark as ",(0,t.jsx)(n.code,{children:"IsLookupable"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, we added the trait ",(0,t.jsx)(n.code,{children:"IsLookupable"})," to allow the member to be marked ",(0,t.jsx)(n.code,{children:"@public"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, IsLookupable, public}\n\ncase class MyCaseClass(width: Int) extends IsLookupable\n\n@instantiable\nclass MyModule extends Module {\n  @public val x = MyCaseClass(10)\n}\n\nclass Top extends Module {\n  val inst = Instance(Definition(new MyModule))\n  println(s"Width is ${inst.x.width}")\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Width is 10\nCircuit(Top,List(DefModule(repl.MdocSession$MdocApp5$MyModule@6ab0bed4,MyModule,false,List(),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2))),chisel3.internal.firrtl.ir$Block@3f49e283), DefModule(repl.MdocSession$MdocApp5$Top@48234eb8,Top,true,List(),List(Port(Top.clock: IO[Clock],Input,SourceLine(hierarchy.md,111,7)), Port(Top.reset: IO[Bool],Input,SourceLine(hierarchy.md,111,7))),chisel3.internal.firrtl.ir$Block@5abd5a92)),List(),firrtl.renamemap.package$MutableRenameMap@3514090f,List(),List(),List(Layer(UnlocatableSourceInfo,Verification,Extract(Some(verification)),List(Layer(UnlocatableSourceInfo,Assert,Extract(Some(verification/assert)),List(),chisel3.layers.Verification$Assert$@21b8322f), Layer(UnlocatableSourceInfo,Assume,Extract(Some(verification/assume)),List(),chisel3.layers.Verification$Assume$@73ad8b1b), Layer(UnlocatableSourceInfo,Cover,Extract(Some(verification/cover)),List(),chisel3.layers.Verification$Cover$@4e09695)),chisel3.layers.Verification$@59ec2429)),List())\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-case-classes-containing-data-or-modules-accessible-from-an-instance",children:"How do I make case classes containing Data or Modules accessible from an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["For case classes containing ",(0,t.jsx)(n.code,{children:"Data"}),", ",(0,t.jsx)(n.code,{children:"BaseModule"}),", ",(0,t.jsx)(n.code,{children:"MemBase"})," or ",(0,t.jsx)(n.code,{children:"Instance"})," types, you can provide an implementation of the ",(0,t.jsx)(n.code,{children:"Lookupable"})," typeclass."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsxs)(n.strong,{children:["Note that Lookupable for Modules is deprecated, please cast to Instance instead (with ",(0,t.jsx)(n.code,{children:".toInstance"}),")."]})}),"\n",(0,t.jsx)(n.p,{children:"Consider the following case class:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass MyModule extends Module {\n  @public val wire = Wire(UInt(8.W))\n}\ncase class UserDefinedType(name: String, data: UInt, inst: Instance[MyModule])\n"})}),"\n",(0,t.jsxs)(n.p,{children:["By default, instances of ",(0,t.jsx)(n.code,{children:"UserDefinedType"})," will not be accessible from instances:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'@instantiable\nclass HasUserDefinedType extends Module {\n  val inst = Module(new MyModule)\n  val wire = Wire(UInt(8.W))\n  @public val x = UserDefinedType("foo", wire, inst.toInstance)\n}\n// error: @public is only legal within a class or trait marked @instantiable, and only on vals of types that have a Lookupable implementation. Chisel types like Data, BaseModule, and MemBase are supported, as are common Scala types like String, Int, Boolean, Iterable, Option, Either, and Tuples. Please implement Lookupable for MdocApp3.this.UserDefinedType.\n//   @public val x = UserDefinedType("foo", wire, inst.toInstance)\n//               ^\n'})}),"\n",(0,t.jsxs)(n.p,{children:["We can implement the ",(0,t.jsx)(n.code,{children:"Lookupable"})," type class for ",(0,t.jsx)(n.code,{children:"UserDefinedType"})," in order to make it accessible.\nThis involves defining an implicit val in the companion object for ",(0,t.jsx)(n.code,{children:"UserDefinedType"}),".\nBecause ",(0,t.jsx)(n.code,{children:"UserDefinedType"})," has three fields, we use the ",(0,t.jsx)(n.code,{children:"Lookupable.product3"})," factory.\nIt takes 4 type parameters: the type of the case class, and the types of each of its fields."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsxs)(n.strong,{children:["If any fields are ",(0,t.jsx)(n.code,{children:"BaseModules"}),", you must change them to be ",(0,t.jsx)(n.code,{children:"Instance[_]"})," in order to define the ",(0,t.jsx)(n.code,{children:"Lookupable"})," typeclass."]})}),"\n",(0,t.jsxs)(n.p,{children:["For more information about typeclasses, see the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/chisel3/docs/explanations/dataview#type-classes",children:"DataView section on Type Classes"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.hierarchy.Lookupable\nobject UserDefinedType {\n  // Use Lookupable.Simple type alias as return type.\n  implicit val lookupable: Lookupable.Simple[UserDefinedType] =\n    Lookupable.product3[UserDefinedType, String, UInt, Instance[MyModule]](\n      // Provide the recipe for converting the UserDefinedType to a Tuple.\n      x => (x.name, x.data, x.inst),\n      // Provide the recipe for converting a Tuple to a user defined type.\n      // For case classes, you can use the built-in factory method.\n      UserDefinedType.apply\n    )\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Now, we can access instances of ",(0,t.jsx)(n.code,{children:"UserDefinedType"})," from instances:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'@instantiable\nclass HasUserDefinedType extends Module {\n  val inst = Module(new MyModule)\n  val wire = Wire(UInt(8.W))\n  @public val x = UserDefinedType("foo", wire, inst.toInstance)\n}\nclass Top extends Module {\n  val inst = Instance(Definition(new HasUserDefinedType))\n  println(s"Name is: ${inst.x.name}")\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-type-parameterized-case-classes-accessible-from-an-instance",children:"How do I make type parameterized case classes accessible from an instance?"}),"\n",(0,t.jsx)(n.p,{children:"Consider the following type-parameterized case class:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\ncase class ParameterizedUserDefinedType[A, T <: Data](value: A, data: T)\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Similarly to ",(0,t.jsx)(n.code,{children:"HasUserDefinedType"})," we need to define an implicit to provide the ",(0,t.jsx)(n.code,{children:"Lookupable"})," typeclass.\nUnlike the simpler example above, however, we use an ",(0,t.jsx)(n.code,{children:"implicit def"})," to handle the type parameters:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.hierarchy.Lookupable\nobject ParameterizedUserDefinedType {\n  // Type class materialization is recursive, so both A and T must have Lookupable instances.\n  // We required this for A via the context bound `: Lookupable`.\n  // Data is a Chisel built-in so is known to have a Lookupable instance.\n  implicit def lookupable[A : Lookupable, T <: Data]: Lookupable.Simple[ParameterizedUserDefinedType[A, T]] =\n    Lookupable.product2[ParameterizedUserDefinedType[A, T], A, T](\n      x => (x.value, x.data),\n      ParameterizedUserDefinedType.apply\n    )\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Now, we can access instances of ",(0,t.jsx)(n.code,{children:"ParameterizedUserDefinedType"})," from instances:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class ChildModule extends Module {\n  @public val wire = Wire(UInt(8.W))\n}\n@instantiable\nclass HasUserDefinedType extends Module {\n  val wire = Wire(UInt(8.W))\n  @public val x = ParameterizedUserDefinedType("foo", wire)\n  @public val y = ParameterizedUserDefinedType(List(1, 2, 3), wire)\n}\nclass Top extends Module {\n  val inst = Instance(Definition(new HasUserDefinedType))\n  println(s"x.value is: ${inst.x.value}")\n  println(s"y.value.head is: ${inst.y.value.head}")\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-case-classes-with-lots-of-fields-accessible-from-an-instance",children:"How do I make case classes with lots of fields accessible from an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["Lookupable provides factories for ",(0,t.jsx)(n.code,{children:"product1"})," to ",(0,t.jsx)(n.code,{children:"product5"}),'.\nIf your class has more than 5 fields, you can use nested tuples as "pseduo-fields" in the mapping.']}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"case class LotsOfFields(a: Data, b: Data, c: Data, d: Data, e: Data, f: Data)\nobject LotsOfFields {\n  implicit val lookupable: Lookupable.Simple[LotsOfFields] =\n    Lookupable.product5[LotsOfFields, Data, Data, Data, Data, (Data, Data)](\n      x => (x.a, x.b, x.c, x.d, (x.e, x.f)),\n      // Cannot use factory method directly this time since we have to unpack the tuple.\n      { case (a, b, c, d, (e, f)) => LotsOfFields(a, b, c, d, e, f) },\n    )\n}\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-look-up-fields-from-a-definition-if-i-dont-want-to-instantiate-it",children:"How do I look up fields from a Definition, if I don't want to instantiate it?"}),"\n",(0,t.jsxs)(n.p,{children:["Just like ",(0,t.jsx)(n.code,{children:"Instance"}),"s, ",(0,t.jsx)(n.code,{children:"Definition"}),"'s also contain accessors for ",(0,t.jsx)(n.code,{children:"@public"})," members.\nAs such, you can directly access them:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, instantiable, public}\n\n@instantiable\nclass AddOne(val width: Int) extends RawModule {\n  @public val width = width\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass Top extends Module {\n  val definition = Definition(new AddOne(10))\n  println(s"Width is: ${definition.width}")\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Top(\n  input clock,\n        reset\n);\n\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-parameterize-a-module-by-its-children-instances",children:"How do I parameterize a module by its children instances?"}),"\n",(0,t.jsx)(n.p,{children:"Prior to the introduction of this package, a parent module would have to pass all necessary parameters\nwhen instantiating a child module.\nThis had the unfortunate consequence of requiring a parent's parameters to always contain the child's\nparameters, which was an unnecessary coupling which lead to some anti-patterns."}),"\n",(0,t.jsxs)(n.p,{children:["Now, a parent can take a child ",(0,t.jsx)(n.code,{children:"Definition"})," as an argument, and instantiate it directly.\nIn addition, it can analyze the parameters used in the definition to parameterize itself.\nIn a sense, now the child can actually parameterize the parent."]}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, we create a definition of ",(0,t.jsx)(n.code,{children:"AddOne"}),", and pass the definition to ",(0,t.jsx)(n.code,{children:"AddTwo"}),".\nThe width of the ",(0,t.jsx)(n.code,{children:"AddTwo"})," ports are now derived from the parameterization of the ",(0,t.jsx)(n.code,{children:"AddOne"})," instance."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass AddOne(val width: Int) extends Module {\n  @public val width = width\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass AddTwo(addOneDef: Definition[AddOne]) extends Module {\n  val i0 = Instance(addOneDef)\n  val i1 = Instance(addOneDef)\n  val in  = IO(Input(UInt(addOneDef.width.W)))\n  val out = IO(Output(UInt(addOneDef.width.W)))\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule AddOne(\n  input  [9:0] in,\n  output [9:0] out\n);\n\n  assign out = in + 10'h1;\nendmodule\n\nmodule AddTwo(\n  input        clock,\n               reset,\n  input  [9:0] in,\n  output [9:0] out\n);\n\n  wire [9:0] _i0_out;\n  AddOne i0 (\n    .in  (in),\n    .out (_i0_out)\n  );\n  AddOne i1 (\n    .in  (_i0_out),\n    .out (out)\n  );\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-use-the-new-hierarchy-specific-select-functions",children:"How do I use the new hierarchy-specific Select functions?"}),"\n",(0,t.jsx)(n.p,{children:"Select functions can be applied after a module has been elaborated, either in a Chisel Aspect or in a parent module applied to a child module."}),"\n",(0,t.jsxs)(n.p,{children:["There are seven hierarchy-specific functions, which (with the exception of ",(0,t.jsx)(n.code,{children:"ios"}),") either return ",(0,t.jsx)(n.code,{children:"Instance"}),"'s or ",(0,t.jsx)(n.code,{children:"Definition"}),"'s:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"instancesIn(parent)"}),": Return all instances directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"instancesOf[type](parent)"}),": Return all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"allInstancesOf[type](root)"}),": Return all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly and indirectly instantiated, locally and deeply, starting from ",(0,t.jsx)(n.code,{children:"root"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"definitionsIn"}),": Return definitions of all instances directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"definitionsOf[type]"}),": Return definitions of all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"allDefinitionsOf[type]"}),": Return all definitions of instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly and indirectly instantiated, locally and deeply, starting from ",(0,t.jsx)(n.code,{children:"root"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"ios"}),": Returns all the I/Os of the provided definition or instance."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["To demonstrate this, consider the following. We mock up an example where we are using the ",(0,t.jsx)(n.code,{children:"Select.allInstancesOf"})," and ",(0,t.jsx)(n.code,{children:"Select.allDefinitionsOf"})," to annotate instances and the definition of ",(0,t.jsx)(n.code,{children:"EmptyModule"}),". When converting the ",(0,t.jsx)(n.code,{children:"ChiselAnnotation"})," to firrtl's ",(0,t.jsx)(n.code,{children:"Annotation"}),", we print out the resulting ",(0,t.jsx)(n.code,{children:"Target"}),". As shown, despite ",(0,t.jsx)(n.code,{children:"EmptyModule"})," actually only being elaborated once, we still provide different targets depending on how the instance or definition is selected."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, Hierarchy, instantiable, public}\nimport firrtl.annotations.{IsModule, NoTargetAnnotation}\ncase object EmptyAnnotation extends NoTargetAnnotation\ncase class MyChiselAnnotation(m: Hierarchy[RawModule], tag: String) extends experimental.ChiselAnnotation {\n  def toFirrtl = {\n    println(tag + ": " + m.toTarget)\n    EmptyAnnotation\n  }\n}\n\n@instantiable\nclass EmptyModule extends Module {\n  println("Elaborating EmptyModule!")\n}\n\n@instantiable\nclass TwoEmptyModules extends Module {\n  val definition = Definition(new EmptyModule)\n  val i0         = Instance(definition)\n  val i1         = Instance(definition)\n}\n\nclass Top extends Module {\n  val definition = Definition(new TwoEmptyModules)\n  val instance   = Instance(definition)\n  aop.Select.allInstancesOf[EmptyModule](instance).foreach { i =>\n    experimental.annotate(MyChiselAnnotation(i, "instance"))\n  }\n  aop.Select.allDefinitionsOf[EmptyModule](instance).foreach { d =>\n    experimental.annotate(MyChiselAnnotation(d, "definition"))\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Elaborating EmptyModule!\ninstance: ~Top|Top/instance:TwoEmptyModules/i0:EmptyModule\ninstance: ~Top|Top/instance:TwoEmptyModules/i1:EmptyModule\ndefinition: ~Top|EmptyModule\n"})}),"\n",(0,t.jsxs)(n.p,{children:["You can also use ",(0,t.jsx)(n.code,{children:"Select.ios"})," on either a ",(0,t.jsx)(n.code,{children:"Definition"})," or an ",(0,t.jsx)(n.code,{children:"Instance"})," to annotate the I/Os appropriately:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'case class MyIOAnnotation(m: Data, tag: String) extends experimental.ChiselAnnotation {\n  def toFirrtl = {\n    println(tag + ": " + m.toTarget)\n    EmptyAnnotation\n  }\n}\n\n@instantiable\nclass InOutModule extends Module {\n  @public val in = IO(Input(Bool()))\n  @public val out = IO(Output(Bool()))\n  out := in\n}\n\n@instantiable\nclass TwoInOutModules extends Module {\n  val in = IO(Input(Bool()))\n  val out = IO(Output(Bool()))\n  val definition = Definition(new InOutModule)\n  val i0         = Instance(definition)\n  val i1         = Instance(definition)\n  i0.in := in\n  i1.in := i0.out\n  out := i1.out\n}\n\nclass InOutTop extends Module {\n  val definition = Definition(new TwoInOutModules)\n  val instance   = Instance(definition)\n  aop.Select.allInstancesOf[InOutModule](instance).foreach { i =>\n    aop.Select.ios(i).foreach { io =>\n      experimental.annotate(MyIOAnnotation(io, "instance io"))\n  }}\n  aop.Select.allDefinitionsOf[InOutModule](instance).foreach { d =>\n    aop.Select.ios(d).foreach {io =>\n      experimental.annotate(MyIOAnnotation(io, "definition io"))\n  }}\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"instance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>clock\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>reset\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>in\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>out\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>clock\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>reset\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>in\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>out\ndefinition io: ~InOutTop|InOutModule>clock\ndefinition io: ~InOutTop|InOutModule>reset\ndefinition io: ~InOutTop|InOutModule>in\ndefinition io: ~InOutTop|InOutModule>out\n"})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},1871:(e,n,i)=>{i.d(n,{A:()=>o});i(6540);var t=i(5195);const a={tableOfContentsInline:"tableOfContentsInline_prmo"};var s=i(4848);function o(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:o}=e;return(0,s.jsx)("div",{className:a.tableOfContentsInline,children:(0,s.jsx)(t.A,{toc:n,minHeadingLevel:i,maxHeadingLevel:o,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,i)=>{i.d(n,{A:()=>f});var t=i(6540),a=i(6342);function s(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),i=Array(7).fill(-1);n.forEach(((e,n)=>{const t=i.slice(2,e.level);e.parentIndex=Math.max(...t),i[e.level]=n}));const t=[];return n.forEach((e=>{const{parentIndex:i,...a}=e;i>=0?n[i].children.push(a):t.push(a)})),t}function o(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=o({toc:e.children,minHeadingLevel:i,maxHeadingLevel:t});return function(e){return e.level>=i&&e.level<=t}(e)?[{...e,children:n}]:n}))}function l(e){const n=e.getBoundingClientRect();return n.top===n.bottom?l(e.parentNode):n}function c(e,n){let{anchorTopOffset:i}=n;const t=e.find((e=>l(e).top>=i));if(t){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(l(t))?t:e[e.indexOf(t)-1]??null}return e[e.length-1]??null}function d(){const e=(0,t.useRef)(0),{navbar:{hideOnScroll:n}}=(0,a.p)();return(0,t.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function r(e){const n=(0,t.useRef)(void 0),i=d();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:a,minHeadingLevel:s,maxHeadingLevel:o}=e;function l(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),l=function(e){let{minHeadingLevel:n,maxHeadingLevel:i}=e;const t=[];for(let a=n;a<=i;a+=1)t.push(`h${a}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:s,maxHeadingLevel:o}),d=c(l,{anchorTopOffset:i.current}),r=e.find((e=>d&&d.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,i){i?(n.current&&n.current!==e&&n.current.classList.remove(a),e.classList.add(a),n.current=e):e.classList.remove(a)}(e,e===r)}))}return document.addEventListener("scroll",l),document.addEventListener("resize",l),l(),()=>{document.removeEventListener("scroll",l),document.removeEventListener("resize",l)}}),[e,i])}var h=i(8774),u=i(4848);function p(e){let{toc:n,className:i,linkClassName:t,isChild:a}=e;return n.length?(0,u.jsx)("ul",{className:a?void 0:i,children:n.map((e=>(0,u.jsxs)("li",{children:[(0,u.jsx)(h.A,{to:`#${e.id}`,className:t??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,u.jsx)(p,{isChild:!0,toc:e.children,className:i,linkClassName:t})]},e.id)))}):null}const m=t.memo(p);function f(e){let{toc:n,className:i="table-of-contents table-of-contents__left-border",linkClassName:l="table-of-contents__link",linkActiveClassName:c,minHeadingLevel:d,maxHeadingLevel:h,...p}=e;const f=(0,a.p)(),x=d??f.tableOfContents.minHeadingLevel,j=h??f.tableOfContents.maxHeadingLevel,b=function(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:a}=e;return(0,t.useMemo)((()=>o({toc:s(n),minHeadingLevel:i,maxHeadingLevel:a})),[n,i,a])}({toc:n,minHeadingLevel:x,maxHeadingLevel:j});return r((0,t.useMemo)((()=>{if(l&&c)return{linkClassName:l,linkActiveClassName:c,minHeadingLevel:x,maxHeadingLevel:j}}),[l,c,x,j])),(0,u.jsx)(m,{toc:b,className:i,linkClassName:l,...p})}},8453:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>l});var t=i(6540);const a={},s=t.createContext(a);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/1ce89024.76afd8dc.js b/assets/js/1ce89024.76afd8dc.js
deleted file mode 100644
index 26e4998213..0000000000
--- a/assets/js/1ce89024.76afd8dc.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[741],{3519:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>r});var t=i(4848),a=i(8453),s=i(1871);const o={sidebar_position:2},l="Hierarchy Cookbook",c={id:"cookbooks/hierarchy",title:"Hierarchy Cookbook",description:"How do I instantiate multiple instances with the same module parameterization?",source:"@site/docs/cookbooks/hierarchy.md",sourceDirName:"cookbooks",slug:"/cookbooks/hierarchy",permalink:"/docs/cookbooks/hierarchy",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/hierarchy.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"chiselSidebar",previous:{title:"Naming Cookbook",permalink:"/docs/cookbooks/naming"},next:{title:"DataView Cookbook",permalink:"/docs/cookbooks/dataview"}},d={},r=[{value:"How do I instantiate multiple instances with the same module parameterization?",id:"how-do-i-instantiate-multiple-instances-with-the-same-module-parameterization",level:2},{value:"Using Definition and Instance",id:"using-definition-and-instance",level:3},{value:"Using Instantiate",id:"using-instantiate",level:3},{value:"How do I access internal fields of an instance?",id:"how-do-i-access-internal-fields-of-an-instance",level:2},{value:"How do I make my fields accessible from an instance?",id:"how-do-i-make-my-fields-accessible-from-an-instance",level:2},{value:"How do I make case classes containing Data or Modules accessible from an instance?",id:"how-do-i-make-case-classes-containing-data-or-modules-accessible-from-an-instance",level:2},{value:"How do I make type parameterized case classes accessible from an instance?",id:"how-do-i-make-type-parameterized-case-classes-accessible-from-an-instance",level:2},{value:"How do I make case classes with lots of fields accessible from an instance?",id:"how-do-i-make-case-classes-with-lots-of-fields-accessible-from-an-instance",level:2},{value:"How do I look up fields from a Definition, if I don&#39;t want to instantiate it?",id:"how-do-i-look-up-fields-from-a-definition-if-i-dont-want-to-instantiate-it",level:2},{value:"How do I parameterize a module by its children instances?",id:"how-do-i-parameterize-a-module-by-its-children-instances",level:2},{value:"How do I use the new hierarchy-specific Select functions?",id:"how-do-i-use-the-new-hierarchy-specific-select-functions",level:2}];function h(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"hierarchy-cookbook",children:"Hierarchy Cookbook"})}),"\n","\n",(0,t.jsx)(s.A,{toc:r}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-instantiate-multiple-instances-with-the-same-module-parameterization",children:"How do I instantiate multiple instances with the same module parameterization?"}),"\n",(0,t.jsx)(n.p,{children:'Prior to this package, Chisel users relied on deduplication in a FIRRTL compiler to combine\nstructurally equivalent modules into one module (aka "deduplication").\nThis package introduces the following new APIs to enable multiply-instantiated modules directly in Chisel.'}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Definition(...)"})," enables elaborating a module, but does not actually instantiate that module.\nInstead, it returns a ",(0,t.jsx)(n.code,{children:"Definition"})," class which represents that module's definition."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Instance(...)"})," takes a ",(0,t.jsx)(n.code,{children:"Definition"})," and instantiates it, returning an ",(0,t.jsx)(n.code,{children:"Instance"})," object."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Instantiate(...)"})," provides an API similar to ",(0,t.jsx)(n.code,{children:"Module(...)"}),", except it uses\n",(0,t.jsx)(n.code,{children:"Definition"})," and ",(0,t.jsx)(n.code,{children:"Instance"})," to only elaborate modules once for a given set of\nparameters. It returns an ",(0,t.jsx)(n.code,{children:"Instance"})," object."]}),"\n",(0,t.jsxs)(n.p,{children:["Modules (classes or traits) which will be used with the ",(0,t.jsx)(n.code,{children:"Definition"}),"/",(0,t.jsx)(n.code,{children:"Instance"})," api should be marked\nwith the ",(0,t.jsx)(n.code,{children:"@instantiable"})," annotation at the class/trait definition."]}),"\n",(0,t.jsxs)(n.p,{children:["To make a Module's members variables accessible from an ",(0,t.jsx)(n.code,{children:"Instance"})," object, they must be annotated\nwith the ",(0,t.jsx)(n.code,{children:"@public"})," annotation. Note that this is only accessible from a Scala sense\u2014this is not\nin and of itself a mechanism for cross-module references."]}),"\n",(0,t.jsx)(n.h3,{id:"using-definition-and-instance",children:"Using Definition and Instance"}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, use ",(0,t.jsx)(n.code,{children:"Definition"}),", ",(0,t.jsx)(n.code,{children:"Instance"}),", ",(0,t.jsx)(n.code,{children:"@instantiable"})," and ",(0,t.jsx)(n.code,{children:"@public"})," to create\nmultiple instances of one specific parameterization of a module, ",(0,t.jsx)(n.code,{children:"AddOne"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass AddOne(width: Int) extends Module {\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass AddTwo(width: Int) extends Module {\n  val in  = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt(width.W)))\n  val addOneDef = Definition(new AddOne(width))\n  val i0 = Instance(addOneDef)\n  val i1 = Instance(addOneDef)\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule AddOne(\n  input  [9:0] in,\n  output [9:0] out\n);\n\n  assign out = in + 10'h1;\nendmodule\n\nmodule AddTwo(\n  input        clock,\n               reset,\n  input  [9:0] in,\n  output [9:0] out\n);\n\n  wire [9:0] _i0_out;\n  AddOne i0 (\n    .in  (in),\n    .out (_i0_out)\n  );\n  AddOne i1 (\n    .in  (_i0_out),\n    .out (out)\n  );\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"using-instantiate",children:"Using Instantiate"}),"\n",(0,t.jsxs)(n.p,{children:["Similar to the above, the following example uses ",(0,t.jsx)(n.code,{children:"Instantiate"})," to create\nmultiple instances of ",(0,t.jsx)(n.code,{children:"AddOne"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.hierarchy.Instantiate\n\nclass AddTwoInstantiate(width: Int) extends Module {\n  val in  = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt(width.W)))\n  val i0 = Instantiate(new AddOne(width))\n  val i1 = Instantiate(new AddOne(width))\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule AddOne(\n  input  [15:0] in,\n  output [15:0] out\n);\n\n  assign out = in + 16'h1;\nendmodule\n\nmodule AddTwoInstantiate(\n  input         clock,\n                reset,\n  input  [15:0] in,\n  output [15:0] out\n);\n\n  wire [15:0] _i0_out;\n  AddOne i0 (\n    .in  (in),\n    .out (_i0_out)\n  );\n  AddOne i1 (\n    .in  (_i0_out),\n    .out (out)\n  );\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-access-internal-fields-of-an-instance",children:"How do I access internal fields of an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["You can mark internal members of a Module class or trait marked with ",(0,t.jsx)(n.code,{children:"@instantiable"})," with the ",(0,t.jsx)(n.code,{children:"@public"})," annotation.\nThe requirements are that the field is publicly accessible, is a ",(0,t.jsx)(n.code,{children:"val"})," or ",(0,t.jsx)(n.code,{children:"lazy val"}),", and must have an implementation of ",(0,t.jsx)(n.code,{children:"Lookupable"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"Types that are supported by default are:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"Data"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"BaseModule"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"MemBase"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"IsLookupable"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Iterable"}),"/",(0,t.jsx)(n.code,{children:"Option"}),"/",(0,t.jsx)(n.code,{children:"Either"})," containing a type that meets these requirements"]}),"\n",(0,t.jsxs)(n.li,{children:["Basic type like ",(0,t.jsx)(n.code,{children:"String"}),", ",(0,t.jsx)(n.code,{children:"Int"}),", ",(0,t.jsx)(n.code,{children:"BigInt"}),", ",(0,t.jsx)(n.code,{children:"Unit"}),", etc."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["To mark a superclass's member as ",(0,t.jsx)(n.code,{children:"@public"}),", use the following pattern (shown with ",(0,t.jsx)(n.code,{children:"val clock"}),")."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{instantiable, public}\n\n@instantiable\nclass MyModule extends Module {\n  @public val clock = clock\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["You'll get the following error message for improperly marking something as ",(0,t.jsx)(n.code,{children:"@public"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{instantiable, public}\n\nobject NotValidType\n\n@instantiable\nclass MyModule extends Module {\n  @public val x = NotValidType\n}\n// error: @public is only legal within a class or trait marked @instantiable, and only on vals of types that have a Lookupable implementation. Chisel types like Data, BaseModule, and MemBase are supported, as are common Scala types like String, Int, Boolean, Iterable, Option, Either, and Tuples. Please implement Lookupable for MdocApp1.this.NotValidType.type.\n//   @public val x = ParameterizedUserDefinedType("foo", wire)\n//               ^\n'})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-my-fields-accessible-from-an-instance",children:"How do I make my fields accessible from an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["If an instance's fields are simple (e.g. ",(0,t.jsx)(n.code,{children:"Int"}),", ",(0,t.jsx)(n.code,{children:"String"})," etc.) they can be marked directly with ",(0,t.jsx)(n.code,{children:"@public"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Often, fields are more complicated (e.g. a user-defined case class).\nIf a case class is only made up of simple types (i.e. it does ",(0,t.jsx)(n.em,{children:"not"})," contain any ",(0,t.jsx)(n.code,{children:"Data"}),", ",(0,t.jsx)(n.code,{children:"BaseModules"}),", memories, or ",(0,t.jsx)(n.code,{children:"Instances"}),"),\nit can extend the ",(0,t.jsx)(n.code,{children:"IsLookupable"})," trait.\nThis indicates to Chisel that instances of the ",(0,t.jsx)(n.code,{children:"IsLookupable"})," class may be accessed from within instances.\n(If the class ",(0,t.jsx)(n.em,{children:"does"})," contain things like ",(0,t.jsx)(n.code,{children:"Data"})," or modules, ",(0,t.jsx)(n.a,{href:"#how-do-i-make-case-classes-containing-data-or-modules-accessible-from-an-instance",children:"the section below"}),".)"]}),"\n",(0,t.jsxs)(n.p,{children:["However, ensure that these parameters are true for ",(0,t.jsx)(n.strong,{children:"all"})," instances of a definition.\nFor example, if our parameters contained an id field which was instance-specific but defaulted to zero,\nthen the definition's id would be returned for all instances.\nThis change in behavior could lead to bugs if other code presumed the id field was correct."]}),"\n",(0,t.jsxs)(n.p,{children:["Thus, it is important that when converting normal modules to use this package,\nyou are careful about what you mark as ",(0,t.jsx)(n.code,{children:"IsLookupable"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, we added the trait ",(0,t.jsx)(n.code,{children:"IsLookupable"})," to allow the member to be marked ",(0,t.jsx)(n.code,{children:"@public"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, IsLookupable, public}\n\ncase class MyCaseClass(width: Int) extends IsLookupable\n\n@instantiable\nclass MyModule extends Module {\n  @public val x = MyCaseClass(10)\n}\n\nclass Top extends Module {\n  val inst = Instance(Definition(new MyModule))\n  println(s"Width is ${inst.x.width}")\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Width is 10\nCircuit(Top,List(DefModule(repl.MdocSession$MdocApp5$MyModule@1b9e5c8d,MyModule,false,List(),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2))),chisel3.internal.firrtl.ir$Block@7863f906), DefModule(repl.MdocSession$MdocApp5$Top@38208fda,Top,true,List(),List(Port(Top.clock: IO[Clock],Input,SourceLine(hierarchy.md,111,7)), Port(Top.reset: IO[Bool],Input,SourceLine(hierarchy.md,111,7))),chisel3.internal.firrtl.ir$Block@f1b1c23)),List(),firrtl.renamemap.package$MutableRenameMap@66884379,List(),List(),List(Layer(UnlocatableSourceInfo,Verification,Extract(Some(verification)),List(Layer(UnlocatableSourceInfo,Assert,Extract(Some(verification/assert)),List(),chisel3.layers.Verification$Assert$@626d0a28), Layer(UnlocatableSourceInfo,Assume,Extract(Some(verification/assume)),List(),chisel3.layers.Verification$Assume$@5dc8f7c8), Layer(UnlocatableSourceInfo,Cover,Extract(Some(verification/cover)),List(),chisel3.layers.Verification$Cover$@786bcd48)),chisel3.layers.Verification$@7e5d979b)),List())\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-case-classes-containing-data-or-modules-accessible-from-an-instance",children:"How do I make case classes containing Data or Modules accessible from an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["For case classes containing ",(0,t.jsx)(n.code,{children:"Data"}),", ",(0,t.jsx)(n.code,{children:"BaseModule"}),", ",(0,t.jsx)(n.code,{children:"MemBase"})," or ",(0,t.jsx)(n.code,{children:"Instance"})," types, you can provide an implementation of the ",(0,t.jsx)(n.code,{children:"Lookupable"})," typeclass."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsxs)(n.strong,{children:["Note that Lookupable for Modules is deprecated, please cast to Instance instead (with ",(0,t.jsx)(n.code,{children:".toInstance"}),")."]})}),"\n",(0,t.jsx)(n.p,{children:"Consider the following case class:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass MyModule extends Module {\n  @public val wire = Wire(UInt(8.W))\n}\ncase class UserDefinedType(name: String, data: UInt, inst: Instance[MyModule])\n"})}),"\n",(0,t.jsxs)(n.p,{children:["By default, instances of ",(0,t.jsx)(n.code,{children:"UserDefinedType"})," will not be accessible from instances:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'@instantiable\nclass HasUserDefinedType extends Module {\n  val inst = Module(new MyModule)\n  val wire = Wire(UInt(8.W))\n  @public val x = UserDefinedType("foo", wire, inst.toInstance)\n}\n// error: @public is only legal within a class or trait marked @instantiable, and only on vals of types that have a Lookupable implementation. Chisel types like Data, BaseModule, and MemBase are supported, as are common Scala types like String, Int, Boolean, Iterable, Option, Either, and Tuples. Please implement Lookupable for MdocApp3.this.UserDefinedType.\n//   @public val x = UserDefinedType("foo", wire, inst.toInstance)\n//               ^\n'})}),"\n",(0,t.jsxs)(n.p,{children:["We can implement the ",(0,t.jsx)(n.code,{children:"Lookupable"})," type class for ",(0,t.jsx)(n.code,{children:"UserDefinedType"})," in order to make it accessible.\nThis involves defining an implicit val in the companion object for ",(0,t.jsx)(n.code,{children:"UserDefinedType"}),".\nBecause ",(0,t.jsx)(n.code,{children:"UserDefinedType"})," has three fields, we use the ",(0,t.jsx)(n.code,{children:"Lookupable.product3"})," factory.\nIt takes 4 type parameters: the type of the case class, and the types of each of its fields."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsxs)(n.strong,{children:["If any fields are ",(0,t.jsx)(n.code,{children:"BaseModules"}),", you must change them to be ",(0,t.jsx)(n.code,{children:"Instance[_]"})," in order to define the ",(0,t.jsx)(n.code,{children:"Lookupable"})," typeclass."]})}),"\n",(0,t.jsxs)(n.p,{children:["For more information about typeclasses, see the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/chisel3/docs/explanations/dataview#type-classes",children:"DataView section on Type Classes"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.hierarchy.Lookupable\nobject UserDefinedType {\n  // Use Lookupable.Simple type alias as return type.\n  implicit val lookupable: Lookupable.Simple[UserDefinedType] =\n    Lookupable.product3[UserDefinedType, String, UInt, Instance[MyModule]](\n      // Provide the recipe for converting the UserDefinedType to a Tuple.\n      x => (x.name, x.data, x.inst),\n      // Provide the recipe for converting a Tuple to a user defined type.\n      // For case classes, you can use the built-in factory method.\n      UserDefinedType.apply\n    )\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Now, we can access instances of ",(0,t.jsx)(n.code,{children:"UserDefinedType"})," from instances:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'@instantiable\nclass HasUserDefinedType extends Module {\n  val inst = Module(new MyModule)\n  val wire = Wire(UInt(8.W))\n  @public val x = UserDefinedType("foo", wire, inst.toInstance)\n}\nclass Top extends Module {\n  val inst = Instance(Definition(new HasUserDefinedType))\n  println(s"Name is: ${inst.x.name}")\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-type-parameterized-case-classes-accessible-from-an-instance",children:"How do I make type parameterized case classes accessible from an instance?"}),"\n",(0,t.jsx)(n.p,{children:"Consider the following type-parameterized case class:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\ncase class ParameterizedUserDefinedType[A, T <: Data](value: A, data: T)\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Similarly to ",(0,t.jsx)(n.code,{children:"HasUserDefinedType"})," we need to define an implicit to provide the ",(0,t.jsx)(n.code,{children:"Lookupable"})," typeclass.\nUnlike the simpler example above, however, we use an ",(0,t.jsx)(n.code,{children:"implicit def"})," to handle the type parameters:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.hierarchy.Lookupable\nobject ParameterizedUserDefinedType {\n  // Type class materialization is recursive, so both A and T must have Lookupable instances.\n  // We required this for A via the context bound `: Lookupable`.\n  // Data is a Chisel built-in so is known to have a Lookupable instance.\n  implicit def lookupable[A : Lookupable, T <: Data]: Lookupable.Simple[ParameterizedUserDefinedType[A, T]] =\n    Lookupable.product2[ParameterizedUserDefinedType[A, T], A, T](\n      x => (x.value, x.data),\n      ParameterizedUserDefinedType.apply\n    )\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Now, we can access instances of ",(0,t.jsx)(n.code,{children:"ParameterizedUserDefinedType"})," from instances:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class ChildModule extends Module {\n  @public val wire = Wire(UInt(8.W))\n}\n@instantiable\nclass HasUserDefinedType extends Module {\n  val wire = Wire(UInt(8.W))\n  @public val x = ParameterizedUserDefinedType("foo", wire)\n  @public val y = ParameterizedUserDefinedType(List(1, 2, 3), wire)\n}\nclass Top extends Module {\n  val inst = Instance(Definition(new HasUserDefinedType))\n  println(s"x.value is: ${inst.x.value}")\n  println(s"y.value.head is: ${inst.y.value.head}")\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-case-classes-with-lots-of-fields-accessible-from-an-instance",children:"How do I make case classes with lots of fields accessible from an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["Lookupable provides factories for ",(0,t.jsx)(n.code,{children:"product1"})," to ",(0,t.jsx)(n.code,{children:"product5"}),'.\nIf your class has more than 5 fields, you can use nested tuples as "pseduo-fields" in the mapping.']}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"case class LotsOfFields(a: Data, b: Data, c: Data, d: Data, e: Data, f: Data)\nobject LotsOfFields {\n  implicit val lookupable: Lookupable.Simple[LotsOfFields] =\n    Lookupable.product5[LotsOfFields, Data, Data, Data, Data, (Data, Data)](\n      x => (x.a, x.b, x.c, x.d, (x.e, x.f)),\n      // Cannot use factory method directly this time since we have to unpack the tuple.\n      { case (a, b, c, d, (e, f)) => LotsOfFields(a, b, c, d, e, f) },\n    )\n}\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-look-up-fields-from-a-definition-if-i-dont-want-to-instantiate-it",children:"How do I look up fields from a Definition, if I don't want to instantiate it?"}),"\n",(0,t.jsxs)(n.p,{children:["Just like ",(0,t.jsx)(n.code,{children:"Instance"}),"s, ",(0,t.jsx)(n.code,{children:"Definition"}),"'s also contain accessors for ",(0,t.jsx)(n.code,{children:"@public"})," members.\nAs such, you can directly access them:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, instantiable, public}\n\n@instantiable\nclass AddOne(val width: Int) extends RawModule {\n  @public val width = width\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass Top extends Module {\n  val definition = Definition(new AddOne(10))\n  println(s"Width is: ${definition.width}")\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Top(\n  input clock,\n        reset\n);\n\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-parameterize-a-module-by-its-children-instances",children:"How do I parameterize a module by its children instances?"}),"\n",(0,t.jsx)(n.p,{children:"Prior to the introduction of this package, a parent module would have to pass all necessary parameters\nwhen instantiating a child module.\nThis had the unfortunate consequence of requiring a parent's parameters to always contain the child's\nparameters, which was an unnecessary coupling which lead to some anti-patterns."}),"\n",(0,t.jsxs)(n.p,{children:["Now, a parent can take a child ",(0,t.jsx)(n.code,{children:"Definition"})," as an argument, and instantiate it directly.\nIn addition, it can analyze the parameters used in the definition to parameterize itself.\nIn a sense, now the child can actually parameterize the parent."]}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, we create a definition of ",(0,t.jsx)(n.code,{children:"AddOne"}),", and pass the definition to ",(0,t.jsx)(n.code,{children:"AddTwo"}),".\nThe width of the ",(0,t.jsx)(n.code,{children:"AddTwo"})," ports are now derived from the parameterization of the ",(0,t.jsx)(n.code,{children:"AddOne"})," instance."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass AddOne(val width: Int) extends Module {\n  @public val width = width\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass AddTwo(addOneDef: Definition[AddOne]) extends Module {\n  val i0 = Instance(addOneDef)\n  val i1 = Instance(addOneDef)\n  val in  = IO(Input(UInt(addOneDef.width.W)))\n  val out = IO(Output(UInt(addOneDef.width.W)))\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule AddOne(\n  input  [9:0] in,\n  output [9:0] out\n);\n\n  assign out = in + 10'h1;\nendmodule\n\nmodule AddTwo(\n  input        clock,\n               reset,\n  input  [9:0] in,\n  output [9:0] out\n);\n\n  wire [9:0] _i0_out;\n  AddOne i0 (\n    .in  (in),\n    .out (_i0_out)\n  );\n  AddOne i1 (\n    .in  (_i0_out),\n    .out (out)\n  );\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-use-the-new-hierarchy-specific-select-functions",children:"How do I use the new hierarchy-specific Select functions?"}),"\n",(0,t.jsx)(n.p,{children:"Select functions can be applied after a module has been elaborated, either in a Chisel Aspect or in a parent module applied to a child module."}),"\n",(0,t.jsxs)(n.p,{children:["There are seven hierarchy-specific functions, which (with the exception of ",(0,t.jsx)(n.code,{children:"ios"}),") either return ",(0,t.jsx)(n.code,{children:"Instance"}),"'s or ",(0,t.jsx)(n.code,{children:"Definition"}),"'s:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"instancesIn(parent)"}),": Return all instances directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"instancesOf[type](parent)"}),": Return all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"allInstancesOf[type](root)"}),": Return all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly and indirectly instantiated, locally and deeply, starting from ",(0,t.jsx)(n.code,{children:"root"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"definitionsIn"}),": Return definitions of all instances directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"definitionsOf[type]"}),": Return definitions of all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"allDefinitionsOf[type]"}),": Return all definitions of instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly and indirectly instantiated, locally and deeply, starting from ",(0,t.jsx)(n.code,{children:"root"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"ios"}),": Returns all the I/Os of the provided definition or instance."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["To demonstrate this, consider the following. We mock up an example where we are using the ",(0,t.jsx)(n.code,{children:"Select.allInstancesOf"})," and ",(0,t.jsx)(n.code,{children:"Select.allDefinitionsOf"})," to annotate instances and the definition of ",(0,t.jsx)(n.code,{children:"EmptyModule"}),". When converting the ",(0,t.jsx)(n.code,{children:"ChiselAnnotation"})," to firrtl's ",(0,t.jsx)(n.code,{children:"Annotation"}),", we print out the resulting ",(0,t.jsx)(n.code,{children:"Target"}),". As shown, despite ",(0,t.jsx)(n.code,{children:"EmptyModule"})," actually only being elaborated once, we still provide different targets depending on how the instance or definition is selected."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, Hierarchy, instantiable, public}\nimport firrtl.annotations.{IsModule, NoTargetAnnotation}\ncase object EmptyAnnotation extends NoTargetAnnotation\ncase class MyChiselAnnotation(m: Hierarchy[RawModule], tag: String) extends experimental.ChiselAnnotation {\n  def toFirrtl = {\n    println(tag + ": " + m.toTarget)\n    EmptyAnnotation\n  }\n}\n\n@instantiable\nclass EmptyModule extends Module {\n  println("Elaborating EmptyModule!")\n}\n\n@instantiable\nclass TwoEmptyModules extends Module {\n  val definition = Definition(new EmptyModule)\n  val i0         = Instance(definition)\n  val i1         = Instance(definition)\n}\n\nclass Top extends Module {\n  val definition = Definition(new TwoEmptyModules)\n  val instance   = Instance(definition)\n  aop.Select.allInstancesOf[EmptyModule](instance).foreach { i =>\n    experimental.annotate(MyChiselAnnotation(i, "instance"))\n  }\n  aop.Select.allDefinitionsOf[EmptyModule](instance).foreach { d =>\n    experimental.annotate(MyChiselAnnotation(d, "definition"))\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Elaborating EmptyModule!\ninstance: ~Top|Top/instance:TwoEmptyModules/i0:EmptyModule\ninstance: ~Top|Top/instance:TwoEmptyModules/i1:EmptyModule\ndefinition: ~Top|EmptyModule\n"})}),"\n",(0,t.jsxs)(n.p,{children:["You can also use ",(0,t.jsx)(n.code,{children:"Select.ios"})," on either a ",(0,t.jsx)(n.code,{children:"Definition"})," or an ",(0,t.jsx)(n.code,{children:"Instance"})," to annotate the I/Os appropriately:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'case class MyIOAnnotation(m: Data, tag: String) extends experimental.ChiselAnnotation {\n  def toFirrtl = {\n    println(tag + ": " + m.toTarget)\n    EmptyAnnotation\n  }\n}\n\n@instantiable\nclass InOutModule extends Module {\n  @public val in = IO(Input(Bool()))\n  @public val out = IO(Output(Bool()))\n  out := in\n}\n\n@instantiable\nclass TwoInOutModules extends Module {\n  val in = IO(Input(Bool()))\n  val out = IO(Output(Bool()))\n  val definition = Definition(new InOutModule)\n  val i0         = Instance(definition)\n  val i1         = Instance(definition)\n  i0.in := in\n  i1.in := i0.out\n  out := i1.out\n}\n\nclass InOutTop extends Module {\n  val definition = Definition(new TwoInOutModules)\n  val instance   = Instance(definition)\n  aop.Select.allInstancesOf[InOutModule](instance).foreach { i =>\n    aop.Select.ios(i).foreach { io =>\n      experimental.annotate(MyIOAnnotation(io, "instance io"))\n  }}\n  aop.Select.allDefinitionsOf[InOutModule](instance).foreach { d =>\n    aop.Select.ios(d).foreach {io =>\n      experimental.annotate(MyIOAnnotation(io, "definition io"))\n  }}\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"instance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>clock\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>reset\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>in\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>out\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>clock\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>reset\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>in\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>out\ndefinition io: ~InOutTop|InOutModule>clock\ndefinition io: ~InOutTop|InOutModule>reset\ndefinition io: ~InOutTop|InOutModule>in\ndefinition io: ~InOutTop|InOutModule>out\n"})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},1871:(e,n,i)=>{i.d(n,{A:()=>o});i(6540);var t=i(5195);const a={tableOfContentsInline:"tableOfContentsInline_prmo"};var s=i(4848);function o(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:o}=e;return(0,s.jsx)("div",{className:a.tableOfContentsInline,children:(0,s.jsx)(t.A,{toc:n,minHeadingLevel:i,maxHeadingLevel:o,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,i)=>{i.d(n,{A:()=>f});var t=i(6540),a=i(6342);function s(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),i=Array(7).fill(-1);n.forEach(((e,n)=>{const t=i.slice(2,e.level);e.parentIndex=Math.max(...t),i[e.level]=n}));const t=[];return n.forEach((e=>{const{parentIndex:i,...a}=e;i>=0?n[i].children.push(a):t.push(a)})),t}function o(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=o({toc:e.children,minHeadingLevel:i,maxHeadingLevel:t});return function(e){return e.level>=i&&e.level<=t}(e)?[{...e,children:n}]:n}))}function l(e){const n=e.getBoundingClientRect();return n.top===n.bottom?l(e.parentNode):n}function c(e,n){let{anchorTopOffset:i}=n;const t=e.find((e=>l(e).top>=i));if(t){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(l(t))?t:e[e.indexOf(t)-1]??null}return e[e.length-1]??null}function d(){const e=(0,t.useRef)(0),{navbar:{hideOnScroll:n}}=(0,a.p)();return(0,t.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function r(e){const n=(0,t.useRef)(void 0),i=d();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:a,minHeadingLevel:s,maxHeadingLevel:o}=e;function l(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),l=function(e){let{minHeadingLevel:n,maxHeadingLevel:i}=e;const t=[];for(let a=n;a<=i;a+=1)t.push(`h${a}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:s,maxHeadingLevel:o}),d=c(l,{anchorTopOffset:i.current}),r=e.find((e=>d&&d.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,i){i?(n.current&&n.current!==e&&n.current.classList.remove(a),e.classList.add(a),n.current=e):e.classList.remove(a)}(e,e===r)}))}return document.addEventListener("scroll",l),document.addEventListener("resize",l),l(),()=>{document.removeEventListener("scroll",l),document.removeEventListener("resize",l)}}),[e,i])}var h=i(8774),u=i(4848);function p(e){let{toc:n,className:i,linkClassName:t,isChild:a}=e;return n.length?(0,u.jsx)("ul",{className:a?void 0:i,children:n.map((e=>(0,u.jsxs)("li",{children:[(0,u.jsx)(h.A,{to:`#${e.id}`,className:t??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,u.jsx)(p,{isChild:!0,toc:e.children,className:i,linkClassName:t})]},e.id)))}):null}const m=t.memo(p);function f(e){let{toc:n,className:i="table-of-contents table-of-contents__left-border",linkClassName:l="table-of-contents__link",linkActiveClassName:c,minHeadingLevel:d,maxHeadingLevel:h,...p}=e;const f=(0,a.p)(),x=d??f.tableOfContents.minHeadingLevel,j=h??f.tableOfContents.maxHeadingLevel,y=function(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:a}=e;return(0,t.useMemo)((()=>o({toc:s(n),minHeadingLevel:i,maxHeadingLevel:a})),[n,i,a])}({toc:n,minHeadingLevel:x,maxHeadingLevel:j});return r((0,t.useMemo)((()=>{if(l&&c)return{linkClassName:l,linkActiveClassName:c,minHeadingLevel:x,maxHeadingLevel:j}}),[l,c,x,j])),(0,u.jsx)(m,{toc:y,className:i,linkClassName:l,...p})}},8453:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>l});var t=i(6540);const a={},s=t.createContext(a);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/67ffb541.4805b36a.js b/assets/js/67ffb541.4805b36a.js
deleted file mode 100644
index 4bed43e6f9..0000000000
--- a/assets/js/67ffb541.4805b36a.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[7132],{2869:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var i=a(4848),t=a(8453);const l={layout:"docs",title:"DataView",section:"chisel3"},s="DataView",o={id:"explanations/dataview",title:"DataView",description:"New in Chisel 3.5",source:"@site/docs/explanations/dataview.md",sourceDirName:"explanations",slug:"/explanations/dataview",permalink:"/docs/explanations/dataview",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/dataview.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"DataView",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Chisel Data Types",permalink:"/docs/explanations/data-types"},next:{title:"Decoders",permalink:"/docs/explanations/decoder"}},r={},d=[{value:"Introduction",id:"introduction",level:2},{value:"A Motivating Example (AXI4)",id:"a-motivating-example-axi4",level:2},{value:"Other Use Cases",id:"other-use-cases",level:2},{value:"Tuples",id:"tuples",level:3},{value:"Totality and PartialDataView",id:"totality-and-partialdataview",level:2},{value:"Advanced Details",id:"advanced-details",level:2},{value:"Type Classes",id:"type-classes",level:3},{value:"Implicit Resolution",id:"implicit-resolution",level:3},{value:"Implicit Resolution Example",id:"implicit-resolution-example",level:4},{value:"DataProduct",id:"dataproduct",level:3}];function c(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"dataview",children:"DataView"})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.em,{children:"New in Chisel 3.5"})}),"\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsxs)(n.p,{children:['DataView is a mechanism for "viewing" Scala objects as a subtype of ',(0,i.jsx)(n.code,{children:"chisel3.Data"}),".\nOften, this is useful for viewing one subtype of ",(0,i.jsx)(n.code,{children:"chisel3.Data"}),", as another.\nOne can think about a ",(0,i.jsx)(n.code,{children:"DataView"})," as a mapping from a ",(0,i.jsx)(n.em,{children:"Target"})," type ",(0,i.jsx)(n.code,{children:"T"})," to a ",(0,i.jsx)(n.em,{children:"View"})," type ",(0,i.jsx)(n.code,{children:"V"}),".\nThis is similar to a cast (eg. ",(0,i.jsx)(n.code,{children:".asTypeOf"}),") with a few differences:"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Views are ",(0,i.jsx)(n.em,{children:"connectable"}),"\u2014connections to the view will occur on the target"]}),"\n",(0,i.jsxs)(n.li,{children:["Whereas casts are ",(0,i.jsx)(n.em,{children:"structural"})," (a reinterpretation of the underlying bits), a DataView is a customizable mapping"]}),"\n",(0,i.jsxs)(n.li,{children:["Views can be ",(0,i.jsx)(n.em,{children:"partial"}),"\u2014not every field in the target must be included in the mapping"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"a-motivating-example-axi4",children:"A Motivating Example (AXI4)"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Advanced_eXtensible_Interface",children:"AXI4"})," is a common interface in digital\ndesign.\nA typical Verilog peripheral using AXI4 will define a write channel as something like:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"module my_module(\n  // Write Channel\n  input        AXI_AWVALID,\n  output       AXI_AWREADY,\n  input [3:0]  AXI_AWID,\n  input [19:0] AXI_AWADDR,\n  input [1:0]  AXI_AWLEN,\n  input [1:0]  AXI_AWSIZE,\n  // ...\n);\n"})}),"\n",(0,i.jsx)(n.p,{children:"This would correspond to the following Chisel Bundle:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class VerilogAXIBundle(val addrWidth: Int) extends Bundle {\n  val AWVALID = Output(Bool())\n  val AWREADY = Input(Bool())\n  val AWID = Output(UInt(4.W))\n  val AWADDR = Output(UInt(addrWidth.W))\n  val AWLEN = Output(UInt(2.W))\n  val AWSIZE = Output(UInt(2.W))\n  // The rest of AW and other AXI channels here\n}\n\n// Instantiated as\nclass my_module extends RawModule {\n  val AXI = IO(new VerilogAXIBundle(20))\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Expressing something that matches a standard Verilog interface is important when instantiating Verilog\nmodules in a Chisel design as ",(0,i.jsx)(n.code,{children:"BlackBoxes"}),".\nGenerally though, Chisel developers prefer to use composition via utilities like ",(0,i.jsx)(n.code,{children:"Decoupled"})," rather\nthan a flat handling of ",(0,i.jsx)(n.code,{children:"ready"})," and ",(0,i.jsx)(n.code,{children:"valid"}),' as in the above.\nA more "Chisel-y" implementation of this interface might look like:']}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// Note that both the AW and AR channels look similar and could use the same Bundle definition\nclass AXIAddressChannel(val addrWidth: Int) extends Bundle {\n  val id = UInt(4.W)\n  val addr = UInt(addrWidth.W)\n  val len = UInt(2.W)\n  val size = UInt(2.W)\n  // ...\n}\nimport chisel3.util.Decoupled\n// We can compose the various AXI channels together\nclass AXIBundle(val addrWidth: Int) extends Bundle {\n  val aw = Decoupled(new AXIAddressChannel(addrWidth))\n  // val ar = new AXIAddressChannel\n  // ... Other channels here ...\n}\n// Instantiated as\nclass MyModule extends RawModule {\n  val axi = IO(new AXIBundle(20))\n}\n"})}),"\n",(0,i.jsx)(n.p,{children:"Of course, this would result in very different looking Verilog:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule MyModule(\n  input         axi_aw_ready,\n  output        axi_aw_valid,\n  output [3:0]  axi_aw_bits_id,\n  output [19:0] axi_aw_bits_addr,\n  output [1:0]  axi_aw_bits_len,\n                axi_aw_bits_size\n);\n\n  assign axi_aw_valid = 1'h0;\n  assign axi_aw_bits_id = 4'h0;\n  assign axi_aw_bits_addr = 20'h0;\n  assign axi_aw_bits_len = 2'h0;\n  assign axi_aw_bits_size = 2'h0;\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.p,{children:"So how can we use our more structured types while maintaining expected Verilog interfaces?\nMeet DataView:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.dataview._\n\n// We recommend putting DataViews in a companion object of one of the involved types\nobject AXIBundle {\n  // Don't be afraid of the use of implicits, we will discuss this pattern in more detail later\n  implicit val axiView: DataView[VerilogAXIBundle, AXIBundle] = DataView(\n    // The first argument is a function constructing an object of View type (AXIBundle)\n    // from an object of the Target type (VerilogAXIBundle)\n    vab => new AXIBundle(vab.addrWidth),\n    // The remaining arguments are a mapping of the corresponding fields of the two types\n    _.AWVALID -> _.aw.valid,\n    _.AWREADY -> _.aw.ready,\n    _.AWID -> _.aw.bits.id,\n    _.AWADDR -> _.aw.bits.addr,\n    _.AWLEN -> _.aw.bits.len,\n    _.AWSIZE -> _.aw.bits.size,\n    // ...\n  )\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["This ",(0,i.jsx)(n.code,{children:"DataView"})," is a mapping between our flat, Verilog-style AXI Bundle to our more compositional,\nChisel-style AXI Bundle.\nIt allows us to define our ports to match the expected Verilog interface, while manipulating it as if\nit were the more structured type:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class AXIStub extends RawModule {\n  val AXI = IO(new VerilogAXIBundle(20))\n  val view = AXI.viewAs[AXIBundle]\n\n  // We can now manipulate `AXI` via `view`\n  view.aw.bits := 0.U.asTypeOf(new AXIAddressChannel(20)) // zero everything out by default\n  view.aw.valid := true.B\n  when (view.aw.ready) {\n    view.aw.bits.id := 5.U\n    view.aw.bits.addr := 1234.U\n    // We can still manipulate AXI as well\n    AXI.AWLEN := 1.U\n  }\n}\n"})}),"\n",(0,i.jsx)(n.p,{children:"This will generate Verilog that matches the standard naming convention:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule AXIStub(\n  output        AXI_AWVALID,\n  input         AXI_AWREADY,\n  output [3:0]  AXI_AWID,\n  output [19:0] AXI_AWADDR,\n  output [1:0]  AXI_AWLEN,\n                AXI_AWSIZE\n);\n\n  assign AXI_AWVALID = 1'h1;\n  assign AXI_AWID = AXI_AWREADY ? 4'h5 : 4'h0;\n  assign AXI_AWADDR = AXI_AWREADY ? 20'h4D2 : 20'h0;\n  assign AXI_AWLEN = {1'h0, AXI_AWREADY};\n  assign AXI_AWSIZE = 2'h0;\nendmodule\n\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Note that if both the ",(0,i.jsx)(n.em,{children:"Target"})," and the ",(0,i.jsx)(n.em,{children:"View"})," types are subtypes of ",(0,i.jsx)(n.code,{children:"Data"})," (as they are in this example),\nthe ",(0,i.jsx)(n.code,{children:"DataView"})," is ",(0,i.jsx)(n.em,{children:"invertible"}),".\nThis means that we can easily create a ",(0,i.jsx)(n.code,{children:"DataView[AXIBundle, VerilogAXIBundle]"})," from our existing\n",(0,i.jsx)(n.code,{children:"DataView[VerilogAXIBundle, AXIBundle]"}),", all we need to do is provide a function to construct\na ",(0,i.jsx)(n.code,{children:"VerilogAXIBundle"})," from an instance of an ",(0,i.jsx)(n.code,{children:"AXIBundle"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// Note that typically you should define these together (eg. inside object AXIBundle)\nimplicit val axiView2: DataView[AXIBundle, VerilogAXIBundle] = AXIBundle.axiView.invert(ab => new VerilogAXIBundle(ab.addrWidth))\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The following example shows this and illustrates another use case of ",(0,i.jsx)(n.code,{children:"DataView"}),"\u2014connecting unrelated\ntypes:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class ConnectionExample extends RawModule {\n  val in = IO(new AXIBundle(20))\n  val out = IO(Flipped(new VerilogAXIBundle(20)))\n  out.viewAs[AXIBundle] <> in\n}\n"})}),"\n",(0,i.jsx)(n.p,{children:"This results in the corresponding fields being connected in the emitted Verilog:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule ConnectionExample(\n  input         in_aw_ready,\n  output        in_aw_valid,\n  output [3:0]  in_aw_bits_id,\n  output [19:0] in_aw_bits_addr,\n  output [1:0]  in_aw_bits_len,\n                in_aw_bits_size,\n  input         out_AWVALID,\n  output        out_AWREADY,\n  input  [3:0]  out_AWID,\n  input  [19:0] out_AWADDR,\n  input  [1:0]  out_AWLEN,\n                out_AWSIZE\n);\n\n  assign in_aw_valid = out_AWVALID;\n  assign in_aw_bits_id = out_AWID;\n  assign in_aw_bits_addr = out_AWADDR;\n  assign in_aw_bits_len = out_AWLEN;\n  assign in_aw_bits_size = out_AWSIZE;\n  assign out_AWREADY = in_aw_ready;\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.h2,{id:"other-use-cases",children:"Other Use Cases"}),"\n",(0,i.jsxs)(n.p,{children:["While the ability to map between ",(0,i.jsx)(n.code,{children:"Bundle"})," types as in the AXI4 example is pretty compelling,\nDataView has many other applications.\nImportantly, because the ",(0,i.jsx)(n.em,{children:"Target"})," of the ",(0,i.jsx)(n.code,{children:"DataView"})," need not be a ",(0,i.jsx)(n.code,{children:"Data"}),", it provides a way to use\n",(0,i.jsx)(n.code,{children:"non-Data"})," objects with APIs that require ",(0,i.jsx)(n.code,{children:"Data"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"tuples",children:"Tuples"}),"\n",(0,i.jsxs)(n.p,{children:["Perhaps the most helpful use of ",(0,i.jsx)(n.code,{children:"DataView"})," for a non-",(0,i.jsx)(n.code,{children:"Data"})," type is viewing Scala tuples as ",(0,i.jsx)(n.code,{children:"Bundles"}),".\nFor example, in Chisel prior to the introduction of ",(0,i.jsx)(n.code,{children:"DataView"}),", one might try to ",(0,i.jsx)(n.code,{children:"Mux"})," tuples and\nsee an error like the following:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class TupleExample extends RawModule {\n  val a, b, c, d = IO(Input(UInt(8.W)))\n  val cond = IO(Input(Bool()))\n  val x, y = IO(Output(UInt(8.W)))\n  (x, y) := Mux(cond, (a, b), (c, d))\n}\n// error: value := is not a member of (chisel3.UInt, chisel3.UInt)\n//   Expression does not convert to assignment because receiver is not assignable.\n//   (x, y) := Mux(cond, (a, b), (c, d))\n//   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n// error: inferred type arguments [(chisel3.UInt, chisel3.UInt)] do not conform to macro method apply's type parameter bounds [T <: chisel3.Data]\n//   (x, y) := Mux(cond, (a, b), (c, d))\n//             ^^^\n// error: type mismatch;\n//  found   : (chisel3.UInt, chisel3.UInt)\n//  required: T\n//   (x, y) := Mux(cond, (a, b), (c, d))\n//                       ^^^^^^\n// error: type mismatch;\n//  found   : (chisel3.UInt, chisel3.UInt)\n//  required: T\n//   (x, y) := Mux(cond, (a, b), (c, d))\n//                               ^^^^^^\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The issue, is that Chisel primitives like ",(0,i.jsx)(n.code,{children:"Mux"})," and ",(0,i.jsx)(n.code,{children:":="})," only operate on subtypes of ",(0,i.jsx)(n.code,{children:"Data"})," and\nTuples (as members of the Scala standard library), are not subclasses of ",(0,i.jsx)(n.code,{children:"Data"}),".\n",(0,i.jsx)(n.code,{children:"DataView"})," provides a mechanism to ",(0,i.jsx)(n.em,{children:"view"})," a ",(0,i.jsx)(n.code,{children:"Tuple"})," as if it were a ",(0,i.jsx)(n.code,{children:"Data"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// We need a type to represent the Tuple\nclass HWTuple2[A <: Data, B <: Data](val _1: A, val _2: B) extends Bundle\n\n// Provide DataView between Tuple and HWTuple\nimplicit def view[A <: Data, B <: Data]: DataView[(A, B), HWTuple2[A, B]] =\n  DataView(tup => new HWTuple2(tup._1.cloneType, tup._2.cloneType),\n           _._1 -> _._1, _._2 -> _._2)\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Now, we can use ",(0,i.jsx)(n.code,{children:".viewAs"})," to view Tuples as if they were subtypes of ",(0,i.jsx)(n.code,{children:"Data"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class TupleVerboseExample extends RawModule {\n  val a, b, c, d = IO(Input(UInt(8.W)))\n  val cond = IO(Input(Bool()))\n  val x, y = IO(Output(UInt(8.W)))\n  (x, y).viewAs[HWTuple2[UInt, UInt]] := Mux(cond, (a, b).viewAs[HWTuple2[UInt, UInt]], (c, d).viewAs[HWTuple2[UInt, UInt]])\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["This is much more verbose than the original idea of just using the Tuples directly as if they were ",(0,i.jsx)(n.code,{children:"Data"}),".\nWe can make this better by providing an implicit conversion that views a ",(0,i.jsx)(n.code,{children:"Tuple"})," as a ",(0,i.jsx)(n.code,{children:"HWTuple2"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"implicit def tuple2hwtuple[A <: Data, B <: Data](tup: (A, B)): HWTuple2[A, B] =\n  tup.viewAs[HWTuple2[A, B]]\n"})}),"\n",(0,i.jsx)(n.p,{children:"Now, the original code just works!"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class TupleExample extends RawModule {\n  val a, b, c, d = IO(Input(UInt(8.W)))\n  val cond = IO(Input(Bool()))\n  val x, y = IO(Output(UInt(8.W)))\n  (x, y) := Mux(cond, (a, b), (c, d))\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Note that this example ignored ",(0,i.jsx)(n.code,{children:"DataProduct"})," which is another required piece (see ",(0,i.jsx)(n.a,{href:"#dataproduct",children:"the documentation\nabout it below"}),")."]}),"\n",(0,i.jsx)(n.p,{children:"All of this is available to users via a single import:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.conversions._\n"})}),"\n",(0,i.jsx)(n.h2,{id:"totality-and-partialdataview",children:"Totality and PartialDataView"}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.code,{children:"DataView"})," is ",(0,i.jsx)(n.em,{children:"total"})," if all fields of the ",(0,i.jsx)(n.em,{children:"Target"})," type and all fields of the ",(0,i.jsx)(n.em,{children:"View"})," type are\nincluded in the mapping.\nChisel will error if a field is accidentally left out from a ",(0,i.jsx)(n.code,{children:"DataView"}),".\nFor example:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class BundleA extends Bundle {\n  val foo = UInt(8.W)\n  val bar = UInt(8.W)\n}\nclass BundleB extends Bundle {\n  val fizz = UInt(8.W)\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// We forgot BundleA.foo in the mapping!\nimplicit val myView: DataView[BundleA, BundleB] = DataView(_ => new BundleB, _.bar -> _.fizz)\nclass BadMapping extends Module {\n   val in = IO(Input(new BundleA))\n   val out = IO(Output(new BundleB))\n   out := in.viewAs[BundleB]\n}\n// We must run Chisel to see the error\ngetVerilogString(new BadMapping)\n// chisel3.experimental.dataview.package$InvalidViewException: Viewing BadMapping.in: IO[BundleA] as BundleB is non-Total!\n//   Target field '_.foo' is missing.\n//   DataView used is DataView(defined @[dataview.md:228:59]).\n//   If the view *should* be non-total, try a 'PartialDataView'.\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$BadMapping$1$$anonfun$60.apply(dataview.md:232)\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$BadMapping$1$$anonfun$60.apply(dataview.md:232)\n// \tat chisel3.DataImpl.$anonfun$$colon$eq$1(DataImpl.scala:817)\n// \tat scala.runtime.java8.JFunction0$mcV$sp.apply(JFunction0$mcV$sp.scala:18)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:33)\n// \tat chisel3.DataImpl.$colon$eq(DataImpl.scala:817)\n// \tat chisel3.DataImpl.$colon$eq$(DataImpl.scala:815)\n// \tat chisel3.Data.$colon$eq(Data.scala:31)\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$BadMapping$1.<init>(dataview.md:232)\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$$anonfun$apply$67.apply(dataview.md:234)\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$$anonfun$apply$67.apply(dataview.md:234)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,i.jsxs)(n.p,{children:["As that error suggests, if we ",(0,i.jsx)(n.em,{children:"want"})," the view to be non-total, we can use a ",(0,i.jsx)(n.code,{children:"PartialDataView"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// A PartialDataView does not have to be total for the Target\nimplicit val myView: DataView[BundleA, BundleB] = PartialDataView[BundleA, BundleB](_ => new BundleB, _.bar -> _.fizz)\n// myView: DataView[BundleA, BundleB] = PartialDataView(defined @[dataview.md:243:84])\nclass PartialDataViewModule extends Module {\n   val in = IO(Input(new BundleA))\n   val out = IO(Output(new BundleB))\n   out := in.viewAs[BundleB]\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule PartialDataViewModule(\n  input        clock,\n               reset,\n  input  [7:0] in_foo,\n               in_bar,\n  output [7:0] out_fizz\n);\n\n  assign out_fizz = in_bar;\nendmodule\n\n"})}),"\n",(0,i.jsxs)(n.p,{children:["While ",(0,i.jsx)(n.code,{children:"PartialDataViews"})," need not be total for the ",(0,i.jsx)(n.em,{children:"Target"}),", both ",(0,i.jsx)(n.code,{children:"PartialDataViews"})," and ",(0,i.jsx)(n.code,{children:"DataViews"}),"\nmust always be total for the ",(0,i.jsx)(n.em,{children:"View"}),".\nThis has the consequence that ",(0,i.jsx)(n.code,{children:"PartialDataViews"})," are ",(0,i.jsx)(n.strong,{children:"not"})," invertible in the same way as ",(0,i.jsx)(n.code,{children:"DataViews"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"For example:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"implicit val myView2 = myView.invert(_ => new BundleA)\nclass PartialDataViewModule2 extends Module {\n   val in = IO(Input(new BundleA))\n   val out = IO(Output(new BundleB))\n   // Using the inverted version of the mapping\n   out.viewAs[BundleA] := in\n}\n// We must run Chisel to see the error\ngetVerilogString(new PartialDataViewModule2)\n// chisel3.experimental.dataview.package$InvalidViewException: Cannot invert 'PartialDataView(defined @[dataview.md:243:84])' as it is non-total.\n//   Try providing a DataView[MdocApp6.this.BundleB, MdocApp6.this.BundleA].\n//   Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview.\n// \tat chisel3.experimental.dataview.InvertibleDataView$InvertibleDataView.invert(InvertibleDataView.scala:33)\n// \tat repl.MdocSession$MdocApp6$$anonfun$67.apply(dataview.md:263)\n// \tat repl.MdocSession$MdocApp6$$anonfun$67.apply(dataview.md:262)\n"})}),"\n",(0,i.jsxs)(n.p,{children:["As noted, the mapping must ",(0,i.jsx)(n.strong,{children:"always"})," be total for the ",(0,i.jsx)(n.code,{children:"View"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"advanced-details",children:"Advanced Details"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"DataView"})," takes advantage of features of Scala that may be new to many users of Chisel\u2014in particular\n",(0,i.jsx)(n.a,{href:"#type-classes",children:"Type Classes"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"type-classes",children:"Type Classes"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Type_class",children:"Type classes"}),' are powerful language feature for writing\npolymorphic code.\nThey are a common feature in "modern programming languages" like\nScala,\nSwift (see ',(0,i.jsx)(n.a,{href:"https://docs.swift.org/swift-book/LanguageGuide/Protocols.html",children:"protocols"}),"),\nand Rust (see ",(0,i.jsx)(n.a,{href:"https://doc.rust-lang.org/book/ch10-02-traits.html",children:"traits"}),").\nType classes may appear similar to inheritance in object-oriented programming but there are some\nimportant  differences:"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"You can provide a type class for a type you don't own (eg. one defined in a 3rd party library,\nthe Scala standard library, or Chisel itself)"}),"\n",(0,i.jsx)(n.li,{children:"You can write a single type class for many types that do not have a sub-typing relationship"}),"\n",(0,i.jsx)(n.li,{children:"You can provide multiple different type classes for the same type"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"DataView"}),", (1) is crucial because we want to be able to implement ",(0,i.jsx)(n.code,{children:"DataViews"})," of built-in Scala\ntypes like tuples and ",(0,i.jsx)(n.code,{children:"Seqs"}),". Furthermore, ",(0,i.jsx)(n.code,{children:"DataView"})," has two type parameters (the ",(0,i.jsx)(n.em,{children:"Target"})," and the\n",(0,i.jsx)(n.em,{children:"View"})," types) so inheritance does not really make sense\u2014which type would ",(0,i.jsx)(n.code,{children:"extend"})," ",(0,i.jsx)(n.code,{children:"DataView"}),"?"]}),"\n",(0,i.jsx)(n.p,{children:"In Scala 2, type classes are not a built-in language feature, but rather are implemented using implicits.\nThere are great resources out there for interested readers:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://scalac.io/blog/typeclasses-in-scala/",children:"Basic Tutorial"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://stackoverflow.com/a/5598107/2483329",children:"Fantastic Explanation on StackOverflow"})}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Note that Scala 3 has added built-in syntax for type classes that does not apply to Chisel 3 which\ncurrently only supports Scala 2."}),"\n",(0,i.jsx)(n.h3,{id:"implicit-resolution",children:"Implicit Resolution"}),"\n",(0,i.jsxs)(n.p,{children:["Given that ",(0,i.jsx)(n.code,{children:"DataView"})," is implemented using implicits, it is important to understand implicit\nresolution.\nWhenever the compiler sees an implicit argument is required, it first looks in ",(0,i.jsx)(n.em,{children:"current scope"}),"\nbefore looking in the ",(0,i.jsx)(n.em,{children:"implicit scope"}),"."]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Current scope","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Values defined in the current scope"}),"\n",(0,i.jsx)(n.li,{children:"Explicit imports"}),"\n",(0,i.jsx)(n.li,{children:"Wildcard imports"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["Implicit scope","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Companion object of a type"}),"\n",(0,i.jsx)(n.li,{children:"Implicit scope of an argument's type"}),"\n",(0,i.jsx)(n.li,{children:"Implicit scope of type parameters"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If at either stage, multiple implicits are found, then the static overloading rule is used to resolve\nit.\nPut simply, if one implicit applies to a more-specific type than the other, the more-specific one\nwill be selected.\nIf multiple implicits apply within a given stage, then the compiler throws an ambiguous implicit\nresolution error."}),"\n",(0,i.jsxs)(n.p,{children:["This section draws heavily from ",(0,i.jsx)(n.a,{href:"https://stackoverflow.com/a/5598107/2483329",children:"[1]"})," and\n",(0,i.jsx)(n.a,{href:"https://stackoverflow.com/a/8694558/2483329",children:"[2]"}),".\nIn particular, see [1] for examples."]}),"\n",(0,i.jsx)(n.h4,{id:"implicit-resolution-example",children:"Implicit Resolution Example"}),"\n",(0,i.jsxs)(n.p,{children:["To help clarify a bit, let us consider how implicit resolution works for ",(0,i.jsx)(n.code,{children:"DataView"}),".\nConsider the definition of ",(0,i.jsx)(n.code,{children:"viewAs"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"def viewAs[V <: Data](implicit dataView: DataView[T, V]): V\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Armed with the knowledge from the previous section, we know that whenever we call ",(0,i.jsx)(n.code,{children:".viewAs"}),", the\nScala compiler will first look for a ",(0,i.jsx)(n.code,{children:"DataView[T, V]"})," in the current scope (defined in, or imported),\nthen it will look in the companion objects of ",(0,i.jsx)(n.code,{children:"DataView"}),", ",(0,i.jsx)(n.code,{children:"T"}),", and ",(0,i.jsx)(n.code,{children:"V"}),".\nThis enables a fairly powerful pattern, namely that default or typical implementations of a ",(0,i.jsx)(n.code,{children:"DataView"}),"\nshould be defined in the companion object for one of the two types.\nWe can think about ",(0,i.jsx)(n.code,{children:"DataViews"}),' defined in this way as "low priority defaults".\nThey can then be overruled by a specific import if a given user ever wants different behavior.\nFor example:']}),"\n",(0,i.jsx)(n.p,{children:"Given the following types:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class Foo extends Bundle {\n  val a = UInt(8.W)\n  val b = UInt(8.W)\n}\nclass Bar extends Bundle {\n  val c = UInt(8.W)\n  val d = UInt(8.W)\n}\nobject Foo {\n  implicit val f2b: DataView[Foo, Bar] = DataView(_ => new Bar, _.a -> _.c, _.b -> _.d)\n  implicit val b2f: DataView[Bar, Foo] = f2b.invert(_ => new Foo)\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["This provides an implementation of ",(0,i.jsx)(n.code,{children:"DataView"})," in the ",(0,i.jsx)(n.em,{children:"implicit scope"}),' as a "default" mapping between\n',(0,i.jsx)(n.code,{children:"Foo"})," and ",(0,i.jsx)(n.code,{children:"Bar"})," (and it doesn't even require an import!):"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class FooToBar extends Module {\n  val foo = IO(Input(new Foo))\n  val bar = IO(Output(new Bar))\n  bar := foo.viewAs[Bar]\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule FooToBar(\n  input        clock,\n               reset,\n  input  [7:0] foo_a,\n               foo_b,\n  output [7:0] bar_c,\n               bar_d\n);\n\n  assign bar_c = foo_a;\n  assign bar_d = foo_b;\nendmodule\n\n"})}),"\n",(0,i.jsxs)(n.p,{children:["However, it's possible that some user of ",(0,i.jsx)(n.code,{children:"Foo"})," and ",(0,i.jsx)(n.code,{children:"Bar"}),' wants different behavior,\nperhaps they would prefer more of "swizzling" behavior rather than a direct mapping:']}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"object Swizzle {\n  implicit val swizzle: DataView[Foo, Bar] = DataView(_ => new Bar, _.a -> _.d, _.b -> _.c)\n}\n// Current scope always wins over implicit scope\nimport Swizzle._\nclass FooToBarSwizzled extends Module {\n  val foo = IO(Input(new Foo))\n  val bar = IO(Output(new Bar))\n  bar := foo.viewAs[Bar]\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule FooToBarSwizzled(\n  input        clock,\n               reset,\n  input  [7:0] foo_a,\n               foo_b,\n  output [7:0] bar_c,\n               bar_d\n);\n\n  assign bar_c = foo_b;\n  assign bar_d = foo_a;\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.h3,{id:"dataproduct",children:"DataProduct"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"DataProduct"})," is a type class used by ",(0,i.jsx)(n.code,{children:"DataView"}),' to validate the correctness of a user-provided mapping.\nIn order for a type to be "viewable" (ie. the ',(0,i.jsx)(n.code,{children:"Target"})," type of a ",(0,i.jsx)(n.code,{children:"DataView"}),"), it must have an\nimplementation of ",(0,i.jsx)(n.code,{children:"DataProduct"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"For example, say we have some non-Bundle type:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// Loosely based on chisel3.util.Counter\nclass MyCounter(val width: Int) {\n  /** Indicates if the Counter is incrementing this cycle */\n  val active = WireDefault(false.B)\n  val value = RegInit(0.U(width.W))\n  def inc(): Unit = {\n    active := true.B\n    value := value + 1.U\n  }\n  def reset(): Unit = {\n    value := 0.U\n  }\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Say we want to view ",(0,i.jsx)(n.code,{children:"MyCounter"})," as a ",(0,i.jsx)(n.code,{children:"Valid[UInt]"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.Valid\nimplicit val counterView = DataView[MyCounter, Valid[UInt]](c => Valid(UInt(c.width.W)), _.value -> _.bits, _.active -> _.valid)\n// error: myView is already defined as value myView\n// implicit val myView: DataView[BundleA, BundleB] = PartialDataView[BundleA, BundleB](_ => new BundleB, _.bar -> _.fizz)\n//              ^^^^^^\n// error: Could not find implicit value for DataView[MdocApp1.this.BundleA, MdocApp1.this.BundleB].\n// Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview\n//    out := in.viewAs[BundleB]\n//           ^^^^^^^^^^^^^^^^^^\n// error: Could not find implicit value for DataView[MdocApp1.this.BundleA, MdocApp1.this.BundleB].\n// Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview\n//    out := in.viewAs[BundleB]\n//           ^^^^^^^^^^^^^^^^^^\n// error: Could not find implicit value for DataView[MdocApp1.this.BundleB, MdocApp1.this.BundleA].\n// Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview\n//    out.viewAs[BundleA] := in\n//    ^^^^^^^^^^^^^^^^^^^\n// error: Could not find implicit value for DataProduct[MdocApp1.this.MyCounter].\n// Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview#dataproduct\n// implicit val counterView = DataView[MyCounter, Valid[UInt]](c => Valid(UInt(c.width.W)), _.value -> _.bits, _.active -> _.valid)\n//                            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n// error: Implicit definition must have explicit type [quickfixable]\n// Scala 3 migration messages are issued as errors under -Xsource:3. Use -Wconf or @nowarn to demote them to warnings or suppress.\n// Applicable -Wconf / @nowarn filters for this fatal warning: msg=<part of the message>, cat=scala3-migration, site=repl.MdocSession.MdocApp1.myView2\n// implicit val myView2 = myView.invert(_ => new BundleA)\n//              ^^^^^^^\n// error: Implicit definition must have explicit type [quickfixable]\n// Scala 3 migration messages are issued as errors under -Xsource:3. Use -Wconf or @nowarn to demote them to warnings or suppress.\n// Applicable -Wconf / @nowarn filters for this fatal warning: msg=<part of the message>, cat=scala3-migration, site=repl.MdocSession.MdocApp1.counterView\n// implicit val counterView = DataView[MyCounter, Valid[UInt]](c => Valid(UInt(c.width.W)), _.value -> _.bits, _.active -> _.valid)\n//              ^^^^^^^^^^^\n"})}),"\n",(0,i.jsxs)(n.p,{children:["As you can see, this fails Scala compliation.\nWe need to provide an implementation of ",(0,i.jsx)(n.code,{children:"DataProduct[MyCounter]"})," which provides Chisel a way to access\nthe objects of type ",(0,i.jsx)(n.code,{children:"Data"})," within ",(0,i.jsx)(n.code,{children:"MyCounter"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'import chisel3.util.Valid\nimplicit val counterProduct: DataProduct[MyCounter] = new DataProduct[MyCounter] {\n  // The String part of the tuple is a String path to the object to help in debugging\n  def dataIterator(a: MyCounter, path: String): Iterator[(Data, String)] =\n    List(a.value -> s"$path.value", a.active -> s"$path.active").iterator\n}\n// Now this works\nimplicit val counterView: DataView[MyCounter, Valid[UInt]] = DataView(c => Valid(UInt(c.width.W)), _.value -> _.bits, _.active -> _.valid)\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Why is this useful?\nThis is how Chisel is able to check for totality as ",(0,i.jsx)(n.a,{href:"#totality-and-partialdataview",children:"described above"}),".\nIn addition to checking if a user has left a field out of the mapping, it also allows Chisel to check\nif the user has included a ",(0,i.jsx)(n.code,{children:"Data"})," in the mapping that isn't actually a part of the ",(0,i.jsx)(n.em,{children:"target"})," nor the\n",(0,i.jsx)(n.em,{children:"view"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>s,x:()=>o});var i=a(6540);const t={},l=i.createContext(t);function s(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/67ffb541.51383dc4.js b/assets/js/67ffb541.51383dc4.js
new file mode 100644
index 0000000000..480b9d9c4a
--- /dev/null
+++ b/assets/js/67ffb541.51383dc4.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[7132],{2869:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var i=a(4848),t=a(8453);const l={layout:"docs",title:"DataView",section:"chisel3"},s="DataView",o={id:"explanations/dataview",title:"DataView",description:"New in Chisel 3.5",source:"@site/docs/explanations/dataview.md",sourceDirName:"explanations",slug:"/explanations/dataview",permalink:"/docs/explanations/dataview",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/dataview.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"DataView",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Chisel Data Types",permalink:"/docs/explanations/data-types"},next:{title:"Decoders",permalink:"/docs/explanations/decoder"}},r={},d=[{value:"Introduction",id:"introduction",level:2},{value:"A Motivating Example (AXI4)",id:"a-motivating-example-axi4",level:2},{value:"Other Use Cases",id:"other-use-cases",level:2},{value:"Tuples",id:"tuples",level:3},{value:"Totality and PartialDataView",id:"totality-and-partialdataview",level:2},{value:"Advanced Details",id:"advanced-details",level:2},{value:"Type Classes",id:"type-classes",level:3},{value:"Implicit Resolution",id:"implicit-resolution",level:3},{value:"Implicit Resolution Example",id:"implicit-resolution-example",level:4},{value:"DataProduct",id:"dataproduct",level:3}];function c(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"dataview",children:"DataView"})}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.em,{children:"New in Chisel 3.5"})}),"\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsxs)(n.p,{children:['DataView is a mechanism for "viewing" Scala objects as a subtype of ',(0,i.jsx)(n.code,{children:"chisel3.Data"}),".\nOften, this is useful for viewing one subtype of ",(0,i.jsx)(n.code,{children:"chisel3.Data"}),", as another.\nOne can think about a ",(0,i.jsx)(n.code,{children:"DataView"})," as a mapping from a ",(0,i.jsx)(n.em,{children:"Target"})," type ",(0,i.jsx)(n.code,{children:"T"})," to a ",(0,i.jsx)(n.em,{children:"View"})," type ",(0,i.jsx)(n.code,{children:"V"}),".\nThis is similar to a cast (eg. ",(0,i.jsx)(n.code,{children:".asTypeOf"}),") with a few differences:"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Views are ",(0,i.jsx)(n.em,{children:"connectable"}),"\u2014connections to the view will occur on the target"]}),"\n",(0,i.jsxs)(n.li,{children:["Whereas casts are ",(0,i.jsx)(n.em,{children:"structural"})," (a reinterpretation of the underlying bits), a DataView is a customizable mapping"]}),"\n",(0,i.jsxs)(n.li,{children:["Views can be ",(0,i.jsx)(n.em,{children:"partial"}),"\u2014not every field in the target must be included in the mapping"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"a-motivating-example-axi4",children:"A Motivating Example (AXI4)"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Advanced_eXtensible_Interface",children:"AXI4"})," is a common interface in digital\ndesign.\nA typical Verilog peripheral using AXI4 will define a write channel as something like:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"module my_module(\n  // Write Channel\n  input        AXI_AWVALID,\n  output       AXI_AWREADY,\n  input [3:0]  AXI_AWID,\n  input [19:0] AXI_AWADDR,\n  input [1:0]  AXI_AWLEN,\n  input [1:0]  AXI_AWSIZE,\n  // ...\n);\n"})}),"\n",(0,i.jsx)(n.p,{children:"This would correspond to the following Chisel Bundle:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class VerilogAXIBundle(val addrWidth: Int) extends Bundle {\n  val AWVALID = Output(Bool())\n  val AWREADY = Input(Bool())\n  val AWID = Output(UInt(4.W))\n  val AWADDR = Output(UInt(addrWidth.W))\n  val AWLEN = Output(UInt(2.W))\n  val AWSIZE = Output(UInt(2.W))\n  // The rest of AW and other AXI channels here\n}\n\n// Instantiated as\nclass my_module extends RawModule {\n  val AXI = IO(new VerilogAXIBundle(20))\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Expressing something that matches a standard Verilog interface is important when instantiating Verilog\nmodules in a Chisel design as ",(0,i.jsx)(n.code,{children:"BlackBoxes"}),".\nGenerally though, Chisel developers prefer to use composition via utilities like ",(0,i.jsx)(n.code,{children:"Decoupled"})," rather\nthan a flat handling of ",(0,i.jsx)(n.code,{children:"ready"})," and ",(0,i.jsx)(n.code,{children:"valid"}),' as in the above.\nA more "Chisel-y" implementation of this interface might look like:']}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// Note that both the AW and AR channels look similar and could use the same Bundle definition\nclass AXIAddressChannel(val addrWidth: Int) extends Bundle {\n  val id = UInt(4.W)\n  val addr = UInt(addrWidth.W)\n  val len = UInt(2.W)\n  val size = UInt(2.W)\n  // ...\n}\nimport chisel3.util.Decoupled\n// We can compose the various AXI channels together\nclass AXIBundle(val addrWidth: Int) extends Bundle {\n  val aw = Decoupled(new AXIAddressChannel(addrWidth))\n  // val ar = new AXIAddressChannel\n  // ... Other channels here ...\n}\n// Instantiated as\nclass MyModule extends RawModule {\n  val axi = IO(new AXIBundle(20))\n}\n"})}),"\n",(0,i.jsx)(n.p,{children:"Of course, this would result in very different looking Verilog:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule MyModule(\n  input         axi_aw_ready,\n  output        axi_aw_valid,\n  output [3:0]  axi_aw_bits_id,\n  output [19:0] axi_aw_bits_addr,\n  output [1:0]  axi_aw_bits_len,\n                axi_aw_bits_size\n);\n\n  assign axi_aw_valid = 1'h0;\n  assign axi_aw_bits_id = 4'h0;\n  assign axi_aw_bits_addr = 20'h0;\n  assign axi_aw_bits_len = 2'h0;\n  assign axi_aw_bits_size = 2'h0;\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.p,{children:"So how can we use our more structured types while maintaining expected Verilog interfaces?\nMeet DataView:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.dataview._\n\n// We recommend putting DataViews in a companion object of one of the involved types\nobject AXIBundle {\n  // Don't be afraid of the use of implicits, we will discuss this pattern in more detail later\n  implicit val axiView: DataView[VerilogAXIBundle, AXIBundle] = DataView(\n    // The first argument is a function constructing an object of View type (AXIBundle)\n    // from an object of the Target type (VerilogAXIBundle)\n    vab => new AXIBundle(vab.addrWidth),\n    // The remaining arguments are a mapping of the corresponding fields of the two types\n    _.AWVALID -> _.aw.valid,\n    _.AWREADY -> _.aw.ready,\n    _.AWID -> _.aw.bits.id,\n    _.AWADDR -> _.aw.bits.addr,\n    _.AWLEN -> _.aw.bits.len,\n    _.AWSIZE -> _.aw.bits.size,\n    // ...\n  )\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["This ",(0,i.jsx)(n.code,{children:"DataView"})," is a mapping between our flat, Verilog-style AXI Bundle to our more compositional,\nChisel-style AXI Bundle.\nIt allows us to define our ports to match the expected Verilog interface, while manipulating it as if\nit were the more structured type:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class AXIStub extends RawModule {\n  val AXI = IO(new VerilogAXIBundle(20))\n  val view = AXI.viewAs[AXIBundle]\n\n  // We can now manipulate `AXI` via `view`\n  view.aw.bits := 0.U.asTypeOf(new AXIAddressChannel(20)) // zero everything out by default\n  view.aw.valid := true.B\n  when (view.aw.ready) {\n    view.aw.bits.id := 5.U\n    view.aw.bits.addr := 1234.U\n    // We can still manipulate AXI as well\n    AXI.AWLEN := 1.U\n  }\n}\n"})}),"\n",(0,i.jsx)(n.p,{children:"This will generate Verilog that matches the standard naming convention:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule AXIStub(\n  output        AXI_AWVALID,\n  input         AXI_AWREADY,\n  output [3:0]  AXI_AWID,\n  output [19:0] AXI_AWADDR,\n  output [1:0]  AXI_AWLEN,\n                AXI_AWSIZE\n);\n\n  assign AXI_AWVALID = 1'h1;\n  assign AXI_AWID = AXI_AWREADY ? 4'h5 : 4'h0;\n  assign AXI_AWADDR = AXI_AWREADY ? 20'h4D2 : 20'h0;\n  assign AXI_AWLEN = {1'h0, AXI_AWREADY};\n  assign AXI_AWSIZE = 2'h0;\nendmodule\n\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Note that if both the ",(0,i.jsx)(n.em,{children:"Target"})," and the ",(0,i.jsx)(n.em,{children:"View"})," types are subtypes of ",(0,i.jsx)(n.code,{children:"Data"})," (as they are in this example),\nthe ",(0,i.jsx)(n.code,{children:"DataView"})," is ",(0,i.jsx)(n.em,{children:"invertible"}),".\nThis means that we can easily create a ",(0,i.jsx)(n.code,{children:"DataView[AXIBundle, VerilogAXIBundle]"})," from our existing\n",(0,i.jsx)(n.code,{children:"DataView[VerilogAXIBundle, AXIBundle]"}),", all we need to do is provide a function to construct\na ",(0,i.jsx)(n.code,{children:"VerilogAXIBundle"})," from an instance of an ",(0,i.jsx)(n.code,{children:"AXIBundle"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// Note that typically you should define these together (eg. inside object AXIBundle)\nimplicit val axiView2: DataView[AXIBundle, VerilogAXIBundle] = AXIBundle.axiView.invert(ab => new VerilogAXIBundle(ab.addrWidth))\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The following example shows this and illustrates another use case of ",(0,i.jsx)(n.code,{children:"DataView"}),"\u2014connecting unrelated\ntypes:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class ConnectionExample extends RawModule {\n  val in = IO(new AXIBundle(20))\n  val out = IO(Flipped(new VerilogAXIBundle(20)))\n  out.viewAs[AXIBundle] <> in\n}\n"})}),"\n",(0,i.jsx)(n.p,{children:"This results in the corresponding fields being connected in the emitted Verilog:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule ConnectionExample(\n  input         in_aw_ready,\n  output        in_aw_valid,\n  output [3:0]  in_aw_bits_id,\n  output [19:0] in_aw_bits_addr,\n  output [1:0]  in_aw_bits_len,\n                in_aw_bits_size,\n  input         out_AWVALID,\n  output        out_AWREADY,\n  input  [3:0]  out_AWID,\n  input  [19:0] out_AWADDR,\n  input  [1:0]  out_AWLEN,\n                out_AWSIZE\n);\n\n  assign in_aw_valid = out_AWVALID;\n  assign in_aw_bits_id = out_AWID;\n  assign in_aw_bits_addr = out_AWADDR;\n  assign in_aw_bits_len = out_AWLEN;\n  assign in_aw_bits_size = out_AWSIZE;\n  assign out_AWREADY = in_aw_ready;\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.h2,{id:"other-use-cases",children:"Other Use Cases"}),"\n",(0,i.jsxs)(n.p,{children:["While the ability to map between ",(0,i.jsx)(n.code,{children:"Bundle"})," types as in the AXI4 example is pretty compelling,\nDataView has many other applications.\nImportantly, because the ",(0,i.jsx)(n.em,{children:"Target"})," of the ",(0,i.jsx)(n.code,{children:"DataView"})," need not be a ",(0,i.jsx)(n.code,{children:"Data"}),", it provides a way to use\n",(0,i.jsx)(n.code,{children:"non-Data"})," objects with APIs that require ",(0,i.jsx)(n.code,{children:"Data"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"tuples",children:"Tuples"}),"\n",(0,i.jsxs)(n.p,{children:["Perhaps the most helpful use of ",(0,i.jsx)(n.code,{children:"DataView"})," for a non-",(0,i.jsx)(n.code,{children:"Data"})," type is viewing Scala tuples as ",(0,i.jsx)(n.code,{children:"Bundles"}),".\nFor example, in Chisel prior to the introduction of ",(0,i.jsx)(n.code,{children:"DataView"}),", one might try to ",(0,i.jsx)(n.code,{children:"Mux"})," tuples and\nsee an error like the following:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class TupleExample extends RawModule {\n  val a, b, c, d = IO(Input(UInt(8.W)))\n  val cond = IO(Input(Bool()))\n  val x, y = IO(Output(UInt(8.W)))\n  (x, y) := Mux(cond, (a, b), (c, d))\n}\n// error: value := is not a member of (chisel3.UInt, chisel3.UInt)\n//   Expression does not convert to assignment because receiver is not assignable.\n//   (x, y) := Mux(cond, (a, b), (c, d))\n//   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n// error: inferred type arguments [(chisel3.UInt, chisel3.UInt)] do not conform to macro method apply's type parameter bounds [T <: chisel3.Data]\n//   (x, y) := Mux(cond, (a, b), (c, d))\n//             ^^^\n// error: type mismatch;\n//  found   : (chisel3.UInt, chisel3.UInt)\n//  required: T\n//   (x, y) := Mux(cond, (a, b), (c, d))\n//                       ^^^^^^\n// error: type mismatch;\n//  found   : (chisel3.UInt, chisel3.UInt)\n//  required: T\n//   (x, y) := Mux(cond, (a, b), (c, d))\n//                               ^^^^^^\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The issue, is that Chisel primitives like ",(0,i.jsx)(n.code,{children:"Mux"})," and ",(0,i.jsx)(n.code,{children:":="})," only operate on subtypes of ",(0,i.jsx)(n.code,{children:"Data"})," and\nTuples (as members of the Scala standard library), are not subclasses of ",(0,i.jsx)(n.code,{children:"Data"}),".\n",(0,i.jsx)(n.code,{children:"DataView"})," provides a mechanism to ",(0,i.jsx)(n.em,{children:"view"})," a ",(0,i.jsx)(n.code,{children:"Tuple"})," as if it were a ",(0,i.jsx)(n.code,{children:"Data"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// We need a type to represent the Tuple\nclass HWTuple2[A <: Data, B <: Data](val _1: A, val _2: B) extends Bundle\n\n// Provide DataView between Tuple and HWTuple\nimplicit def view[A <: Data, B <: Data]: DataView[(A, B), HWTuple2[A, B]] =\n  DataView(tup => new HWTuple2(tup._1.cloneType, tup._2.cloneType),\n           _._1 -> _._1, _._2 -> _._2)\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Now, we can use ",(0,i.jsx)(n.code,{children:".viewAs"})," to view Tuples as if they were subtypes of ",(0,i.jsx)(n.code,{children:"Data"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class TupleVerboseExample extends RawModule {\n  val a, b, c, d = IO(Input(UInt(8.W)))\n  val cond = IO(Input(Bool()))\n  val x, y = IO(Output(UInt(8.W)))\n  (x, y).viewAs[HWTuple2[UInt, UInt]] := Mux(cond, (a, b).viewAs[HWTuple2[UInt, UInt]], (c, d).viewAs[HWTuple2[UInt, UInt]])\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["This is much more verbose than the original idea of just using the Tuples directly as if they were ",(0,i.jsx)(n.code,{children:"Data"}),".\nWe can make this better by providing an implicit conversion that views a ",(0,i.jsx)(n.code,{children:"Tuple"})," as a ",(0,i.jsx)(n.code,{children:"HWTuple2"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"implicit def tuple2hwtuple[A <: Data, B <: Data](tup: (A, B)): HWTuple2[A, B] =\n  tup.viewAs[HWTuple2[A, B]]\n"})}),"\n",(0,i.jsx)(n.p,{children:"Now, the original code just works!"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class TupleExample extends RawModule {\n  val a, b, c, d = IO(Input(UInt(8.W)))\n  val cond = IO(Input(Bool()))\n  val x, y = IO(Output(UInt(8.W)))\n  (x, y) := Mux(cond, (a, b), (c, d))\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Note that this example ignored ",(0,i.jsx)(n.code,{children:"DataProduct"})," which is another required piece (see ",(0,i.jsx)(n.a,{href:"#dataproduct",children:"the documentation\nabout it below"}),")."]}),"\n",(0,i.jsx)(n.p,{children:"All of this is available to users via a single import:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.conversions._\n"})}),"\n",(0,i.jsx)(n.h2,{id:"totality-and-partialdataview",children:"Totality and PartialDataView"}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.code,{children:"DataView"})," is ",(0,i.jsx)(n.em,{children:"total"})," if all fields of the ",(0,i.jsx)(n.em,{children:"Target"})," type and all fields of the ",(0,i.jsx)(n.em,{children:"View"})," type are\nincluded in the mapping.\nChisel will error if a field is accidentally left out from a ",(0,i.jsx)(n.code,{children:"DataView"}),".\nFor example:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class BundleA extends Bundle {\n  val foo = UInt(8.W)\n  val bar = UInt(8.W)\n}\nclass BundleB extends Bundle {\n  val fizz = UInt(8.W)\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// We forgot BundleA.foo in the mapping!\nimplicit val myView: DataView[BundleA, BundleB] = DataView(_ => new BundleB, _.bar -> _.fizz)\nclass BadMapping extends Module {\n   val in = IO(Input(new BundleA))\n   val out = IO(Output(new BundleB))\n   out := in.viewAs[BundleB]\n}\n// We must run Chisel to see the error\ngetVerilogString(new BadMapping)\n// chisel3.experimental.dataview.package$InvalidViewException: Viewing BadMapping.in: IO[BundleA] as BundleB is non-Total!\n//   Target field '_.foo' is missing.\n//   DataView used is DataView(defined @[dataview.md:228:59]).\n//   If the view *should* be non-total, try a 'PartialDataView'.\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$BadMapping$1$$anonfun$60.apply(dataview.md:232)\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$BadMapping$1$$anonfun$60.apply(dataview.md:232)\n// \tat chisel3.DataImpl.$anonfun$$colon$eq$1(DataImpl.scala:817)\n// \tat scala.runtime.java8.JFunction0$mcV$sp.apply(JFunction0$mcV$sp.scala:18)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:33)\n// \tat chisel3.DataImpl.$colon$eq(DataImpl.scala:817)\n// \tat chisel3.DataImpl.$colon$eq$(DataImpl.scala:815)\n// \tat chisel3.Data.$colon$eq(Data.scala:31)\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$BadMapping$1.<init>(dataview.md:232)\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$$anonfun$apply$67.apply(dataview.md:234)\n// \tat repl.MdocSession$MdocApp6$$anonfun$55$$anonfun$apply$67.apply(dataview.md:234)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,i.jsxs)(n.p,{children:["As that error suggests, if we ",(0,i.jsx)(n.em,{children:"want"})," the view to be non-total, we can use a ",(0,i.jsx)(n.code,{children:"PartialDataView"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// A PartialDataView does not have to be total for the Target\nimplicit val myView: DataView[BundleA, BundleB] = PartialDataView[BundleA, BundleB](_ => new BundleB, _.bar -> _.fizz)\n// myView: DataView[BundleA, BundleB] = PartialDataView(defined @[dataview.md:243:84])\nclass PartialDataViewModule extends Module {\n   val in = IO(Input(new BundleA))\n   val out = IO(Output(new BundleB))\n   out := in.viewAs[BundleB]\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule PartialDataViewModule(\n  input        clock,\n               reset,\n  input  [7:0] in_foo,\n               in_bar,\n  output [7:0] out_fizz\n);\n\n  assign out_fizz = in_bar;\nendmodule\n\n"})}),"\n",(0,i.jsxs)(n.p,{children:["While ",(0,i.jsx)(n.code,{children:"PartialDataViews"})," need not be total for the ",(0,i.jsx)(n.em,{children:"Target"}),", both ",(0,i.jsx)(n.code,{children:"PartialDataViews"})," and ",(0,i.jsx)(n.code,{children:"DataViews"}),"\nmust always be total for the ",(0,i.jsx)(n.em,{children:"View"}),".\nThis has the consequence that ",(0,i.jsx)(n.code,{children:"PartialDataViews"})," are ",(0,i.jsx)(n.strong,{children:"not"})," invertible in the same way as ",(0,i.jsx)(n.code,{children:"DataViews"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"For example:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"implicit val myView2 = myView.invert(_ => new BundleA)\nclass PartialDataViewModule2 extends Module {\n   val in = IO(Input(new BundleA))\n   val out = IO(Output(new BundleB))\n   // Using the inverted version of the mapping\n   out.viewAs[BundleA] := in\n}\n// We must run Chisel to see the error\ngetVerilogString(new PartialDataViewModule2)\n// chisel3.experimental.dataview.package$InvalidViewException: Cannot invert 'PartialDataView(defined @[dataview.md:243:84])' as it is non-total.\n//   Try providing a DataView[MdocApp6.this.BundleB, MdocApp6.this.BundleA].\n//   Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview.\n// \tat chisel3.experimental.dataview.InvertibleDataView$InvertibleDataView.invert(InvertibleDataView.scala:33)\n// \tat repl.MdocSession$MdocApp6$$anonfun$67.apply(dataview.md:263)\n// \tat repl.MdocSession$MdocApp6$$anonfun$67.apply(dataview.md:262)\n"})}),"\n",(0,i.jsxs)(n.p,{children:["As noted, the mapping must ",(0,i.jsx)(n.strong,{children:"always"})," be total for the ",(0,i.jsx)(n.code,{children:"View"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"advanced-details",children:"Advanced Details"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"DataView"})," takes advantage of features of Scala that may be new to many users of Chisel\u2014in particular\n",(0,i.jsx)(n.a,{href:"#type-classes",children:"Type Classes"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"type-classes",children:"Type Classes"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Type_class",children:"Type classes"}),' are powerful language feature for writing\npolymorphic code.\nThey are a common feature in "modern programming languages" like\nScala,\nSwift (see ',(0,i.jsx)(n.a,{href:"https://docs.swift.org/swift-book/LanguageGuide/Protocols.html",children:"protocols"}),"),\nand Rust (see ",(0,i.jsx)(n.a,{href:"https://doc.rust-lang.org/book/ch10-02-traits.html",children:"traits"}),").\nType classes may appear similar to inheritance in object-oriented programming but there are some\nimportant  differences:"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"You can provide a type class for a type you don't own (eg. one defined in a 3rd party library,\nthe Scala standard library, or Chisel itself)"}),"\n",(0,i.jsx)(n.li,{children:"You can write a single type class for many types that do not have a sub-typing relationship"}),"\n",(0,i.jsx)(n.li,{children:"You can provide multiple different type classes for the same type"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["For ",(0,i.jsx)(n.code,{children:"DataView"}),", (1) is crucial because we want to be able to implement ",(0,i.jsx)(n.code,{children:"DataViews"})," of built-in Scala\ntypes like tuples and ",(0,i.jsx)(n.code,{children:"Seqs"}),". Furthermore, ",(0,i.jsx)(n.code,{children:"DataView"})," has two type parameters (the ",(0,i.jsx)(n.em,{children:"Target"})," and the\n",(0,i.jsx)(n.em,{children:"View"})," types) so inheritance does not really make sense\u2014which type would ",(0,i.jsx)(n.code,{children:"extend"})," ",(0,i.jsx)(n.code,{children:"DataView"}),"?"]}),"\n",(0,i.jsx)(n.p,{children:"In Scala 2, type classes are not a built-in language feature, but rather are implemented using implicits.\nThere are great resources out there for interested readers:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://scalac.io/blog/typeclasses-in-scala/",children:"Basic Tutorial"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://stackoverflow.com/a/5598107/2483329",children:"Fantastic Explanation on StackOverflow"})}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Note that Scala 3 has added built-in syntax for type classes that does not apply to Chisel 3 which\ncurrently only supports Scala 2."}),"\n",(0,i.jsx)(n.h3,{id:"implicit-resolution",children:"Implicit Resolution"}),"\n",(0,i.jsxs)(n.p,{children:["Given that ",(0,i.jsx)(n.code,{children:"DataView"})," is implemented using implicits, it is important to understand implicit\nresolution.\nWhenever the compiler sees an implicit argument is required, it first looks in ",(0,i.jsx)(n.em,{children:"current scope"}),"\nbefore looking in the ",(0,i.jsx)(n.em,{children:"implicit scope"}),"."]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Current scope","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Values defined in the current scope"}),"\n",(0,i.jsx)(n.li,{children:"Explicit imports"}),"\n",(0,i.jsx)(n.li,{children:"Wildcard imports"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["Implicit scope","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Companion object of a type"}),"\n",(0,i.jsx)(n.li,{children:"Implicit scope of an argument's type"}),"\n",(0,i.jsx)(n.li,{children:"Implicit scope of type parameters"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If at either stage, multiple implicits are found, then the static overloading rule is used to resolve\nit.\nPut simply, if one implicit applies to a more-specific type than the other, the more-specific one\nwill be selected.\nIf multiple implicits apply within a given stage, then the compiler throws an ambiguous implicit\nresolution error."}),"\n",(0,i.jsxs)(n.p,{children:["This section draws heavily from ",(0,i.jsx)(n.a,{href:"https://stackoverflow.com/a/5598107/2483329",children:"[1]"})," and\n",(0,i.jsx)(n.a,{href:"https://stackoverflow.com/a/8694558/2483329",children:"[2]"}),".\nIn particular, see [1] for examples."]}),"\n",(0,i.jsx)(n.h4,{id:"implicit-resolution-example",children:"Implicit Resolution Example"}),"\n",(0,i.jsxs)(n.p,{children:["To help clarify a bit, let us consider how implicit resolution works for ",(0,i.jsx)(n.code,{children:"DataView"}),".\nConsider the definition of ",(0,i.jsx)(n.code,{children:"viewAs"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"def viewAs[V <: Data](implicit dataView: DataView[T, V]): V\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Armed with the knowledge from the previous section, we know that whenever we call ",(0,i.jsx)(n.code,{children:".viewAs"}),", the\nScala compiler will first look for a ",(0,i.jsx)(n.code,{children:"DataView[T, V]"})," in the current scope (defined in, or imported),\nthen it will look in the companion objects of ",(0,i.jsx)(n.code,{children:"DataView"}),", ",(0,i.jsx)(n.code,{children:"T"}),", and ",(0,i.jsx)(n.code,{children:"V"}),".\nThis enables a fairly powerful pattern, namely that default or typical implementations of a ",(0,i.jsx)(n.code,{children:"DataView"}),"\nshould be defined in the companion object for one of the two types.\nWe can think about ",(0,i.jsx)(n.code,{children:"DataViews"}),' defined in this way as "low priority defaults".\nThey can then be overruled by a specific import if a given user ever wants different behavior.\nFor example:']}),"\n",(0,i.jsx)(n.p,{children:"Given the following types:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class Foo extends Bundle {\n  val a = UInt(8.W)\n  val b = UInt(8.W)\n}\nclass Bar extends Bundle {\n  val c = UInt(8.W)\n  val d = UInt(8.W)\n}\nobject Foo {\n  implicit val f2b: DataView[Foo, Bar] = DataView(_ => new Bar, _.a -> _.c, _.b -> _.d)\n  implicit val b2f: DataView[Bar, Foo] = f2b.invert(_ => new Foo)\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["This provides an implementation of ",(0,i.jsx)(n.code,{children:"DataView"})," in the ",(0,i.jsx)(n.em,{children:"implicit scope"}),' as a "default" mapping between\n',(0,i.jsx)(n.code,{children:"Foo"})," and ",(0,i.jsx)(n.code,{children:"Bar"})," (and it doesn't even require an import!):"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class FooToBar extends Module {\n  val foo = IO(Input(new Foo))\n  val bar = IO(Output(new Bar))\n  bar := foo.viewAs[Bar]\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule FooToBar(\n  input        clock,\n               reset,\n  input  [7:0] foo_a,\n               foo_b,\n  output [7:0] bar_c,\n               bar_d\n);\n\n  assign bar_c = foo_a;\n  assign bar_d = foo_b;\nendmodule\n\n"})}),"\n",(0,i.jsxs)(n.p,{children:["However, it's possible that some user of ",(0,i.jsx)(n.code,{children:"Foo"})," and ",(0,i.jsx)(n.code,{children:"Bar"}),' wants different behavior,\nperhaps they would prefer more of "swizzling" behavior rather than a direct mapping:']}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"object Swizzle {\n  implicit val swizzle: DataView[Foo, Bar] = DataView(_ => new Bar, _.a -> _.d, _.b -> _.c)\n}\n// Current scope always wins over implicit scope\nimport Swizzle._\nclass FooToBarSwizzled extends Module {\n  val foo = IO(Input(new Foo))\n  val bar = IO(Output(new Bar))\n  bar := foo.viewAs[Bar]\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule FooToBarSwizzled(\n  input        clock,\n               reset,\n  input  [7:0] foo_a,\n               foo_b,\n  output [7:0] bar_c,\n               bar_d\n);\n\n  assign bar_c = foo_b;\n  assign bar_d = foo_a;\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.h3,{id:"dataproduct",children:"DataProduct"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"DataProduct"})," is a type class used by ",(0,i.jsx)(n.code,{children:"DataView"}),' to validate the correctness of a user-provided mapping.\nIn order for a type to be "viewable" (ie. the ',(0,i.jsx)(n.code,{children:"Target"})," type of a ",(0,i.jsx)(n.code,{children:"DataView"}),"), it must have an\nimplementation of ",(0,i.jsx)(n.code,{children:"DataProduct"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"For example, say we have some non-Bundle type:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"// Loosely based on chisel3.util.Counter\nclass MyCounter(val width: Int) {\n  /** Indicates if the Counter is incrementing this cycle */\n  val active = WireDefault(false.B)\n  val value = RegInit(0.U(width.W))\n  def inc(): Unit = {\n    active := true.B\n    value := value + 1.U\n  }\n  def reset(): Unit = {\n    value := 0.U\n  }\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Say we want to view ",(0,i.jsx)(n.code,{children:"MyCounter"})," as a ",(0,i.jsx)(n.code,{children:"Valid[UInt]"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.Valid\nimplicit val counterView = DataView[MyCounter, Valid[UInt]](c => Valid(UInt(c.width.W)), _.value -> _.bits, _.active -> _.valid)\n// error: myView is already defined as value myView\n// implicit val myView: DataView[BundleA, BundleB] = PartialDataView[BundleA, BundleB](_ => new BundleB, _.bar -> _.fizz)\n//              ^^^^^^\n// error: Could not find implicit value for DataView[MdocApp1.this.BundleA, MdocApp1.this.BundleB].\n// Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview\n//    out := in.viewAs[BundleB]\n//           ^^^^^^^^^^^^^^^^^^\n// error: Could not find implicit value for DataView[MdocApp1.this.BundleA, MdocApp1.this.BundleB].\n// Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview\n//    out := in.viewAs[BundleB]\n//           ^^^^^^^^^^^^^^^^^^\n// error: Could not find implicit value for DataView[MdocApp1.this.BundleB, MdocApp1.this.BundleA].\n// Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview\n//    out.viewAs[BundleA] := in\n//    ^^^^^^^^^^^^^^^^^^^\n// error: Could not find implicit value for DataProduct[MdocApp1.this.MyCounter].\n// Please see https://www.chisel-lang.org/chisel3/docs/explanations/dataview#dataproduct\n// implicit val counterView = DataView[MyCounter, Valid[UInt]](c => Valid(UInt(c.width.W)), _.value -> _.bits, _.active -> _.valid)\n//                            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n// error: Implicit definition must have explicit type [quickfixable]\n// Scala 3 migration messages are issued as errors under -Xsource:3. Use -Wconf or @nowarn to demote them to warnings or suppress.\n// Applicable -Wconf / @nowarn filters for this fatal warning: msg=<part of the message>, cat=scala3-migration, site=repl.MdocSession.MdocApp1.myView2\n// implicit val myView2 = myView.invert(_ => new BundleA)\n//              ^^^^^^^\n// error: Implicit definition must have explicit type [quickfixable]\n// Scala 3 migration messages are issued as errors under -Xsource:3. Use -Wconf or @nowarn to demote them to warnings or suppress.\n// Applicable -Wconf / @nowarn filters for this fatal warning: msg=<part of the message>, cat=scala3-migration, site=repl.MdocSession.MdocApp1.counterView\n// implicit val counterView = DataView[MyCounter, Valid[UInt]](c => Valid(UInt(c.width.W)), _.value -> _.bits, _.active -> _.valid)\n//              ^^^^^^^^^^^\n"})}),"\n",(0,i.jsxs)(n.p,{children:["As you can see, this fails Scala compliation.\nWe need to provide an implementation of ",(0,i.jsx)(n.code,{children:"DataProduct[MyCounter]"})," which provides Chisel a way to access\nthe objects of type ",(0,i.jsx)(n.code,{children:"Data"})," within ",(0,i.jsx)(n.code,{children:"MyCounter"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'import chisel3.util.Valid\nimplicit val counterProduct: DataProduct[MyCounter] = new DataProduct[MyCounter] {\n  // The String part of the tuple is a String path to the object to help in debugging\n  def dataIterator(a: MyCounter, path: String): Iterator[(Data, String)] =\n    List(a.value -> s"$path.value", a.active -> s"$path.active").iterator\n}\n// Now this works\nimplicit val counterView: DataView[MyCounter, Valid[UInt]] = DataView(c => Valid(UInt(c.width.W)), _.value -> _.bits, _.active -> _.valid)\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Why is this useful?\nThis is how Chisel is able to check for totality as ",(0,i.jsx)(n.a,{href:"#totality-and-partialdataview",children:"described above"}),".\nIn addition to checking if a user has left a field out of the mapping, it also allows Chisel to check\nif the user has included a ",(0,i.jsx)(n.code,{children:"Data"})," in the mapping that isn't actually a part of the ",(0,i.jsx)(n.em,{children:"target"})," nor the\n",(0,i.jsx)(n.em,{children:"view"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>s,x:()=>o});var i=a(6540);const t={},l=i.createContext(t);function s(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/7b5bfa87.77e370fe.js b/assets/js/7b5bfa87.1c5fc558.js
similarity index 96%
rename from assets/js/7b5bfa87.77e370fe.js
rename to assets/js/7b5bfa87.1c5fc558.js
index 6c36d06e45..db74eb2648 100644
--- a/assets/js/7b5bfa87.77e370fe.js
+++ b/assets/js/7b5bfa87.1c5fc558.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[2785],{1001:(a,e,n)=>{n.r(e),n.d(e,{assets:()=>i,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>p});var l=n(4848),t=n(8453);const s={layout:"docs",title:"Chisel Type vs Scala Type",section:"chisel3"},c="Chisel Type vs Scala Type",o={id:"explanations/chisel-type-vs-scala-type",title:"Chisel Type vs Scala Type",description:"The Scala compiler cannot distinguish between Chisel's representation of hardware such as false.B, Reg(Bool())",source:"@site/docs/explanations/chisel-type-vs-scala-type.md",sourceDirName:"explanations",slug:"/explanations/chisel-type-vs-scala-type",permalink:"/docs/explanations/chisel-type-vs-scala-type",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/chisel-type-vs-scala-type.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Chisel Type vs Scala Type",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Enumerations",permalink:"/docs/explanations/chisel-enum"},next:{title:"Combinational Circuits",permalink:"/docs/explanations/combinational-circuits"}},i={},p=[{value:"Scala Type vs Chisel Type vs Hardware",id:"scala-type-vs-chisel-type-vs-hardware",level:2},{value:"Chisel Type vs Hardware vs Literals",id:"chisel-type-vs-hardware-vs-literals",level:2},{value:"Chisel Type vs Hardware -- Specific Functions and Errors",id:"chisel-type-vs-hardware----specific-functions-and-errors",level:2},{value:"<code>.asInstanceOf</code> vs <code>.asTypeOf</code> vs <code>chiselTypeOf</code>",id:"asinstanceof-vs-astypeof-vs-chiseltypeof",level:2}];function r(a){const e={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,t.R)(),...a.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(e.header,{children:(0,l.jsx)(e.h1,{id:"chisel-type-vs-scala-type",children:"Chisel Type vs Scala Type"})}),"\n",(0,l.jsxs)(e.p,{children:["The Scala compiler cannot distinguish between Chisel's representation of hardware such as ",(0,l.jsx)(e.code,{children:"false.B"}),", ",(0,l.jsx)(e.code,{children:"Reg(Bool())"}),"\nand pure Chisel types (e.g. ",(0,l.jsx)(e.code,{children:"Bool()"}),"). You can get runtime errors passing a Chisel type when hardware is expected, and vice versa."]}),"\n",(0,l.jsx)(e.h2,{id:"scala-type-vs-chisel-type-vs-hardware",children:"Scala Type vs Chisel Type vs Hardware"}),"\n",(0,l.jsxs)(e.p,{children:["The ",(0,l.jsx)(e.em,{children:"Scala"})," type of the Data is recognized by the Scala compiler, such as ",(0,l.jsx)(e.code,{children:"Bool"}),", ",(0,l.jsx)(e.code,{children:"Decoupled[UInt]"})," or ",(0,l.jsx)(e.code,{children:"MyBundle"})," in"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"class MyBundle(w: Int) extends Bundle {\n  val foo = UInt(w.W)\n  val bar = UInt(w.W)\n}\n"})}),"\n",(0,l.jsxs)(e.p,{children:["The ",(0,l.jsx)(e.em,{children:"Chisel"})," type of a ",(0,l.jsx)(e.code,{children:"Data"})," is a Scala object. It captures all the fields actually present,\nby names, and their types including widths.\nFor example, ",(0,l.jsx)(e.code,{children:"MyBundle(3)"})," creates a Chisel Type with fields ",(0,l.jsx)(e.code,{children:"foo: UInt(3.W),  bar: UInt(3.W))"}),"."]}),"\n",(0,l.jsxs)(e.p,{children:["Hardware is ",(0,l.jsx)(e.code,{children:"Data"}),' that is "bound" to synthesizable hardware. For example ',(0,l.jsx)(e.code,{children:"false.B"})," or ",(0,l.jsx)(e.code,{children:"Reg(Bool())"}),".\nThe binding is what determines the actual directionality of each field, it is not a property of the Chisel type."]}),"\n",(0,l.jsxs)(e.p,{children:["A literal is a ",(0,l.jsx)(e.code,{children:"Data"})," that is respresentable as a literal value without being wrapped in Wire, Reg, or IO."]}),"\n",(0,l.jsx)(e.h2,{id:"chisel-type-vs-hardware-vs-literals",children:"Chisel Type vs Hardware vs Literals"}),"\n",(0,l.jsxs)(e.p,{children:["The below code demonstrates how objects with the same Scala type (",(0,l.jsx)(e.code,{children:"MyBundle"}),") can have different properties."]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"import chisel3.experimental.BundleLiterals._\n\nclass MyModule(gen: () => MyBundle) extends Module {\n                                                            //   Hardware   Literal\n    val xType:    MyBundle     = new MyBundle(3)            //      -          -\n    val dirXType: MyBundle     = Input(new MyBundle(3))     //      -          -\n    val xReg:     MyBundle     = Reg(new MyBundle(3))       //      x          -\n    val xIO:      MyBundle     = IO(Input(new MyBundle(3))) //      x          -\n    val xRegInit: MyBundle     = RegInit(xIO)               //      x          -\n    val xLit:     MyBundle     = xType.Lit(                 //      x          x\n      _.foo -> 0.U(3.W),\n      _.bar -> 0.U(3.W)\n    )\n    val y:        MyBundle = gen()                          //      ?          ?\n\n    // Need to initialize all hardware values\n    xReg := DontCare\n}\n"})}),"\n",(0,l.jsx)(e.h2,{id:"chisel-type-vs-hardware----specific-functions-and-errors",children:"Chisel Type vs Hardware -- Specific Functions and Errors"}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".asTypeOf"})," works for both hardware and Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"elaborate(new Module {\n  val chiselType = new MyBundle(3)\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val a = 0.U.asTypeOf(chiselType)\n  val b = 0.U.asTypeOf(hardware)\n})\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only ",(0,l.jsx)(e.code,{children:":="})," to hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val chiselType = new MyBundle(3)\n  chiselType := DontCare\n})\n// chisel3.package$ExpectedHardwareException: data to be connected 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21$$anon$3.<init>(chisel-type-vs-scala-type.md:90)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:88)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:88)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only ",(0,l.jsx)(e.code,{children:":="})," from hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = IO(new MyBundle(3))\n  val moarHardware = Wire(new MyBundle(3))\n  moarHardware := DontCare\n  hardware := moarHardware\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val hardware = IO(new MyBundle(3))\n  val chiselType = new MyBundle(3)\n  hardware := chiselType\n})\n// chisel3.package$ExpectedHardwareException: data to be connected 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27$$anon$5.<init>(chisel-type-vs-scala-type.md:115)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:112)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:112)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Have to pass hardware to ",(0,l.jsx)(e.code,{children:"chiselTypeOf"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val chiselType = chiselTypeOf(hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val chiselType = new MyBundle(3)\n  val crash = chiselTypeOf(chiselType)\n})\n// chisel3.package$ExpectedHardwareException: 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:138)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39.apply(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7.<init>(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:136)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:136)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Have to pass hardware to ",(0,l.jsx)(e.code,{children:"*Init"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val moarHardware = WireInit(hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val crash = WireInit(new MyBundle(3))\n})\n// chisel3.package$ExpectedHardwareException: wire initializer 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:160)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45.apply(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9.<init>(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:159)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:159)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can't pass hardware to a ",(0,l.jsx)(e.code,{children:"Wire"}),", ",(0,l.jsx)(e.code,{children:"Reg"}),", ",(0,l.jsx)(e.code,{children:"IO"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  val crash = Wire(hardware)\n})\n// chisel3.package$ExpectedChiselTypeException: wire type '_44_Anon.hardware: Wire[MyBundle]' must be a Chisel type, not hardware\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:182)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51.apply(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11.<init>(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:180)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:180)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".Lit"})," can only be called on Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardwareLit = (new MyBundle(3)).Lit(\n    _.foo -> 0.U,\n    _.bar -> 0.U\n  )\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"//Not this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  val crash = hardware.Lit(\n    _.foo -> 0.U,\n    _.bar -> 0.U\n  )\n})\n// chisel3.package$ExpectedChiselTypeException: bundle literal constructor model '_52_Anon.hardware: Wire[MyBundle]' must be a Chisel type, not hardware\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:206)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56.apply(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13.<init>(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:204)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:204)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only use a Chisel type within a ",(0,l.jsx)(e.code,{children:"Bundle"})," definition:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new Bundle {\n    val nested = new MyBundle(3)\n  })\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val crash = Wire(new Bundle {\n    val nested = Wire(new MyBundle(3))\n  })\n})\n// chisel3.package$ExpectedChiselTypeException: Bundle: AnonymousBundle contains hardware fields: nested: _60_Anon.crash_nested: Wire[MyBundle]\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:232)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62.apply(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16.<init>(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:231)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:231)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only call ",(0,l.jsx)(e.code,{children:"directionOf"})," on Hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"import chisel3.reflect.DataMirror\n\nclass Child extends Module{\n  val hardware = IO(new MyBundle(3))\n  hardware := DontCare\n  val chiselType = new MyBundle(3)\n}\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val child = Module(new Child())\n  child.hardware := DontCare\n  val direction = DataMirror.directionOf(child.hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\nval child = Module(new Child())\n  child.hardware := DontCare\n  val direction = DataMirror.directionOf(child.chiselType)\n})\n// chisel3.package$ExpectedHardwareException: node requested directionality on 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68$$anon$19.<init>(chisel-type-vs-scala-type.md:271)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:268)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:268)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can call ",(0,l.jsx)(e.code,{children:"specifiedDirectionOf"})," on hardware or Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"elaborate(new Module {\n  val child = Module(new Child())\n  child.hardware := DontCare\n  val direction0 = DataMirror.specifiedDirectionOf(child.hardware)\n  val direction1 = DataMirror.specifiedDirectionOf(child.chiselType)\n})\n"})}),"\n",(0,l.jsxs)(e.h2,{id:"asinstanceof-vs-astypeof-vs-chiseltypeof",children:[(0,l.jsx)(e.code,{children:".asInstanceOf"})," vs ",(0,l.jsx)(e.code,{children:".asTypeOf"})," vs ",(0,l.jsx)(e.code,{children:"chiselTypeOf"})]}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".asInstanceOf"})," is a Scala runtime cast, usually used for telling the compiler\nthat you have more information than it can infer to convert Scala types:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"class ScalaCastingModule(gen: () => Bundle) extends Module {\n  val io = IO(Output(gen().asInstanceOf[MyBundle]))\n  io.foo := 0.U\n}\n"})}),"\n",(0,l.jsx)(e.p,{children:"This works if we do indeed have more information than the compiler:"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"elaborate(new ScalaCastingModule( () => new MyBundle(3)))\n"})}),"\n",(0,l.jsx)(e.p,{children:"But if we are wrong, we can get a Scala runtime exception:"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"class NotMyBundle extends Bundle {val baz = Bool()}\nelaborate(new ScalaCastingModule(() => new NotMyBundle()))\n// java.lang.ClassCastException: class repl.MdocSession$MdocApp$$anonfun$79$NotMyBundle$1 cannot be cast to class repl.MdocSession$MdocApp$MyBundle (repl.MdocSession$MdocApp$$anonfun$79$NotMyBundle$1 and repl.MdocSession$MdocApp$MyBundle are in unnamed module of loader scala.reflect.internal.util.AbstractFileClassLoader @527e2530)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.SpecifiedDirection$.specifiedDirection(DataImpl.scala:73)\n// \tat chisel3.Output$.apply(DataImpl.scala:320)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(ModuleImpl.scala:927)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule.<init>(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".asTypeOf"})," is a conversion from one ",(0,l.jsx)(e.code,{children:"Data"})," subclass to another.\nIt is commonly used to assign data to all-zeros, as described in ",(0,l.jsx)(e.a,{href:"https://www.chisel-lang.org/chisel3/docs/cookbooks/cookbook.html#how-can-i-tieoff-a-bundlevec-to-0",children:"this cookbook recipe"}),", but it can\nalso be used (though not really recommended, as there is no checking on\nwidth matches) to convert one Chisel type to another:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:'class SimilarToMyBundle(w: Int) extends Bundle{\n  val foobar = UInt((2*w).W)\n}\n\nemitSystemVerilog(new Module {\n  val in = IO(Input(new MyBundle(3)))\n  val out = IO(Output(new SimilarToMyBundle(3)))\n\n  out := in.asTypeOf(out)\n})\n// res12: String = """// Generated by CIRCT firtool-1.99.2\n// module _82_Anon(\n//   input        clock,\n//                reset,\n//   input  [2:0] in_foo,\n//                in_bar,\n//   output [5:0] out_foobar\n// );\n// \n//   assign out_foobar = {in_foo, in_bar};\n// endmodule\n// \n// """\n'})}),"\n",(0,l.jsxs)(e.p,{children:["In contrast to ",(0,l.jsx)(e.code,{children:"asInstanceOf"})," and ",(0,l.jsx)(e.code,{children:"asTypeOf"}),",\n",(0,l.jsx)(e.code,{children:"chiselTypeOf"})," is not a casting operation. It returns a Scala object which\ncan be used as shown in the examples above to create more Chisel types and\nhardware with the same Chisel type as existing hardware."]})]})}function d(a={}){const{wrapper:e}={...(0,t.R)(),...a.components};return e?(0,l.jsx)(e,{...a,children:(0,l.jsx)(r,{...a})}):r(a)}},8453:(a,e,n)=>{n.d(e,{R:()=>c,x:()=>o});var l=n(6540);const t={},s=l.createContext(t);function c(a){const e=l.useContext(s);return l.useMemo((function(){return"function"==typeof a?a(e):{...e,...a}}),[e,a])}function o(a){let e;return e=a.disableParentContext?"function"==typeof a.components?a.components(t):a.components||t:c(a.components),l.createElement(s.Provider,{value:e},a.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[2785],{1001:(a,e,n)=>{n.r(e),n.d(e,{assets:()=>i,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>p});var l=n(4848),t=n(8453);const s={layout:"docs",title:"Chisel Type vs Scala Type",section:"chisel3"},c="Chisel Type vs Scala Type",o={id:"explanations/chisel-type-vs-scala-type",title:"Chisel Type vs Scala Type",description:"The Scala compiler cannot distinguish between Chisel's representation of hardware such as false.B, Reg(Bool())",source:"@site/docs/explanations/chisel-type-vs-scala-type.md",sourceDirName:"explanations",slug:"/explanations/chisel-type-vs-scala-type",permalink:"/docs/explanations/chisel-type-vs-scala-type",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/chisel-type-vs-scala-type.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Chisel Type vs Scala Type",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Enumerations",permalink:"/docs/explanations/chisel-enum"},next:{title:"Combinational Circuits",permalink:"/docs/explanations/combinational-circuits"}},i={},p=[{value:"Scala Type vs Chisel Type vs Hardware",id:"scala-type-vs-chisel-type-vs-hardware",level:2},{value:"Chisel Type vs Hardware vs Literals",id:"chisel-type-vs-hardware-vs-literals",level:2},{value:"Chisel Type vs Hardware -- Specific Functions and Errors",id:"chisel-type-vs-hardware----specific-functions-and-errors",level:2},{value:"<code>.asInstanceOf</code> vs <code>.asTypeOf</code> vs <code>chiselTypeOf</code>",id:"asinstanceof-vs-astypeof-vs-chiseltypeof",level:2}];function r(a){const e={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,t.R)(),...a.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(e.header,{children:(0,l.jsx)(e.h1,{id:"chisel-type-vs-scala-type",children:"Chisel Type vs Scala Type"})}),"\n",(0,l.jsxs)(e.p,{children:["The Scala compiler cannot distinguish between Chisel's representation of hardware such as ",(0,l.jsx)(e.code,{children:"false.B"}),", ",(0,l.jsx)(e.code,{children:"Reg(Bool())"}),"\nand pure Chisel types (e.g. ",(0,l.jsx)(e.code,{children:"Bool()"}),"). You can get runtime errors passing a Chisel type when hardware is expected, and vice versa."]}),"\n",(0,l.jsx)(e.h2,{id:"scala-type-vs-chisel-type-vs-hardware",children:"Scala Type vs Chisel Type vs Hardware"}),"\n",(0,l.jsxs)(e.p,{children:["The ",(0,l.jsx)(e.em,{children:"Scala"})," type of the Data is recognized by the Scala compiler, such as ",(0,l.jsx)(e.code,{children:"Bool"}),", ",(0,l.jsx)(e.code,{children:"Decoupled[UInt]"})," or ",(0,l.jsx)(e.code,{children:"MyBundle"})," in"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"class MyBundle(w: Int) extends Bundle {\n  val foo = UInt(w.W)\n  val bar = UInt(w.W)\n}\n"})}),"\n",(0,l.jsxs)(e.p,{children:["The ",(0,l.jsx)(e.em,{children:"Chisel"})," type of a ",(0,l.jsx)(e.code,{children:"Data"})," is a Scala object. It captures all the fields actually present,\nby names, and their types including widths.\nFor example, ",(0,l.jsx)(e.code,{children:"MyBundle(3)"})," creates a Chisel Type with fields ",(0,l.jsx)(e.code,{children:"foo: UInt(3.W),  bar: UInt(3.W))"}),"."]}),"\n",(0,l.jsxs)(e.p,{children:["Hardware is ",(0,l.jsx)(e.code,{children:"Data"}),' that is "bound" to synthesizable hardware. For example ',(0,l.jsx)(e.code,{children:"false.B"})," or ",(0,l.jsx)(e.code,{children:"Reg(Bool())"}),".\nThe binding is what determines the actual directionality of each field, it is not a property of the Chisel type."]}),"\n",(0,l.jsxs)(e.p,{children:["A literal is a ",(0,l.jsx)(e.code,{children:"Data"})," that is respresentable as a literal value without being wrapped in Wire, Reg, or IO."]}),"\n",(0,l.jsx)(e.h2,{id:"chisel-type-vs-hardware-vs-literals",children:"Chisel Type vs Hardware vs Literals"}),"\n",(0,l.jsxs)(e.p,{children:["The below code demonstrates how objects with the same Scala type (",(0,l.jsx)(e.code,{children:"MyBundle"}),") can have different properties."]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"import chisel3.experimental.BundleLiterals._\n\nclass MyModule(gen: () => MyBundle) extends Module {\n                                                            //   Hardware   Literal\n    val xType:    MyBundle     = new MyBundle(3)            //      -          -\n    val dirXType: MyBundle     = Input(new MyBundle(3))     //      -          -\n    val xReg:     MyBundle     = Reg(new MyBundle(3))       //      x          -\n    val xIO:      MyBundle     = IO(Input(new MyBundle(3))) //      x          -\n    val xRegInit: MyBundle     = RegInit(xIO)               //      x          -\n    val xLit:     MyBundle     = xType.Lit(                 //      x          x\n      _.foo -> 0.U(3.W),\n      _.bar -> 0.U(3.W)\n    )\n    val y:        MyBundle = gen()                          //      ?          ?\n\n    // Need to initialize all hardware values\n    xReg := DontCare\n}\n"})}),"\n",(0,l.jsx)(e.h2,{id:"chisel-type-vs-hardware----specific-functions-and-errors",children:"Chisel Type vs Hardware -- Specific Functions and Errors"}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".asTypeOf"})," works for both hardware and Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"elaborate(new Module {\n  val chiselType = new MyBundle(3)\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val a = 0.U.asTypeOf(chiselType)\n  val b = 0.U.asTypeOf(hardware)\n})\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only ",(0,l.jsx)(e.code,{children:":="})," to hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val chiselType = new MyBundle(3)\n  chiselType := DontCare\n})\n// chisel3.package$ExpectedHardwareException: data to be connected 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21$$anon$3.<init>(chisel-type-vs-scala-type.md:90)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:88)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:88)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only ",(0,l.jsx)(e.code,{children:":="})," from hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = IO(new MyBundle(3))\n  val moarHardware = Wire(new MyBundle(3))\n  moarHardware := DontCare\n  hardware := moarHardware\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val hardware = IO(new MyBundle(3))\n  val chiselType = new MyBundle(3)\n  hardware := chiselType\n})\n// chisel3.package$ExpectedHardwareException: data to be connected 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27$$anon$5.<init>(chisel-type-vs-scala-type.md:115)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:112)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:112)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Have to pass hardware to ",(0,l.jsx)(e.code,{children:"chiselTypeOf"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val chiselType = chiselTypeOf(hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val chiselType = new MyBundle(3)\n  val crash = chiselTypeOf(chiselType)\n})\n// chisel3.package$ExpectedHardwareException: 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:138)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39.apply(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7.<init>(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:136)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:136)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Have to pass hardware to ",(0,l.jsx)(e.code,{children:"*Init"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val moarHardware = WireInit(hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val crash = WireInit(new MyBundle(3))\n})\n// chisel3.package$ExpectedHardwareException: wire initializer 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:160)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45.apply(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9.<init>(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:159)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:159)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can't pass hardware to a ",(0,l.jsx)(e.code,{children:"Wire"}),", ",(0,l.jsx)(e.code,{children:"Reg"}),", ",(0,l.jsx)(e.code,{children:"IO"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  val crash = Wire(hardware)\n})\n// chisel3.package$ExpectedChiselTypeException: wire type '_44_Anon.hardware: Wire[MyBundle]' must be a Chisel type, not hardware\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:182)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51.apply(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11.<init>(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:180)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:180)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".Lit"})," can only be called on Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardwareLit = (new MyBundle(3)).Lit(\n    _.foo -> 0.U,\n    _.bar -> 0.U\n  )\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"//Not this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  val crash = hardware.Lit(\n    _.foo -> 0.U,\n    _.bar -> 0.U\n  )\n})\n// chisel3.package$ExpectedChiselTypeException: bundle literal constructor model '_52_Anon.hardware: Wire[MyBundle]' must be a Chisel type, not hardware\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:206)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56.apply(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13.<init>(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:204)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:204)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only use a Chisel type within a ",(0,l.jsx)(e.code,{children:"Bundle"})," definition:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new Bundle {\n    val nested = new MyBundle(3)\n  })\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val crash = Wire(new Bundle {\n    val nested = Wire(new MyBundle(3))\n  })\n})\n// chisel3.package$ExpectedChiselTypeException: Bundle: AnonymousBundle contains hardware fields: nested: _60_Anon.crash_nested: Wire[MyBundle]\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:232)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62.apply(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16.<init>(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:231)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:231)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only call ",(0,l.jsx)(e.code,{children:"directionOf"})," on Hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"import chisel3.reflect.DataMirror\n\nclass Child extends Module{\n  val hardware = IO(new MyBundle(3))\n  hardware := DontCare\n  val chiselType = new MyBundle(3)\n}\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val child = Module(new Child())\n  child.hardware := DontCare\n  val direction = DataMirror.directionOf(child.hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\nval child = Module(new Child())\n  child.hardware := DontCare\n  val direction = DataMirror.directionOf(child.chiselType)\n})\n// chisel3.package$ExpectedHardwareException: node requested directionality on 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68$$anon$19.<init>(chisel-type-vs-scala-type.md:271)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:268)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:268)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can call ",(0,l.jsx)(e.code,{children:"specifiedDirectionOf"})," on hardware or Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"elaborate(new Module {\n  val child = Module(new Child())\n  child.hardware := DontCare\n  val direction0 = DataMirror.specifiedDirectionOf(child.hardware)\n  val direction1 = DataMirror.specifiedDirectionOf(child.chiselType)\n})\n"})}),"\n",(0,l.jsxs)(e.h2,{id:"asinstanceof-vs-astypeof-vs-chiseltypeof",children:[(0,l.jsx)(e.code,{children:".asInstanceOf"})," vs ",(0,l.jsx)(e.code,{children:".asTypeOf"})," vs ",(0,l.jsx)(e.code,{children:"chiselTypeOf"})]}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".asInstanceOf"})," is a Scala runtime cast, usually used for telling the compiler\nthat you have more information than it can infer to convert Scala types:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"class ScalaCastingModule(gen: () => Bundle) extends Module {\n  val io = IO(Output(gen().asInstanceOf[MyBundle]))\n  io.foo := 0.U\n}\n"})}),"\n",(0,l.jsx)(e.p,{children:"This works if we do indeed have more information than the compiler:"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"elaborate(new ScalaCastingModule( () => new MyBundle(3)))\n"})}),"\n",(0,l.jsx)(e.p,{children:"But if we are wrong, we can get a Scala runtime exception:"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"class NotMyBundle extends Bundle {val baz = Bool()}\nelaborate(new ScalaCastingModule(() => new NotMyBundle()))\n// java.lang.ClassCastException: class repl.MdocSession$MdocApp$$anonfun$79$NotMyBundle$1 cannot be cast to class repl.MdocSession$MdocApp$MyBundle (repl.MdocSession$MdocApp$$anonfun$79$NotMyBundle$1 and repl.MdocSession$MdocApp$MyBundle are in unnamed module of loader scala.reflect.internal.util.AbstractFileClassLoader @365431ae)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.SpecifiedDirection$.specifiedDirection(DataImpl.scala:73)\n// \tat chisel3.Output$.apply(DataImpl.scala:320)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(ModuleImpl.scala:927)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule.<init>(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".asTypeOf"})," is a conversion from one ",(0,l.jsx)(e.code,{children:"Data"})," subclass to another.\nIt is commonly used to assign data to all-zeros, as described in ",(0,l.jsx)(e.a,{href:"https://www.chisel-lang.org/chisel3/docs/cookbooks/cookbook.html#how-can-i-tieoff-a-bundlevec-to-0",children:"this cookbook recipe"}),", but it can\nalso be used (though not really recommended, as there is no checking on\nwidth matches) to convert one Chisel type to another:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:'class SimilarToMyBundle(w: Int) extends Bundle{\n  val foobar = UInt((2*w).W)\n}\n\nemitSystemVerilog(new Module {\n  val in = IO(Input(new MyBundle(3)))\n  val out = IO(Output(new SimilarToMyBundle(3)))\n\n  out := in.asTypeOf(out)\n})\n// res12: String = """// Generated by CIRCT firtool-1.100.0\n// module _82_Anon(\n//   input        clock,\n//                reset,\n//   input  [2:0] in_foo,\n//                in_bar,\n//   output [5:0] out_foobar\n// );\n// \n//   assign out_foobar = {in_foo, in_bar};\n// endmodule\n// \n// """\n'})}),"\n",(0,l.jsxs)(e.p,{children:["In contrast to ",(0,l.jsx)(e.code,{children:"asInstanceOf"})," and ",(0,l.jsx)(e.code,{children:"asTypeOf"}),",\n",(0,l.jsx)(e.code,{children:"chiselTypeOf"})," is not a casting operation. It returns a Scala object which\ncan be used as shown in the examples above to create more Chisel types and\nhardware with the same Chisel type as existing hardware."]})]})}function d(a={}){const{wrapper:e}={...(0,t.R)(),...a.components};return e?(0,l.jsx)(e,{...a,children:(0,l.jsx)(r,{...a})}):r(a)}},8453:(a,e,n)=>{n.d(e,{R:()=>c,x:()=>o});var l=n(6540);const t={},s=l.createContext(t);function c(a){const e=l.useContext(s);return l.useMemo((function(){return"function"==typeof a?a(e):{...e,...a}}),[e,a])}function o(a){let e;return e=a.disableParentContext?"function"==typeof a.components?a.components(t):a.components||t:c(a.components),l.createElement(s.Provider,{value:e},a.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/7cc2f0dc.54852e76.js b/assets/js/7cc2f0dc.97f33e9d.js
similarity index 87%
rename from assets/js/7cc2f0dc.54852e76.js
rename to assets/js/7cc2f0dc.97f33e9d.js
index 01ad206cb8..6b00abbc5b 100644
--- a/assets/js/7cc2f0dc.54852e76.js
+++ b/assets/js/7cc2f0dc.97f33e9d.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[3291],{9533:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>l,toc:()=>r});var t=a(4848),i=a(8453);const s={layout:"docs",title:"Polymorphism and Parameterization",section:"chisel3"},o="Polymorphism and Parameterization",l={id:"explanations/polymorphism-and-parameterization",title:"Polymorphism and Parameterization",description:"This section is advanced and can be skipped at first reading.",source:"@site/docs/explanations/polymorphism-and-parameterization.md",sourceDirName:"explanations",slug:"/explanations/polymorphism-and-parameterization",permalink:"/docs/explanations/polymorphism-and-parameterization",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/polymorphism-and-parameterization.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Polymorphism and Parameterization",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Operators",permalink:"/docs/explanations/operators"},next:{title:"Ports",permalink:"/docs/explanations/ports"}},d={},r=[{value:"Parameterized Functions",id:"parameterized-functions",level:2},{value:"Parameterized Classes",id:"parameterized-classes",level:2},{value:"Parametrization based on Modules",id:"parametrization-based-on-modules",level:2}];function c(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"polymorphism-and-parameterization",children:"Polymorphism and Parameterization"})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.em,{children:"This section is advanced and can be skipped at first reading."})}),"\n",(0,t.jsx)(n.p,{children:"Scala is a strongly typed language and uses parameterized types to specify generic functions and classes.\nIn this section, we show how Chisel users can define their own reusable functions and classes using parameterized classes."}),"\n",(0,t.jsx)(n.h2,{id:"parameterized-functions",children:"Parameterized Functions"}),"\n",(0,t.jsxs)(n.p,{children:["Earlier we defined ",(0,t.jsx)(n.code,{children:"Mux2"})," on ",(0,t.jsx)(n.code,{children:"Bool"}),", but now we show how we can define a generic multiplexer function.\nWe define this function as taking a boolean condition and con and alt arguments (corresponding to then and else expressions) of type ",(0,t.jsx)(n.code,{children:"T"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"def Mux[T <: Bits](c: Bool, con: T, alt: T): T = { ... }\n"})}),"\n",(0,t.jsxs)(n.p,{children:["where ",(0,t.jsx)(n.code,{children:"T"})," is required to be a subclass of ",(0,t.jsx)(n.code,{children:"Bits"}),".\nScala ensures that in each usage of ",(0,t.jsx)(n.code,{children:"Mux"}),", it can find a common superclass of the actual con and alt argument types,\notherwise it causes a Scala compilation type error.\nFor example,"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"Mux(c, UInt(10), UInt(11))\n"})}),"\n",(0,t.jsxs)(n.p,{children:["yields a ",(0,t.jsx)(n.code,{children:"UInt"})," wire because the ",(0,t.jsx)(n.code,{children:"con"})," and ",(0,t.jsx)(n.code,{children:"alt"})," arguments are each of type ",(0,t.jsx)(n.code,{children:"UInt"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameterized-classes",children:"Parameterized Classes"}),"\n",(0,t.jsxs)(n.p,{children:["Like parameterized functions, we can also parameterize classes to make them more reusable.\nFor instance, we can generalize the Filter class to use any kind of link.\nWe do so by parameterizing the ",(0,t.jsx)(n.code,{children:"FilterIO"})," class and defining the constructor to take a single argument ",(0,t.jsx)(n.code,{children:"gen"})," of type ",(0,t.jsx)(n.code,{children:"T"})," as below."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class FilterIO[T <: Data](gen: T) extends Bundle {\n  val x = Input(gen)\n  val y = Output(gen)\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["We can now define ",(0,t.jsx)(n.code,{children:"Filter"})," by defining a module class that also takes a link type constructor argument and passes it through to the ",(0,t.jsx)(n.code,{children:"FilterIO"})," interface constructor:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class Filter[T <: Data](gen: T) extends Module {\n  val io = IO(new FilterIO(gen))\n  // ...\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["We can now define a ",(0,t.jsx)(n.code,{children:"PLink"}),"-based ",(0,t.jsx)(n.code,{children:"Filter"})," as follows:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"val f = Module(new Filter(new PLink))\n"})}),"\n",(0,t.jsx)(n.p,{children:"A generic FIFO could be defined as follows:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.log2Up\n\nclass DataBundle extends Bundle {\n  val a = UInt(32.W)\n  val b = UInt(32.W)\n}\n\nclass Fifo[T <: Data](gen: T, n: Int) extends Module {\n  val io = IO(new Bundle {\n    val enqVal = Input(Bool())\n    val enqRdy = Output(Bool())\n    val deqVal = Output(Bool())\n    val deqRdy = Input(Bool())\n    val enqDat = Input(gen)\n    val deqDat = Output(gen)\n  })\n  val enqPtr     = RegInit(0.U((log2Up(n)).W))\n  val deqPtr     = RegInit(0.U((log2Up(n)).W))\n  val isFull     = RegInit(false.B)\n  val doEnq      = io.enqRdy && io.enqVal\n  val doDeq      = io.deqRdy && io.deqVal\n  val isEmpty    = !isFull && (enqPtr === deqPtr)\n  val deqPtrInc  = deqPtr + 1.U\n  val enqPtrInc  = enqPtr + 1.U\n  val isFullNext = Mux(doEnq && ~doDeq && (enqPtrInc === deqPtr),\n                         true.B, Mux(doDeq && isFull, false.B,\n                         isFull))\n  enqPtr := Mux(doEnq, enqPtrInc, enqPtr)\n  deqPtr := Mux(doDeq, deqPtrInc, deqPtr)\n  isFull := isFullNext\n  val ram = Mem(n, gen)\n  when (doEnq) {\n    ram(enqPtr) := io.enqDat\n  }\n  io.enqRdy := !isFull\n  io.deqVal := !isEmpty\n  ram(deqPtr) <> io.deqDat\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"An Fifo with 8 elements of type DataBundle could then be instantiated as:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"val fifo = Module(new Fifo(new DataBundle, 8))\n"})}),"\n",(0,t.jsx)(n.p,{children:"It is also possible to define a generic decoupled (ready/valid) interface:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class DecoupledIO[T <: Data](data: T) extends Bundle {\n  val ready = Input(Bool())\n  val valid = Output(Bool())\n  val bits  = Output(data)\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"This template can then be used to add a handshaking protocol to any\nset of signals:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class DecoupledDemo extends DecoupledIO(new DataBundle)\n"})}),"\n",(0,t.jsx)(n.p,{children:"The FIFO interface can be now be simplified as follows:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class Fifo[T <: Data](data: T, n: Int) extends Module {\n  val io = IO(new Bundle {\n    val enq = Flipped(new DecoupledIO(data))\n    val deq = new DecoupledIO(data)\n  })\n  // ...\n}\n"})}),"\n",(0,t.jsx)(n.h2,{id:"parametrization-based-on-modules",children:"Parametrization based on Modules"}),"\n",(0,t.jsx)(n.p,{children:"You can also parametrize modules based on other modules rather than just types. The following is an example of a module parametrized by other modules as opposed to e.g. types."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.RawModule\nimport chisel3.experimental.BaseModule\n\n// Provides a more specific interface since generic Module\n// provides no compile-time information on generic module's IOs.\ntrait MyAdder {\n    def in1: UInt\n    def in2: UInt\n    def out: UInt\n}\n\nclass Mod1 extends RawModule with MyAdder {\n    val in1 = IO(Input(UInt(8.W)))\n    val in2 = IO(Input(UInt(8.W)))\n    val out = IO(Output(UInt(8.W)))\n    out := in1 + in2\n}\n\nclass Mod2 extends RawModule with MyAdder {\n    val in1 = IO(Input(UInt(8.W)))\n    val in2 = IO(Input(UInt(8.W)))\n    val out = IO(Output(UInt(8.W)))\n    out := in1 - in2\n}\n\nclass X[T <: BaseModule with MyAdder](genT: => T) extends Module {\n    val io = IO(new Bundle {\n        val in1 = Input(UInt(8.W))\n        val in2 = Input(UInt(8.W))\n        val out = Output(UInt(8.W))\n    })\n    val subMod = Module(genT)\n    io.out := subMod.out\n    subMod.in1 := io.in1\n    subMod.in2 := io.in2\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"Output:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Mod1(\n  input  [7:0] in1,\n               in2,\n  output [7:0] out\n);\n\n  assign out = in1 + in2;\nendmodule\n\nmodule X(\n  input        clock,\n               reset,\n  input  [7:0] io_in1,\n               io_in2,\n  output [7:0] io_out\n);\n\n  Mod1 subMod (\n    .in1 (io_in1),\n    .in2 (io_in2),\n    .out (io_out)\n  );\nendmodule\n\n// Generated by CIRCT firtool-1.99.2\nmodule Mod2(\n  input  [7:0] in1,\n               in2,\n  output [7:0] out\n);\n\n  assign out = in1 - in2;\nendmodule\n\nmodule X(\n  input        clock,\n               reset,\n  input  [7:0] io_in1,\n               io_in2,\n  output [7:0] io_out\n);\n\n  Mod2 subMod (\n    .in1 (io_in1),\n    .in2 (io_in2),\n    .out (io_out)\n  );\nendmodule\n\n"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var t=a(6540);const i={},s=t.createContext(i);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[3291],{9533:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>l,toc:()=>r});var t=a(4848),i=a(8453);const s={layout:"docs",title:"Polymorphism and Parameterization",section:"chisel3"},o="Polymorphism and Parameterization",l={id:"explanations/polymorphism-and-parameterization",title:"Polymorphism and Parameterization",description:"This section is advanced and can be skipped at first reading.",source:"@site/docs/explanations/polymorphism-and-parameterization.md",sourceDirName:"explanations",slug:"/explanations/polymorphism-and-parameterization",permalink:"/docs/explanations/polymorphism-and-parameterization",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/polymorphism-and-parameterization.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Polymorphism and Parameterization",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Operators",permalink:"/docs/explanations/operators"},next:{title:"Ports",permalink:"/docs/explanations/ports"}},d={},r=[{value:"Parameterized Functions",id:"parameterized-functions",level:2},{value:"Parameterized Classes",id:"parameterized-classes",level:2},{value:"Parametrization based on Modules",id:"parametrization-based-on-modules",level:2}];function c(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"polymorphism-and-parameterization",children:"Polymorphism and Parameterization"})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.em,{children:"This section is advanced and can be skipped at first reading."})}),"\n",(0,t.jsx)(n.p,{children:"Scala is a strongly typed language and uses parameterized types to specify generic functions and classes.\nIn this section, we show how Chisel users can define their own reusable functions and classes using parameterized classes."}),"\n",(0,t.jsx)(n.h2,{id:"parameterized-functions",children:"Parameterized Functions"}),"\n",(0,t.jsxs)(n.p,{children:["Earlier we defined ",(0,t.jsx)(n.code,{children:"Mux2"})," on ",(0,t.jsx)(n.code,{children:"Bool"}),", but now we show how we can define a generic multiplexer function.\nWe define this function as taking a boolean condition and con and alt arguments (corresponding to then and else expressions) of type ",(0,t.jsx)(n.code,{children:"T"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"def Mux[T <: Bits](c: Bool, con: T, alt: T): T = { ... }\n"})}),"\n",(0,t.jsxs)(n.p,{children:["where ",(0,t.jsx)(n.code,{children:"T"})," is required to be a subclass of ",(0,t.jsx)(n.code,{children:"Bits"}),".\nScala ensures that in each usage of ",(0,t.jsx)(n.code,{children:"Mux"}),", it can find a common superclass of the actual con and alt argument types,\notherwise it causes a Scala compilation type error.\nFor example,"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"Mux(c, UInt(10), UInt(11))\n"})}),"\n",(0,t.jsxs)(n.p,{children:["yields a ",(0,t.jsx)(n.code,{children:"UInt"})," wire because the ",(0,t.jsx)(n.code,{children:"con"})," and ",(0,t.jsx)(n.code,{children:"alt"})," arguments are each of type ",(0,t.jsx)(n.code,{children:"UInt"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameterized-classes",children:"Parameterized Classes"}),"\n",(0,t.jsxs)(n.p,{children:["Like parameterized functions, we can also parameterize classes to make them more reusable.\nFor instance, we can generalize the Filter class to use any kind of link.\nWe do so by parameterizing the ",(0,t.jsx)(n.code,{children:"FilterIO"})," class and defining the constructor to take a single argument ",(0,t.jsx)(n.code,{children:"gen"})," of type ",(0,t.jsx)(n.code,{children:"T"})," as below."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class FilterIO[T <: Data](gen: T) extends Bundle {\n  val x = Input(gen)\n  val y = Output(gen)\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["We can now define ",(0,t.jsx)(n.code,{children:"Filter"})," by defining a module class that also takes a link type constructor argument and passes it through to the ",(0,t.jsx)(n.code,{children:"FilterIO"})," interface constructor:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class Filter[T <: Data](gen: T) extends Module {\n  val io = IO(new FilterIO(gen))\n  // ...\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["We can now define a ",(0,t.jsx)(n.code,{children:"PLink"}),"-based ",(0,t.jsx)(n.code,{children:"Filter"})," as follows:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"val f = Module(new Filter(new PLink))\n"})}),"\n",(0,t.jsx)(n.p,{children:"A generic FIFO could be defined as follows:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.log2Up\n\nclass DataBundle extends Bundle {\n  val a = UInt(32.W)\n  val b = UInt(32.W)\n}\n\nclass Fifo[T <: Data](gen: T, n: Int) extends Module {\n  val io = IO(new Bundle {\n    val enqVal = Input(Bool())\n    val enqRdy = Output(Bool())\n    val deqVal = Output(Bool())\n    val deqRdy = Input(Bool())\n    val enqDat = Input(gen)\n    val deqDat = Output(gen)\n  })\n  val enqPtr     = RegInit(0.U((log2Up(n)).W))\n  val deqPtr     = RegInit(0.U((log2Up(n)).W))\n  val isFull     = RegInit(false.B)\n  val doEnq      = io.enqRdy && io.enqVal\n  val doDeq      = io.deqRdy && io.deqVal\n  val isEmpty    = !isFull && (enqPtr === deqPtr)\n  val deqPtrInc  = deqPtr + 1.U\n  val enqPtrInc  = enqPtr + 1.U\n  val isFullNext = Mux(doEnq && ~doDeq && (enqPtrInc === deqPtr),\n                         true.B, Mux(doDeq && isFull, false.B,\n                         isFull))\n  enqPtr := Mux(doEnq, enqPtrInc, enqPtr)\n  deqPtr := Mux(doDeq, deqPtrInc, deqPtr)\n  isFull := isFullNext\n  val ram = Mem(n, gen)\n  when (doEnq) {\n    ram(enqPtr) := io.enqDat\n  }\n  io.enqRdy := !isFull\n  io.deqVal := !isEmpty\n  ram(deqPtr) <> io.deqDat\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"An Fifo with 8 elements of type DataBundle could then be instantiated as:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"val fifo = Module(new Fifo(new DataBundle, 8))\n"})}),"\n",(0,t.jsx)(n.p,{children:"It is also possible to define a generic decoupled (ready/valid) interface:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class DecoupledIO[T <: Data](data: T) extends Bundle {\n  val ready = Input(Bool())\n  val valid = Output(Bool())\n  val bits  = Output(data)\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"This template can then be used to add a handshaking protocol to any\nset of signals:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class DecoupledDemo extends DecoupledIO(new DataBundle)\n"})}),"\n",(0,t.jsx)(n.p,{children:"The FIFO interface can be now be simplified as follows:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class Fifo[T <: Data](data: T, n: Int) extends Module {\n  val io = IO(new Bundle {\n    val enq = Flipped(new DecoupledIO(data))\n    val deq = new DecoupledIO(data)\n  })\n  // ...\n}\n"})}),"\n",(0,t.jsx)(n.h2,{id:"parametrization-based-on-modules",children:"Parametrization based on Modules"}),"\n",(0,t.jsx)(n.p,{children:"You can also parametrize modules based on other modules rather than just types. The following is an example of a module parametrized by other modules as opposed to e.g. types."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.RawModule\nimport chisel3.experimental.BaseModule\n\n// Provides a more specific interface since generic Module\n// provides no compile-time information on generic module's IOs.\ntrait MyAdder {\n    def in1: UInt\n    def in2: UInt\n    def out: UInt\n}\n\nclass Mod1 extends RawModule with MyAdder {\n    val in1 = IO(Input(UInt(8.W)))\n    val in2 = IO(Input(UInt(8.W)))\n    val out = IO(Output(UInt(8.W)))\n    out := in1 + in2\n}\n\nclass Mod2 extends RawModule with MyAdder {\n    val in1 = IO(Input(UInt(8.W)))\n    val in2 = IO(Input(UInt(8.W)))\n    val out = IO(Output(UInt(8.W)))\n    out := in1 - in2\n}\n\nclass X[T <: BaseModule with MyAdder](genT: => T) extends Module {\n    val io = IO(new Bundle {\n        val in1 = Input(UInt(8.W))\n        val in2 = Input(UInt(8.W))\n        val out = Output(UInt(8.W))\n    })\n    val subMod = Module(genT)\n    io.out := subMod.out\n    subMod.in1 := io.in1\n    subMod.in2 := io.in2\n}\n"})}),"\n",(0,t.jsx)(n.p,{children:"Output:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Mod1(\n  input  [7:0] in1,\n               in2,\n  output [7:0] out\n);\n\n  assign out = in1 + in2;\nendmodule\n\nmodule X(\n  input        clock,\n               reset,\n  input  [7:0] io_in1,\n               io_in2,\n  output [7:0] io_out\n);\n\n  Mod1 subMod (\n    .in1 (io_in1),\n    .in2 (io_in2),\n    .out (io_out)\n  );\nendmodule\n\n// Generated by CIRCT firtool-1.100.0\nmodule Mod2(\n  input  [7:0] in1,\n               in2,\n  output [7:0] out\n);\n\n  assign out = in1 - in2;\nendmodule\n\nmodule X(\n  input        clock,\n               reset,\n  input  [7:0] io_in1,\n               io_in2,\n  output [7:0] io_out\n);\n\n  Mod2 subMod (\n    .in1 (io_in1),\n    .in2 (io_in2),\n    .out (io_out)\n  );\nendmodule\n\n"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var t=a(6540);const i={},s=t.createContext(i);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/7e1e4a75.b8ae9443.js b/assets/js/7e1e4a75.51497e19.js
similarity index 66%
rename from assets/js/7e1e4a75.b8ae9443.js
rename to assets/js/7e1e4a75.51497e19.js
index f549197708..6e89da7d37 100644
--- a/assets/js/7e1e4a75.b8ae9443.js
+++ b/assets/js/7e1e4a75.51497e19.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[5432],{7363:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=a(4848),t=a(8453),l=a(1871);const i={sidebar_position:0},s="General Cookbook",c={id:"cookbooks/cookbook",title:"General Cookbook",description:"Please note that these examples make use of Chisel's scala-style printing.",source:"@site/docs/cookbooks/cookbook.md",sourceDirName:"cookbooks",slug:"/cookbooks/cookbook",permalink:"/docs/cookbooks/cookbook",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/cookbook.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_position:0},sidebar:"chiselSidebar",previous:{title:"Cookbooks",permalink:"/docs/cookbooks"},next:{title:"Naming Cookbook",permalink:"/docs/cookbooks/naming"}},r={},d=[{value:"Type Conversions",id:"type-conversions",level:2},{value:"How do I create a UInt from an instance of a Bundle?",id:"how-do-i-create-a-uint-from-an-instance-of-a-bundle",level:3},{value:"How do I create a Bundle from a UInt?",id:"how-do-i-create-a-bundle-from-a-uint",level:3},{value:"How can I tieoff a Bundle/Vec to 0?",id:"how-can-i-tieoff-a-bundlevec-to-0",level:3},{value:"How do I create a Vec of Bools from a UInt?",id:"how-do-i-create-a-vec-of-bools-from-a-uint",level:3},{value:"How do I create a UInt from a Vec of Bool?",id:"how-do-i-create-a-uint-from-a-vec-of-bool",level:3},{value:"How do I connect a subset of Bundle fields?",id:"how-do-i-connect-a-subset-of-bundle-fields",level:3},{value:"Vectors and Registers",id:"vectors-and-registers",level:2},{value:"Can I make a 2D or 3D Vector?",id:"can-i-make-a-2d-or-3d-vector",level:3},{value:"How do I create a Vector of Registers?",id:"how-do-i-create-a-vector-of-registers",level:3},{value:"How do I create a Reg of type Vec?",id:"how-do-i-create-a-reg-of-type-vec",level:3},{value:"How do I partially reset an Aggregate Reg?",id:"how-do-i-partially-reset-an-aggregate-reg",level:3},{value:"Bundles",id:"bundles",level:2},{value:"How do I deal with aliased Bundle fields?",id:"how-do-i-deal-with-aliased-bundle-fields",level:3},{value:"1. 0-arity function parameters",id:"1-0-arity-function-parameters",level:4},{value:"Aliased Warning",id:"aliased-warning",level:5},{value:"2. By-name function parameters",id:"2-by-name-function-parameters",level:4},{value:"3. Directioned Bundle fields",id:"3-directioned-bundle-fields",level:4},{value:"4. Call <code>.cloneType</code> directly",id:"4-call-clonetype-directly",level:4},{value:"<a></a> How do I deal with the &quot;unable to clone&quot; error?",id:"-how-do-i-deal-with-the-unable-to-clone-error",level:3},{value:"How do I create a finite state machine (FSM)?",id:"how-do-i-create-a-finite-state-machine-fsm",level:2},{value:"How do I unpack a value (&quot;reverse concatenation&quot;) like in Verilog?",id:"how-do-i-unpack-a-value-reverse-concatenation-like-in-verilog",level:2},{value:"How do I do subword assignment (assign to some bits in a UInt)?",id:"how-do-i-do-subword-assignment-assign-to-some-bits-in-a-uint",level:2},{value:"How do I create an optional I/O?",id:"how-do-i-create-an-optional-io",level:2},{value:"How do I create I/O without a prefix?",id:"how-do-i-create-io-without-a-prefix",level:2},{value:"How do I override the implicit clock or reset within a Module?",id:"how-do-i-override-the-implicit-clock-or-reset-within-a-module",level:2},{value:"How do I minimize the number of bits used in an output vector?",id:"how-do-i-minimize-the-number-of-bits-used-in-an-output-vector",level:2},{value:"How do I resolve &quot;Dynamic index ... is too wide/narrow for extractee ...&quot;?",id:"how-do-i-resolve-dynamic-index--is-too-widenarrow-for-extractee-",level:2},{value:"Use bit extraction when the index is too wide",id:"use-bit-extraction-when-the-index-is-too-wide",level:4},{value:"How can I use Verilog &quot;case equality&quot; operators in Chisel?",id:"how-can-i-use-verilog-case-equality-operators-in-chisel",level:2},{value:"Predictable Naming",id:"predictable-naming",level:2},{value:"How do I get Chisel to name signals properly in blocks like when/withClockAndReset?",id:"how-do-i-get-chisel-to-name-signals-properly-in-blocks-like-whenwithclockandreset",level:3},{value:"How do I get Chisel to name the results of vector reads properly?",id:"how-do-i-get-chisel-to-name-the-results-of-vector-reads-properly",level:3},{value:"How can I dynamically set/parametrize the name of a module?",id:"how-can-i-dynamically-setparametrize-the-name-of-a-module",level:3},{value:"Directionality",id:"directionality",level:2},{value:"How do I strip directions from a bidirectional Bundle (or other Data)?",id:"how-do-i-strip-directions-from-a-bidirectional-bundle-or-other-data",level:3}];function u(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"general-cookbook",children:"General Cookbook"})}),"\n",(0,o.jsxs)(n.p,{children:["Please note that these examples make use of ",(0,o.jsx)(n.a,{href:"../explanations/printing#scala-style",children:"Chisel's scala-style printing"}),"."]}),"\n","\n",(0,o.jsx)(l.A,{toc:d}),"\n",(0,o.jsx)(n.h2,{id:"type-conversions",children:"Type Conversions"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-uint-from-an-instance-of-a-bundle",children:"How do I create a UInt from an instance of a Bundle?"}),"\n",(0,o.jsxs)(n.p,{children:["Call ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html#asUInt:chisel3.UInt",children:(0,o.jsx)(n.code,{children:"asUInt"})})," on the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html",children:(0,o.jsx)(n.code,{children:"Bundle"})})," instance."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(4.W)\n  val bar = UInt(4.W)\n}\n\nclass Foo extends Module {\n  val bundle = Wire(new MyBundle)\n  bundle.foo := 0xc.U\n  bundle.bar := 0x3.U\n  val uint = bundle.asUInt\n  printf(cf"$uint") // 195\n\n  // Test\n  assert(uint === 0xc3.U)\n}\n'})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-bundle-from-a-uint",children:"How do I create a Bundle from a UInt?"}),"\n",(0,o.jsxs)(n.p,{children:["Use the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html#asTypeOf%5BT%3C:chisel3.Data%5D(that:T):T",children:(0,o.jsx)(n.code,{children:"asTypeOf"})})," method to reinterpret the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html",children:(0,o.jsx)(n.code,{children:"UInt"})})," as the type of the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html",children:(0,o.jsx)(n.code,{children:"Bundle"})}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(4.W)\n  val bar = UInt(4.W)\n}\n\nclass Foo extends Module {\n  val uint = 0xb4.U\n  val bundle = uint.asTypeOf(new MyBundle)\n\n  printf(cf"$bundle") // Bundle(foo -> 11, bar -> 4)\n\n  // Test\n  assert(bundle.foo === 0xb.U)\n  assert(bundle.bar === 0x4.U)\n}\n'})}),"\n",(0,o.jsx)(n.h3,{id:"how-can-i-tieoff-a-bundlevec-to-0",children:"How can I tieoff a Bundle/Vec to 0?"}),"\n",(0,o.jsxs)(n.p,{children:["You can use ",(0,o.jsx)(n.code,{children:"asTypeOf"})," as above. If you don't want to worry about the type of the thing\nyou are tying off, you can use ",(0,o.jsx)(n.code,{children:"chiselTypeOf"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(4.W)\n  val bar = Vec(4, UInt(1.W))\n}\n\nclass Foo(typ: MyBundle) extends Module {\n  val bundleA = IO(Output(typ))\n  val bundleB = IO(Output(typ))\n\n  // typ is already a Chisel Data Type, so can use it directly here, but you\n  // need to know that bundleA is of type typ\n  bundleA := 0.U.asTypeOf(typ)\n\n  // bundleB is a Hardware data IO(Output(...)) so need to call chiselTypeOf,\n  // but this will work no matter the type of bundleB:\n  bundleB := 0.U.asTypeOf(chiselTypeOf(bundleB))\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-vec-of-bools-from-a-uint",children:"How do I create a Vec of Bools from a UInt?"}),"\n",(0,o.jsxs)(n.p,{children:["Use ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/VecInit$.html",children:(0,o.jsx)(n.code,{children:"VecInit"})})," given a ",(0,o.jsx)(n.code,{children:"Seq[Bool]"})," generated using the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html#asBools:Seq%5Bchisel3.Bool%5D",children:(0,o.jsx)(n.code,{children:"asBools"})})," method."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass Foo extends Module {\n  val uint = 0xc.U\n  val vec = VecInit(uint.asBools)\n\n  printf(cf"$vec") // Vec(0, 0, 1, 1)\n\n  // Test\n  assert(vec(0) === false.B)\n  assert(vec(1) === false.B)\n  assert(vec(2) === true.B)\n  assert(vec(3) === true.B)\n}\n'})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-uint-from-a-vec-of-bool",children:"How do I create a UInt from a Vec of Bool?"}),"\n",(0,o.jsxs)(n.p,{children:["Use the builtin function ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Vec.html#asUInt:chisel3.UInt",children:(0,o.jsx)(n.code,{children:"asUInt"})})]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass Foo extends Module {\n  val vec = VecInit(true.B, false.B, true.B, true.B)\n  val uint = vec.asUInt\n\n  printf(cf"$uint") // 13\n\n  // Test\n  // (remember leftmost Bool in Vec is low order bit)\n  assert(0xd.U === uint)\n\n}\n'})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-connect-a-subset-of-bundle-fields",children:"How do I connect a subset of Bundle fields?"}),"\n",(0,o.jsxs)(n.p,{children:["See the ",(0,o.jsx)(n.a,{href:"dataview#how-do-i-connect-a-subset-of-bundle-fields",children:"DataView cookbook"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"vectors-and-registers",children:"Vectors and Registers"}),"\n",(0,o.jsx)(n.h3,{id:"can-i-make-a-2d-or-3d-vector",children:"Can I make a 2D or 3D Vector?"}),"\n",(0,o.jsxs)(n.p,{children:["Yes. Using ",(0,o.jsx)(n.code,{children:"VecInit"})," you can make Vectors that hold Vectors of Chisel types. Methods ",(0,o.jsx)(n.code,{children:"fill"})," and ",(0,o.jsx)(n.code,{children:"tabulate"})," make these multi-dimensional Vectors."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(4.W)\n  val bar = UInt(4.W)\n}\n\nclass Foo extends Module {\n  //2D Fill\n  val twoDVec = VecInit.fill(2, 3)(5.U)\n  //3D Fill\n  val myBundle = Wire(new MyBundle)\n  myBundle.foo := 0xc.U\n  myBundle.bar := 0x3.U\n  val threeDVec = VecInit.fill(1, 2, 3)(myBundle)\n  assert(threeDVec(0)(0)(0).foo === 0xc.U && threeDVec(0)(0)(0).bar === 0x3.U)\n\n  //2D Tabulate\n  val indexTiedVec = VecInit.tabulate(2, 2){ (x, y) => (x + y).U }\n  assert(indexTiedVec(0)(0) === 0.U)\n  assert(indexTiedVec(0)(1) === 1.U)\n  assert(indexTiedVec(1)(0) === 1.U)\n  assert(indexTiedVec(1)(1) === 2.U)\n  //3D Tabulate\n  val indexTiedVec3D = VecInit.tabulate(2, 3, 4){ (x, y, z) => (x + y * z).U }\n  assert(indexTiedVec3D(0)(0)(0) === 0.U)\n  assert(indexTiedVec3D(1)(1)(1) === 2.U)\n  assert(indexTiedVec3D(1)(1)(2) === 3.U)\n  assert(indexTiedVec3D(1)(1)(3) === 4.U)\n  assert(indexTiedVec3D(1)(2)(3) === 7.U)\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-vector-of-registers",children:"How do I create a Vector of Registers?"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"Rule!  Use Reg of Vec not Vec of Reg!"})}),"\n",(0,o.jsxs)(n.p,{children:["You create a ",(0,o.jsx)(n.a,{href:"#how-do-i-create-a-reg-of-type-vec",children:"Reg of type Vec"}),". Because Vecs are a ",(0,o.jsx)(n.em,{children:"type"})," (like ",(0,o.jsx)(n.code,{children:"UInt"}),", ",(0,o.jsx)(n.code,{children:"Bool"}),") rather than a ",(0,o.jsx)(n.em,{children:"value"}),", we must bind the Vec to some concrete ",(0,o.jsx)(n.em,{children:"value"}),"."]}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-reg-of-type-vec",children:"How do I create a Reg of type Vec?"}),"\n",(0,o.jsxs)(n.p,{children:["For more information, the API Documentation for ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Vec.html",children:(0,o.jsx)(n.code,{children:"Vec"})})," provides more information."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass Foo extends Module {\n  val regOfVec = Reg(Vec(4, UInt(32.W))) // Register of 32-bit UInts\n  regOfVec(0) := 123.U                   // Assignments to elements of the Vec\n  regOfVec(1) := 456.U\n  regOfVec(2) := 789.U\n  regOfVec(3) := regOfVec(0)\n\n  // Reg of Vec of 32-bit UInts initialized to zero\n  //   Note that Seq.fill constructs 4 32-bit UInt literals with the value 0\n  //   VecInit(...) then constructs a Wire of these literals\n  //   The Reg is then initialized to the value of the Wire (which gives it the same type)\n  val initRegOfVec = RegInit(VecInit(Seq.fill(4)(0.U(32.W))))\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-partially-reset-an-aggregate-reg",children:"How do I partially reset an Aggregate Reg?"}),"\n",(0,o.jsxs)(n.p,{children:["The easiest way is to use a partially-specified ",(0,o.jsx)(n.a,{href:"../appendix/experimental-features#bundle-literals",children:"Bundle Literal"}),"\nor ",(0,o.jsx)(n.a,{href:"../appendix/experimental-features#vec-literals",children:"Vec Literal"})," to match the type of the Reg."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.BundleLiterals._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(8.W)\n  val bar = UInt(8.W)\n}\n\nclass MyModule extends Module {\n  // Only .foo will be reset, .bar will have no reset value\n  val reg = RegInit((new MyBundle).Lit(_.foo -> 123.U))\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["If your initial value is not a literal, or if you just prefer, you can use a\nWire as the initial value for the Reg. Simply connect fields to ",(0,o.jsx)(n.code,{children:"DontCare"})," that\nyou do not wish to be reset."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class MyModule2 extends Module {\n  val reg = RegInit({\n    // The wire could be constructed before the reg rather than in the RegInit scope,\n    // but this style has nice lexical scoping behavior, keeping the Wire private\n    val init = Wire(new MyBundle)\n    init := DontCare // No fields will be reset\n    init.foo := 123.U // Last connect override, .foo is reset\n    init\n  })\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"bundles",children:"Bundles"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-deal-with-aliased-bundle-fields",children:"How do I deal with aliased Bundle fields?"}),"\n",(0,o.jsxs)(n.p,{children:["Following the ",(0,o.jsx)(n.code,{children:"gen"})," pattern when creating Bundles can result in some opaque error messages:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class AliasedBundle[T <: Data](gen: T) extends Bundle {\n  val foo = gen\n  val bar = gen\n}\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new Top(new AliasedBundle(UInt(8.W))))\n// chisel3.AliasedAggregateFieldException: AliasedBundle contains aliased fields named (foo,bar)\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:298)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp17$Top.<init>(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$$anonfun$55$$anonfun$apply$43.apply(cookbook.md:317)\n// \tat repl.MdocSession$MdocApp17$$anonfun$55$$anonfun$apply$43.apply(cookbook.md:317)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This error is saying that fields ",(0,o.jsx)(n.code,{children:"foo"})," and ",(0,o.jsx)(n.code,{children:"bar"})," of ",(0,o.jsx)(n.code,{children:"AliasedBundle"})," are the\nexact same object in memory.\nThis is a problem for Chisel because we need to be able to distinguish uses of\n",(0,o.jsx)(n.code,{children:"foo"})," and ",(0,o.jsx)(n.code,{children:"bar"})," but cannot when they are referentially the same."]}),"\n",(0,o.jsx)(n.p,{children:"Note that the following example looks different but will give you exactly the same issue:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class AlsoAliasedBundle[T <: Data](val gen: T) extends Bundle {\n                                // ^ This val makes `gen` a field, just like `foo`\n  val foo = gen\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["By making ",(0,o.jsx)(n.code,{children:"gen"})," a ",(0,o.jsx)(n.code,{children:"val"}),", it becomes a public field of the ",(0,o.jsx)(n.code,{children:"class"}),", just like ",(0,o.jsx)(n.code,{children:"foo"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new Top(new AlsoAliasedBundle(UInt(8.W))))\n// chisel3.AliasedAggregateFieldException: AlsoAliasedBundle contains aliased fields named (gen,foo)\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:298)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp17$Top.<init>(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$$anonfun$57$$anonfun$apply$44.apply(cookbook.md:336)\n// \tat repl.MdocSession$MdocApp17$$anonfun$57$$anonfun$apply$44.apply(cookbook.md:336)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsx)(n.p,{children:"There are several ways to solve this issue with their own advantages and disadvantages."}),"\n",(0,o.jsx)(n.h4,{id:"1-0-arity-function-parameters",children:"1. 0-arity function parameters"}),"\n",(0,o.jsx)(n.p,{children:"Instead of passing an object as a parameter, you can pass a 0-arity function (a function with no arguments):"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class UsingAFunctionBundle[T <: Data](gen: () => T) extends Bundle {\n  val foo = gen()\n  val bar = gen()\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that the type of ",(0,o.jsx)(n.code,{children:"gen"})," is now ",(0,o.jsx)(n.code,{children:"() => T"}),".\nBecause it is now a function and not a subtype of ",(0,o.jsx)(n.code,{children:"Data"}),", you can safely make ",(0,o.jsx)(n.code,{children:"gen"})," a ",(0,o.jsx)(n.code,{children:"val"})," without\nit becoming a hardware field of the ",(0,o.jsx)(n.code,{children:"Bundle"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Note that this also means you must pass ",(0,o.jsx)(n.code,{children:"gen"})," as a function, for example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"chisel3.docs.emitSystemVerilog(new Top(new UsingAFunctionBundle(() => UInt(8.W))))\n"})}),"\n",(0,o.jsx)(n.h5,{id:"aliased-warning",children:"Aliased Warning"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Warning"}),": you must ensure that ",(0,o.jsx)(n.code,{children:"gen"})," creates fresh objects rather than capturing an already constructed value:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class MisusedFunctionArguments extends Module {\n  // This usage is correct\n  val in = IO(Input(new UsingAFunctionBundle(() => UInt(8.W))))\n\n  // This usage is incorrect\n  val fizz = UInt(8.W)\n  val out = IO(Output(new UsingAFunctionBundle(() => fizz)))\n}\ngetVerilogString(new MisusedFunctionArguments)\n// chisel3.AutoClonetypeException: The bundle plugin was unable to clone UsingAFunctionBundle that has field 'bar' aliased with base UsingAFunctionBundle.This likely happened because you tried nesting Data arguments inside of other data structures. Try wrapping the field(s) in Input(...), Output(...), or Flipped(...) if appropriate. As a last resort, you can call chisel3.reflect.DataMirror.internal.chiselTypeClone on any nested Data arguments. See the cookbook entry 'How do I deal with the \"unable to clone\" error?' for more details.\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51$$anonfun$apply$52.apply(cookbook.md:367)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51$$anonfun$apply$52.apply(cookbook.md:367)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(ModuleImpl.scala:927)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51.apply(cookbook.md:367)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51.apply(cookbook.md:367)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62.apply(cookbook.md:367)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62.apply(cookbook.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1.<init>(cookbook.md:367)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$$anonfun$apply$55.apply(cookbook.md:369)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$$anonfun$apply$55.apply(cookbook.md:369)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["In the above example, value ",(0,o.jsx)(n.code,{children:"fizz"})," and fields ",(0,o.jsx)(n.code,{children:"foo"})," and ",(0,o.jsx)(n.code,{children:"bar"})," of ",(0,o.jsx)(n.code,{children:"out"})," are all the same object in memory."]}),"\n",(0,o.jsx)(n.h4,{id:"2-by-name-function-parameters",children:"2. By-name function parameters"}),"\n",(0,o.jsxs)(n.p,{children:["Functionally the same as (1) but with more subtle syntax, you can use ",(0,o.jsx)(n.a,{href:"https://docs.scala-lang.org/tour/by-name-parameters.html",children:"Scala by-name function parameters"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class UsingByNameParameters[T <: Data](gen: => T) extends Bundle {\n  val foo = gen\n  val bar = gen\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["With this usage, you do not include ",(0,o.jsx)(n.code,{children:"() =>"})," when passing the argument:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"chisel3.docs.emitSystemVerilog(new Top(new UsingByNameParameters(UInt(8.W))))\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that as this is just syntactic sugar over (1), the ",(0,o.jsx)(n.a,{href:"#aliased-warning",children:"same warning applies"}),"."]}),"\n",(0,o.jsx)(n.h4,{id:"3-directioned-bundle-fields",children:"3. Directioned Bundle fields"}),"\n",(0,o.jsxs)(n.p,{children:["You can alternatively wrap the fields with ",(0,o.jsx)(n.code,{children:"Output(...)"}),", which creates fresh instances of the passed argument.\nChisel treats ",(0,o.jsx)(n.code,{children:"Output"}),' as the "default direction" so if all fields are outputs, the ',(0,o.jsx)(n.code,{children:"Bundle"})," is functionally equivalent to a ",(0,o.jsx)(n.code,{children:"Bundle"})," with no directioned fields."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class DirectionedBundle[T <: Data](gen: T) extends Bundle {\n  val foo = Output(gen)\n  val bar = Output(gen)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This approach is admittedly a little ugly and may mislead others reading the code because it implies that this Bundle is intended to be used as an ",(0,o.jsx)(n.code,{children:"Output"}),"."]}),"\n",(0,o.jsxs)(n.h4,{id:"4-call-clonetype-directly",children:["4. Call ",(0,o.jsx)(n.code,{children:".cloneType"})," directly"]}),"\n",(0,o.jsxs)(n.p,{children:["You can also just call ",(0,o.jsx)(n.code,{children:".cloneType"})," on your ",(0,o.jsx)(n.code,{children:"gen"})," argument directly.\nWhile we try to hide this implementation detail from the user, ",(0,o.jsx)(n.code,{children:".cloneType"})," is the mechanism by which Chisel creates fresh instances of ",(0,o.jsx)(n.code,{children:"Data"})," objects:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class UsingCloneTypeBundle[T <: Data](gen: T) extends Bundle {\n  val foo = gen.cloneType\n  val bar = gen.cloneType\n}\n"})}),"\n",(0,o.jsxs)(n.h3,{id:"-how-do-i-deal-with-the-unable-to-clone-error",children:[(0,o.jsx)("a",{name:"bundle-unable-to-clone"}),' How do I deal with the "unable to clone" error?']}),"\n",(0,o.jsx)(n.p,{children:'Most Chisel objects need to be cloned in order to differentiate between the\nsoftware representation of the bundle field from its "bound" hardware\nrepresentation, where "binding" is the process of generating a hardware\ncomponent. For Bundle fields, this cloning is supposed to happen automatically\nwith a compiler plugin.'}),"\n",(0,o.jsxs)(n.p,{children:["In some cases though, the plugin may not be able to clone the Bundle fields. The\nmost common case for when this happens is when the ",(0,o.jsx)(n.code,{children:"chisel3.Data"})," part of the\nBundle field is nested inside some other data structure and the compiler plugin\nis unable to figure out how to clone the entire structure. It is best to avoid\nsuch nested structures."]}),"\n",(0,o.jsxs)(n.p,{children:["There are a few ways around this issue - you can try wrapping the problematic\nfields in Input(...), Output(...), or Flipped(...) if appropriate. You can also\ntry manually cloning each field in the Bundle using the ",(0,o.jsx)(n.code,{children:"chiselTypeClone"})," method\nin ",(0,o.jsx)(n.code,{children:"chisel3.reflect.DataMirror"}),". Here's an example with the Bundle whose fields\nwon't get cloned:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'class CustomBundleBroken(elts: (String, Data)*) extends Record {\n  val elements = ListMap(elts: _*)\n\n  def apply(elt: String): Data = elements(elt)\n}\n\nclass NewModule extends Module {\n  val out = Output(UInt(8.W))\n  val recordType = new CustomBundleBroken("fizz" -> UInt(16.W), "buzz" -> UInt(16.W))\n  val record = Wire(recordType)\n  val uint = record.asUInt\n  val record2 = uint.asTypeOf(recordType)\n  out := record\n}\ngetVerilogString(new NewModule)\n// chisel3.AutoClonetypeException: The bundle plugin was unable to clone CustomBundleBroken$1 that has field \'fizz\' aliased with base CustomBundleBroken$1.This likely happened because you tried nesting Data arguments inside of other data structures. Try wrapping the field(s) in Input(...), Output(...), or Flipped(...) if appropriate. As a last resort, you can call chisel3.reflect.DataMirror.internal.chiselTypeClone on any nested Data arguments. See the cookbook entry \'How do I deal with the "unable to clone" error?\' for more details.\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74$$anonfun$apply$63.apply(cookbook.md:441)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74$$anonfun$apply$63.apply(cookbook.md:441)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74.apply(cookbook.md:441)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74.apply(cookbook.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1.<init>(cookbook.md:441)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$$anonfun$apply$67.apply(cookbook.md:446)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$$anonfun$apply$67.apply(cookbook.md:446)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n'})}),"\n",(0,o.jsxs)(n.p,{children:["You can use ",(0,o.jsx)(n.code,{children:"chiselTypeClone"})," to clone the elements as:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3.reflect.DataMirror\nimport chisel3.experimental.requireIsChiselType\n\nclass CustomBundleFixed(elts: (String, Data)*) extends Record {\n  val elements = ListMap(elts.map {\n    case (field, elt) =>\n      requireIsChiselType(elt)\n      field -> DataMirror.internal.chiselTypeClone(elt)\n  }: _*)\n\n  def apply(elt: String): Data = elements(elt)\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-create-a-finite-state-machine-fsm",children:"How do I create a finite state machine (FSM)?"}),"\n",(0,o.jsxs)(n.p,{children:["The advised way is to use ",(0,o.jsx)(n.code,{children:"ChiselEnum"})," to construct enumerated types representing the state of the FSM.\nState transitions are then handled with ",(0,o.jsx)(n.code,{children:"switch"}),"/",(0,o.jsx)(n.code,{children:"is"})," and ",(0,o.jsx)(n.code,{children:"when"}),"/",(0,o.jsx)(n.code,{children:".elsewhen"}),"/",(0,o.jsx)(n.code,{children:".otherwise"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.{switch, is}\n\nobject DetectTwoOnes {\n  object State extends ChiselEnum {\n    val sNone, sOne1, sTwo1s = Value\n  }\n}\n\n/* This FSM detects two 1's one after the other */\nclass DetectTwoOnes extends Module {\n  import DetectTwoOnes.State\n  import DetectTwoOnes.State._\n\n  val io = IO(new Bundle {\n    val in = Input(Bool())\n    val out = Output(Bool())\n    val state = Output(State())\n  })\n\n  val state = RegInit(sNone)\n\n  io.out := (state === sTwo1s)\n  io.state := state\n\n  switch (state) {\n    is (sNone) {\n      when (io.in) {\n        state := sOne1\n      }\n    }\n    is (sOne1) {\n      when (io.in) {\n        state := sTwo1s\n      } .otherwise {\n        state := sNone\n      }\n    }\n    is (sTwo1s) {\n      when (!io.in) {\n        state := sNone\n      }\n    }\n  }\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note: the ",(0,o.jsx)(n.code,{children:"is"})," statement can take multiple conditions e.g. ",(0,o.jsx)(n.code,{children:"is (sTwo1s, sOne1) { ... }"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-unpack-a-value-reverse-concatenation-like-in-verilog",children:'How do I unpack a value ("reverse concatenation") like in Verilog?'}),"\n",(0,o.jsxs)(n.p,{children:["In Verilog, you can do something like the following which will unpack a the value ",(0,o.jsx)(n.code,{children:"z"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"wire [1:0] a;\nwire [3:0] b;\nwire [2:0] c;\nwire [8:0] z = [...];\nassign {a,b,c} = z;\n"})}),"\n",(0,o.jsx)(n.p,{children:"Unpacking often corresponds to reinterpreting an unstructured data type as a structured data type.\nFrequently, this structured type is used prolifically in the design, and has been declared as in the following example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyBundle extends Bundle {\n  val a = UInt(2.W)\n  val b = UInt(4.W)\n  val c = UInt(3.W)\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"The easiest way to accomplish this in Chisel would be:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'class Foo extends Module {\n  val z = Wire(UInt(9.W))\n  z := DontCare // This is a dummy connection\n  val unpacked = z.asTypeOf(new MyBundle)\n  printf("%d", unpacked.a)\n  printf("%d", unpacked.b)\n  printf("%d", unpacked.c)\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["If you ",(0,o.jsx)(n.strong,{children:"really"})," need to do this for a one-off case (Think thrice! It is likely you can better structure the code using bundles), then rocket-chip has a ",(0,o.jsx)(n.a,{href:"https://github.com/freechipsproject/rocket-chip/blob/723af5e6b69e07b5f94c46269a208a8d65e9d73b/src/main/scala/util/Misc.scala#L140",children:"Split utility"})," which can accomplish this."]}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-do-subword-assignment-assign-to-some-bits-in-a-uint",children:"How do I do subword assignment (assign to some bits in a UInt)?"}),"\n",(0,o.jsxs)(n.p,{children:["You may try to do something like the following where you want to assign only some bits of a Chisel type.\nBelow, the left-hand side connection to ",(0,o.jsx)(n.code,{children:"io.out(0)"})," is not allowed."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass Foo extends Module {\n  val io = IO(new Bundle {\n    val bit = Input(Bool())\n    val out = Output(UInt(10.W))\n  })\n  io.out(0) := io.bit\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"If you try to compile this, you will get an error."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new Foo)\n// chisel3.package$ChiselException: Cannot reassign to read-only Foo.?: OpResult[Bool]\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp26$Foo.<init>(cookbook.md:583)\n// \tat repl.MdocSession$MdocApp26$$anonfun$104$$anonfun$apply$90.apply(cookbook.md:591)\n// \tat repl.MdocSession$MdocApp26$$anonfun$104$$anonfun$apply$90.apply(cookbook.md:591)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Chisel3 ",(0,o.jsx)(n.em,{children:"does not support subword assignment"}),".\nThe reason for this is that subword assignment generally hints at a better abstraction with an aggregate/structured types, i.e., a ",(0,o.jsx)(n.code,{children:"Bundle"})," or a ",(0,o.jsx)(n.code,{children:"Vec"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["If you must express it this way, one approach is to blast your ",(0,o.jsx)(n.code,{children:"UInt"})," to a ",(0,o.jsx)(n.code,{children:"Vec"})," of ",(0,o.jsx)(n.code,{children:"Bool"})," and back:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass Foo extends Module {\n  val io = IO(new Bundle {\n    val in = Input(UInt(10.W))\n    val bit = Input(Bool())\n    val out = Output(UInt(10.W))\n  })\n  val bools = VecInit(io.in.asBools)\n  bools(0) := io.bit\n  io.out := bools.asUInt\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-create-an-optional-io",children:"How do I create an optional I/O?"}),"\n",(0,o.jsxs)(n.p,{children:["The following example is a module which includes the optional port ",(0,o.jsx)(n.code,{children:"out2"})," only if the given parameter is ",(0,o.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass ModuleWithOptionalIOs(flag: Boolean) extends Module {\n  val io = IO(new Bundle {\n    val in = Input(UInt(12.W))\n    val out = Output(UInt(12.W))\n    val out2 = if (flag) Some(Output(UInt(12.W))) else None\n  })\n\n  io.out := io.in\n  if (flag) {\n    io.out2.get := io.in\n  }\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The following is an example where an entire ",(0,o.jsx)(n.code,{children:"IO"})," is optional:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass ModuleWithOptionalIO(flag: Boolean) extends Module {\n  val in = if (flag) Some(IO(Input(Bool()))) else None\n  val out = IO(Output(Bool()))\n\n  out := in.getOrElse(false.B)\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-create-io-without-a-prefix",children:"How do I create I/O without a prefix?"}),"\n",(0,o.jsxs)(n.p,{children:["In most cases, you can simply call ",(0,o.jsx)(n.code,{children:"IO"})," multiple times:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyModule extends Module {\n  val in = IO(Input(UInt(8.W)))\n  val out = IO(Output(UInt(8.W)))\n\n  out := in +% 1.U\n}\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule MyModule(\n  input        clock,\n               reset,\n  input  [7:0] in,\n  output [7:0] out\n);\n\n  assign out = in + 8'h1;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.p,{children:["If you have a ",(0,o.jsx)(n.code,{children:"Bundle"})," from which you would like to create ports without the\nnormal ",(0,o.jsx)(n.code,{children:"val"})," prefix, you can use ",(0,o.jsx)(n.code,{children:"FlatIO"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = Input(UInt(8.W))\n  val bar = Output(UInt(8.W))\n}\n\nclass MyModule extends Module {\n  val io = FlatIO(new MyBundle)\n\n  io.bar := io.foo +% 1.U\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that ",(0,o.jsx)(n.code,{children:"io_"})," is nowhere to be seen!"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule MyModule(\n  input        clock,\n               reset,\n  input  [7:0] foo,\n  output [7:0] bar\n);\n\n  assign bar = foo + 8'h1;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-override-the-implicit-clock-or-reset-within-a-module",children:"How do I override the implicit clock or reset within a Module?"}),"\n",(0,o.jsxs)(n.p,{children:["To change the clock or reset for a region of code, use ",(0,o.jsx)(n.code,{children:"withClock"}),", ",(0,o.jsx)(n.code,{children:"withReset"}),", or ",(0,o.jsx)(n.code,{children:"withClockAndReset"}),".\nSee ",(0,o.jsx)(n.a,{href:"../explanations/multi-clock",children:"Multiple Clock Domains"})," for examples and details."]}),"\n",(0,o.jsxs)(n.p,{children:["To override the clock or reset for the entire scope of the ",(0,o.jsx)(n.code,{children:"Module"}),", you can mixin the ",(0,o.jsx)(n.code,{children:"ImplicitClock"})," and ",(0,o.jsx)(n.code,{children:"ImplicitReset"})," traits."]}),"\n",(0,o.jsx)(n.p,{children:'For example, you could "gate" the default implicit clock as follows:'}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass MyModule extends Module with ImplicitClock {\n  val gate = IO(Input(Bool()))\n  val in = IO(Input(UInt(8.W)))\n  val out = IO(Output(UInt(8.W)))\n  // We could just assign this to val implicitClock, but this allows us to give it a custom name\n  val gatedClock = (clock.asBool || gate).asClock\n  // The trait requires us to implement this method referring to the clock\n  // Note that this is a def, but the actual clock value must be assigned to a val\n  override protected def implicitClock = gatedClock\n\n  val r = Reg(UInt(8.W))\n  out := r\n  r := in\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"This gives the following Verilog:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule MyModule(\n  input        clock,\n               reset,\n               gate,\n  input  [7:0] in,\n  output [7:0] out\n);\n\n  wire       gatedClock = clock | gate;\n  reg  [7:0] r;\n  always @(posedge gatedClock)\n    r <= in;\n  assign out = r;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.p,{children:["If you do not care about the name of the overriden clock, you can just assign it to ",(0,o.jsx)(n.code,{children:"val implicitClock"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"override protected val implicitClock = (clock.asBool || gate).asClock\n"})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"ImplicitReset"})," works analogously to ",(0,o.jsx)(n.code,{children:"ImplicitClock"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-minimize-the-number-of-bits-used-in-an-output-vector",children:"How do I minimize the number of bits used in an output vector?"}),"\n",(0,o.jsxs)(n.p,{children:["Use inferred width and a ",(0,o.jsx)(n.code,{children:"Seq"})," instead of a ",(0,o.jsx)(n.code,{children:"Vec"}),":"]}),"\n",(0,o.jsx)(n.p,{children:"Consider:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\n// Count the number of set bits up to and including each bit position\nclass CountBits(width: Int) extends Module {\n  val bits = IO(Input(UInt(width.W)))\n  val countVector = IO(Output(Vec(width, UInt())))\n\n  private val countSequence = Seq.tabulate(width)(i => Wire(UInt()))\n  countSequence.zipWithIndex.foreach { case (port, i) =>\n    port := util.PopCount(bits(i, 0))\n  }\n  countVector := countSequence\n}\n\nclass Top(width: Int) extends Module {\n  val countBits = Module(new CountBits(width))\n  countBits.bits :<>= DontCare\n  dontTouch(countBits.bits)\n  dontTouch(countBits.countVector)\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Note that top modules or public modules cannot have unknown widths."}),"\n",(0,o.jsxs)(n.p,{children:["Unlike ",(0,o.jsx)(n.code,{children:"Vecs"})," which represent a singular Chisel type and must have the same width for every element,\n",(0,o.jsx)(n.code,{children:"Seq"})," is a purely Scala construct, so their elements are independent from the perspective of Chisel and can have different widths."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule CountBits(\n  input  [3:0] bits,\n  output [2:0] countVector_0,\n               countVector_1,\n               countVector_2,\n               countVector_3\n);\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-resolve-dynamic-index--is-too-widenarrow-for-extractee-",children:'How do I resolve "Dynamic index ... is too wide/narrow for extractee ..."?'}),"\n",(0,o.jsx)(n.p,{children:'Chisel will warn if a dynamic index is not the correctly-sized width for indexing a Vec or UInt.\n"Correctly-sized" means that the width of the index should be the log2 of the size of the indexee.\nIf the indexee is a non-power-of-2 size, use the ceiling of the log2 result.'}),"\n",(0,o.jsxs)(n.p,{children:["When the index does not have enough bits to address all entries or bits in the extractee, you can ",(0,o.jsx)(n.code,{children:".pad"})," the index to increase the width."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooNarrow extends RawModule {\n  val extractee = Wire(UInt(7.W))\n  val index = Wire(UInt(2.W))\n  extractee(index)\n}\ncompile(new TooNarrow)\n// [warn] cookbook.md 816:12: [W003] Dynamic index with width 2 is too small for extractee of width 7\n// [warn] There were 1 warning(s) during hardware elaboration.\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This can be fixed with ",(0,o.jsx)(n.code,{children:"pad"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooNarrowFixed extends RawModule {\n  val extractee = Wire(UInt(7.W))\n  val index = Wire(UInt(2.W))\n  extractee(index.pad(3))\n}\ncompile(new TooNarrowFixed)\n"})}),"\n",(0,o.jsx)(n.h4,{id:"use-bit-extraction-when-the-index-is-too-wide",children:"Use bit extraction when the index is too wide"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooWide extends RawModule {\n  val extractee = Wire(Vec(8, UInt(32.W)))\n  val index = Wire(UInt(4.W))\n  extractee(index)\n}\ncompile(new TooWide)\n// [warn] cookbook.md 842:12: [W004] Dynamic index with width 4 is too wide for Vec of size 8 (expected index width 3).\n// [warn] There were 1 warning(s) during hardware elaboration.\n"})}),"\n",(0,o.jsx)(n.p,{children:"This can be fixed with bit extraction:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooWideFixed extends RawModule {\n  val extractee = Wire(Vec(8, UInt(32.W)))\n  val index = Wire(UInt(4.W))\n  extractee(index(2, 0))\n}\ncompile(new TooWideFixed)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that size 1 ",(0,o.jsx)(n.code,{children:"Vecs"})," and ",(0,o.jsx)(n.code,{children:"UInts"})," should be indexed by a zero-width ",(0,o.jsx)(n.code,{children:"UInt"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class SizeOneVec extends RawModule {\n  val extractee = Wire(Vec(1, UInt(32.W)))\n  val index = Wire(UInt(0.W))\n  extractee(index)\n}\ncompile(new SizeOneVec)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Because ",(0,o.jsx)(n.code,{children:"pad"})," only pads if the desired width is less than the current width of the argument,\nyou can use ",(0,o.jsx)(n.code,{children:"pad"})," in conjunction with bit extraction when the widths may be too wide or too\nnarrow under different circumstances"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.log2Ceil\nclass TooWideOrNarrow(extracteeSize: Int, indexWidth: Int) extends Module {\n  val extractee = Wire(Vec(extracteeSize, UInt(8.W)))\n  val index = Wire(UInt(indexWidth.W))\n  val correctWidth = log2Ceil(extracteeSize)\n  extractee(index.pad(correctWidth)(correctWidth - 1, 0))\n}\ncompile(new TooWideOrNarrow(8, 2))\ncompile(new TooWideOrNarrow(8, 4))\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Another option for dynamic bit selection of ",(0,o.jsx)(n.code,{children:"UInts"})," (but not ",(0,o.jsx)(n.code,{children:"Vec"})," dynamic indexing) is to do a dynamic\nright shift of the extractee by the index and then just bit select a single bit:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooWideOrNarrowUInt(extracteeSize: Int, indexWidth: Int) extends Module {\n  val extractee = Wire(UInt(extracteeSize.W))\n  val index = Wire(UInt(indexWidth.W))\n  (extractee >> index)(0)\n}\ncompile(new TooWideOrNarrowUInt(8, 2))\ncompile(new TooWideOrNarrowUInt(8, 4))\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-can-i-use-verilog-case-equality-operators-in-chisel",children:'How can I use Verilog "case equality" operators in Chisel?'}),"\n",(0,o.jsxs)(n.p,{children:['Verilog has "case equality" (',(0,o.jsx)(n.code,{children:"==="}),") and inequality (",(0,o.jsx)(n.code,{children:"!=="}),") operators.\nThey are typically used to ignore unknown (",(0,o.jsx)(n.code,{children:"X"}),") values in assertions."]}),"\n",(0,o.jsxs)(n.p,{children:["Chisel does not support Verilog ",(0,o.jsx)(n.code,{children:"X"})," directly, but it is possible to check if a value is ",(0,o.jsx)(n.code,{children:"X"})," with ",(0,o.jsx)(n.code,{children:"chisel3.util.circt.isX"}),".\n",(0,o.jsx)(n.code,{children:"isX"})," is commonly used to guard assertions against ",(0,o.jsx)(n.code,{children:"X"})," which gives similar behavior to Verilog case equality."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.util.circt.IsX\n\nclass AssertButAllowX extends Module {\n  val in = IO(Input(UInt(8.W)))\n\n  // Assert that in is never zero; also do not trigger assert in the presence of X.\n  assert(IsX(in) || in =/= 0.U, "in should never equal 0")\n}\n'})}),"\n",(0,o.jsx)(n.h2,{id:"predictable-naming",children:"Predictable Naming"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-get-chisel-to-name-signals-properly-in-blocks-like-whenwithclockandreset",children:"How do I get Chisel to name signals properly in blocks like when/withClockAndReset?"}),"\n",(0,o.jsxs)(n.p,{children:["Use the compiler plugin, and check out the ",(0,o.jsx)(n.a,{href:"naming",children:"Naming Cookbook"})," if that still does not do what you want."]}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-get-chisel-to-name-the-results-of-vector-reads-properly",children:"How do I get Chisel to name the results of vector reads properly?"}),"\n",(0,o.jsx)(n.p,{children:"Currently, name information is lost when using dynamic indexing. For example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass Foo extends Module {\n  val io = IO(new Bundle {\n    val in = Input(Vec(4, Bool()))\n    val idx = Input(UInt(2.W))\n    val en = Input(Bool())\n    val out = Output(Bool())\n  })\n\n  val x = io.in(io.idx)\n  val y = x && io.en\n  io.out := y\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The above code loses the ",(0,o.jsx)(n.code,{children:"x"})," name, instead using ",(0,o.jsx)(n.code,{children:"_GEN_3"})," (the other ",(0,o.jsx)(n.code,{children:"_GEN_*"})," signals are expected)."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Foo(\n  input        clock,\n               reset,\n               io_in_0,\n               io_in_1,\n               io_in_2,\n               io_in_3,\n  input  [1:0] io_idx,\n  input        io_en,\n  output       io_out\n);\n\n  wire [3:0] _GEN = {{io_in_3}, {io_in_2}, {io_in_1}, {io_in_0}};\n  assign io_out = _GEN[io_idx] & io_en;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.p,{children:"This can be worked around by creating a wire and connecting the dynamic index to the wire:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"val x = WireInit(io.in(io.idx))\n"})}),"\n",(0,o.jsx)(n.p,{children:"Which produces:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Foo2(\n  input        clock,\n               reset,\n               io_in_0,\n               io_in_1,\n               io_in_2,\n               io_in_3,\n  input  [1:0] io_idx,\n  input        io_en,\n  output       io_out\n);\n\n  wire [3:0] _GEN = {{io_in_3}, {io_in_2}, {io_in_1}, {io_in_0}};\n  assign io_out = _GEN[io_idx] & io_en;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-can-i-dynamically-setparametrize-the-name-of-a-module",children:"How can I dynamically set/parametrize the name of a module?"}),"\n",(0,o.jsxs)(n.p,{children:["You can override the ",(0,o.jsx)(n.code,{children:"desiredName"})," function. This works with normal Chisel modules and ",(0,o.jsx)(n.code,{children:"BlackBox"}),"es. Example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass Coffee extends BlackBox {\n    val io = IO(new Bundle {\n        val I = Input(UInt(32.W))\n        val O = Output(UInt(32.W))\n    })\n    override def desiredName = "Tea"\n}\n\nclass Salt extends Module {\n    val io = IO(new Bundle {})\n    val drink = Module(new Coffee)\n    override def desiredName = "SodiumMonochloride"\n\n    drink.io.I := 42.U\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["Elaborating the Chisel module ",(0,o.jsx)(n.code,{children:"Salt"}),' yields our "desired names" for ',(0,o.jsx)(n.code,{children:"Salt"})," and ",(0,o.jsx)(n.code,{children:"Coffee"})," in the output Verilog:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule SodiumMonochloride(\n  input clock,\n        reset\n);\n\n  Tea drink (\n    .I (32'h2A),\n    .O (/* unused */)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"directionality",children:"Directionality"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-strip-directions-from-a-bidirectional-bundle-or-other-data",children:"How do I strip directions from a bidirectional Bundle (or other Data)?"}),"\n",(0,o.jsxs)(n.p,{children:["Given a bidirectional port like a ",(0,o.jsx)(n.code,{children:"Decoupled"}),", you will get an error if you try to connect it directly\nto a register:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.Decoupled\nclass BadRegConnect extends Module {\n  val io = IO(new Bundle {\n    val enq = Decoupled(UInt(8.W))\n  })\n\n  val monitor = Reg(chiselTypeOf(io.enq))\n  monitor := io.enq\n}\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new BadRegConnect)\n// circt.stage.phases.Exceptions$FirtoolNonZeroExitCode: /home/runner/.cache/llvm-firtool/1.99.2/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+285-e12935ed-SNAPSHOT) was published against firtool version 1.99.2.\n// ------------------------------------------------------------------------------\n// ExitCode:\n// 1\n// STDOUT:\n// \n// STDERR:\n// cookbook.md:1039:20: error: 'firrtl.reg' op result #0 must be a passive non-'const' base type that does not contain analog, but got '!firrtl.bundle<ready flip: uint<1>, valid: uint<1>, bits: uint<8>>'\n// cookbook.md:1039:20: note: see current operation: %4 = \"firrtl.reg\"(%arg0) <{annotations = [], name = \"monitor\", nameKind = #firrtl<name_kind interesting_name>}> : (!firrtl.clock) -> !firrtl.bundle<ready flip: uint<1>, valid: uint<1>, bits: uint<8>>\n// \n// ------------------------------------------------------------------------------\n"})}),"\n",(0,o.jsxs)(n.p,{children:['While there is no construct to "strip direction" in Chisel3, wrapping a type in ',(0,o.jsx)(n.code,{children:"Output(...)"}),"\n(the default direction in Chisel3) will\nset all of the individual elements to output direction.\nThis will have the desired result when used to construct a Register:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.Decoupled\nclass CoercedRegConnect extends Module {\n  val io = IO(new Bundle {\n    val enq = Flipped(Decoupled(UInt(8.W)))\n  })\n\n  // Make a Reg which contains all of the bundle's signals, regardless of their directionality\n  val monitor = Reg(Output(chiselTypeOf(io.enq)))\n  // Even though io.enq is bidirectional, := will drive all fields of monitor with the fields of io.enq\n  monitor := io.enq\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},1871:(e,n,a)=>{a.d(n,{A:()=>i});a(6540);var o=a(5195);const t={tableOfContentsInline:"tableOfContentsInline_prmo"};var l=a(4848);function i(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:i}=e;return(0,l.jsx)("div",{className:t.tableOfContentsInline,children:(0,l.jsx)(o.A,{toc:n,minHeadingLevel:a,maxHeadingLevel:i,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,a)=>{a.d(n,{A:()=>g});var o=a(6540),t=a(6342);function l(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),a=Array(7).fill(-1);n.forEach(((e,n)=>{const o=a.slice(2,e.level);e.parentIndex=Math.max(...o),a[e.level]=n}));const o=[];return n.forEach((e=>{const{parentIndex:a,...t}=e;a>=0?n[a].children.push(t):o.push(t)})),o}function i(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:o}=e;return n.flatMap((e=>{const n=i({toc:e.children,minHeadingLevel:a,maxHeadingLevel:o});return function(e){return e.level>=a&&e.level<=o}(e)?[{...e,children:n}]:n}))}function s(e){const n=e.getBoundingClientRect();return n.top===n.bottom?s(e.parentNode):n}function c(e,n){let{anchorTopOffset:a}=n;const o=e.find((e=>s(e).top>=a));if(o){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(s(o))?o:e[e.indexOf(o)-1]??null}return e[e.length-1]??null}function r(){const e=(0,o.useRef)(0),{navbar:{hideOnScroll:n}}=(0,t.p)();return(0,o.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function d(e){const n=(0,o.useRef)(void 0),a=r();(0,o.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:o,linkActiveClassName:t,minHeadingLevel:l,maxHeadingLevel:i}=e;function s(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(o),s=function(e){let{minHeadingLevel:n,maxHeadingLevel:a}=e;const o=[];for(let t=n;t<=a;t+=1)o.push(`h${t}.anchor`);return Array.from(document.querySelectorAll(o.join()))}({minHeadingLevel:l,maxHeadingLevel:i}),r=c(s,{anchorTopOffset:a.current}),d=e.find((e=>r&&r.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,a){a?(n.current&&n.current!==e&&n.current.classList.remove(t),e.classList.add(t),n.current=e):e.classList.remove(t)}(e,e===d)}))}return document.addEventListener("scroll",s),document.addEventListener("resize",s),s(),()=>{document.removeEventListener("scroll",s),document.removeEventListener("resize",s)}}),[e,a])}var u=a(8774),h=a(4848);function p(e){let{toc:n,className:a,linkClassName:o,isChild:t}=e;return n.length?(0,h.jsx)("ul",{className:t?void 0:a,children:n.map((e=>(0,h.jsxs)("li",{children:[(0,h.jsx)(u.A,{to:`#${e.id}`,className:o??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,h.jsx)(p,{isChild:!0,toc:e.children,className:a,linkClassName:o})]},e.id)))}):null}const m=o.memo(p);function g(e){let{toc:n,className:a="table-of-contents table-of-contents__left-border",linkClassName:s="table-of-contents__link",linkActiveClassName:c,minHeadingLevel:r,maxHeadingLevel:u,...p}=e;const g=(0,t.p)(),x=r??g.tableOfContents.minHeadingLevel,f=u??g.tableOfContents.maxHeadingLevel,w=function(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:t}=e;return(0,o.useMemo)((()=>i({toc:l(n),minHeadingLevel:a,maxHeadingLevel:t})),[n,a,t])}({toc:n,minHeadingLevel:x,maxHeadingLevel:f});return d((0,o.useMemo)((()=>{if(s&&c)return{linkClassName:s,linkActiveClassName:c,minHeadingLevel:x,maxHeadingLevel:f}}),[s,c,x,f])),(0,h.jsx)(m,{toc:w,className:a,linkClassName:s,...p})}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>s});var o=a(6540);const t={},l=o.createContext(t);function i(e){const n=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),o.createElement(l.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[5432],{7363:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=a(4848),t=a(8453),l=a(1871);const i={sidebar_position:0},s="General Cookbook",c={id:"cookbooks/cookbook",title:"General Cookbook",description:"Please note that these examples make use of Chisel's scala-style printing.",source:"@site/docs/cookbooks/cookbook.md",sourceDirName:"cookbooks",slug:"/cookbooks/cookbook",permalink:"/docs/cookbooks/cookbook",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/cookbook.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_position:0},sidebar:"chiselSidebar",previous:{title:"Cookbooks",permalink:"/docs/cookbooks"},next:{title:"Naming Cookbook",permalink:"/docs/cookbooks/naming"}},r={},d=[{value:"Type Conversions",id:"type-conversions",level:2},{value:"How do I create a UInt from an instance of a Bundle?",id:"how-do-i-create-a-uint-from-an-instance-of-a-bundle",level:3},{value:"How do I create a Bundle from a UInt?",id:"how-do-i-create-a-bundle-from-a-uint",level:3},{value:"How can I tieoff a Bundle/Vec to 0?",id:"how-can-i-tieoff-a-bundlevec-to-0",level:3},{value:"How do I create a Vec of Bools from a UInt?",id:"how-do-i-create-a-vec-of-bools-from-a-uint",level:3},{value:"How do I create a UInt from a Vec of Bool?",id:"how-do-i-create-a-uint-from-a-vec-of-bool",level:3},{value:"How do I connect a subset of Bundle fields?",id:"how-do-i-connect-a-subset-of-bundle-fields",level:3},{value:"Vectors and Registers",id:"vectors-and-registers",level:2},{value:"Can I make a 2D or 3D Vector?",id:"can-i-make-a-2d-or-3d-vector",level:3},{value:"How do I create a Vector of Registers?",id:"how-do-i-create-a-vector-of-registers",level:3},{value:"How do I create a Reg of type Vec?",id:"how-do-i-create-a-reg-of-type-vec",level:3},{value:"How do I partially reset an Aggregate Reg?",id:"how-do-i-partially-reset-an-aggregate-reg",level:3},{value:"Bundles",id:"bundles",level:2},{value:"How do I deal with aliased Bundle fields?",id:"how-do-i-deal-with-aliased-bundle-fields",level:3},{value:"1. 0-arity function parameters",id:"1-0-arity-function-parameters",level:4},{value:"Aliased Warning",id:"aliased-warning",level:5},{value:"2. By-name function parameters",id:"2-by-name-function-parameters",level:4},{value:"3. Directioned Bundle fields",id:"3-directioned-bundle-fields",level:4},{value:"4. Call <code>.cloneType</code> directly",id:"4-call-clonetype-directly",level:4},{value:"<a></a> How do I deal with the &quot;unable to clone&quot; error?",id:"-how-do-i-deal-with-the-unable-to-clone-error",level:3},{value:"How do I create a finite state machine (FSM)?",id:"how-do-i-create-a-finite-state-machine-fsm",level:2},{value:"How do I unpack a value (&quot;reverse concatenation&quot;) like in Verilog?",id:"how-do-i-unpack-a-value-reverse-concatenation-like-in-verilog",level:2},{value:"How do I do subword assignment (assign to some bits in a UInt)?",id:"how-do-i-do-subword-assignment-assign-to-some-bits-in-a-uint",level:2},{value:"How do I create an optional I/O?",id:"how-do-i-create-an-optional-io",level:2},{value:"How do I create I/O without a prefix?",id:"how-do-i-create-io-without-a-prefix",level:2},{value:"How do I override the implicit clock or reset within a Module?",id:"how-do-i-override-the-implicit-clock-or-reset-within-a-module",level:2},{value:"How do I minimize the number of bits used in an output vector?",id:"how-do-i-minimize-the-number-of-bits-used-in-an-output-vector",level:2},{value:"How do I resolve &quot;Dynamic index ... is too wide/narrow for extractee ...&quot;?",id:"how-do-i-resolve-dynamic-index--is-too-widenarrow-for-extractee-",level:2},{value:"Use bit extraction when the index is too wide",id:"use-bit-extraction-when-the-index-is-too-wide",level:4},{value:"How can I use Verilog &quot;case equality&quot; operators in Chisel?",id:"how-can-i-use-verilog-case-equality-operators-in-chisel",level:2},{value:"Predictable Naming",id:"predictable-naming",level:2},{value:"How do I get Chisel to name signals properly in blocks like when/withClockAndReset?",id:"how-do-i-get-chisel-to-name-signals-properly-in-blocks-like-whenwithclockandreset",level:3},{value:"How do I get Chisel to name the results of vector reads properly?",id:"how-do-i-get-chisel-to-name-the-results-of-vector-reads-properly",level:3},{value:"How can I dynamically set/parametrize the name of a module?",id:"how-can-i-dynamically-setparametrize-the-name-of-a-module",level:3},{value:"Directionality",id:"directionality",level:2},{value:"How do I strip directions from a bidirectional Bundle (or other Data)?",id:"how-do-i-strip-directions-from-a-bidirectional-bundle-or-other-data",level:3}];function u(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"general-cookbook",children:"General Cookbook"})}),"\n",(0,o.jsxs)(n.p,{children:["Please note that these examples make use of ",(0,o.jsx)(n.a,{href:"../explanations/printing#scala-style",children:"Chisel's scala-style printing"}),"."]}),"\n","\n",(0,o.jsx)(l.A,{toc:d}),"\n",(0,o.jsx)(n.h2,{id:"type-conversions",children:"Type Conversions"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-uint-from-an-instance-of-a-bundle",children:"How do I create a UInt from an instance of a Bundle?"}),"\n",(0,o.jsxs)(n.p,{children:["Call ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html#asUInt:chisel3.UInt",children:(0,o.jsx)(n.code,{children:"asUInt"})})," on the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html",children:(0,o.jsx)(n.code,{children:"Bundle"})})," instance."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(4.W)\n  val bar = UInt(4.W)\n}\n\nclass Foo extends Module {\n  val bundle = Wire(new MyBundle)\n  bundle.foo := 0xc.U\n  bundle.bar := 0x3.U\n  val uint = bundle.asUInt\n  printf(cf"$uint") // 195\n\n  // Test\n  assert(uint === 0xc3.U)\n}\n'})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-bundle-from-a-uint",children:"How do I create a Bundle from a UInt?"}),"\n",(0,o.jsxs)(n.p,{children:["Use the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html#asTypeOf%5BT%3C:chisel3.Data%5D(that:T):T",children:(0,o.jsx)(n.code,{children:"asTypeOf"})})," method to reinterpret the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html",children:(0,o.jsx)(n.code,{children:"UInt"})})," as the type of the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html",children:(0,o.jsx)(n.code,{children:"Bundle"})}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(4.W)\n  val bar = UInt(4.W)\n}\n\nclass Foo extends Module {\n  val uint = 0xb4.U\n  val bundle = uint.asTypeOf(new MyBundle)\n\n  printf(cf"$bundle") // Bundle(foo -> 11, bar -> 4)\n\n  // Test\n  assert(bundle.foo === 0xb.U)\n  assert(bundle.bar === 0x4.U)\n}\n'})}),"\n",(0,o.jsx)(n.h3,{id:"how-can-i-tieoff-a-bundlevec-to-0",children:"How can I tieoff a Bundle/Vec to 0?"}),"\n",(0,o.jsxs)(n.p,{children:["You can use ",(0,o.jsx)(n.code,{children:"asTypeOf"})," as above. If you don't want to worry about the type of the thing\nyou are tying off, you can use ",(0,o.jsx)(n.code,{children:"chiselTypeOf"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(4.W)\n  val bar = Vec(4, UInt(1.W))\n}\n\nclass Foo(typ: MyBundle) extends Module {\n  val bundleA = IO(Output(typ))\n  val bundleB = IO(Output(typ))\n\n  // typ is already a Chisel Data Type, so can use it directly here, but you\n  // need to know that bundleA is of type typ\n  bundleA := 0.U.asTypeOf(typ)\n\n  // bundleB is a Hardware data IO(Output(...)) so need to call chiselTypeOf,\n  // but this will work no matter the type of bundleB:\n  bundleB := 0.U.asTypeOf(chiselTypeOf(bundleB))\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-vec-of-bools-from-a-uint",children:"How do I create a Vec of Bools from a UInt?"}),"\n",(0,o.jsxs)(n.p,{children:["Use ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/VecInit$.html",children:(0,o.jsx)(n.code,{children:"VecInit"})})," given a ",(0,o.jsx)(n.code,{children:"Seq[Bool]"})," generated using the ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html#asBools:Seq%5Bchisel3.Bool%5D",children:(0,o.jsx)(n.code,{children:"asBools"})})," method."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass Foo extends Module {\n  val uint = 0xc.U\n  val vec = VecInit(uint.asBools)\n\n  printf(cf"$vec") // Vec(0, 0, 1, 1)\n\n  // Test\n  assert(vec(0) === false.B)\n  assert(vec(1) === false.B)\n  assert(vec(2) === true.B)\n  assert(vec(3) === true.B)\n}\n'})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-uint-from-a-vec-of-bool",children:"How do I create a UInt from a Vec of Bool?"}),"\n",(0,o.jsxs)(n.p,{children:["Use the builtin function ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Vec.html#asUInt:chisel3.UInt",children:(0,o.jsx)(n.code,{children:"asUInt"})})]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass Foo extends Module {\n  val vec = VecInit(true.B, false.B, true.B, true.B)\n  val uint = vec.asUInt\n\n  printf(cf"$uint") // 13\n\n  // Test\n  // (remember leftmost Bool in Vec is low order bit)\n  assert(0xd.U === uint)\n\n}\n'})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-connect-a-subset-of-bundle-fields",children:"How do I connect a subset of Bundle fields?"}),"\n",(0,o.jsxs)(n.p,{children:["See the ",(0,o.jsx)(n.a,{href:"dataview#how-do-i-connect-a-subset-of-bundle-fields",children:"DataView cookbook"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"vectors-and-registers",children:"Vectors and Registers"}),"\n",(0,o.jsx)(n.h3,{id:"can-i-make-a-2d-or-3d-vector",children:"Can I make a 2D or 3D Vector?"}),"\n",(0,o.jsxs)(n.p,{children:["Yes. Using ",(0,o.jsx)(n.code,{children:"VecInit"})," you can make Vectors that hold Vectors of Chisel types. Methods ",(0,o.jsx)(n.code,{children:"fill"})," and ",(0,o.jsx)(n.code,{children:"tabulate"})," make these multi-dimensional Vectors."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(4.W)\n  val bar = UInt(4.W)\n}\n\nclass Foo extends Module {\n  //2D Fill\n  val twoDVec = VecInit.fill(2, 3)(5.U)\n  //3D Fill\n  val myBundle = Wire(new MyBundle)\n  myBundle.foo := 0xc.U\n  myBundle.bar := 0x3.U\n  val threeDVec = VecInit.fill(1, 2, 3)(myBundle)\n  assert(threeDVec(0)(0)(0).foo === 0xc.U && threeDVec(0)(0)(0).bar === 0x3.U)\n\n  //2D Tabulate\n  val indexTiedVec = VecInit.tabulate(2, 2){ (x, y) => (x + y).U }\n  assert(indexTiedVec(0)(0) === 0.U)\n  assert(indexTiedVec(0)(1) === 1.U)\n  assert(indexTiedVec(1)(0) === 1.U)\n  assert(indexTiedVec(1)(1) === 2.U)\n  //3D Tabulate\n  val indexTiedVec3D = VecInit.tabulate(2, 3, 4){ (x, y, z) => (x + y * z).U }\n  assert(indexTiedVec3D(0)(0)(0) === 0.U)\n  assert(indexTiedVec3D(1)(1)(1) === 2.U)\n  assert(indexTiedVec3D(1)(1)(2) === 3.U)\n  assert(indexTiedVec3D(1)(1)(3) === 4.U)\n  assert(indexTiedVec3D(1)(2)(3) === 7.U)\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-vector-of-registers",children:"How do I create a Vector of Registers?"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"Rule!  Use Reg of Vec not Vec of Reg!"})}),"\n",(0,o.jsxs)(n.p,{children:["You create a ",(0,o.jsx)(n.a,{href:"#how-do-i-create-a-reg-of-type-vec",children:"Reg of type Vec"}),". Because Vecs are a ",(0,o.jsx)(n.em,{children:"type"})," (like ",(0,o.jsx)(n.code,{children:"UInt"}),", ",(0,o.jsx)(n.code,{children:"Bool"}),") rather than a ",(0,o.jsx)(n.em,{children:"value"}),", we must bind the Vec to some concrete ",(0,o.jsx)(n.em,{children:"value"}),"."]}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-create-a-reg-of-type-vec",children:"How do I create a Reg of type Vec?"}),"\n",(0,o.jsxs)(n.p,{children:["For more information, the API Documentation for ",(0,o.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Vec.html",children:(0,o.jsx)(n.code,{children:"Vec"})})," provides more information."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass Foo extends Module {\n  val regOfVec = Reg(Vec(4, UInt(32.W))) // Register of 32-bit UInts\n  regOfVec(0) := 123.U                   // Assignments to elements of the Vec\n  regOfVec(1) := 456.U\n  regOfVec(2) := 789.U\n  regOfVec(3) := regOfVec(0)\n\n  // Reg of Vec of 32-bit UInts initialized to zero\n  //   Note that Seq.fill constructs 4 32-bit UInt literals with the value 0\n  //   VecInit(...) then constructs a Wire of these literals\n  //   The Reg is then initialized to the value of the Wire (which gives it the same type)\n  val initRegOfVec = RegInit(VecInit(Seq.fill(4)(0.U(32.W))))\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-partially-reset-an-aggregate-reg",children:"How do I partially reset an Aggregate Reg?"}),"\n",(0,o.jsxs)(n.p,{children:["The easiest way is to use a partially-specified ",(0,o.jsx)(n.a,{href:"../appendix/experimental-features#bundle-literals",children:"Bundle Literal"}),"\nor ",(0,o.jsx)(n.a,{href:"../appendix/experimental-features#vec-literals",children:"Vec Literal"})," to match the type of the Reg."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.BundleLiterals._\n\nclass MyBundle extends Bundle {\n  val foo = UInt(8.W)\n  val bar = UInt(8.W)\n}\n\nclass MyModule extends Module {\n  // Only .foo will be reset, .bar will have no reset value\n  val reg = RegInit((new MyBundle).Lit(_.foo -> 123.U))\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["If your initial value is not a literal, or if you just prefer, you can use a\nWire as the initial value for the Reg. Simply connect fields to ",(0,o.jsx)(n.code,{children:"DontCare"})," that\nyou do not wish to be reset."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class MyModule2 extends Module {\n  val reg = RegInit({\n    // The wire could be constructed before the reg rather than in the RegInit scope,\n    // but this style has nice lexical scoping behavior, keeping the Wire private\n    val init = Wire(new MyBundle)\n    init := DontCare // No fields will be reset\n    init.foo := 123.U // Last connect override, .foo is reset\n    init\n  })\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"bundles",children:"Bundles"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-deal-with-aliased-bundle-fields",children:"How do I deal with aliased Bundle fields?"}),"\n",(0,o.jsxs)(n.p,{children:["Following the ",(0,o.jsx)(n.code,{children:"gen"})," pattern when creating Bundles can result in some opaque error messages:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class AliasedBundle[T <: Data](gen: T) extends Bundle {\n  val foo = gen\n  val bar = gen\n}\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new Top(new AliasedBundle(UInt(8.W))))\n// chisel3.AliasedAggregateFieldException: AliasedBundle contains aliased fields named (foo,bar)\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:298)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp17$Top.<init>(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$$anonfun$55$$anonfun$apply$43.apply(cookbook.md:317)\n// \tat repl.MdocSession$MdocApp17$$anonfun$55$$anonfun$apply$43.apply(cookbook.md:317)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This error is saying that fields ",(0,o.jsx)(n.code,{children:"foo"})," and ",(0,o.jsx)(n.code,{children:"bar"})," of ",(0,o.jsx)(n.code,{children:"AliasedBundle"})," are the\nexact same object in memory.\nThis is a problem for Chisel because we need to be able to distinguish uses of\n",(0,o.jsx)(n.code,{children:"foo"})," and ",(0,o.jsx)(n.code,{children:"bar"})," but cannot when they are referentially the same."]}),"\n",(0,o.jsx)(n.p,{children:"Note that the following example looks different but will give you exactly the same issue:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class AlsoAliasedBundle[T <: Data](val gen: T) extends Bundle {\n                                // ^ This val makes `gen` a field, just like `foo`\n  val foo = gen\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["By making ",(0,o.jsx)(n.code,{children:"gen"})," a ",(0,o.jsx)(n.code,{children:"val"}),", it becomes a public field of the ",(0,o.jsx)(n.code,{children:"class"}),", just like ",(0,o.jsx)(n.code,{children:"foo"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new Top(new AlsoAliasedBundle(UInt(8.W))))\n// chisel3.AliasedAggregateFieldException: AlsoAliasedBundle contains aliased fields named (gen,foo)\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:298)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp17$Top.<init>(cookbook.md:298)\n// \tat repl.MdocSession$MdocApp17$$anonfun$57$$anonfun$apply$44.apply(cookbook.md:336)\n// \tat repl.MdocSession$MdocApp17$$anonfun$57$$anonfun$apply$44.apply(cookbook.md:336)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsx)(n.p,{children:"There are several ways to solve this issue with their own advantages and disadvantages."}),"\n",(0,o.jsx)(n.h4,{id:"1-0-arity-function-parameters",children:"1. 0-arity function parameters"}),"\n",(0,o.jsx)(n.p,{children:"Instead of passing an object as a parameter, you can pass a 0-arity function (a function with no arguments):"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class UsingAFunctionBundle[T <: Data](gen: () => T) extends Bundle {\n  val foo = gen()\n  val bar = gen()\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that the type of ",(0,o.jsx)(n.code,{children:"gen"})," is now ",(0,o.jsx)(n.code,{children:"() => T"}),".\nBecause it is now a function and not a subtype of ",(0,o.jsx)(n.code,{children:"Data"}),", you can safely make ",(0,o.jsx)(n.code,{children:"gen"})," a ",(0,o.jsx)(n.code,{children:"val"})," without\nit becoming a hardware field of the ",(0,o.jsx)(n.code,{children:"Bundle"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Note that this also means you must pass ",(0,o.jsx)(n.code,{children:"gen"})," as a function, for example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"chisel3.docs.emitSystemVerilog(new Top(new UsingAFunctionBundle(() => UInt(8.W))))\n"})}),"\n",(0,o.jsx)(n.h5,{id:"aliased-warning",children:"Aliased Warning"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"Warning"}),": you must ensure that ",(0,o.jsx)(n.code,{children:"gen"})," creates fresh objects rather than capturing an already constructed value:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class MisusedFunctionArguments extends Module {\n  // This usage is correct\n  val in = IO(Input(new UsingAFunctionBundle(() => UInt(8.W))))\n\n  // This usage is incorrect\n  val fizz = UInt(8.W)\n  val out = IO(Output(new UsingAFunctionBundle(() => fizz)))\n}\ngetVerilogString(new MisusedFunctionArguments)\n// chisel3.AutoClonetypeException: The bundle plugin was unable to clone UsingAFunctionBundle that has field 'bar' aliased with base UsingAFunctionBundle.This likely happened because you tried nesting Data arguments inside of other data structures. Try wrapping the field(s) in Input(...), Output(...), or Flipped(...) if appropriate. As a last resort, you can call chisel3.reflect.DataMirror.internal.chiselTypeClone on any nested Data arguments. See the cookbook entry 'How do I deal with the \"unable to clone\" error?' for more details.\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51$$anonfun$apply$52.apply(cookbook.md:367)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51$$anonfun$apply$52.apply(cookbook.md:367)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(ModuleImpl.scala:927)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51.apply(cookbook.md:367)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51.apply(cookbook.md:367)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62.apply(cookbook.md:367)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62.apply(cookbook.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1.<init>(cookbook.md:367)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$$anonfun$apply$55.apply(cookbook.md:369)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$$anonfun$apply$55.apply(cookbook.md:369)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["In the above example, value ",(0,o.jsx)(n.code,{children:"fizz"})," and fields ",(0,o.jsx)(n.code,{children:"foo"})," and ",(0,o.jsx)(n.code,{children:"bar"})," of ",(0,o.jsx)(n.code,{children:"out"})," are all the same object in memory."]}),"\n",(0,o.jsx)(n.h4,{id:"2-by-name-function-parameters",children:"2. By-name function parameters"}),"\n",(0,o.jsxs)(n.p,{children:["Functionally the same as (1) but with more subtle syntax, you can use ",(0,o.jsx)(n.a,{href:"https://docs.scala-lang.org/tour/by-name-parameters.html",children:"Scala by-name function parameters"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class UsingByNameParameters[T <: Data](gen: => T) extends Bundle {\n  val foo = gen\n  val bar = gen\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["With this usage, you do not include ",(0,o.jsx)(n.code,{children:"() =>"})," when passing the argument:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"chisel3.docs.emitSystemVerilog(new Top(new UsingByNameParameters(UInt(8.W))))\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that as this is just syntactic sugar over (1), the ",(0,o.jsx)(n.a,{href:"#aliased-warning",children:"same warning applies"}),"."]}),"\n",(0,o.jsx)(n.h4,{id:"3-directioned-bundle-fields",children:"3. Directioned Bundle fields"}),"\n",(0,o.jsxs)(n.p,{children:["You can alternatively wrap the fields with ",(0,o.jsx)(n.code,{children:"Output(...)"}),", which creates fresh instances of the passed argument.\nChisel treats ",(0,o.jsx)(n.code,{children:"Output"}),' as the "default direction" so if all fields are outputs, the ',(0,o.jsx)(n.code,{children:"Bundle"})," is functionally equivalent to a ",(0,o.jsx)(n.code,{children:"Bundle"})," with no directioned fields."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class DirectionedBundle[T <: Data](gen: T) extends Bundle {\n  val foo = Output(gen)\n  val bar = Output(gen)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This approach is admittedly a little ugly and may mislead others reading the code because it implies that this Bundle is intended to be used as an ",(0,o.jsx)(n.code,{children:"Output"}),"."]}),"\n",(0,o.jsxs)(n.h4,{id:"4-call-clonetype-directly",children:["4. Call ",(0,o.jsx)(n.code,{children:".cloneType"})," directly"]}),"\n",(0,o.jsxs)(n.p,{children:["You can also just call ",(0,o.jsx)(n.code,{children:".cloneType"})," on your ",(0,o.jsx)(n.code,{children:"gen"})," argument directly.\nWhile we try to hide this implementation detail from the user, ",(0,o.jsx)(n.code,{children:".cloneType"})," is the mechanism by which Chisel creates fresh instances of ",(0,o.jsx)(n.code,{children:"Data"})," objects:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class UsingCloneTypeBundle[T <: Data](gen: T) extends Bundle {\n  val foo = gen.cloneType\n  val bar = gen.cloneType\n}\n"})}),"\n",(0,o.jsxs)(n.h3,{id:"-how-do-i-deal-with-the-unable-to-clone-error",children:[(0,o.jsx)("a",{name:"bundle-unable-to-clone"}),' How do I deal with the "unable to clone" error?']}),"\n",(0,o.jsx)(n.p,{children:'Most Chisel objects need to be cloned in order to differentiate between the\nsoftware representation of the bundle field from its "bound" hardware\nrepresentation, where "binding" is the process of generating a hardware\ncomponent. For Bundle fields, this cloning is supposed to happen automatically\nwith a compiler plugin.'}),"\n",(0,o.jsxs)(n.p,{children:["In some cases though, the plugin may not be able to clone the Bundle fields. The\nmost common case for when this happens is when the ",(0,o.jsx)(n.code,{children:"chisel3.Data"})," part of the\nBundle field is nested inside some other data structure and the compiler plugin\nis unable to figure out how to clone the entire structure. It is best to avoid\nsuch nested structures."]}),"\n",(0,o.jsxs)(n.p,{children:["There are a few ways around this issue - you can try wrapping the problematic\nfields in Input(...), Output(...), or Flipped(...) if appropriate. You can also\ntry manually cloning each field in the Bundle using the ",(0,o.jsx)(n.code,{children:"chiselTypeClone"})," method\nin ",(0,o.jsx)(n.code,{children:"chisel3.reflect.DataMirror"}),". Here's an example with the Bundle whose fields\nwon't get cloned:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'class CustomBundleBroken(elts: (String, Data)*) extends Record {\n  val elements = ListMap(elts: _*)\n\n  def apply(elt: String): Data = elements(elt)\n}\n\nclass NewModule extends Module {\n  val out = Output(UInt(8.W))\n  val recordType = new CustomBundleBroken("fizz" -> UInt(16.W), "buzz" -> UInt(16.W))\n  val record = Wire(recordType)\n  val uint = record.asUInt\n  val record2 = uint.asTypeOf(recordType)\n  out := record\n}\ngetVerilogString(new NewModule)\n// chisel3.AutoClonetypeException: The bundle plugin was unable to clone CustomBundleBroken$1 that has field \'fizz\' aliased with base CustomBundleBroken$1.This likely happened because you tried nesting Data arguments inside of other data structures. Try wrapping the field(s) in Input(...), Output(...), or Flipped(...) if appropriate. As a last resort, you can call chisel3.reflect.DataMirror.internal.chiselTypeClone on any nested Data arguments. See the cookbook entry \'How do I deal with the "unable to clone" error?\' for more details.\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74$$anonfun$apply$63.apply(cookbook.md:441)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74$$anonfun$apply$63.apply(cookbook.md:441)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74.apply(cookbook.md:441)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74.apply(cookbook.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1.<init>(cookbook.md:441)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$$anonfun$apply$67.apply(cookbook.md:446)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$$anonfun$apply$67.apply(cookbook.md:446)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n'})}),"\n",(0,o.jsxs)(n.p,{children:["You can use ",(0,o.jsx)(n.code,{children:"chiselTypeClone"})," to clone the elements as:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3.reflect.DataMirror\nimport chisel3.experimental.requireIsChiselType\n\nclass CustomBundleFixed(elts: (String, Data)*) extends Record {\n  val elements = ListMap(elts.map {\n    case (field, elt) =>\n      requireIsChiselType(elt)\n      field -> DataMirror.internal.chiselTypeClone(elt)\n  }: _*)\n\n  def apply(elt: String): Data = elements(elt)\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-create-a-finite-state-machine-fsm",children:"How do I create a finite state machine (FSM)?"}),"\n",(0,o.jsxs)(n.p,{children:["The advised way is to use ",(0,o.jsx)(n.code,{children:"ChiselEnum"})," to construct enumerated types representing the state of the FSM.\nState transitions are then handled with ",(0,o.jsx)(n.code,{children:"switch"}),"/",(0,o.jsx)(n.code,{children:"is"})," and ",(0,o.jsx)(n.code,{children:"when"}),"/",(0,o.jsx)(n.code,{children:".elsewhen"}),"/",(0,o.jsx)(n.code,{children:".otherwise"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.{switch, is}\n\nobject DetectTwoOnes {\n  object State extends ChiselEnum {\n    val sNone, sOne1, sTwo1s = Value\n  }\n}\n\n/* This FSM detects two 1's one after the other */\nclass DetectTwoOnes extends Module {\n  import DetectTwoOnes.State\n  import DetectTwoOnes.State._\n\n  val io = IO(new Bundle {\n    val in = Input(Bool())\n    val out = Output(Bool())\n    val state = Output(State())\n  })\n\n  val state = RegInit(sNone)\n\n  io.out := (state === sTwo1s)\n  io.state := state\n\n  switch (state) {\n    is (sNone) {\n      when (io.in) {\n        state := sOne1\n      }\n    }\n    is (sOne1) {\n      when (io.in) {\n        state := sTwo1s\n      } .otherwise {\n        state := sNone\n      }\n    }\n    is (sTwo1s) {\n      when (!io.in) {\n        state := sNone\n      }\n    }\n  }\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note: the ",(0,o.jsx)(n.code,{children:"is"})," statement can take multiple conditions e.g. ",(0,o.jsx)(n.code,{children:"is (sTwo1s, sOne1) { ... }"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-unpack-a-value-reverse-concatenation-like-in-verilog",children:'How do I unpack a value ("reverse concatenation") like in Verilog?'}),"\n",(0,o.jsxs)(n.p,{children:["In Verilog, you can do something like the following which will unpack a the value ",(0,o.jsx)(n.code,{children:"z"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"wire [1:0] a;\nwire [3:0] b;\nwire [2:0] c;\nwire [8:0] z = [...];\nassign {a,b,c} = z;\n"})}),"\n",(0,o.jsx)(n.p,{children:"Unpacking often corresponds to reinterpreting an unstructured data type as a structured data type.\nFrequently, this structured type is used prolifically in the design, and has been declared as in the following example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyBundle extends Bundle {\n  val a = UInt(2.W)\n  val b = UInt(4.W)\n  val c = UInt(3.W)\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"The easiest way to accomplish this in Chisel would be:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'class Foo extends Module {\n  val z = Wire(UInt(9.W))\n  z := DontCare // This is a dummy connection\n  val unpacked = z.asTypeOf(new MyBundle)\n  printf("%d", unpacked.a)\n  printf("%d", unpacked.b)\n  printf("%d", unpacked.c)\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["If you ",(0,o.jsx)(n.strong,{children:"really"})," need to do this for a one-off case (Think thrice! It is likely you can better structure the code using bundles), then rocket-chip has a ",(0,o.jsx)(n.a,{href:"https://github.com/freechipsproject/rocket-chip/blob/723af5e6b69e07b5f94c46269a208a8d65e9d73b/src/main/scala/util/Misc.scala#L140",children:"Split utility"})," which can accomplish this."]}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-do-subword-assignment-assign-to-some-bits-in-a-uint",children:"How do I do subword assignment (assign to some bits in a UInt)?"}),"\n",(0,o.jsxs)(n.p,{children:["You may try to do something like the following where you want to assign only some bits of a Chisel type.\nBelow, the left-hand side connection to ",(0,o.jsx)(n.code,{children:"io.out(0)"})," is not allowed."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass Foo extends Module {\n  val io = IO(new Bundle {\n    val bit = Input(Bool())\n    val out = Output(UInt(10.W))\n  })\n  io.out(0) := io.bit\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"If you try to compile this, you will get an error."}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new Foo)\n// chisel3.package$ChiselException: Cannot reassign to read-only Foo.?: OpResult[Bool]\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp26$Foo.<init>(cookbook.md:583)\n// \tat repl.MdocSession$MdocApp26$$anonfun$104$$anonfun$apply$90.apply(cookbook.md:591)\n// \tat repl.MdocSession$MdocApp26$$anonfun$104$$anonfun$apply$90.apply(cookbook.md:591)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Chisel3 ",(0,o.jsx)(n.em,{children:"does not support subword assignment"}),".\nThe reason for this is that subword assignment generally hints at a better abstraction with an aggregate/structured types, i.e., a ",(0,o.jsx)(n.code,{children:"Bundle"})," or a ",(0,o.jsx)(n.code,{children:"Vec"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["If you must express it this way, one approach is to blast your ",(0,o.jsx)(n.code,{children:"UInt"})," to a ",(0,o.jsx)(n.code,{children:"Vec"})," of ",(0,o.jsx)(n.code,{children:"Bool"})," and back:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass Foo extends Module {\n  val io = IO(new Bundle {\n    val in = Input(UInt(10.W))\n    val bit = Input(Bool())\n    val out = Output(UInt(10.W))\n  })\n  val bools = VecInit(io.in.asBools)\n  bools(0) := io.bit\n  io.out := bools.asUInt\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-create-an-optional-io",children:"How do I create an optional I/O?"}),"\n",(0,o.jsxs)(n.p,{children:["The following example is a module which includes the optional port ",(0,o.jsx)(n.code,{children:"out2"})," only if the given parameter is ",(0,o.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass ModuleWithOptionalIOs(flag: Boolean) extends Module {\n  val io = IO(new Bundle {\n    val in = Input(UInt(12.W))\n    val out = Output(UInt(12.W))\n    val out2 = if (flag) Some(Output(UInt(12.W))) else None\n  })\n\n  io.out := io.in\n  if (flag) {\n    io.out2.get := io.in\n  }\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The following is an example where an entire ",(0,o.jsx)(n.code,{children:"IO"})," is optional:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass ModuleWithOptionalIO(flag: Boolean) extends Module {\n  val in = if (flag) Some(IO(Input(Bool()))) else None\n  val out = IO(Output(Bool()))\n\n  out := in.getOrElse(false.B)\n}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-create-io-without-a-prefix",children:"How do I create I/O without a prefix?"}),"\n",(0,o.jsxs)(n.p,{children:["In most cases, you can simply call ",(0,o.jsx)(n.code,{children:"IO"})," multiple times:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyModule extends Module {\n  val in = IO(Input(UInt(8.W)))\n  val out = IO(Output(UInt(8.W)))\n\n  out := in +% 1.U\n}\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule MyModule(\n  input        clock,\n               reset,\n  input  [7:0] in,\n  output [7:0] out\n);\n\n  assign out = in + 8'h1;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.p,{children:["If you have a ",(0,o.jsx)(n.code,{children:"Bundle"})," from which you would like to create ports without the\nnormal ",(0,o.jsx)(n.code,{children:"val"})," prefix, you can use ",(0,o.jsx)(n.code,{children:"FlatIO"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass MyBundle extends Bundle {\n  val foo = Input(UInt(8.W))\n  val bar = Output(UInt(8.W))\n}\n\nclass MyModule extends Module {\n  val io = FlatIO(new MyBundle)\n\n  io.bar := io.foo +% 1.U\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that ",(0,o.jsx)(n.code,{children:"io_"})," is nowhere to be seen!"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule MyModule(\n  input        clock,\n               reset,\n  input  [7:0] foo,\n  output [7:0] bar\n);\n\n  assign bar = foo + 8'h1;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-override-the-implicit-clock-or-reset-within-a-module",children:"How do I override the implicit clock or reset within a Module?"}),"\n",(0,o.jsxs)(n.p,{children:["To change the clock or reset for a region of code, use ",(0,o.jsx)(n.code,{children:"withClock"}),", ",(0,o.jsx)(n.code,{children:"withReset"}),", or ",(0,o.jsx)(n.code,{children:"withClockAndReset"}),".\nSee ",(0,o.jsx)(n.a,{href:"../explanations/multi-clock",children:"Multiple Clock Domains"})," for examples and details."]}),"\n",(0,o.jsxs)(n.p,{children:["To override the clock or reset for the entire scope of the ",(0,o.jsx)(n.code,{children:"Module"}),", you can mixin the ",(0,o.jsx)(n.code,{children:"ImplicitClock"})," and ",(0,o.jsx)(n.code,{children:"ImplicitReset"})," traits."]}),"\n",(0,o.jsx)(n.p,{children:'For example, you could "gate" the default implicit clock as follows:'}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass MyModule extends Module with ImplicitClock {\n  val gate = IO(Input(Bool()))\n  val in = IO(Input(UInt(8.W)))\n  val out = IO(Output(UInt(8.W)))\n  // We could just assign this to val implicitClock, but this allows us to give it a custom name\n  val gatedClock = (clock.asBool || gate).asClock\n  // The trait requires us to implement this method referring to the clock\n  // Note that this is a def, but the actual clock value must be assigned to a val\n  override protected def implicitClock = gatedClock\n\n  val r = Reg(UInt(8.W))\n  out := r\n  r := in\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"This gives the following Verilog:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule MyModule(\n  input        clock,\n               reset,\n               gate,\n  input  [7:0] in,\n  output [7:0] out\n);\n\n  wire       gatedClock = clock | gate;\n  reg  [7:0] r;\n  always @(posedge gatedClock)\n    r <= in;\n  assign out = r;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.p,{children:["If you do not care about the name of the overriden clock, you can just assign it to ",(0,o.jsx)(n.code,{children:"val implicitClock"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"override protected val implicitClock = (clock.asBool || gate).asClock\n"})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"ImplicitReset"})," works analogously to ",(0,o.jsx)(n.code,{children:"ImplicitClock"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-minimize-the-number-of-bits-used-in-an-output-vector",children:"How do I minimize the number of bits used in an output vector?"}),"\n",(0,o.jsxs)(n.p,{children:["Use inferred width and a ",(0,o.jsx)(n.code,{children:"Seq"})," instead of a ",(0,o.jsx)(n.code,{children:"Vec"}),":"]}),"\n",(0,o.jsx)(n.p,{children:"Consider:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\n// Count the number of set bits up to and including each bit position\nclass CountBits(width: Int) extends Module {\n  val bits = IO(Input(UInt(width.W)))\n  val countVector = IO(Output(Vec(width, UInt())))\n\n  private val countSequence = Seq.tabulate(width)(i => Wire(UInt()))\n  countSequence.zipWithIndex.foreach { case (port, i) =>\n    port := util.PopCount(bits(i, 0))\n  }\n  countVector := countSequence\n}\n\nclass Top(width: Int) extends Module {\n  val countBits = Module(new CountBits(width))\n  countBits.bits :<>= DontCare\n  dontTouch(countBits.bits)\n  dontTouch(countBits.countVector)\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Note that top modules or public modules cannot have unknown widths."}),"\n",(0,o.jsxs)(n.p,{children:["Unlike ",(0,o.jsx)(n.code,{children:"Vecs"})," which represent a singular Chisel type and must have the same width for every element,\n",(0,o.jsx)(n.code,{children:"Seq"})," is a purely Scala construct, so their elements are independent from the perspective of Chisel and can have different widths."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule CountBits(\n  input  [3:0] bits,\n  output [2:0] countVector_0,\n               countVector_1,\n               countVector_2,\n               countVector_3\n);\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-do-i-resolve-dynamic-index--is-too-widenarrow-for-extractee-",children:'How do I resolve "Dynamic index ... is too wide/narrow for extractee ..."?'}),"\n",(0,o.jsx)(n.p,{children:'Chisel will warn if a dynamic index is not the correctly-sized width for indexing a Vec or UInt.\n"Correctly-sized" means that the width of the index should be the log2 of the size of the indexee.\nIf the indexee is a non-power-of-2 size, use the ceiling of the log2 result.'}),"\n",(0,o.jsxs)(n.p,{children:["When the index does not have enough bits to address all entries or bits in the extractee, you can ",(0,o.jsx)(n.code,{children:".pad"})," the index to increase the width."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooNarrow extends RawModule {\n  val extractee = Wire(UInt(7.W))\n  val index = Wire(UInt(2.W))\n  extractee(index)\n}\ncompile(new TooNarrow)\n// [warn] cookbook.md 816:12: [W003] Dynamic index with width 2 is too small for extractee of width 7\n// [warn] There were 1 warning(s) during hardware elaboration.\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This can be fixed with ",(0,o.jsx)(n.code,{children:"pad"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooNarrowFixed extends RawModule {\n  val extractee = Wire(UInt(7.W))\n  val index = Wire(UInt(2.W))\n  extractee(index.pad(3))\n}\ncompile(new TooNarrowFixed)\n"})}),"\n",(0,o.jsx)(n.h4,{id:"use-bit-extraction-when-the-index-is-too-wide",children:"Use bit extraction when the index is too wide"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooWide extends RawModule {\n  val extractee = Wire(Vec(8, UInt(32.W)))\n  val index = Wire(UInt(4.W))\n  extractee(index)\n}\ncompile(new TooWide)\n// [warn] cookbook.md 842:12: [W004] Dynamic index with width 4 is too wide for Vec of size 8 (expected index width 3).\n// [warn] There were 1 warning(s) during hardware elaboration.\n"})}),"\n",(0,o.jsx)(n.p,{children:"This can be fixed with bit extraction:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooWideFixed extends RawModule {\n  val extractee = Wire(Vec(8, UInt(32.W)))\n  val index = Wire(UInt(4.W))\n  extractee(index(2, 0))\n}\ncompile(new TooWideFixed)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that size 1 ",(0,o.jsx)(n.code,{children:"Vecs"})," and ",(0,o.jsx)(n.code,{children:"UInts"})," should be indexed by a zero-width ",(0,o.jsx)(n.code,{children:"UInt"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class SizeOneVec extends RawModule {\n  val extractee = Wire(Vec(1, UInt(32.W)))\n  val index = Wire(UInt(0.W))\n  extractee(index)\n}\ncompile(new SizeOneVec)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Because ",(0,o.jsx)(n.code,{children:"pad"})," only pads if the desired width is less than the current width of the argument,\nyou can use ",(0,o.jsx)(n.code,{children:"pad"})," in conjunction with bit extraction when the widths may be too wide or too\nnarrow under different circumstances"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.log2Ceil\nclass TooWideOrNarrow(extracteeSize: Int, indexWidth: Int) extends Module {\n  val extractee = Wire(Vec(extracteeSize, UInt(8.W)))\n  val index = Wire(UInt(indexWidth.W))\n  val correctWidth = log2Ceil(extracteeSize)\n  extractee(index.pad(correctWidth)(correctWidth - 1, 0))\n}\ncompile(new TooWideOrNarrow(8, 2))\ncompile(new TooWideOrNarrow(8, 4))\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Another option for dynamic bit selection of ",(0,o.jsx)(n.code,{children:"UInts"})," (but not ",(0,o.jsx)(n.code,{children:"Vec"})," dynamic indexing) is to do a dynamic\nright shift of the extractee by the index and then just bit select a single bit:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class TooWideOrNarrowUInt(extracteeSize: Int, indexWidth: Int) extends Module {\n  val extractee = Wire(UInt(extracteeSize.W))\n  val index = Wire(UInt(indexWidth.W))\n  (extractee >> index)(0)\n}\ncompile(new TooWideOrNarrowUInt(8, 2))\ncompile(new TooWideOrNarrowUInt(8, 4))\n"})}),"\n",(0,o.jsx)(n.h2,{id:"how-can-i-use-verilog-case-equality-operators-in-chisel",children:'How can I use Verilog "case equality" operators in Chisel?'}),"\n",(0,o.jsxs)(n.p,{children:['Verilog has "case equality" (',(0,o.jsx)(n.code,{children:"==="}),") and inequality (",(0,o.jsx)(n.code,{children:"!=="}),") operators.\nThey are typically used to ignore unknown (",(0,o.jsx)(n.code,{children:"X"}),") values in assertions."]}),"\n",(0,o.jsxs)(n.p,{children:["Chisel does not support Verilog ",(0,o.jsx)(n.code,{children:"X"})," directly, but it is possible to check if a value is ",(0,o.jsx)(n.code,{children:"X"})," with ",(0,o.jsx)(n.code,{children:"chisel3.util.circt.isX"}),".\n",(0,o.jsx)(n.code,{children:"isX"})," is commonly used to guard assertions against ",(0,o.jsx)(n.code,{children:"X"})," which gives similar behavior to Verilog case equality."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.util.circt.IsX\n\nclass AssertButAllowX extends Module {\n  val in = IO(Input(UInt(8.W)))\n\n  // Assert that in is never zero; also do not trigger assert in the presence of X.\n  assert(IsX(in) || in =/= 0.U, "in should never equal 0")\n}\n'})}),"\n",(0,o.jsx)(n.h2,{id:"predictable-naming",children:"Predictable Naming"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-get-chisel-to-name-signals-properly-in-blocks-like-whenwithclockandreset",children:"How do I get Chisel to name signals properly in blocks like when/withClockAndReset?"}),"\n",(0,o.jsxs)(n.p,{children:["Use the compiler plugin, and check out the ",(0,o.jsx)(n.a,{href:"naming",children:"Naming Cookbook"})," if that still does not do what you want."]}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-get-chisel-to-name-the-results-of-vector-reads-properly",children:"How do I get Chisel to name the results of vector reads properly?"}),"\n",(0,o.jsx)(n.p,{children:"Currently, name information is lost when using dynamic indexing. For example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\n\nclass Foo extends Module {\n  val io = IO(new Bundle {\n    val in = Input(Vec(4, Bool()))\n    val idx = Input(UInt(2.W))\n    val en = Input(Bool())\n    val out = Output(Bool())\n  })\n\n  val x = io.in(io.idx)\n  val y = x && io.en\n  io.out := y\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The above code loses the ",(0,o.jsx)(n.code,{children:"x"})," name, instead using ",(0,o.jsx)(n.code,{children:"_GEN_3"})," (the other ",(0,o.jsx)(n.code,{children:"_GEN_*"})," signals are expected)."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Foo(\n  input        clock,\n               reset,\n               io_in_0,\n               io_in_1,\n               io_in_2,\n               io_in_3,\n  input  [1:0] io_idx,\n  input        io_en,\n  output       io_out\n);\n\n  wire [3:0] _GEN = {{io_in_3}, {io_in_2}, {io_in_1}, {io_in_0}};\n  assign io_out = _GEN[io_idx] & io_en;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.p,{children:"This can be worked around by creating a wire and connecting the dynamic index to the wire:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"val x = WireInit(io.in(io.idx))\n"})}),"\n",(0,o.jsx)(n.p,{children:"Which produces:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Foo2(\n  input        clock,\n               reset,\n               io_in_0,\n               io_in_1,\n               io_in_2,\n               io_in_3,\n  input  [1:0] io_idx,\n  input        io_en,\n  output       io_out\n);\n\n  wire [3:0] _GEN = {{io_in_3}, {io_in_2}, {io_in_1}, {io_in_0}};\n  assign io_out = _GEN[io_idx] & io_en;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-can-i-dynamically-setparametrize-the-name-of-a-module",children:"How can I dynamically set/parametrize the name of a module?"}),"\n",(0,o.jsxs)(n.p,{children:["You can override the ",(0,o.jsx)(n.code,{children:"desiredName"})," function. This works with normal Chisel modules and ",(0,o.jsx)(n.code,{children:"BlackBox"}),"es. Example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import chisel3._\n\nclass Coffee extends BlackBox {\n    val io = IO(new Bundle {\n        val I = Input(UInt(32.W))\n        val O = Output(UInt(32.W))\n    })\n    override def desiredName = "Tea"\n}\n\nclass Salt extends Module {\n    val io = IO(new Bundle {})\n    val drink = Module(new Coffee)\n    override def desiredName = "SodiumMonochloride"\n\n    drink.io.I := 42.U\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["Elaborating the Chisel module ",(0,o.jsx)(n.code,{children:"Salt"}),' yields our "desired names" for ',(0,o.jsx)(n.code,{children:"Salt"})," and ",(0,o.jsx)(n.code,{children:"Coffee"})," in the output Verilog:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule SodiumMonochloride(\n  input clock,\n        reset\n);\n\n  Tea drink (\n    .I (32'h2A),\n    .O (/* unused */)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"directionality",children:"Directionality"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-strip-directions-from-a-bidirectional-bundle-or-other-data",children:"How do I strip directions from a bidirectional Bundle (or other Data)?"}),"\n",(0,o.jsxs)(n.p,{children:["Given a bidirectional port like a ",(0,o.jsx)(n.code,{children:"Decoupled"}),", you will get an error if you try to connect it directly\nto a register:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.Decoupled\nclass BadRegConnect extends Module {\n  val io = IO(new Bundle {\n    val enq = Decoupled(UInt(8.W))\n  })\n\n  val monitor = Reg(chiselTypeOf(io.enq))\n  monitor := io.enq\n}\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new BadRegConnect)\n// circt.stage.phases.Exceptions$FirtoolNonZeroExitCode: /home/runner/.cache/llvm-firtool/1.100.0/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+286-ba4e01c3-SNAPSHOT) was published against firtool version 1.100.0.\n// ------------------------------------------------------------------------------\n// ExitCode:\n// 1\n// STDOUT:\n// \n// STDERR:\n// cookbook.md:1039:20: error: 'firrtl.reg' op result #0 must be a passive non-'const' base type that does not contain analog, but got '!firrtl.bundle<ready flip: uint<1>, valid: uint<1>, bits: uint<8>>'\n// cookbook.md:1039:20: note: see current operation: %4 = \"firrtl.reg\"(%arg0) <{annotations = [], name = \"monitor\", nameKind = #firrtl<name_kind interesting_name>}> : (!firrtl.clock) -> !firrtl.bundle<ready flip: uint<1>, valid: uint<1>, bits: uint<8>>\n// \n// ------------------------------------------------------------------------------\n"})}),"\n",(0,o.jsxs)(n.p,{children:['While there is no construct to "strip direction" in Chisel3, wrapping a type in ',(0,o.jsx)(n.code,{children:"Output(...)"}),"\n(the default direction in Chisel3) will\nset all of the individual elements to output direction.\nThis will have the desired result when used to construct a Register:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.Decoupled\nclass CoercedRegConnect extends Module {\n  val io = IO(new Bundle {\n    val enq = Flipped(Decoupled(UInt(8.W)))\n  })\n\n  // Make a Reg which contains all of the bundle's signals, regardless of their directionality\n  val monitor = Reg(Output(chiselTypeOf(io.enq)))\n  // Even though io.enq is bidirectional, := will drive all fields of monitor with the fields of io.enq\n  monitor := io.enq\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},1871:(e,n,a)=>{a.d(n,{A:()=>i});a(6540);var o=a(5195);const t={tableOfContentsInline:"tableOfContentsInline_prmo"};var l=a(4848);function i(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:i}=e;return(0,l.jsx)("div",{className:t.tableOfContentsInline,children:(0,l.jsx)(o.A,{toc:n,minHeadingLevel:a,maxHeadingLevel:i,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,a)=>{a.d(n,{A:()=>g});var o=a(6540),t=a(6342);function l(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),a=Array(7).fill(-1);n.forEach(((e,n)=>{const o=a.slice(2,e.level);e.parentIndex=Math.max(...o),a[e.level]=n}));const o=[];return n.forEach((e=>{const{parentIndex:a,...t}=e;a>=0?n[a].children.push(t):o.push(t)})),o}function i(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:o}=e;return n.flatMap((e=>{const n=i({toc:e.children,minHeadingLevel:a,maxHeadingLevel:o});return function(e){return e.level>=a&&e.level<=o}(e)?[{...e,children:n}]:n}))}function s(e){const n=e.getBoundingClientRect();return n.top===n.bottom?s(e.parentNode):n}function c(e,n){let{anchorTopOffset:a}=n;const o=e.find((e=>s(e).top>=a));if(o){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(s(o))?o:e[e.indexOf(o)-1]??null}return e[e.length-1]??null}function r(){const e=(0,o.useRef)(0),{navbar:{hideOnScroll:n}}=(0,t.p)();return(0,o.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function d(e){const n=(0,o.useRef)(void 0),a=r();(0,o.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:o,linkActiveClassName:t,minHeadingLevel:l,maxHeadingLevel:i}=e;function s(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(o),s=function(e){let{minHeadingLevel:n,maxHeadingLevel:a}=e;const o=[];for(let t=n;t<=a;t+=1)o.push(`h${t}.anchor`);return Array.from(document.querySelectorAll(o.join()))}({minHeadingLevel:l,maxHeadingLevel:i}),r=c(s,{anchorTopOffset:a.current}),d=e.find((e=>r&&r.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,a){a?(n.current&&n.current!==e&&n.current.classList.remove(t),e.classList.add(t),n.current=e):e.classList.remove(t)}(e,e===d)}))}return document.addEventListener("scroll",s),document.addEventListener("resize",s),s(),()=>{document.removeEventListener("scroll",s),document.removeEventListener("resize",s)}}),[e,a])}var u=a(8774),h=a(4848);function p(e){let{toc:n,className:a,linkClassName:o,isChild:t}=e;return n.length?(0,h.jsx)("ul",{className:t?void 0:a,children:n.map((e=>(0,h.jsxs)("li",{children:[(0,h.jsx)(u.A,{to:`#${e.id}`,className:o??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,h.jsx)(p,{isChild:!0,toc:e.children,className:a,linkClassName:o})]},e.id)))}):null}const m=o.memo(p);function g(e){let{toc:n,className:a="table-of-contents table-of-contents__left-border",linkClassName:s="table-of-contents__link",linkActiveClassName:c,minHeadingLevel:r,maxHeadingLevel:u,...p}=e;const g=(0,t.p)(),x=r??g.tableOfContents.minHeadingLevel,f=u??g.tableOfContents.maxHeadingLevel,w=function(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:t}=e;return(0,o.useMemo)((()=>i({toc:l(n),minHeadingLevel:a,maxHeadingLevel:t})),[n,a,t])}({toc:n,minHeadingLevel:x,maxHeadingLevel:f});return d((0,o.useMemo)((()=>{if(s&&c)return{linkClassName:s,linkActiveClassName:c,minHeadingLevel:x,maxHeadingLevel:f}}),[s,c,x,f])),(0,h.jsx)(m,{toc:w,className:a,linkClassName:s,...p})}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>s});var o=a(6540);const t={},l=o.createContext(t);function i(e){const n=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),o.createElement(l.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/868241d3.1a857a9d.js b/assets/js/868241d3.1a857a9d.js
new file mode 100644
index 0000000000..f07a604a65
--- /dev/null
+++ b/assets/js/868241d3.1a857a9d.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[9017],{5268:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>r});var c=s(4848),t=s(8453);const i={},a=void 0,l={type:"mdx",permalink:"/generated/scaladoc_links",source:"@site/src/pages/generated/scaladoc_links.md",description:"- Latest (6.6.0)",frontMatter:{},unlisted:!1},o={},r=[];function h(e){const n={a:"a",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,c.jsxs)(n.ul,{children:["\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"pathname:///api/latest/index.html",children:"Latest (6.6.0)"})}),"\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://s01.oss.sonatype.org/service/local/repositories/snapshots/archive/org/chipsalliance/chisel_2.13/7.0.0-M2+286-ba4e01c3-SNAPSHOT/chisel_2.13-7.0.0-M2+286-ba4e01c3-SNAPSHOT-javadoc.jar/!/index.html",children:"Snapshot"})}),"\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/7.0.0-M2",children:"7.0.0-M2"})}),"\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/6.6.0",children:"6.6.0"})}),"\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/5.3.0",children:"5.3.0"})}),"\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.6.1",children:"3.6.1"})}),"\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.5.6",children:"3.5.6"})}),"\n"]})}function d(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>l});var c=s(6540);const t={},i=c.createContext(t);function a(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/868241d3.2d32cef4.js b/assets/js/868241d3.2d32cef4.js
deleted file mode 100644
index c8dd116b8d..0000000000
--- a/assets/js/868241d3.2d32cef4.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[9017],{5268:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>r});var t=s(4848),c=s(8453);const i={},l=void 0,a={type:"mdx",permalink:"/generated/scaladoc_links",source:"@site/src/pages/generated/scaladoc_links.md",description:"- Latest (6.6.0)",frontMatter:{},unlisted:!1},o={},r=[];function h(e){const n={a:"a",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"pathname:///api/latest/index.html",children:"Latest (6.6.0)"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://s01.oss.sonatype.org/service/local/repositories/snapshots/archive/org/chipsalliance/chisel_2.13/7.0.0-M2+285-e12935ed-SNAPSHOT/chisel_2.13-7.0.0-M2+285-e12935ed-SNAPSHOT-javadoc.jar/!/index.html",children:"Snapshot"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/7.0.0-M2",children:"7.0.0-M2"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/6.6.0",children:"6.6.0"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/5.3.0",children:"5.3.0"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.6.1",children:"3.6.1"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.5.6",children:"3.5.6"})}),"\n"]})}function d(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>l,x:()=>a});var t=s(6540);const c={},i=t.createContext(c);function l(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:l(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/916cecd1.90b255c9.js b/assets/js/916cecd1.90b255c9.js
deleted file mode 100644
index e00bd1bce8..0000000000
--- a/assets/js/916cecd1.90b255c9.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[2289],{2358:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>d,toc:()=>c});var i=a(4848),s=a(8453),t=a(1871);const l={sidebar_position:1},o="Naming Cookbook",d={id:"cookbooks/naming",title:"Naming Cookbook",description:"I still have _T signals, can this be fixed?",source:"@site/docs/cookbooks/naming.md",sourceDirName:"cookbooks",slug:"/cookbooks/naming",permalink:"/docs/cookbooks/naming",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/naming.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"chiselSidebar",previous:{title:"General Cookbook",permalink:"/docs/cookbooks/cookbook"},next:{title:"Hierarchy Cookbook",permalink:"/docs/cookbooks/hierarchy"}},r={},c=[{value:"I still have _T signals, can this be fixed?",id:"i-still-have-_t-signals-can-this-be-fixed",level:3},{value:"I have so many wires with the same name, like <code>x</code>, <code>x_1</code> and <code>x_2</code>. How can I make them easier to understand?",id:"i-have-so-many-wires-with-the-same-name-like-x-x_1-and-x_2-how-can-i-make-them-easier-to-understand",level:3},{value:"How can I get better names for code generated by <code>when</code> clauses?",id:"how-can-i-get-better-names-for-code-generated-by-when-clauses",level:3},{value:"I still see _GEN signals, can this be fixed?",id:"i-still-see-_gen-signals-can-this-be-fixed",level:3},{value:"How do I make my modules have more stable names instead of &#39;Module_1&#39; and &#39;Module_42&#39;?",id:"how-do-i-make-my-modules-have-more-stable-names-instead-of-module_1-and-module_42",level:3},{value:"How would I write my own <code>typeName</code> for my data types?",id:"how-would-i-write-my-own-typename-for-my-data-types",level:3},{value:"I don&#39;t want to override <code>typeName</code> over and over! Is there any easy way to generate a <code>typeName</code>?",id:"i-dont-want-to-override-typename-over-and-over-is-there-any-easy-way-to-generate-a-typename",level:3},{value:"Can I name my bundles in FIRRTL, so I don&#39;t generate extremely long bundle types?",id:"can-i-name-my-bundles-in-firrtl-so-i-dont-generate-extremely-long-bundle-types",level:3},{value:"Why do I keep seeing _stripped suffixing everywhere in my FIRRTL? I didn&#39;t specify that in my <code>aliasName</code>.",id:"why-do-i-keep-seeing-_stripped-suffixing-everywhere-in-my-firrtl-i-didnt-specify-that-in-my-aliasname",level:3},{value:"I want to add some hardware or assertions, but each time I do all the signal names get bumped!",id:"i-want-to-add-some-hardware-or-assertions-but-each-time-i-do-all-the-signal-names-get-bumped",level:3},{value:"I want to force a signal (or instance) name to something, how do I do that?",id:"i-want-to-force-a-signal-or-instance-name-to-something-how-do-i-do-that",level:3},{value:"How can I omit the prefix in certain parts of the code?",id:"how-can-i-omit-the-prefix-in-certain-parts-of-the-code",level:3},{value:"I am still not getting the name I want. For example, inlining an instance changes my name!",id:"i-am-still-not-getting-the-name-i-want-for-example-inlining-an-instance-changes-my-name",level:3}];function u(e){const n={a:"a",code:"code",em:"em",h1:"h1",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"naming-cookbook",children:"Naming Cookbook"})}),"\n","\n",(0,i.jsx)(t.A,{toc:c}),"\n",(0,i.jsx)(n.h3,{id:"i-still-have-_t-signals-can-this-be-fixed",children:"I still have _T signals, can this be fixed?"}),"\n",(0,i.jsx)(n.p,{children:"See the next answer!"}),"\n",(0,i.jsxs)(n.h3,{id:"i-have-so-many-wires-with-the-same-name-like-x-x_1-and-x_2-how-can-i-make-them-easier-to-understand",children:["I have so many wires with the same name, like ",(0,i.jsx)(n.code,{children:"x"}),", ",(0,i.jsx)(n.code,{children:"x_1"})," and ",(0,i.jsx)(n.code,{children:"x_2"}),". How can I make them easier to understand?"]}),"\n",(0,i.jsxs)(n.p,{children:["Signals with ",(0,i.jsx)(n.code,{children:"_T"})," names or names that Chisel has to uniquify\noften are intermediate values generated within loops, function calls, or ",(0,i.jsx)(n.code,{children:"when"})," predicates.\nThey can also be consumed by verification statements like ",(0,i.jsx)(n.code,{children:"assert"})," or ",(0,i.jsx)(n.code,{children:"prints"}),".\nIn these cases, the compiler plugin often can't find a good prefix for the generated\nintermediate signals and can't name them at all or has to make up a unique name for them."]}),"\n",(0,i.jsxs)(n.p,{children:["We recommend you manually insert calls to ",(0,i.jsx)(n.code,{children:"prefix"})," to clarify these cases:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'import chisel3.experimental.prefix\nclass ExamplePrefix extends Module {\n\n  Seq.tabulate(2) { i =>\n    Seq.tabulate(2) { j =>\n      prefix(s"loop_${i}_${j}"){\n        val x = WireInit((i*0x10+j).U(8.W))\n        dontTouch(x)\n      }\n    }\n  }\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule ExamplePrefix(\n  input clock,\n        reset\n);\n\n  wire [7:0] loop_0_0_x = 8'h0;\n  wire [7:0] loop_0_1_x = 8'h1;\n  wire [7:0] loop_1_0_x = 8'h10;\n  wire [7:0] loop_1_1_x = 8'h11;\nendmodule\n\n"})}),"\n",(0,i.jsxs)(n.h3,{id:"how-can-i-get-better-names-for-code-generated-by-when-clauses",children:["How can I get better names for code generated by ",(0,i.jsx)(n.code,{children:"when"})," clauses?"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"prefix"})," API can help with code inside ",(0,i.jsx)(n.code,{children:"when"})," clauses:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class ExampleWhenPrefix extends Module {\n\n  val in = IO(Input(UInt(4.W)))\n  val out = IO(Output(UInt(4.W)))\n\n  out := DontCare\n\n  Seq.tabulate(2) { i =>\n    val j = i + 1\n    prefix(s"clause_${j}") {\n      when (in === j.U) {\n        val foo = Reg(UInt(4.W))\n        foo := in + j.U(4.W)\n        out := foo\n      }\n    }\n  }\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule ExampleWhenPrefix(\n  input        clock,\n               reset,\n  input  [3:0] in,\n  output [3:0] out\n);\n\n  reg [3:0] clause_1_foo;\n  reg [3:0] clause_2_foo;\n  always @(posedge clock) begin\n    clause_1_foo <= in + 4'h1;\n    clause_2_foo <= in + 4'h2;\n  end // always @(posedge)\n  assign out = in == 4'h2 ? clause_2_foo : clause_1_foo;\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.h3,{id:"i-still-see-_gen-signals-can-this-be-fixed",children:"I still see _GEN signals, can this be fixed?"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"_GEN"})," signals are usually generated from the FIRRTL compiler, rather than the Chisel library. We are working on\nrenaming these signals with more context-dependent names, but it is a work in progress. Thanks for caring!"]}),"\n",(0,i.jsx)(n.h3,{id:"how-do-i-make-my-modules-have-more-stable-names-instead-of-module_1-and-module_42",children:"How do I make my modules have more stable names instead of 'Module_1' and 'Module_42'?"}),"\n",(0,i.jsxs)(n.p,{children:["This is an example of the module instability problem, which results from several modules all sharing the exact same name. To fix this, you must add more specificity to your ",(0,i.jsx)(n.code,{children:"Module"}),"'s name to avoid these name collisions."]}),"\n",(0,i.jsxs)(n.p,{children:["This can be done by leveraging the ",(0,i.jsx)(n.code,{children:"desiredName"})," and ",(0,i.jsx)(n.code,{children:"typeName"})," APIs.\n",(0,i.jsx)(n.code,{children:"desiredName"})," is for indicating the names of ",(0,i.jsx)(n.code,{children:"Modules"})," (e.g. influenced by the parameters passed in), and ",(0,i.jsx)(n.code,{children:"typeName"})," is useful for modules which are type-parameterized by subclasses of ",(0,i.jsx)(n.code,{children:"Data"}),". Overriding ",(0,i.jsx)(n.code,{children:"desiredName"})," can reduce or even eliminate name collisions. For instance, suppose your module looks like the following:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class MyModule[T <: Data](gen: T) extends Module {\n  // ...\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["We can override ",(0,i.jsx)(n.code,{children:"desiredName"})," of the module to include the type name of the ",(0,i.jsx)(n.code,{children:"gen"})," parameter like so:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class MyModule[T <: Data](gen: T) extends Module {\n  override def desiredName = s"MyModule_${gen.typeName}"\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Any instances of your ",(0,i.jsx)(n.code,{children:"MyModule"})," will now have Verilog module names containing the type parameter."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"val foo = Module(new MyModule(UInt(4.W))) // MyModule_UInt4 // MyModule_UInt4\nval bar = Module(new MyModule(Vec(3, UInt(4.W)))) // MyModule_Vec3_UInt4\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Note that all base Chisel util modules, like ",(0,i.jsx)(n.code,{children:"Queue"}),", already implement ",(0,i.jsx)(n.code,{children:"desiredName"})," like this:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"val fooQueue = Module(new Queue(UInt(8.W), 4)) // Verilog module would be named 'Queue4_UInt8' // Verilog module would be named 'Queue4_UInt8'\nval barQueue = Module(new Queue(SInt(12.W), 3)) // ... and 'Queue3_SInt12' // ... and 'Queue3_SInt12'\nval bazQueue = Module(new Queue(Bool(), 16)) // ... and 'Queue16_Bool'\n"})}),"\n",(0,i.jsxs)(n.h3,{id:"how-would-i-write-my-own-typename-for-my-data-types",children:["How would I write my own ",(0,i.jsx)(n.code,{children:"typeName"})," for my data types?"]}),"\n",(0,i.jsxs)(n.p,{children:["If you're using your own user-defined ",(0,i.jsx)(n.code,{children:"Bundle"}),", you can increase the specificity of its own ",(0,i.jsx)(n.code,{children:"typeName"})," by overriding it. All ",(0,i.jsx)(n.code,{children:"Data"})," types have a simple default implementation of ",(0,i.jsx)(n.code,{children:"typeName"})," (which is simply its class name), but you can override this yourself:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class MyBundle[T <: Data](gen: T, intParam: Int) extends Bundle {\n  // Generate a stable typeName for this Bundle. Two 'words' are present\n  // in this implementation: the bundle's name plus its integer parameter\n  // (something like 'MyBundle9')\n  // and the generator's typeName, which itself can be composed of 'words'\n  // (something like 'Vec3_UInt4')\n  override def typeName = s\"MyBundle${intParam}_${gen.typeName}\"\n\n  // ...\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Now if you use your ",(0,i.jsx)(n.code,{children:"MyBundle"})," in a module like a ",(0,i.jsx)(n.code,{children:"Queue"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"val fooQueue = Module(new Queue(new MyBundle(UInt(4.W), 3), 16)) // Queue16_MyBundle3_UInt4\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The suggested pattern for ",(0,i.jsx)(n.code,{children:"typeName"}),", and subsequently ",(0,i.jsx)(n.code,{children:"desiredName"}),", is to fold single integer-like parameters with the name itself (for example, ",(0,i.jsx)(n.code,{children:"Queue4"}),", ",(0,i.jsx)(n.code,{children:"UInt3"}),", ",(0,i.jsx)(n.code,{children:"MyBundle9"}),") to form 'words' and separate these 'words' with underscores (",(0,i.jsx)(n.code,{children:"Queue4_UInt3"}),", ",(0,i.jsx)(n.code,{children:"FooBundle_BarType4"}),")."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Bundles"})," that have multiple integer arguments aren't presently addressed by any of the built-in modules, and so implementing a descriptive and sufficiently differentiable ",(0,i.jsx)(n.code,{children:"typeName"})," for such ",(0,i.jsx)(n.code,{children:"Bundles"})," is left as an exercise to the reader. However, integers should not occur with an underscore before them at the very end of the ",(0,i.jsx)(n.code,{children:"typeName"})," (e.g. ",(0,i.jsx)(n.code,{children:"MyBundle_1"}),") because this is the ",(0,i.jsx)(n.em,{children:"same"})," syntax used for duplicates, and so would cause confusion. Having to disambiguate modules all named ",(0,i.jsx)(n.code,{children:"Queue32_MyBundle_4_1"}),", ",(0,i.jsx)(n.code,{children:"Queue32_MyBundle_4_2"}),", ",(0,i.jsx)(n.code,{children:"Queue32_MyBundle_4_3"}),", and so on would be undesirable, indeed!"]}),"\n",(0,i.jsxs)(n.h3,{id:"i-dont-want-to-override-typename-over-and-over-is-there-any-easy-way-to-generate-a-typename",children:["I don't want to override ",(0,i.jsx)(n.code,{children:"typeName"})," over and over! Is there any easy way to generate a ",(0,i.jsx)(n.code,{children:"typeName"}),"?"]}),"\n",(0,i.jsxs)(n.p,{children:["Yes, with the experimental ",(0,i.jsx)(n.code,{children:"HasAutoTypename"})," trait. This trait can be mixed into your ",(0,i.jsx)(n.code,{children:"Bundle"}),"s to automatically generate a tuple-like ",(0,i.jsx)(n.code,{children:"typeName"})," for them, based on the constructor parameters of that ",(0,i.jsx)(n.code,{children:"Bundle"}),". Let's look at the previous examples:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class MyBundle[T <: Data](gen: T, intParam: Int) extends Bundle {\n  override def typeName = s"MyBundle_${gen.typeName}_${intParam}"\n  // ...\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'new MyBundle(UInt(8.W), 3).typeName\n// res7: String = "MyBundle_UInt<8>_3"\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Auto-generated ",(0,i.jsx)(n.code,{children:"typeName"}),"s take the form of ",(0,i.jsx)(n.code,{children:"{Bundle Name}_{Parameter Value 1}_{Parameter Value 2}_{...}"}),", and so our ",(0,i.jsx)(n.code,{children:"MyBundle"})," can be equivalently expressed with:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.HasAutoTypename\nclass MyBundle[T <: Data](gen: T, intParam: Int) extends Bundle with HasAutoTypename {\n  // ...\n  // Note: No `override def typeName` statement here\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'new MyBundle(UInt(8.W), 3).typeName\n// res9: String = "MyBundle_UInt<8>_3"\n'})}),"\n",(0,i.jsx)(n.h3,{id:"can-i-name-my-bundles-in-firrtl-so-i-dont-generate-extremely-long-bundle-types",children:"Can I name my bundles in FIRRTL, so I don't generate extremely long bundle types?"}),"\n",(0,i.jsxs)(n.p,{children:["Yes, using the ",(0,i.jsx)(n.code,{children:"HasTypeAlias"})," trait. FIRRTL has a construct to alias a bundle type with a type alias like so:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"circuit Top :\n  type MyBundle = { foo : UInt<8>, bar : UInt<1>}\n\n  module Top :\n    //...\n"})}),"\n",(0,i.jsxs)(n.p,{children:["These can be automatically emitted from Chisel by mixing ",(0,i.jsx)(n.code,{children:"HasTypeAlias"})," into a user-defined ",(0,i.jsx)(n.code,{children:"Record"}),", and implementing a field named ",(0,i.jsx)(n.code,{children:"aliasName"})," with a ",(0,i.jsx)(n.code,{children:"RecordAlias(...)"})," instance."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'import chisel3.experimental.{HasTypeAlias, RecordAlias}\n\nclass AliasedBundle extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("MyAliasedBundle")\n  val foo = UInt(8.W)\n  val bar = Bool()\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Let's see what happens when we generate FIRRTL using this ",(0,i.jsx)(n.code,{children:"Bundle"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'emitFIRRTL(new Module {\n  val wire = Wire(new AliasedBundle)\n})\n// res10: String = """FIRRTL version 4.2.0\n// circuit _18_Anon :\n//   type MyAliasedBundle = { foo : UInt<8>, bar : UInt<1>}\n// \n//   layer Verification, bind, "verification" :\n//     layer Assert, bind, "verification/assert" :\n//     layer Assume, bind, "verification/assume" :\n//     layer Cover, bind, "verification/cover" :\n//   public module _18_Anon : @[naming.md 232:28]\n//     input clock : Clock @[naming.md 232:28]\n//     input reset : UInt<1> @[naming.md 232:28]\n// \n//     wire wire : MyAliasedBundle @[naming.md 233:18]\n// \n// """\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"HasTypeAlias"})," also supports nested bundles, too:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class Child extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("ChildBundle")\n  val x = UInt(8.W)\n}\n\nclass Parent extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("ParentBundle")\n  val child = new Child\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'emitFIRRTL(new Module {\n  val wire = Wire(new Parent)\n})\n// res11: String = """FIRRTL version 4.2.0\n// circuit _22_Anon :\n//   type ChildBundle = { x : UInt<8>}\n//   type ParentBundle = { child : ChildBundle}\n// \n//   layer Verification, bind, "verification" :\n//     layer Assert, bind, "verification/assert" :\n//     layer Assume, bind, "verification/assume" :\n//     layer Cover, bind, "verification/cover" :\n//   public module _22_Anon : @[naming.md 255:28]\n//     input clock : Clock @[naming.md 255:28]\n//     input reset : UInt<1> @[naming.md 255:28]\n// \n//     wire wire : ParentBundle @[naming.md 256:18]\n// \n// """\n'})}),"\n",(0,i.jsxs)(n.h3,{id:"why-do-i-keep-seeing-_stripped-suffixing-everywhere-in-my-firrtl-i-didnt-specify-that-in-my-aliasname",children:["Why do I keep seeing _stripped suffixing everywhere in my FIRRTL? I didn't specify that in my ",(0,i.jsx)(n.code,{children:"aliasName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["You're using an ",(0,i.jsx)(n.code,{children:"Input(...)"})," or ",(0,i.jsx)(n.code,{children:"Output(...)"})," in conjunction with an aliased ",(0,i.jsx)(n.code,{children:"Record"})," that contains a ",(0,i.jsx)(n.code,{children:"Flipped(...)"}),". These flipped values are stripped by ",(0,i.jsx)(n.code,{children:"Input"})," and ",(0,i.jsx)(n.code,{children:"Output"})," which fundamentally changes the type of the parent ",(0,i.jsx)(n.code,{children:"Record"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class StrippedBundle extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("StrippedBundle")\n  val flipped = Flipped(UInt(8.W))\n  val normal = UInt(8.W)\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'emitFIRRTL(new Module {\n  val in = IO(Input(new StrippedBundle))\n})\n// res12: String = """FIRRTL version 4.2.0\n// circuit _26_Anon :\n//   type StrippedBundle_stripped = { flipped : UInt<8>, normal : UInt<8>}\n// \n//   layer Verification, bind, "verification" :\n//     layer Assert, bind, "verification/assert" :\n//     layer Assume, bind, "verification/assume" :\n//     layer Cover, bind, "verification/cover" :\n//   public module _26_Anon : @[naming.md 273:28]\n//     input clock : Clock @[naming.md 273:28]\n//     input reset : UInt<1> @[naming.md 273:28]\n//     input in : StrippedBundle_stripped @[naming.md 274:14]\n// \n//     skip\n// \n// """\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Note how the bundle type doesn't contain a ",(0,i.jsx)(n.code,{children:"flip flipped : UInt<8>"})," field, and the alias gains a ",(0,i.jsx)(n.code,{children:'"_stripped"'})," suffix! This ",(0,i.jsx)(n.code,{children:"Bundle"})," type is no longer the same as the one we wrote in Chisel, so we have to distinguish it as such."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, the suffix appended to ",(0,i.jsx)(n.code,{children:"Record"})," names is ",(0,i.jsx)(n.code,{children:'"_stripped"'}),". This can be defined by users with an additional string argument passed to ",(0,i.jsx)(n.code,{children:"RecordAlias(alias, strippedSuffix)"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class CustomStrippedBundle extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("StrippedBundle", "Foo")\n  val flipped = Flipped(UInt(8.W))\n  val normal = UInt(8.W)\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'emitFIRRTL(new Module {\n  val in = IO(Input(new CustomStrippedBundle))\n})\n// res13: String = """FIRRTL version 4.2.0\n// circuit _30_Anon :\n//   type StrippedBundleFoo = { flipped : UInt<8>, normal : UInt<8>}\n// \n//   layer Verification, bind, "verification" :\n//     layer Assert, bind, "verification/assert" :\n//     layer Assume, bind, "verification/assume" :\n//     layer Cover, bind, "verification/cover" :\n//   public module _30_Anon : @[naming.md 291:28]\n//     input clock : Clock @[naming.md 291:28]\n//     input reset : UInt<1> @[naming.md 291:28]\n//     input in : StrippedBundleFoo @[naming.md 292:14]\n// \n//     skip\n// \n// """\n'})}),"\n",(0,i.jsx)(n.h3,{id:"i-want-to-add-some-hardware-or-assertions-but-each-time-i-do-all-the-signal-names-get-bumped",children:"I want to add some hardware or assertions, but each time I do all the signal names get bumped!"}),"\n",(0,i.jsxs)(n.p,{children:['This is the classic "ECO" problem, and we provide descriptions in ',(0,i.jsx)(n.a,{href:"../explanations/naming",children:"explanation"}),". In short,\nwe recommend wrapping all additional logic in a prefix scope, which enables a unique namespace. This should prevent\nname collisions, which are what triggers all those annoying signal name bumps!"]}),"\n",(0,i.jsx)(n.h3,{id:"i-want-to-force-a-signal-or-instance-name-to-something-how-do-i-do-that",children:"I want to force a signal (or instance) name to something, how do I do that?"}),"\n",(0,i.jsxs)(n.p,{children:["Use the ",(0,i.jsx)(n.code,{children:".suggestName"})," method, which is on all classes which subtype ",(0,i.jsx)(n.code,{children:"Data"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"how-can-i-omit-the-prefix-in-certain-parts-of-the-code",children:"How can I omit the prefix in certain parts of the code?"}),"\n",(0,i.jsxs)(n.p,{children:["You can use the ",(0,i.jsx)(n.code,{children:"noPrefix { ... }"})," to strip the prefix from all signals generated in that scope."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.noPrefix\n\nclass ExampleNoPrefix extends Module {\n  val in = IO(Input(UInt(2.W)))\n  val out = IO(Output(UInt(5.W)))\n\n  val add = noPrefix {\n    // foo will not get a prefix\n    val foo = RegNext(in + 1.U)\n    foo + in\n  }\n\n  out := add\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule ExampleNoPrefix(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [4:0] out\n);\n\n  reg [1:0] foo;\n  always @(posedge clock)\n    foo <= in + 2'h1;\n  assign out = {3'h0, foo + in};\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.h3,{id:"i-am-still-not-getting-the-name-i-want-for-example-inlining-an-instance-changes-my-name",children:"I am still not getting the name I want. For example, inlining an instance changes my name!"}),"\n",(0,i.jsxs)(n.p,{children:["In cases where a FIRRTL transform renames a signal/instance, you can use the ",(0,i.jsx)(n.code,{children:"forcename"})," API:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'import chisel3.util.experimental.{forceName, InlineInstance}\n\nclass WrapperExample extends Module {\n  val in = IO(Input(UInt(3.W)))\n  val out = IO(Output(UInt(3.W)))\n  val inst = Module(new Wrapper)\n  inst.in := in\n  out := inst.out\n}\nclass Wrapper extends Module with InlineInstance {\n  val in = IO(Input(UInt(3.W)))\n  val out = IO(Output(UInt(3.W)))\n  val inst = Module(new MyLeaf)\n  forceName(inst, "inst")\n  inst.in := in\n  out := inst.out\n}\nclass MyLeaf extends Module {\n  val in = IO(Input(UInt(3.W)))\n  val out = IO(Output(UInt(3.W)))\n  out := in\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule MyLeaf(\n  input  [2:0] in,\n  output [2:0] out\n);\n\n  assign out = in;\nendmodule\n\nmodule WrapperExample(\n  input        clock,\n               reset,\n  input  [2:0] in,\n  output [2:0] out\n);\n\n  MyLeaf inst (\n    .in  (in),\n    .out (out)\n  );\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.p,{children:"This can be used to rename instances and non-aggregate typed signals."})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},1871:(e,n,a)=>{a.d(n,{A:()=>l});a(6540);var i=a(5195);const s={tableOfContentsInline:"tableOfContentsInline_prmo"};var t=a(4848);function l(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:l}=e;return(0,t.jsx)("div",{className:s.tableOfContentsInline,children:(0,t.jsx)(i.A,{toc:n,minHeadingLevel:a,maxHeadingLevel:l,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,a)=>{a.d(n,{A:()=>x});var i=a(6540),s=a(6342);function t(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),a=Array(7).fill(-1);n.forEach(((e,n)=>{const i=a.slice(2,e.level);e.parentIndex=Math.max(...i),a[e.level]=n}));const i=[];return n.forEach((e=>{const{parentIndex:a,...s}=e;a>=0?n[a].children.push(s):i.push(s)})),i}function l(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:i}=e;return n.flatMap((e=>{const n=l({toc:e.children,minHeadingLevel:a,maxHeadingLevel:i});return function(e){return e.level>=a&&e.level<=i}(e)?[{...e,children:n}]:n}))}function o(e){const n=e.getBoundingClientRect();return n.top===n.bottom?o(e.parentNode):n}function d(e,n){let{anchorTopOffset:a}=n;const i=e.find((e=>o(e).top>=a));if(i){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(o(i))?i:e[e.indexOf(i)-1]??null}return e[e.length-1]??null}function r(){const e=(0,i.useRef)(0),{navbar:{hideOnScroll:n}}=(0,s.p)();return(0,i.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function c(e){const n=(0,i.useRef)(void 0),a=r();(0,i.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:i,linkActiveClassName:s,minHeadingLevel:t,maxHeadingLevel:l}=e;function o(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(i),o=function(e){let{minHeadingLevel:n,maxHeadingLevel:a}=e;const i=[];for(let s=n;s<=a;s+=1)i.push(`h${s}.anchor`);return Array.from(document.querySelectorAll(i.join()))}({minHeadingLevel:t,maxHeadingLevel:l}),r=d(o,{anchorTopOffset:a.current}),c=e.find((e=>r&&r.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,a){a?(n.current&&n.current!==e&&n.current.classList.remove(s),e.classList.add(s),n.current=e):e.classList.remove(s)}(e,e===c)}))}return document.addEventListener("scroll",o),document.addEventListener("resize",o),o(),()=>{document.removeEventListener("scroll",o),document.removeEventListener("resize",o)}}),[e,a])}var u=a(8774),h=a(4848);function m(e){let{toc:n,className:a,linkClassName:i,isChild:s}=e;return n.length?(0,h.jsx)("ul",{className:s?void 0:a,children:n.map((e=>(0,h.jsxs)("li",{children:[(0,h.jsx)(u.A,{to:`#${e.id}`,className:i??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,h.jsx)(m,{isChild:!0,toc:e.children,className:a,linkClassName:i})]},e.id)))}):null}const p=i.memo(m);function x(e){let{toc:n,className:a="table-of-contents table-of-contents__left-border",linkClassName:o="table-of-contents__link",linkActiveClassName:d,minHeadingLevel:r,maxHeadingLevel:u,...m}=e;const x=(0,s.p)(),g=r??x.tableOfContents.minHeadingLevel,f=u??x.tableOfContents.maxHeadingLevel,y=function(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:s}=e;return(0,i.useMemo)((()=>l({toc:t(n),minHeadingLevel:a,maxHeadingLevel:s})),[n,a,s])}({toc:n,minHeadingLevel:g,maxHeadingLevel:f});return c((0,i.useMemo)((()=>{if(o&&d)return{linkClassName:o,linkActiveClassName:d,minHeadingLevel:g,maxHeadingLevel:f}}),[o,d,g,f])),(0,h.jsx)(p,{toc:y,className:a,linkClassName:o,...m})}},8453:(e,n,a)=>{a.d(n,{R:()=>l,x:()=>o});var i=a(6540);const s={},t=i.createContext(s);function l(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/916cecd1.94aedafa.js b/assets/js/916cecd1.94aedafa.js
new file mode 100644
index 0000000000..7ee53440ff
--- /dev/null
+++ b/assets/js/916cecd1.94aedafa.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[2289],{2358:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>d,toc:()=>c});var i=a(4848),s=a(8453),t=a(1871);const l={sidebar_position:1},o="Naming Cookbook",d={id:"cookbooks/naming",title:"Naming Cookbook",description:"I still have _T signals, can this be fixed?",source:"@site/docs/cookbooks/naming.md",sourceDirName:"cookbooks",slug:"/cookbooks/naming",permalink:"/docs/cookbooks/naming",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/naming.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"chiselSidebar",previous:{title:"General Cookbook",permalink:"/docs/cookbooks/cookbook"},next:{title:"Hierarchy Cookbook",permalink:"/docs/cookbooks/hierarchy"}},r={},c=[{value:"I still have _T signals, can this be fixed?",id:"i-still-have-_t-signals-can-this-be-fixed",level:3},{value:"I have so many wires with the same name, like <code>x</code>, <code>x_1</code> and <code>x_2</code>. How can I make them easier to understand?",id:"i-have-so-many-wires-with-the-same-name-like-x-x_1-and-x_2-how-can-i-make-them-easier-to-understand",level:3},{value:"How can I get better names for code generated by <code>when</code> clauses?",id:"how-can-i-get-better-names-for-code-generated-by-when-clauses",level:3},{value:"I still see _GEN signals, can this be fixed?",id:"i-still-see-_gen-signals-can-this-be-fixed",level:3},{value:"How do I make my modules have more stable names instead of &#39;Module_1&#39; and &#39;Module_42&#39;?",id:"how-do-i-make-my-modules-have-more-stable-names-instead-of-module_1-and-module_42",level:3},{value:"How would I write my own <code>typeName</code> for my data types?",id:"how-would-i-write-my-own-typename-for-my-data-types",level:3},{value:"I don&#39;t want to override <code>typeName</code> over and over! Is there any easy way to generate a <code>typeName</code>?",id:"i-dont-want-to-override-typename-over-and-over-is-there-any-easy-way-to-generate-a-typename",level:3},{value:"Can I name my bundles in FIRRTL, so I don&#39;t generate extremely long bundle types?",id:"can-i-name-my-bundles-in-firrtl-so-i-dont-generate-extremely-long-bundle-types",level:3},{value:"Why do I keep seeing _stripped suffixing everywhere in my FIRRTL? I didn&#39;t specify that in my <code>aliasName</code>.",id:"why-do-i-keep-seeing-_stripped-suffixing-everywhere-in-my-firrtl-i-didnt-specify-that-in-my-aliasname",level:3},{value:"I want to add some hardware or assertions, but each time I do all the signal names get bumped!",id:"i-want-to-add-some-hardware-or-assertions-but-each-time-i-do-all-the-signal-names-get-bumped",level:3},{value:"I want to force a signal (or instance) name to something, how do I do that?",id:"i-want-to-force-a-signal-or-instance-name-to-something-how-do-i-do-that",level:3},{value:"How can I omit the prefix in certain parts of the code?",id:"how-can-i-omit-the-prefix-in-certain-parts-of-the-code",level:3},{value:"I am still not getting the name I want. For example, inlining an instance changes my name!",id:"i-am-still-not-getting-the-name-i-want-for-example-inlining-an-instance-changes-my-name",level:3}];function u(e){const n={a:"a",code:"code",em:"em",h1:"h1",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"naming-cookbook",children:"Naming Cookbook"})}),"\n","\n",(0,i.jsx)(t.A,{toc:c}),"\n",(0,i.jsx)(n.h3,{id:"i-still-have-_t-signals-can-this-be-fixed",children:"I still have _T signals, can this be fixed?"}),"\n",(0,i.jsx)(n.p,{children:"See the next answer!"}),"\n",(0,i.jsxs)(n.h3,{id:"i-have-so-many-wires-with-the-same-name-like-x-x_1-and-x_2-how-can-i-make-them-easier-to-understand",children:["I have so many wires with the same name, like ",(0,i.jsx)(n.code,{children:"x"}),", ",(0,i.jsx)(n.code,{children:"x_1"})," and ",(0,i.jsx)(n.code,{children:"x_2"}),". How can I make them easier to understand?"]}),"\n",(0,i.jsxs)(n.p,{children:["Signals with ",(0,i.jsx)(n.code,{children:"_T"})," names or names that Chisel has to uniquify\noften are intermediate values generated within loops, function calls, or ",(0,i.jsx)(n.code,{children:"when"})," predicates.\nThey can also be consumed by verification statements like ",(0,i.jsx)(n.code,{children:"assert"})," or ",(0,i.jsx)(n.code,{children:"prints"}),".\nIn these cases, the compiler plugin often can't find a good prefix for the generated\nintermediate signals and can't name them at all or has to make up a unique name for them."]}),"\n",(0,i.jsxs)(n.p,{children:["We recommend you manually insert calls to ",(0,i.jsx)(n.code,{children:"prefix"})," to clarify these cases:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'import chisel3.experimental.prefix\nclass ExamplePrefix extends Module {\n\n  Seq.tabulate(2) { i =>\n    Seq.tabulate(2) { j =>\n      prefix(s"loop_${i}_${j}"){\n        val x = WireInit((i*0x10+j).U(8.W))\n        dontTouch(x)\n      }\n    }\n  }\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule ExamplePrefix(\n  input clock,\n        reset\n);\n\n  wire [7:0] loop_0_0_x = 8'h0;\n  wire [7:0] loop_0_1_x = 8'h1;\n  wire [7:0] loop_1_0_x = 8'h10;\n  wire [7:0] loop_1_1_x = 8'h11;\nendmodule\n\n"})}),"\n",(0,i.jsxs)(n.h3,{id:"how-can-i-get-better-names-for-code-generated-by-when-clauses",children:["How can I get better names for code generated by ",(0,i.jsx)(n.code,{children:"when"})," clauses?"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"prefix"})," API can help with code inside ",(0,i.jsx)(n.code,{children:"when"})," clauses:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class ExampleWhenPrefix extends Module {\n\n  val in = IO(Input(UInt(4.W)))\n  val out = IO(Output(UInt(4.W)))\n\n  out := DontCare\n\n  Seq.tabulate(2) { i =>\n    val j = i + 1\n    prefix(s"clause_${j}") {\n      when (in === j.U) {\n        val foo = Reg(UInt(4.W))\n        foo := in + j.U(4.W)\n        out := foo\n      }\n    }\n  }\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule ExampleWhenPrefix(\n  input        clock,\n               reset,\n  input  [3:0] in,\n  output [3:0] out\n);\n\n  reg [3:0] clause_1_foo;\n  reg [3:0] clause_2_foo;\n  always @(posedge clock) begin\n    clause_1_foo <= in + 4'h1;\n    clause_2_foo <= in + 4'h2;\n  end // always @(posedge)\n  assign out = in == 4'h2 ? clause_2_foo : clause_1_foo;\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.h3,{id:"i-still-see-_gen-signals-can-this-be-fixed",children:"I still see _GEN signals, can this be fixed?"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"_GEN"})," signals are usually generated from the FIRRTL compiler, rather than the Chisel library. We are working on\nrenaming these signals with more context-dependent names, but it is a work in progress. Thanks for caring!"]}),"\n",(0,i.jsx)(n.h3,{id:"how-do-i-make-my-modules-have-more-stable-names-instead-of-module_1-and-module_42",children:"How do I make my modules have more stable names instead of 'Module_1' and 'Module_42'?"}),"\n",(0,i.jsxs)(n.p,{children:["This is an example of the module instability problem, which results from several modules all sharing the exact same name. To fix this, you must add more specificity to your ",(0,i.jsx)(n.code,{children:"Module"}),"'s name to avoid these name collisions."]}),"\n",(0,i.jsxs)(n.p,{children:["This can be done by leveraging the ",(0,i.jsx)(n.code,{children:"desiredName"})," and ",(0,i.jsx)(n.code,{children:"typeName"})," APIs.\n",(0,i.jsx)(n.code,{children:"desiredName"})," is for indicating the names of ",(0,i.jsx)(n.code,{children:"Modules"})," (e.g. influenced by the parameters passed in), and ",(0,i.jsx)(n.code,{children:"typeName"})," is useful for modules which are type-parameterized by subclasses of ",(0,i.jsx)(n.code,{children:"Data"}),". Overriding ",(0,i.jsx)(n.code,{children:"desiredName"})," can reduce or even eliminate name collisions. For instance, suppose your module looks like the following:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class MyModule[T <: Data](gen: T) extends Module {\n  // ...\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["We can override ",(0,i.jsx)(n.code,{children:"desiredName"})," of the module to include the type name of the ",(0,i.jsx)(n.code,{children:"gen"})," parameter like so:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class MyModule[T <: Data](gen: T) extends Module {\n  override def desiredName = s"MyModule_${gen.typeName}"\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Any instances of your ",(0,i.jsx)(n.code,{children:"MyModule"})," will now have Verilog module names containing the type parameter."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"val foo = Module(new MyModule(UInt(4.W))) // MyModule_UInt4 // MyModule_UInt4\nval bar = Module(new MyModule(Vec(3, UInt(4.W)))) // MyModule_Vec3_UInt4\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Note that all base Chisel util modules, like ",(0,i.jsx)(n.code,{children:"Queue"}),", already implement ",(0,i.jsx)(n.code,{children:"desiredName"})," like this:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"val fooQueue = Module(new Queue(UInt(8.W), 4)) // Verilog module would be named 'Queue4_UInt8' // Verilog module would be named 'Queue4_UInt8'\nval barQueue = Module(new Queue(SInt(12.W), 3)) // ... and 'Queue3_SInt12' // ... and 'Queue3_SInt12'\nval bazQueue = Module(new Queue(Bool(), 16)) // ... and 'Queue16_Bool'\n"})}),"\n",(0,i.jsxs)(n.h3,{id:"how-would-i-write-my-own-typename-for-my-data-types",children:["How would I write my own ",(0,i.jsx)(n.code,{children:"typeName"})," for my data types?"]}),"\n",(0,i.jsxs)(n.p,{children:["If you're using your own user-defined ",(0,i.jsx)(n.code,{children:"Bundle"}),", you can increase the specificity of its own ",(0,i.jsx)(n.code,{children:"typeName"})," by overriding it. All ",(0,i.jsx)(n.code,{children:"Data"})," types have a simple default implementation of ",(0,i.jsx)(n.code,{children:"typeName"})," (which is simply its class name), but you can override this yourself:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"class MyBundle[T <: Data](gen: T, intParam: Int) extends Bundle {\n  // Generate a stable typeName for this Bundle. Two 'words' are present\n  // in this implementation: the bundle's name plus its integer parameter\n  // (something like 'MyBundle9')\n  // and the generator's typeName, which itself can be composed of 'words'\n  // (something like 'Vec3_UInt4')\n  override def typeName = s\"MyBundle${intParam}_${gen.typeName}\"\n\n  // ...\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Now if you use your ",(0,i.jsx)(n.code,{children:"MyBundle"})," in a module like a ",(0,i.jsx)(n.code,{children:"Queue"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"val fooQueue = Module(new Queue(new MyBundle(UInt(4.W), 3), 16)) // Queue16_MyBundle3_UInt4\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The suggested pattern for ",(0,i.jsx)(n.code,{children:"typeName"}),", and subsequently ",(0,i.jsx)(n.code,{children:"desiredName"}),", is to fold single integer-like parameters with the name itself (for example, ",(0,i.jsx)(n.code,{children:"Queue4"}),", ",(0,i.jsx)(n.code,{children:"UInt3"}),", ",(0,i.jsx)(n.code,{children:"MyBundle9"}),") to form 'words' and separate these 'words' with underscores (",(0,i.jsx)(n.code,{children:"Queue4_UInt3"}),", ",(0,i.jsx)(n.code,{children:"FooBundle_BarType4"}),")."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Bundles"})," that have multiple integer arguments aren't presently addressed by any of the built-in modules, and so implementing a descriptive and sufficiently differentiable ",(0,i.jsx)(n.code,{children:"typeName"})," for such ",(0,i.jsx)(n.code,{children:"Bundles"})," is left as an exercise to the reader. However, integers should not occur with an underscore before them at the very end of the ",(0,i.jsx)(n.code,{children:"typeName"})," (e.g. ",(0,i.jsx)(n.code,{children:"MyBundle_1"}),") because this is the ",(0,i.jsx)(n.em,{children:"same"})," syntax used for duplicates, and so would cause confusion. Having to disambiguate modules all named ",(0,i.jsx)(n.code,{children:"Queue32_MyBundle_4_1"}),", ",(0,i.jsx)(n.code,{children:"Queue32_MyBundle_4_2"}),", ",(0,i.jsx)(n.code,{children:"Queue32_MyBundle_4_3"}),", and so on would be undesirable, indeed!"]}),"\n",(0,i.jsxs)(n.h3,{id:"i-dont-want-to-override-typename-over-and-over-is-there-any-easy-way-to-generate-a-typename",children:["I don't want to override ",(0,i.jsx)(n.code,{children:"typeName"})," over and over! Is there any easy way to generate a ",(0,i.jsx)(n.code,{children:"typeName"}),"?"]}),"\n",(0,i.jsxs)(n.p,{children:["Yes, with the experimental ",(0,i.jsx)(n.code,{children:"HasAutoTypename"})," trait. This trait can be mixed into your ",(0,i.jsx)(n.code,{children:"Bundle"}),"s to automatically generate a tuple-like ",(0,i.jsx)(n.code,{children:"typeName"})," for them, based on the constructor parameters of that ",(0,i.jsx)(n.code,{children:"Bundle"}),". Let's look at the previous examples:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class MyBundle[T <: Data](gen: T, intParam: Int) extends Bundle {\n  override def typeName = s"MyBundle_${gen.typeName}_${intParam}"\n  // ...\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'new MyBundle(UInt(8.W), 3).typeName\n// res7: String = "MyBundle_UInt<8>_3"\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Auto-generated ",(0,i.jsx)(n.code,{children:"typeName"}),"s take the form of ",(0,i.jsx)(n.code,{children:"{Bundle Name}_{Parameter Value 1}_{Parameter Value 2}_{...}"}),", and so our ",(0,i.jsx)(n.code,{children:"MyBundle"})," can be equivalently expressed with:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.HasAutoTypename\nclass MyBundle[T <: Data](gen: T, intParam: Int) extends Bundle with HasAutoTypename {\n  // ...\n  // Note: No `override def typeName` statement here\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'new MyBundle(UInt(8.W), 3).typeName\n// res9: String = "MyBundle_UInt<8>_3"\n'})}),"\n",(0,i.jsx)(n.h3,{id:"can-i-name-my-bundles-in-firrtl-so-i-dont-generate-extremely-long-bundle-types",children:"Can I name my bundles in FIRRTL, so I don't generate extremely long bundle types?"}),"\n",(0,i.jsxs)(n.p,{children:["Yes, using the ",(0,i.jsx)(n.code,{children:"HasTypeAlias"})," trait. FIRRTL has a construct to alias a bundle type with a type alias like so:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"circuit Top :\n  type MyBundle = { foo : UInt<8>, bar : UInt<1>}\n\n  module Top :\n    //...\n"})}),"\n",(0,i.jsxs)(n.p,{children:["These can be automatically emitted from Chisel by mixing ",(0,i.jsx)(n.code,{children:"HasTypeAlias"})," into a user-defined ",(0,i.jsx)(n.code,{children:"Record"}),", and implementing a field named ",(0,i.jsx)(n.code,{children:"aliasName"})," with a ",(0,i.jsx)(n.code,{children:"RecordAlias(...)"})," instance."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'import chisel3.experimental.{HasTypeAlias, RecordAlias}\n\nclass AliasedBundle extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("MyAliasedBundle")\n  val foo = UInt(8.W)\n  val bar = Bool()\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Let's see what happens when we generate FIRRTL using this ",(0,i.jsx)(n.code,{children:"Bundle"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'emitFIRRTL(new Module {\n  val wire = Wire(new AliasedBundle)\n})\n// res10: String = """FIRRTL version 4.2.0\n// circuit _18_Anon :\n//   type MyAliasedBundle = { foo : UInt<8>, bar : UInt<1>}\n// \n//   layer Verification, bind, "verification" :\n//     layer Assert, bind, "verification/assert" :\n//     layer Assume, bind, "verification/assume" :\n//     layer Cover, bind, "verification/cover" :\n//   public module _18_Anon : @[naming.md 232:28]\n//     input clock : Clock @[naming.md 232:28]\n//     input reset : UInt<1> @[naming.md 232:28]\n// \n//     wire wire : MyAliasedBundle @[naming.md 233:18]\n// \n// """\n'})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"HasTypeAlias"})," also supports nested bundles, too:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class Child extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("ChildBundle")\n  val x = UInt(8.W)\n}\n\nclass Parent extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("ParentBundle")\n  val child = new Child\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'emitFIRRTL(new Module {\n  val wire = Wire(new Parent)\n})\n// res11: String = """FIRRTL version 4.2.0\n// circuit _22_Anon :\n//   type ChildBundle = { x : UInt<8>}\n//   type ParentBundle = { child : ChildBundle}\n// \n//   layer Verification, bind, "verification" :\n//     layer Assert, bind, "verification/assert" :\n//     layer Assume, bind, "verification/assume" :\n//     layer Cover, bind, "verification/cover" :\n//   public module _22_Anon : @[naming.md 255:28]\n//     input clock : Clock @[naming.md 255:28]\n//     input reset : UInt<1> @[naming.md 255:28]\n// \n//     wire wire : ParentBundle @[naming.md 256:18]\n// \n// """\n'})}),"\n",(0,i.jsxs)(n.h3,{id:"why-do-i-keep-seeing-_stripped-suffixing-everywhere-in-my-firrtl-i-didnt-specify-that-in-my-aliasname",children:["Why do I keep seeing _stripped suffixing everywhere in my FIRRTL? I didn't specify that in my ",(0,i.jsx)(n.code,{children:"aliasName"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["You're using an ",(0,i.jsx)(n.code,{children:"Input(...)"})," or ",(0,i.jsx)(n.code,{children:"Output(...)"})," in conjunction with an aliased ",(0,i.jsx)(n.code,{children:"Record"})," that contains a ",(0,i.jsx)(n.code,{children:"Flipped(...)"}),". These flipped values are stripped by ",(0,i.jsx)(n.code,{children:"Input"})," and ",(0,i.jsx)(n.code,{children:"Output"})," which fundamentally changes the type of the parent ",(0,i.jsx)(n.code,{children:"Record"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class StrippedBundle extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("StrippedBundle")\n  val flipped = Flipped(UInt(8.W))\n  val normal = UInt(8.W)\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'emitFIRRTL(new Module {\n  val in = IO(Input(new StrippedBundle))\n})\n// res12: String = """FIRRTL version 4.2.0\n// circuit _26_Anon :\n//   type StrippedBundle_stripped = { flipped : UInt<8>, normal : UInt<8>}\n// \n//   layer Verification, bind, "verification" :\n//     layer Assert, bind, "verification/assert" :\n//     layer Assume, bind, "verification/assume" :\n//     layer Cover, bind, "verification/cover" :\n//   public module _26_Anon : @[naming.md 273:28]\n//     input clock : Clock @[naming.md 273:28]\n//     input reset : UInt<1> @[naming.md 273:28]\n//     input in : StrippedBundle_stripped @[naming.md 274:14]\n// \n//     skip\n// \n// """\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Note how the bundle type doesn't contain a ",(0,i.jsx)(n.code,{children:"flip flipped : UInt<8>"})," field, and the alias gains a ",(0,i.jsx)(n.code,{children:'"_stripped"'})," suffix! This ",(0,i.jsx)(n.code,{children:"Bundle"})," type is no longer the same as the one we wrote in Chisel, so we have to distinguish it as such."]}),"\n",(0,i.jsxs)(n.p,{children:["By default, the suffix appended to ",(0,i.jsx)(n.code,{children:"Record"})," names is ",(0,i.jsx)(n.code,{children:'"_stripped"'}),". This can be defined by users with an additional string argument passed to ",(0,i.jsx)(n.code,{children:"RecordAlias(alias, strippedSuffix)"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'class CustomStrippedBundle extends Bundle with HasTypeAlias {\n  override def aliasName = RecordAlias("StrippedBundle", "Foo")\n  val flipped = Flipped(UInt(8.W))\n  val normal = UInt(8.W)\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'emitFIRRTL(new Module {\n  val in = IO(Input(new CustomStrippedBundle))\n})\n// res13: String = """FIRRTL version 4.2.0\n// circuit _30_Anon :\n//   type StrippedBundleFoo = { flipped : UInt<8>, normal : UInt<8>}\n// \n//   layer Verification, bind, "verification" :\n//     layer Assert, bind, "verification/assert" :\n//     layer Assume, bind, "verification/assume" :\n//     layer Cover, bind, "verification/cover" :\n//   public module _30_Anon : @[naming.md 291:28]\n//     input clock : Clock @[naming.md 291:28]\n//     input reset : UInt<1> @[naming.md 291:28]\n//     input in : StrippedBundleFoo @[naming.md 292:14]\n// \n//     skip\n// \n// """\n'})}),"\n",(0,i.jsx)(n.h3,{id:"i-want-to-add-some-hardware-or-assertions-but-each-time-i-do-all-the-signal-names-get-bumped",children:"I want to add some hardware or assertions, but each time I do all the signal names get bumped!"}),"\n",(0,i.jsxs)(n.p,{children:['This is the classic "ECO" problem, and we provide descriptions in ',(0,i.jsx)(n.a,{href:"../explanations/naming",children:"explanation"}),". In short,\nwe recommend wrapping all additional logic in a prefix scope, which enables a unique namespace. This should prevent\nname collisions, which are what triggers all those annoying signal name bumps!"]}),"\n",(0,i.jsx)(n.h3,{id:"i-want-to-force-a-signal-or-instance-name-to-something-how-do-i-do-that",children:"I want to force a signal (or instance) name to something, how do I do that?"}),"\n",(0,i.jsxs)(n.p,{children:["Use the ",(0,i.jsx)(n.code,{children:".suggestName"})," method, which is on all classes which subtype ",(0,i.jsx)(n.code,{children:"Data"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"how-can-i-omit-the-prefix-in-certain-parts-of-the-code",children:"How can I omit the prefix in certain parts of the code?"}),"\n",(0,i.jsxs)(n.p,{children:["You can use the ",(0,i.jsx)(n.code,{children:"noPrefix { ... }"})," to strip the prefix from all signals generated in that scope."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.noPrefix\n\nclass ExampleNoPrefix extends Module {\n  val in = IO(Input(UInt(2.W)))\n  val out = IO(Output(UInt(5.W)))\n\n  val add = noPrefix {\n    // foo will not get a prefix\n    val foo = RegNext(in + 1.U)\n    foo + in\n  }\n\n  out := add\n}\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule ExampleNoPrefix(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [4:0] out\n);\n\n  reg [1:0] foo;\n  always @(posedge clock)\n    foo <= in + 2'h1;\n  assign out = {3'h0, foo + in};\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.h3,{id:"i-am-still-not-getting-the-name-i-want-for-example-inlining-an-instance-changes-my-name",children:"I am still not getting the name I want. For example, inlining an instance changes my name!"}),"\n",(0,i.jsxs)(n.p,{children:["In cases where a FIRRTL transform renames a signal/instance, you can use the ",(0,i.jsx)(n.code,{children:"forcename"})," API:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-scala",children:'import chisel3.util.experimental.{forceName, InlineInstance}\n\nclass WrapperExample extends Module {\n  val in = IO(Input(UInt(3.W)))\n  val out = IO(Output(UInt(3.W)))\n  val inst = Module(new Wrapper)\n  inst.in := in\n  out := inst.out\n}\nclass Wrapper extends Module with InlineInstance {\n  val in = IO(Input(UInt(3.W)))\n  val out = IO(Output(UInt(3.W)))\n  val inst = Module(new MyLeaf)\n  forceName(inst, "inst")\n  inst.in := in\n  out := inst.out\n}\nclass MyLeaf extends Module {\n  val in = IO(Input(UInt(3.W)))\n  val out = IO(Output(UInt(3.W)))\n  out := in\n}\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule MyLeaf(\n  input  [2:0] in,\n  output [2:0] out\n);\n\n  assign out = in;\nendmodule\n\nmodule WrapperExample(\n  input        clock,\n               reset,\n  input  [2:0] in,\n  output [2:0] out\n);\n\n  MyLeaf inst (\n    .in  (in),\n    .out (out)\n  );\nendmodule\n\n"})}),"\n",(0,i.jsx)(n.p,{children:"This can be used to rename instances and non-aggregate typed signals."})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},1871:(e,n,a)=>{a.d(n,{A:()=>l});a(6540);var i=a(5195);const s={tableOfContentsInline:"tableOfContentsInline_prmo"};var t=a(4848);function l(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:l}=e;return(0,t.jsx)("div",{className:s.tableOfContentsInline,children:(0,t.jsx)(i.A,{toc:n,minHeadingLevel:a,maxHeadingLevel:l,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,a)=>{a.d(n,{A:()=>x});var i=a(6540),s=a(6342);function t(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),a=Array(7).fill(-1);n.forEach(((e,n)=>{const i=a.slice(2,e.level);e.parentIndex=Math.max(...i),a[e.level]=n}));const i=[];return n.forEach((e=>{const{parentIndex:a,...s}=e;a>=0?n[a].children.push(s):i.push(s)})),i}function l(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:i}=e;return n.flatMap((e=>{const n=l({toc:e.children,minHeadingLevel:a,maxHeadingLevel:i});return function(e){return e.level>=a&&e.level<=i}(e)?[{...e,children:n}]:n}))}function o(e){const n=e.getBoundingClientRect();return n.top===n.bottom?o(e.parentNode):n}function d(e,n){let{anchorTopOffset:a}=n;const i=e.find((e=>o(e).top>=a));if(i){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(o(i))?i:e[e.indexOf(i)-1]??null}return e[e.length-1]??null}function r(){const e=(0,i.useRef)(0),{navbar:{hideOnScroll:n}}=(0,s.p)();return(0,i.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function c(e){const n=(0,i.useRef)(void 0),a=r();(0,i.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:i,linkActiveClassName:s,minHeadingLevel:t,maxHeadingLevel:l}=e;function o(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(i),o=function(e){let{minHeadingLevel:n,maxHeadingLevel:a}=e;const i=[];for(let s=n;s<=a;s+=1)i.push(`h${s}.anchor`);return Array.from(document.querySelectorAll(i.join()))}({minHeadingLevel:t,maxHeadingLevel:l}),r=d(o,{anchorTopOffset:a.current}),c=e.find((e=>r&&r.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,a){a?(n.current&&n.current!==e&&n.current.classList.remove(s),e.classList.add(s),n.current=e):e.classList.remove(s)}(e,e===c)}))}return document.addEventListener("scroll",o),document.addEventListener("resize",o),o(),()=>{document.removeEventListener("scroll",o),document.removeEventListener("resize",o)}}),[e,a])}var u=a(8774),h=a(4848);function m(e){let{toc:n,className:a,linkClassName:i,isChild:s}=e;return n.length?(0,h.jsx)("ul",{className:s?void 0:a,children:n.map((e=>(0,h.jsxs)("li",{children:[(0,h.jsx)(u.A,{to:`#${e.id}`,className:i??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,h.jsx)(m,{isChild:!0,toc:e.children,className:a,linkClassName:i})]},e.id)))}):null}const p=i.memo(m);function x(e){let{toc:n,className:a="table-of-contents table-of-contents__left-border",linkClassName:o="table-of-contents__link",linkActiveClassName:d,minHeadingLevel:r,maxHeadingLevel:u,...m}=e;const x=(0,s.p)(),g=r??x.tableOfContents.minHeadingLevel,f=u??x.tableOfContents.maxHeadingLevel,y=function(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:s}=e;return(0,i.useMemo)((()=>l({toc:t(n),minHeadingLevel:a,maxHeadingLevel:s})),[n,a,s])}({toc:n,minHeadingLevel:g,maxHeadingLevel:f});return c((0,i.useMemo)((()=>{if(o&&d)return{linkClassName:o,linkActiveClassName:d,minHeadingLevel:g,maxHeadingLevel:f}}),[o,d,g,f])),(0,h.jsx)(p,{toc:y,className:a,linkClassName:o,...m})}},8453:(e,n,a)=>{a.d(n,{R:()=>l,x:()=>o});var i=a(6540);const s={},t=i.createContext(s);function l(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/98ca0ee0.e62af188.js b/assets/js/98ca0ee0.8b580311.js
similarity index 95%
rename from assets/js/98ca0ee0.e62af188.js
rename to assets/js/98ca0ee0.8b580311.js
index b36b129308..608356725d 100644
--- a/assets/js/98ca0ee0.e62af188.js
+++ b/assets/js/98ca0ee0.8b580311.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[8946,9017],{6734:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(4848),i=t(8453),c=t(5268);const o={title:"API Docs"},a=void 0,r={type:"mdx",permalink:"/api",source:"@site/src/pages/api.md",title:"API Docs",description:"Chisel API Documentation",frontMatter:{title:"API Docs"},unlisted:!1},l={},d=[{value:"Chisel API Documentation",id:"chisel-api-documentation",level:2},...c.toc];function h(e){const n={a:"a",h2:"h2",p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"chisel-api-documentation",children:"Chisel API Documentation"}),"\n",(0,s.jsxs)(n.p,{children:["Please see the page about ",(0,s.jsx)(n.a,{href:"docs/appendix/versioning",children:"Versioning"})," for more information about major and minor versioning and binary compatibility."]}),"\n",(0,s.jsx)(c.default,{})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},5268:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var s=t(4848),i=t(8453);const c={},o=void 0,a={type:"mdx",permalink:"/generated/scaladoc_links",source:"@site/src/pages/generated/scaladoc_links.md",description:"- Latest (6.6.0)",frontMatter:{},unlisted:!1},r={},l=[];function d(e){const n={a:"a",li:"li",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"pathname:///api/latest/index.html",children:"Latest (6.6.0)"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://s01.oss.sonatype.org/service/local/repositories/snapshots/archive/org/chipsalliance/chisel_2.13/7.0.0-M2+285-e12935ed-SNAPSHOT/chisel_2.13-7.0.0-M2+285-e12935ed-SNAPSHOT-javadoc.jar/!/index.html",children:"Snapshot"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/7.0.0-M2",children:"7.0.0-M2"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/6.6.0",children:"6.6.0"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/5.3.0",children:"5.3.0"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.6.1",children:"3.6.1"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.5.6",children:"3.5.6"})}),"\n"]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const i={},c=s.createContext(i);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[8946,9017],{6734:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(4848),i=t(8453),c=t(5268);const o={title:"API Docs"},a=void 0,r={type:"mdx",permalink:"/api",source:"@site/src/pages/api.md",title:"API Docs",description:"Chisel API Documentation",frontMatter:{title:"API Docs"},unlisted:!1},l={},d=[{value:"Chisel API Documentation",id:"chisel-api-documentation",level:2},...c.toc];function h(e){const n={a:"a",h2:"h2",p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"chisel-api-documentation",children:"Chisel API Documentation"}),"\n",(0,s.jsxs)(n.p,{children:["Please see the page about ",(0,s.jsx)(n.a,{href:"docs/appendix/versioning",children:"Versioning"})," for more information about major and minor versioning and binary compatibility."]}),"\n",(0,s.jsx)(c.default,{})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},5268:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var s=t(4848),i=t(8453);const c={},o=void 0,a={type:"mdx",permalink:"/generated/scaladoc_links",source:"@site/src/pages/generated/scaladoc_links.md",description:"- Latest (6.6.0)",frontMatter:{},unlisted:!1},r={},l=[];function d(e){const n={a:"a",li:"li",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"pathname:///api/latest/index.html",children:"Latest (6.6.0)"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://s01.oss.sonatype.org/service/local/repositories/snapshots/archive/org/chipsalliance/chisel_2.13/7.0.0-M2+286-ba4e01c3-SNAPSHOT/chisel_2.13-7.0.0-M2+286-ba4e01c3-SNAPSHOT-javadoc.jar/!/index.html",children:"Snapshot"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/7.0.0-M2",children:"7.0.0-M2"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/6.6.0",children:"6.6.0"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/5.3.0",children:"5.3.0"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.6.1",children:"3.6.1"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.5.6",children:"3.5.6"})}),"\n"]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const i={},c=s.createContext(i);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a8f82c73.a31650d1.js b/assets/js/a8f82c73.a44bdfa5.js
similarity index 55%
rename from assets/js/a8f82c73.a31650d1.js
rename to assets/js/a8f82c73.a44bdfa5.js
index 5ff46ba319..e496541ebc 100644
--- a/assets/js/a8f82c73.a31650d1.js
+++ b/assets/js/a8f82c73.a44bdfa5.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[3313],{5527:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>o});var s=l(4848),a=l(8453);const i={layout:"docs",title:"Bundles and Vecs",section:"chisel3"},t="Bundles and Vecs",c={id:"explanations/bundles-and-vecs",title:"Bundles and Vecs",description:"Bundle and Vec are classes that allow the user to expand the set of Chisel datatypes with aggregates of other types.",source:"@site/docs/explanations/bundles-and-vecs.md",sourceDirName:"explanations",slug:"/explanations/bundles-and-vecs",permalink:"/docs/explanations/bundles-and-vecs",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/bundles-and-vecs.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Bundles and Vecs",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Blackboxes",permalink:"/docs/explanations/blackboxes"},next:{title:"Enumerations",permalink:"/docs/explanations/chisel-enum"}},d={},o=[{value:"Flipping Bundles",id:"flipping-bundles",level:3},{value:"MixedVec",id:"mixedvec",level:3},{value:"A note on <code>cloneType</code> (For Chisel &lt; 3.5)",id:"a-note-on-clonetype-for-chisel--35",level:3}];function r(e){const n={a:"a",code:"code",h1:"h1",h3:"h3",header:"header",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"bundles-and-vecs",children:"Bundles and Vecs"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Bundle"})," and ",(0,s.jsx)(n.code,{children:"Vec"})," are classes that allow the user to expand the set of Chisel datatypes with aggregates of other types."]}),"\n",(0,s.jsxs)(n.p,{children:["Bundles group together several named fields of potentially different types into a coherent unit, much like a ",(0,s.jsx)(n.code,{children:"struct"})," in\nC. Users define their own bundles by defining a class as a subclass of ",(0,s.jsx)(n.code,{children:"Bundle"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass MyFloat extends Bundle {\n  val sign        = Bool()\n  val exponent    = UInt(8.W)\n  val significand = UInt(23.W)\n}\n\nclass ModuleWithFloatWire extends RawModule {\n  val x  = Wire(new MyFloat)\n  val xs = x.sign\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["You can create literal Bundles using the experimental ",(0,s.jsx)(n.a,{href:"../appendix/experimental-features#bundle-literals",children:"Bundle Literals"})," feature."]}),"\n",(0,s.jsx)(n.p,{children:"Scala convention is to name classes using UpperCamelCase, and we suggest you follow that convention in your Chisel code."}),"\n",(0,s.jsx)(n.p,{children:"Vecs create an indexable vector of elements, and are constructed as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class ModuleWithVec extends RawModule {\n  // Vector of 5 23-bit signed integers.\n  val myVec = Wire(Vec(5, SInt(23.W)))\n\n  // Connect to one element of vector.\n  val reg3 = myVec(3)\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["(Note that we specify the number followed by the type of the ",(0,s.jsx)(n.code,{children:"Vec"})," elements. We also specifiy the width of the ",(0,s.jsx)(n.code,{children:"SInt"}),")"]}),"\n",(0,s.jsxs)(n.p,{children:["The set of primitive classes\n(",(0,s.jsx)(n.code,{children:"SInt"}),", ",(0,s.jsx)(n.code,{children:"UInt"}),", and ",(0,s.jsx)(n.code,{children:"Bool"}),") plus the aggregate\nclasses (",(0,s.jsx)(n.code,{children:"Bundles"})," and ",(0,s.jsx)(n.code,{children:"Vec"}),"s) all inherit from a common\nsuperclass, ",(0,s.jsx)(n.code,{children:"Data"}),".  Every object that ultimately inherits from\n",(0,s.jsx)(n.code,{children:"Data"})," can be represented as a bit vector in a hardware design."]}),"\n",(0,s.jsx)(n.p,{children:"Bundles and Vecs can be arbitrarily nested to build complex data\nstructures:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class BigBundle extends Bundle {\n // Vector of 5 23-bit signed integers.\n val myVec = Vec(5, SInt(23.W))\n val flag  = Bool()\n // Previously defined bundle.\n val f     = new MyFloat\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Note that the builtin Chisel primitive and aggregate classes do not\nrequire the ",(0,s.jsx)(n.code,{children:"new"})," when creating an instance, whereas new user\ndatatypes will.  A Scala ",(0,s.jsx)(n.code,{children:"apply"})," constructor can be defined so\nthat a user datatype also does not require ",(0,s.jsx)(n.code,{children:"new"}),", as described in\n",(0,s.jsx)(n.a,{href:"../explanations/functional-module-creation",children:"Function Constructor"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"flipping-bundles",children:"Flipping Bundles"}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"Flipped()"})," function recursively flips all elements in a Bundle/Record. This is very useful for building bidirectional interfaces that connect to each other (e.g. ",(0,s.jsx)(n.code,{children:"Decoupled"}),"). See below for an example."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class ABBundle extends Bundle {\n  val a = Input(Bool())\n  val b = Output(Bool())\n}\nclass MyFlippedModule extends RawModule {\n  // Normal instantiation of the bundle\n  // 'a' is an Input and 'b' is an Output\n  val normalBundle = IO(new ABBundle)\n  normalBundle.b := normalBundle.a\n\n  // Flipped recursively flips the direction of all Bundle fields\n  // Now 'a' is an Output and 'b' is an Input\n  val flippedBundle = IO(Flipped(new ABBundle))\n  flippedBundle.a := flippedBundle.b\n}\n"})}),"\n",(0,s.jsx)(n.p,{children:"This generates the following Verilog:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule MyFlippedModule(\n  input  normalBundle_a,\n  output normalBundle_b,\n         flippedBundle_a,\n  input  flippedBundle_b\n);\n\n  assign normalBundle_b = normalBundle_a;\n  assign flippedBundle_a = flippedBundle_b;\nendmodule\n\n"})}),"\n",(0,s.jsx)(n.h3,{id:"mixedvec",children:"MixedVec"}),"\n",(0,s.jsx)(n.p,{children:"(Chisel 3.2+)"}),"\n",(0,s.jsxs)(n.p,{children:["All elements of a ",(0,s.jsx)(n.code,{children:"Vec"})," must have the same parameterization. If we want to create a Vec where the elements have the same type but different parameterizations, we can use a MixedVec:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.MixedVec\nclass ModuleMixedVec extends Module {\n  val io = IO(new Bundle {\n    val x = Input(UInt(3.W))\n    val y = Input(UInt(10.W))\n    val vec = Output(MixedVec(UInt(3.W), UInt(10.W)))\n  })\n  io.vec(0) := io.x\n  io.vec(1) := io.y\n}\n"})}),"\n",(0,s.jsx)(n.p,{children:"We can also programmatically create the types in a MixedVec:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class ModuleProgrammaticMixedVec(x: Int, y: Int) extends Module {\n  val io = IO(new Bundle {\n    val vec = Input(MixedVec((x to y) map { i => UInt(i.W) }))\n    // ...\n  })\n  // ...rest of the module goes here...\n}\n"})}),"\n",(0,s.jsxs)(n.h3,{id:"a-note-on-clonetype-for-chisel--35",children:["A note on ",(0,s.jsx)(n.code,{children:"cloneType"})," (For Chisel < 3.5)"]}),"\n",(0,s.jsxs)(n.p,{children:["NOTE: This section ",(0,s.jsx)(n.strong,{children:"only applies to Chisel before Chisel 3.5"}),".\nAs of Chisel 3.5, ",(0,s.jsx)(n.code,{children:"Bundle"}),"s should ",(0,s.jsx)(n.strong,{children:"not"})," ",(0,s.jsx)(n.code,{children:"override def cloneType"}),",\nas this is a compiler error when using the chisel3 compiler plugin for inferring ",(0,s.jsx)(n.code,{children:"cloneType"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["Since Chisel is built on top of Scala and the JVM,\nit needs to know how to construct copies of ",(0,s.jsx)(n.code,{children:"Bundle"}),"s for various\npurposes (creating wires, IOs, etc).\nIf you have a parametrized ",(0,s.jsx)(n.code,{children:"Bundle"})," and Chisel can't automatically figure out how to\nclone it, you will need to create a custom ",(0,s.jsx)(n.code,{children:"cloneType"})," method in your bundle.\nIn the vast majority of cases, ",(0,s.jsx)(n.strong,{children:"this is not required"}),"\nas Chisel can figure out how to clone most ",(0,s.jsx)(n.code,{children:"Bundle"}),"s automatically:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class MyCloneTypeBundle(val bitwidth: Int) extends Bundle {\n   val field = UInt(bitwidth.W)\n   // ...\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The only caveat is if you are passing something of type ",(0,s.jsx)(n.code,{children:"Data"}),' as a "generator" parameter,\nin which case you should make it a ',(0,s.jsx)(n.code,{children:"private val"}),", and define a ",(0,s.jsx)(n.code,{children:"cloneType"})," method with\n",(0,s.jsx)(n.code,{children:"override def cloneType = (new YourBundleHere(...)).asInstanceOf[this.type]"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["For example, consider the following ",(0,s.jsx)(n.code,{children:"Bundle"}),". Because its ",(0,s.jsx)(n.code,{children:"gen"})," variable is not a ",(0,s.jsx)(n.code,{children:"private val"}),", the user has to\nexplicitly define the ",(0,s.jsx)(n.code,{children:"cloneType"})," method:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.{Decoupled, Irrevocable}\nclass RegisterWriteIOExplicitCloneType[T <: Data](gen: T) extends Bundle {\n  val request  = Flipped(Decoupled(gen))\n  val response = Irrevocable(Bool())\n  override def cloneType = new RegisterWriteIOExplicitCloneType(gen).asInstanceOf[this.type]\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["We can make this this infer cloneType by making ",(0,s.jsx)(n.code,{children:"gen"}),' private since it is a "type parameter":']}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.{Decoupled, Irrevocable}\nclass RegisterWriteIO[T <: Data](private val gen: T) extends Bundle {\n  val request  = Flipped(Decoupled(gen))\n  val response = Irrevocable(Bool())\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(r,{...e})}):r(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>t,x:()=>c});var s=l(6540);const a={},i=s.createContext(a);function t(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:t(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[3313],{5527:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>o});var s=l(4848),a=l(8453);const i={layout:"docs",title:"Bundles and Vecs",section:"chisel3"},t="Bundles and Vecs",c={id:"explanations/bundles-and-vecs",title:"Bundles and Vecs",description:"Bundle and Vec are classes that allow the user to expand the set of Chisel datatypes with aggregates of other types.",source:"@site/docs/explanations/bundles-and-vecs.md",sourceDirName:"explanations",slug:"/explanations/bundles-and-vecs",permalink:"/docs/explanations/bundles-and-vecs",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/bundles-and-vecs.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Bundles and Vecs",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Blackboxes",permalink:"/docs/explanations/blackboxes"},next:{title:"Enumerations",permalink:"/docs/explanations/chisel-enum"}},d={},o=[{value:"Flipping Bundles",id:"flipping-bundles",level:3},{value:"MixedVec",id:"mixedvec",level:3},{value:"A note on <code>cloneType</code> (For Chisel &lt; 3.5)",id:"a-note-on-clonetype-for-chisel--35",level:3}];function r(e){const n={a:"a",code:"code",h1:"h1",h3:"h3",header:"header",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"bundles-and-vecs",children:"Bundles and Vecs"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Bundle"})," and ",(0,s.jsx)(n.code,{children:"Vec"})," are classes that allow the user to expand the set of Chisel datatypes with aggregates of other types."]}),"\n",(0,s.jsxs)(n.p,{children:["Bundles group together several named fields of potentially different types into a coherent unit, much like a ",(0,s.jsx)(n.code,{children:"struct"})," in\nC. Users define their own bundles by defining a class as a subclass of ",(0,s.jsx)(n.code,{children:"Bundle"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass MyFloat extends Bundle {\n  val sign        = Bool()\n  val exponent    = UInt(8.W)\n  val significand = UInt(23.W)\n}\n\nclass ModuleWithFloatWire extends RawModule {\n  val x  = Wire(new MyFloat)\n  val xs = x.sign\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["You can create literal Bundles using the experimental ",(0,s.jsx)(n.a,{href:"../appendix/experimental-features#bundle-literals",children:"Bundle Literals"})," feature."]}),"\n",(0,s.jsx)(n.p,{children:"Scala convention is to name classes using UpperCamelCase, and we suggest you follow that convention in your Chisel code."}),"\n",(0,s.jsx)(n.p,{children:"Vecs create an indexable vector of elements, and are constructed as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class ModuleWithVec extends RawModule {\n  // Vector of 5 23-bit signed integers.\n  val myVec = Wire(Vec(5, SInt(23.W)))\n\n  // Connect to one element of vector.\n  val reg3 = myVec(3)\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["(Note that we specify the number followed by the type of the ",(0,s.jsx)(n.code,{children:"Vec"})," elements. We also specifiy the width of the ",(0,s.jsx)(n.code,{children:"SInt"}),")"]}),"\n",(0,s.jsxs)(n.p,{children:["The set of primitive classes\n(",(0,s.jsx)(n.code,{children:"SInt"}),", ",(0,s.jsx)(n.code,{children:"UInt"}),", and ",(0,s.jsx)(n.code,{children:"Bool"}),") plus the aggregate\nclasses (",(0,s.jsx)(n.code,{children:"Bundles"})," and ",(0,s.jsx)(n.code,{children:"Vec"}),"s) all inherit from a common\nsuperclass, ",(0,s.jsx)(n.code,{children:"Data"}),".  Every object that ultimately inherits from\n",(0,s.jsx)(n.code,{children:"Data"})," can be represented as a bit vector in a hardware design."]}),"\n",(0,s.jsx)(n.p,{children:"Bundles and Vecs can be arbitrarily nested to build complex data\nstructures:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class BigBundle extends Bundle {\n // Vector of 5 23-bit signed integers.\n val myVec = Vec(5, SInt(23.W))\n val flag  = Bool()\n // Previously defined bundle.\n val f     = new MyFloat\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Note that the builtin Chisel primitive and aggregate classes do not\nrequire the ",(0,s.jsx)(n.code,{children:"new"})," when creating an instance, whereas new user\ndatatypes will.  A Scala ",(0,s.jsx)(n.code,{children:"apply"})," constructor can be defined so\nthat a user datatype also does not require ",(0,s.jsx)(n.code,{children:"new"}),", as described in\n",(0,s.jsx)(n.a,{href:"../explanations/functional-module-creation",children:"Function Constructor"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"flipping-bundles",children:"Flipping Bundles"}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"Flipped()"})," function recursively flips all elements in a Bundle/Record. This is very useful for building bidirectional interfaces that connect to each other (e.g. ",(0,s.jsx)(n.code,{children:"Decoupled"}),"). See below for an example."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class ABBundle extends Bundle {\n  val a = Input(Bool())\n  val b = Output(Bool())\n}\nclass MyFlippedModule extends RawModule {\n  // Normal instantiation of the bundle\n  // 'a' is an Input and 'b' is an Output\n  val normalBundle = IO(new ABBundle)\n  normalBundle.b := normalBundle.a\n\n  // Flipped recursively flips the direction of all Bundle fields\n  // Now 'a' is an Output and 'b' is an Input\n  val flippedBundle = IO(Flipped(new ABBundle))\n  flippedBundle.a := flippedBundle.b\n}\n"})}),"\n",(0,s.jsx)(n.p,{children:"This generates the following Verilog:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule MyFlippedModule(\n  input  normalBundle_a,\n  output normalBundle_b,\n         flippedBundle_a,\n  input  flippedBundle_b\n);\n\n  assign normalBundle_b = normalBundle_a;\n  assign flippedBundle_a = flippedBundle_b;\nendmodule\n\n"})}),"\n",(0,s.jsx)(n.h3,{id:"mixedvec",children:"MixedVec"}),"\n",(0,s.jsx)(n.p,{children:"(Chisel 3.2+)"}),"\n",(0,s.jsxs)(n.p,{children:["All elements of a ",(0,s.jsx)(n.code,{children:"Vec"})," must have the same parameterization. If we want to create a Vec where the elements have the same type but different parameterizations, we can use a MixedVec:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.MixedVec\nclass ModuleMixedVec extends Module {\n  val io = IO(new Bundle {\n    val x = Input(UInt(3.W))\n    val y = Input(UInt(10.W))\n    val vec = Output(MixedVec(UInt(3.W), UInt(10.W)))\n  })\n  io.vec(0) := io.x\n  io.vec(1) := io.y\n}\n"})}),"\n",(0,s.jsx)(n.p,{children:"We can also programmatically create the types in a MixedVec:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class ModuleProgrammaticMixedVec(x: Int, y: Int) extends Module {\n  val io = IO(new Bundle {\n    val vec = Input(MixedVec((x to y) map { i => UInt(i.W) }))\n    // ...\n  })\n  // ...rest of the module goes here...\n}\n"})}),"\n",(0,s.jsxs)(n.h3,{id:"a-note-on-clonetype-for-chisel--35",children:["A note on ",(0,s.jsx)(n.code,{children:"cloneType"})," (For Chisel < 3.5)"]}),"\n",(0,s.jsxs)(n.p,{children:["NOTE: This section ",(0,s.jsx)(n.strong,{children:"only applies to Chisel before Chisel 3.5"}),".\nAs of Chisel 3.5, ",(0,s.jsx)(n.code,{children:"Bundle"}),"s should ",(0,s.jsx)(n.strong,{children:"not"})," ",(0,s.jsx)(n.code,{children:"override def cloneType"}),",\nas this is a compiler error when using the chisel3 compiler plugin for inferring ",(0,s.jsx)(n.code,{children:"cloneType"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["Since Chisel is built on top of Scala and the JVM,\nit needs to know how to construct copies of ",(0,s.jsx)(n.code,{children:"Bundle"}),"s for various\npurposes (creating wires, IOs, etc).\nIf you have a parametrized ",(0,s.jsx)(n.code,{children:"Bundle"})," and Chisel can't automatically figure out how to\nclone it, you will need to create a custom ",(0,s.jsx)(n.code,{children:"cloneType"})," method in your bundle.\nIn the vast majority of cases, ",(0,s.jsx)(n.strong,{children:"this is not required"}),"\nas Chisel can figure out how to clone most ",(0,s.jsx)(n.code,{children:"Bundle"}),"s automatically:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"class MyCloneTypeBundle(val bitwidth: Int) extends Bundle {\n   val field = UInt(bitwidth.W)\n   // ...\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The only caveat is if you are passing something of type ",(0,s.jsx)(n.code,{children:"Data"}),' as a "generator" parameter,\nin which case you should make it a ',(0,s.jsx)(n.code,{children:"private val"}),", and define a ",(0,s.jsx)(n.code,{children:"cloneType"})," method with\n",(0,s.jsx)(n.code,{children:"override def cloneType = (new YourBundleHere(...)).asInstanceOf[this.type]"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["For example, consider the following ",(0,s.jsx)(n.code,{children:"Bundle"}),". Because its ",(0,s.jsx)(n.code,{children:"gen"})," variable is not a ",(0,s.jsx)(n.code,{children:"private val"}),", the user has to\nexplicitly define the ",(0,s.jsx)(n.code,{children:"cloneType"})," method:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.{Decoupled, Irrevocable}\nclass RegisterWriteIOExplicitCloneType[T <: Data](gen: T) extends Bundle {\n  val request  = Flipped(Decoupled(gen))\n  val response = Irrevocable(Bool())\n  override def cloneType = new RegisterWriteIOExplicitCloneType(gen).asInstanceOf[this.type]\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["We can make this this infer cloneType by making ",(0,s.jsx)(n.code,{children:"gen"}),' private since it is a "type parameter":']}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-scala",children:"import chisel3.util.{Decoupled, Irrevocable}\nclass RegisterWriteIO[T <: Data](private val gen: T) extends Bundle {\n  val request  = Flipped(Decoupled(gen))\n  val response = Irrevocable(Bool())\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(r,{...e})}):r(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>t,x:()=>c});var s=l(6540);const a={},i=s.createContext(a);function t(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:t(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/c48de377.33b512d1.js b/assets/js/c48de377.33b512d1.js
new file mode 100644
index 0000000000..7dabbae281
--- /dev/null
+++ b/assets/js/c48de377.33b512d1.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[3316],{1429:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var l=i(4848),t=i(8453);const a={layout:"docs",title:"Experimental Features",section:"chisel3"},o="Experimental Features",s={id:"appendix/experimental-features",title:"Experimental Features",description:"Chisel has a number of new features that are worth checking out.  This page is an informal list of these features and projects.",source:"@site/docs/appendix/experimental-features.md",sourceDirName:"appendix",slug:"/appendix/experimental-features",permalink:"/docs/appendix/experimental-features",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/appendix/experimental-features.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Experimental Features",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Migrating from ChiselTest",permalink:"/docs/appendix/migrating-from-chiseltest"},next:{title:"Upgrading From Chisel 3.4 to 3.5",permalink:"/docs/appendix/upgrading-from-chisel-3-4"}},r={},d=[{value:"Module Variants",id:"module-variants",level:2},{value:"Bundle Literals",id:"bundle-literals",level:2},{value:"Vec Literals",id:"vec-literals",level:2},{value:"Loading Memories for simulation or FPGA initialization",id:"loading-memories-for-simulation-or-fpga-initialization",level:2},{value:"Inline initialization with external file",id:"inline-initialization-with-external-file",level:3},{value:"SystemVerilog Bind Initialization",id:"systemverilog-bind-initialization",level:3},{value:"Notes on files",id:"notes-on-files",level:3},{value:"Aggregate memories",id:"aggregate-memories",level:3}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"experimental-features",children:"Experimental Features"})}),"\n",(0,l.jsx)(n.p,{children:"Chisel has a number of new features that are worth checking out.  This page is an informal list of these features and projects."}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"#module-variants",children:"Module Variants"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"#bundle-literals",children:"Bundle Literals"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"#vec-literals",children:"Vec Literals"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"#loading-memories-for-simulation-or-fpga-initialization",children:"Loading-Memories-for-simulation-or-FPGA-initialization"})}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"module-variants",children:"Module Variants"}),"\n",(0,l.jsxs)(n.p,{children:["The standard Chisel ",(0,l.jsx)(n.em,{children:"Module"})," requires a ",(0,l.jsx)(n.code,{children:"val io = IO(...)"}),", the experimental package introduces several\nnew ways of defining Modules"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"BaseModule: no contents, instantiable"}),"\n",(0,l.jsx)(n.li,{children:"BlackBox extends BaseModule"}),"\n",(0,l.jsx)(n.li,{children:"UserDefinedModule extends BaseModule: this module can contain Chisel RTL. No default clock or reset lines. No default IO. - User should be able to specify non-io ports, ideally multiple of them."}),"\n",(0,l.jsx)(n.li,{children:"ImplicitModule extends UserModule: has clock, reset, and io, essentially current Chisel Module."}),"\n",(0,l.jsx)(n.li,{children:"RawModule: will be the user-facing version of UserDefinedModule"}),"\n",(0,l.jsx)(n.li,{children:"Module: type-aliases to ImplicitModule, the user-facing version of ImplicitModule."}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"bundle-literals",children:"Bundle Literals"}),"\n",(0,l.jsx)(n.p,{children:"Bundle literals can be constructed via an experimental import:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.BundleLiterals._\n\nclass MyBundle extends Bundle {\n  val a = UInt(8.W)\n  val b = Bool()\n}\n\nclass Example extends RawModule {\n  val out = IO(Output(new MyBundle))\n  out := (new MyBundle).Lit(_.a -> 8.U, _.b -> true.B)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example(\n  output [7:0] out_a,\n  output       out_b\n);\n\n  assign out_a = 8'h8;\n  assign out_b = 1'h1;\nendmodule\n\n"})}),"\n",(0,l.jsxs)(n.p,{children:['Partial specification is allowed, which results in "invalidated fields" as\ndescribed in ',(0,l.jsx)(n.a,{href:"../explanations/unconnected-wires",children:"Unconnected Wires"}),".\nNote that this can be used with ",(0,l.jsx)(n.code,{children:"RegInit"})," to construct partially reset registers as\ndescribed in the ",(0,l.jsx)(n.a,{href:"../cookbooks/cookbook#how-do-i-partially-reset-an-aggregate-reg",children:"Cookbook"}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class Example2 extends RawModule {\n  val out = IO(Output(new MyBundle))\n  out := (new MyBundle).Lit(_.b -> true.B)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example2(\n  output [7:0] out_a,\n  output       out_b\n);\n\n  assign out_a = 8'h0;\n  assign out_b = 1'h1;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.p,{children:"Bundle literals can also be nested arbitrarily."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class ChildBundle extends Bundle {\n  val foo = UInt(8.W)\n}\n\nclass ParentBundle extends Bundle {\n  val a = UInt(8.W)\n  val b = new ChildBundle\n}\n\nclass Example3 extends RawModule {\n  val out = IO(Output(new ParentBundle))\n  out := (new ParentBundle).Lit(_.a -> 123.U, _.b -> (new ChildBundle).Lit(_.foo -> 42.U))\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example3(\n  output [7:0] out_a,\n               out_b_foo\n);\n\n  assign out_a = 8'h7B;\n  assign out_b_foo = 8'h2A;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.h2,{id:"vec-literals",children:"Vec Literals"}),"\n",(0,l.jsx)(n.p,{children:"Vec literals are very similar to Bundle literals and can be constructed via an experimental import.\nThey can be constructed in two forms, with type and length inferred as in:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.VecLiterals._\n\nclass VecExample1 extends Module {\n  val out = IO(Output(Vec(2, UInt(4.W))))\n  out := Vec.Lit(0xa.U, 0xbb.U)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule VecExample1(\n  input        clock,\n               reset,\n  output [3:0] out_0,\n               out_1\n);\n\n  assign out_0 = 4'hA;\n  assign out_1 = 4'hB;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.p,{children:"or explicitly as in:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.VecLiterals._\n\nclass VecExample1a extends Module {\n  val out = IO(Output(Vec(2, UInt(4.W))))\n  out := Vec(2, UInt(4.W)).Lit(0 -> 1.U, 1 -> 2.U)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule VecExample1a(\n  input        clock,\n               reset,\n  output [3:0] out_0,\n               out_1\n);\n\n  assign out_0 = 4'h1;\n  assign out_1 = 4'h2;\nendmodule\n\n"})}),"\n",(0,l.jsxs)(n.p,{children:['The following examples all use the explicit form.\nWith the explicit form partial specification is allowed, which results in\n"invalidated fields" as described in ',(0,l.jsx)(n.a,{href:"../explanations/unconnected-wires",children:"Unconnected Wires"}),".\nNote that this can be used with ",(0,l.jsx)(n.code,{children:"RegInit"})," to construct partially reset registers as\ndescribed in the ",(0,l.jsx)(n.a,{href:"../cookbooks/cookbook#how-do-i-partially-reset-an-aggregate-reg",children:"Cookbook"}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class VecExample2 extends RawModule {\n  val out = IO(Output(Vec(4, UInt(4.W))))\n  out := Vec(4, UInt(4.W)).Lit(0 -> 1.U, 3 -> 7.U)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule VecExample2(\n  output [3:0] out_0,\n               out_1,\n               out_2,\n               out_3\n);\n\n  assign out_0 = 4'h1;\n  assign out_1 = 4'h0;\n  assign out_2 = 4'h0;\n  assign out_3 = 4'h7;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.p,{children:"Registers can be initialized from Vec literals"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class VecExample3 extends Module {\n  val out = IO(Output(Vec(4, UInt(8.W))))\n  val y = RegInit(\n    Vec(4, UInt(8.W)).Lit(0 -> 0xAB.U(8.W), 1 -> 0xCD.U(8.W), 2 -> 0xEF.U(8.W), 3 -> 0xFF.U(8.W))\n  )\n  out := y\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule VecExample3(\n  input        clock,\n               reset,\n  output [7:0] out_0,\n               out_1,\n               out_2,\n               out_3\n);\n\n  assign out_0 = 8'hAB;\n  assign out_1 = 8'hCD;\n  assign out_2 = 8'hEF;\n  assign out_3 = 8'hFF;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.p,{children:"Vec literals can also be nested arbitrarily."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class VecExample5 extends RawModule {\n  val out = IO(Output(Vec(2, new ChildBundle)))\n  out := Vec(2, new ChildBundle).Lit(\n    0 -> (new ChildBundle).Lit(_.foo -> 42.U),\n    1 -> (new ChildBundle).Lit(_.foo -> 7.U)\n  )\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule VecExample5(\n  output [7:0] out_0_foo,\n               out_1_foo\n);\n\n  assign out_0_foo = 8'h2A;\n  assign out_1_foo = 8'h7;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.h2,{id:"loading-memories-for-simulation-or-fpga-initialization",children:"Loading Memories for simulation or FPGA initialization"}),"\n",(0,l.jsx)(n.h3,{id:"inline-initialization-with-external-file",children:"Inline initialization with external file"}),"\n",(0,l.jsxs)(n.p,{children:["Memories can be initialized by generating inline ",(0,l.jsx)(n.code,{children:"readmemh"})," or ",(0,l.jsx)(n.code,{children:"readmemb"})," statements in the output Verilog."]}),"\n",(0,l.jsxs)(n.p,{children:["The function ",(0,l.jsx)(n.code,{children:"loadMemoryFromFileInline"})," from ",(0,l.jsx)(n.code,{children:"chisel3.util.experimental"})," allows the memory to be initialized by the synthesis software from the specified file. Chisel does not validate the file contents nor its location. Both the memory initialization file and the Verilog source should be accessible for the toolchain."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.util.experimental.loadMemoryFromFileInline\n\nclass InitMemInline(memoryFile: String = "") extends Module {\n  val width: Int = 32\n  val io = IO(new Bundle {\n    val enable = Input(Bool())\n    val write = Input(Bool())\n    val addr = Input(UInt(10.W))\n    val dataIn = Input(UInt(width.W))\n    val dataOut = Output(UInt(width.W))\n  })\n\n  val mem = SyncReadMem(1024, UInt(width.W))\n  // Initialize memory\n  if (memoryFile.trim().nonEmpty) {\n    loadMemoryFromFileInline(mem, memoryFile)\n  }\n  io.dataOut := DontCare\n  when(io.enable) {\n    val rdwrPort = mem(io.addr)\n    when (io.write) { rdwrPort := io.dataIn }\n      .otherwise    { io.dataOut := rdwrPort }\n  }\n}\n'})}),"\n",(0,l.jsxs)(n.p,{children:["The default is to use ",(0,l.jsx)(n.code,{children:"$readmemh"})," (which assumes all numbers in the file are in ascii hex),\nbut to use ascii binary there is an optional ",(0,l.jsx)(n.code,{children:"hexOrBinary"})," argument which can be set to ",(0,l.jsx)(n.code,{children:"MemoryLoadFileType.Hex"})," or ",(0,l.jsx)(n.code,{children:"MemoryLoadFileType.Binary"}),". You will need to add an additional import."]}),"\n",(0,l.jsx)(n.h3,{id:"systemverilog-bind-initialization",children:"SystemVerilog Bind Initialization"}),"\n",(0,l.jsxs)(n.p,{children:["Chisel can also initialize memories by generating a SV bind module with ",(0,l.jsx)(n.code,{children:"readmemh"})," or ",(0,l.jsx)(n.code,{children:"readmemb"})," statements by using the function ",(0,l.jsx)(n.code,{children:"loadMemoryFromFile"})," from ",(0,l.jsx)(n.code,{children:"chisel3.util.experimental"}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.experimental.loadMemoryFromFile\n\nclass InitMemBind(val bits: Int, val size: Int, filename: String) extends Module {\n  val io = IO(new Bundle {\n    val nia = Input(UInt(bits.W))\n    val insn = Output(UInt(32.W))\n  })\n\n  val memory = Mem(size, UInt(32.W))\n  io.insn := memory(io.nia >> 2);\n  loadMemoryFromFile(memory, filename)\n}\n"})}),"\n",(0,l.jsx)(n.p,{children:"Which generates the bind module:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:'module BindsTo_0_Foo(\n  input         clock,\n  input         reset,\n  input  [31:0] io_nia,\n  output [31:0] io_insn\n);\n\ninitial begin\n  $readmemh("test.hex", Foo.memory);\nend\nendmodule\n\nbind Foo BindsTo_0_Foo BindsTo_0_Foo_Inst(.*);\n'})}),"\n",(0,l.jsx)(n.h3,{id:"notes-on-files",children:"Notes on files"}),"\n",(0,l.jsxs)(n.p,{children:["There is no simple answer to where to put the ",(0,l.jsx)(n.code,{children:"hex"})," or ",(0,l.jsx)(n.code,{children:"bin"})," file with the initial contents. It's probably best to create a resource directory somewhere and reference that through a full path or place the file beside the generated Verilog. Another option is adding the path to the memory file in the synthesis tool path. Because these files may be large, Chisel does not copy them."]}),"\n",(0,l.jsxs)(n.blockquote,{children:["\n",(0,l.jsx)(n.p,{children:"Don't forget there is no decimal option, so a 10 in an input file will be 16 decimal"}),"\n"]}),"\n",(0,l.jsxs)(n.p,{children:["See: ",(0,l.jsx)(n.a,{href:"https://github.com/freechipsproject/chisel-testers/blob/master/src/test/scala/examples/ComplexMemoryLoadingSpec.scala",children:"ComplexMemoryLoadingSpec.scala"})," and\n",(0,l.jsx)(n.a,{href:"https://github.com/freechipsproject/chisel-testers/blob/master/src/test/scala/examples/LoadMemoryFromFileSpec.scala",children:"LoadMemoryFromFileSpec.scala"}),"\nfor working examples."]}),"\n",(0,l.jsx)(n.h3,{id:"aggregate-memories",children:"Aggregate memories"}),"\n",(0,l.jsxs)(n.p,{children:["Aggregate memories are supported and will be lowered to a single wide ",(0,l.jsx)(n.code,{children:"UInt"}),".  The memory loading file should be constructed to align with the final structure of the memory."]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(c,{...e})}):c(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>s});var l=i(6540);const t={},a=l.createContext(t);function o(e){const n=l.useContext(a);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),l.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/c48de377.f67a205e.js b/assets/js/c48de377.f67a205e.js
deleted file mode 100644
index 7fefd0950d..0000000000
--- a/assets/js/c48de377.f67a205e.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[3316],{1429:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var l=i(4848),t=i(8453);const a={layout:"docs",title:"Experimental Features",section:"chisel3"},o="Experimental Features",s={id:"appendix/experimental-features",title:"Experimental Features",description:"Chisel has a number of new features that are worth checking out.  This page is an informal list of these features and projects.",source:"@site/docs/appendix/experimental-features.md",sourceDirName:"appendix",slug:"/appendix/experimental-features",permalink:"/docs/appendix/experimental-features",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/appendix/experimental-features.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Experimental Features",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Migrating from ChiselTest",permalink:"/docs/appendix/migrating-from-chiseltest"},next:{title:"Upgrading From Chisel 3.4 to 3.5",permalink:"/docs/appendix/upgrading-from-chisel-3-4"}},r={},d=[{value:"Module Variants",id:"module-variants",level:2},{value:"Bundle Literals",id:"bundle-literals",level:2},{value:"Vec Literals",id:"vec-literals",level:2},{value:"Loading Memories for simulation or FPGA initialization",id:"loading-memories-for-simulation-or-fpga-initialization",level:2},{value:"Inline initialization with external file",id:"inline-initialization-with-external-file",level:3},{value:"SystemVerilog Bind Initialization",id:"systemverilog-bind-initialization",level:3},{value:"Notes on files",id:"notes-on-files",level:3},{value:"Aggregate memories",id:"aggregate-memories",level:3}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"experimental-features",children:"Experimental Features"})}),"\n",(0,l.jsx)(n.p,{children:"Chisel has a number of new features that are worth checking out.  This page is an informal list of these features and projects."}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"#module-variants",children:"Module Variants"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"#bundle-literals",children:"Bundle Literals"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"#vec-literals",children:"Vec Literals"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"#loading-memories-for-simulation-or-fpga-initialization",children:"Loading-Memories-for-simulation-or-FPGA-initialization"})}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"module-variants",children:"Module Variants"}),"\n",(0,l.jsxs)(n.p,{children:["The standard Chisel ",(0,l.jsx)(n.em,{children:"Module"})," requires a ",(0,l.jsx)(n.code,{children:"val io = IO(...)"}),", the experimental package introduces several\nnew ways of defining Modules"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"BaseModule: no contents, instantiable"}),"\n",(0,l.jsx)(n.li,{children:"BlackBox extends BaseModule"}),"\n",(0,l.jsx)(n.li,{children:"UserDefinedModule extends BaseModule: this module can contain Chisel RTL. No default clock or reset lines. No default IO. - User should be able to specify non-io ports, ideally multiple of them."}),"\n",(0,l.jsx)(n.li,{children:"ImplicitModule extends UserModule: has clock, reset, and io, essentially current Chisel Module."}),"\n",(0,l.jsx)(n.li,{children:"RawModule: will be the user-facing version of UserDefinedModule"}),"\n",(0,l.jsx)(n.li,{children:"Module: type-aliases to ImplicitModule, the user-facing version of ImplicitModule."}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"bundle-literals",children:"Bundle Literals"}),"\n",(0,l.jsx)(n.p,{children:"Bundle literals can be constructed via an experimental import:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.BundleLiterals._\n\nclass MyBundle extends Bundle {\n  val a = UInt(8.W)\n  val b = Bool()\n}\n\nclass Example extends RawModule {\n  val out = IO(Output(new MyBundle))\n  out := (new MyBundle).Lit(_.a -> 8.U, _.b -> true.B)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example(\n  output [7:0] out_a,\n  output       out_b\n);\n\n  assign out_a = 8'h8;\n  assign out_b = 1'h1;\nendmodule\n\n"})}),"\n",(0,l.jsxs)(n.p,{children:['Partial specification is allowed, which results in "invalidated fields" as\ndescribed in ',(0,l.jsx)(n.a,{href:"../explanations/unconnected-wires",children:"Unconnected Wires"}),".\nNote that this can be used with ",(0,l.jsx)(n.code,{children:"RegInit"})," to construct partially reset registers as\ndescribed in the ",(0,l.jsx)(n.a,{href:"../cookbooks/cookbook#how-do-i-partially-reset-an-aggregate-reg",children:"Cookbook"}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class Example2 extends RawModule {\n  val out = IO(Output(new MyBundle))\n  out := (new MyBundle).Lit(_.b -> true.B)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example2(\n  output [7:0] out_a,\n  output       out_b\n);\n\n  assign out_a = 8'h0;\n  assign out_b = 1'h1;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.p,{children:"Bundle literals can also be nested arbitrarily."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class ChildBundle extends Bundle {\n  val foo = UInt(8.W)\n}\n\nclass ParentBundle extends Bundle {\n  val a = UInt(8.W)\n  val b = new ChildBundle\n}\n\nclass Example3 extends RawModule {\n  val out = IO(Output(new ParentBundle))\n  out := (new ParentBundle).Lit(_.a -> 123.U, _.b -> (new ChildBundle).Lit(_.foo -> 42.U))\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example3(\n  output [7:0] out_a,\n               out_b_foo\n);\n\n  assign out_a = 8'h7B;\n  assign out_b_foo = 8'h2A;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.h2,{id:"vec-literals",children:"Vec Literals"}),"\n",(0,l.jsx)(n.p,{children:"Vec literals are very similar to Bundle literals and can be constructed via an experimental import.\nThey can be constructed in two forms, with type and length inferred as in:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.VecLiterals._\n\nclass VecExample1 extends Module {\n  val out = IO(Output(Vec(2, UInt(4.W))))\n  out := Vec.Lit(0xa.U, 0xbb.U)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule VecExample1(\n  input        clock,\n               reset,\n  output [3:0] out_0,\n               out_1\n);\n\n  assign out_0 = 4'hA;\n  assign out_1 = 4'hB;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.p,{children:"or explicitly as in:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.VecLiterals._\n\nclass VecExample1a extends Module {\n  val out = IO(Output(Vec(2, UInt(4.W))))\n  out := Vec(2, UInt(4.W)).Lit(0 -> 1.U, 1 -> 2.U)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule VecExample1a(\n  input        clock,\n               reset,\n  output [3:0] out_0,\n               out_1\n);\n\n  assign out_0 = 4'h1;\n  assign out_1 = 4'h2;\nendmodule\n\n"})}),"\n",(0,l.jsxs)(n.p,{children:['The following examples all use the explicit form.\nWith the explicit form partial specification is allowed, which results in\n"invalidated fields" as described in ',(0,l.jsx)(n.a,{href:"../explanations/unconnected-wires",children:"Unconnected Wires"}),".\nNote that this can be used with ",(0,l.jsx)(n.code,{children:"RegInit"})," to construct partially reset registers as\ndescribed in the ",(0,l.jsx)(n.a,{href:"../cookbooks/cookbook#how-do-i-partially-reset-an-aggregate-reg",children:"Cookbook"}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class VecExample2 extends RawModule {\n  val out = IO(Output(Vec(4, UInt(4.W))))\n  out := Vec(4, UInt(4.W)).Lit(0 -> 1.U, 3 -> 7.U)\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule VecExample2(\n  output [3:0] out_0,\n               out_1,\n               out_2,\n               out_3\n);\n\n  assign out_0 = 4'h1;\n  assign out_1 = 4'h0;\n  assign out_2 = 4'h0;\n  assign out_3 = 4'h7;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.p,{children:"Registers can be initialized from Vec literals"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class VecExample3 extends Module {\n  val out = IO(Output(Vec(4, UInt(8.W))))\n  val y = RegInit(\n    Vec(4, UInt(8.W)).Lit(0 -> 0xAB.U(8.W), 1 -> 0xCD.U(8.W), 2 -> 0xEF.U(8.W), 3 -> 0xFF.U(8.W))\n  )\n  out := y\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule VecExample3(\n  input        clock,\n               reset,\n  output [7:0] out_0,\n               out_1,\n               out_2,\n               out_3\n);\n\n  assign out_0 = 8'hAB;\n  assign out_1 = 8'hCD;\n  assign out_2 = 8'hEF;\n  assign out_3 = 8'hFF;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.p,{children:"Vec literals can also be nested arbitrarily."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class VecExample5 extends RawModule {\n  val out = IO(Output(Vec(2, new ChildBundle)))\n  out := Vec(2, new ChildBundle).Lit(\n    0 -> (new ChildBundle).Lit(_.foo -> 42.U),\n    1 -> (new ChildBundle).Lit(_.foo -> 7.U)\n  )\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule VecExample5(\n  output [7:0] out_0_foo,\n               out_1_foo\n);\n\n  assign out_0_foo = 8'h2A;\n  assign out_1_foo = 8'h7;\nendmodule\n\n"})}),"\n",(0,l.jsx)(n.h2,{id:"loading-memories-for-simulation-or-fpga-initialization",children:"Loading Memories for simulation or FPGA initialization"}),"\n",(0,l.jsx)(n.h3,{id:"inline-initialization-with-external-file",children:"Inline initialization with external file"}),"\n",(0,l.jsxs)(n.p,{children:["Memories can be initialized by generating inline ",(0,l.jsx)(n.code,{children:"readmemh"})," or ",(0,l.jsx)(n.code,{children:"readmemb"})," statements in the output Verilog."]}),"\n",(0,l.jsxs)(n.p,{children:["The function ",(0,l.jsx)(n.code,{children:"loadMemoryFromFileInline"})," from ",(0,l.jsx)(n.code,{children:"chisel3.util.experimental"})," allows the memory to be initialized by the synthesis software from the specified file. Chisel does not validate the file contents nor its location. Both the memory initialization file and the Verilog source should be accessible for the toolchain."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.util.experimental.loadMemoryFromFileInline\n\nclass InitMemInline(memoryFile: String = "") extends Module {\n  val width: Int = 32\n  val io = IO(new Bundle {\n    val enable = Input(Bool())\n    val write = Input(Bool())\n    val addr = Input(UInt(10.W))\n    val dataIn = Input(UInt(width.W))\n    val dataOut = Output(UInt(width.W))\n  })\n\n  val mem = SyncReadMem(1024, UInt(width.W))\n  // Initialize memory\n  if (memoryFile.trim().nonEmpty) {\n    loadMemoryFromFileInline(mem, memoryFile)\n  }\n  io.dataOut := DontCare\n  when(io.enable) {\n    val rdwrPort = mem(io.addr)\n    when (io.write) { rdwrPort := io.dataIn }\n      .otherwise    { io.dataOut := rdwrPort }\n  }\n}\n'})}),"\n",(0,l.jsxs)(n.p,{children:["The default is to use ",(0,l.jsx)(n.code,{children:"$readmemh"})," (which assumes all numbers in the file are in ascii hex),\nbut to use ascii binary there is an optional ",(0,l.jsx)(n.code,{children:"hexOrBinary"})," argument which can be set to ",(0,l.jsx)(n.code,{children:"MemoryLoadFileType.Hex"})," or ",(0,l.jsx)(n.code,{children:"MemoryLoadFileType.Binary"}),". You will need to add an additional import."]}),"\n",(0,l.jsx)(n.h3,{id:"systemverilog-bind-initialization",children:"SystemVerilog Bind Initialization"}),"\n",(0,l.jsxs)(n.p,{children:["Chisel can also initialize memories by generating a SV bind module with ",(0,l.jsx)(n.code,{children:"readmemh"})," or ",(0,l.jsx)(n.code,{children:"readmemb"})," statements by using the function ",(0,l.jsx)(n.code,{children:"loadMemoryFromFile"})," from ",(0,l.jsx)(n.code,{children:"chisel3.util.experimental"}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.experimental.loadMemoryFromFile\n\nclass InitMemBind(val bits: Int, val size: Int, filename: String) extends Module {\n  val io = IO(new Bundle {\n    val nia = Input(UInt(bits.W))\n    val insn = Output(UInt(32.W))\n  })\n\n  val memory = Mem(size, UInt(32.W))\n  io.insn := memory(io.nia >> 2);\n  loadMemoryFromFile(memory, filename)\n}\n"})}),"\n",(0,l.jsx)(n.p,{children:"Which generates the bind module:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:'module BindsTo_0_Foo(\n  input         clock,\n  input         reset,\n  input  [31:0] io_nia,\n  output [31:0] io_insn\n);\n\ninitial begin\n  $readmemh("test.hex", Foo.memory);\nend\nendmodule\n\nbind Foo BindsTo_0_Foo BindsTo_0_Foo_Inst(.*);\n'})}),"\n",(0,l.jsx)(n.h3,{id:"notes-on-files",children:"Notes on files"}),"\n",(0,l.jsxs)(n.p,{children:["There is no simple answer to where to put the ",(0,l.jsx)(n.code,{children:"hex"})," or ",(0,l.jsx)(n.code,{children:"bin"})," file with the initial contents. It's probably best to create a resource directory somewhere and reference that through a full path or place the file beside the generated Verilog. Another option is adding the path to the memory file in the synthesis tool path. Because these files may be large, Chisel does not copy them."]}),"\n",(0,l.jsxs)(n.blockquote,{children:["\n",(0,l.jsx)(n.p,{children:"Don't forget there is no decimal option, so a 10 in an input file will be 16 decimal"}),"\n"]}),"\n",(0,l.jsxs)(n.p,{children:["See: ",(0,l.jsx)(n.a,{href:"https://github.com/freechipsproject/chisel-testers/blob/master/src/test/scala/examples/ComplexMemoryLoadingSpec.scala",children:"ComplexMemoryLoadingSpec.scala"})," and\n",(0,l.jsx)(n.a,{href:"https://github.com/freechipsproject/chisel-testers/blob/master/src/test/scala/examples/LoadMemoryFromFileSpec.scala",children:"LoadMemoryFromFileSpec.scala"}),"\nfor working examples."]}),"\n",(0,l.jsx)(n.h3,{id:"aggregate-memories",children:"Aggregate memories"}),"\n",(0,l.jsxs)(n.p,{children:["Aggregate memories are supported and will be lowered to a single wide ",(0,l.jsx)(n.code,{children:"UInt"}),".  The memory loading file should be constructed to align with the final structure of the memory."]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(c,{...e})}):c(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>s});var l=i(6540);const t={},a=l.createContext(t);function o(e){const n=l.useContext(a);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),l.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/c7666d49.4bc58ceb.js b/assets/js/c7666d49.edd1fd74.js
similarity index 60%
rename from assets/js/c7666d49.4bc58ceb.js
rename to assets/js/c7666d49.edd1fd74.js
index 213342d362..0ec3d606cd 100644
--- a/assets/js/c7666d49.4bc58ceb.js
+++ b/assets/js/c7666d49.edd1fd74.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[6474],{6458:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var r=i(4848),a=i(8453);const o={layout:"docs",title:"Layers",section:"chisel3"},l="Layers",s={id:"explanations/layers",title:"Layers",description:"Layers describe functionality of a Chisel generator that a user would like to",source:"@site/docs/explanations/layers.md",sourceDirName:"explanations",slug:"/explanations/layers",permalink:"/docs/explanations/layers",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/layers.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Layers",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Intrinsics",permalink:"/docs/explanations/intrinsics"},next:{title:"Memories",permalink:"/docs/explanations/memories"}},t={},c=[{value:"Overview",id:"overview",level:2},{value:"Verilog ABI",id:"verilog-abi",level:2},{value:"Extract Layers",id:"extract-layers",level:3},{value:"Inline Layers",id:"inline-layers",level:3},{value:"User-defined Layers",id:"user-defined-layers",level:2},{value:"Built-in Layers",id:"built-in-layers",level:2},{value:"Layer-coloring",id:"layer-coloring",level:2},{value:"Layer-colored Probes and Wires",id:"layer-colored-probes-and-wires",level:3},{value:"Enabling Layers",id:"enabling-layers",level:3},{value:"Examples",id:"examples",level:2},{value:"Simple Extract Layer",id:"simple-extract-layer",level:3},{value:"Simple Inline Layer",id:"simple-inline-layer",level:3},{value:"Design Verification Example",id:"design-verification-example",level:3},{value:"Implementation Notes",id:"implementation-notes",level:4},{value:"Verilog Output",id:"verilog-output",level:4}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"layers",children:"Layers"})}),"\n",(0,r.jsxs)(n.p,{children:["Layers describe functionality of a Chisel generator that a user would like to\n",(0,r.jsx)(n.em,{children:"optionally"})," include at Verilog elaboration time.  Pragmatically, they are a\nfeature to access SystemVerilog's ",(0,r.jsx)(n.code,{children:"bind"})," construct and ",(0,r.jsx)(n.code,{children:"`ifdef"})," preprocessor\nmacros.  The optional functionality of layers, by construction, is not allowed\nto affect logic outside the layer."]}),"\n",(0,r.jsx)(n.p,{children:"Layers are typically used to describe design verification code or\ndebugging logic that a user would like to be able to later disable (for\nperformance, verbosity, or cleanliness reasons) or use internally, but exclude\nfrom delivery to a customer."}),"\n",(0,r.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsx)(n.p,{children:"A layer consists of two pieces:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["A layer ",(0,r.jsx)(n.em,{children:"declaration"}),", and"]}),"\n",(0,r.jsxs)(n.li,{children:["One or more ",(0,r.jsx)(n.em,{children:"layer blocks"})," inside Chisel modules."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The declaration indicates that optional functionality can exist.  The layer\nblock contains the optional functionality."}),"\n",(0,r.jsxs)(n.p,{children:["There are two kinds of layers.  The layer kind determines the ",(0,r.jsx)(n.em,{children:"convention"}),",\ni.e., how the layer blocks of a layer are represented in Verilog and the\nmechanism to enable a layer.  Available layer kinds are:"]}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:['"Extract" Layers: layers whose blocks are lowered to modules that are\ninstantiated using ',(0,r.jsx)(n.code,{children:"bind"})," and can be enabled by including a file during\nVerilog elaboration, and"]}),"\n",(0,r.jsxs)(n.li,{children:['"Inline" Layers: layers whose blocks will be guarded with ',(0,r.jsx)(n.code,{children:"`ifdef"})," macros\nand can be enabled by setting a Verilog preprocessor define."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Extract layers may also specify a directory into which their collateral are\nwritten."}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["For more information about these SystemVerilog concepts, the IEEE 1800-2023\nstandard discusses ",(0,r.jsx)(n.code,{children:"bind"})," in Section 23.11 and ",(0,r.jsx)(n.code,{children:"`ifdef"})," in Section 23.6."]})}),"\n",(0,r.jsxs)(n.p,{children:["To declare a layer, create a singleton ",(0,r.jsx)(n.code,{children:"object"})," in scala that extends the\nabstract class ",(0,r.jsx)(n.code,{children:"chisel3.layer.Layer"}),", passing into the layer constructor either\nan object of class ",(0,r.jsx)(n.code,{children:"chisel3.layer.LayerConfig.Extract"})," for an extract layer, or\nthe object ",(0,r.jsx)(n.code,{children:"chisel3.layer.LayerConfig.Inline"})," for an inline layer."]}),"\n",(0,r.jsx)(n.p,{children:"Below, an extract layer and an inline layer are declared:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"import chisel3.layer.{Layer, LayerConfig}\n\nobject A extends Layer(LayerConfig.Extract())\n\nobject B extends Layer(LayerConfig.Inline)\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Layers may be nested.  Nesting a child layer under a parent layer means that the\nchild layer may access constructs in the parent layer.  Put differently, the\nchild layer will only be enabled if the parent layer is already enabled.  To\ndeclare a nested layer, extend the ",(0,r.jsx)(n.code,{children:"chisel3.layer.Layer"})," abstract class inside\nanother declaration."]}),"\n",(0,r.jsx)(n.p,{children:"The following example defines an extract layer with two nested layers inside it:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"object C extends Layer(LayerConfig.Extract()) {\n  object D extends Layer(LayerConfig.Extract())\n  object E extends Layer(LayerConfig.Inline) {\n    object F extends Layer(LayerConfig.Inline)\n  }\n}\n"})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["SystemVerilog prohibits a ",(0,r.jsx)(n.code,{children:"bind"})," instantiation under another ",(0,r.jsx)(n.code,{children:"bind"}),"\ninstantiation.  However, Chisel allows nesting of extract layers.  This is\nresolved by the FIRRTL compiler to restructure nested extract layers to be\nsibling modules that communicate via ports."]})}),"\n",(0,r.jsxs)(n.admonition,{type:"warning",children:[(0,r.jsx)(n.p,{children:"Extract layers may not be nested under inline layers.  However, inline layers\nmay be nested under extract layers."}),(0,r.jsx)(n.p,{children:"Any module which contains layer blocks or transitively contains layer blocks in\nits submodules may not be instantiated under a layer block."})]}),"\n",(0,r.jsxs)(n.p,{children:["A ",(0,r.jsx)(n.em,{children:"layer block"}),", associated with a layer, adds optional functionality to a\nmodule that is enabled if that layer is enabled.  To define a layer block, use\nthe ",(0,r.jsx)(n.code,{children:"chisel3.layer.block"})," inside a Chisel module and pass the layer that it\nshould be associated with."]}),"\n",(0,r.jsx)(n.p,{children:"Inside the layer block, any Chisel or Scala value visible in lexical scope may\nbe used.  Layer blocks may not return values.  Any values created inside a layer\nblock are not accessible outside the layer block, unless using layer-colored\nprobes."}),"\n",(0,r.jsxs)(n.p,{children:["The following example defines layer blocks inside module ",(0,r.jsx)(n.code,{children:"Foo"}),".  Each layer\nblock contains a wire that captures a value from its visible lexical scope.\n(For nested layer blocks, this scope includes their parent layer blocks.):"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.layer.block\n\nclass Foo extends RawModule {\n  val port = IO(Input(Bool()))\n\n  block(A) {\n    val a = WireInit(port)\n  }\n\n  block(B) {\n    val b = WireInit(port)\n  }\n\n  block(C) {\n    val c = WireInit(port)\n    block(C.D) {\n      val d = WireInit(port | c)\n    }\n    block(C.E) {\n      val e = WireInit(port ^ c)\n      block (C.E.F) {\n        val f = WireInit(port & e)\n      }\n    }\n  }\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["The layer block API will automatically create parent layer blocks for you if\npossible.  In the following example, it is legal to directly create a layer\nblock of ",(0,r.jsx)(n.code,{children:"C.D"})," directly in a module:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"class Bar extends RawModule {\n  block (C.D) {}\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Formally, it is legal to create a layer block associated with a layer as long as\nthe current scope is an ",(0,r.jsx)(n.em,{children:"ancestor"})," of the request layer."]}),"\n",(0,r.jsxs)(n.admonition,{type:"info",children:[(0,r.jsxs)(n.p,{children:["The requirement is an ",(0,r.jsx)(n.em,{children:"ancestor"})," relationship, not a ",(0,r.jsx)(n.em,{children:"proper ancestor"}),"\nrelationship.  This means that it is legal to nest a layer block under a layer\nblock of the same layer like:"]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"class Baz extends RawModule {\n  block(A) {\n    block(A) {}\n  }\n}\n"})})]}),"\n",(0,r.jsx)(n.h2,{id:"verilog-abi",children:"Verilog ABI"}),"\n",(0,r.jsx)(n.p,{children:"Layers are compiled to SystemVerilog using the FIRRTL ABI.  This ABI defines\nwhat happens to layer blocks in a Chisel design and how a layer can be enabled\nafter a design is compiled to SystemVerilog."}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["For the exact definition of the FIRRTL ABI for layers, see the ",(0,r.jsx)(n.a,{href:"https://github.com/chipsalliance/firrtl-spec/releases/latest/download/abi.pdf",children:"FIRRTL ABI\nSpecification"}),"."]})}),"\n",(0,r.jsx)(n.h3,{id:"extract-layers",children:"Extract Layers"}),"\n",(0,r.jsxs)(n.p,{children:["Extract layers have their layer blocks removed from the design.  To enable a\nlayer, a file with a specific name should be included in the design.  This file\nbegins with ",(0,r.jsx)(n.code,{children:"layers-"})," and then includes the circuit name and all layer names\ndelimited with dashes (",(0,r.jsx)(n.code,{children:"-"}),")."]}),"\n",(0,r.jsxs)(n.p,{children:["For example, for module ",(0,r.jsx)(n.code,{children:"Foo"})," declared above, this will produce three files, one\nfor each extract layer:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"layers-Foo-A.sv\nlayers-Foo-C.sv\nlayers-Foo-C-D.sv\n"})}),"\n",(0,r.jsx)(n.p,{children:"To enable any of these layers at compilation time, the appropriate file should\nbe included in the build.  Any combination of files may be included.  Including\nonly a child layer's file will automatically include its parent layer's file."}),"\n",(0,r.jsx)(n.h3,{id:"inline-layers",children:"Inline Layers"}),"\n",(0,r.jsxs)(n.p,{children:["Inline layers have their layer blocks guarded with conditional compilation\ndirectives.  To enable an inline layer, set a preprocessor define when compiling\nyour design.  The preprocessor define begins with ",(0,r.jsx)(n.code,{children:"layer_"})," and then includes the\ncircuit name and all layer names delimited with dollar signs (",(0,r.jsx)(n.code,{children:"$"}),").  Parent\nextract layer names appear in the macro."]}),"\n",(0,r.jsxs)(n.p,{children:["For example, for module ",(0,r.jsx)(n.code,{children:"Foo"})," declared above, this will be sensitive to three\nmacros, one for each inline layer:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"layer_Foo$B\nlayer_Foo$C$E\nlayer_Foo$C$E$F\n"})}),"\n",(0,r.jsx)(n.h2,{id:"user-defined-layers",children:"User-defined Layers"}),"\n",(0,r.jsxs)(n.p,{children:["A user is free to define as many layers as they want.  All layers shown\npreviously are user-defined, e.g., ",(0,r.jsx)(n.code,{children:"A"})," and ",(0,r.jsx)(n.code,{children:"C.E"})," are user-defined layers.\nUser-defined layers are only emitted into FIRRTL if they have layer block users.\nTo change this behavior and unconditionally emit a user-defined layer, use the\n",(0,r.jsx)(n.code,{children:"chisel3.layer.addLayer"})," API."]}),"\n",(0,r.jsx)(n.admonition,{type:"tip",children:(0,r.jsx)(n.p,{children:"Before creating new user-defined layers, consider using the built-in layers\ndefined below.  Additionally, if working in a larger project, the project may\nhave it's own user-defined layers that you are expected to use.  This is because\nthe ABIs affect the build system.  Please consult with a technical lead of the\nproject to see if this is the case."})}),"\n",(0,r.jsx)(n.h2,{id:"built-in-layers",children:"Built-in Layers"}),"\n",(0,r.jsx)(n.p,{children:"Chisel provides several built-in layers.  These are shown below with their full\nScala paths.  All built-in layers are extract layers:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"chisel3.layers.Verification\n\u251c\u2500\u2500 chisel3.layers.Verification.Assert\n\u251c\u2500\u2500 chisel3.layers.Verification.Assume\n\u2514\u2500\u2500 chisel3.layers.Verification.Cover\n"})}),"\n",(0,r.jsxs)(n.p,{children:["These built-in layers are dual purpose.  First, these layers match the common\nuse case of sequestering verification code.  The ",(0,r.jsx)(n.code,{children:"Verification"})," layer is for\ncommon verification collateral.  The ",(0,r.jsx)(n.code,{children:"Assert"}),", ",(0,r.jsx)(n.code,{children:"Assume"}),", and ",(0,r.jsx)(n.code,{children:"Cover"})," layers are\nfor, respectively, assertions, assumptions, and cover statements.  Second, the\nChisel standard library uses them for a number of its APIs.  ",(0,r.jsx)(n.em,{children:"Unless otherwise\nwrapped in a different layer block, the following operations are automatically\nplaced in layers"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Prints are placed in the ",(0,r.jsx)(n.code,{children:"Verification"})," layer"]}),"\n",(0,r.jsxs)(n.li,{children:["Assertions are placed in the ",(0,r.jsx)(n.code,{children:"Verification.Assert"})," layer"]}),"\n",(0,r.jsxs)(n.li,{children:["Assumptions are placed in the ",(0,r.jsx)(n.code,{children:"Verification.Assume"})," layer"]}),"\n",(0,r.jsxs)(n.li,{children:["Covers are placed in the ",(0,r.jsx)(n.code,{children:"Verification.Cover"})," layer"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["For predictability of output, these layers will always be show up in the FIRRTL\nthat Chisel emits.  To change this behavior, use ",(0,r.jsx)(n.code,{children:"firtool"})," command line options\nto ",(0,r.jsx)(n.em,{children:"specialize"})," these layers (remove their optionality by making them always\nenabled or disabled).  Use ",(0,r.jsx)(n.code,{children:"-enable-layers"})," to enable a layer, ",(0,r.jsx)(n.code,{children:"-disable-layers"}),"\nto disable a layer, or ",(0,r.jsx)(n.code,{children:"-default-layer-specialization"})," to set a default\nspecialization."]}),"\n",(0,r.jsxs)(n.admonition,{type:"tip",children:[(0,r.jsx)(n.p,{children:"Users may extend built-in layers with user-defined layers using an advanced API.\nTo do this, the layer parent must be specified as an implicit value."}),(0,r.jsxs)(n.p,{children:["The following example nests the layer ",(0,r.jsx)(n.code,{children:"Debug"})," to the ",(0,r.jsx)(n.code,{children:"Verification"})," layer:"]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"object UserDefined {\n  // Define an implicit val `root` of type `Layer` to cause layers which can see\n  // this to use `root` as their parent layer.  This allows us to nest the\n  // user-defined `Debug` layer under the built-in `Verification` layer.\n  implicit val root: Layer = chisel3.layers.Verification\n  object Debug extends Layer(LayerConfig.Inline)\n}\n"})})]}),"\n",(0,r.jsx)(n.h2,{id:"layer-coloring",children:"Layer-coloring"}),"\n",(0,r.jsxs)(n.p,{children:["While layers are not allowed to influence the design or their parent layers, it\nis often useful and necessary to allow layer blocks to send information out of\ntheir containing modules to be read by layer blocks of the same layer or\nchildren layers. Hardware which has this optional property is said to be\n",(0,r.jsx)(n.em,{children:"layer-colored"}),".  Both probes and wires can be layer-colored."]}),"\n",(0,r.jsx)(n.h3,{id:"layer-colored-probes-and-wires",children:"Layer-colored Probes and Wires"}),"\n",(0,r.jsx)(n.p,{children:"A layer-colored probe is a probe that exists if a user enables its corresponding\nlayer during Verilog elaboration.  Layer-colored probes are used to describe\noptional verification, debugging, or logging interfaces."}),"\n",(0,r.jsx)(n.p,{children:"Layer-colored wires are used as temporary storage of defined probe values.  They\nare used for communication between layer blocks of the same layer in the same\nmodule or as temporary storage when forwarding a probe to a port."}),"\n",(0,r.jsxs)(n.p,{children:["A layer-colored probe or wire may be the target of a ",(0,r.jsx)(n.code,{children:"define"})," if the ",(0,r.jsx)(n.code,{children:"define"})," is\nenabled when the color of the probe or wire is enabled.  A layer-colored probe\nor wire may be ",(0,r.jsx)(n.code,{children:"read"})," from if the color of the probe or wire is enabled when the\n",(0,r.jsx)(n.code,{children:"read"})," is enabled.  Put differently, you may write to your layer or a child\nlayer and you may read from your layer or a parent layer."]}),"\n",(0,r.jsx)(n.p,{children:"The example below shows two layer-colored probe ports and one layer-colored\nprobe wire driven in legal ways:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.layer.{Layer, LayerConfig}\nimport chisel3.probe.{Probe, ProbeValue, define}\n\nobject A extends Layer(LayerConfig.Extract())\nobject B extends Layer(LayerConfig.Extract())\n\nclass Foo extends RawModule {\n  val a = IO(Output(Probe(Bool(), A)))\n  val b = IO(Output(Probe(Bool(), B)))\n\n  layer.block(A) {\n    val a_wire = WireInit(false.B)\n    define(a, ProbeValue(a_wire))\n  }\n\n  val b_wire_probe = Wire(Probe(Bool(), B))\n  define(b, b_wire_probe)\n\n  layer.block(B) {\n    val b_wire = WireInit(false.B)\n    define(b_wire_probe, ProbeValue(b_wire))\n  }\n\n}\n"})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["For more information, see the layer coloring section of the ",(0,r.jsx)(n.a,{href:"https://github.com/chipsalliance/firrtl-spec/releases/latest/download/spec.pdf",children:"FIRRTL\nSpecification"}),"."]})}),"\n",(0,r.jsx)(n.h3,{id:"enabling-layers",children:"Enabling Layers"}),"\n",(0,r.jsxs)(n.p,{children:["When working with layer-colored probes, it is often convenient to grant access\nto probes of one or more colors.  E.g., testbenches often want to ",(0,r.jsx)(n.em,{children:"enable"})," all\nlayers in a design-under-test so that they gain access to layer-colored probe\nports necessary for advanced design verification.  Without an additional\nfeature, this use case is poorly supported with just layer coloring.  First, it\nis tedious to enclose all code inside a testbench in a layer block.  Second, a\ntestbench may need to read probes with colors that do not have a parent--child\nrelationship.  No layer block is capable of both legally reading from different\nprobes and combining the results."]}),"\n",(0,r.jsxs)(n.p,{children:["To support this use case, Chisel provides the ",(0,r.jsx)(n.code,{children:"layer.enable"})," API.  This API\ngrants access to any layer-colored probes of instantiated modules for the\nenabled layer.  The API may be used more than once to enable more than one\nlayer."]}),"\n",(0,r.jsxs)(n.p,{children:["The example below instantiates module ",(0,r.jsx)(n.code,{children:"Foo"})," from the previous section.  After\nenabling layers ",(0,r.jsx)(n.code,{children:"A"})," and ",(0,r.jsx)(n.code,{children:"B"}),", the module can read from probes with colors ",(0,r.jsx)(n.code,{children:"A"})," and\n",(0,r.jsx)(n.code,{children:"B"})," and use their results in a single operation:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"import chisel3.layer.enable\nimport chisel3.probe.read\n\nclass Bar extends RawModule {\n\n  enable(A)\n  enable(B)\n\n  val foo = Module(new Foo)\n\n  val c = read(foo.a) ^ read(foo.b)\n\n}\n"})}),"\n",(0,r.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.h3,{id:"simple-extract-layer",children:"Simple Extract Layer"}),"\n",(0,r.jsxs)(n.p,{children:["The design below has a single extract layer that, when enabled, will add an\nassert that checks for overflow.  Based on the FIRRTL ABI, we can expect that a\nfile called ",(0,r.jsx)(n.code,{children:"layers-Foo-A.sv"})," will be produced when we compile it."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.layer.{Layer, LayerConfig, block}\nimport chisel3.ltl.AssertProperty\n\nobject A extends Layer(LayerConfig.Extract())\n\nclass Foo extends Module {\n  val a, b = IO(Input(UInt(4.W)))\n  val sum = IO(Output(UInt(4.W)))\n\n  sum :<= a +% b\n\n  block(A) {\n    withDisable(Disable.Never) {\n      AssertProperty(!(a +& b)(4), "overflow occurred")\n    }\n  }\n\n}\n'})}),"\n",(0,r.jsxs)(n.p,{children:["After compilation, we get the following SystemVerilog.  Comments that include\n",(0,r.jsx)(n.code,{children:"FILE"})," indicate the beginning of a new file:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-verilog",children:'// Generated by CIRCT firtool-1.99.2\nmodule Foo(\n  input        clock,\n               reset,\n  input  [3:0] a,\n               b,\n  output [3:0] sum\n);\n\n  wire [4:0] _sum_T = {1\'h0, a} + {1\'h0, b};\n  assign sum = _sum_T[3:0];\nendmodule\n\n\n// ----- 8< ----- FILE "A/layers-Foo-A.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n`ifndef layers_Foo_A\n`define layers_Foo_A\nbind Foo Foo_A a_0 (\n  ._GEN  (_sum_T),\n  .clock (clock)\n);\n`endif // layers_Foo_A\n\n// ----- 8< ----- FILE "A/Foo_A.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\nmodule Foo_A(\n  input [4:0] _GEN,\n  input       clock\n);\n\n  overflow_occurred: assert property (@(posedge clock) ~(_GEN[4]));\nendmodule\n\n'})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["The above example was compiled with the firtool options\n",(0,r.jsx)(n.code,{children:"-enable-layers=Verification"}),", ",(0,r.jsx)(n.code,{children:"-enable-layers=Verification.Assert"}),",\n",(0,r.jsx)(n.code,{children:"-enable-layers=Verification.Assume"}),", and ",(0,r.jsx)(n.code,{children:"-enable-layers=Verification.Cover"})," to\nmake the output terser.  Normally, bind files would show up for these built-in\nlayers."]})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["Note: the generated module, ",(0,r.jsx)(n.code,{children:"Foo_A"}),", and its file, ",(0,r.jsx)(n.code,{children:"Foo_A.sv"}),", are ",(0,r.jsx)(n.em,{children:"not part of\nthe ABI"}),".  You should not rely on any generated module names or files other than\nthe bind file, ",(0,r.jsx)(n.code,{children:"layers-Foo-A.sv"}),"."]})}),"\n",(0,r.jsx)(n.h3,{id:"simple-inline-layer",children:"Simple Inline Layer"}),"\n",(0,r.jsxs)(n.p,{children:["The design below is the same as the previous example, but uses an inline layer.\nBased on the FIRRTL ABI, we can expect that the body of the layer block will be\nguarded by an ",(0,r.jsx)(n.code,{children:"`ifdef"})," sensitive to the preprocessor macro ",(0,r.jsx)(n.code,{children:"layer_Foo$A"}),"."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.layer.{Layer, LayerConfig, block}\nimport chisel3.ltl.AssertProperty\n\nobject A extends Layer(LayerConfig.Inline)\n\nclass Foo extends Module {\n  val a, b = IO(Input(UInt(4.W)))\n  val sum = IO(Output(UInt(4.W)))\n\n  sum :<= a +% b\n\n  block(A) {\n    withDisable(Disable.Never) {\n      AssertProperty(!(a +& b)(4), "overflow occurred")\n    }\n  }\n\n}\n'})}),"\n",(0,r.jsx)(n.p,{children:"After compilation, we get the following SystemVerilog."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Foo(\n  input        clock,\n               reset,\n  input  [3:0] a,\n               b,\n  output [3:0] sum\n);\n\n  wire [4:0] _sum_T = {1'h0, a} + {1'h0, b};\n  `ifdef layer_Foo$A\n    overflow_occurred: assert property (@(posedge clock) ~(_sum_T[4]));\n  `endif // layer_Foo$A\n  assign sum = _sum_T[3:0];\nendmodule\n\n"})}),"\n",(0,r.jsx)(n.h3,{id:"design-verification-example",children:"Design Verification Example"}),"\n",(0,r.jsx)(n.p,{children:"Consider a use case where a design or design verification engineer would like to\nadd some asserts and debug prints to a module.  The logic necessary for the\nasserts and debug prints requires additional computation.  All of this code\nshould selectively included at Verilog elaboration time (not at Chisel\nelaboration time).  The engineer can use three layers to do this."}),"\n",(0,r.jsx)(n.p,{children:"There are three layers used in this example:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["The built-in ",(0,r.jsx)(n.code,{children:"Verification"})," layer"]}),"\n",(0,r.jsxs)(n.li,{children:["The built-in ",(0,r.jsx)(n.code,{children:"Assert"})," layer which is nested under the built-in ",(0,r.jsx)(n.code,{children:"Verification"}),"\nlayer"]}),"\n",(0,r.jsxs)(n.li,{children:["A user-defined ",(0,r.jsx)(n.code,{children:"Debug"})," layer which is also nested under the built-in\n",(0,r.jsx)(n.code,{children:"Verification"})," layer"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"Verification"})," layer can be used to store common logic used by both the\n",(0,r.jsx)(n.code,{children:"Assert"})," and ",(0,r.jsx)(n.code,{children:"Debug"})," layers.  The latter two layers allow for separation of,\nrespectively, assertions from prints."]}),"\n",(0,r.jsx)(n.p,{children:"One way to write this in Scala is the following:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.layer.{Layer, LayerConfig, block}\nimport chisel3.layers.Verification\n\n// User-defined layers are declared here.  Built-in layers do not need to be declared.\nobject UserDefined {\n  implicit val root: Layer = Verification\n  object Debug extends Layer(LayerConfig.Inline)\n}\n\nclass Foo extends Module {\n  val a = IO(Input(UInt(32.W)))\n  val b = IO(Output(UInt(32.W)))\n\n  b := a +% 1.U\n\n  // This adds a `Verification` layer block inside Foo.\n  block(Verification) {\n\n    // Some common logic added here.  The input port `a` is "captured" and\n    // used here.\n    val a_d0 = RegNext(a)\n\n    // This adds an `Assert` layer block.\n    block(Verification.Assert) {\n      chisel3.assert(a >= a_d0, "a must always increment")\n    }\n\n    // This adds a `Debug` layer block.\n    block(UserDefined.Debug) {\n      printf("a: %x, a_d0: %x", a, a_d0)\n    }\n\n  }\n\n}\n\n'})}),"\n",(0,r.jsx)(n.p,{children:"After compilation, this will produce two layer include files with the\nfollowing filenames.  One file is created for each extract layer:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"layers_Foo_Verification.sv"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"layers_Foo_Verification_Assert.sv"})}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Additionally, the resulting SystemVerilog will be sensitive to the preprocessor\ndefine ",(0,r.jsx)(n.code,{children:"layer_Foo$Verification$Debug"})," due to the one inline layer we added."]}),"\n",(0,r.jsxs)(n.p,{children:["A user can then include any combination of these files in their design to\ninclude the optional functionality described by the ",(0,r.jsx)(n.code,{children:"Verification"})," or\n",(0,r.jsx)(n.code,{children:"Verification.Assert"})," layers and enable debugging by setting the preprocessor\nmacro.  The ",(0,r.jsx)(n.code,{children:"Verification.Assert"})," bind file automatically includes the\n",(0,r.jsx)(n.code,{children:"Verification"})," bind file for the user."]}),"\n",(0,r.jsx)(n.h4,{id:"implementation-notes",children:"Implementation Notes"}),"\n",(0,r.jsxs)(n.admonition,{type:"warning",children:[(0,r.jsxs)(n.p,{children:["This section describes the implementation of how layers are compiled.  Anything\nthat is ",(0,r.jsx)(n.em,{children:"not"})," a bind file name or a preprocessor macro should not be relied\nupon!  A FIRRTL compiler may implement this differently or may optimize layer\nblocks in any legal way it chooses.  E.g., layer blocks associated with the same\nlayer may be merged, layer blocks may be moved up or down the hierarchy, code\nthat only fans out to a layer block may be sunk into it, and unused layer blocks\nmay be deleted."]}),(0,r.jsx)(n.p,{children:"The information below is for user understanding and interest only."})]}),"\n",(0,r.jsxs)(n.p,{children:["In implementation, a FIRRTL compiler creates three Verilog modules for the\ncircuit above (one for ",(0,r.jsx)(n.code,{children:"Foo"})," and one for each layer block associated with an\nextract layer in module ",(0,r.jsx)(n.code,{children:"Foo"}),"):"]}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Foo"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Foo_Verification"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Foo_Verification_Assert"})}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["These will typically be created in separate files with names that match the\nmodules, i.e., ",(0,r.jsx)(n.code,{children:"Foo.sv"}),", ",(0,r.jsx)(n.code,{children:"Foo_Verification.sv"}),", and\n",(0,r.jsx)(n.code,{children:"Foo_Verification_Assert.sv"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["The ports of each module created from a layer block will be automatically\ndetermined based on what that layer block captured from outside the layer block.\nIn the example above, the ",(0,r.jsx)(n.code,{children:"Verification"})," layer block captured port ",(0,r.jsx)(n.code,{children:"a"}),".  The\n",(0,r.jsx)(n.code,{children:"Assert"})," layer block captured captured ",(0,r.jsx)(n.code,{children:"a"})," and ",(0,r.jsx)(n.code,{children:"a_d0"}),"."]}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["Even though there are no layer blocks that use the ",(0,r.jsx)(n.code,{children:"Verification.Assume"})," or\n",(0,r.jsx)(n.code,{children:"Verification.Cover"})," layers, bind files which have no effect are produced in the\noutput.  This is due to the ABI which requires that layers that are defined in\nFIRRTL must produce these files."]})}),"\n",(0,r.jsx)(n.h4,{id:"verilog-output",children:"Verilog Output"}),"\n",(0,r.jsx)(n.p,{children:"The complete Verilog output for this example is reproduced below:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-verilog",children:'// Generated by CIRCT firtool-1.99.2\nmodule Foo(\n  input         clock,\n                reset,\n  input  [31:0] a,\n  output [31:0] b\n);\n\n  assign b = a + 32\'h1;\nendmodule\n\n\n// ----- 8< ----- FILE "verification/cover/layers-Foo-Verification-Cover.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n`include "verification/layers-Foo-Verification.sv"\n`ifndef layers_Foo_Verification_Cover\n`define layers_Foo_Verification_Cover\n`endif // layers_Foo_Verification_Cover\n\n// ----- 8< ----- FILE "verification/assume/layers-Foo-Verification-Assume.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n`include "verification/layers-Foo-Verification.sv"\n`ifndef layers_Foo_Verification_Assume\n`define layers_Foo_Verification_Assume\n`endif // layers_Foo_Verification_Assume\n\n// ----- 8< ----- FILE "verification/assert/layers-Foo-Verification-Assert.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n`include "verification/layers-Foo-Verification.sv"\n`ifndef layers_Foo_Verification_Assert\n`define layers_Foo_Verification_Assert\nbind Foo Foo_Verification_Assert verification_assert (\n  .a     (Foo.verification.a_probe),\n  .a_d0  (Foo.verification.a_d0_probe),\n  .reset (reset),\n  .clock (Foo.verification.clock_probe)\n);\n`endif // layers_Foo_Verification_Assert\n\n// ----- 8< ----- FILE "verification/layers-Foo-Verification.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n`ifndef layers_Foo_Verification\n`define layers_Foo_Verification\nbind Foo Foo_Verification verification (\n  .clock (clock),\n  .a     (a),\n  .reset (reset)\n);\n`endif // layers_Foo_Verification\n\n// ----- 8< ----- FILE "verification/assert/Foo_Verification_Assert.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n\n// Users can define \'STOP_COND\' to add an extra gate to stop conditions.\n`ifndef STOP_COND_\n  `ifdef STOP_COND\n    `define STOP_COND_ (`STOP_COND)\n  `else  // STOP_COND\n    `define STOP_COND_ 1\n  `endif // STOP_COND\n`endif // not def STOP_COND_\n\n// Users can define \'ASSERT_VERBOSE_COND\' to add an extra gate to assert error printing.\n`ifndef ASSERT_VERBOSE_COND_\n  `ifdef ASSERT_VERBOSE_COND\n    `define ASSERT_VERBOSE_COND_ (`ASSERT_VERBOSE_COND)\n  `else  // ASSERT_VERBOSE_COND\n    `define ASSERT_VERBOSE_COND_ 1\n  `endif // ASSERT_VERBOSE_COND\n`endif // not def ASSERT_VERBOSE_COND_\nmodule Foo_Verification_Assert(\n  input [31:0] a,\n               a_d0,\n  input        reset,\n               clock\n);\n\n  `ifndef SYNTHESIS\n    always @(posedge clock) begin\n      if (~reset & a < a_d0) begin\n        if (`ASSERT_VERBOSE_COND_)\n          $error("Assertion failed: a must always increment\\n");\n        if (`STOP_COND_)\n          $fatal;\n      end\n    end // always @(posedge)\n  `endif // not def SYNTHESIS\nendmodule\n\n\n// ----- 8< ----- FILE "verification/Foo_Verification.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.99.2\n\n// Users can define \'PRINTF_COND\' to add an extra gate to prints.\n`ifndef PRINTF_COND_\n  `ifdef PRINTF_COND\n    `define PRINTF_COND_ (`PRINTF_COND)\n  `else  // PRINTF_COND\n    `define PRINTF_COND_ 1\n  `endif // PRINTF_COND\n`endif // not def PRINTF_COND_\nmodule Foo_Verification(\n  input        clock,\n  input [31:0] a,\n  input        reset\n);\n\n  wire        clock_probe = clock;\n  wire [31:0] a_probe = a;\n  reg  [31:0] a_d0;\n  wire [31:0] a_d0_probe = a_d0;\n  `ifdef layer_Foo$Verification$Debug\n    `ifndef SYNTHESIS\n      always @(posedge clock) begin\n        if ((`PRINTF_COND_) & ~reset)\n          $fwrite(32\'h80000002, "a: %x, a_d0: %x", a, a_d0);\n      end // always @(posedge)\n    `endif // not def SYNTHESIS\n  `endif // layer_Foo$Verification$Debug\n  always @(posedge clock)\n    a_d0 <= a;\nendmodule\n\n'})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>s});var r=i(6540);const a={},o=r.createContext(a);function l(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[6474],{6458:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var r=i(4848),a=i(8453);const o={layout:"docs",title:"Layers",section:"chisel3"},l="Layers",s={id:"explanations/layers",title:"Layers",description:"Layers describe functionality of a Chisel generator that a user would like to",source:"@site/docs/explanations/layers.md",sourceDirName:"explanations",slug:"/explanations/layers",permalink:"/docs/explanations/layers",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/layers.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Layers",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Intrinsics",permalink:"/docs/explanations/intrinsics"},next:{title:"Memories",permalink:"/docs/explanations/memories"}},t={},c=[{value:"Overview",id:"overview",level:2},{value:"Verilog ABI",id:"verilog-abi",level:2},{value:"Extract Layers",id:"extract-layers",level:3},{value:"Inline Layers",id:"inline-layers",level:3},{value:"User-defined Layers",id:"user-defined-layers",level:2},{value:"Built-in Layers",id:"built-in-layers",level:2},{value:"Layer-coloring",id:"layer-coloring",level:2},{value:"Layer-colored Probes and Wires",id:"layer-colored-probes-and-wires",level:3},{value:"Enabling Layers",id:"enabling-layers",level:3},{value:"Examples",id:"examples",level:2},{value:"Simple Extract Layer",id:"simple-extract-layer",level:3},{value:"Simple Inline Layer",id:"simple-inline-layer",level:3},{value:"Design Verification Example",id:"design-verification-example",level:3},{value:"Implementation Notes",id:"implementation-notes",level:4},{value:"Verilog Output",id:"verilog-output",level:4}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"layers",children:"Layers"})}),"\n",(0,r.jsxs)(n.p,{children:["Layers describe functionality of a Chisel generator that a user would like to\n",(0,r.jsx)(n.em,{children:"optionally"})," include at Verilog elaboration time.  Pragmatically, they are a\nfeature to access SystemVerilog's ",(0,r.jsx)(n.code,{children:"bind"})," construct and ",(0,r.jsx)(n.code,{children:"`ifdef"})," preprocessor\nmacros.  The optional functionality of layers, by construction, is not allowed\nto affect logic outside the layer."]}),"\n",(0,r.jsx)(n.p,{children:"Layers are typically used to describe design verification code or\ndebugging logic that a user would like to be able to later disable (for\nperformance, verbosity, or cleanliness reasons) or use internally, but exclude\nfrom delivery to a customer."}),"\n",(0,r.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsx)(n.p,{children:"A layer consists of two pieces:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["A layer ",(0,r.jsx)(n.em,{children:"declaration"}),", and"]}),"\n",(0,r.jsxs)(n.li,{children:["One or more ",(0,r.jsx)(n.em,{children:"layer blocks"})," inside Chisel modules."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The declaration indicates that optional functionality can exist.  The layer\nblock contains the optional functionality."}),"\n",(0,r.jsxs)(n.p,{children:["There are two kinds of layers.  The layer kind determines the ",(0,r.jsx)(n.em,{children:"convention"}),",\ni.e., how the layer blocks of a layer are represented in Verilog and the\nmechanism to enable a layer.  Available layer kinds are:"]}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:['"Extract" Layers: layers whose blocks are lowered to modules that are\ninstantiated using ',(0,r.jsx)(n.code,{children:"bind"})," and can be enabled by including a file during\nVerilog elaboration, and"]}),"\n",(0,r.jsxs)(n.li,{children:['"Inline" Layers: layers whose blocks will be guarded with ',(0,r.jsx)(n.code,{children:"`ifdef"})," macros\nand can be enabled by setting a Verilog preprocessor define."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Extract layers may also specify a directory into which their collateral are\nwritten."}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["For more information about these SystemVerilog concepts, the IEEE 1800-2023\nstandard discusses ",(0,r.jsx)(n.code,{children:"bind"})," in Section 23.11 and ",(0,r.jsx)(n.code,{children:"`ifdef"})," in Section 23.6."]})}),"\n",(0,r.jsxs)(n.p,{children:["To declare a layer, create a singleton ",(0,r.jsx)(n.code,{children:"object"})," in scala that extends the\nabstract class ",(0,r.jsx)(n.code,{children:"chisel3.layer.Layer"}),", passing into the layer constructor either\nan object of class ",(0,r.jsx)(n.code,{children:"chisel3.layer.LayerConfig.Extract"})," for an extract layer, or\nthe object ",(0,r.jsx)(n.code,{children:"chisel3.layer.LayerConfig.Inline"})," for an inline layer."]}),"\n",(0,r.jsx)(n.p,{children:"Below, an extract layer and an inline layer are declared:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"import chisel3.layer.{Layer, LayerConfig}\n\nobject A extends Layer(LayerConfig.Extract())\n\nobject B extends Layer(LayerConfig.Inline)\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Layers may be nested.  Nesting a child layer under a parent layer means that the\nchild layer may access constructs in the parent layer.  Put differently, the\nchild layer will only be enabled if the parent layer is already enabled.  To\ndeclare a nested layer, extend the ",(0,r.jsx)(n.code,{children:"chisel3.layer.Layer"})," abstract class inside\nanother declaration."]}),"\n",(0,r.jsx)(n.p,{children:"The following example defines an extract layer with two nested layers inside it:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"object C extends Layer(LayerConfig.Extract()) {\n  object D extends Layer(LayerConfig.Extract())\n  object E extends Layer(LayerConfig.Inline) {\n    object F extends Layer(LayerConfig.Inline)\n  }\n}\n"})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["SystemVerilog prohibits a ",(0,r.jsx)(n.code,{children:"bind"})," instantiation under another ",(0,r.jsx)(n.code,{children:"bind"}),"\ninstantiation.  However, Chisel allows nesting of extract layers.  This is\nresolved by the FIRRTL compiler to restructure nested extract layers to be\nsibling modules that communicate via ports."]})}),"\n",(0,r.jsxs)(n.admonition,{type:"warning",children:[(0,r.jsx)(n.p,{children:"Extract layers may not be nested under inline layers.  However, inline layers\nmay be nested under extract layers."}),(0,r.jsx)(n.p,{children:"Any module which contains layer blocks or transitively contains layer blocks in\nits submodules may not be instantiated under a layer block."})]}),"\n",(0,r.jsxs)(n.p,{children:["A ",(0,r.jsx)(n.em,{children:"layer block"}),", associated with a layer, adds optional functionality to a\nmodule that is enabled if that layer is enabled.  To define a layer block, use\nthe ",(0,r.jsx)(n.code,{children:"chisel3.layer.block"})," inside a Chisel module and pass the layer that it\nshould be associated with."]}),"\n",(0,r.jsx)(n.p,{children:"Inside the layer block, any Chisel or Scala value visible in lexical scope may\nbe used.  Layer blocks may not return values.  Any values created inside a layer\nblock are not accessible outside the layer block, unless using layer-colored\nprobes."}),"\n",(0,r.jsxs)(n.p,{children:["The following example defines layer blocks inside module ",(0,r.jsx)(n.code,{children:"Foo"}),".  Each layer\nblock contains a wire that captures a value from its visible lexical scope.\n(For nested layer blocks, this scope includes their parent layer blocks.):"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.layer.block\n\nclass Foo extends RawModule {\n  val port = IO(Input(Bool()))\n\n  block(A) {\n    val a = WireInit(port)\n  }\n\n  block(B) {\n    val b = WireInit(port)\n  }\n\n  block(C) {\n    val c = WireInit(port)\n    block(C.D) {\n      val d = WireInit(port | c)\n    }\n    block(C.E) {\n      val e = WireInit(port ^ c)\n      block (C.E.F) {\n        val f = WireInit(port & e)\n      }\n    }\n  }\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["The layer block API will automatically create parent layer blocks for you if\npossible.  In the following example, it is legal to directly create a layer\nblock of ",(0,r.jsx)(n.code,{children:"C.D"})," directly in a module:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"class Bar extends RawModule {\n  block (C.D) {}\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Formally, it is legal to create a layer block associated with a layer as long as\nthe current scope is an ",(0,r.jsx)(n.em,{children:"ancestor"})," of the request layer."]}),"\n",(0,r.jsxs)(n.admonition,{type:"info",children:[(0,r.jsxs)(n.p,{children:["The requirement is an ",(0,r.jsx)(n.em,{children:"ancestor"})," relationship, not a ",(0,r.jsx)(n.em,{children:"proper ancestor"}),"\nrelationship.  This means that it is legal to nest a layer block under a layer\nblock of the same layer like:"]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"class Baz extends RawModule {\n  block(A) {\n    block(A) {}\n  }\n}\n"})})]}),"\n",(0,r.jsx)(n.h2,{id:"verilog-abi",children:"Verilog ABI"}),"\n",(0,r.jsx)(n.p,{children:"Layers are compiled to SystemVerilog using the FIRRTL ABI.  This ABI defines\nwhat happens to layer blocks in a Chisel design and how a layer can be enabled\nafter a design is compiled to SystemVerilog."}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["For the exact definition of the FIRRTL ABI for layers, see the ",(0,r.jsx)(n.a,{href:"https://github.com/chipsalliance/firrtl-spec/releases/latest/download/abi.pdf",children:"FIRRTL ABI\nSpecification"}),"."]})}),"\n",(0,r.jsx)(n.h3,{id:"extract-layers",children:"Extract Layers"}),"\n",(0,r.jsxs)(n.p,{children:["Extract layers have their layer blocks removed from the design.  To enable a\nlayer, a file with a specific name should be included in the design.  This file\nbegins with ",(0,r.jsx)(n.code,{children:"layers-"})," and then includes the circuit name and all layer names\ndelimited with dashes (",(0,r.jsx)(n.code,{children:"-"}),")."]}),"\n",(0,r.jsxs)(n.p,{children:["For example, for module ",(0,r.jsx)(n.code,{children:"Foo"})," declared above, this will produce three files, one\nfor each extract layer:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"layers-Foo-A.sv\nlayers-Foo-C.sv\nlayers-Foo-C-D.sv\n"})}),"\n",(0,r.jsx)(n.p,{children:"To enable any of these layers at compilation time, the appropriate file should\nbe included in the build.  Any combination of files may be included.  Including\nonly a child layer's file will automatically include its parent layer's file."}),"\n",(0,r.jsx)(n.h3,{id:"inline-layers",children:"Inline Layers"}),"\n",(0,r.jsxs)(n.p,{children:["Inline layers have their layer blocks guarded with conditional compilation\ndirectives.  To enable an inline layer, set a preprocessor define when compiling\nyour design.  The preprocessor define begins with ",(0,r.jsx)(n.code,{children:"layer_"})," and then includes the\ncircuit name and all layer names delimited with dollar signs (",(0,r.jsx)(n.code,{children:"$"}),").  Parent\nextract layer names appear in the macro."]}),"\n",(0,r.jsxs)(n.p,{children:["For example, for module ",(0,r.jsx)(n.code,{children:"Foo"})," declared above, this will be sensitive to three\nmacros, one for each inline layer:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"layer_Foo$B\nlayer_Foo$C$E\nlayer_Foo$C$E$F\n"})}),"\n",(0,r.jsx)(n.h2,{id:"user-defined-layers",children:"User-defined Layers"}),"\n",(0,r.jsxs)(n.p,{children:["A user is free to define as many layers as they want.  All layers shown\npreviously are user-defined, e.g., ",(0,r.jsx)(n.code,{children:"A"})," and ",(0,r.jsx)(n.code,{children:"C.E"})," are user-defined layers.\nUser-defined layers are only emitted into FIRRTL if they have layer block users.\nTo change this behavior and unconditionally emit a user-defined layer, use the\n",(0,r.jsx)(n.code,{children:"chisel3.layer.addLayer"})," API."]}),"\n",(0,r.jsx)(n.admonition,{type:"tip",children:(0,r.jsx)(n.p,{children:"Before creating new user-defined layers, consider using the built-in layers\ndefined below.  Additionally, if working in a larger project, the project may\nhave it's own user-defined layers that you are expected to use.  This is because\nthe ABIs affect the build system.  Please consult with a technical lead of the\nproject to see if this is the case."})}),"\n",(0,r.jsx)(n.h2,{id:"built-in-layers",children:"Built-in Layers"}),"\n",(0,r.jsx)(n.p,{children:"Chisel provides several built-in layers.  These are shown below with their full\nScala paths.  All built-in layers are extract layers:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"chisel3.layers.Verification\n\u251c\u2500\u2500 chisel3.layers.Verification.Assert\n\u251c\u2500\u2500 chisel3.layers.Verification.Assume\n\u2514\u2500\u2500 chisel3.layers.Verification.Cover\n"})}),"\n",(0,r.jsxs)(n.p,{children:["These built-in layers are dual purpose.  First, these layers match the common\nuse case of sequestering verification code.  The ",(0,r.jsx)(n.code,{children:"Verification"})," layer is for\ncommon verification collateral.  The ",(0,r.jsx)(n.code,{children:"Assert"}),", ",(0,r.jsx)(n.code,{children:"Assume"}),", and ",(0,r.jsx)(n.code,{children:"Cover"})," layers are\nfor, respectively, assertions, assumptions, and cover statements.  Second, the\nChisel standard library uses them for a number of its APIs.  ",(0,r.jsx)(n.em,{children:"Unless otherwise\nwrapped in a different layer block, the following operations are automatically\nplaced in layers"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Prints are placed in the ",(0,r.jsx)(n.code,{children:"Verification"})," layer"]}),"\n",(0,r.jsxs)(n.li,{children:["Assertions are placed in the ",(0,r.jsx)(n.code,{children:"Verification.Assert"})," layer"]}),"\n",(0,r.jsxs)(n.li,{children:["Assumptions are placed in the ",(0,r.jsx)(n.code,{children:"Verification.Assume"})," layer"]}),"\n",(0,r.jsxs)(n.li,{children:["Covers are placed in the ",(0,r.jsx)(n.code,{children:"Verification.Cover"})," layer"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["For predictability of output, these layers will always be show up in the FIRRTL\nthat Chisel emits.  To change this behavior, use ",(0,r.jsx)(n.code,{children:"firtool"})," command line options\nto ",(0,r.jsx)(n.em,{children:"specialize"})," these layers (remove their optionality by making them always\nenabled or disabled).  Use ",(0,r.jsx)(n.code,{children:"-enable-layers"})," to enable a layer, ",(0,r.jsx)(n.code,{children:"-disable-layers"}),"\nto disable a layer, or ",(0,r.jsx)(n.code,{children:"-default-layer-specialization"})," to set a default\nspecialization."]}),"\n",(0,r.jsxs)(n.admonition,{type:"tip",children:[(0,r.jsx)(n.p,{children:"Users may extend built-in layers with user-defined layers using an advanced API.\nTo do this, the layer parent must be specified as an implicit value."}),(0,r.jsxs)(n.p,{children:["The following example nests the layer ",(0,r.jsx)(n.code,{children:"Debug"})," to the ",(0,r.jsx)(n.code,{children:"Verification"})," layer:"]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"object UserDefined {\n  // Define an implicit val `root` of type `Layer` to cause layers which can see\n  // this to use `root` as their parent layer.  This allows us to nest the\n  // user-defined `Debug` layer under the built-in `Verification` layer.\n  implicit val root: Layer = chisel3.layers.Verification\n  object Debug extends Layer(LayerConfig.Inline)\n}\n"})})]}),"\n",(0,r.jsx)(n.h2,{id:"layer-coloring",children:"Layer-coloring"}),"\n",(0,r.jsxs)(n.p,{children:["While layers are not allowed to influence the design or their parent layers, it\nis often useful and necessary to allow layer blocks to send information out of\ntheir containing modules to be read by layer blocks of the same layer or\nchildren layers. Hardware which has this optional property is said to be\n",(0,r.jsx)(n.em,{children:"layer-colored"}),".  Both probes and wires can be layer-colored."]}),"\n",(0,r.jsx)(n.h3,{id:"layer-colored-probes-and-wires",children:"Layer-colored Probes and Wires"}),"\n",(0,r.jsx)(n.p,{children:"A layer-colored probe is a probe that exists if a user enables its corresponding\nlayer during Verilog elaboration.  Layer-colored probes are used to describe\noptional verification, debugging, or logging interfaces."}),"\n",(0,r.jsx)(n.p,{children:"Layer-colored wires are used as temporary storage of defined probe values.  They\nare used for communication between layer blocks of the same layer in the same\nmodule or as temporary storage when forwarding a probe to a port."}),"\n",(0,r.jsxs)(n.p,{children:["A layer-colored probe or wire may be the target of a ",(0,r.jsx)(n.code,{children:"define"})," if the ",(0,r.jsx)(n.code,{children:"define"})," is\nenabled when the color of the probe or wire is enabled.  A layer-colored probe\nor wire may be ",(0,r.jsx)(n.code,{children:"read"})," from if the color of the probe or wire is enabled when the\n",(0,r.jsx)(n.code,{children:"read"})," is enabled.  Put differently, you may write to your layer or a child\nlayer and you may read from your layer or a parent layer."]}),"\n",(0,r.jsx)(n.p,{children:"The example below shows two layer-colored probe ports and one layer-colored\nprobe wire driven in legal ways:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.layer.{Layer, LayerConfig}\nimport chisel3.probe.{Probe, ProbeValue, define}\n\nobject A extends Layer(LayerConfig.Extract())\nobject B extends Layer(LayerConfig.Extract())\n\nclass Foo extends RawModule {\n  val a = IO(Output(Probe(Bool(), A)))\n  val b = IO(Output(Probe(Bool(), B)))\n\n  layer.block(A) {\n    val a_wire = WireInit(false.B)\n    define(a, ProbeValue(a_wire))\n  }\n\n  val b_wire_probe = Wire(Probe(Bool(), B))\n  define(b, b_wire_probe)\n\n  layer.block(B) {\n    val b_wire = WireInit(false.B)\n    define(b_wire_probe, ProbeValue(b_wire))\n  }\n\n}\n"})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["For more information, see the layer coloring section of the ",(0,r.jsx)(n.a,{href:"https://github.com/chipsalliance/firrtl-spec/releases/latest/download/spec.pdf",children:"FIRRTL\nSpecification"}),"."]})}),"\n",(0,r.jsx)(n.h3,{id:"enabling-layers",children:"Enabling Layers"}),"\n",(0,r.jsxs)(n.p,{children:["When working with layer-colored probes, it is often convenient to grant access\nto probes of one or more colors.  E.g., testbenches often want to ",(0,r.jsx)(n.em,{children:"enable"})," all\nlayers in a design-under-test so that they gain access to layer-colored probe\nports necessary for advanced design verification.  Without an additional\nfeature, this use case is poorly supported with just layer coloring.  First, it\nis tedious to enclose all code inside a testbench in a layer block.  Second, a\ntestbench may need to read probes with colors that do not have a parent--child\nrelationship.  No layer block is capable of both legally reading from different\nprobes and combining the results."]}),"\n",(0,r.jsxs)(n.p,{children:["To support this use case, Chisel provides the ",(0,r.jsx)(n.code,{children:"layer.enable"})," API.  This API\ngrants access to any layer-colored probes of instantiated modules for the\nenabled layer.  The API may be used more than once to enable more than one\nlayer."]}),"\n",(0,r.jsxs)(n.p,{children:["The example below instantiates module ",(0,r.jsx)(n.code,{children:"Foo"})," from the previous section.  After\nenabling layers ",(0,r.jsx)(n.code,{children:"A"})," and ",(0,r.jsx)(n.code,{children:"B"}),", the module can read from probes with colors ",(0,r.jsx)(n.code,{children:"A"})," and\n",(0,r.jsx)(n.code,{children:"B"})," and use their results in a single operation:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:"import chisel3.layer.enable\nimport chisel3.probe.read\n\nclass Bar extends RawModule {\n\n  enable(A)\n  enable(B)\n\n  val foo = Module(new Foo)\n\n  val c = read(foo.a) ^ read(foo.b)\n\n}\n"})}),"\n",(0,r.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.h3,{id:"simple-extract-layer",children:"Simple Extract Layer"}),"\n",(0,r.jsxs)(n.p,{children:["The design below has a single extract layer that, when enabled, will add an\nassert that checks for overflow.  Based on the FIRRTL ABI, we can expect that a\nfile called ",(0,r.jsx)(n.code,{children:"layers-Foo-A.sv"})," will be produced when we compile it."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.layer.{Layer, LayerConfig, block}\nimport chisel3.ltl.AssertProperty\n\nobject A extends Layer(LayerConfig.Extract())\n\nclass Foo extends Module {\n  val a, b = IO(Input(UInt(4.W)))\n  val sum = IO(Output(UInt(4.W)))\n\n  sum :<= a +% b\n\n  block(A) {\n    withDisable(Disable.Never) {\n      AssertProperty(!(a +& b)(4), "overflow occurred")\n    }\n  }\n\n}\n'})}),"\n",(0,r.jsxs)(n.p,{children:["After compilation, we get the following SystemVerilog.  Comments that include\n",(0,r.jsx)(n.code,{children:"FILE"})," indicate the beginning of a new file:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-verilog",children:'// Generated by CIRCT firtool-1.100.0\nmodule Foo(\n  input        clock,\n               reset,\n  input  [3:0] a,\n               b,\n  output [3:0] sum\n);\n\n  wire [4:0] _sum_T = {1\'h0, a} + {1\'h0, b};\n  assign sum = _sum_T[3:0];\nendmodule\n\n\n// ----- 8< ----- FILE "A/layers-Foo-A.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n`ifndef layers_Foo_A\n`define layers_Foo_A\nbind Foo Foo_A a_0 (\n  ._GEN  (_sum_T),\n  .clock (clock)\n);\n`endif // layers_Foo_A\n\n// ----- 8< ----- FILE "A/Foo_A.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\nmodule Foo_A(\n  input [4:0] _GEN,\n  input       clock\n);\n\n  overflow_occurred: assert property (@(posedge clock) ~(_GEN[4]));\nendmodule\n\n'})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["The above example was compiled with the firtool options\n",(0,r.jsx)(n.code,{children:"-enable-layers=Verification"}),", ",(0,r.jsx)(n.code,{children:"-enable-layers=Verification.Assert"}),",\n",(0,r.jsx)(n.code,{children:"-enable-layers=Verification.Assume"}),", and ",(0,r.jsx)(n.code,{children:"-enable-layers=Verification.Cover"})," to\nmake the output terser.  Normally, bind files would show up for these built-in\nlayers."]})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["Note: the generated module, ",(0,r.jsx)(n.code,{children:"Foo_A"}),", and its file, ",(0,r.jsx)(n.code,{children:"Foo_A.sv"}),", are ",(0,r.jsx)(n.em,{children:"not part of\nthe ABI"}),".  You should not rely on any generated module names or files other than\nthe bind file, ",(0,r.jsx)(n.code,{children:"layers-Foo-A.sv"}),"."]})}),"\n",(0,r.jsx)(n.h3,{id:"simple-inline-layer",children:"Simple Inline Layer"}),"\n",(0,r.jsxs)(n.p,{children:["The design below is the same as the previous example, but uses an inline layer.\nBased on the FIRRTL ABI, we can expect that the body of the layer block will be\nguarded by an ",(0,r.jsx)(n.code,{children:"`ifdef"})," sensitive to the preprocessor macro ",(0,r.jsx)(n.code,{children:"layer_Foo$A"}),"."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.layer.{Layer, LayerConfig, block}\nimport chisel3.ltl.AssertProperty\n\nobject A extends Layer(LayerConfig.Inline)\n\nclass Foo extends Module {\n  val a, b = IO(Input(UInt(4.W)))\n  val sum = IO(Output(UInt(4.W)))\n\n  sum :<= a +% b\n\n  block(A) {\n    withDisable(Disable.Never) {\n      AssertProperty(!(a +& b)(4), "overflow occurred")\n    }\n  }\n\n}\n'})}),"\n",(0,r.jsx)(n.p,{children:"After compilation, we get the following SystemVerilog."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Foo(\n  input        clock,\n               reset,\n  input  [3:0] a,\n               b,\n  output [3:0] sum\n);\n\n  wire [4:0] _sum_T = {1'h0, a} + {1'h0, b};\n  `ifdef layer_Foo$A\n    overflow_occurred: assert property (@(posedge clock) ~(_sum_T[4]));\n  `endif // layer_Foo$A\n  assign sum = _sum_T[3:0];\nendmodule\n\n"})}),"\n",(0,r.jsx)(n.h3,{id:"design-verification-example",children:"Design Verification Example"}),"\n",(0,r.jsx)(n.p,{children:"Consider a use case where a design or design verification engineer would like to\nadd some asserts and debug prints to a module.  The logic necessary for the\nasserts and debug prints requires additional computation.  All of this code\nshould selectively included at Verilog elaboration time (not at Chisel\nelaboration time).  The engineer can use three layers to do this."}),"\n",(0,r.jsx)(n.p,{children:"There are three layers used in this example:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["The built-in ",(0,r.jsx)(n.code,{children:"Verification"})," layer"]}),"\n",(0,r.jsxs)(n.li,{children:["The built-in ",(0,r.jsx)(n.code,{children:"Assert"})," layer which is nested under the built-in ",(0,r.jsx)(n.code,{children:"Verification"}),"\nlayer"]}),"\n",(0,r.jsxs)(n.li,{children:["A user-defined ",(0,r.jsx)(n.code,{children:"Debug"})," layer which is also nested under the built-in\n",(0,r.jsx)(n.code,{children:"Verification"})," layer"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"Verification"})," layer can be used to store common logic used by both the\n",(0,r.jsx)(n.code,{children:"Assert"})," and ",(0,r.jsx)(n.code,{children:"Debug"})," layers.  The latter two layers allow for separation of,\nrespectively, assertions from prints."]}),"\n",(0,r.jsx)(n.p,{children:"One way to write this in Scala is the following:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.layer.{Layer, LayerConfig, block}\nimport chisel3.layers.Verification\n\n// User-defined layers are declared here.  Built-in layers do not need to be declared.\nobject UserDefined {\n  implicit val root: Layer = Verification\n  object Debug extends Layer(LayerConfig.Inline)\n}\n\nclass Foo extends Module {\n  val a = IO(Input(UInt(32.W)))\n  val b = IO(Output(UInt(32.W)))\n\n  b := a +% 1.U\n\n  // This adds a `Verification` layer block inside Foo.\n  block(Verification) {\n\n    // Some common logic added here.  The input port `a` is "captured" and\n    // used here.\n    val a_d0 = RegNext(a)\n\n    // This adds an `Assert` layer block.\n    block(Verification.Assert) {\n      chisel3.assert(a >= a_d0, "a must always increment")\n    }\n\n    // This adds a `Debug` layer block.\n    block(UserDefined.Debug) {\n      printf("a: %x, a_d0: %x", a, a_d0)\n    }\n\n  }\n\n}\n\n'})}),"\n",(0,r.jsx)(n.p,{children:"After compilation, this will produce two layer include files with the\nfollowing filenames.  One file is created for each extract layer:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"layers_Foo_Verification.sv"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"layers_Foo_Verification_Assert.sv"})}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Additionally, the resulting SystemVerilog will be sensitive to the preprocessor\ndefine ",(0,r.jsx)(n.code,{children:"layer_Foo$Verification$Debug"})," due to the one inline layer we added."]}),"\n",(0,r.jsxs)(n.p,{children:["A user can then include any combination of these files in their design to\ninclude the optional functionality described by the ",(0,r.jsx)(n.code,{children:"Verification"})," or\n",(0,r.jsx)(n.code,{children:"Verification.Assert"})," layers and enable debugging by setting the preprocessor\nmacro.  The ",(0,r.jsx)(n.code,{children:"Verification.Assert"})," bind file automatically includes the\n",(0,r.jsx)(n.code,{children:"Verification"})," bind file for the user."]}),"\n",(0,r.jsx)(n.h4,{id:"implementation-notes",children:"Implementation Notes"}),"\n",(0,r.jsxs)(n.admonition,{type:"warning",children:[(0,r.jsxs)(n.p,{children:["This section describes the implementation of how layers are compiled.  Anything\nthat is ",(0,r.jsx)(n.em,{children:"not"})," a bind file name or a preprocessor macro should not be relied\nupon!  A FIRRTL compiler may implement this differently or may optimize layer\nblocks in any legal way it chooses.  E.g., layer blocks associated with the same\nlayer may be merged, layer blocks may be moved up or down the hierarchy, code\nthat only fans out to a layer block may be sunk into it, and unused layer blocks\nmay be deleted."]}),(0,r.jsx)(n.p,{children:"The information below is for user understanding and interest only."})]}),"\n",(0,r.jsxs)(n.p,{children:["In implementation, a FIRRTL compiler creates three Verilog modules for the\ncircuit above (one for ",(0,r.jsx)(n.code,{children:"Foo"})," and one for each layer block associated with an\nextract layer in module ",(0,r.jsx)(n.code,{children:"Foo"}),"):"]}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Foo"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Foo_Verification"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Foo_Verification_Assert"})}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["These will typically be created in separate files with names that match the\nmodules, i.e., ",(0,r.jsx)(n.code,{children:"Foo.sv"}),", ",(0,r.jsx)(n.code,{children:"Foo_Verification.sv"}),", and\n",(0,r.jsx)(n.code,{children:"Foo_Verification_Assert.sv"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["The ports of each module created from a layer block will be automatically\ndetermined based on what that layer block captured from outside the layer block.\nIn the example above, the ",(0,r.jsx)(n.code,{children:"Verification"})," layer block captured port ",(0,r.jsx)(n.code,{children:"a"}),".  The\n",(0,r.jsx)(n.code,{children:"Assert"})," layer block captured captured ",(0,r.jsx)(n.code,{children:"a"})," and ",(0,r.jsx)(n.code,{children:"a_d0"}),"."]}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["Even though there are no layer blocks that use the ",(0,r.jsx)(n.code,{children:"Verification.Assume"})," or\n",(0,r.jsx)(n.code,{children:"Verification.Cover"})," layers, bind files which have no effect are produced in the\noutput.  This is due to the ABI which requires that layers that are defined in\nFIRRTL must produce these files."]})}),"\n",(0,r.jsx)(n.h4,{id:"verilog-output",children:"Verilog Output"}),"\n",(0,r.jsx)(n.p,{children:"The complete Verilog output for this example is reproduced below:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-verilog",children:'// Generated by CIRCT firtool-1.100.0\nmodule Foo(\n  input         clock,\n                reset,\n  input  [31:0] a,\n  output [31:0] b\n);\n\n  assign b = a + 32\'h1;\nendmodule\n\n\n// ----- 8< ----- FILE "verification/cover/layers-Foo-Verification-Cover.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n`include "verification/layers-Foo-Verification.sv"\n`ifndef layers_Foo_Verification_Cover\n`define layers_Foo_Verification_Cover\n`endif // layers_Foo_Verification_Cover\n\n// ----- 8< ----- FILE "verification/assume/layers-Foo-Verification-Assume.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n`include "verification/layers-Foo-Verification.sv"\n`ifndef layers_Foo_Verification_Assume\n`define layers_Foo_Verification_Assume\n`endif // layers_Foo_Verification_Assume\n\n// ----- 8< ----- FILE "verification/assert/layers-Foo-Verification-Assert.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n`include "verification/layers-Foo-Verification.sv"\n`ifndef layers_Foo_Verification_Assert\n`define layers_Foo_Verification_Assert\nbind Foo Foo_Verification_Assert verification_assert (\n  .a     (Foo.verification.a_probe),\n  .a_d0  (Foo.verification.a_d0_probe),\n  .reset (reset),\n  .clock (Foo.verification.clock_probe)\n);\n`endif // layers_Foo_Verification_Assert\n\n// ----- 8< ----- FILE "verification/layers-Foo-Verification.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n`ifndef layers_Foo_Verification\n`define layers_Foo_Verification\nbind Foo Foo_Verification verification (\n  .clock (clock),\n  .a     (a),\n  .reset (reset)\n);\n`endif // layers_Foo_Verification\n\n// ----- 8< ----- FILE "verification/assert/Foo_Verification_Assert.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n\n// Users can define \'STOP_COND\' to add an extra gate to stop conditions.\n`ifndef STOP_COND_\n  `ifdef STOP_COND\n    `define STOP_COND_ (`STOP_COND)\n  `else  // STOP_COND\n    `define STOP_COND_ 1\n  `endif // STOP_COND\n`endif // not def STOP_COND_\n\n// Users can define \'ASSERT_VERBOSE_COND\' to add an extra gate to assert error printing.\n`ifndef ASSERT_VERBOSE_COND_\n  `ifdef ASSERT_VERBOSE_COND\n    `define ASSERT_VERBOSE_COND_ (`ASSERT_VERBOSE_COND)\n  `else  // ASSERT_VERBOSE_COND\n    `define ASSERT_VERBOSE_COND_ 1\n  `endif // ASSERT_VERBOSE_COND\n`endif // not def ASSERT_VERBOSE_COND_\nmodule Foo_Verification_Assert(\n  input [31:0] a,\n               a_d0,\n  input        reset,\n               clock\n);\n\n  `ifndef SYNTHESIS\n    always @(posedge clock) begin\n      if (~reset & a < a_d0) begin\n        if (`ASSERT_VERBOSE_COND_)\n          $error("Assertion failed: a must always increment\\n");\n        if (`STOP_COND_)\n          $fatal;\n      end\n    end // always @(posedge)\n  `endif // not def SYNTHESIS\nendmodule\n\n\n// ----- 8< ----- FILE "verification/Foo_Verification.sv" ----- 8< -----\n\n// Generated by CIRCT firtool-1.100.0\n\n// Users can define \'PRINTF_FD\' to add a specified fd to prints.\n`ifndef PRINTF_FD_\n  `ifdef PRINTF_FD\n    `define PRINTF_FD_ (`PRINTF_FD)\n  `else  // PRINTF_FD\n    `define PRINTF_FD_ 32\'h80000002\n  `endif // PRINTF_FD\n`endif // not def PRINTF_FD_\n\n// Users can define \'PRINTF_COND\' to add an extra gate to prints.\n`ifndef PRINTF_COND_\n  `ifdef PRINTF_COND\n    `define PRINTF_COND_ (`PRINTF_COND)\n  `else  // PRINTF_COND\n    `define PRINTF_COND_ 1\n  `endif // PRINTF_COND\n`endif // not def PRINTF_COND_\nmodule Foo_Verification(\n  input        clock,\n  input [31:0] a,\n  input        reset\n);\n\n  wire        clock_probe = clock;\n  wire [31:0] a_probe = a;\n  reg  [31:0] a_d0;\n  wire [31:0] a_d0_probe = a_d0;\n  `ifdef layer_Foo$Verification$Debug\n    `ifndef SYNTHESIS\n      always @(posedge clock) begin\n        if ((`PRINTF_COND_) & ~reset)\n          $fwrite(`PRINTF_FD_, "a: %x, a_d0: %x", a, a_d0);\n      end // always @(posedge)\n    `endif // not def SYNTHESIS\n  `endif // layer_Foo$Verification$Debug\n  always @(posedge clock)\n    a_d0 <= a;\nendmodule\n\n'})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>s});var r=i(6540);const a={},o=r.createContext(a);function l(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/cdcdfbab.6031edb9.js b/assets/js/cdcdfbab.6031edb9.js
deleted file mode 100644
index dbd9548250..0000000000
--- a/assets/js/cdcdfbab.6031edb9.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[5522],{6102:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>d,frontMatter:()=>t,metadata:()=>c,toc:()=>u});var l=s(4848),a=s(8453);const t={layout:"docs",title:"Enumerations",section:"chisel3"},i="ChiselEnum",c={id:"explanations/chisel-enum",title:"Enumerations",description:"The ChiselEnum type can be used to reduce the chance of error when encoding mux selectors, opcodes, and functional unit operations.",source:"@site/docs/explanations/chisel-enum.md",sourceDirName:"explanations",slug:"/explanations/chisel-enum",permalink:"/docs/explanations/chisel-enum",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/chisel-enum.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Enumerations",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Bundles and Vecs",permalink:"/docs/explanations/bundles-and-vecs"},next:{title:"Chisel Type vs Scala Type",permalink:"/docs/explanations/chisel-type-vs-scala-type"}},o={},u=[{value:"Functionality and Examples",id:"functionality-and-examples",level:2},{value:"Casting",id:"casting",level:2},{value:"Testing",id:"testing",level:2},{value:"Workarounds",id:"workarounds",level:2},{value:"Additional Resources",id:"additional-resources",level:2}];function r(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"chiselenum",children:"ChiselEnum"})}),"\n",(0,l.jsxs)(n.p,{children:["The ChiselEnum type can be used to reduce the chance of error when encoding mux selectors, opcodes, and functional unit operations.\nIn contrast with ",(0,l.jsx)(n.code,{children:"Chisel.util.Enum"}),", ",(0,l.jsx)(n.code,{children:"ChiselEnum"})," are subclasses of ",(0,l.jsx)(n.code,{children:"Data"}),", which means that they can be used to define fields in ",(0,l.jsx)(n.code,{children:"Bundle"}),"s, including in ",(0,l.jsx)(n.code,{children:"IO"}),"s."]}),"\n",(0,l.jsx)(n.h2,{id:"functionality-and-examples",children:"Functionality and Examples"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"// Imports used in the following examples\nimport chisel3._\nimport chisel3.util._\n"})}),"\n",(0,l.jsx)(n.p,{children:"Below we see ChiselEnum being used as mux select for a RISC-V core. While wrapping the object in a package is not required, it is highly recommended as it allows for the type to be used in multiple files more easily."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"// package CPUTypes {\nobject AluMux1Sel extends ChiselEnum {\n  val selectRS1, selectPC = Value\n}\n// We can see the mapping by printing each Value\nAluMux1Sel.all.foreach(println)\n// AluMux1Sel(0=selectRS1)\n// AluMux1Sel(1=selectPC)\n"})}),"\n",(0,l.jsx)(n.p,{children:"Here we see a mux using the AluMux1Sel to select between different inputs."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import AluMux1Sel._\n\nclass AluMux1Bundle extends Bundle {\n  val aluMux1Sel = Input(AluMux1Sel())\n  val rs1Out     = Input(Bits(32.W))\n  val pcOut      = Input(Bits(32.W))\n  val aluMux1Out = Output(Bits(32.W))\n}\n\nclass AluMux1File extends Module {\n  val io = IO(new AluMux1Bundle)\n\n  // Default value for aluMux1Out\n  io.aluMux1Out := 0.U\n\n  switch (io.aluMux1Sel) {\n    is (selectRS1) {\n      io.aluMux1Out := io.rs1Out\n    }\n    is (selectPC) {\n      io.aluMux1Out := io.pcOut\n    }\n  }\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule AluMux1File(\n  input         clock,\n                reset,\n                io_aluMux1Sel,\n  input  [31:0] io_rs1Out,\n                io_pcOut,\n  output [31:0] io_aluMux1Out\n);\n\n  assign io_aluMux1Out = io_aluMux1Sel ? io_pcOut : io_rs1Out;\nendmodule\n\n"})}),"\n",(0,l.jsxs)(n.p,{children:["ChiselEnum also allows for the user to directly set the Values by passing an ",(0,l.jsx)(n.code,{children:"UInt"})," to ",(0,l.jsx)(n.code,{children:"Value(...)"}),"\nas shown below. Note that the magnitude of each ",(0,l.jsx)(n.code,{children:"Value"})," must be strictly greater than the one before\nit."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:'object Opcode extends ChiselEnum {\n    val load  = Value(0x03.U) // i "load"  -> 000_0011\n    val imm   = Value(0x13.U) // i "imm"   -> 001_0011\n    val auipc = Value(0x17.U) // u "auipc" -> 001_0111\n    val store = Value(0x23.U) // s "store" -> 010_0011\n    val reg   = Value(0x33.U) // r "reg"   -> 011_0011\n    val lui   = Value(0x37.U) // u "lui"   -> 011_0111\n    val br    = Value(0x63.U) // b "br"    -> 110_0011\n    val jalr  = Value(0x67.U) // i "jalr"  -> 110_0111\n    val jal   = Value(0x6F.U) // j "jal"   -> 110_1111\n}\n'})}),"\n",(0,l.jsx)(n.p,{children:"The user can 'jump' to a value and continue incrementing by passing a start point then using a regular Value definition."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"object BranchFunct3 extends ChiselEnum {\n    val beq, bne = Value\n    val blt = Value(4.U)\n    val bge, bltu, bgeu = Value\n}\n// We can see the mapping by printing each Value\nBranchFunct3.all.foreach(println)\n// BranchFunct3(0=beq)\n// BranchFunct3(1=bne)\n// BranchFunct3(4=blt)\n// BranchFunct3(5=bge)\n// BranchFunct3(6=bltu)\n// BranchFunct3(7=bgeu)\n"})}),"\n",(0,l.jsx)(n.h2,{id:"casting",children:"Casting"}),"\n",(0,l.jsxs)(n.p,{children:["You can cast an enum to a ",(0,l.jsx)(n.code,{children:"UInt"})," using ",(0,l.jsx)(n.code,{children:".asUInt"}),":"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class ToUInt extends RawModule {\n  val in = IO(Input(Opcode()))\n  val out = IO(Output(UInt(in.getWidth.W)))\n  out := in.asUInt\n}\n"})}),"\n",(0,l.jsxs)(n.p,{children:["You can cast from a ",(0,l.jsx)(n.code,{children:"UInt"})," to an enum by passing the ",(0,l.jsx)(n.code,{children:"UInt"})," to the apply method of the ",(0,l.jsx)(n.code,{children:"ChiselEnum"})," object:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class FromUInt extends Module {\n  val in = IO(Input(UInt(7.W)))\n  val out = IO(Output(Opcode()))\n  out := Opcode(in)\n}\n"})}),"\n",(0,l.jsxs)(n.p,{children:["However, if you cast from a ",(0,l.jsx)(n.code,{children:"UInt"})," to an Enum type when there are undefined states in the Enum values\nthat the ",(0,l.jsx)(n.code,{children:"UInt"})," could hit, you will see a warning like the following:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:"[warn] chisel-enum.md 133:16: [W001] Casting non-literal UInt to repl.MdocSession$MdocApp$Opcode. You can use repl.MdocSession$MdocApp$Opcode.safe to cast without this warning.\n[warn] There were 1 warning(s) during hardware elaboration.\n"})}),"\n",(0,l.jsx)(n.p,{children:"(Note that the name of the Enum is ugly as an artifact of our documentation generation flow, it will\nbe cleaner in normal use)."}),"\n",(0,l.jsxs)(n.p,{children:["You can avoid this warning by using the ",(0,l.jsx)(n.code,{children:".safe"})," factory method which returns the cast Enum in addition\nto a ",(0,l.jsx)(n.code,{children:"Bool"})," indicating if the Enum is in a valid state:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:'class SafeFromUInt extends Module {\n  val in = IO(Input(UInt(7.W)))\n  val out = IO(Output(Opcode()))\n  val (value, valid) = Opcode.safe(in)\n  assert(valid, "Enum state must be valid, got %d!", in)\n  out := value\n}\n'})}),"\n",(0,l.jsx)(n.p,{children:"Now there will be no warning:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{})}),"\n",(0,l.jsxs)(n.p,{children:["You can also suppress the warning by using ",(0,l.jsx)(n.code,{children:"suppressEnumCastWarning"}),". This is\nprimarily used for casting from [[UInt]] to a Bundle type that contains an\nEnum, where the [[UInt]] is known to be valid for the Bundle type."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class MyBundle extends Bundle {\n  val addr = UInt(8.W)\n  val op = Opcode()\n}\n\nclass SuppressedFromUInt extends Module {\n  val in = IO(Input(UInt(15.W)))\n  val out = IO(Output(new MyBundle()))\n  suppressEnumCastWarning {\n    out := in.asTypeOf(new MyBundle)\n  }\n}\n"})}),"\n",(0,l.jsx)(n.h2,{id:"testing",children:"Testing"}),"\n",(0,l.jsxs)(n.p,{children:["The ",(0,l.jsx)(n.em,{children:"Type"})," of the enums values is ",(0,l.jsx)(n.code,{children:"<ChiselEnum Object>.Type"})," which can be useful for passing the values\nas parameters to a function (or any other time a type annotation is needed).\nCalling ",(0,l.jsx)(n.code,{children:".litValue"})," on an enum value will return the integer value of that object as a\n",(0,l.jsx)(n.a,{href:"https://www.scala-lang.org/api/2.12.13/scala/math/BigInt.html",children:(0,l.jsx)(n.code,{children:"BigInt"})}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"def expectedSel(sel: AluMux1Sel.Type): Boolean = sel match {\n  case AluMux1Sel.selectRS1 => (sel.litValue == 0)\n  case AluMux1Sel.selectPC  => (sel.litValue == 1)\n  case _                    => false\n}\n"})}),"\n",(0,l.jsxs)(n.p,{children:["The enum value type also defines some convenience methods for working with ",(0,l.jsx)(n.code,{children:"ChiselEnum"})," values. For example, continuing with the RISC-V opcode\nexample, one could easily create hardware signal that is only asserted on LOAD/STORE operations (when the enum value is equal to ",(0,l.jsx)(n.code,{children:"Opcode.load"}),"\nor ",(0,l.jsx)(n.code,{children:"Opcode.store"}),") using the ",(0,l.jsx)(n.code,{children:".isOneOf"})," method:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class LoadStoreExample extends Module {\n  val io = IO(new Bundle {\n    val opcode = Input(Opcode())\n    val load_or_store = Output(Bool())\n  })\n  io.load_or_store := io.opcode.isOneOf(Opcode.load, Opcode.store)\n}\n"})}),"\n",(0,l.jsxs)(n.p,{children:["Some additional useful methods defined on the ",(0,l.jsx)(n.code,{children:"ChiselEnum"})," object are:"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.code,{children:".all"}),": returns the enum values within the enumeration"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.code,{children:".getWidth"}),": returns the width of the hardware type"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"workarounds",children:"Workarounds"}),"\n",(0,l.jsxs)(n.p,{children:["As of Chisel v3.4.3 (1 July 2020), the width of the values is always inferred.\nTo work around this, you can add an extra ",(0,l.jsx)(n.code,{children:"Value"})," that forces the width that is desired.\nThis is shown in the example below, where we add a field ",(0,l.jsx)(n.code,{children:"ukn"})," to force the width to be 3 bits wide:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"object StoreFunct3 extends ChiselEnum {\n    val sb, sh, sw = Value\n    val ukn = Value(7.U)\n}\n// We can see the mapping by printing each Value\nStoreFunct3.all.foreach(println)\n// StoreFunct3(0=sb)\n// StoreFunct3(1=sh)\n// StoreFunct3(2=sw)\n// StoreFunct3(7=ukn)\n"})}),"\n",(0,l.jsxs)(n.p,{children:["Signed values are not supported so if you want the value signed, you must cast the UInt with ",(0,l.jsx)(n.code,{children:".asSInt"}),"."]}),"\n",(0,l.jsx)(n.h2,{id:"additional-resources",children:"Additional Resources"}),"\n",(0,l.jsxs)(n.p,{children:["The ChiselEnum type is much more powerful than stated above. It allows for Sequence, Vec, and Bundle assignments, as well as a ",(0,l.jsx)(n.code,{children:".next"})," operation to allow for stepping through sequential states and an ",(0,l.jsx)(n.code,{children:".isValid"})," for checking that a hardware value is a valid ",(0,l.jsx)(n.code,{children:"Value"}),". The source code for the ChiselEnum can be found ",(0,l.jsx)(n.a,{href:"https://github.com/chipsalliance/chisel3/blob/2a96767097264eade18ff26e1d8bce192383a190/core/src/main/scala/chisel3/StrongEnum.scala",children:"here"})," in the class ",(0,l.jsx)(n.code,{children:"EnumFactory"}),". Examples of the ChiselEnum operations can be found ",(0,l.jsx)(n.a,{href:"https://github.com/chipsalliance/chisel3/blob/dd6871b8b3f2619178c2a333d9d6083805d99e16/src/test/scala/chiselTests/StrongEnum.scala",children:"here"}),"."]})]})}function d(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(r,{...e})}):r(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>c});var l=s(6540);const a={},t=l.createContext(a);function i(e){const n=l.useContext(t);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),l.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/cdcdfbab.953ede6d.js b/assets/js/cdcdfbab.953ede6d.js
new file mode 100644
index 0000000000..57ef25affe
--- /dev/null
+++ b/assets/js/cdcdfbab.953ede6d.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[5522],{6102:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>d,frontMatter:()=>t,metadata:()=>c,toc:()=>u});var l=s(4848),a=s(8453);const t={layout:"docs",title:"Enumerations",section:"chisel3"},i="ChiselEnum",c={id:"explanations/chisel-enum",title:"Enumerations",description:"The ChiselEnum type can be used to reduce the chance of error when encoding mux selectors, opcodes, and functional unit operations.",source:"@site/docs/explanations/chisel-enum.md",sourceDirName:"explanations",slug:"/explanations/chisel-enum",permalink:"/docs/explanations/chisel-enum",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/chisel-enum.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Enumerations",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Bundles and Vecs",permalink:"/docs/explanations/bundles-and-vecs"},next:{title:"Chisel Type vs Scala Type",permalink:"/docs/explanations/chisel-type-vs-scala-type"}},o={},u=[{value:"Functionality and Examples",id:"functionality-and-examples",level:2},{value:"Casting",id:"casting",level:2},{value:"Testing",id:"testing",level:2},{value:"Workarounds",id:"workarounds",level:2},{value:"Additional Resources",id:"additional-resources",level:2}];function r(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"chiselenum",children:"ChiselEnum"})}),"\n",(0,l.jsxs)(n.p,{children:["The ChiselEnum type can be used to reduce the chance of error when encoding mux selectors, opcodes, and functional unit operations.\nIn contrast with ",(0,l.jsx)(n.code,{children:"Chisel.util.Enum"}),", ",(0,l.jsx)(n.code,{children:"ChiselEnum"})," are subclasses of ",(0,l.jsx)(n.code,{children:"Data"}),", which means that they can be used to define fields in ",(0,l.jsx)(n.code,{children:"Bundle"}),"s, including in ",(0,l.jsx)(n.code,{children:"IO"}),"s."]}),"\n",(0,l.jsx)(n.h2,{id:"functionality-and-examples",children:"Functionality and Examples"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"// Imports used in the following examples\nimport chisel3._\nimport chisel3.util._\n"})}),"\n",(0,l.jsx)(n.p,{children:"Below we see ChiselEnum being used as mux select for a RISC-V core. While wrapping the object in a package is not required, it is highly recommended as it allows for the type to be used in multiple files more easily."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"// package CPUTypes {\nobject AluMux1Sel extends ChiselEnum {\n  val selectRS1, selectPC = Value\n}\n// We can see the mapping by printing each Value\nAluMux1Sel.all.foreach(println)\n// AluMux1Sel(0=selectRS1)\n// AluMux1Sel(1=selectPC)\n"})}),"\n",(0,l.jsx)(n.p,{children:"Here we see a mux using the AluMux1Sel to select between different inputs."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"import AluMux1Sel._\n\nclass AluMux1Bundle extends Bundle {\n  val aluMux1Sel = Input(AluMux1Sel())\n  val rs1Out     = Input(Bits(32.W))\n  val pcOut      = Input(Bits(32.W))\n  val aluMux1Out = Output(Bits(32.W))\n}\n\nclass AluMux1File extends Module {\n  val io = IO(new AluMux1Bundle)\n\n  // Default value for aluMux1Out\n  io.aluMux1Out := 0.U\n\n  switch (io.aluMux1Sel) {\n    is (selectRS1) {\n      io.aluMux1Out := io.rs1Out\n    }\n    is (selectPC) {\n      io.aluMux1Out := io.pcOut\n    }\n  }\n}\n"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule AluMux1File(\n  input         clock,\n                reset,\n                io_aluMux1Sel,\n  input  [31:0] io_rs1Out,\n                io_pcOut,\n  output [31:0] io_aluMux1Out\n);\n\n  assign io_aluMux1Out = io_aluMux1Sel ? io_pcOut : io_rs1Out;\nendmodule\n\n"})}),"\n",(0,l.jsxs)(n.p,{children:["ChiselEnum also allows for the user to directly set the Values by passing an ",(0,l.jsx)(n.code,{children:"UInt"})," to ",(0,l.jsx)(n.code,{children:"Value(...)"}),"\nas shown below. Note that the magnitude of each ",(0,l.jsx)(n.code,{children:"Value"})," must be strictly greater than the one before\nit."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:'object Opcode extends ChiselEnum {\n    val load  = Value(0x03.U) // i "load"  -> 000_0011\n    val imm   = Value(0x13.U) // i "imm"   -> 001_0011\n    val auipc = Value(0x17.U) // u "auipc" -> 001_0111\n    val store = Value(0x23.U) // s "store" -> 010_0011\n    val reg   = Value(0x33.U) // r "reg"   -> 011_0011\n    val lui   = Value(0x37.U) // u "lui"   -> 011_0111\n    val br    = Value(0x63.U) // b "br"    -> 110_0011\n    val jalr  = Value(0x67.U) // i "jalr"  -> 110_0111\n    val jal   = Value(0x6F.U) // j "jal"   -> 110_1111\n}\n'})}),"\n",(0,l.jsx)(n.p,{children:"The user can 'jump' to a value and continue incrementing by passing a start point then using a regular Value definition."}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"object BranchFunct3 extends ChiselEnum {\n    val beq, bne = Value\n    val blt = Value(4.U)\n    val bge, bltu, bgeu = Value\n}\n// We can see the mapping by printing each Value\nBranchFunct3.all.foreach(println)\n// BranchFunct3(0=beq)\n// BranchFunct3(1=bne)\n// BranchFunct3(4=blt)\n// BranchFunct3(5=bge)\n// BranchFunct3(6=bltu)\n// BranchFunct3(7=bgeu)\n"})}),"\n",(0,l.jsx)(n.h2,{id:"casting",children:"Casting"}),"\n",(0,l.jsxs)(n.p,{children:["You can cast an enum to a ",(0,l.jsx)(n.code,{children:"UInt"})," using ",(0,l.jsx)(n.code,{children:".asUInt"}),":"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class ToUInt extends RawModule {\n  val in = IO(Input(Opcode()))\n  val out = IO(Output(UInt(in.getWidth.W)))\n  out := in.asUInt\n}\n"})}),"\n",(0,l.jsxs)(n.p,{children:["You can cast from a ",(0,l.jsx)(n.code,{children:"UInt"})," to an enum by passing the ",(0,l.jsx)(n.code,{children:"UInt"})," to the apply method of the ",(0,l.jsx)(n.code,{children:"ChiselEnum"})," object:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class FromUInt extends Module {\n  val in = IO(Input(UInt(7.W)))\n  val out = IO(Output(Opcode()))\n  out := Opcode(in)\n}\n"})}),"\n",(0,l.jsxs)(n.p,{children:["However, if you cast from a ",(0,l.jsx)(n.code,{children:"UInt"})," to an Enum type when there are undefined states in the Enum values\nthat the ",(0,l.jsx)(n.code,{children:"UInt"})," could hit, you will see a warning like the following:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:"[warn] chisel-enum.md 133:16: [W001] Casting non-literal UInt to repl.MdocSession$MdocApp$Opcode. You can use repl.MdocSession$MdocApp$Opcode.safe to cast without this warning.\n[warn] There were 1 warning(s) during hardware elaboration.\n"})}),"\n",(0,l.jsx)(n.p,{children:"(Note that the name of the Enum is ugly as an artifact of our documentation generation flow, it will\nbe cleaner in normal use)."}),"\n",(0,l.jsxs)(n.p,{children:["You can avoid this warning by using the ",(0,l.jsx)(n.code,{children:".safe"})," factory method which returns the cast Enum in addition\nto a ",(0,l.jsx)(n.code,{children:"Bool"})," indicating if the Enum is in a valid state:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:'class SafeFromUInt extends Module {\n  val in = IO(Input(UInt(7.W)))\n  val out = IO(Output(Opcode()))\n  val (value, valid) = Opcode.safe(in)\n  assert(valid, "Enum state must be valid, got %d!", in)\n  out := value\n}\n'})}),"\n",(0,l.jsx)(n.p,{children:"Now there will be no warning:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{})}),"\n",(0,l.jsxs)(n.p,{children:["You can also suppress the warning by using ",(0,l.jsx)(n.code,{children:"suppressEnumCastWarning"}),". This is\nprimarily used for casting from [[UInt]] to a Bundle type that contains an\nEnum, where the [[UInt]] is known to be valid for the Bundle type."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class MyBundle extends Bundle {\n  val addr = UInt(8.W)\n  val op = Opcode()\n}\n\nclass SuppressedFromUInt extends Module {\n  val in = IO(Input(UInt(15.W)))\n  val out = IO(Output(new MyBundle()))\n  suppressEnumCastWarning {\n    out := in.asTypeOf(new MyBundle)\n  }\n}\n"})}),"\n",(0,l.jsx)(n.h2,{id:"testing",children:"Testing"}),"\n",(0,l.jsxs)(n.p,{children:["The ",(0,l.jsx)(n.em,{children:"Type"})," of the enums values is ",(0,l.jsx)(n.code,{children:"<ChiselEnum Object>.Type"})," which can be useful for passing the values\nas parameters to a function (or any other time a type annotation is needed).\nCalling ",(0,l.jsx)(n.code,{children:".litValue"})," on an enum value will return the integer value of that object as a\n",(0,l.jsx)(n.a,{href:"https://www.scala-lang.org/api/2.12.13/scala/math/BigInt.html",children:(0,l.jsx)(n.code,{children:"BigInt"})}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"def expectedSel(sel: AluMux1Sel.Type): Boolean = sel match {\n  case AluMux1Sel.selectRS1 => (sel.litValue == 0)\n  case AluMux1Sel.selectPC  => (sel.litValue == 1)\n  case _                    => false\n}\n"})}),"\n",(0,l.jsxs)(n.p,{children:["The enum value type also defines some convenience methods for working with ",(0,l.jsx)(n.code,{children:"ChiselEnum"})," values. For example, continuing with the RISC-V opcode\nexample, one could easily create hardware signal that is only asserted on LOAD/STORE operations (when the enum value is equal to ",(0,l.jsx)(n.code,{children:"Opcode.load"}),"\nor ",(0,l.jsx)(n.code,{children:"Opcode.store"}),") using the ",(0,l.jsx)(n.code,{children:".isOneOf"})," method:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"class LoadStoreExample extends Module {\n  val io = IO(new Bundle {\n    val opcode = Input(Opcode())\n    val load_or_store = Output(Bool())\n  })\n  io.load_or_store := io.opcode.isOneOf(Opcode.load, Opcode.store)\n}\n"})}),"\n",(0,l.jsxs)(n.p,{children:["Some additional useful methods defined on the ",(0,l.jsx)(n.code,{children:"ChiselEnum"})," object are:"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.code,{children:".all"}),": returns the enum values within the enumeration"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.code,{children:".getWidth"}),": returns the width of the hardware type"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"workarounds",children:"Workarounds"}),"\n",(0,l.jsxs)(n.p,{children:["As of Chisel v3.4.3 (1 July 2020), the width of the values is always inferred.\nTo work around this, you can add an extra ",(0,l.jsx)(n.code,{children:"Value"})," that forces the width that is desired.\nThis is shown in the example below, where we add a field ",(0,l.jsx)(n.code,{children:"ukn"})," to force the width to be 3 bits wide:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-scala",children:"object StoreFunct3 extends ChiselEnum {\n    val sb, sh, sw = Value\n    val ukn = Value(7.U)\n}\n// We can see the mapping by printing each Value\nStoreFunct3.all.foreach(println)\n// StoreFunct3(0=sb)\n// StoreFunct3(1=sh)\n// StoreFunct3(2=sw)\n// StoreFunct3(7=ukn)\n"})}),"\n",(0,l.jsxs)(n.p,{children:["Signed values are not supported so if you want the value signed, you must cast the UInt with ",(0,l.jsx)(n.code,{children:".asSInt"}),"."]}),"\n",(0,l.jsx)(n.h2,{id:"additional-resources",children:"Additional Resources"}),"\n",(0,l.jsxs)(n.p,{children:["The ChiselEnum type is much more powerful than stated above. It allows for Sequence, Vec, and Bundle assignments, as well as a ",(0,l.jsx)(n.code,{children:".next"})," operation to allow for stepping through sequential states and an ",(0,l.jsx)(n.code,{children:".isValid"})," for checking that a hardware value is a valid ",(0,l.jsx)(n.code,{children:"Value"}),". The source code for the ChiselEnum can be found ",(0,l.jsx)(n.a,{href:"https://github.com/chipsalliance/chisel3/blob/2a96767097264eade18ff26e1d8bce192383a190/core/src/main/scala/chisel3/StrongEnum.scala",children:"here"})," in the class ",(0,l.jsx)(n.code,{children:"EnumFactory"}),". Examples of the ChiselEnum operations can be found ",(0,l.jsx)(n.a,{href:"https://github.com/chipsalliance/chisel3/blob/dd6871b8b3f2619178c2a333d9d6083805d99e16/src/test/scala/chiselTests/StrongEnum.scala",children:"here"}),"."]})]})}function d(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(r,{...e})}):r(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>c});var l=s(6540);const a={},t=l.createContext(a);function i(e){const n=l.useContext(t);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),l.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d1e6e3d8.83eacef3.js b/assets/js/d1e6e3d8.83eacef3.js
deleted file mode 100644
index 473c235f05..0000000000
--- a/assets/js/d1e6e3d8.83eacef3.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[4863],{7396:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>d});var o=i(4848),a=i(8453);const t={layout:"docs",title:"Deep Dive into <> and := Connection Operators",section:"chisel3"},l="Deep Dive into Connection Operators",s={id:"explanations/connection-operators",title:"Deep Dive into <> and := Connection Operators",description:"Chisel contains two connection operators, := and `. This document provides a deeper explanation of the differences of the two and when to use one or the other. The differences are demonstrated with experiments using Scastie examples which use DecoupledIO`.",source:"@site/docs/explanations/connection-operators.md",sourceDirName:"explanations",slug:"/explanations/connection-operators",permalink:"/docs/explanations/connection-operators",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/connection-operators.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Deep Dive into <> and := Connection Operators",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Connectable Operators",permalink:"/docs/explanations/connectable"},next:{title:"Chisel Data Types",permalink:"/docs/explanations/data-types"}},c={},d=[{value:"Experiment Setup",id:"experiment-setup",level:3},{value:"Concept 1: <code>&lt;&gt;</code> is Commutative",id:"concept-1--is-commutative",level:2},{value:"Conclusion:",id:"conclusion",level:3},{value:"Concept 2: <code>:=</code> means assign ALL LHS signals from the RHS, regardless of the direction on the LHS.",id:"concept-2--means-assign-all-lhs-signals-from-the-rhs-regardless-of-the-direction-on-the-lhs",level:2},{value:"Conclusion:",id:"conclusion-1",level:3},{value:"Concept 3: Always Use <code>:=</code> to assign DontCare to Wires",id:"concept-3-always-use--to-assign-dontcare-to-wires",level:2},{value:"Conclusion:",id:"conclusion-2",level:3},{value:"Concept 4: You can use <code>&lt;&gt;</code> or <code>:=</code> to assign <code>DontCare</code> to directioned things (IOs)",id:"concept-4-you-can-use--or--to-assign-dontcare-to-directioned-things-ios",level:2},{value:"Conclusion:",id:"conclusion-3",level:3},{value:"Concept 5: <code>&lt;&gt;</code>  works between things with at least one known flow (An IO or child&#39;s IO).",id:"concept-5---works-between-things-with-at-least-one-known-flow-an-io-or-childs-io",level:2},{value:"Conclusion:",id:"conclusion-4",level:3},{value:"Concept 6: <code>&lt;&gt;</code> and <code>:=</code> connect signals by field name.",id:"concept-6--and--connect-signals-by-field-name",level:2},{value:"Conclusion:",id:"conclusion-5",level:3}];function r(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",img:"img",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"deep-dive-into-connection-operators",children:"Deep Dive into Connection Operators"})}),"\n",(0,o.jsxs)(n.p,{children:["Chisel contains two connection operators, ",(0,o.jsx)(n.code,{children:":="})," and ",(0,o.jsx)(n.code,{children:"<>"}),". This document provides a deeper explanation of the differences of the two and when to use one or the other. The differences are demonstrated with experiments using Scastie examples which use ",(0,o.jsx)(n.code,{children:"DecoupledIO"}),"."]}),"\n",(0,o.jsx)(n.h3,{id:"experiment-setup",children:"Experiment Setup"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"// Imports used by the following examples\nimport chisel3._\nimport chisel3.util.DecoupledIO\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The diagram for the experiment can be viewed ",(0,o.jsx)(n.a,{href:"https://docs.google.com/document/d/14C918Hdahk2xOGSJJBT-ZVqAx99_hg3JQIq-vaaifQU/edit?usp=sharing",children:"here"}),".\n",(0,o.jsx)(n.img,{src:"https://raw.githubusercontent.com/chipsalliance/chisel3/master/docs/src/images/connection-operators-experiment.svg?sanitize=true",alt:"Experiment Image"})]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect Producer to IO\n  p.io.a <> io.in\n  // connect producer to consumer\n  c.io.a <> p.io.b\n  // connect consumer to IO\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.b <> io.a\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n  output       io_in_ready,\n  input        io_in_valid,\n  input  [7:0] io_in_bits,\n  input        io_out_ready,\n  output       io_out_valid,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.h2,{id:"concept-1--is-commutative",children:["Concept 1: ",(0,o.jsx)(n.code,{children:"<>"})," is Commutative"]}),"\n",(0,o.jsxs)(n.p,{children:["This experiment is set up to test for the function of ",(0,o.jsx)(n.code,{children:"<>"})," using the experiment above."]}),"\n",(0,o.jsxs)(n.p,{children:["Achieving this involves flipping the RHS and LHS of the ",(0,o.jsx)(n.code,{children:"<>"})," operator and seeing how ",(0,o.jsx)(n.code,{children:"<>"}),"  will react.\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/LVhlbkFQQnq7X3trHfgZZQ",children:"https://scastie.scala-lang.org/Shorla/LVhlbkFQQnq7X3trHfgZZQ"})," )"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect producer to I/O\n  io.in <> p.io.a\n  // connect producer  to consumer\n  p.io.b <> c.io.a\n  // connect consumer to I/O\n  c.io.b <> io.out\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.a <> io.b\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n  output       io_in_ready,\n  input        io_in_valid,\n  input  [7:0] io_in_bits,\n  input        io_out_ready,\n  output       io_out_valid,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["The Verilog remained the same without incurring errors, showing that the ",(0,o.jsx)(n.code,{children:"<>"})," operator is commutative."]}),"\n",(0,o.jsxs)(n.h2,{id:"concept-2--means-assign-all-lhs-signals-from-the-rhs-regardless-of-the-direction-on-the-lhs",children:["Concept 2: ",(0,o.jsx)(n.code,{children:":="})," means assign ALL LHS signals from the RHS, regardless of the direction on the LHS."]}),"\n",(0,o.jsxs)(n.p,{children:["Using the same experiment code as above, we set to test for the function of ",(0,o.jsx)(n.code,{children:":="}),"\nWe replace all instances of ",(0,o.jsx)(n.code,{children:"<>"})," with ",(0,o.jsx)(n.code,{children:":="})," in the sample code above.\n(Scastie link to the experiment: ",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/o1ShdaY3RWKf0IIFwwQ1UQ/1",children:"https://scastie.scala-lang.org/Shorla/o1ShdaY3RWKf0IIFwwQ1UQ/1"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect producer to I/O\n  p.io.a := io.in\n  // connect producer  to consumer\n  c.io.a := p.io.b\n  // connect consumer to I/O\n  io.out := c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.a := io.b\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting error message for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"circt.stage.ChiselStage.emitSystemVerilog(new Wrapper)\n// chisel3.package$ChiselException: Connection between sink (PipelineStage.io.a: IO[DecoupledIO]) and source (PipelineStage.io.b: IO[DecoupledIO]) failed @: .bitsio.a.bits in PipelineStage cannot be written from module PipelineStage.\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp3$PipelineStage.<init>(connection-operators.md:124)\n// \tat repl.MdocSession$MdocApp3$Wrapper$$anonfun$30$$anonfun$apply$20.apply(connection-operators.md:108)\n// \tat repl.MdocSession$MdocApp3$Wrapper$$anonfun$30$$anonfun$apply$20.apply(connection-operators.md:108)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat repl.MdocSession$MdocApp3$Wrapper$$anonfun$30.apply(connection-operators.md:108)\n// \tat repl.MdocSession$MdocApp3$Wrapper$$anonfun$30.apply(connection-operators.md:108)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp3$Wrapper.<init>(connection-operators.md:108)\n// \tat repl.MdocSession$MdocApp3$$anonfun$39$$anonfun$apply$25.apply(connection-operators.md:132)\n// \tat repl.MdocSession$MdocApp3$$anonfun$39$$anonfun$apply$25.apply(connection-operators.md:132)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-1",children:"Conclusion:"}),"\n",(0,o.jsx)(n.p,{children:"The := operator goes field-by-field on the LHS and attempts to connect it to the same-named signal from the RHS. If something on the LHS is actually an Input, or the corresponding signal on the RHS is an Output, you will get an error as shown above."}),"\n",(0,o.jsxs)(n.h2,{id:"concept-3-always-use--to-assign-dontcare-to-wires",children:["Concept 3: Always Use ",(0,o.jsx)(n.code,{children:":="})," to assign DontCare to Wires"]}),"\n",(0,o.jsxs)(n.p,{children:["When assigning ",(0,o.jsx)(n.code,{children:"DontCare"})," to something that is not directioned, should you use ",(0,o.jsx)(n.code,{children:":="})," or ",(0,o.jsx)(n.code,{children:"<>"}),"?\nWe will find out using the sample codes below:\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1",children:"https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  //connect Producer to IO\n  io.in := DontCare\n  p.io.a <> DontCare\n  val tmp = Wire(Flipped(DecoupledIO(UInt(8.W))))\n  tmp := DontCare\n  p.io.a <> io.in\n  // connect producer to consumer\n  c.io.a <> p.io.b\n  //connect consumer to IO\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.b <> io.a\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n  output       io_in_ready,\n  input        io_in_valid,\n  input  [7:0] io_in_bits,\n  input        io_out_ready,\n  output       io_out_valid,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-2",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["If ",(0,o.jsx)(n.code,{children:"<>"})," were used to assign the unidrectioned wire ",(0,o.jsx)(n.code,{children:"tmp"})," to DontCare, we would get an error. But in the example above, we used ",(0,o.jsx)(n.code,{children:":="})," and no errors occurred.\nBut when ",(0,o.jsx)(n.code,{children:":="})," was used to assign the wire to DontCare, no errors will occur."]}),"\n",(0,o.jsxs)(n.p,{children:["Thus, when assigning ",(0,o.jsx)(n.code,{children:"DontCare"})," to a ",(0,o.jsx)(n.code,{children:"Wire"}),", always use ",(0,o.jsx)(n.code,{children:":="}),"."]}),"\n",(0,o.jsxs)(n.h2,{id:"concept-4-you-can-use--or--to-assign-dontcare-to-directioned-things-ios",children:["Concept 4: You can use ",(0,o.jsx)(n.code,{children:"<>"})," or ",(0,o.jsx)(n.code,{children:":="})," to assign ",(0,o.jsx)(n.code,{children:"DontCare"})," to directioned things (IOs)"]}),"\n",(0,o.jsxs)(n.p,{children:["When assigning ",(0,o.jsx)(n.code,{children:"DontCare"})," to something that is directioned, should you use ",(0,o.jsx)(n.code,{children:":="})," or ",(0,o.jsx)(n.code,{children:"<>"}),"?\nWe will find out using the sample codes below:\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1",children:"https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  //connect Producer to IO\n  io.in := DontCare\n  p.io.a <> DontCare\n  val tmp = Wire(Flipped(DecoupledIO(UInt(8.W))))\n  tmp := DontCare\n  p.io.a <> io.in\n  // connect producer to consumer\n  c.io.a <> p.io.b\n  //connect consumer to IO\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.b <> io.a\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n  output       io_in_ready,\n  input        io_in_valid,\n  input  [7:0] io_in_bits,\n  input        io_out_ready,\n  output       io_out_valid,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-3",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["Both ",(0,o.jsx)(n.code,{children:"<>"})," and ",(0,o.jsx)(n.code,{children:":="})," can be used to assign directioned things (IOs) to DontCare as shown in ",(0,o.jsx)(n.code,{children:"io.in"})," and ",(0,o.jsx)(n.code,{children:"p.io.a"})," respectively. This is basically equivalent because in this case both ",(0,o.jsx)(n.code,{children:"<>"})," and ",(0,o.jsx)(n.code,{children:":="})," will determine the direction from the LHS."]}),"\n",(0,o.jsxs)(n.h2,{id:"concept-5---works-between-things-with-at-least-one-known-flow-an-io-or-childs-io",children:["Concept 5: ",(0,o.jsx)(n.code,{children:"<>"}),"  works between things with at least one known flow (An IO or child's IO)."]}),"\n",(0,o.jsxs)(n.p,{children:["If there is at least one known flow what will ",(0,o.jsx)(n.code,{children:"<>"})," do? This will be shown using the experiment code below:\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/gKx9ReLVTTqDTk9vmw5ozg",children:"https://scastie.scala-lang.org/Shorla/gKx9ReLVTTqDTk9vmw5ozg"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  //connect Producer to IO\n    // For this experiment, we add a temporary wire and see if it works...\n  //p.io.a <> io.in\n  val tmp = Wire(DecoupledIO(UInt(8.W)))\n  // connect intermediate wire\n  tmp <> io.in\n  p.io.a <> tmp\n  // connect producer to consumer\n  c.io.a <> p.io.b\n  //connect consumer to IO\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.b <> io.a\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'chisel3.docs.emitSystemVerilog(new Wrapper)\n// res9: String = """// Generated by CIRCT firtool-1.99.2\n// module PipelineStage(\n//   output       io_a_ready,\n//   input        io_a_valid,\n//   input  [7:0] io_a_bits,\n//   input        io_b_ready,\n//   output       io_b_valid,\n//   output [7:0] io_b_bits\n// );\n// \n//   assign io_a_ready = io_b_ready;\n//   assign io_b_valid = io_a_valid;\n//   assign io_b_bits = io_a_bits;\n// endmodule\n// \n// module Wrapper(\n//   input        clock,\n//                reset,\n//   output       io_in_ready,\n//   input        io_in_valid,\n//   input  [7:0] io_in_bits,\n//   input        io_out_ready,\n//   output       io_out_valid,\n//   output [7:0] io_out_bits\n// );\n// \n//   wire       _c_io_a_ready;\n//   wire       _p_io_b_valid;\n//   wire [7:0] _p_io_b_bits;\n//   PipelineStage p (\n//     .io_a_ready (io_in_ready),\n//     .io_a_valid (io_in_valid),\n//     .io_a_bits  (io_in_bits),\n//     .io_b_ready (_c_io_a_ready),\n//     .io_b_valid (_p_io_b_valid),\n//     .io_b_bits  (_p_io_b_bits)\n//   );\n//   PipelineStage c (\n//     .io_a_ready (_c_io_a_ready),\n//     .io_a_valid (_p_io_b_valid),\n//     .io_a_bits  (_p_io_b_bits),\n//     .io_b_ready (io_out_ready),\n//     .io_b_valid (io_out_valid),\n//     .io_b_bits  (io_out_bits)\n//   );\n// endmodule\n// \n// """\n'})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-4",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["The connection above went smoothly with no errors, this goes to show ",(0,o.jsx)(n.code,{children:"<>"}),' will work as long as there is at least one directioned thing (IO or submodule\'s IO) to "fix" the direction.']}),"\n",(0,o.jsxs)(n.h2,{id:"concept-6--and--connect-signals-by-field-name",children:["Concept 6: ",(0,o.jsx)(n.code,{children:"<>"})," and ",(0,o.jsx)(n.code,{children:":="})," connect signals by field name."]}),"\n",(0,o.jsxs)(n.p,{children:["This experiment creates a MockDecoupledIO which has the same fields by name as a DecoupledIO. Chisel lets us connect it and produces the same verilog, even though MockDecoupledIO and DecoupledIO are different types.\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Uf4tQquvQYigZAW705NFIQ",children:"https://scastie.scala-lang.org/Uf4tQquvQYigZAW705NFIQ"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass MockDecoupledIO extends Bundle {\n  val valid = Output(Bool())\n  val ready = Input(Bool())\n  val bits = Output(UInt(8.W))\n}\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(new MockDecoupledIO())\n  val out = new MockDecoupledIO()\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect producer to I/O\n  p.io.a <> io.in\n  // connect producer  to consumer\n  c.io.a <> p.io.b\n  // connect consumer to I/O\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.a <> io.b\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n               io_in_valid,\n  output       io_in_ready,\n  input  [7:0] io_in_bits,\n  output       io_out_valid,\n  input        io_out_ready,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.p,{children:["And here is another experiment, where we remove one of the fields of MockDecoupledIO:\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/ChtkhKCpS9CvJkjjqpdeIA",children:"https://scastie.scala-lang.org/ChtkhKCpS9CvJkjjqpdeIA"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass MockDecoupledIO extends Bundle {\n  val valid = Output(Bool())\n  val ready = Input(Bool())\n  //val bits = Output(UInt(8.W))\n}\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(new MockDecoupledIO())\n  val out = new MockDecoupledIO()\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect producer to I/O\n  p.io.a <> io.in\n  // connect producer  to consumer\n  c.io.a <> p.io.b\n  // connect consumer to I/O\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.a <> io.b\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting error for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"circt.stage.ChiselStage.emitSystemVerilog(new Wrapper)\n// chisel3.package$ChiselException: Connection between left (PipelineStage.io.a: IO[DecoupledIO]) and source (Wrapper.io.in: IO[MockDecoupledIO]) failed @.bits: Right Record missing field (bits).\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp12$Wrapper.<init>(connection-operators.md:357)\n// \tat repl.MdocSession$MdocApp12$$anonfun$119$$anonfun$apply$79.apply(connection-operators.md:378)\n// \tat repl.MdocSession$MdocApp12$$anonfun$119$$anonfun$apply$79.apply(connection-operators.md:378)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This one fails because there is a field ",(0,o.jsx)(n.code,{children:"bits"})," missing."]}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-5",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["For ",(0,o.jsx)(n.code,{children:":="}),", the Scala types do not need to match but all the signals on the LHS must be provided by the RHS or you will get a Chisel elaboration error. There may be additional signals on the RHS, these will be ignored. For ",(0,o.jsx)(n.code,{children:"<>"}),", the Scala types do not need to match, but all signals must match exactly between LHS and RHS. In both cases, the order of the fields does not matter."]})]})}function p(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(r,{...e})}):r(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>s});var o=i(6540);const a={},t=o.createContext(a);function l(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d1e6e3d8.b6d39183.js b/assets/js/d1e6e3d8.b6d39183.js
new file mode 100644
index 0000000000..47307434ee
--- /dev/null
+++ b/assets/js/d1e6e3d8.b6d39183.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[4863],{7396:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>d});var o=i(4848),a=i(8453);const t={layout:"docs",title:"Deep Dive into <> and := Connection Operators",section:"chisel3"},l="Deep Dive into Connection Operators",s={id:"explanations/connection-operators",title:"Deep Dive into <> and := Connection Operators",description:"Chisel contains two connection operators, := and `. This document provides a deeper explanation of the differences of the two and when to use one or the other. The differences are demonstrated with experiments using Scastie examples which use DecoupledIO`.",source:"@site/docs/explanations/connection-operators.md",sourceDirName:"explanations",slug:"/explanations/connection-operators",permalink:"/docs/explanations/connection-operators",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/connection-operators.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Deep Dive into <> and := Connection Operators",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Connectable Operators",permalink:"/docs/explanations/connectable"},next:{title:"Chisel Data Types",permalink:"/docs/explanations/data-types"}},c={},d=[{value:"Experiment Setup",id:"experiment-setup",level:3},{value:"Concept 1: <code>&lt;&gt;</code> is Commutative",id:"concept-1--is-commutative",level:2},{value:"Conclusion:",id:"conclusion",level:3},{value:"Concept 2: <code>:=</code> means assign ALL LHS signals from the RHS, regardless of the direction on the LHS.",id:"concept-2--means-assign-all-lhs-signals-from-the-rhs-regardless-of-the-direction-on-the-lhs",level:2},{value:"Conclusion:",id:"conclusion-1",level:3},{value:"Concept 3: Always Use <code>:=</code> to assign DontCare to Wires",id:"concept-3-always-use--to-assign-dontcare-to-wires",level:2},{value:"Conclusion:",id:"conclusion-2",level:3},{value:"Concept 4: You can use <code>&lt;&gt;</code> or <code>:=</code> to assign <code>DontCare</code> to directioned things (IOs)",id:"concept-4-you-can-use--or--to-assign-dontcare-to-directioned-things-ios",level:2},{value:"Conclusion:",id:"conclusion-3",level:3},{value:"Concept 5: <code>&lt;&gt;</code>  works between things with at least one known flow (An IO or child&#39;s IO).",id:"concept-5---works-between-things-with-at-least-one-known-flow-an-io-or-childs-io",level:2},{value:"Conclusion:",id:"conclusion-4",level:3},{value:"Concept 6: <code>&lt;&gt;</code> and <code>:=</code> connect signals by field name.",id:"concept-6--and--connect-signals-by-field-name",level:2},{value:"Conclusion:",id:"conclusion-5",level:3}];function r(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",img:"img",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"deep-dive-into-connection-operators",children:"Deep Dive into Connection Operators"})}),"\n",(0,o.jsxs)(n.p,{children:["Chisel contains two connection operators, ",(0,o.jsx)(n.code,{children:":="})," and ",(0,o.jsx)(n.code,{children:"<>"}),". This document provides a deeper explanation of the differences of the two and when to use one or the other. The differences are demonstrated with experiments using Scastie examples which use ",(0,o.jsx)(n.code,{children:"DecoupledIO"}),"."]}),"\n",(0,o.jsx)(n.h3,{id:"experiment-setup",children:"Experiment Setup"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"// Imports used by the following examples\nimport chisel3._\nimport chisel3.util.DecoupledIO\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The diagram for the experiment can be viewed ",(0,o.jsx)(n.a,{href:"https://docs.google.com/document/d/14C918Hdahk2xOGSJJBT-ZVqAx99_hg3JQIq-vaaifQU/edit?usp=sharing",children:"here"}),".\n",(0,o.jsx)(n.img,{src:"https://raw.githubusercontent.com/chipsalliance/chisel3/master/docs/src/images/connection-operators-experiment.svg?sanitize=true",alt:"Experiment Image"})]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect Producer to IO\n  p.io.a <> io.in\n  // connect producer to consumer\n  c.io.a <> p.io.b\n  // connect consumer to IO\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.b <> io.a\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n  output       io_in_ready,\n  input        io_in_valid,\n  input  [7:0] io_in_bits,\n  input        io_out_ready,\n  output       io_out_valid,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.h2,{id:"concept-1--is-commutative",children:["Concept 1: ",(0,o.jsx)(n.code,{children:"<>"})," is Commutative"]}),"\n",(0,o.jsxs)(n.p,{children:["This experiment is set up to test for the function of ",(0,o.jsx)(n.code,{children:"<>"})," using the experiment above."]}),"\n",(0,o.jsxs)(n.p,{children:["Achieving this involves flipping the RHS and LHS of the ",(0,o.jsx)(n.code,{children:"<>"})," operator and seeing how ",(0,o.jsx)(n.code,{children:"<>"}),"  will react.\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/LVhlbkFQQnq7X3trHfgZZQ",children:"https://scastie.scala-lang.org/Shorla/LVhlbkFQQnq7X3trHfgZZQ"})," )"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect producer to I/O\n  io.in <> p.io.a\n  // connect producer  to consumer\n  p.io.b <> c.io.a\n  // connect consumer to I/O\n  c.io.b <> io.out\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.a <> io.b\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n  output       io_in_ready,\n  input        io_in_valid,\n  input  [7:0] io_in_bits,\n  input        io_out_ready,\n  output       io_out_valid,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["The Verilog remained the same without incurring errors, showing that the ",(0,o.jsx)(n.code,{children:"<>"})," operator is commutative."]}),"\n",(0,o.jsxs)(n.h2,{id:"concept-2--means-assign-all-lhs-signals-from-the-rhs-regardless-of-the-direction-on-the-lhs",children:["Concept 2: ",(0,o.jsx)(n.code,{children:":="})," means assign ALL LHS signals from the RHS, regardless of the direction on the LHS."]}),"\n",(0,o.jsxs)(n.p,{children:["Using the same experiment code as above, we set to test for the function of ",(0,o.jsx)(n.code,{children:":="}),"\nWe replace all instances of ",(0,o.jsx)(n.code,{children:"<>"})," with ",(0,o.jsx)(n.code,{children:":="})," in the sample code above.\n(Scastie link to the experiment: ",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/o1ShdaY3RWKf0IIFwwQ1UQ/1",children:"https://scastie.scala-lang.org/Shorla/o1ShdaY3RWKf0IIFwwQ1UQ/1"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect producer to I/O\n  p.io.a := io.in\n  // connect producer  to consumer\n  c.io.a := p.io.b\n  // connect consumer to I/O\n  io.out := c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.a := io.b\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting error message for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"circt.stage.ChiselStage.emitSystemVerilog(new Wrapper)\n// chisel3.package$ChiselException: Connection between sink (PipelineStage.io.a: IO[DecoupledIO]) and source (PipelineStage.io.b: IO[DecoupledIO]) failed @: .bitsio.a.bits in PipelineStage cannot be written from module PipelineStage.\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp3$PipelineStage.<init>(connection-operators.md:124)\n// \tat repl.MdocSession$MdocApp3$Wrapper$$anonfun$30$$anonfun$apply$20.apply(connection-operators.md:108)\n// \tat repl.MdocSession$MdocApp3$Wrapper$$anonfun$30$$anonfun$apply$20.apply(connection-operators.md:108)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat repl.MdocSession$MdocApp3$Wrapper$$anonfun$30.apply(connection-operators.md:108)\n// \tat repl.MdocSession$MdocApp3$Wrapper$$anonfun$30.apply(connection-operators.md:108)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp3$Wrapper.<init>(connection-operators.md:108)\n// \tat repl.MdocSession$MdocApp3$$anonfun$39$$anonfun$apply$25.apply(connection-operators.md:132)\n// \tat repl.MdocSession$MdocApp3$$anonfun$39$$anonfun$apply$25.apply(connection-operators.md:132)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-1",children:"Conclusion:"}),"\n",(0,o.jsx)(n.p,{children:"The := operator goes field-by-field on the LHS and attempts to connect it to the same-named signal from the RHS. If something on the LHS is actually an Input, or the corresponding signal on the RHS is an Output, you will get an error as shown above."}),"\n",(0,o.jsxs)(n.h2,{id:"concept-3-always-use--to-assign-dontcare-to-wires",children:["Concept 3: Always Use ",(0,o.jsx)(n.code,{children:":="})," to assign DontCare to Wires"]}),"\n",(0,o.jsxs)(n.p,{children:["When assigning ",(0,o.jsx)(n.code,{children:"DontCare"})," to something that is not directioned, should you use ",(0,o.jsx)(n.code,{children:":="})," or ",(0,o.jsx)(n.code,{children:"<>"}),"?\nWe will find out using the sample codes below:\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1",children:"https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  //connect Producer to IO\n  io.in := DontCare\n  p.io.a <> DontCare\n  val tmp = Wire(Flipped(DecoupledIO(UInt(8.W))))\n  tmp := DontCare\n  p.io.a <> io.in\n  // connect producer to consumer\n  c.io.a <> p.io.b\n  //connect consumer to IO\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.b <> io.a\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n  output       io_in_ready,\n  input        io_in_valid,\n  input  [7:0] io_in_bits,\n  input        io_out_ready,\n  output       io_out_valid,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-2",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["If ",(0,o.jsx)(n.code,{children:"<>"})," were used to assign the unidrectioned wire ",(0,o.jsx)(n.code,{children:"tmp"})," to DontCare, we would get an error. But in the example above, we used ",(0,o.jsx)(n.code,{children:":="})," and no errors occurred.\nBut when ",(0,o.jsx)(n.code,{children:":="})," was used to assign the wire to DontCare, no errors will occur."]}),"\n",(0,o.jsxs)(n.p,{children:["Thus, when assigning ",(0,o.jsx)(n.code,{children:"DontCare"})," to a ",(0,o.jsx)(n.code,{children:"Wire"}),", always use ",(0,o.jsx)(n.code,{children:":="}),"."]}),"\n",(0,o.jsxs)(n.h2,{id:"concept-4-you-can-use--or--to-assign-dontcare-to-directioned-things-ios",children:["Concept 4: You can use ",(0,o.jsx)(n.code,{children:"<>"})," or ",(0,o.jsx)(n.code,{children:":="})," to assign ",(0,o.jsx)(n.code,{children:"DontCare"})," to directioned things (IOs)"]}),"\n",(0,o.jsxs)(n.p,{children:["When assigning ",(0,o.jsx)(n.code,{children:"DontCare"})," to something that is directioned, should you use ",(0,o.jsx)(n.code,{children:":="})," or ",(0,o.jsx)(n.code,{children:"<>"}),"?\nWe will find out using the sample codes below:\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1",children:"https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  //connect Producer to IO\n  io.in := DontCare\n  p.io.a <> DontCare\n  val tmp = Wire(Flipped(DecoupledIO(UInt(8.W))))\n  tmp := DontCare\n  p.io.a <> io.in\n  // connect producer to consumer\n  c.io.a <> p.io.b\n  //connect consumer to IO\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.b <> io.a\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n  output       io_in_ready,\n  input        io_in_valid,\n  input  [7:0] io_in_bits,\n  input        io_out_ready,\n  output       io_out_valid,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-3",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["Both ",(0,o.jsx)(n.code,{children:"<>"})," and ",(0,o.jsx)(n.code,{children:":="})," can be used to assign directioned things (IOs) to DontCare as shown in ",(0,o.jsx)(n.code,{children:"io.in"})," and ",(0,o.jsx)(n.code,{children:"p.io.a"})," respectively. This is basically equivalent because in this case both ",(0,o.jsx)(n.code,{children:"<>"})," and ",(0,o.jsx)(n.code,{children:":="})," will determine the direction from the LHS."]}),"\n",(0,o.jsxs)(n.h2,{id:"concept-5---works-between-things-with-at-least-one-known-flow-an-io-or-childs-io",children:["Concept 5: ",(0,o.jsx)(n.code,{children:"<>"}),"  works between things with at least one known flow (An IO or child's IO)."]}),"\n",(0,o.jsxs)(n.p,{children:["If there is at least one known flow what will ",(0,o.jsx)(n.code,{children:"<>"})," do? This will be shown using the experiment code below:\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Shorla/gKx9ReLVTTqDTk9vmw5ozg",children:"https://scastie.scala-lang.org/Shorla/gKx9ReLVTTqDTk9vmw5ozg"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(DecoupledIO(UInt(8.W)))\n  val out = DecoupledIO(UInt(8.W))\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  //connect Producer to IO\n    // For this experiment, we add a temporary wire and see if it works...\n  //p.io.a <> io.in\n  val tmp = Wire(DecoupledIO(UInt(8.W)))\n  // connect intermediate wire\n  tmp <> io.in\n  p.io.a <> tmp\n  // connect producer to consumer\n  c.io.a <> p.io.b\n  //connect consumer to IO\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.b <> io.a\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'chisel3.docs.emitSystemVerilog(new Wrapper)\n// res9: String = """// Generated by CIRCT firtool-1.100.0\n// module PipelineStage(\n//   output       io_a_ready,\n//   input        io_a_valid,\n//   input  [7:0] io_a_bits,\n//   input        io_b_ready,\n//   output       io_b_valid,\n//   output [7:0] io_b_bits\n// );\n// \n//   assign io_a_ready = io_b_ready;\n//   assign io_b_valid = io_a_valid;\n//   assign io_b_bits = io_a_bits;\n// endmodule\n// \n// module Wrapper(\n//   input        clock,\n//                reset,\n//   output       io_in_ready,\n//   input        io_in_valid,\n//   input  [7:0] io_in_bits,\n//   input        io_out_ready,\n//   output       io_out_valid,\n//   output [7:0] io_out_bits\n// );\n// \n//   wire       _c_io_a_ready;\n//   wire       _p_io_b_valid;\n//   wire [7:0] _p_io_b_bits;\n//   PipelineStage p (\n//     .io_a_ready (io_in_ready),\n//     .io_a_valid (io_in_valid),\n//     .io_a_bits  (io_in_bits),\n//     .io_b_ready (_c_io_a_ready),\n//     .io_b_valid (_p_io_b_valid),\n//     .io_b_bits  (_p_io_b_bits)\n//   );\n//   PipelineStage c (\n//     .io_a_ready (_c_io_a_ready),\n//     .io_a_valid (_p_io_b_valid),\n//     .io_a_bits  (_p_io_b_bits),\n//     .io_b_ready (io_out_ready),\n//     .io_b_valid (io_out_valid),\n//     .io_b_bits  (io_out_bits)\n//   );\n// endmodule\n// \n// """\n'})}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-4",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["The connection above went smoothly with no errors, this goes to show ",(0,o.jsx)(n.code,{children:"<>"}),' will work as long as there is at least one directioned thing (IO or submodule\'s IO) to "fix" the direction.']}),"\n",(0,o.jsxs)(n.h2,{id:"concept-6--and--connect-signals-by-field-name",children:["Concept 6: ",(0,o.jsx)(n.code,{children:"<>"})," and ",(0,o.jsx)(n.code,{children:":="})," connect signals by field name."]}),"\n",(0,o.jsxs)(n.p,{children:["This experiment creates a MockDecoupledIO which has the same fields by name as a DecoupledIO. Chisel lets us connect it and produces the same verilog, even though MockDecoupledIO and DecoupledIO are different types.\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/Uf4tQquvQYigZAW705NFIQ",children:"https://scastie.scala-lang.org/Uf4tQquvQYigZAW705NFIQ"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass MockDecoupledIO extends Bundle {\n  val valid = Output(Bool())\n  val ready = Input(Bool())\n  val bits = Output(UInt(8.W))\n}\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(new MockDecoupledIO())\n  val out = new MockDecoupledIO()\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect producer to I/O\n  p.io.a <> io.in\n  // connect producer  to consumer\n  c.io.a <> p.io.b\n  // connect consumer to I/O\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.a <> io.b\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting Verilog for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule PipelineStage(\n  output       io_a_ready,\n  input        io_a_valid,\n  input  [7:0] io_a_bits,\n  input        io_b_ready,\n  output       io_b_valid,\n  output [7:0] io_b_bits\n);\n\n  assign io_a_ready = io_b_ready;\n  assign io_b_valid = io_a_valid;\n  assign io_b_bits = io_a_bits;\nendmodule\n\nmodule Wrapper(\n  input        clock,\n               reset,\n               io_in_valid,\n  output       io_in_ready,\n  input  [7:0] io_in_bits,\n  output       io_out_valid,\n  input        io_out_ready,\n  output [7:0] io_out_bits\n);\n\n  wire       _c_io_a_ready;\n  wire       _p_io_b_valid;\n  wire [7:0] _p_io_b_bits;\n  PipelineStage p (\n    .io_a_ready (io_in_ready),\n    .io_a_valid (io_in_valid),\n    .io_a_bits  (io_in_bits),\n    .io_b_ready (_c_io_a_ready),\n    .io_b_valid (_p_io_b_valid),\n    .io_b_bits  (_p_io_b_bits)\n  );\n  PipelineStage c (\n    .io_a_ready (_c_io_a_ready),\n    .io_a_valid (_p_io_b_valid),\n    .io_a_bits  (_p_io_b_bits),\n    .io_b_ready (io_out_ready),\n    .io_b_valid (io_out_valid),\n    .io_b_bits  (io_out_bits)\n  );\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.p,{children:["And here is another experiment, where we remove one of the fields of MockDecoupledIO:\n( Scastie link for the experiment:",(0,o.jsx)(n.a,{href:"https://scastie.scala-lang.org/ChtkhKCpS9CvJkjjqpdeIA",children:"https://scastie.scala-lang.org/ChtkhKCpS9CvJkjjqpdeIA"}),")"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.util.DecoupledIO\n\nclass MockDecoupledIO extends Bundle {\n  val valid = Output(Bool())\n  val ready = Input(Bool())\n  //val bits = Output(UInt(8.W))\n}\nclass Wrapper extends Module{\n  val io = IO(new Bundle {\n  val in = Flipped(new MockDecoupledIO())\n  val out = new MockDecoupledIO()\n  })\n  val p = Module(new PipelineStage)\n  val c = Module(new PipelineStage)\n  // connect producer to I/O\n  p.io.a <> io.in\n  // connect producer  to consumer\n  c.io.a <> p.io.b\n  // connect consumer to I/O\n  io.out <> c.io.b\n}\nclass PipelineStage extends Module{\n  val io = IO(new Bundle{\n    val a = Flipped(DecoupledIO(UInt(8.W)))\n    val b = DecoupledIO(UInt(8.W))\n  })\n  io.a <> io.b\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Below we can see the resulting error for this example:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"circt.stage.ChiselStage.emitSystemVerilog(new Wrapper)\n// chisel3.package$ChiselException: Connection between left (PipelineStage.io.a: IO[DecoupledIO]) and source (Wrapper.io.in: IO[MockDecoupledIO]) failed @.bits: Right Record missing field (bits).\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp12$Wrapper.<init>(connection-operators.md:357)\n// \tat repl.MdocSession$MdocApp12$$anonfun$119$$anonfun$apply$79.apply(connection-operators.md:378)\n// \tat repl.MdocSession$MdocApp12$$anonfun$119$$anonfun$apply$79.apply(connection-operators.md:378)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)\n// \tat chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)\n// \tat chisel3.Module$.evaluate(Module.scala:10)\n// \tat chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)\n// \tat chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)\n// \tat chisel3.Module$._applyImpl(Module.scala:10)\n// \tat chisel3.Module$.do_apply(Module.scala:22)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1080)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This one fails because there is a field ",(0,o.jsx)(n.code,{children:"bits"})," missing."]}),"\n",(0,o.jsx)(n.h3,{id:"conclusion-5",children:"Conclusion:"}),"\n",(0,o.jsxs)(n.p,{children:["For ",(0,o.jsx)(n.code,{children:":="}),", the Scala types do not need to match but all the signals on the LHS must be provided by the RHS or you will get a Chisel elaboration error. There may be additional signals on the RHS, these will be ignored. For ",(0,o.jsx)(n.code,{children:"<>"}),", the Scala types do not need to match, but all signals must match exactly between LHS and RHS. In both cases, the order of the fields does not matter."]})]})}function p(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(r,{...e})}):r(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>s});var o=i(6540);const a={},t=o.createContext(a);function l(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d4b6d0e6.de292a95.js b/assets/js/d4b6d0e6.de292a95.js
new file mode 100644
index 0000000000..2310a3ef8e
--- /dev/null
+++ b/assets/js/d4b6d0e6.de292a95.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[4166],{7240:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>s,toc:()=>r});var o=i(4848),l=i(8453);const t={layout:"docs",title:"Connectable Operators",section:"chisel3"},c=void 0,s={id:"explanations/connectable",title:"Connectable Operators",description:"Table of Contents",source:"@site/docs/explanations/connectable.md",sourceDirName:"explanations",slug:"/explanations/connectable",permalink:"/docs/explanations/connectable",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/connectable.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Connectable Operators",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Combinational Circuits",permalink:"/docs/explanations/combinational-circuits"},next:{title:"Deep Dive into <> and := Connection Operators",permalink:"/docs/explanations/connection-operators"}},d={},r=[{value:"Table of Contents",id:"table-of-contents",level:2},{value:"Terminology",id:"terminology",level:2},{value:"Overview",id:"overview",level:2},{value:"Alignment: Flipped vs Aligned",id:"alignment-flipped-vs-aligned",level:2},{value:"Input/Output",id:"inputoutput",level:2},{value:"Connecting components with fully aligned members",id:"connecting-components-with-fully-aligned-members",level:2},{value:"Mono-direction connection operator (:=)",id:"mono-direction-connection-operator-",level:3},{value:"Connecting components with mixed alignment members",id:"connecting-components-with-mixed-alignment-members",level:2},{value:"Bi-direction connection operator (<code>:&lt;&gt;=</code>)",id:"bi-direction-connection-operator-",level:3},{value:"Port-Direction Computation versus Connection-Direction Computation",id:"port-direction-computation-versus-connection-direction-computation",level:3},{value:"Aligned connection operator (<code>:&lt;=</code>)",id:"aligned-connection-operator-",level:3},{value:"Flipped connection operator (<code>:&gt;=</code>)",id:"flipped-connection-operator-",level:3},{value:"Coercing mono-direction connection operator (<code>:#=</code>)",id:"coercing-mono-direction-connection-operator-",level:3},{value:"Connectable",id:"connectable",level:2},{value:"Connecting Records",id:"connecting-records",level:3},{value:"Defaults with waived connections",id:"defaults-with-waived-connections",level:3},{value:"Connecting types with optional members",id:"connecting-types-with-optional-members",level:3},{value:"Always ignore errors caused by extra members (partial connection operator)",id:"always-ignore-errors-caused-by-extra-members-partial-connection-operator",level:3},{value:"Connecting components with different widths",id:"connecting-components-with-different-widths",level:3},{value:"Excluding members from any operator on a Connectable",id:"excluding-members-from-any-operator-on-a-connectable",level:3},{value:"Techniques for connecting structurally inequivalent Chisel types",id:"techniques-for-connecting-structurally-inequivalent-chisel-types",level:2},{value:"Connecting different sub-types of the same super-type, with colliding names",id:"connecting-different-sub-types-of-the-same-super-type-with-colliding-names",level:3},{value:"Connecting sub-types to super-types by waiving extra members",id:"connecting-sub-types-to-super-types-by-waiving-extra-members",level:3},{value:"Connecting different sub-types",id:"connecting-different-sub-types",level:3},{value:"FAQ",id:"faq",level:2},{value:"How do I connect two items as flexibly as possible (try your best but never error)",id:"how-do-i-connect-two-items-as-flexibly-as-possible-try-your-best-but-never-error",level:3},{value:"How do I connect two items but don&#39;t care about the Scala types being equivalent?",id:"how-do-i-connect-two-items-but-dont-care-about-the-scala-types-being-equivalent",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"table-of-contents",children:"Table of Contents"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#terminology",children:"Terminology"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#overview",children:"Overview"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#alignment-flipped-vs-aligned",children:"Alignment: Flipped vs Aligned"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#inputoutput",children:"Input/Output"})}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"#connecting-components-with-fully-aligned-members",children:"Connecting components with fully aligned members"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#mono-direction-connection-operator-",children:["Mono-direction connection operator (",(0,o.jsx)(n.code,{children:":="}),")"]})}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"#connecting-components-with-mixed-alignment-members",children:"Connecting components with mixed alignment members"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#bi-direction-connection-operator-",children:["Bi-direction connection operator (",(0,o.jsx)(n.code,{children:":<>="}),")"]})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#port-direction-computation-versus-connection-direction-computation",children:"Port-Direction Computation versus Connection-Direction Computation"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#aligned-connection-operator-",children:["Aligned connection operator (",(0,o.jsx)(n.code,{children:":<="}),")"]})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#flipped-connection-operator-",children:["Flipped connection operator (",(0,o.jsx)(n.code,{children:":>="}),")"]})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#coercing-mono-direction-connection-operator-",children:["Coercing mono-direction connection operator (",(0,o.jsx)(n.code,{children:":#="}),")"]})}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"#connectable",children:"Connectable"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-records",children:"Connecting Records"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#defaults-with-waived-connections",children:"Defaults with waived connections"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-types-with-optional-members",children:"Connecting types with optional members"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#always-ignore-errors-caused-by-extra-members-partial-connection-operator",children:"Always ignore extra members (partial connection operator)"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-components-with-different-widths",children:"Connecting components with different widths"})}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"#techniques-for-connecting-structurally-inequivalent-chisel-types",children:"Techniques for connecting structurally inequivalent Chisel types"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-different-sub-types-of-the-same-super-type-with-colliding-names",children:"Connecting different sub-types of the same super-type, with colliding names"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-sub-types-to-super-types-by-waiving-extra-members",children:"Connecting sub-types to super-types by waiving extra members"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-different-sub-types",children:"Connecting different sub-types"})}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#faq",children:"FAQ"})}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"terminology",children:"Terminology"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:['"Chisel type" - a ',(0,o.jsx)(n.code,{children:"Data"})," that is not bound to hardware, i.e. not a component. (more details ",(0,o.jsx)(n.a,{href:"chisel-type-vs-scala-type",children:"here"}),").","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"UInt(3.W)"}),", ",(0,o.jsx)(n.code,{children:"new Bundle {..}"}),", ",(0,o.jsx)(n.code,{children:"Vec(3, SInt(2.W))"})," are all Chisel types"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:['"component" - a ',(0,o.jsx)(n.code,{children:"Data"})," that is bound to hardware (",(0,o.jsx)(n.code,{children:"IO"}),", ",(0,o.jsx)(n.code,{children:"Reg"}),", ",(0,o.jsx)(n.code,{children:"Wire"}),", etc.)","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"Wire(UInt(3.W))"})," is a component, whose Chisel type is ",(0,o.jsx)(n.code,{children:"UInt(3.W)"})]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Aggregate"})," - a Chisel type or component that contains other Chisel types or components (i.e. ",(0,o.jsx)(n.code,{children:"Vec"}),", ",(0,o.jsx)(n.code,{children:"Record"}),", or ",(0,o.jsx)(n.code,{children:"Bundle"}),")"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Element"})," - a Chisel type or component that does not contain other Chisel types or components (e.g. ",(0,o.jsx)(n.code,{children:"UInt"}),", ",(0,o.jsx)(n.code,{children:"SInt"}),", ",(0,o.jsx)(n.code,{children:"Clock"}),", ",(0,o.jsx)(n.code,{children:"Bool"})," etc.)"]}),"\n",(0,o.jsxs)(n.li,{children:['"member" - a Chisel type or component, or any of its children (could be an ',(0,o.jsx)(n.code,{children:"Aggregate"})," or an ",(0,o.jsx)(n.code,{children:"Element"}),")","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"Vec(3, UInt(2.W))(0)"})," is a member of the parent ",(0,o.jsx)(n.code,{children:"Vec"})," Chisel type"]}),"\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"Wire(Vec(3, UInt(2.W)))(0)"})," is a member of the parent ",(0,o.jsx)(n.code,{children:"Wire"})," component"]}),"\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"IO(Decoupled(Bool)).ready"})," is a member of the parent ",(0,o.jsx)(n.code,{children:"IO"})," component"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:['"relative alignment" - whether two members of the same component or Chisel type are aligned/flipped, relative to one another',"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["see section ",(0,o.jsx)(n.a,{href:"#alignment-flipped-vs-aligned",children:"below"})," for a detailed definition"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:['"structural type check" - Chisel type ',(0,o.jsx)(n.code,{children:"A"})," is structurally equivalent to Chisel type ",(0,o.jsx)(n.code,{children:"B"})," if ",(0,o.jsx)(n.code,{children:"A"})," and ",(0,o.jsx)(n.code,{children:"B"})," have matching bundle field names and types (",(0,o.jsx)(n.code,{children:"Record"})," vs ",(0,o.jsx)(n.code,{children:"Vector"})," vs ",(0,o.jsx)(n.code,{children:"Element"}),"), probe modifiers (probe vs nonprobe), vector sizes, ",(0,o.jsx)(n.code,{children:"Element"})," types (UInt/SInt/Bool/Clock)","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"ignores relative alignment (flippedness)"}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:['"alignment type check" - a Chisel type ',(0,o.jsx)(n.code,{children:"A"})," matches alignment with another Chisel type ",(0,o.jsx)(n.code,{children:"B"})," if every member of ",(0,o.jsx)(n.code,{children:"A"}),"'s relative alignment to ",(0,o.jsx)(n.code,{children:"A"})," is the same as the structurally corresponding member of ",(0,o.jsx)(n.code,{children:"B"}),"'s relative alignment to ",(0,o.jsx)(n.code,{children:"B"}),"."]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"Connectable"})," operators are the standard way to connect Chisel hardware components to one another."]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note: For descriptions of the semantics for the previous operators, see ",(0,o.jsx)(n.a,{href:"connection-operators",children:(0,o.jsx)(n.code,{children:"Connection Operators"})}),"."]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"All connection operators require the two hardware components (consumer and producer) to be structurally type equivalent."}),"\n",(0,o.jsxs)(n.p,{children:["The one exception to the structural type-equivalence rule is using the ",(0,o.jsx)(n.code,{children:"Connectable"})," mechanism, detailed at this ",(0,o.jsx)(n.a,{href:"#techniques-for-connecting-structurally-inequivalent-chisel-types",children:"section"})," towards the end of this document."]}),"\n",(0,o.jsxs)(n.p,{children:["Aggregate (",(0,o.jsx)(n.code,{children:"Record"}),", ",(0,o.jsx)(n.code,{children:"Vec"}),", ",(0,o.jsx)(n.code,{children:"Bundle"}),") Chisel types can include data members which are flipped relative to one another.\nDue to this, there are many desired connection behaviors between two Chisel components.\nThe following are the Chisel connection operators between a consumer ",(0,o.jsx)(n.code,{children:"c"})," and producer ",(0,o.jsx)(n.code,{children:"p"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c := p"})," (mono-direction): connects all ",(0,o.jsx)(n.code,{children:"p"})," members to ",(0,o.jsx)(n.code,{children:"c"}),"; requires ",(0,o.jsx)(n.code,{children:"c"})," and ",(0,o.jsx)(n.code,{children:"p"})," to not have any flipped members"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c :#= p"})," (coercing mono-direction): connects all ",(0,o.jsx)(n.code,{children:"p"})," members to ",(0,o.jsx)(n.code,{children:"c"}),"; regardless of alignment"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c :<= p"})," (aligned-direction): connects all aligned (non-flipped) ",(0,o.jsx)(n.code,{children:"c"})," members from ",(0,o.jsx)(n.code,{children:"p"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c :>= p"})," (flipped-direction): connects all flipped ",(0,o.jsx)(n.code,{children:"p"})," members from ",(0,o.jsx)(n.code,{children:"c"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c :<>= p"})," (bi-direction operator): connects all aligned ",(0,o.jsx)(n.code,{children:"c"})," members from ",(0,o.jsx)(n.code,{children:"p"}),"; all flipped ",(0,o.jsx)(n.code,{children:"p"})," members from ",(0,o.jsx)(n.code,{children:"c"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"These operators may appear to be a random collection of symbols; however, the characters are consistent between operators and self-describe the semantics of each operator:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:":"})," always indicates the consumer, or left-hand-side, of the operator."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"="})," always indicates the producer, or right-hand-side, of the operator.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c := p"})," connects a consumer (",(0,o.jsx)(n.code,{children:"c"}),") and a producer (",(0,o.jsx)(n.code,{children:"p"}),")."]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"<"})," always indicates that some members will be driven producer-to-consumer, or right-to-left.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c :<= p"})," drives members in producer (",(0,o.jsx)(n.code,{children:"p"}),") to members in consumer (",(0,o.jsx)(n.code,{children:"c"}),")."]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:">"})," always indicates that some signals will be driven consumer-to-producer, or left-to-right.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c :>= p"})," drives members in consumer (",(0,o.jsx)(n.code,{children:"c"}),") to members producer (",(0,o.jsx)(n.code,{children:"p"}),")."]}),"\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c :<>= p"})," both drives members from ",(0,o.jsx)(n.code,{children:"p"})," to ",(0,o.jsx)(n.code,{children:"c"})," and from ",(0,o.jsx)(n.code,{children:"c"})," to ",(0,o.jsx)(n.code,{children:"p"}),"."]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"#"})," always indicates to ignore member alignment and to drive producer-to-consumer, or right-to-left.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c :#= p"})," always drives members from ",(0,o.jsx)(n.code,{children:"p"})," to ",(0,o.jsx)(n.code,{children:"c"})," ignoring direction."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note: in addition, an operator that ends in ",(0,o.jsx)(n.code,{children:"="})," has assignment-precedence, which means that ",(0,o.jsx)(n.code,{children:"x :<>= y + z"})," will translate to ",(0,o.jsx)(n.code,{children:"x :<>= (y + z)"}),", rather than ",(0,o.jsx)(n.code,{children:"(x :<>= y) + z"}),".\nThis was not true of the ",(0,o.jsx)(n.code,{children:"<>"})," operator and was a minor painpoint for users."]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"alignment-flipped-vs-aligned",children:"Alignment: Flipped vs Aligned"}),"\n",(0,o.jsxs)(n.p,{children:["A member's alignment is a relative property: a member is aligned/flipped relative to another member of the same component or Chisel type.\nHence, one must always say whether a member is flipped/aligned ",(0,o.jsx)(n.em,{children:"with respect to (w.r.t)"})," another member of that type (parent, sibling, child etc.)."]}),"\n",(0,o.jsxs)(n.p,{children:["We use the following example of a non-nested bundle ",(0,o.jsx)(n.code,{children:"Parent"})," to let us state all of the alignment relationships between members of ",(0,o.jsx)(n.code,{children:"p"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass Parent extends Bundle {\n  val alignedChild = UInt(32.W)\n  val flippedChild = Flipped(UInt(32.W))\n}\nclass MyModule0 extends Module {\n  val p = Wire(new Parent)\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"First, every member is always aligned with themselves:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.alignedChild"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.flippedChild"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedChild"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Next, we list all parent/child relationships.\nBecause the ",(0,o.jsx)(n.code,{children:"flippedChild"})," field is ",(0,o.jsx)(n.code,{children:"Flipped"}),", it changes its alignment relative to its parent."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedChild"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Finally, we can list all sibling relationships:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.alignedChild"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedChild"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["The next example has a nested bundle ",(0,o.jsx)(n.code,{children:"GrandParent"})," who instantiates an aligned ",(0,o.jsx)(n.code,{children:"Parent"})," field and flipped ",(0,o.jsx)(n.code,{children:"Parent"})," field."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass GrandParent extends Bundle {\n  val alignedParent = new Parent\n  val flippedParent = Flipped(new Parent)\n}\nclass MyModule1 extends Module {\n  val g = Wire(new GrandParent)\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Consider the following alignments between grandparent and grandchildren.\nAn odd number of flips indicate a flipped relationship; even numbers of flips indicate an aligned relationship."}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"g.flippedParent.flippedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"g.alignedParent.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"g.flippedParent.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"g.alignedParent.flippedChild"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Consider the following alignment relationships starting from ",(0,o.jsx)(n.code,{children:"g.alignedParent"})," and ",(0,o.jsx)(n.code,{children:"g.flippedParent"}),".\n",(0,o.jsxs)(n.em,{children:["Note that whether ",(0,o.jsx)(n.code,{children:"g.alignedParent"})," is aligned/flipped relative to ",(0,o.jsx)(n.code,{children:"g"})," has no effect on the aligned/flipped relationship between ",(0,o.jsx)(n.code,{children:"g.alignedParent"})," and ",(0,o.jsx)(n.code,{children:"g.alignedParent.alignedChild"})," because alignment is only relative to the two members in question!"]}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.alignedParent"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.alignedParent.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.flippedParent"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.flippedParent.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.alignedParent"})," is flipped w.r.t. ",(0,o.jsx)(n.code,{children:"g.alignedParent.flippedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.flippedParent"})," is flipped w.r.t. ",(0,o.jsx)(n.code,{children:"g.flippedParent.flippedChild"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["In summary, a member is aligned or flipped w.r.t. another member of the hardware component.\nThis means that the type of the consumer/producer is the only information needed to determine the behavior of any operator.\n",(0,o.jsx)(n.em,{children:"Whether the consumer/producer is a member of a larger bundle is irrelevant; you ONLY need to know the type of the consumer/producer"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"inputoutput",children:"Input/Output"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Input(gen)"}),"/",(0,o.jsx)(n.code,{children:"Output(gen)"})," are coercing operators.\nThey perform two functions: (1) create a new Chisel type that has all flips removed from all recursive children members (still structurally equivalent to ",(0,o.jsx)(n.code,{children:"gen"})," but no longer alignment type equivalent), and (2) apply ",(0,o.jsx)(n.code,{children:"Flipped"})," if ",(0,o.jsx)(n.code,{children:"Input"}),", keep aligned (do nothing) if ",(0,o.jsx)(n.code,{children:"Output"}),".\nE.g. if we imagine a function called ",(0,o.jsx)(n.code,{children:"cloneChiselTypeButStripAllFlips"}),", then ",(0,o.jsx)(n.code,{children:"Input(gen)"})," is structurally and alignment type equivalent to ",(0,o.jsx)(n.code,{children:"Flipped(cloneChiselTypeButStripAllFlips(gen))"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Note that if ",(0,o.jsx)(n.code,{children:"gen"})," is a non-aggregate, then ",(0,o.jsx)(n.code,{children:"Input(nonAggregateGen)"})," is equivalent to ",(0,o.jsx)(n.code,{children:"Flipped(nonAggregateGen)"}),"."]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Future work will refactor how these primitives are exposed to the user to make Chisel's type system more intuitive.\nSee [",(0,o.jsx)(n.a,{href:"https://github.com/chipsalliance/chisel3/issues/2643",children:"https://github.com/chipsalliance/chisel3/issues/2643"}),"]."]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"With this in mind, we can consider the following examples and detail relative alignments of members."}),"\n",(0,o.jsxs)(n.p,{children:["First, we can use a similar example to ",(0,o.jsx)(n.code,{children:"Parent"})," but use ",(0,o.jsx)(n.code,{children:"Input/Output"})," instead of ",(0,o.jsx)(n.code,{children:"Flipped"}),".\nBecause ",(0,o.jsx)(n.code,{children:"alignedChild"})," and ",(0,o.jsx)(n.code,{children:"flippedChild"})," are non-aggregates, ",(0,o.jsx)(n.code,{children:"Input"})," is basically just a ",(0,o.jsx)(n.code,{children:"Flipped"})," and thus the alignments are unchanged compared to the previous ",(0,o.jsx)(n.code,{children:"Parent"})," example."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass ParentWithOutputInput extends Bundle {\n  val alignedCoerced = Output(UInt(32.W)) // Equivalent to just UInt(32.W)\n  val flippedCoerced = Input(UInt(32.W))  // Equivalent to Flipped(UInt(32.W))\n}\nclass MyModule2 extends Module {\n  val p = Wire(new ParentWithOutputInput)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The alignments are the same as the previous ",(0,o.jsx)(n.code,{children:"Parent"})," example:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.alignedCoerced"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.flippedCoerced"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.alignedCoerced"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedCoerced"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["The next example has a nested bundle ",(0,o.jsx)(n.code,{children:"GrandParent"})," who instantiates an ",(0,o.jsx)(n.code,{children:"Output"})," ",(0,o.jsx)(n.code,{children:"ParentWithOutputInput"})," field and an ",(0,o.jsx)(n.code,{children:"Input"})," ",(0,o.jsx)(n.code,{children:"ParentWithOutputInput"})," field."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass GrandParentWithOutputInput extends Bundle {\n  val alignedCoerced = Output(new ParentWithOutputInput)\n  val flippedCoerced = Input(new ParentWithOutputInput)\n}\nclass MyModule3 extends Module {\n  val g = Wire(new GrandParentWithOutputInput)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Remember that ",(0,o.jsx)(n.code,{children:"Output(gen)/Input(gen)"})," recursively strips the ",(0,o.jsx)(n.code,{children:"Flipped"})," of any recursive children.\nThis makes every member of ",(0,o.jsx)(n.code,{children:"gen"})," aligned with every other member of ",(0,o.jsx)(n.code,{children:"gen"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Consider the following alignments between grandparent and grandchildren.\nBecause ",(0,o.jsx)(n.code,{children:"alignedCoerced"})," and ",(0,o.jsx)(n.code,{children:"flippedCoerced"})," are aligned with all their recursive members, they are fully aligned.\nThus, only their alignment to ",(0,o.jsx)(n.code,{children:"g"})," influences grandchildren alignment:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.flippedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"g.flippedCoerced.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"g.flippedCoerced.flippedCoerced"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Consider the following alignment relationships starting from ",(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," and ",(0,o.jsx)(n.code,{children:"g.flippedCoerced"}),".\n",(0,o.jsxs)(n.em,{children:["Note that whether ",(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," is aligned/flipped relative to ",(0,o.jsx)(n.code,{children:"g"})," has no effect on the aligned/flipped relationship between ",(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," and ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.alignedCoerced"})," or ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.flippedCoerced"})," because alignment is only relative to the two members in question! However, because alignment is coerced, everything is aligned between ",(0,o.jsx)(n.code,{children:"g.alignedCoerced"}),"/",(0,o.jsx)(n.code,{children:"g.flippedAligned"})," and their children"]}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.flippedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.flippedCoerced"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.flippedCoerced.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.flippedCoerced"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.flippedCoerced.flippedCoerced"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["In summary, ",(0,o.jsx)(n.code,{children:"Input(gen)"})," and ",(0,o.jsx)(n.code,{children:"Output(gen)"})," recursively coerce children alignment, as well as dictate ",(0,o.jsx)(n.code,{children:"gen"}),"'s alignment to its parent bundle (if it exists)."]}),"\n",(0,o.jsx)(n.h2,{id:"connecting-components-with-fully-aligned-members",children:"Connecting components with fully aligned members"}),"\n",(0,o.jsx)(n.h3,{id:"mono-direction-connection-operator-",children:"Mono-direction connection operator (:=)"}),"\n",(0,o.jsxs)(n.p,{children:["For simple connections where all members are aligned (non-flipped) w.r.t. one another, use ",(0,o.jsx)(n.code,{children:":="}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass FullyAlignedBundle extends Bundle {\n  val a = Bool()\n  val b = Bool()\n}\nclass Example0 extends RawModule {\n  val incoming = IO(Flipped(new FullyAlignedBundle))\n  val outgoing = IO(new FullyAlignedBundle)\n  outgoing := incoming\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where each member of ",(0,o.jsx)(n.code,{children:"incoming"})," drives every member of ",(0,o.jsx)(n.code,{children:"outgoing"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example0(\n  input  incoming_a,\n         incoming_b,\n  output outgoing_a,\n         outgoing_b\n);\n\n  assign outgoing_a = incoming_a;\n  assign outgoing_b = incoming_b;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["You may be thinking \"Wait, I'm confused! Isn't ",(0,o.jsx)(n.code,{children:"incoming"})," flipped and ",(0,o.jsx)(n.code,{children:"outgoing"}),' aligned?" -- Noo! Whether ',(0,o.jsx)(n.code,{children:"incoming"})," is aligned with ",(0,o.jsx)(n.code,{children:"outgoing"})," makes no sense; remember, you only evaluate alignment between members of the same component or Chisel type.\nBecause components are always aligned to themselves, ",(0,o.jsx)(n.code,{children:"outgoing"})," is aligned to ",(0,o.jsx)(n.code,{children:"outgoing"}),", and ",(0,o.jsx)(n.code,{children:"incoming"})," is aligned to ",(0,o.jsx)(n.code,{children:"incoming"}),", there is no problem.\nTheir relative flippedness to anything else is irrelevant."]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"connecting-components-with-mixed-alignment-members",children:"Connecting components with mixed alignment members"}),"\n",(0,o.jsxs)(n.p,{children:["Aggregate Chisel types can include data members which are flipped relative to one another; in the example below, ",(0,o.jsx)(n.code,{children:"alignedChild"})," and ",(0,o.jsx)(n.code,{children:"flippedChild"})," are aligned/flipped relative to ",(0,o.jsx)(n.code,{children:"MixedAlignmentBundle"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass MixedAlignmentBundle extends Bundle {\n  val alignedChild = Bool()\n  val flippedChild = Flipped(Bool())\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Due to this, there are many desired connection behaviors between two Chisel components.\nFirst we will introduce the most common Chisel connection operator, ",(0,o.jsx)(n.code,{children:":<>="}),", useful for connecting components with members of mixed-alignments, then take a moment to investigate a common source of confusion between port-direction and connection-direction.\nThen, we will explore the remainder of the Chisel connection operators."]}),"\n",(0,o.jsxs)(n.h3,{id:"bi-direction-connection-operator-",children:["Bi-direction connection operator (",(0,o.jsx)(n.code,{children:":<>="}),")"]}),"\n",(0,o.jsxs)(n.p,{children:["For connections where you want 'bulk-connect-like-semantics' where the aligned members are driven producer-to-consumer and flipped members are driven consumer-to-producer, use ",(0,o.jsx)(n.code,{children:":<>="}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Example1 extends RawModule {\n  val incoming = IO(Flipped(new MixedAlignmentBundle))\n  val outgoing = IO(new MixedAlignmentBundle)\n  outgoing :<>= incoming\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where the aligned members are driven ",(0,o.jsx)(n.code,{children:"incoming"})," to ",(0,o.jsx)(n.code,{children:"outgoing"})," and flipped members are driven ",(0,o.jsx)(n.code,{children:"outgoing"})," to ",(0,o.jsx)(n.code,{children:"incoming"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example1(\n  input  incoming_alignedChild,\n  output incoming_flippedChild,\n         outgoing_alignedChild,\n  input  outgoing_flippedChild\n);\n\n  assign incoming_flippedChild = outgoing_flippedChild;\n  assign outgoing_alignedChild = incoming_alignedChild;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"port-direction-computation-versus-connection-direction-computation",children:"Port-Direction Computation versus Connection-Direction Computation"}),"\n",(0,o.jsxs)(n.p,{children:["A common question is if you use a mixed-alignment connection (such as ",(0,o.jsx)(n.code,{children:":<>="}),") to connect submembers of parent components, does the alignment of the submember to their parent affect anything? The answer is no, because ",(0,o.jsx)(n.em,{children:"alignment is always computed relative to what is being connected to, and members are always aligned with themselves."})]}),"\n",(0,o.jsxs)(n.p,{children:["In the following example connecting from ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," to ",(0,o.jsx)(n.code,{children:"outgoing.alignedChild"}),", whether ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," is aligned with ",(0,o.jsx)(n.code,{children:"incoming"})," is irrelevant because the ",(0,o.jsx)(n.code,{children:":<>="})," only computes alignment relative to the thing being connected to, and ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," is aligned with ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Example1a extends RawModule {\n  val incoming = IO(Flipped(new MixedAlignmentBundle))\n  val outgoing = IO(new MixedAlignmentBundle)\n  outgoing.alignedChild :<>= incoming.alignedChild // whether incoming.alignedChild is aligned/flipped to incoming is IRRELEVANT to what gets connected with :<>=\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"incoming.flippedChild"}),"'s alignment with ",(0,o.jsx)(n.code,{children:"incoming"})," does not affect our operators, it does influence whether ",(0,o.jsx)(n.code,{children:"incoming.flippedChild"})," is an output or input port of my module.\nA common source of confusion is to mistake the process for determining whether ",(0,o.jsx)(n.code,{children:"incoming.flippedChild"})," will resolve to a Verilog ",(0,o.jsx)(n.code,{children:"output"}),"/",(0,o.jsx)(n.code,{children:"input"})," (the port-direction computation) with the process for determining how ",(0,o.jsx)(n.code,{children:":<>="})," drives what with what (the connection-direction computation).\nWhile both processes consider relative alignment, they are distinct."]}),"\n",(0,o.jsxs)(n.p,{children:["The port-direction computation always computes alignment relative to the component marked with ",(0,o.jsx)(n.code,{children:"IO"}),".\nAn ",(0,o.jsx)(n.code,{children:"IO(Flipped(gen))"})," is an incoming port, and any member of ",(0,o.jsx)(n.code,{children:"gen"})," that is aligned/flipped with ",(0,o.jsx)(n.code,{children:"gen"})," is an incoming/outgoing port.\nAn ",(0,o.jsx)(n.code,{children:"IO(gen)"})," is an outgoing port, and any member of ",(0,o.jsx)(n.code,{children:"gen"})," that is aligned/flipped with ",(0,o.jsx)(n.code,{children:"gen"})," is an outgoing/incoming port."]}),"\n",(0,o.jsxs)(n.p,{children:["The connection-direction computation always computes alignment based on the explicit consumer/producer referenced for the connection.\nIf one connects ",(0,o.jsx)(n.code,{children:"incoming :<>= outgoing"}),", alignments are computed based on ",(0,o.jsx)(n.code,{children:"incoming"})," and ",(0,o.jsx)(n.code,{children:"outgoing"}),".\nIf one connects ",(0,o.jsx)(n.code,{children:"incoming.alignedChild :<>= outgoing.alignedChild"}),", then alignments are computed based on ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," and ",(0,o.jsx)(n.code,{children:"outgoing.alignedChild"})," (and the alignment of ",(0,o.jsx)(n.code,{children:"incoming"})," to ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," is irrelevant)."]}),"\n",(0,o.jsxs)(n.p,{children:["This means that users can try to connect to input ports of their module! If I write ",(0,o.jsx)(n.code,{children:"x :<>= y"}),", and ",(0,o.jsx)(n.code,{children:"x"})," is an input to the current module, then that is what the connection is trying to do.\nHowever, because input ports are not drivable from within the current module, Chisel will throw an error.\nThis is the same error a user would get using a mono-directioned operator: ",(0,o.jsx)(n.code,{children:"x := y"})," will throw the same error if ",(0,o.jsx)(n.code,{children:"x"})," is an input to the current module.\n",(0,o.jsx)(n.em,{children:"Whether a component is drivable is irrelevant to the semantics of any connection operator attempting to drive to it."})]}),"\n",(0,o.jsxs)(n.p,{children:["In summary, the port-direction computation is relative to the root marked ",(0,o.jsx)(n.code,{children:"IO"}),", but connection-direction computation is relative to the consumer/producer that the connection is doing.\nThis has the positive property that connection semantics are solely based on the Chisel structural type and its relative alignments of the consumer/producer (nothing more, nothing less)."]}),"\n",(0,o.jsxs)(n.h3,{id:"aligned-connection-operator-",children:["Aligned connection operator (",(0,o.jsx)(n.code,{children:":<="}),")"]}),"\n",(0,o.jsxs)(n.p,{children:["For connections where you want the aligned-half of 'bulk-connect-like-semantics' where the aligned members are driven producer-to-consumer and flipped members are ignored, use ",(0,o.jsx)(n.code,{children:":<="}),' (the "aligned connection").']}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Example2 extends RawModule {\n  val incoming = IO(Flipped(new MixedAlignmentBundle))\n  val outgoing = IO(new MixedAlignmentBundle)\n  incoming.flippedChild := DontCare // Otherwise FIRRTL throws an uninitialization error\n  outgoing :<= incoming\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where the aligned members are driven ",(0,o.jsx)(n.code,{children:"incoming"})," to ",(0,o.jsx)(n.code,{children:"outgoing"})," and flipped members are ignored:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example2(\n  input  incoming_alignedChild,\n  output incoming_flippedChild,\n         outgoing_alignedChild,\n  input  outgoing_flippedChild\n);\n\n  assign incoming_flippedChild = 1'h0;\n  assign outgoing_alignedChild = incoming_alignedChild;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.h3,{id:"flipped-connection-operator-",children:["Flipped connection operator (",(0,o.jsx)(n.code,{children:":>="}),")"]}),"\n",(0,o.jsxs)(n.p,{children:["For connections where you want the flipped-half of 'bulk-connect-like-semantics' where the aligned members are ignored and flipped members are connected consumer-to-producer, use ",(0,o.jsx)(n.code,{children:":>="}),' (the "flipped connection", or "backpressure connection").']}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Example3 extends RawModule {\n  val incoming = IO(Flipped(new MixedAlignmentBundle))\n  val outgoing = IO(new MixedAlignmentBundle)\n  outgoing.alignedChild := DontCare // Otherwise FIRRTL throws an uninitialization error\n  outgoing :>= incoming\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where the aligned members are ignored and the flipped members are driven ",(0,o.jsx)(n.code,{children:"outgoing"})," to ",(0,o.jsx)(n.code,{children:"incoming"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example3(\n  input  incoming_alignedChild,\n  output incoming_flippedChild,\n         outgoing_alignedChild,\n  input  outgoing_flippedChild\n);\n\n  assign incoming_flippedChild = outgoing_flippedChild;\n  assign outgoing_alignedChild = 1'h0;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note: Astute observers will realize that ",(0,o.jsx)(n.code,{children:"c :<>= p"})," is semantically equivalent to ",(0,o.jsx)(n.code,{children:"c :<= p"})," followed by ",(0,o.jsx)(n.code,{children:"c :>= p"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.h3,{id:"coercing-mono-direction-connection-operator-",children:["Coercing mono-direction connection operator (",(0,o.jsx)(n.code,{children:":#="}),")"]}),"\n",(0,o.jsxs)(n.p,{children:["For connections where you want to every producer member to always drive every consumer member, regardless of alignment, use ",(0,o.jsx)(n.code,{children:":#="}),' (the "coercion connection").\nThis operator is useful for initializing wires whose types contain members of mixed alignment.']}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.BundleLiterals._\nclass Example4 extends RawModule {\n  val w = Wire(new MixedAlignmentBundle)\n  dontTouch(w) // So we see it in the output Verilog\n  w :#= (new MixedAlignmentBundle).Lit(_.alignedChild -> true.B, _.flippedChild -> true.B)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where all members are driven from the literal to ",(0,o.jsx)(n.code,{children:"w"}),", regardless of alignment:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example4();\n  wire w_alignedChild = 1'h1;\n  wire w_flippedChild = 1'h1;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note: Astute observers will realize that ",(0,o.jsx)(n.code,{children:"c :#= p"})," is semantically equivalent to ",(0,o.jsx)(n.code,{children:"c :<= p"})," followed by ",(0,o.jsx)(n.code,{children:"p :>= c"})," (note ",(0,o.jsx)(n.code,{children:"p"})," and ",(0,o.jsx)(n.code,{children:"c"})," switched places in the second connection)."]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Another use case for ",(0,o.jsx)(n.code,{children:":#="})," is for connecting a mixed-directional bundle to a fully-aligned monitor."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.BundleLiterals._\nclass Example4b extends RawModule {\n  val monitor = IO(Output(new MixedAlignmentBundle))\n  val w = Wire(new MixedAlignmentBundle)\n  dontTouch(w) // So we see it in the output Verilog\n  w :#= DontCare\n  monitor :#= w\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where all members are driven from the literal to ",(0,o.jsx)(n.code,{children:"w"}),", regardless of alignment:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example4b(\n  output monitor_alignedChild,\n         monitor_flippedChild\n);\n\n  wire w_alignedChild = 1'h0;\n  wire w_flippedChild = 1'h0;\n  assign monitor_alignedChild = w_alignedChild;\n  assign monitor_flippedChild = w_flippedChild;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"connectable",children:"Connectable"}),"\n",(0,o.jsxs)(n.p,{children:["Sometimes a user wants to connect Chisel components which are not type equivalent.\nFor example, a user may want to hook up anonymous ",(0,o.jsx)(n.code,{children:"Record"})," components who may have an intersection of their fields being equivalent, but cannot because they are not structurally equivalent.\nAlternatively, one may want to connect two types that have different widths."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Connectable"})," is the mechanism to specialize connection operator behavior in these scenarios.\nFor additional members which are not present in the other component being connected to, or for mismatched widths, or for always excluding a member from being connected to, they can be explicitly called out from the ",(0,o.jsx)(n.code,{children:"Connectable"})," object, rather than trigger an error."]}),"\n",(0,o.jsxs)(n.p,{children:["In addition, there are other techniques that can be used to address similar use cases including ",(0,o.jsx)(n.code,{children:".viewAsSuperType"}),", a static cast to a supertype (e.g. ",(0,o.jsx)(n.code,{children:"(x: T)"}),"), or creating a custom ",(0,o.jsx)(n.code,{children:"DataView"}),".\nFor a discussion about when to use each technique, please continue ",(0,o.jsx)(n.a,{href:"#techniques-for-connecting-structurally-inequivalent-chisel-types",children:"here"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["This section demonstrates how ",(0,o.jsx)(n.code,{children:"Connectable"})," specifically can be used in a multitude of scenarios."]}),"\n",(0,o.jsx)(n.h3,{id:"connecting-records",children:"Connecting Records"}),"\n",(0,o.jsxs)(n.p,{children:["One use case is to try to connect two ",(0,o.jsx)(n.code,{children:"Record"}),"s; for matching members, they should be connected, but for unmatched members, the errors caused due to them being unmatched should be ignored.\nTo accomplish this, use the other operators to initialize all ",(0,o.jsx)(n.code,{children:"Record"})," members, then use ",(0,o.jsx)(n.code,{children:":<>="})," with ",(0,o.jsx)(n.code,{children:".waive"})," to connect only the matching members."]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note that none of ",(0,o.jsx)(n.code,{children:".viewAsSuperType"}),", static casts, nor a custom ",(0,o.jsx)(n.code,{children:"DataView"})," helps this case because the Scala types are still ",(0,o.jsx)(n.code,{children:"Record"}),"."]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import scala.collection.immutable.SeqMap\n\nclass Example9 extends RawModule {\n  val abType = new Record { val elements = SeqMap("a" -> Bool(), "b" -> Flipped(Bool())) }\n  val bcType = new Record { val elements = SeqMap("b" -> Flipped(Bool()), "c" -> Bool()) }\n\n  val p = IO(Flipped(abType))\n  val c = IO(bcType)\n\n  DontCare :>= p\n  c :<= DontCare\n\n  c.waive(_.elements("c")):<>= p.waive(_.elements("a"))\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"p.b"})," is driven from ",(0,o.jsx)(n.code,{children:"c.b"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example9(\n  output p_b,\n  input  p_a,\n  output c_c,\n  input  c_b\n);\n\n  assign p_b = c_b;\n  assign c_c = 1'h0;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"defaults-with-waived-connections",children:"Defaults with waived connections"}),"\n",(0,o.jsxs)(n.p,{children:["Another use case is to try to connect two ",(0,o.jsx)(n.code,{children:"Record"}),"s; for matching members, they should be connected, but for unmatched members, ",(0,o.jsx)(n.em,{children:"they should be connected to a default value"}),".\nTo accomplish this, use the other operators to initialize all ",(0,o.jsx)(n.code,{children:"Record"})," members, then use ",(0,o.jsx)(n.code,{children:":<>="})," with ",(0,o.jsx)(n.code,{children:".waive"})," to connect only the matching members."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import scala.collection.immutable.SeqMap\n\nclass Example10 extends RawModule {\n  val abType = new Record { val elements = SeqMap("a" -> Bool(), "b" -> Flipped(Bool())) }\n  val bcType = new Record { val elements = SeqMap("b" -> Flipped(Bool()), "c" -> Bool()) }\n\n  val p = Wire(abType)\n  val c = Wire(bcType)\n\n  dontTouch(p) // So it doesn\'t get constant-propped away for the example\n  dontTouch(c) // So it doesn\'t get constant-propped away for the example\n\n  p :#= abType.Lit(_.elements("a") -> true.B, _.elements("b") -> true.B)\n  c :#= bcType.Lit(_.elements("b") -> true.B, _.elements("c") -> true.B)\n\n  c.waive(_.elements("c")) :<>= p.waive(_.elements("a"))\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"p.b"})," is driven from ",(0,o.jsx)(n.code,{children:"c.b"}),", and ",(0,o.jsx)(n.code,{children:"p.a"}),", ",(0,o.jsx)(n.code,{children:"c.b"}),", and ",(0,o.jsx)(n.code,{children:"c.c"})," are initialized to default values:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example10();\n  wire p_a = 1'h1;\n  wire c_c = 1'h1;\n  wire c_b = 1'h1;\n  wire p_b = c_b;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"connecting-types-with-optional-members",children:"Connecting types with optional members"}),"\n",(0,o.jsxs)(n.p,{children:["In the following example, we can use ",(0,o.jsx)(n.code,{children:":<>="})," and ",(0,o.jsx)(n.code,{children:".waive"})," to connect two ",(0,o.jsx)(n.code,{children:"MyDecoupledOpts"}),"'s, where only one has a ",(0,o.jsx)(n.code,{children:"bits"})," member."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class MyDecoupledOpt(hasBits: Boolean) extends Bundle {\n  val valid = Bool()\n  val ready = Flipped(Bool())\n  val bits = if (hasBits) Some(UInt(32.W)) else None\n}\nclass Example6 extends RawModule {\n  val in  = IO(Flipped(new MyDecoupledOpt(true)))\n  val out = IO(new MyDecoupledOpt(false))\n  out :<>= in.waive(_.bits.get) // We can know to call .get because we can inspect in.bits.isEmpty\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"ready"})," and ",(0,o.jsx)(n.code,{children:"valid"})," are connected, and ",(0,o.jsx)(n.code,{children:"bits"})," is ignored:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example6(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"always-ignore-errors-caused-by-extra-members-partial-connection-operator",children:"Always ignore errors caused by extra members (partial connection operator)"}),"\n",(0,o.jsx)(n.p,{children:"The most unsafe connection is to connect only members that are present in both consumer and producer, and ignore all other members.\nThis is unsafe because this connection will never error on any Chisel types."}),"\n",(0,o.jsxs)(n.p,{children:["To do this, you can use ",(0,o.jsx)(n.code,{children:".waiveAll"})," and static cast to ",(0,o.jsx)(n.code,{children:"Data"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class OnlyA extends Bundle {\n  val a = UInt(32.W)\n}\nclass OnlyB extends Bundle {\n  val b = UInt(32.W)\n}\nclass Example11 extends RawModule {\n  val in  = IO(Flipped(new OnlyA))\n  val out = IO(new OnlyB)\n\n  out := DontCare\n\n  (out: Data).waiveAll :<>= (in: Data).waiveAll\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"This generates the following Verilog, where nothing is connected:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example11(\n  input  [31:0] in_a,\n  output [31:0] out_b\n);\n\n  assign out_b = 32'h0;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"connecting-components-with-different-widths",children:"Connecting components with different widths"}),"\n",(0,o.jsxs)(n.p,{children:["Non-",(0,o.jsx)(n.code,{children:"Connectable"})," operators implicitly truncate if a component with a larger width is connected to a component with a smaller width.\n",(0,o.jsx)(n.code,{children:"Connectable"})," operators disallow this implicit truncation behavior and require the driven component to be equal or larger in width that the sourcing component."]}),"\n",(0,o.jsxs)(n.p,{children:["If implicit truncation behavior is desired, then ",(0,o.jsx)(n.code,{children:"Connectable"})," provides a ",(0,o.jsx)(n.code,{children:"squeeze"})," mechanism which will allow the connection to continue with implicit truncation."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import scala.collection.immutable.SeqMap\n\nclass Example14 extends RawModule {\n  val p = IO(Flipped(UInt(4.W)))\n  val c = IO(UInt(3.W))\n\n  c :<>= p.squeeze\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"p"})," is truncated prior to driving ",(0,o.jsx)(n.code,{children:"c"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example14(\n  input  [3:0] p,\n  output [2:0] c\n);\n\n  assign c = p[2:0];\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"excluding-members-from-any-operator-on-a-connectable",children:"Excluding members from any operator on a Connectable"}),"\n",(0,o.jsxs)(n.p,{children:["If a user wants to always exclude a field from a connect, use the ",(0,o.jsx)(n.code,{children:".exclude"})," mechanism which will never connect the field (as if it didn't exist to the connection)."]}),"\n",(0,o.jsxs)(n.p,{children:["Note that if a field matches in both producer and consumer, but only one is excluded, the other non-excluded field will still trigger an error; to fix this, use either ",(0,o.jsx)(n.code,{children:".waive"})," or ",(0,o.jsx)(n.code,{children:".exclude"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import scala.collection.immutable.SeqMap\n\nclass BundleWithSpecialField extends Bundle {\n  val foo = UInt(3.W)\n  val special = Bool()\n}\nclass Example15 extends RawModule {\n  val p = IO(Flipped(new BundleWithSpecialField()))\n  val c = IO(new BundleWithSpecialField())\n\n  c.special := true.B // must initialize it\n\n  c.exclude(_.special) :<>= p.exclude(_.special)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where the ",(0,o.jsx)(n.code,{children:"special"})," field is not connected:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example15(\n  input  [2:0] p_foo,\n  input        p_special,\n  output [2:0] c_foo,\n  output       c_special\n);\n\n  assign c_foo = p_foo;\n  assign c_special = 1'h1;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"techniques-for-connecting-structurally-inequivalent-chisel-types",children:"Techniques for connecting structurally inequivalent Chisel types"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"DataView"})," and ",(0,o.jsx)(n.code,{children:".viewAsSupertype"})," create a view of the component that has a different Chisel type.\nThis means that a user can first create a ",(0,o.jsx)(n.code,{children:"DataView"})," of the consumer or producer (or both) so that the Chisel types are structurally equivalent.\nThis is useful when the difference between the consumer and producer aren't super nested, and also if they have rich Scala types which encode their structure.\nIn general, ",(0,o.jsx)(n.code,{children:"DataView"})," is the preferred mechanism to use (if you can) because it maintains the most amount of Chisel information in the Scala type, but there are many instances where it doesn't work and thus one must fall back on ",(0,o.jsx)(n.code,{children:"Connectable"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Connectable"})," does not change the Chisel type, but instead changes the semantics of the operator to not error on the waived members if they are dangling or unconnected.\nThis is useful for when differences between the consumer and producer do not show up in the Scala type system (e.g. present/missing fields of type ",(0,o.jsx)(n.code,{children:"Option[Data]"}),", or anonymous ",(0,o.jsx)(n.code,{children:"Record"}),"s) or are deeply nested in a bundle that is especially onerous to create a ",(0,o.jsx)(n.code,{children:"DataView"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Static casts (e.g. ",(0,o.jsx)(n.code,{children:"(x: T)"}),") allows connecting components that have different Scala types, but leaves the Chisel type unchanged.\nUse this to force a connection to occur, even if the Scala types are different."]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsx)(n.p,{children:'One may wonder why the operators require identical Scala types in the first place, if they can easily be bypassed.\nThe reason is to encourage users to use the Scala type system to encode Chisel information as it can make their code more robust; however, we don\'t want to be draconian about it because there are times when we want to enable the user to "just connect the darn thing".'}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"When all else fails one can always manually expand the connection to do what they want to happen, member by member.\nThe down-side to this approach is its verbosity and that adding new members to a component will require updating the manual connections."}),"\n",(0,o.jsxs)(n.p,{children:["Things to remember about ",(0,o.jsx)(n.code,{children:"Connectable"})," vs ",(0,o.jsx)(n.code,{children:".viewAsSupertype"}),"/",(0,o.jsx)(n.code,{children:"DataView"})," vs static cast (e.g. ",(0,o.jsx)(n.code,{children:"(x: T)"}),"):"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"DataView"})," and ",(0,o.jsx)(n.code,{children:".viewAsSupertype"})," will preemptively remove members that are not present in the new view which has a different Chisel type, thus ",(0,o.jsx)(n.code,{children:"DataView"})," ",(0,o.jsx)(n.em,{children:"does"})," affect what is connected"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Connectable"})," can be used to waive the error on members who end up being dangling or unconnected.\nImportantly, ",(0,o.jsx)(n.code,{children:"Connectable"})," waives ",(0,o.jsx)(n.em,{children:"do not"})," affect what is connected"]}),"\n",(0,o.jsxs)(n.li,{children:["Static cast does not remove extra members, thus a static cast ",(0,o.jsx)(n.em,{children:"does not"})," affect what is connected"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"connecting-different-sub-types-of-the-same-super-type-with-colliding-names",children:"Connecting different sub-types of the same super-type, with colliding names"}),"\n",(0,o.jsxs)(n.p,{children:["In these examples, we are connecting ",(0,o.jsx)(n.code,{children:"MyDecoupled"})," with ",(0,o.jsx)(n.code,{children:"MyDecoupledOtherBits"}),".\nBoth are subtypes of ",(0,o.jsx)(n.code,{children:"MyReadyValid"}),", and both have a ",(0,o.jsx)(n.code,{children:"bits"})," field of type ",(0,o.jsx)(n.code,{children:"UInt(32.W)"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["The first example will use ",(0,o.jsx)(n.code,{children:".viewAsSupertype"})," to connect them as ",(0,o.jsx)(n.code,{children:"MyReadyValid"}),".\nBecause it changes the Chisel type to omit both ",(0,o.jsx)(n.code,{children:"bits"})," fields, the ",(0,o.jsx)(n.code,{children:"bits"})," fields are unconnected."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import experimental.dataview._\nclass MyDecoupledOtherBits extends MyReadyValid {\n  val bits = UInt(32.W)\n}\nclass Example12 extends RawModule {\n  val in  = IO(Flipped(new MyDecoupled))\n  val out = IO(new MyDecoupledOtherBits)\n\n  out := DontCare\n\n  out.viewAsSupertype(new MyReadyValid) :<>= in.viewAsSupertype(new MyReadyValid)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that the ",(0,o.jsx)(n.code,{children:"bits"})," fields are unconnected."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example12(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready,\n  output [31:0] out_bits\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\n  assign out_bits = 32'h0;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The second example will use a static cast and ",(0,o.jsx)(n.code,{children:".waive(_.bits)"})," to connect them as ",(0,o.jsx)(n.code,{children:"MyReadyValid"}),".\nNote that because the static cast does not change the Chisel type, the connection finds that both consumer and producer have a ",(0,o.jsx)(n.code,{children:"bits"})," field.\nThis means that since they are structurally equivalent, they match and are connected.\nThe ",(0,o.jsx)(n.code,{children:"waive(_.bits)"})," does nothing, because the ",(0,o.jsx)(n.code,{children:"bits"})," are neither dangling nor unconnected."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import experimental.dataview._\nclass Example13 extends RawModule {\n  val in  = IO(Flipped(new MyDecoupled))\n  val out = IO(new MyDecoupledOtherBits)\n\n  out := DontCare\n\n  out.waiveAs[MyReadyValid](_.bits) :<>= in.waiveAs[MyReadyValid](_.bits)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that the ",(0,o.jsx)(n.code,{children:"bits"})," fields ARE connected, even though they are waived, as ",(0,o.jsx)(n.code,{children:".waive"})," just changes whether an error should be thrown if they are missing, NOT to not connect them if they are structurally equivalent.\nTo always omit the connection, use ",(0,o.jsx)(n.code,{children:".exclude"})," on one side and either ",(0,o.jsx)(n.code,{children:".exclude"})," or ",(0,o.jsx)(n.code,{children:".waive"})," on the other side."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example13(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready,\n  output [31:0] out_bits\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\n  assign out_bits = in_bits;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"connecting-sub-types-to-super-types-by-waiving-extra-members",children:"Connecting sub-types to super-types by waiving extra members"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note that in this example, it would be better to use ",(0,o.jsx)(n.code,{children:".viewAsSupertype"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["In the following example, we can use ",(0,o.jsx)(n.code,{children:":<>="})," to connect a ",(0,o.jsx)(n.code,{children:"MyReadyValid"})," to a ",(0,o.jsx)(n.code,{children:"MyDecoupled"})," by waiving the ",(0,o.jsx)(n.code,{children:"bits"})," member."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class MyReadyValid extends Bundle {\n  val valid = Bool()\n  val ready = Flipped(Bool())\n}\nclass MyDecoupled extends MyReadyValid {\n  val bits = UInt(32.W)\n}\nclass Example5 extends RawModule {\n  val in  = IO(Flipped(new MyDecoupled))\n  val out = IO(new MyReadyValid)\n  out :<>= in.waiveAs[MyReadyValid](_.bits)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"ready"})," and ",(0,o.jsx)(n.code,{children:"valid"})," are connected, and ",(0,o.jsx)(n.code,{children:"bits"})," is ignored:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example5(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"connecting-different-sub-types",children:"Connecting different sub-types"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note that in this example, it would be better to use ",(0,o.jsx)(n.code,{children:".viewAsSupertype"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Note that the connection operator requires the ",(0,o.jsx)(n.code,{children:"consumer"})," and ",(0,o.jsx)(n.code,{children:"producer"})," to be the same Scala type to encourage capturing more information statically, but they can always be cast to ",(0,o.jsx)(n.code,{children:"Data"})," or another common supertype prior to connecting."]}),"\n",(0,o.jsxs)(n.p,{children:["In the following example, we can use ",(0,o.jsx)(n.code,{children:":<>="})," and ",(0,o.jsx)(n.code,{children:".waiveAs"})," to connect two different sub-types of ",(0,o.jsx)(n.code,{children:"MyReadyValid"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class HasBits extends MyReadyValid {\n  val bits = UInt(32.W)\n}\nclass HasEcho extends MyReadyValid {\n  val echo = Flipped(UInt(32.W))\n}\nclass Example7 extends RawModule {\n  val in  = IO(Flipped(new HasBits))\n  val out = IO(new HasEcho)\n  out.waiveAs[MyReadyValid](_.echo) :<>= in.waiveAs[MyReadyValid](_.bits)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"ready"})," and ",(0,o.jsx)(n.code,{children:"valid"})," are connected, and ",(0,o.jsx)(n.code,{children:"bits"})," and ",(0,o.jsx)(n.code,{children:"echo"})," are ignored:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example7(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready,\n  input  [31:0] out_echo\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"faq",children:"FAQ"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-connect-two-items-as-flexibly-as-possible-try-your-best-but-never-error",children:"How do I connect two items as flexibly as possible (try your best but never error)"}),"\n",(0,o.jsxs)(n.p,{children:["Use ",(0,o.jsx)(n.code,{children:".unsafe"})," (both waives and allows squeezing of all fields)."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class ExampleUnsafe extends RawModule {\n  val in  = IO(Flipped(new Bundle { val foo = Bool(); val bar = Bool() }))\n  val out = IO(new Bundle { val baz = Bool(); val bar = Bool() })\n  out.unsafe :<>= in.unsafe // bar is connected, and nothing errors\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-connect-two-items-but-dont-care-about-the-scala-types-being-equivalent",children:"How do I connect two items but don't care about the Scala types being equivalent?"}),"\n",(0,o.jsxs)(n.p,{children:["Use ",(0,o.jsx)(n.code,{children:".as"})," (upcasts the Scala type)."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class ExampleAs extends RawModule {\n  val in  = IO(Flipped(new Bundle { val foo = Bool(); val bar = Bool() }))\n  val out = IO(new Bundle { val foo = Bool(); val bar = Bool() })\n  // foo and bar are connected, although Scala types aren't the same\n  out.as[Data] :<>= in.as[Data]\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>s});var o=i(6540);const l={},t=o.createContext(l);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d4b6d0e6.f68aedf5.js b/assets/js/d4b6d0e6.f68aedf5.js
deleted file mode 100644
index dc059f7444..0000000000
--- a/assets/js/d4b6d0e6.f68aedf5.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[4166],{7240:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>s,toc:()=>r});var o=i(4848),l=i(8453);const t={layout:"docs",title:"Connectable Operators",section:"chisel3"},c=void 0,s={id:"explanations/connectable",title:"Connectable Operators",description:"Table of Contents",source:"@site/docs/explanations/connectable.md",sourceDirName:"explanations",slug:"/explanations/connectable",permalink:"/docs/explanations/connectable",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/connectable.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Connectable Operators",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Combinational Circuits",permalink:"/docs/explanations/combinational-circuits"},next:{title:"Deep Dive into <> and := Connection Operators",permalink:"/docs/explanations/connection-operators"}},d={},r=[{value:"Table of Contents",id:"table-of-contents",level:2},{value:"Terminology",id:"terminology",level:2},{value:"Overview",id:"overview",level:2},{value:"Alignment: Flipped vs Aligned",id:"alignment-flipped-vs-aligned",level:2},{value:"Input/Output",id:"inputoutput",level:2},{value:"Connecting components with fully aligned members",id:"connecting-components-with-fully-aligned-members",level:2},{value:"Mono-direction connection operator (:=)",id:"mono-direction-connection-operator-",level:3},{value:"Connecting components with mixed alignment members",id:"connecting-components-with-mixed-alignment-members",level:2},{value:"Bi-direction connection operator (<code>:&lt;&gt;=</code>)",id:"bi-direction-connection-operator-",level:3},{value:"Port-Direction Computation versus Connection-Direction Computation",id:"port-direction-computation-versus-connection-direction-computation",level:3},{value:"Aligned connection operator (<code>:&lt;=</code>)",id:"aligned-connection-operator-",level:3},{value:"Flipped connection operator (<code>:&gt;=</code>)",id:"flipped-connection-operator-",level:3},{value:"Coercing mono-direction connection operator (<code>:#=</code>)",id:"coercing-mono-direction-connection-operator-",level:3},{value:"Connectable",id:"connectable",level:2},{value:"Connecting Records",id:"connecting-records",level:3},{value:"Defaults with waived connections",id:"defaults-with-waived-connections",level:3},{value:"Connecting types with optional members",id:"connecting-types-with-optional-members",level:3},{value:"Always ignore errors caused by extra members (partial connection operator)",id:"always-ignore-errors-caused-by-extra-members-partial-connection-operator",level:3},{value:"Connecting components with different widths",id:"connecting-components-with-different-widths",level:3},{value:"Excluding members from any operator on a Connectable",id:"excluding-members-from-any-operator-on-a-connectable",level:3},{value:"Techniques for connecting structurally inequivalent Chisel types",id:"techniques-for-connecting-structurally-inequivalent-chisel-types",level:2},{value:"Connecting different sub-types of the same super-type, with colliding names",id:"connecting-different-sub-types-of-the-same-super-type-with-colliding-names",level:3},{value:"Connecting sub-types to super-types by waiving extra members",id:"connecting-sub-types-to-super-types-by-waiving-extra-members",level:3},{value:"Connecting different sub-types",id:"connecting-different-sub-types",level:3},{value:"FAQ",id:"faq",level:2},{value:"How do I connect two items as flexibly as possible (try your best but never error)",id:"how-do-i-connect-two-items-as-flexibly-as-possible-try-your-best-but-never-error",level:3},{value:"How do I connect two items but don&#39;t care about the Scala types being equivalent?",id:"how-do-i-connect-two-items-but-dont-care-about-the-scala-types-being-equivalent",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"table-of-contents",children:"Table of Contents"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#terminology",children:"Terminology"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#overview",children:"Overview"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#alignment-flipped-vs-aligned",children:"Alignment: Flipped vs Aligned"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#inputoutput",children:"Input/Output"})}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"#connecting-components-with-fully-aligned-members",children:"Connecting components with fully aligned members"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#mono-direction-connection-operator-",children:["Mono-direction connection operator (",(0,o.jsx)(n.code,{children:":="}),")"]})}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"#connecting-components-with-mixed-alignment-members",children:"Connecting components with mixed alignment members"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#bi-direction-connection-operator-",children:["Bi-direction connection operator (",(0,o.jsx)(n.code,{children:":<>="}),")"]})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#port-direction-computation-versus-connection-direction-computation",children:"Port-Direction Computation versus Connection-Direction Computation"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#aligned-connection-operator-",children:["Aligned connection operator (",(0,o.jsx)(n.code,{children:":<="}),")"]})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#flipped-connection-operator-",children:["Flipped connection operator (",(0,o.jsx)(n.code,{children:":>="}),")"]})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsxs)(n.a,{href:"#coercing-mono-direction-connection-operator-",children:["Coercing mono-direction connection operator (",(0,o.jsx)(n.code,{children:":#="}),")"]})}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"#connectable",children:"Connectable"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-records",children:"Connecting Records"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#defaults-with-waived-connections",children:"Defaults with waived connections"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-types-with-optional-members",children:"Connecting types with optional members"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#always-ignore-errors-caused-by-extra-members-partial-connection-operator",children:"Always ignore extra members (partial connection operator)"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-components-with-different-widths",children:"Connecting components with different widths"})}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"#techniques-for-connecting-structurally-inequivalent-chisel-types",children:"Techniques for connecting structurally inequivalent Chisel types"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-different-sub-types-of-the-same-super-type-with-colliding-names",children:"Connecting different sub-types of the same super-type, with colliding names"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-sub-types-to-super-types-by-waiving-extra-members",children:"Connecting sub-types to super-types by waiving extra members"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#connecting-different-sub-types",children:"Connecting different sub-types"})}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"#faq",children:"FAQ"})}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"terminology",children:"Terminology"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:['"Chisel type" - a ',(0,o.jsx)(n.code,{children:"Data"})," that is not bound to hardware, i.e. not a component. (more details ",(0,o.jsx)(n.a,{href:"chisel-type-vs-scala-type",children:"here"}),").","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"UInt(3.W)"}),", ",(0,o.jsx)(n.code,{children:"new Bundle {..}"}),", ",(0,o.jsx)(n.code,{children:"Vec(3, SInt(2.W))"})," are all Chisel types"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:['"component" - a ',(0,o.jsx)(n.code,{children:"Data"})," that is bound to hardware (",(0,o.jsx)(n.code,{children:"IO"}),", ",(0,o.jsx)(n.code,{children:"Reg"}),", ",(0,o.jsx)(n.code,{children:"Wire"}),", etc.)","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"Wire(UInt(3.W))"})," is a component, whose Chisel type is ",(0,o.jsx)(n.code,{children:"UInt(3.W)"})]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Aggregate"})," - a Chisel type or component that contains other Chisel types or components (i.e. ",(0,o.jsx)(n.code,{children:"Vec"}),", ",(0,o.jsx)(n.code,{children:"Record"}),", or ",(0,o.jsx)(n.code,{children:"Bundle"}),")"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Element"})," - a Chisel type or component that does not contain other Chisel types or components (e.g. ",(0,o.jsx)(n.code,{children:"UInt"}),", ",(0,o.jsx)(n.code,{children:"SInt"}),", ",(0,o.jsx)(n.code,{children:"Clock"}),", ",(0,o.jsx)(n.code,{children:"Bool"})," etc.)"]}),"\n",(0,o.jsxs)(n.li,{children:['"member" - a Chisel type or component, or any of its children (could be an ',(0,o.jsx)(n.code,{children:"Aggregate"})," or an ",(0,o.jsx)(n.code,{children:"Element"}),")","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"Vec(3, UInt(2.W))(0)"})," is a member of the parent ",(0,o.jsx)(n.code,{children:"Vec"})," Chisel type"]}),"\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"Wire(Vec(3, UInt(2.W)))(0)"})," is a member of the parent ",(0,o.jsx)(n.code,{children:"Wire"})," component"]}),"\n",(0,o.jsxs)(n.li,{children:["E.g. ",(0,o.jsx)(n.code,{children:"IO(Decoupled(Bool)).ready"})," is a member of the parent ",(0,o.jsx)(n.code,{children:"IO"})," component"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:['"relative alignment" - whether two members of the same component or Chisel type are aligned/flipped, relative to one another',"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["see section ",(0,o.jsx)(n.a,{href:"#alignment-flipped-vs-aligned",children:"below"})," for a detailed definition"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:['"structural type check" - Chisel type ',(0,o.jsx)(n.code,{children:"A"})," is structurally equivalent to Chisel type ",(0,o.jsx)(n.code,{children:"B"})," if ",(0,o.jsx)(n.code,{children:"A"})," and ",(0,o.jsx)(n.code,{children:"B"})," have matching bundle field names and types (",(0,o.jsx)(n.code,{children:"Record"})," vs ",(0,o.jsx)(n.code,{children:"Vector"})," vs ",(0,o.jsx)(n.code,{children:"Element"}),"), probe modifiers (probe vs nonprobe), vector sizes, ",(0,o.jsx)(n.code,{children:"Element"})," types (UInt/SInt/Bool/Clock)","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"ignores relative alignment (flippedness)"}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:['"alignment type check" - a Chisel type ',(0,o.jsx)(n.code,{children:"A"})," matches alignment with another Chisel type ",(0,o.jsx)(n.code,{children:"B"})," if every member of ",(0,o.jsx)(n.code,{children:"A"}),"'s relative alignment to ",(0,o.jsx)(n.code,{children:"A"})," is the same as the structurally corresponding member of ",(0,o.jsx)(n.code,{children:"B"}),"'s relative alignment to ",(0,o.jsx)(n.code,{children:"B"}),"."]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"Connectable"})," operators are the standard way to connect Chisel hardware components to one another."]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note: For descriptions of the semantics for the previous operators, see ",(0,o.jsx)(n.a,{href:"connection-operators",children:(0,o.jsx)(n.code,{children:"Connection Operators"})}),"."]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"All connection operators require the two hardware components (consumer and producer) to be structurally type equivalent."}),"\n",(0,o.jsxs)(n.p,{children:["The one exception to the structural type-equivalence rule is using the ",(0,o.jsx)(n.code,{children:"Connectable"})," mechanism, detailed at this ",(0,o.jsx)(n.a,{href:"#techniques-for-connecting-structurally-inequivalent-chisel-types",children:"section"})," towards the end of this document."]}),"\n",(0,o.jsxs)(n.p,{children:["Aggregate (",(0,o.jsx)(n.code,{children:"Record"}),", ",(0,o.jsx)(n.code,{children:"Vec"}),", ",(0,o.jsx)(n.code,{children:"Bundle"}),") Chisel types can include data members which are flipped relative to one another.\nDue to this, there are many desired connection behaviors between two Chisel components.\nThe following are the Chisel connection operators between a consumer ",(0,o.jsx)(n.code,{children:"c"})," and producer ",(0,o.jsx)(n.code,{children:"p"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c := p"})," (mono-direction): connects all ",(0,o.jsx)(n.code,{children:"p"})," members to ",(0,o.jsx)(n.code,{children:"c"}),"; requires ",(0,o.jsx)(n.code,{children:"c"})," and ",(0,o.jsx)(n.code,{children:"p"})," to not have any flipped members"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c :#= p"})," (coercing mono-direction): connects all ",(0,o.jsx)(n.code,{children:"p"})," members to ",(0,o.jsx)(n.code,{children:"c"}),"; regardless of alignment"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c :<= p"})," (aligned-direction): connects all aligned (non-flipped) ",(0,o.jsx)(n.code,{children:"c"})," members from ",(0,o.jsx)(n.code,{children:"p"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c :>= p"})," (flipped-direction): connects all flipped ",(0,o.jsx)(n.code,{children:"p"})," members from ",(0,o.jsx)(n.code,{children:"c"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"c :<>= p"})," (bi-direction operator): connects all aligned ",(0,o.jsx)(n.code,{children:"c"})," members from ",(0,o.jsx)(n.code,{children:"p"}),"; all flipped ",(0,o.jsx)(n.code,{children:"p"})," members from ",(0,o.jsx)(n.code,{children:"c"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"These operators may appear to be a random collection of symbols; however, the characters are consistent between operators and self-describe the semantics of each operator:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:":"})," always indicates the consumer, or left-hand-side, of the operator."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"="})," always indicates the producer, or right-hand-side, of the operator.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c := p"})," connects a consumer (",(0,o.jsx)(n.code,{children:"c"}),") and a producer (",(0,o.jsx)(n.code,{children:"p"}),")."]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"<"})," always indicates that some members will be driven producer-to-consumer, or right-to-left.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c :<= p"})," drives members in producer (",(0,o.jsx)(n.code,{children:"p"}),") to members in consumer (",(0,o.jsx)(n.code,{children:"c"}),")."]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:">"})," always indicates that some signals will be driven consumer-to-producer, or left-to-right.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c :>= p"})," drives members in consumer (",(0,o.jsx)(n.code,{children:"c"}),") to members producer (",(0,o.jsx)(n.code,{children:"p"}),")."]}),"\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c :<>= p"})," both drives members from ",(0,o.jsx)(n.code,{children:"p"})," to ",(0,o.jsx)(n.code,{children:"c"})," and from ",(0,o.jsx)(n.code,{children:"c"})," to ",(0,o.jsx)(n.code,{children:"p"}),"."]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"#"})," always indicates to ignore member alignment and to drive producer-to-consumer, or right-to-left.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Hence, ",(0,o.jsx)(n.code,{children:"c :#= p"})," always drives members from ",(0,o.jsx)(n.code,{children:"p"})," to ",(0,o.jsx)(n.code,{children:"c"})," ignoring direction."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note: in addition, an operator that ends in ",(0,o.jsx)(n.code,{children:"="})," has assignment-precedence, which means that ",(0,o.jsx)(n.code,{children:"x :<>= y + z"})," will translate to ",(0,o.jsx)(n.code,{children:"x :<>= (y + z)"}),", rather than ",(0,o.jsx)(n.code,{children:"(x :<>= y) + z"}),".\nThis was not true of the ",(0,o.jsx)(n.code,{children:"<>"})," operator and was a minor painpoint for users."]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"alignment-flipped-vs-aligned",children:"Alignment: Flipped vs Aligned"}),"\n",(0,o.jsxs)(n.p,{children:["A member's alignment is a relative property: a member is aligned/flipped relative to another member of the same component or Chisel type.\nHence, one must always say whether a member is flipped/aligned ",(0,o.jsx)(n.em,{children:"with respect to (w.r.t)"})," another member of that type (parent, sibling, child etc.)."]}),"\n",(0,o.jsxs)(n.p,{children:["We use the following example of a non-nested bundle ",(0,o.jsx)(n.code,{children:"Parent"})," to let us state all of the alignment relationships between members of ",(0,o.jsx)(n.code,{children:"p"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass Parent extends Bundle {\n  val alignedChild = UInt(32.W)\n  val flippedChild = Flipped(UInt(32.W))\n}\nclass MyModule0 extends Module {\n  val p = Wire(new Parent)\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"First, every member is always aligned with themselves:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.alignedChild"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.flippedChild"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedChild"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Next, we list all parent/child relationships.\nBecause the ",(0,o.jsx)(n.code,{children:"flippedChild"})," field is ",(0,o.jsx)(n.code,{children:"Flipped"}),", it changes its alignment relative to its parent."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedChild"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Finally, we can list all sibling relationships:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.alignedChild"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedChild"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["The next example has a nested bundle ",(0,o.jsx)(n.code,{children:"GrandParent"})," who instantiates an aligned ",(0,o.jsx)(n.code,{children:"Parent"})," field and flipped ",(0,o.jsx)(n.code,{children:"Parent"})," field."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass GrandParent extends Bundle {\n  val alignedParent = new Parent\n  val flippedParent = Flipped(new Parent)\n}\nclass MyModule1 extends Module {\n  val g = Wire(new GrandParent)\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"Consider the following alignments between grandparent and grandchildren.\nAn odd number of flips indicate a flipped relationship; even numbers of flips indicate an aligned relationship."}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"g.flippedParent.flippedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"g.alignedParent.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"g.flippedParent.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"g.alignedParent.flippedChild"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Consider the following alignment relationships starting from ",(0,o.jsx)(n.code,{children:"g.alignedParent"})," and ",(0,o.jsx)(n.code,{children:"g.flippedParent"}),".\n",(0,o.jsxs)(n.em,{children:["Note that whether ",(0,o.jsx)(n.code,{children:"g.alignedParent"})," is aligned/flipped relative to ",(0,o.jsx)(n.code,{children:"g"})," has no effect on the aligned/flipped relationship between ",(0,o.jsx)(n.code,{children:"g.alignedParent"})," and ",(0,o.jsx)(n.code,{children:"g.alignedParent.alignedChild"})," because alignment is only relative to the two members in question!"]}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.alignedParent"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.alignedParent.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.flippedParent"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.flippedParent.alignedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.alignedParent"})," is flipped w.r.t. ",(0,o.jsx)(n.code,{children:"g.alignedParent.flippedChild"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.flippedParent"})," is flipped w.r.t. ",(0,o.jsx)(n.code,{children:"g.flippedParent.flippedChild"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["In summary, a member is aligned or flipped w.r.t. another member of the hardware component.\nThis means that the type of the consumer/producer is the only information needed to determine the behavior of any operator.\n",(0,o.jsx)(n.em,{children:"Whether the consumer/producer is a member of a larger bundle is irrelevant; you ONLY need to know the type of the consumer/producer"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"inputoutput",children:"Input/Output"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Input(gen)"}),"/",(0,o.jsx)(n.code,{children:"Output(gen)"})," are coercing operators.\nThey perform two functions: (1) create a new Chisel type that has all flips removed from all recursive children members (still structurally equivalent to ",(0,o.jsx)(n.code,{children:"gen"})," but no longer alignment type equivalent), and (2) apply ",(0,o.jsx)(n.code,{children:"Flipped"})," if ",(0,o.jsx)(n.code,{children:"Input"}),", keep aligned (do nothing) if ",(0,o.jsx)(n.code,{children:"Output"}),".\nE.g. if we imagine a function called ",(0,o.jsx)(n.code,{children:"cloneChiselTypeButStripAllFlips"}),", then ",(0,o.jsx)(n.code,{children:"Input(gen)"})," is structurally and alignment type equivalent to ",(0,o.jsx)(n.code,{children:"Flipped(cloneChiselTypeButStripAllFlips(gen))"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Note that if ",(0,o.jsx)(n.code,{children:"gen"})," is a non-aggregate, then ",(0,o.jsx)(n.code,{children:"Input(nonAggregateGen)"})," is equivalent to ",(0,o.jsx)(n.code,{children:"Flipped(nonAggregateGen)"}),"."]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Future work will refactor how these primitives are exposed to the user to make Chisel's type system more intuitive.\nSee [",(0,o.jsx)(n.a,{href:"https://github.com/chipsalliance/chisel3/issues/2643",children:"https://github.com/chipsalliance/chisel3/issues/2643"}),"]."]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"With this in mind, we can consider the following examples and detail relative alignments of members."}),"\n",(0,o.jsxs)(n.p,{children:["First, we can use a similar example to ",(0,o.jsx)(n.code,{children:"Parent"})," but use ",(0,o.jsx)(n.code,{children:"Input/Output"})," instead of ",(0,o.jsx)(n.code,{children:"Flipped"}),".\nBecause ",(0,o.jsx)(n.code,{children:"alignedChild"})," and ",(0,o.jsx)(n.code,{children:"flippedChild"})," are non-aggregates, ",(0,o.jsx)(n.code,{children:"Input"})," is basically just a ",(0,o.jsx)(n.code,{children:"Flipped"})," and thus the alignments are unchanged compared to the previous ",(0,o.jsx)(n.code,{children:"Parent"})," example."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass ParentWithOutputInput extends Bundle {\n  val alignedCoerced = Output(UInt(32.W)) // Equivalent to just UInt(32.W)\n  val flippedCoerced = Input(UInt(32.W))  // Equivalent to Flipped(UInt(32.W))\n}\nclass MyModule2 extends Module {\n  val p = Wire(new ParentWithOutputInput)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The alignments are the same as the previous ",(0,o.jsx)(n.code,{children:"Parent"})," example:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.alignedCoerced"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.flippedCoerced"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"p.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"p.alignedCoerced"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"p.flippedCoerced"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["The next example has a nested bundle ",(0,o.jsx)(n.code,{children:"GrandParent"})," who instantiates an ",(0,o.jsx)(n.code,{children:"Output"})," ",(0,o.jsx)(n.code,{children:"ParentWithOutputInput"})," field and an ",(0,o.jsx)(n.code,{children:"Input"})," ",(0,o.jsx)(n.code,{children:"ParentWithOutputInput"})," field."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass GrandParentWithOutputInput extends Bundle {\n  val alignedCoerced = Output(new ParentWithOutputInput)\n  val flippedCoerced = Input(new ParentWithOutputInput)\n}\nclass MyModule3 extends Module {\n  val g = Wire(new GrandParentWithOutputInput)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Remember that ",(0,o.jsx)(n.code,{children:"Output(gen)/Input(gen)"})," recursively strips the ",(0,o.jsx)(n.code,{children:"Flipped"})," of any recursive children.\nThis makes every member of ",(0,o.jsx)(n.code,{children:"gen"})," aligned with every other member of ",(0,o.jsx)(n.code,{children:"gen"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Consider the following alignments between grandparent and grandchildren.\nBecause ",(0,o.jsx)(n.code,{children:"alignedCoerced"})," and ",(0,o.jsx)(n.code,{children:"flippedCoerced"})," are aligned with all their recursive members, they are fully aligned.\nThus, only their alignment to ",(0,o.jsx)(n.code,{children:"g"})," influences grandchildren alignment:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is aligned w.r.t ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.flippedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"g.flippedCoerced.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g"})," is flipped w.r.t ",(0,o.jsx)(n.code,{children:"g.flippedCoerced.flippedCoerced"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Consider the following alignment relationships starting from ",(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," and ",(0,o.jsx)(n.code,{children:"g.flippedCoerced"}),".\n",(0,o.jsxs)(n.em,{children:["Note that whether ",(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," is aligned/flipped relative to ",(0,o.jsx)(n.code,{children:"g"})," has no effect on the aligned/flipped relationship between ",(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," and ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.alignedCoerced"})," or ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.flippedCoerced"})," because alignment is only relative to the two members in question! However, because alignment is coerced, everything is aligned between ",(0,o.jsx)(n.code,{children:"g.alignedCoerced"}),"/",(0,o.jsx)(n.code,{children:"g.flippedAligned"})," and their children"]}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.alignedCoerced"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.alignedCoerced.flippedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.flippedCoerced"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.flippedCoerced.alignedCoerced"})]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"g.flippedCoerced"})," is aligned w.r.t. ",(0,o.jsx)(n.code,{children:"g.flippedCoerced.flippedCoerced"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["In summary, ",(0,o.jsx)(n.code,{children:"Input(gen)"})," and ",(0,o.jsx)(n.code,{children:"Output(gen)"})," recursively coerce children alignment, as well as dictate ",(0,o.jsx)(n.code,{children:"gen"}),"'s alignment to its parent bundle (if it exists)."]}),"\n",(0,o.jsx)(n.h2,{id:"connecting-components-with-fully-aligned-members",children:"Connecting components with fully aligned members"}),"\n",(0,o.jsx)(n.h3,{id:"mono-direction-connection-operator-",children:"Mono-direction connection operator (:=)"}),"\n",(0,o.jsxs)(n.p,{children:["For simple connections where all members are aligned (non-flipped) w.r.t. one another, use ",(0,o.jsx)(n.code,{children:":="}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass FullyAlignedBundle extends Bundle {\n  val a = Bool()\n  val b = Bool()\n}\nclass Example0 extends RawModule {\n  val incoming = IO(Flipped(new FullyAlignedBundle))\n  val outgoing = IO(new FullyAlignedBundle)\n  outgoing := incoming\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where each member of ",(0,o.jsx)(n.code,{children:"incoming"})," drives every member of ",(0,o.jsx)(n.code,{children:"outgoing"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example0(\n  input  incoming_a,\n         incoming_b,\n  output outgoing_a,\n         outgoing_b\n);\n\n  assign outgoing_a = incoming_a;\n  assign outgoing_b = incoming_b;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["You may be thinking \"Wait, I'm confused! Isn't ",(0,o.jsx)(n.code,{children:"incoming"})," flipped and ",(0,o.jsx)(n.code,{children:"outgoing"}),' aligned?" -- Noo! Whether ',(0,o.jsx)(n.code,{children:"incoming"})," is aligned with ",(0,o.jsx)(n.code,{children:"outgoing"})," makes no sense; remember, you only evaluate alignment between members of the same component or Chisel type.\nBecause components are always aligned to themselves, ",(0,o.jsx)(n.code,{children:"outgoing"})," is aligned to ",(0,o.jsx)(n.code,{children:"outgoing"}),", and ",(0,o.jsx)(n.code,{children:"incoming"})," is aligned to ",(0,o.jsx)(n.code,{children:"incoming"}),", there is no problem.\nTheir relative flippedness to anything else is irrelevant."]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"connecting-components-with-mixed-alignment-members",children:"Connecting components with mixed alignment members"}),"\n",(0,o.jsxs)(n.p,{children:["Aggregate Chisel types can include data members which are flipped relative to one another; in the example below, ",(0,o.jsx)(n.code,{children:"alignedChild"})," and ",(0,o.jsx)(n.code,{children:"flippedChild"})," are aligned/flipped relative to ",(0,o.jsx)(n.code,{children:"MixedAlignmentBundle"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nclass MixedAlignmentBundle extends Bundle {\n  val alignedChild = Bool()\n  val flippedChild = Flipped(Bool())\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Due to this, there are many desired connection behaviors between two Chisel components.\nFirst we will introduce the most common Chisel connection operator, ",(0,o.jsx)(n.code,{children:":<>="}),", useful for connecting components with members of mixed-alignments, then take a moment to investigate a common source of confusion between port-direction and connection-direction.\nThen, we will explore the remainder of the Chisel connection operators."]}),"\n",(0,o.jsxs)(n.h3,{id:"bi-direction-connection-operator-",children:["Bi-direction connection operator (",(0,o.jsx)(n.code,{children:":<>="}),")"]}),"\n",(0,o.jsxs)(n.p,{children:["For connections where you want 'bulk-connect-like-semantics' where the aligned members are driven producer-to-consumer and flipped members are driven consumer-to-producer, use ",(0,o.jsx)(n.code,{children:":<>="}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Example1 extends RawModule {\n  val incoming = IO(Flipped(new MixedAlignmentBundle))\n  val outgoing = IO(new MixedAlignmentBundle)\n  outgoing :<>= incoming\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where the aligned members are driven ",(0,o.jsx)(n.code,{children:"incoming"})," to ",(0,o.jsx)(n.code,{children:"outgoing"})," and flipped members are driven ",(0,o.jsx)(n.code,{children:"outgoing"})," to ",(0,o.jsx)(n.code,{children:"incoming"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example1(\n  input  incoming_alignedChild,\n  output incoming_flippedChild,\n         outgoing_alignedChild,\n  input  outgoing_flippedChild\n);\n\n  assign incoming_flippedChild = outgoing_flippedChild;\n  assign outgoing_alignedChild = incoming_alignedChild;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"port-direction-computation-versus-connection-direction-computation",children:"Port-Direction Computation versus Connection-Direction Computation"}),"\n",(0,o.jsxs)(n.p,{children:["A common question is if you use a mixed-alignment connection (such as ",(0,o.jsx)(n.code,{children:":<>="}),") to connect submembers of parent components, does the alignment of the submember to their parent affect anything? The answer is no, because ",(0,o.jsx)(n.em,{children:"alignment is always computed relative to what is being connected to, and members are always aligned with themselves."})]}),"\n",(0,o.jsxs)(n.p,{children:["In the following example connecting from ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," to ",(0,o.jsx)(n.code,{children:"outgoing.alignedChild"}),", whether ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," is aligned with ",(0,o.jsx)(n.code,{children:"incoming"})," is irrelevant because the ",(0,o.jsx)(n.code,{children:":<>="})," only computes alignment relative to the thing being connected to, and ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," is aligned with ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Example1a extends RawModule {\n  val incoming = IO(Flipped(new MixedAlignmentBundle))\n  val outgoing = IO(new MixedAlignmentBundle)\n  outgoing.alignedChild :<>= incoming.alignedChild // whether incoming.alignedChild is aligned/flipped to incoming is IRRELEVANT to what gets connected with :<>=\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"incoming.flippedChild"}),"'s alignment with ",(0,o.jsx)(n.code,{children:"incoming"})," does not affect our operators, it does influence whether ",(0,o.jsx)(n.code,{children:"incoming.flippedChild"})," is an output or input port of my module.\nA common source of confusion is to mistake the process for determining whether ",(0,o.jsx)(n.code,{children:"incoming.flippedChild"})," will resolve to a Verilog ",(0,o.jsx)(n.code,{children:"output"}),"/",(0,o.jsx)(n.code,{children:"input"})," (the port-direction computation) with the process for determining how ",(0,o.jsx)(n.code,{children:":<>="})," drives what with what (the connection-direction computation).\nWhile both processes consider relative alignment, they are distinct."]}),"\n",(0,o.jsxs)(n.p,{children:["The port-direction computation always computes alignment relative to the component marked with ",(0,o.jsx)(n.code,{children:"IO"}),".\nAn ",(0,o.jsx)(n.code,{children:"IO(Flipped(gen))"})," is an incoming port, and any member of ",(0,o.jsx)(n.code,{children:"gen"})," that is aligned/flipped with ",(0,o.jsx)(n.code,{children:"gen"})," is an incoming/outgoing port.\nAn ",(0,o.jsx)(n.code,{children:"IO(gen)"})," is an outgoing port, and any member of ",(0,o.jsx)(n.code,{children:"gen"})," that is aligned/flipped with ",(0,o.jsx)(n.code,{children:"gen"})," is an outgoing/incoming port."]}),"\n",(0,o.jsxs)(n.p,{children:["The connection-direction computation always computes alignment based on the explicit consumer/producer referenced for the connection.\nIf one connects ",(0,o.jsx)(n.code,{children:"incoming :<>= outgoing"}),", alignments are computed based on ",(0,o.jsx)(n.code,{children:"incoming"})," and ",(0,o.jsx)(n.code,{children:"outgoing"}),".\nIf one connects ",(0,o.jsx)(n.code,{children:"incoming.alignedChild :<>= outgoing.alignedChild"}),", then alignments are computed based on ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," and ",(0,o.jsx)(n.code,{children:"outgoing.alignedChild"})," (and the alignment of ",(0,o.jsx)(n.code,{children:"incoming"})," to ",(0,o.jsx)(n.code,{children:"incoming.alignedChild"})," is irrelevant)."]}),"\n",(0,o.jsxs)(n.p,{children:["This means that users can try to connect to input ports of their module! If I write ",(0,o.jsx)(n.code,{children:"x :<>= y"}),", and ",(0,o.jsx)(n.code,{children:"x"})," is an input to the current module, then that is what the connection is trying to do.\nHowever, because input ports are not drivable from within the current module, Chisel will throw an error.\nThis is the same error a user would get using a mono-directioned operator: ",(0,o.jsx)(n.code,{children:"x := y"})," will throw the same error if ",(0,o.jsx)(n.code,{children:"x"})," is an input to the current module.\n",(0,o.jsx)(n.em,{children:"Whether a component is drivable is irrelevant to the semantics of any connection operator attempting to drive to it."})]}),"\n",(0,o.jsxs)(n.p,{children:["In summary, the port-direction computation is relative to the root marked ",(0,o.jsx)(n.code,{children:"IO"}),", but connection-direction computation is relative to the consumer/producer that the connection is doing.\nThis has the positive property that connection semantics are solely based on the Chisel structural type and its relative alignments of the consumer/producer (nothing more, nothing less)."]}),"\n",(0,o.jsxs)(n.h3,{id:"aligned-connection-operator-",children:["Aligned connection operator (",(0,o.jsx)(n.code,{children:":<="}),")"]}),"\n",(0,o.jsxs)(n.p,{children:["For connections where you want the aligned-half of 'bulk-connect-like-semantics' where the aligned members are driven producer-to-consumer and flipped members are ignored, use ",(0,o.jsx)(n.code,{children:":<="}),' (the "aligned connection").']}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Example2 extends RawModule {\n  val incoming = IO(Flipped(new MixedAlignmentBundle))\n  val outgoing = IO(new MixedAlignmentBundle)\n  incoming.flippedChild := DontCare // Otherwise FIRRTL throws an uninitialization error\n  outgoing :<= incoming\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where the aligned members are driven ",(0,o.jsx)(n.code,{children:"incoming"})," to ",(0,o.jsx)(n.code,{children:"outgoing"})," and flipped members are ignored:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example2(\n  input  incoming_alignedChild,\n  output incoming_flippedChild,\n         outgoing_alignedChild,\n  input  outgoing_flippedChild\n);\n\n  assign incoming_flippedChild = 1'h0;\n  assign outgoing_alignedChild = incoming_alignedChild;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.h3,{id:"flipped-connection-operator-",children:["Flipped connection operator (",(0,o.jsx)(n.code,{children:":>="}),")"]}),"\n",(0,o.jsxs)(n.p,{children:["For connections where you want the flipped-half of 'bulk-connect-like-semantics' where the aligned members are ignored and flipped members are connected consumer-to-producer, use ",(0,o.jsx)(n.code,{children:":>="}),' (the "flipped connection", or "backpressure connection").']}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class Example3 extends RawModule {\n  val incoming = IO(Flipped(new MixedAlignmentBundle))\n  val outgoing = IO(new MixedAlignmentBundle)\n  outgoing.alignedChild := DontCare // Otherwise FIRRTL throws an uninitialization error\n  outgoing :>= incoming\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where the aligned members are ignored and the flipped members are driven ",(0,o.jsx)(n.code,{children:"outgoing"})," to ",(0,o.jsx)(n.code,{children:"incoming"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example3(\n  input  incoming_alignedChild,\n  output incoming_flippedChild,\n         outgoing_alignedChild,\n  input  outgoing_flippedChild\n);\n\n  assign incoming_flippedChild = outgoing_flippedChild;\n  assign outgoing_alignedChild = 1'h0;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note: Astute observers will realize that ",(0,o.jsx)(n.code,{children:"c :<>= p"})," is semantically equivalent to ",(0,o.jsx)(n.code,{children:"c :<= p"})," followed by ",(0,o.jsx)(n.code,{children:"c :>= p"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.h3,{id:"coercing-mono-direction-connection-operator-",children:["Coercing mono-direction connection operator (",(0,o.jsx)(n.code,{children:":#="}),")"]}),"\n",(0,o.jsxs)(n.p,{children:["For connections where you want to every producer member to always drive every consumer member, regardless of alignment, use ",(0,o.jsx)(n.code,{children:":#="}),' (the "coercion connection").\nThis operator is useful for initializing wires whose types contain members of mixed alignment.']}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.BundleLiterals._\nclass Example4 extends RawModule {\n  val w = Wire(new MixedAlignmentBundle)\n  dontTouch(w) // So we see it in the output Verilog\n  w :#= (new MixedAlignmentBundle).Lit(_.alignedChild -> true.B, _.flippedChild -> true.B)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where all members are driven from the literal to ",(0,o.jsx)(n.code,{children:"w"}),", regardless of alignment:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example4();\n  wire w_alignedChild = 1'h1;\n  wire w_flippedChild = 1'h1;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note: Astute observers will realize that ",(0,o.jsx)(n.code,{children:"c :#= p"})," is semantically equivalent to ",(0,o.jsx)(n.code,{children:"c :<= p"})," followed by ",(0,o.jsx)(n.code,{children:"p :>= c"})," (note ",(0,o.jsx)(n.code,{children:"p"})," and ",(0,o.jsx)(n.code,{children:"c"})," switched places in the second connection)."]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Another use case for ",(0,o.jsx)(n.code,{children:":#="})," is for connecting a mixed-directional bundle to a fully-aligned monitor."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.BundleLiterals._\nclass Example4b extends RawModule {\n  val monitor = IO(Output(new MixedAlignmentBundle))\n  val w = Wire(new MixedAlignmentBundle)\n  dontTouch(w) // So we see it in the output Verilog\n  w :#= DontCare\n  monitor :#= w\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where all members are driven from the literal to ",(0,o.jsx)(n.code,{children:"w"}),", regardless of alignment:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example4b(\n  output monitor_alignedChild,\n         monitor_flippedChild\n);\n\n  wire w_alignedChild = 1'h0;\n  wire w_flippedChild = 1'h0;\n  assign monitor_alignedChild = w_alignedChild;\n  assign monitor_flippedChild = w_flippedChild;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"connectable",children:"Connectable"}),"\n",(0,o.jsxs)(n.p,{children:["Sometimes a user wants to connect Chisel components which are not type equivalent.\nFor example, a user may want to hook up anonymous ",(0,o.jsx)(n.code,{children:"Record"})," components who may have an intersection of their fields being equivalent, but cannot because they are not structurally equivalent.\nAlternatively, one may want to connect two types that have different widths."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Connectable"})," is the mechanism to specialize connection operator behavior in these scenarios.\nFor additional members which are not present in the other component being connected to, or for mismatched widths, or for always excluding a member from being connected to, they can be explicitly called out from the ",(0,o.jsx)(n.code,{children:"Connectable"})," object, rather than trigger an error."]}),"\n",(0,o.jsxs)(n.p,{children:["In addition, there are other techniques that can be used to address similar use cases including ",(0,o.jsx)(n.code,{children:".viewAsSuperType"}),", a static cast to a supertype (e.g. ",(0,o.jsx)(n.code,{children:"(x: T)"}),"), or creating a custom ",(0,o.jsx)(n.code,{children:"DataView"}),".\nFor a discussion about when to use each technique, please continue ",(0,o.jsx)(n.a,{href:"#techniques-for-connecting-structurally-inequivalent-chisel-types",children:"here"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["This section demonstrates how ",(0,o.jsx)(n.code,{children:"Connectable"})," specifically can be used in a multitude of scenarios."]}),"\n",(0,o.jsx)(n.h3,{id:"connecting-records",children:"Connecting Records"}),"\n",(0,o.jsxs)(n.p,{children:["One use case is to try to connect two ",(0,o.jsx)(n.code,{children:"Record"}),"s; for matching members, they should be connected, but for unmatched members, the errors caused due to them being unmatched should be ignored.\nTo accomplish this, use the other operators to initialize all ",(0,o.jsx)(n.code,{children:"Record"})," members, then use ",(0,o.jsx)(n.code,{children:":<>="})," with ",(0,o.jsx)(n.code,{children:".waive"})," to connect only the matching members."]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note that none of ",(0,o.jsx)(n.code,{children:".viewAsSuperType"}),", static casts, nor a custom ",(0,o.jsx)(n.code,{children:"DataView"})," helps this case because the Scala types are still ",(0,o.jsx)(n.code,{children:"Record"}),"."]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import scala.collection.immutable.SeqMap\n\nclass Example9 extends RawModule {\n  val abType = new Record { val elements = SeqMap("a" -> Bool(), "b" -> Flipped(Bool())) }\n  val bcType = new Record { val elements = SeqMap("b" -> Flipped(Bool()), "c" -> Bool()) }\n\n  val p = IO(Flipped(abType))\n  val c = IO(bcType)\n\n  DontCare :>= p\n  c :<= DontCare\n\n  c.waive(_.elements("c")):<>= p.waive(_.elements("a"))\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"p.b"})," is driven from ",(0,o.jsx)(n.code,{children:"c.b"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example9(\n  output p_b,\n  input  p_a,\n  output c_c,\n  input  c_b\n);\n\n  assign p_b = c_b;\n  assign c_c = 1'h0;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"defaults-with-waived-connections",children:"Defaults with waived connections"}),"\n",(0,o.jsxs)(n.p,{children:["Another use case is to try to connect two ",(0,o.jsx)(n.code,{children:"Record"}),"s; for matching members, they should be connected, but for unmatched members, ",(0,o.jsx)(n.em,{children:"they should be connected to a default value"}),".\nTo accomplish this, use the other operators to initialize all ",(0,o.jsx)(n.code,{children:"Record"})," members, then use ",(0,o.jsx)(n.code,{children:":<>="})," with ",(0,o.jsx)(n.code,{children:".waive"})," to connect only the matching members."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:'import scala.collection.immutable.SeqMap\n\nclass Example10 extends RawModule {\n  val abType = new Record { val elements = SeqMap("a" -> Bool(), "b" -> Flipped(Bool())) }\n  val bcType = new Record { val elements = SeqMap("b" -> Flipped(Bool()), "c" -> Bool()) }\n\n  val p = Wire(abType)\n  val c = Wire(bcType)\n\n  dontTouch(p) // So it doesn\'t get constant-propped away for the example\n  dontTouch(c) // So it doesn\'t get constant-propped away for the example\n\n  p :#= abType.Lit(_.elements("a") -> true.B, _.elements("b") -> true.B)\n  c :#= bcType.Lit(_.elements("b") -> true.B, _.elements("c") -> true.B)\n\n  c.waive(_.elements("c")) :<>= p.waive(_.elements("a"))\n}\n'})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"p.b"})," is driven from ",(0,o.jsx)(n.code,{children:"c.b"}),", and ",(0,o.jsx)(n.code,{children:"p.a"}),", ",(0,o.jsx)(n.code,{children:"c.b"}),", and ",(0,o.jsx)(n.code,{children:"c.c"})," are initialized to default values:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example10();\n  wire p_a = 1'h1;\n  wire c_c = 1'h1;\n  wire c_b = 1'h1;\n  wire p_b = c_b;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"connecting-types-with-optional-members",children:"Connecting types with optional members"}),"\n",(0,o.jsxs)(n.p,{children:["In the following example, we can use ",(0,o.jsx)(n.code,{children:":<>="})," and ",(0,o.jsx)(n.code,{children:".waive"})," to connect two ",(0,o.jsx)(n.code,{children:"MyDecoupledOpts"}),"'s, where only one has a ",(0,o.jsx)(n.code,{children:"bits"})," member."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class MyDecoupledOpt(hasBits: Boolean) extends Bundle {\n  val valid = Bool()\n  val ready = Flipped(Bool())\n  val bits = if (hasBits) Some(UInt(32.W)) else None\n}\nclass Example6 extends RawModule {\n  val in  = IO(Flipped(new MyDecoupledOpt(true)))\n  val out = IO(new MyDecoupledOpt(false))\n  out :<>= in.waive(_.bits.get) // We can know to call .get because we can inspect in.bits.isEmpty\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"ready"})," and ",(0,o.jsx)(n.code,{children:"valid"})," are connected, and ",(0,o.jsx)(n.code,{children:"bits"})," is ignored:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example6(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"always-ignore-errors-caused-by-extra-members-partial-connection-operator",children:"Always ignore errors caused by extra members (partial connection operator)"}),"\n",(0,o.jsx)(n.p,{children:"The most unsafe connection is to connect only members that are present in both consumer and producer, and ignore all other members.\nThis is unsafe because this connection will never error on any Chisel types."}),"\n",(0,o.jsxs)(n.p,{children:["To do this, you can use ",(0,o.jsx)(n.code,{children:".waiveAll"})," and static cast to ",(0,o.jsx)(n.code,{children:"Data"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class OnlyA extends Bundle {\n  val a = UInt(32.W)\n}\nclass OnlyB extends Bundle {\n  val b = UInt(32.W)\n}\nclass Example11 extends RawModule {\n  val in  = IO(Flipped(new OnlyA))\n  val out = IO(new OnlyB)\n\n  out := DontCare\n\n  (out: Data).waiveAll :<>= (in: Data).waiveAll\n}\n"})}),"\n",(0,o.jsx)(n.p,{children:"This generates the following Verilog, where nothing is connected:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example11(\n  input  [31:0] in_a,\n  output [31:0] out_b\n);\n\n  assign out_b = 32'h0;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"connecting-components-with-different-widths",children:"Connecting components with different widths"}),"\n",(0,o.jsxs)(n.p,{children:["Non-",(0,o.jsx)(n.code,{children:"Connectable"})," operators implicitly truncate if a component with a larger width is connected to a component with a smaller width.\n",(0,o.jsx)(n.code,{children:"Connectable"})," operators disallow this implicit truncation behavior and require the driven component to be equal or larger in width that the sourcing component."]}),"\n",(0,o.jsxs)(n.p,{children:["If implicit truncation behavior is desired, then ",(0,o.jsx)(n.code,{children:"Connectable"})," provides a ",(0,o.jsx)(n.code,{children:"squeeze"})," mechanism which will allow the connection to continue with implicit truncation."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import scala.collection.immutable.SeqMap\n\nclass Example14 extends RawModule {\n  val p = IO(Flipped(UInt(4.W)))\n  val c = IO(UInt(3.W))\n\n  c :<>= p.squeeze\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"p"})," is truncated prior to driving ",(0,o.jsx)(n.code,{children:"c"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example14(\n  input  [3:0] p,\n  output [2:0] c\n);\n\n  assign c = p[2:0];\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"excluding-members-from-any-operator-on-a-connectable",children:"Excluding members from any operator on a Connectable"}),"\n",(0,o.jsxs)(n.p,{children:["If a user wants to always exclude a field from a connect, use the ",(0,o.jsx)(n.code,{children:".exclude"})," mechanism which will never connect the field (as if it didn't exist to the connection)."]}),"\n",(0,o.jsxs)(n.p,{children:["Note that if a field matches in both producer and consumer, but only one is excluded, the other non-excluded field will still trigger an error; to fix this, use either ",(0,o.jsx)(n.code,{children:".waive"})," or ",(0,o.jsx)(n.code,{children:".exclude"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import scala.collection.immutable.SeqMap\n\nclass BundleWithSpecialField extends Bundle {\n  val foo = UInt(3.W)\n  val special = Bool()\n}\nclass Example15 extends RawModule {\n  val p = IO(Flipped(new BundleWithSpecialField()))\n  val c = IO(new BundleWithSpecialField())\n\n  c.special := true.B // must initialize it\n\n  c.exclude(_.special) :<>= p.exclude(_.special)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where the ",(0,o.jsx)(n.code,{children:"special"})," field is not connected:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example15(\n  input  [2:0] p_foo,\n  input        p_special,\n  output [2:0] c_foo,\n  output       c_special\n);\n\n  assign c_foo = p_foo;\n  assign c_special = 1'h1;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"techniques-for-connecting-structurally-inequivalent-chisel-types",children:"Techniques for connecting structurally inequivalent Chisel types"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"DataView"})," and ",(0,o.jsx)(n.code,{children:".viewAsSupertype"})," create a view of the component that has a different Chisel type.\nThis means that a user can first create a ",(0,o.jsx)(n.code,{children:"DataView"})," of the consumer or producer (or both) so that the Chisel types are structurally equivalent.\nThis is useful when the difference between the consumer and producer aren't super nested, and also if they have rich Scala types which encode their structure.\nIn general, ",(0,o.jsx)(n.code,{children:"DataView"})," is the preferred mechanism to use (if you can) because it maintains the most amount of Chisel information in the Scala type, but there are many instances where it doesn't work and thus one must fall back on ",(0,o.jsx)(n.code,{children:"Connectable"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Connectable"})," does not change the Chisel type, but instead changes the semantics of the operator to not error on the waived members if they are dangling or unconnected.\nThis is useful for when differences between the consumer and producer do not show up in the Scala type system (e.g. present/missing fields of type ",(0,o.jsx)(n.code,{children:"Option[Data]"}),", or anonymous ",(0,o.jsx)(n.code,{children:"Record"}),"s) or are deeply nested in a bundle that is especially onerous to create a ",(0,o.jsx)(n.code,{children:"DataView"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Static casts (e.g. ",(0,o.jsx)(n.code,{children:"(x: T)"}),") allows connecting components that have different Scala types, but leaves the Chisel type unchanged.\nUse this to force a connection to occur, even if the Scala types are different."]}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsx)(n.p,{children:'One may wonder why the operators require identical Scala types in the first place, if they can easily be bypassed.\nThe reason is to encourage users to use the Scala type system to encode Chisel information as it can make their code more robust; however, we don\'t want to be draconian about it because there are times when we want to enable the user to "just connect the darn thing".'}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"When all else fails one can always manually expand the connection to do what they want to happen, member by member.\nThe down-side to this approach is its verbosity and that adding new members to a component will require updating the manual connections."}),"\n",(0,o.jsxs)(n.p,{children:["Things to remember about ",(0,o.jsx)(n.code,{children:"Connectable"})," vs ",(0,o.jsx)(n.code,{children:".viewAsSupertype"}),"/",(0,o.jsx)(n.code,{children:"DataView"})," vs static cast (e.g. ",(0,o.jsx)(n.code,{children:"(x: T)"}),"):"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"DataView"})," and ",(0,o.jsx)(n.code,{children:".viewAsSupertype"})," will preemptively remove members that are not present in the new view which has a different Chisel type, thus ",(0,o.jsx)(n.code,{children:"DataView"})," ",(0,o.jsx)(n.em,{children:"does"})," affect what is connected"]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Connectable"})," can be used to waive the error on members who end up being dangling or unconnected.\nImportantly, ",(0,o.jsx)(n.code,{children:"Connectable"})," waives ",(0,o.jsx)(n.em,{children:"do not"})," affect what is connected"]}),"\n",(0,o.jsxs)(n.li,{children:["Static cast does not remove extra members, thus a static cast ",(0,o.jsx)(n.em,{children:"does not"})," affect what is connected"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"connecting-different-sub-types-of-the-same-super-type-with-colliding-names",children:"Connecting different sub-types of the same super-type, with colliding names"}),"\n",(0,o.jsxs)(n.p,{children:["In these examples, we are connecting ",(0,o.jsx)(n.code,{children:"MyDecoupled"})," with ",(0,o.jsx)(n.code,{children:"MyDecoupledOtherBits"}),".\nBoth are subtypes of ",(0,o.jsx)(n.code,{children:"MyReadyValid"}),", and both have a ",(0,o.jsx)(n.code,{children:"bits"})," field of type ",(0,o.jsx)(n.code,{children:"UInt(32.W)"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["The first example will use ",(0,o.jsx)(n.code,{children:".viewAsSupertype"})," to connect them as ",(0,o.jsx)(n.code,{children:"MyReadyValid"}),".\nBecause it changes the Chisel type to omit both ",(0,o.jsx)(n.code,{children:"bits"})," fields, the ",(0,o.jsx)(n.code,{children:"bits"})," fields are unconnected."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import experimental.dataview._\nclass MyDecoupledOtherBits extends MyReadyValid {\n  val bits = UInt(32.W)\n}\nclass Example12 extends RawModule {\n  val in  = IO(Flipped(new MyDecoupled))\n  val out = IO(new MyDecoupledOtherBits)\n\n  out := DontCare\n\n  out.viewAsSupertype(new MyReadyValid) :<>= in.viewAsSupertype(new MyReadyValid)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that the ",(0,o.jsx)(n.code,{children:"bits"})," fields are unconnected."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example12(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready,\n  output [31:0] out_bits\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\n  assign out_bits = 32'h0;\nendmodule\n\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The second example will use a static cast and ",(0,o.jsx)(n.code,{children:".waive(_.bits)"})," to connect them as ",(0,o.jsx)(n.code,{children:"MyReadyValid"}),".\nNote that because the static cast does not change the Chisel type, the connection finds that both consumer and producer have a ",(0,o.jsx)(n.code,{children:"bits"})," field.\nThis means that since they are structurally equivalent, they match and are connected.\nThe ",(0,o.jsx)(n.code,{children:"waive(_.bits)"})," does nothing, because the ",(0,o.jsx)(n.code,{children:"bits"})," are neither dangling nor unconnected."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"import experimental.dataview._\nclass Example13 extends RawModule {\n  val in  = IO(Flipped(new MyDecoupled))\n  val out = IO(new MyDecoupledOtherBits)\n\n  out := DontCare\n\n  out.waiveAs[MyReadyValid](_.bits) :<>= in.waiveAs[MyReadyValid](_.bits)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Note that the ",(0,o.jsx)(n.code,{children:"bits"})," fields ARE connected, even though they are waived, as ",(0,o.jsx)(n.code,{children:".waive"})," just changes whether an error should be thrown if they are missing, NOT to not connect them if they are structurally equivalent.\nTo always omit the connection, use ",(0,o.jsx)(n.code,{children:".exclude"})," on one side and either ",(0,o.jsx)(n.code,{children:".exclude"})," or ",(0,o.jsx)(n.code,{children:".waive"})," on the other side."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example13(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready,\n  output [31:0] out_bits\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\n  assign out_bits = in_bits;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"connecting-sub-types-to-super-types-by-waiving-extra-members",children:"Connecting sub-types to super-types by waiving extra members"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note that in this example, it would be better to use ",(0,o.jsx)(n.code,{children:".viewAsSupertype"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["In the following example, we can use ",(0,o.jsx)(n.code,{children:":<>="})," to connect a ",(0,o.jsx)(n.code,{children:"MyReadyValid"})," to a ",(0,o.jsx)(n.code,{children:"MyDecoupled"})," by waiving the ",(0,o.jsx)(n.code,{children:"bits"})," member."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class MyReadyValid extends Bundle {\n  val valid = Bool()\n  val ready = Flipped(Bool())\n}\nclass MyDecoupled extends MyReadyValid {\n  val bits = UInt(32.W)\n}\nclass Example5 extends RawModule {\n  val in  = IO(Flipped(new MyDecoupled))\n  val out = IO(new MyReadyValid)\n  out :<>= in.waiveAs[MyReadyValid](_.bits)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"ready"})," and ",(0,o.jsx)(n.code,{children:"valid"})," are connected, and ",(0,o.jsx)(n.code,{children:"bits"})," is ignored:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example5(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h3,{id:"connecting-different-sub-types",children:"Connecting different sub-types"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:["Note that in this example, it would be better to use ",(0,o.jsx)(n.code,{children:".viewAsSupertype"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Note that the connection operator requires the ",(0,o.jsx)(n.code,{children:"consumer"})," and ",(0,o.jsx)(n.code,{children:"producer"})," to be the same Scala type to encourage capturing more information statically, but they can always be cast to ",(0,o.jsx)(n.code,{children:"Data"})," or another common supertype prior to connecting."]}),"\n",(0,o.jsxs)(n.p,{children:["In the following example, we can use ",(0,o.jsx)(n.code,{children:":<>="})," and ",(0,o.jsx)(n.code,{children:".waiveAs"})," to connect two different sub-types of ",(0,o.jsx)(n.code,{children:"MyReadyValid"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class HasBits extends MyReadyValid {\n  val bits = UInt(32.W)\n}\nclass HasEcho extends MyReadyValid {\n  val echo = Flipped(UInt(32.W))\n}\nclass Example7 extends RawModule {\n  val in  = IO(Flipped(new HasBits))\n  val out = IO(new HasEcho)\n  out.waiveAs[MyReadyValid](_.echo) :<>= in.waiveAs[MyReadyValid](_.bits)\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["This generates the following Verilog, where ",(0,o.jsx)(n.code,{children:"ready"})," and ",(0,o.jsx)(n.code,{children:"valid"})," are connected, and ",(0,o.jsx)(n.code,{children:"bits"})," and ",(0,o.jsx)(n.code,{children:"echo"})," are ignored:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example7(\n  input         in_valid,\n  output        in_ready,\n  input  [31:0] in_bits,\n  output        out_valid,\n  input         out_ready,\n  input  [31:0] out_echo\n);\n\n  assign in_ready = out_ready;\n  assign out_valid = in_valid;\nendmodule\n\n"})}),"\n",(0,o.jsx)(n.h2,{id:"faq",children:"FAQ"}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-connect-two-items-as-flexibly-as-possible-try-your-best-but-never-error",children:"How do I connect two items as flexibly as possible (try your best but never error)"}),"\n",(0,o.jsxs)(n.p,{children:["Use ",(0,o.jsx)(n.code,{children:".unsafe"})," (both waives and allows squeezing of all fields)."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class ExampleUnsafe extends RawModule {\n  val in  = IO(Flipped(new Bundle { val foo = Bool(); val bar = Bool() }))\n  val out = IO(new Bundle { val baz = Bool(); val bar = Bool() })\n  out.unsafe :<>= in.unsafe // bar is connected, and nothing errors\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"how-do-i-connect-two-items-but-dont-care-about-the-scala-types-being-equivalent",children:"How do I connect two items but don't care about the Scala types being equivalent?"}),"\n",(0,o.jsxs)(n.p,{children:["Use ",(0,o.jsx)(n.code,{children:".as"})," (upcasts the Scala type)."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-scala",children:"class ExampleAs extends RawModule {\n  val in  = IO(Flipped(new Bundle { val foo = Bool(); val bar = Bool() }))\n  val out = IO(new Bundle { val foo = Bool(); val bar = Bool() })\n  // foo and bar are connected, although Scala types aren't the same\n  out.as[Data] :<>= in.as[Data]\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>s});var o=i(6540);const l={},t=o.createContext(l);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d50fb5c7.3da5f25c.js b/assets/js/d50fb5c7.3da5f25c.js
deleted file mode 100644
index 9039e43f48..0000000000
--- a/assets/js/d50fb5c7.3da5f25c.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[1281],{9536:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>c,frontMatter:()=>s,metadata:()=>l,toc:()=>u});var t=a(4848),i=a(8453);const s={layout:"docs",title:"Naming",section:"chisel3"},o="Naming",l={id:"explanations/naming",title:"Naming",description:"Historically, Chisel has had trouble reliably capturing the names of signals. The reasons for this are due to (1)",source:"@site/docs/explanations/naming.md",sourceDirName:"explanations",slug:"/explanations/naming",permalink:"/docs/explanations/naming",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/naming.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Naming",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Muxes and Input Selection",permalink:"/docs/explanations/muxes-and-input-selection"},next:{title:"Operators",permalink:"/docs/explanations/operators"}},r={},u=[{value:"Compiler Plugin",id:"compiler-plugin",level:3},{value:"Prefixing",id:"prefixing",level:3},{value:"Suggest a Signal&#39;s Name (or the instance name of a Module)",id:"suggest-a-signals-name-or-the-instance-name-of-a-module",level:3},{value:"Behavior for &quot;Unnamed signals&quot; (aka &quot;Temporaries&quot;)",id:"behavior-for-unnamed-signals-aka-temporaries",level:3},{value:"Set a Module Name",id:"set-a-module-name",level:3}];function d(e){const n={a:"a",code:"code",em:"em",h1:"h1",h3:"h3",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"naming",children:"Naming"})}),"\n",(0,t.jsxs)(n.p,{children:["Historically, Chisel has had trouble reliably capturing the names of signals. The reasons for this are due to (1)\nprimarily relying on reflection to find names, (2) using ",(0,t.jsx)(n.code,{children:"@chiselName"})," macro which had unreliable behavior."]}),"\n",(0,t.jsx)(n.p,{children:"Chisel 3.4 introduced a custom Scala compiler plugin which enables reliabe and automatic capturing of signal names, when\nthey are declared. In addition, this release includes prolific use of a new prefixing API which enables more stable\nnaming of signals programmatically generated from function calls."}),"\n",(0,t.jsxs)(n.p,{children:["This document explains how naming now works in Chisel for signal and module names. For cookbook examples on how to fix\nsystemic name-stability issues, please refer to the naming ",(0,t.jsx)(n.a,{href:"../cookbooks/naming",children:"cookbook"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"compiler-plugin",children:"Compiler Plugin"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"// Imports used by the following examples\nimport chisel3._\nimport chisel3.experimental.{prefix, noPrefix}\n"})}),"\n",(0,t.jsx)(n.p,{children:"Chisel users must also include the compiler plugin in their build settings.\nIn SBT this is something like:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'// For chisel versions 5.0.0+\naddCompilerPlugin("org.chipsalliance" % "chisel-plugin" % "5.0.0" cross CrossVersion.full)\n// For older chisel3 versions, eg. 3.6.0\naddCompilerPlugin("edu.berkeley.cs" % "chisel3-plugin" % "3.6.0" cross CrossVersion.full)\n'})}),"\n",(0,t.jsxs)(n.p,{children:["This plugin will run after the 'typer' phase of the Scala compiler. It looks for any user code which is of the form\n",(0,t.jsx)(n.code,{children:"val x = y"}),", where ",(0,t.jsx)(n.code,{children:"x"})," is of type ",(0,t.jsx)(n.code,{children:"chisel3.Data"}),", ",(0,t.jsx)(n.code,{children:"chisel3.MemBase"}),", or ",(0,t.jsx)(n.code,{children:"chisel3.experimental.BaseModule"}),". For each\nline which fits this criteria, it rewrites that line. In the following examples, the commented line is the what the\nline above is rewritten to."]}),"\n",(0,t.jsxs)(n.p,{children:["If the line is within a bundle declaration or is a module instantiation, it is rewritten to replace the right hand\nside with a call to ",(0,t.jsx)(n.code,{children:"autoNameRecursively"}),", which names the signal/module."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class MyBundle extends Bundle {\n  val foo = Input(UInt(3.W))\n  // val foo = autoNameRecursively("foo")(Input(UInt(3.W)))\n}\nclass Example1 extends Module {\n  val io = IO(new MyBundle())\n  // val io = autoNameRecursively("io")(IO(new MyBundle()))\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example1(\n  input       clock,\n              reset,\n  input [2:0] io_foo\n);\n\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.p,{children:"Otherwise, it is rewritten to also include the name as a prefix to any signals generated while executing the right-hand-\nside of the val declaration:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example2 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  // val in = autoNameRecursively("in")(prefix("in")(IO(Input(UInt(2.W)))))\n\n  val out1 = IO(Output(UInt(4.W)))\n  // val out1 = autoNameRecursively("out1")(prefix("out1")(IO(Output(UInt(4.W)))))\n  val out2 = IO(Output(UInt(4.W)))\n  // val out2 = autoNameRecursively("out2")(prefix("out2")(IO(Output(UInt(4.W)))))\n  val out3 = IO(Output(UInt(4.W)))\n  // val out3 = autoNameRecursively("out3")(prefix("out3")(IO(Output(UInt(4.W)))))\n\n  def func() = {\n    val squared = in * in\n    // val squared = autoNameRecursively("squared")(prefix("squared")(in * in))\n    out1 := squared\n    val delay = RegNext(squared)\n    // val delay = autoNameRecursively("delay")(prefix("delay")(RegNext(squared)))\n    delay\n  }\n\n  val masked = 0xa.U & func()\n  // val masked = autoNameRecursively("masked")(prefix("masked")(0xa.U & func()))\n  // Note that values created inside of `func()`` are prefixed with `masked`\n\n  out2 := masked + 1.U\n  out3 := masked - 1.U\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example2(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out1,\n               out2,\n               out3\n);\n\n  wire [3:0] _GEN = {2'h0, in};\n  wire [3:0] masked_squared = _GEN * _GEN;\n  reg  [3:0] masked_delay;\n  wire [3:0] masked = masked_delay & 4'hA;\n  always @(posedge clock)\n    masked_delay <= masked_squared;\n  assign out1 = masked_squared;\n  assign out2 = masked + 4'h1;\n  assign out3 = masked - 4'h1;\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.p,{children:"Prefixing can also be derived from the name of signals on the left-hand side of a connection.\nWhile this is not implemented via the compiler plugin, the behavior should feel similar:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class ConnectPrefixing extends Module {\n  val in = IO(Input(UInt(2.W)))\n  // val in = autoNameRecursively("in")(prefix("in")(IO(Input(UInt(2.W)))))\n\n  val out1 = IO(Output(UInt(4.W)))\n  // val out1 = autoNameRecursively("out1")(prefix("out1")(IO(Output(UInt(4.W)))))\n  val out2 = IO(Output(UInt(4.W)))\n  // val out2 = autoNameRecursively("out2")(prefix("out2")(IO(Output(UInt(4.W)))))\n\n  out1 := { // technically this is not wrapped in autoNameRecursively nor prefix\n    // But the Chisel runtime will still use the name of `out1` as a prefix\n    val squared = in * in\n    out2 := squared\n    val delayed = RegNext(squared)\n    // val delayed = autoNameRecursively("delayed")(prefix("delayed")(RegNext(squared)))\n    delayed + 1.U\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule ConnectPrefixing(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out1,\n               out2\n);\n\n  wire [3:0] _GEN = {2'h0, in};\n  wire [3:0] out1_squared = _GEN * _GEN;\n  reg  [3:0] out1_delayed;\n  always @(posedge clock)\n    out1_delayed <= out1_squared;\n  assign out1 = out1_delayed + 4'h1;\n  assign out2 = out1_squared;\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that the naming also works if the hardware type is nested in an ",(0,t.jsx)(n.code,{children:"Option"})," or a subtype of ",(0,t.jsx)(n.code,{children:"Iterable"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example3 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  // val in = autoNameRecursively("in")(prefix("in")(IO(Input(UInt(2.W)))))\n\n  val out = IO(Output(UInt(4.W)))\n  // val out = autoNameRecursively("out")(prefix("out")(IO(Output(UInt(4.W)))))\n\n  def func() = {\n    val delay = RegNext(in)\n    delay + 1.U\n  }\n\n  val opt = Some(func())\n  // Note that the register in func() is prefixed with `opt`:\n  // val opt = autoNameRecursively("opt")(prefix("opt")(Some(func()))\n\n  out := opt.get + 1.U\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example3(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out\n);\n\n  reg [1:0] opt_delay;\n  always @(posedge clock)\n    opt_delay <= in;\n  assign out = {2'h0, opt_delay - 2'h2};\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["There is also a slight variant (",(0,t.jsx)(n.code,{children:"autoNameRecursivelyProduct"}),") for naming hardware with names provided by an unapply:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class UnapplyExample extends Module {\n  def mkIO() = (IO(Input(UInt(2.W))), IO(Output(UInt(2.W))))\n  val (in, out) = mkIO()\n  // val (in, out) = autoNameRecursivelyProduct(List(Some("in"), Some("out")))(mkIO())\n\n  out := in\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule UnapplyExample(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [1:0] out\n);\n\n  assign out = in;\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that the compiler plugin will not insert a prefix in these cases because it is ambiguous what the prefix should be.\nUsers who desire a prefix are encouraged to provide one as ",(0,t.jsx)(n.a,{href:"#prefixing",children:"described below"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"prefixing",children:"Prefixing"}),"\n",(0,t.jsxs)(n.p,{children:["As shown above, the compiler plugin automatically attempts to prefix some of your signals for you.\nHowever, you as a user can also add your own prefixes by calling ",(0,t.jsx)(n.code,{children:"prefix(...)"}),":"]}),"\n",(0,t.jsx)(n.p,{children:"Also note that the prefixes append to each other (including the prefix generated by the compiler plugin):"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example6 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  val out = IO(Output(UInt(4.W)))\n\n  val add = prefix("foo") {\n    val sum = RegNext(in + 1.U)\n    sum + 1.U\n  }\n\n  out := add\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example6(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out\n);\n\n  reg [1:0] add_foo_sum;\n  always @(posedge clock)\n    add_foo_sum <= in + 2'h1;\n  assign out = {2'h0, add_foo_sum + 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Sometimes you may want to disable the prefixing. This might occur if you are writing a library function and\ndon't want the prefixing behavior. In this case, you can call ",(0,t.jsx)(n.code,{children:"noPrefix"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class Example7 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  val out = IO(Output(UInt(4.W)))\n\n  val add = noPrefix {\n    val sum = RegNext(in + 1.U)\n    sum + 1.U\n  }\n\n  out := add\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example7(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out\n);\n\n  reg [1:0] sum;\n  always @(posedge clock)\n    sum <= in + 2'h1;\n  assign out = {2'h0, sum + 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"suggest-a-signals-name-or-the-instance-name-of-a-module",children:"Suggest a Signal's Name (or the instance name of a Module)"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to specify the name of a signal, you can always use the ",(0,t.jsx)(n.code,{children:".suggestName"})," API. Please note that the suggested\nname will still be prefixed (including by the plugin). You can always use the ",(0,t.jsx)(n.code,{children:"noPrefix"})," object to strip this."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example8 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  val out = IO(Output(UInt(4.W)))\n\n  val add = {\n    val sum = RegNext(in + 1.U).suggestName("foo")\n    sum + 1.U\n  }\n\n  out := add\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule Example8(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out\n);\n\n  reg [1:0] add_foo;\n  always @(posedge clock)\n    add_foo <= in + 2'h1;\n  assign out = {2'h0, add_foo + 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that using ",(0,t.jsx)(n.code,{children:".suggestName"})," does ",(0,t.jsx)(n.strong,{children:"not"})," affect prefixes derived from val names;\nhowever, it ",(0,t.jsx)(n.em,{children:"can"})," affect prefixes derived from connections (eg. ",(0,t.jsx)(n.code,{children:":="}),"):"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class ConnectionPrefixExample extends Module {\n  val in0 = IO(Input(UInt(2.W)))\n  val in1 = IO(Input(UInt(2.W)))\n\n  val out0 = {\n    val port = IO(Output(UInt(5.W)))\n    // Even though this suggestName is before mul, the prefix used in this scope\n    // is derived from `val out0`, so this does not affect the name of mul\n    port.suggestName("foo")\n    // out0_mul\n    val mul = RegNext(in0 * in1)\n    port := mul + 1.U\n    port\n  }\n\n  val out1 = IO(Output(UInt(4.W)))\n  val out2 = IO(Output(UInt(4.W)))\n\n  out1 := {\n    // out1_sum\n    val sum = RegNext(in0 + in1)\n    sum + 1.U\n  }\n  // Comes after so does *not* affect prefix above\n  out1.suggestName("bar")\n\n  // Comes before so *does* affect prefix below\n  out2.suggestName("fizz")\n  out2 := {\n    // fizz_diff\n    val diff = RegNext(in0 - in1)\n    diff + 1.U\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule ConnectionPrefixExample(\n  input        clock,\n               reset,\n  input  [1:0] in0,\n               in1,\n  output [4:0] foo,\n  output [3:0] bar,\n               fizz\n);\n\n  reg [3:0] out0_mul;\n  reg [1:0] out1_sum;\n  reg [1:0] fizz_diff;\n  always @(posedge clock) begin\n    out0_mul <= {2'h0, in0} * {2'h0, in1};\n    out1_sum <= in0 + in1;\n    fizz_diff <= in0 - in1;\n  end // always @(posedge)\n  assign foo = {1'h0, out0_mul + 4'h1};\n  assign bar = {2'h0, out1_sum + 2'h1};\n  assign fizz = {2'h0, fizz_diff + 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.p,{children:"As this example illustrates, this behavior is slightly inconsistent so is subject to change in a future version of Chisel."}),"\n",(0,t.jsx)(n.h3,{id:"behavior-for-unnamed-signals-aka-temporaries",children:'Behavior for "Unnamed signals" (aka "Temporaries")'}),"\n",(0,t.jsxs)(n.p,{children:["If you want to signify that the name of a signal does not matter, you can prefix the name of your val with ",(0,t.jsx)(n.code,{children:"_"}),".\nChisel will preserve the convention of leading ",(0,t.jsx)(n.code,{children:"_"})," signifying an unnamed signal across prefixes.\nFor example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class TemporaryExample extends Module {\n  val in0 = IO(Input(UInt(2.W)))\n  val in1 = IO(Input(UInt(2.W)))\n\n  val out = {\n    // We need 2 ports so firtool will maintain the common subexpression\n    val port0 = IO(Output(UInt(4.W)))\n    // out_port1\n    val port1 = IO(Output(UInt(4.W)))\n    val _sum = in0 + in1\n    port0 := _sum + 1.U\n    port1 := _sum - 1.U\n    // port0 is returned so will get the name "out"\n    port0\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule TemporaryExample(\n  input        clock,\n               reset,\n  input  [1:0] in0,\n               in1,\n  output [3:0] out,\n               out_port1\n);\n\n  wire [1:0] _out_sum_T = in0 + in1;\n  assign out = {2'h0, _out_sum_T + 2'h1};\n  assign out_port1 = {2'h0, _out_sum_T - 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["If an unnamed signal is itself used to generate a prefix, the leading ",(0,t.jsx)(n.code,{children:"_"})," will be ignored to avoid double ",(0,t.jsx)(n.code,{children:"__"})," in the names of further nested signals."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class TemporaryPrefixExample extends Module {\n  val in0 = IO(Input(UInt(2.W)))\n  val in1 = IO(Input(UInt(2.W)))\n  val out0 = IO(Output(UInt(3.W)))\n  val out1 = IO(Output(UInt(4.W)))\n\n  val _sum = {\n    val x = in0 + in1\n    out0 := x\n    x + 1.U\n  }\n  out1 := _sum & 0x2.U\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule TemporaryPrefixExample(\n  input        clock,\n               reset,\n  input  [1:0] in0,\n               in1,\n  output [2:0] out0,\n  output [3:0] out1\n);\n\n  wire [1:0] _sum_x_T = in0 + in1;\n  assign out0 = {1'h0, _sum_x_T};\n  assign out1 = {2'h0, _sum_x_T + 2'h1 & 2'h2};\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"set-a-module-name",children:"Set a Module Name"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to specify the module's name (not the instance name of a module), you can always override the ",(0,t.jsx)(n.code,{children:"desiredName"}),"\nvalue. Note that you can parameterize the name by the module's parameters. This is an excellent way to make your module\nnames more stable and is highly recommended to do."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example9(width: Int) extends Module {\n  override val desiredName = s"EXAMPLE9WITHWIDTH$width"\n  val in = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt((width + 2).W)))\n\n  val add = (in + (in + in).suggestName("foo"))\n\n  out := add\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule EXAMPLE9WITHWIDTH8(\n  input        clock,\n               reset,\n  input  [7:0] in,\n  output [9:0] out\n);\n\n  assign out = {2'h0, in + {in[6:0], 1'h0}};\nendmodule\n\n// Generated by CIRCT firtool-1.99.2\nmodule EXAMPLE9WITHWIDTH1(\n  input        clock,\n               reset,\n               in,\n  output [2:0] out\n);\n\n  assign out = {2'h0, in};\nendmodule\n\n"})})]})}function c(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var t=a(6540);const i={},s=t.createContext(i);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d50fb5c7.99b64109.js b/assets/js/d50fb5c7.99b64109.js
new file mode 100644
index 0000000000..ce81c109fa
--- /dev/null
+++ b/assets/js/d50fb5c7.99b64109.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[1281],{9536:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>c,frontMatter:()=>s,metadata:()=>l,toc:()=>u});var t=a(4848),i=a(8453);const s={layout:"docs",title:"Naming",section:"chisel3"},o="Naming",l={id:"explanations/naming",title:"Naming",description:"Historically, Chisel has had trouble reliably capturing the names of signals. The reasons for this are due to (1)",source:"@site/docs/explanations/naming.md",sourceDirName:"explanations",slug:"/explanations/naming",permalink:"/docs/explanations/naming",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/naming.md",tags:[],version:"current",frontMatter:{layout:"docs",title:"Naming",section:"chisel3"},sidebar:"chiselSidebar",previous:{title:"Muxes and Input Selection",permalink:"/docs/explanations/muxes-and-input-selection"},next:{title:"Operators",permalink:"/docs/explanations/operators"}},r={},u=[{value:"Compiler Plugin",id:"compiler-plugin",level:3},{value:"Prefixing",id:"prefixing",level:3},{value:"Suggest a Signal&#39;s Name (or the instance name of a Module)",id:"suggest-a-signals-name-or-the-instance-name-of-a-module",level:3},{value:"Behavior for &quot;Unnamed signals&quot; (aka &quot;Temporaries&quot;)",id:"behavior-for-unnamed-signals-aka-temporaries",level:3},{value:"Set a Module Name",id:"set-a-module-name",level:3}];function d(e){const n={a:"a",code:"code",em:"em",h1:"h1",h3:"h3",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"naming",children:"Naming"})}),"\n",(0,t.jsxs)(n.p,{children:["Historically, Chisel has had trouble reliably capturing the names of signals. The reasons for this are due to (1)\nprimarily relying on reflection to find names, (2) using ",(0,t.jsx)(n.code,{children:"@chiselName"})," macro which had unreliable behavior."]}),"\n",(0,t.jsx)(n.p,{children:"Chisel 3.4 introduced a custom Scala compiler plugin which enables reliabe and automatic capturing of signal names, when\nthey are declared. In addition, this release includes prolific use of a new prefixing API which enables more stable\nnaming of signals programmatically generated from function calls."}),"\n",(0,t.jsxs)(n.p,{children:["This document explains how naming now works in Chisel for signal and module names. For cookbook examples on how to fix\nsystemic name-stability issues, please refer to the naming ",(0,t.jsx)(n.a,{href:"../cookbooks/naming",children:"cookbook"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"compiler-plugin",children:"Compiler Plugin"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"// Imports used by the following examples\nimport chisel3._\nimport chisel3.experimental.{prefix, noPrefix}\n"})}),"\n",(0,t.jsx)(n.p,{children:"Chisel users must also include the compiler plugin in their build settings.\nIn SBT this is something like:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'// For chisel versions 5.0.0+\naddCompilerPlugin("org.chipsalliance" % "chisel-plugin" % "5.0.0" cross CrossVersion.full)\n// For older chisel3 versions, eg. 3.6.0\naddCompilerPlugin("edu.berkeley.cs" % "chisel3-plugin" % "3.6.0" cross CrossVersion.full)\n'})}),"\n",(0,t.jsxs)(n.p,{children:["This plugin will run after the 'typer' phase of the Scala compiler. It looks for any user code which is of the form\n",(0,t.jsx)(n.code,{children:"val x = y"}),", where ",(0,t.jsx)(n.code,{children:"x"})," is of type ",(0,t.jsx)(n.code,{children:"chisel3.Data"}),", ",(0,t.jsx)(n.code,{children:"chisel3.MemBase"}),", or ",(0,t.jsx)(n.code,{children:"chisel3.experimental.BaseModule"}),". For each\nline which fits this criteria, it rewrites that line. In the following examples, the commented line is the what the\nline above is rewritten to."]}),"\n",(0,t.jsxs)(n.p,{children:["If the line is within a bundle declaration or is a module instantiation, it is rewritten to replace the right hand\nside with a call to ",(0,t.jsx)(n.code,{children:"autoNameRecursively"}),", which names the signal/module."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class MyBundle extends Bundle {\n  val foo = Input(UInt(3.W))\n  // val foo = autoNameRecursively("foo")(Input(UInt(3.W)))\n}\nclass Example1 extends Module {\n  val io = IO(new MyBundle())\n  // val io = autoNameRecursively("io")(IO(new MyBundle()))\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example1(\n  input       clock,\n              reset,\n  input [2:0] io_foo\n);\n\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.p,{children:"Otherwise, it is rewritten to also include the name as a prefix to any signals generated while executing the right-hand-\nside of the val declaration:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example2 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  // val in = autoNameRecursively("in")(prefix("in")(IO(Input(UInt(2.W)))))\n\n  val out1 = IO(Output(UInt(4.W)))\n  // val out1 = autoNameRecursively("out1")(prefix("out1")(IO(Output(UInt(4.W)))))\n  val out2 = IO(Output(UInt(4.W)))\n  // val out2 = autoNameRecursively("out2")(prefix("out2")(IO(Output(UInt(4.W)))))\n  val out3 = IO(Output(UInt(4.W)))\n  // val out3 = autoNameRecursively("out3")(prefix("out3")(IO(Output(UInt(4.W)))))\n\n  def func() = {\n    val squared = in * in\n    // val squared = autoNameRecursively("squared")(prefix("squared")(in * in))\n    out1 := squared\n    val delay = RegNext(squared)\n    // val delay = autoNameRecursively("delay")(prefix("delay")(RegNext(squared)))\n    delay\n  }\n\n  val masked = 0xa.U & func()\n  // val masked = autoNameRecursively("masked")(prefix("masked")(0xa.U & func()))\n  // Note that values created inside of `func()`` are prefixed with `masked`\n\n  out2 := masked + 1.U\n  out3 := masked - 1.U\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example2(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out1,\n               out2,\n               out3\n);\n\n  wire [3:0] _GEN = {2'h0, in};\n  wire [3:0] masked_squared = _GEN * _GEN;\n  reg  [3:0] masked_delay;\n  wire [3:0] masked = masked_delay & 4'hA;\n  always @(posedge clock)\n    masked_delay <= masked_squared;\n  assign out1 = masked_squared;\n  assign out2 = masked + 4'h1;\n  assign out3 = masked - 4'h1;\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.p,{children:"Prefixing can also be derived from the name of signals on the left-hand side of a connection.\nWhile this is not implemented via the compiler plugin, the behavior should feel similar:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class ConnectPrefixing extends Module {\n  val in = IO(Input(UInt(2.W)))\n  // val in = autoNameRecursively("in")(prefix("in")(IO(Input(UInt(2.W)))))\n\n  val out1 = IO(Output(UInt(4.W)))\n  // val out1 = autoNameRecursively("out1")(prefix("out1")(IO(Output(UInt(4.W)))))\n  val out2 = IO(Output(UInt(4.W)))\n  // val out2 = autoNameRecursively("out2")(prefix("out2")(IO(Output(UInt(4.W)))))\n\n  out1 := { // technically this is not wrapped in autoNameRecursively nor prefix\n    // But the Chisel runtime will still use the name of `out1` as a prefix\n    val squared = in * in\n    out2 := squared\n    val delayed = RegNext(squared)\n    // val delayed = autoNameRecursively("delayed")(prefix("delayed")(RegNext(squared)))\n    delayed + 1.U\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule ConnectPrefixing(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out1,\n               out2\n);\n\n  wire [3:0] _GEN = {2'h0, in};\n  wire [3:0] out1_squared = _GEN * _GEN;\n  reg  [3:0] out1_delayed;\n  always @(posedge clock)\n    out1_delayed <= out1_squared;\n  assign out1 = out1_delayed + 4'h1;\n  assign out2 = out1_squared;\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that the naming also works if the hardware type is nested in an ",(0,t.jsx)(n.code,{children:"Option"})," or a subtype of ",(0,t.jsx)(n.code,{children:"Iterable"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example3 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  // val in = autoNameRecursively("in")(prefix("in")(IO(Input(UInt(2.W)))))\n\n  val out = IO(Output(UInt(4.W)))\n  // val out = autoNameRecursively("out")(prefix("out")(IO(Output(UInt(4.W)))))\n\n  def func() = {\n    val delay = RegNext(in)\n    delay + 1.U\n  }\n\n  val opt = Some(func())\n  // Note that the register in func() is prefixed with `opt`:\n  // val opt = autoNameRecursively("opt")(prefix("opt")(Some(func()))\n\n  out := opt.get + 1.U\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example3(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out\n);\n\n  reg [1:0] opt_delay;\n  always @(posedge clock)\n    opt_delay <= in;\n  assign out = {2'h0, opt_delay - 2'h2};\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["There is also a slight variant (",(0,t.jsx)(n.code,{children:"autoNameRecursivelyProduct"}),") for naming hardware with names provided by an unapply:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class UnapplyExample extends Module {\n  def mkIO() = (IO(Input(UInt(2.W))), IO(Output(UInt(2.W))))\n  val (in, out) = mkIO()\n  // val (in, out) = autoNameRecursivelyProduct(List(Some("in"), Some("out")))(mkIO())\n\n  out := in\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule UnapplyExample(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [1:0] out\n);\n\n  assign out = in;\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that the compiler plugin will not insert a prefix in these cases because it is ambiguous what the prefix should be.\nUsers who desire a prefix are encouraged to provide one as ",(0,t.jsx)(n.a,{href:"#prefixing",children:"described below"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"prefixing",children:"Prefixing"}),"\n",(0,t.jsxs)(n.p,{children:["As shown above, the compiler plugin automatically attempts to prefix some of your signals for you.\nHowever, you as a user can also add your own prefixes by calling ",(0,t.jsx)(n.code,{children:"prefix(...)"}),":"]}),"\n",(0,t.jsx)(n.p,{children:"Also note that the prefixes append to each other (including the prefix generated by the compiler plugin):"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example6 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  val out = IO(Output(UInt(4.W)))\n\n  val add = prefix("foo") {\n    val sum = RegNext(in + 1.U)\n    sum + 1.U\n  }\n\n  out := add\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example6(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out\n);\n\n  reg [1:0] add_foo_sum;\n  always @(posedge clock)\n    add_foo_sum <= in + 2'h1;\n  assign out = {2'h0, add_foo_sum + 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Sometimes you may want to disable the prefixing. This might occur if you are writing a library function and\ndon't want the prefixing behavior. In this case, you can call ",(0,t.jsx)(n.code,{children:"noPrefix"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class Example7 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  val out = IO(Output(UInt(4.W)))\n\n  val add = noPrefix {\n    val sum = RegNext(in + 1.U)\n    sum + 1.U\n  }\n\n  out := add\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example7(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out\n);\n\n  reg [1:0] sum;\n  always @(posedge clock)\n    sum <= in + 2'h1;\n  assign out = {2'h0, sum + 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"suggest-a-signals-name-or-the-instance-name-of-a-module",children:"Suggest a Signal's Name (or the instance name of a Module)"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to specify the name of a signal, you can always use the ",(0,t.jsx)(n.code,{children:".suggestName"})," API. Please note that the suggested\nname will still be prefixed (including by the plugin). You can always use the ",(0,t.jsx)(n.code,{children:"noPrefix"})," object to strip this."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example8 extends Module {\n  val in = IO(Input(UInt(2.W)))\n  val out = IO(Output(UInt(4.W)))\n\n  val add = {\n    val sum = RegNext(in + 1.U).suggestName("foo")\n    sum + 1.U\n  }\n\n  out := add\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule Example8(\n  input        clock,\n               reset,\n  input  [1:0] in,\n  output [3:0] out\n);\n\n  reg [1:0] add_foo;\n  always @(posedge clock)\n    add_foo <= in + 2'h1;\n  assign out = {2'h0, add_foo + 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that using ",(0,t.jsx)(n.code,{children:".suggestName"})," does ",(0,t.jsx)(n.strong,{children:"not"})," affect prefixes derived from val names;\nhowever, it ",(0,t.jsx)(n.em,{children:"can"})," affect prefixes derived from connections (eg. ",(0,t.jsx)(n.code,{children:":="}),"):"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class ConnectionPrefixExample extends Module {\n  val in0 = IO(Input(UInt(2.W)))\n  val in1 = IO(Input(UInt(2.W)))\n\n  val out0 = {\n    val port = IO(Output(UInt(5.W)))\n    // Even though this suggestName is before mul, the prefix used in this scope\n    // is derived from `val out0`, so this does not affect the name of mul\n    port.suggestName("foo")\n    // out0_mul\n    val mul = RegNext(in0 * in1)\n    port := mul + 1.U\n    port\n  }\n\n  val out1 = IO(Output(UInt(4.W)))\n  val out2 = IO(Output(UInt(4.W)))\n\n  out1 := {\n    // out1_sum\n    val sum = RegNext(in0 + in1)\n    sum + 1.U\n  }\n  // Comes after so does *not* affect prefix above\n  out1.suggestName("bar")\n\n  // Comes before so *does* affect prefix below\n  out2.suggestName("fizz")\n  out2 := {\n    // fizz_diff\n    val diff = RegNext(in0 - in1)\n    diff + 1.U\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule ConnectionPrefixExample(\n  input        clock,\n               reset,\n  input  [1:0] in0,\n               in1,\n  output [4:0] foo,\n  output [3:0] bar,\n               fizz\n);\n\n  reg [3:0] out0_mul;\n  reg [1:0] out1_sum;\n  reg [1:0] fizz_diff;\n  always @(posedge clock) begin\n    out0_mul <= {2'h0, in0} * {2'h0, in1};\n    out1_sum <= in0 + in1;\n    fizz_diff <= in0 - in1;\n  end // always @(posedge)\n  assign foo = {1'h0, out0_mul + 4'h1};\n  assign bar = {2'h0, out1_sum + 2'h1};\n  assign fizz = {2'h0, fizz_diff + 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.p,{children:"As this example illustrates, this behavior is slightly inconsistent so is subject to change in a future version of Chisel."}),"\n",(0,t.jsx)(n.h3,{id:"behavior-for-unnamed-signals-aka-temporaries",children:'Behavior for "Unnamed signals" (aka "Temporaries")'}),"\n",(0,t.jsxs)(n.p,{children:["If you want to signify that the name of a signal does not matter, you can prefix the name of your val with ",(0,t.jsx)(n.code,{children:"_"}),".\nChisel will preserve the convention of leading ",(0,t.jsx)(n.code,{children:"_"})," signifying an unnamed signal across prefixes.\nFor example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class TemporaryExample extends Module {\n  val in0 = IO(Input(UInt(2.W)))\n  val in1 = IO(Input(UInt(2.W)))\n\n  val out = {\n    // We need 2 ports so firtool will maintain the common subexpression\n    val port0 = IO(Output(UInt(4.W)))\n    // out_port1\n    val port1 = IO(Output(UInt(4.W)))\n    val _sum = in0 + in1\n    port0 := _sum + 1.U\n    port1 := _sum - 1.U\n    // port0 is returned so will get the name "out"\n    port0\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule TemporaryExample(\n  input        clock,\n               reset,\n  input  [1:0] in0,\n               in1,\n  output [3:0] out,\n               out_port1\n);\n\n  wire [1:0] _out_sum_T = in0 + in1;\n  assign out = {2'h0, _out_sum_T + 2'h1};\n  assign out_port1 = {2'h0, _out_sum_T - 2'h1};\nendmodule\n\n"})}),"\n",(0,t.jsxs)(n.p,{children:["If an unnamed signal is itself used to generate a prefix, the leading ",(0,t.jsx)(n.code,{children:"_"})," will be ignored to avoid double ",(0,t.jsx)(n.code,{children:"__"})," in the names of further nested signals."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class TemporaryPrefixExample extends Module {\n  val in0 = IO(Input(UInt(2.W)))\n  val in1 = IO(Input(UInt(2.W)))\n  val out0 = IO(Output(UInt(3.W)))\n  val out1 = IO(Output(UInt(4.W)))\n\n  val _sum = {\n    val x = in0 + in1\n    out0 := x\n    x + 1.U\n  }\n  out1 := _sum & 0x2.U\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule TemporaryPrefixExample(\n  input        clock,\n               reset,\n  input  [1:0] in0,\n               in1,\n  output [2:0] out0,\n  output [3:0] out1\n);\n\n  wire [1:0] _sum_x_T = in0 + in1;\n  assign out0 = {1'h0, _sum_x_T};\n  assign out1 = {2'h0, _sum_x_T + 2'h1 & 2'h2};\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"set-a-module-name",children:"Set a Module Name"}),"\n",(0,t.jsxs)(n.p,{children:["If you want to specify the module's name (not the instance name of a module), you can always override the ",(0,t.jsx)(n.code,{children:"desiredName"}),"\nvalue. Note that you can parameterize the name by the module's parameters. This is an excellent way to make your module\nnames more stable and is highly recommended to do."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'class Example9(width: Int) extends Module {\n  override val desiredName = s"EXAMPLE9WITHWIDTH$width"\n  val in = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt((width + 2).W)))\n\n  val add = (in + (in + in).suggestName("foo"))\n\n  out := add\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule EXAMPLE9WITHWIDTH8(\n  input        clock,\n               reset,\n  input  [7:0] in,\n  output [9:0] out\n);\n\n  assign out = {2'h0, in + {in[6:0], 1'h0}};\nendmodule\n\n// Generated by CIRCT firtool-1.100.0\nmodule EXAMPLE9WITHWIDTH1(\n  input        clock,\n               reset,\n               in,\n  output [2:0] out\n);\n\n  assign out = {2'h0, in};\nendmodule\n\n"})})]})}function c(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var t=a(6540);const i={},s=t.createContext(i);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f10ce86b.4ffec15d.js b/assets/js/f10ce86b.4ffec15d.js
new file mode 100644
index 0000000000..49b261a9a7
--- /dev/null
+++ b/assets/js/f10ce86b.4ffec15d.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[2012],{8415:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var t=a(4848),o=a(8453),i=a(1871);const s={sidebar_position:3},r="DataView Cookbook",l={id:"cookbooks/dataview",title:"DataView Cookbook",description:"How do I view a Data as a UInt or vice versa?",source:"@site/docs/cookbooks/dataview.md",sourceDirName:"cookbooks",slug:"/cookbooks/dataview",permalink:"/docs/cookbooks/dataview",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/dataview.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"chiselSidebar",previous:{title:"Hierarchy Cookbook",permalink:"/docs/cookbooks/hierarchy"},next:{title:"Serialization Cookbook",permalink:"/docs/cookbooks/serialization"}},c={},d=[{value:"How do I view a Data as a UInt or vice versa?",id:"how-do-i-view-a-data-as-a-uint-or-vice-versa",level:2},{value:"How do I create a DataView for a Bundle has a type parameter?",id:"how-do-i-create-a-dataview-for-a-bundle-has-a-type-parameter",level:2},{value:"How do I create a DataView for a Bundle with optional fields?",id:"how-do-i-create-a-dataview-for-a-bundle-with-optional-fields",level:2},{value:"How do I connect a subset of Bundle fields?",id:"how-do-i-connect-a-subset-of-bundle-fields",level:2},{value:"How do I view a Bundle as a parent type (superclass)?",id:"how-do-i-view-a-bundle-as-a-parent-type-superclass",level:3},{value:"How do I view a Bundle as a parent type when the parent type is abstract (like a trait)?",id:"how-do-i-view-a-bundle-as-a-parent-type-when-the-parent-type-is-abstract-like-a-trait",level:3},{value:"How can I use <code>.viewAs</code> instead of <code>.viewAsSupertype(type)</code>?",id:"how-can-i-use-viewas-instead-of-viewassupertypetype",level:3}];function u(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"dataview-cookbook",children:"DataView Cookbook"})}),"\n","\n",(0,t.jsx)(i.A,{toc:d}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-view-a-data-as-a-uint-or-vice-versa",children:"How do I view a Data as a UInt or vice versa?"}),"\n",(0,t.jsxs)(n.p,{children:["Subword viewing (using concatenations or bit extractions in ",(0,t.jsx)(n.code,{children:"DataViews"}),") is not yet supported.\nWe intend to implement this in the future, but for the time being, use regular casts\n(",(0,t.jsx)(n.code,{children:".asUInt"})," and ",(0,t.jsx)(n.code,{children:".asTypeOf"}),")."]}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-create-a-dataview-for-a-bundle-has-a-type-parameter",children:"How do I create a DataView for a Bundle has a type parameter?"}),"\n",(0,t.jsxs)(n.p,{children:["Instead of using a ",(0,t.jsx)(n.code,{children:"val"}),", use a ",(0,t.jsx)(n.code,{children:"def"})," which can have type parameters:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\nclass Foo[T <: Data](val foo: T) extends Bundle\nclass Bar[T <: Data](val bar: T) extends Bundle\n\nobject Foo {\n  implicit def view[T <: Data]: DataView[Foo[T], Bar[T]] = {\n    DataView(f => new Bar(f.foo.cloneType), _.foo -> _.bar)\n    // .cloneType is necessary because the f passed to this function will be bound hardware\n  }\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["If you think about type parameterized classes as really being a family of different classes\n(one for each type parameter), you can think about the ",(0,t.jsx)(n.code,{children:"implicit def"})," as a generator of ",(0,t.jsx)(n.code,{children:"DataViews"}),"\nfor each type parameter."]}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-create-a-dataview-for-a-bundle-with-optional-fields",children:"How do I create a DataView for a Bundle with optional fields?"}),"\n",(0,t.jsxs)(n.p,{children:["Instead of using the default ",(0,t.jsx)(n.code,{children:"DataView"})," apply method, use ",(0,t.jsx)(n.code,{children:"DataView.mapping"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\nclass Foo(val w: Option[Int]) extends Bundle {\n  val foo = UInt(8.W)\n  val opt = w.map(x => UInt(x.W))\n}\nclass Bar(val w: Option[Int]) extends Bundle {\n  val bar = UInt(8.W)\n  val opt = w.map(x => UInt(x.W))\n}\n\nobject Foo {\n  implicit val view: DataView[Foo, Bar] =\n    DataView.mapping(\n      // First argument is always the function to make the view from the target\n      f => new Bar(f.w),\n      // Now instead of a varargs of tuples of individual mappings, we have a single function that\n      // takes a target and a view and returns an Iterable of tuple\n      (f, b) =>  List(f.foo -> b.bar) ++ f.opt.map(_ -> b.opt.get)\n                                   // ^ Note that we can append options since they are Iterable!\n\n    )\n}\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-connect-a-subset-of-bundle-fields",children:"How do I connect a subset of Bundle fields?"}),"\n",(0,t.jsxs)(n.p,{children:['Chisel 3 requires types to match exactly for connections.\nDataView provides a mechanism for "viewing" one ',(0,t.jsx)(n.code,{children:"Bundle"})," object as if it were the type of another,\nwhich allows them to be connected."]}),"\n",(0,t.jsx)(n.h3,{id:"how-do-i-view-a-bundle-as-a-parent-type-superclass",children:"How do I view a Bundle as a parent type (superclass)?"}),"\n",(0,t.jsxs)(n.p,{children:["For viewing ",(0,t.jsx)(n.code,{children:"Bundles"})," as the type of the parent, it is as simple as using ",(0,t.jsx)(n.code,{children:"viewAsSupertype"})," and providing a\ntemplate object of the parent type:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\nclass Foo extends Bundle {\n  val foo = UInt(8.W)\n}\nclass Bar extends Foo {\n  val bar = UInt(8.W)\n}\nclass MyModule extends Module {\n  val foo = IO(Input(new Foo))\n  val bar = IO(Output(new Bar))\n  bar.viewAsSupertype(new Foo) := foo // bar.foo := foo.foo\n  bar.bar := 123.U           // all fields need to be connected\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule MyModule(\n  input        clock,\n               reset,\n  input  [7:0] foo_foo,\n  output [7:0] bar_foo,\n               bar_bar\n);\n\n  assign bar_foo = foo_foo;\n  assign bar_bar = 8'h7B;\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"how-do-i-view-a-bundle-as-a-parent-type-when-the-parent-type-is-abstract-like-a-trait",children:"How do I view a Bundle as a parent type when the parent type is abstract (like a trait)?"}),"\n",(0,t.jsxs)(n.p,{children:["Given the following ",(0,t.jsx)(n.code,{children:"Bundles"})," that share a common ",(0,t.jsx)(n.code,{children:"trait"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\ntrait Super extends Bundle {\n  def bitwidth: Int\n  val a = UInt(bitwidth.W)\n}\nclass Foo(val bitwidth: Int) extends Super {\n  val foo = UInt(8.W)\n}\nclass Bar(val bitwidth: Int) extends Super {\n  val bar = UInt(8.W)\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Foo"})," and ",(0,t.jsx)(n.code,{children:"Bar"})," cannot be connected directly, but they could be connected by viewing them both as if\nthey were instances of their common supertype, ",(0,t.jsx)(n.code,{children:"Super"}),".\nA straightforward approach might run into an issue like the following:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class MyModule extends Module {\n  val foo = IO(Input(new Foo(8)))\n  val bar = IO(Output(new Bar(8)))\n  bar.viewAsSupertype(new Super) := foo.viewAsSupertype(new Super)\n}\n// error: trait Super is abstract; cannot be instantiated\n//   bar.viewAsSupertype(new Super) := foo.viewAsSupertype(new Super)\n//                       ^^^^^^^^^\n// error: trait Super is abstract; cannot be instantiated\n//   bar.viewAsSupertype(new Super) := foo.viewAsSupertype(new Super)\n//                                                         ^^^^^^^^^\n"})}),"\n",(0,t.jsxs)(n.p,{children:["The problem is that ",(0,t.jsx)(n.code,{children:"viewAs"})," requires an object to use as a type template (so that it can be cloned),\nbut ",(0,t.jsx)(n.code,{children:"traits"})," are abstract and cannot be instantiated.\nThe solution is to create an instance of an ",(0,t.jsx)(n.em,{children:"anonymous class"})," and use that object as the argument to ",(0,t.jsx)(n.code,{children:"viewAs"}),".\nWe can do this like so:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class MyModule extends Module {\n  val foo = IO(Input(new Foo(8)))\n  val bar = IO(Output(new Bar(8)))\n  val tpe = new Super { // Adding curly braces creates an anonymous class\n    def bitwidth = 8 // We must implement any abstract methods\n  }\n  bar.viewAsSupertype(tpe) := foo.viewAsSupertype(tpe)\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["By adding curly braces after the name of the trait, we're telling Scala to create a new concrete\nsubclass of the trait, and create an instance of it.\nAs indicated in the comment, abstract methods must still be implemented.\nThis is the same that happens when one writes ",(0,t.jsx)(n.code,{children:"new Bundle {}"}),",\nthe curly braces create a new concrete subclass; however, because ",(0,t.jsx)(n.code,{children:"Bundle"})," has no abstract methods,\nthe contents of the body can be empty."]}),"\n",(0,t.jsxs)(n.h3,{id:"how-can-i-use-viewas-instead-of-viewassupertypetype",children:["How can I use ",(0,t.jsx)(n.code,{children:".viewAs"})," instead of ",(0,t.jsx)(n.code,{children:".viewAsSupertype(type)"}),"?"]}),"\n",(0,t.jsxs)(n.p,{children:["While ",(0,t.jsx)(n.code,{children:"viewAsSupertype"})," is helpful for one-off casts, the need to provide a type template object\neach time can be onerous.\nBecause of the subtyping relationship, you can use ",(0,t.jsx)(n.code,{children:"PartialDataView.supertype"})," to create a\n",(0,t.jsx)(n.code,{children:"DataView"})," from a Bundle type to a parent type by just providing the function to construct an\ninstance of the parent type from an instance of the child type.\nThe mapping of corresponding fields is automatically determined by Chisel to be the fields defined\nin the supertype."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\nclass Foo(x: Int) extends Bundle {\n  val foo = UInt(x.W)\n}\nclass Bar(val x: Int) extends Foo(x) {\n  val bar = UInt(x.W)\n}\n// Define a DataView without having to specify the mapping!\nimplicit val view: DataView[Bar, Foo] = PartialDataView.supertype[Bar, Foo](b => new Foo(b.x))\n\nclass MyModule extends Module {\n  val foo = IO(Input(new Foo(8)))\n  val bar = IO(Output(new Bar(8)))\n  bar.viewAs[Foo] := foo // bar.foo := foo.foo\n  bar.bar := 123.U       // all fields need to be connected\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.100.0\nmodule MyModule(\n  input        clock,\n               reset,\n  input  [7:0] foo_foo,\n  output [7:0] bar_foo,\n               bar_bar\n);\n\n  assign bar_foo = foo_foo;\n  assign bar_bar = 8'h7B;\nendmodule\n\n"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1871:(e,n,a)=>{a.d(n,{A:()=>s});a(6540);var t=a(5195);const o={tableOfContentsInline:"tableOfContentsInline_prmo"};var i=a(4848);function s(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:s}=e;return(0,i.jsx)("div",{className:o.tableOfContentsInline,children:(0,i.jsx)(t.A,{toc:n,minHeadingLevel:a,maxHeadingLevel:s,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,a)=>{a.d(n,{A:()=>m});var t=a(6540),o=a(6342);function i(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),a=Array(7).fill(-1);n.forEach(((e,n)=>{const t=a.slice(2,e.level);e.parentIndex=Math.max(...t),a[e.level]=n}));const t=[];return n.forEach((e=>{const{parentIndex:a,...o}=e;a>=0?n[a].children.push(o):t.push(o)})),t}function s(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=s({toc:e.children,minHeadingLevel:a,maxHeadingLevel:t});return function(e){return e.level>=a&&e.level<=t}(e)?[{...e,children:n}]:n}))}function r(e){const n=e.getBoundingClientRect();return n.top===n.bottom?r(e.parentNode):n}function l(e,n){let{anchorTopOffset:a}=n;const t=e.find((e=>r(e).top>=a));if(t){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(r(t))?t:e[e.indexOf(t)-1]??null}return e[e.length-1]??null}function c(){const e=(0,t.useRef)(0),{navbar:{hideOnScroll:n}}=(0,o.p)();return(0,t.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function d(e){const n=(0,t.useRef)(void 0),a=c();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:o,minHeadingLevel:i,maxHeadingLevel:s}=e;function r(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),r=function(e){let{minHeadingLevel:n,maxHeadingLevel:a}=e;const t=[];for(let o=n;o<=a;o+=1)t.push(`h${o}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:i,maxHeadingLevel:s}),c=l(r,{anchorTopOffset:a.current}),d=e.find((e=>c&&c.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,a){a?(n.current&&n.current!==e&&n.current.classList.remove(o),e.classList.add(o),n.current=e):e.classList.remove(o)}(e,e===d)}))}return document.addEventListener("scroll",r),document.addEventListener("resize",r),r(),()=>{document.removeEventListener("scroll",r),document.removeEventListener("resize",r)}}),[e,a])}var u=a(8774),p=a(4848);function h(e){let{toc:n,className:a,linkClassName:t,isChild:o}=e;return n.length?(0,p.jsx)("ul",{className:o?void 0:a,children:n.map((e=>(0,p.jsxs)("li",{children:[(0,p.jsx)(u.A,{to:`#${e.id}`,className:t??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,p.jsx)(h,{isChild:!0,toc:e.children,className:a,linkClassName:t})]},e.id)))}):null}const f=t.memo(h);function m(e){let{toc:n,className:a="table-of-contents table-of-contents__left-border",linkClassName:r="table-of-contents__link",linkActiveClassName:l,minHeadingLevel:c,maxHeadingLevel:u,...h}=e;const m=(0,o.p)(),v=c??m.tableOfContents.minHeadingLevel,w=u??m.tableOfContents.maxHeadingLevel,b=function(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:o}=e;return(0,t.useMemo)((()=>s({toc:i(n),minHeadingLevel:a,maxHeadingLevel:o})),[n,a,o])}({toc:n,minHeadingLevel:v,maxHeadingLevel:w});return d((0,t.useMemo)((()=>{if(r&&l)return{linkClassName:r,linkActiveClassName:l,minHeadingLevel:v,maxHeadingLevel:w}}),[r,l,v,w])),(0,p.jsx)(f,{toc:b,className:a,linkClassName:r,...h})}},8453:(e,n,a)=>{a.d(n,{R:()=>s,x:()=>r});var t=a(6540);const o={},i=t.createContext(o);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f10ce86b.aefbb291.js b/assets/js/f10ce86b.aefbb291.js
deleted file mode 100644
index 64876e206f..0000000000
--- a/assets/js/f10ce86b.aefbb291.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[2012],{8415:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var t=a(4848),o=a(8453),i=a(1871);const s={sidebar_position:3},r="DataView Cookbook",l={id:"cookbooks/dataview",title:"DataView Cookbook",description:"How do I view a Data as a UInt or vice versa?",source:"@site/docs/cookbooks/dataview.md",sourceDirName:"cookbooks",slug:"/cookbooks/dataview",permalink:"/docs/cookbooks/dataview",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/dataview.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"chiselSidebar",previous:{title:"Hierarchy Cookbook",permalink:"/docs/cookbooks/hierarchy"},next:{title:"Serialization Cookbook",permalink:"/docs/cookbooks/serialization"}},c={},d=[{value:"How do I view a Data as a UInt or vice versa?",id:"how-do-i-view-a-data-as-a-uint-or-vice-versa",level:2},{value:"How do I create a DataView for a Bundle has a type parameter?",id:"how-do-i-create-a-dataview-for-a-bundle-has-a-type-parameter",level:2},{value:"How do I create a DataView for a Bundle with optional fields?",id:"how-do-i-create-a-dataview-for-a-bundle-with-optional-fields",level:2},{value:"How do I connect a subset of Bundle fields?",id:"how-do-i-connect-a-subset-of-bundle-fields",level:2},{value:"How do I view a Bundle as a parent type (superclass)?",id:"how-do-i-view-a-bundle-as-a-parent-type-superclass",level:3},{value:"How do I view a Bundle as a parent type when the parent type is abstract (like a trait)?",id:"how-do-i-view-a-bundle-as-a-parent-type-when-the-parent-type-is-abstract-like-a-trait",level:3},{value:"How can I use <code>.viewAs</code> instead of <code>.viewAsSupertype(type)</code>?",id:"how-can-i-use-viewas-instead-of-viewassupertypetype",level:3}];function u(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"dataview-cookbook",children:"DataView Cookbook"})}),"\n","\n",(0,t.jsx)(i.A,{toc:d}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-view-a-data-as-a-uint-or-vice-versa",children:"How do I view a Data as a UInt or vice versa?"}),"\n",(0,t.jsxs)(n.p,{children:["Subword viewing (using concatenations or bit extractions in ",(0,t.jsx)(n.code,{children:"DataViews"}),") is not yet supported.\nWe intend to implement this in the future, but for the time being, use regular casts\n(",(0,t.jsx)(n.code,{children:".asUInt"})," and ",(0,t.jsx)(n.code,{children:".asTypeOf"}),")."]}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-create-a-dataview-for-a-bundle-has-a-type-parameter",children:"How do I create a DataView for a Bundle has a type parameter?"}),"\n",(0,t.jsxs)(n.p,{children:["Instead of using a ",(0,t.jsx)(n.code,{children:"val"}),", use a ",(0,t.jsx)(n.code,{children:"def"})," which can have type parameters:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\nclass Foo[T <: Data](val foo: T) extends Bundle\nclass Bar[T <: Data](val bar: T) extends Bundle\n\nobject Foo {\n  implicit def view[T <: Data]: DataView[Foo[T], Bar[T]] = {\n    DataView(f => new Bar(f.foo.cloneType), _.foo -> _.bar)\n    // .cloneType is necessary because the f passed to this function will be bound hardware\n  }\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["If you think about type parameterized classes as really being a family of different classes\n(one for each type parameter), you can think about the ",(0,t.jsx)(n.code,{children:"implicit def"})," as a generator of ",(0,t.jsx)(n.code,{children:"DataViews"}),"\nfor each type parameter."]}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-create-a-dataview-for-a-bundle-with-optional-fields",children:"How do I create a DataView for a Bundle with optional fields?"}),"\n",(0,t.jsxs)(n.p,{children:["Instead of using the default ",(0,t.jsx)(n.code,{children:"DataView"})," apply method, use ",(0,t.jsx)(n.code,{children:"DataView.mapping"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\nclass Foo(val w: Option[Int]) extends Bundle {\n  val foo = UInt(8.W)\n  val opt = w.map(x => UInt(x.W))\n}\nclass Bar(val w: Option[Int]) extends Bundle {\n  val bar = UInt(8.W)\n  val opt = w.map(x => UInt(x.W))\n}\n\nobject Foo {\n  implicit val view: DataView[Foo, Bar] =\n    DataView.mapping(\n      // First argument is always the function to make the view from the target\n      f => new Bar(f.w),\n      // Now instead of a varargs of tuples of individual mappings, we have a single function that\n      // takes a target and a view and returns an Iterable of tuple\n      (f, b) =>  List(f.foo -> b.bar) ++ f.opt.map(_ -> b.opt.get)\n                                   // ^ Note that we can append options since they are Iterable!\n\n    )\n}\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-connect-a-subset-of-bundle-fields",children:"How do I connect a subset of Bundle fields?"}),"\n",(0,t.jsxs)(n.p,{children:['Chisel 3 requires types to match exactly for connections.\nDataView provides a mechanism for "viewing" one ',(0,t.jsx)(n.code,{children:"Bundle"})," object as if it were the type of another,\nwhich allows them to be connected."]}),"\n",(0,t.jsx)(n.h3,{id:"how-do-i-view-a-bundle-as-a-parent-type-superclass",children:"How do I view a Bundle as a parent type (superclass)?"}),"\n",(0,t.jsxs)(n.p,{children:["For viewing ",(0,t.jsx)(n.code,{children:"Bundles"})," as the type of the parent, it is as simple as using ",(0,t.jsx)(n.code,{children:"viewAsSupertype"})," and providing a\ntemplate object of the parent type:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\nclass Foo extends Bundle {\n  val foo = UInt(8.W)\n}\nclass Bar extends Foo {\n  val bar = UInt(8.W)\n}\nclass MyModule extends Module {\n  val foo = IO(Input(new Foo))\n  val bar = IO(Output(new Bar))\n  bar.viewAsSupertype(new Foo) := foo // bar.foo := foo.foo\n  bar.bar := 123.U           // all fields need to be connected\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule MyModule(\n  input        clock,\n               reset,\n  input  [7:0] foo_foo,\n  output [7:0] bar_foo,\n               bar_bar\n);\n\n  assign bar_foo = foo_foo;\n  assign bar_bar = 8'h7B;\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"how-do-i-view-a-bundle-as-a-parent-type-when-the-parent-type-is-abstract-like-a-trait",children:"How do I view a Bundle as a parent type when the parent type is abstract (like a trait)?"}),"\n",(0,t.jsxs)(n.p,{children:["Given the following ",(0,t.jsx)(n.code,{children:"Bundles"})," that share a common ",(0,t.jsx)(n.code,{children:"trait"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\ntrait Super extends Bundle {\n  def bitwidth: Int\n  val a = UInt(bitwidth.W)\n}\nclass Foo(val bitwidth: Int) extends Super {\n  val foo = UInt(8.W)\n}\nclass Bar(val bitwidth: Int) extends Super {\n  val bar = UInt(8.W)\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Foo"})," and ",(0,t.jsx)(n.code,{children:"Bar"})," cannot be connected directly, but they could be connected by viewing them both as if\nthey were instances of their common supertype, ",(0,t.jsx)(n.code,{children:"Super"}),".\nA straightforward approach might run into an issue like the following:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class MyModule extends Module {\n  val foo = IO(Input(new Foo(8)))\n  val bar = IO(Output(new Bar(8)))\n  bar.viewAsSupertype(new Super) := foo.viewAsSupertype(new Super)\n}\n// error: trait Super is abstract; cannot be instantiated\n//   bar.viewAsSupertype(new Super) := foo.viewAsSupertype(new Super)\n//                       ^^^^^^^^^\n// error: trait Super is abstract; cannot be instantiated\n//   bar.viewAsSupertype(new Super) := foo.viewAsSupertype(new Super)\n//                                                         ^^^^^^^^^\n"})}),"\n",(0,t.jsxs)(n.p,{children:["The problem is that ",(0,t.jsx)(n.code,{children:"viewAs"})," requires an object to use as a type template (so that it can be cloned),\nbut ",(0,t.jsx)(n.code,{children:"traits"})," are abstract and cannot be instantiated.\nThe solution is to create an instance of an ",(0,t.jsx)(n.em,{children:"anonymous class"})," and use that object as the argument to ",(0,t.jsx)(n.code,{children:"viewAs"}),".\nWe can do this like so:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"class MyModule extends Module {\n  val foo = IO(Input(new Foo(8)))\n  val bar = IO(Output(new Bar(8)))\n  val tpe = new Super { // Adding curly braces creates an anonymous class\n    def bitwidth = 8 // We must implement any abstract methods\n  }\n  bar.viewAsSupertype(tpe) := foo.viewAsSupertype(tpe)\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["By adding curly braces after the name of the trait, we're telling Scala to create a new concrete\nsubclass of the trait, and create an instance of it.\nAs indicated in the comment, abstract methods must still be implemented.\nThis is the same that happens when one writes ",(0,t.jsx)(n.code,{children:"new Bundle {}"}),",\nthe curly braces create a new concrete subclass; however, because ",(0,t.jsx)(n.code,{children:"Bundle"})," has no abstract methods,\nthe contents of the body can be empty."]}),"\n",(0,t.jsxs)(n.h3,{id:"how-can-i-use-viewas-instead-of-viewassupertypetype",children:["How can I use ",(0,t.jsx)(n.code,{children:".viewAs"})," instead of ",(0,t.jsx)(n.code,{children:".viewAsSupertype(type)"}),"?"]}),"\n",(0,t.jsxs)(n.p,{children:["While ",(0,t.jsx)(n.code,{children:"viewAsSupertype"})," is helpful for one-off casts, the need to provide a type template object\neach time can be onerous.\nBecause of the subtyping relationship, you can use ",(0,t.jsx)(n.code,{children:"PartialDataView.supertype"})," to create a\n",(0,t.jsx)(n.code,{children:"DataView"})," from a Bundle type to a parent type by just providing the function to construct an\ninstance of the parent type from an instance of the child type.\nThe mapping of corresponding fields is automatically determined by Chisel to be the fields defined\nin the supertype."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.dataview._\n\nclass Foo(x: Int) extends Bundle {\n  val foo = UInt(x.W)\n}\nclass Bar(val x: Int) extends Foo(x) {\n  val bar = UInt(x.W)\n}\n// Define a DataView without having to specify the mapping!\nimplicit val view: DataView[Bar, Foo] = PartialDataView.supertype[Bar, Foo](b => new Foo(b.x))\n\nclass MyModule extends Module {\n  val foo = IO(Input(new Foo(8)))\n  val bar = IO(Output(new Bar(8)))\n  bar.viewAs[Foo] := foo // bar.foo := foo.foo\n  bar.bar := 123.U       // all fields need to be connected\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.99.2\nmodule MyModule(\n  input        clock,\n               reset,\n  input  [7:0] foo_foo,\n  output [7:0] bar_foo,\n               bar_bar\n);\n\n  assign bar_foo = foo_foo;\n  assign bar_bar = 8'h7B;\nendmodule\n\n"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1871:(e,n,a)=>{a.d(n,{A:()=>s});a(6540);var t=a(5195);const o={tableOfContentsInline:"tableOfContentsInline_prmo"};var i=a(4848);function s(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:s}=e;return(0,i.jsx)("div",{className:o.tableOfContentsInline,children:(0,i.jsx)(t.A,{toc:n,minHeadingLevel:a,maxHeadingLevel:s,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,a)=>{a.d(n,{A:()=>m});var t=a(6540),o=a(6342);function i(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),a=Array(7).fill(-1);n.forEach(((e,n)=>{const t=a.slice(2,e.level);e.parentIndex=Math.max(...t),a[e.level]=n}));const t=[];return n.forEach((e=>{const{parentIndex:a,...o}=e;a>=0?n[a].children.push(o):t.push(o)})),t}function s(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=s({toc:e.children,minHeadingLevel:a,maxHeadingLevel:t});return function(e){return e.level>=a&&e.level<=t}(e)?[{...e,children:n}]:n}))}function r(e){const n=e.getBoundingClientRect();return n.top===n.bottom?r(e.parentNode):n}function l(e,n){let{anchorTopOffset:a}=n;const t=e.find((e=>r(e).top>=a));if(t){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(r(t))?t:e[e.indexOf(t)-1]??null}return e[e.length-1]??null}function c(){const e=(0,t.useRef)(0),{navbar:{hideOnScroll:n}}=(0,o.p)();return(0,t.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function d(e){const n=(0,t.useRef)(void 0),a=c();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:o,minHeadingLevel:i,maxHeadingLevel:s}=e;function r(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),r=function(e){let{minHeadingLevel:n,maxHeadingLevel:a}=e;const t=[];for(let o=n;o<=a;o+=1)t.push(`h${o}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:i,maxHeadingLevel:s}),c=l(r,{anchorTopOffset:a.current}),d=e.find((e=>c&&c.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,a){a?(n.current&&n.current!==e&&n.current.classList.remove(o),e.classList.add(o),n.current=e):e.classList.remove(o)}(e,e===d)}))}return document.addEventListener("scroll",r),document.addEventListener("resize",r),r(),()=>{document.removeEventListener("scroll",r),document.removeEventListener("resize",r)}}),[e,a])}var u=a(8774),p=a(4848);function h(e){let{toc:n,className:a,linkClassName:t,isChild:o}=e;return n.length?(0,p.jsx)("ul",{className:o?void 0:a,children:n.map((e=>(0,p.jsxs)("li",{children:[(0,p.jsx)(u.A,{to:`#${e.id}`,className:t??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,p.jsx)(h,{isChild:!0,toc:e.children,className:a,linkClassName:t})]},e.id)))}):null}const f=t.memo(h);function m(e){let{toc:n,className:a="table-of-contents table-of-contents__left-border",linkClassName:r="table-of-contents__link",linkActiveClassName:l,minHeadingLevel:c,maxHeadingLevel:u,...h}=e;const m=(0,o.p)(),v=c??m.tableOfContents.minHeadingLevel,w=u??m.tableOfContents.maxHeadingLevel,b=function(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:o}=e;return(0,t.useMemo)((()=>s({toc:i(n),minHeadingLevel:a,maxHeadingLevel:o})),[n,a,o])}({toc:n,minHeadingLevel:v,maxHeadingLevel:w});return d((0,t.useMemo)((()=>{if(r&&l)return{linkClassName:r,linkActiveClassName:l,minHeadingLevel:v,maxHeadingLevel:w}}),[r,l,v,w])),(0,p.jsx)(f,{toc:b,className:a,linkClassName:r,...h})}},8453:(e,n,a)=>{a.d(n,{R:()=>s,x:()=>r});var t=a(6540);const o={},i=t.createContext(o);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/runtime~main.ecc71767.js b/assets/js/runtime~main.6f6687cd.js
similarity index 88%
rename from assets/js/runtime~main.ecc71767.js
rename to assets/js/runtime~main.6f6687cd.js
index 352289563d..587efee2d4 100644
--- a/assets/js/runtime~main.ecc71767.js
+++ b/assets/js/runtime~main.6f6687cd.js
@@ -1 +1 @@
-(()=>{"use strict";var e,a,c,d,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={exports:{}};return b[e].call(c.exports,c,c.exports,r),c.exports}r.m=b,e=[],r.O=(a,c,d,f)=>{if(!c){var b=1/0;for(i=0;i<e.length;i++){c=e[i][0],d=e[i][1],f=e[i][2];for(var t=!0,o=0;o<c.length;o++)(!1&f||b>=f)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,f<b&&(b=f));if(t){e.splice(i--,1);var n=d();void 0!==n&&(a=n)}}return a}f=f||0;for(var i=e.length;i>0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[c,d,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&d&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({340:"c5561474",635:"c260b502",741:"1ce89024",849:"0058b4c6",867:"33fc5bb8",957:"c141421f",1108:"bc33eb1f",1188:"e7b22fe0",1235:"a7456010",1281:"d50fb5c7",1384:"8fdf13ba",1596:"f416550b",1903:"acecf23e",1921:"2024159c",2012:"f10ce86b",2138:"1a4e3797",2289:"916cecd1",2504:"54ab625b",2579:"9cc76f42",2634:"c4f5d8e4",2711:"9e4087bc",2785:"7b5bfa87",3117:"a26328e3",3126:"cddf45a4",3130:"3afb3224",3249:"ccc49370",3259:"117a0587",3291:"7cc2f0dc",3313:"a8f82c73",3316:"c48de377",3361:"c377a04b",3460:"a98e3d7d",3543:"96d1adfe",3599:"30c88dbf",4020:"44ff0b81",4166:"d4b6d0e6",4212:"621db11d",4286:"11a69d4a",4315:"651e9e03",4813:"6875c492",4825:"44147ff4",4863:"d1e6e3d8",5056:"ae8e96e2",5432:"7e1e4a75",5497:"46a40f56",5522:"cdcdfbab",5540:"d1a7dbc9",5583:"f901c241",5666:"0bba5ab0",5742:"aba21aa0",6027:"d63f0d9b",6061:"1f391b9e",6067:"1f7682ec",6304:"21d75435",6403:"d1a683e4",6474:"c7666d49",6760:"11d458a9",6803:"3b8c55ea",6891:"1c800026",6969:"14eb3368",6991:"37a5b604",7087:"1883c3a9",7098:"a7bd4aaa",7132:"67ffb541",7315:"407ce553",7425:"a47e47c7",7437:"adf02ec5",7461:"7733a243",7472:"814f3328",7643:"a6aa9e1f",8042:"8a309442",8118:"6559d260",8121:"3a2db09e",8130:"f81c1134",8140:"5839614c",8146:"c15d9823",8209:"01a85c17",8227:"19ad7e9f",8316:"17dd133b",8401:"17896441",8485:"806d4637",8507:"b13aa1a2",8864:"d92a3c43",8946:"98ca0ee0",8947:"ef8b811a",9017:"868241d3",9048:"a94703ab",9128:"7fa9ea57",9387:"c71a47e4",9482:"c77c4085",9647:"5e95c892",9670:"87ed036d",9710:"bc089483",9858:"36994c47",9920:"6a9619ba",9942:"12b2b068"}[e]||e)+"."+{340:"8dbece39",416:"d5c32938",635:"9468039b",741:"76afd8dc",849:"272726e6",867:"9d493afe",957:"0fd76349",1108:"c5d79c51",1188:"e6085ff5",1235:"e788d507",1281:"3da5f25c",1384:"32f7cc71",1596:"d359a0d4",1903:"302c9b19",1921:"8e7dc586",2012:"aefbb291",2138:"d46dc5f1",2237:"c23ff5db",2289:"90b255c9",2504:"4482812e",2579:"8000e271",2634:"b2d80d44",2711:"d7b2888e",2785:"77e370fe",3117:"b21a8621",3126:"ade07b02",3130:"4c52d26f",3249:"d5561e2c",3259:"2eb4c80a",3291:"54852e76",3313:"a31650d1",3316:"f67a205e",3347:"bd9c3960",3361:"304b9e45",3460:"83c44bf7",3543:"ef9fba8c",3599:"70c8f729",4020:"42b22afe",4166:"f68aedf5",4212:"fbb7780b",4286:"0b48b87d",4315:"387bd3d0",4813:"255d3067",4825:"a73dbf93",4863:"83eacef3",5056:"50814aef",5432:"b8ae9443",5497:"1a3404c7",5522:"6031edb9",5540:"cc8714f3",5583:"9339da55",5666:"7d862322",5742:"23cb5882",6027:"668cd119",6061:"73386fd6",6067:"298dd3a2",6304:"ba64159f",6403:"148f34e8",6474:"4bc58ceb",6760:"b9d97434",6803:"6b3858e5",6891:"099dad7c",6969:"b1f4ec0d",6991:"00e7852a",7087:"2844b440",7098:"2786cce5",7132:"4805b36a",7315:"ff2084cf",7425:"208ef3d8",7437:"9654a22f",7461:"a1ab767a",7472:"a50bf01b",7643:"4907955f",8042:"98d3a87c",8118:"e80dab3d",8121:"95beead3",8130:"9c784d80",8140:"82e77c1c",8146:"d012537c",8158:"887a29fb",8209:"afb7d518",8227:"c6729e12",8316:"aa1509dc",8401:"7e876bf3",8485:"f7d72e3e",8498:"491c322f",8507:"81fc2d29",8864:"6b30aa7d",8913:"eae5cfc0",8946:"e62af188",8947:"0dbbe99e",9017:"2d32cef4",9048:"b67ea9de",9128:"ec532c62",9387:"f1c35766",9482:"6e5a0aef",9647:"6f38f138",9670:"11b3d692",9710:"93af3bdb",9858:"68a128de",9920:"2496f8e2",9942:"e726c7f9"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},f="chisel-lang:",r.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i<n.length;i++){var l=n[i];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==f+c){t=l;break}}t||(o=!0,(t=document.createElement("script")).charset="utf-8",t.timeout=120,r.nc&&t.setAttribute("nonce",r.nc),t.setAttribute("data-webpack",f+c),t.src=e),d[e]=[a];var u=(a,c)=>{t.onerror=t.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={17896441:"8401",c5561474:"340",c260b502:"635","1ce89024":"741","0058b4c6":"849","33fc5bb8":"867",c141421f:"957",bc33eb1f:"1108",e7b22fe0:"1188",a7456010:"1235",d50fb5c7:"1281","8fdf13ba":"1384",f416550b:"1596",acecf23e:"1903","2024159c":"1921",f10ce86b:"2012","1a4e3797":"2138","916cecd1":"2289","54ab625b":"2504","9cc76f42":"2579",c4f5d8e4:"2634","9e4087bc":"2711","7b5bfa87":"2785",a26328e3:"3117",cddf45a4:"3126","3afb3224":"3130",ccc49370:"3249","117a0587":"3259","7cc2f0dc":"3291",a8f82c73:"3313",c48de377:"3316",c377a04b:"3361",a98e3d7d:"3460","96d1adfe":"3543","30c88dbf":"3599","44ff0b81":"4020",d4b6d0e6:"4166","621db11d":"4212","11a69d4a":"4286","651e9e03":"4315","6875c492":"4813","44147ff4":"4825",d1e6e3d8:"4863",ae8e96e2:"5056","7e1e4a75":"5432","46a40f56":"5497",cdcdfbab:"5522",d1a7dbc9:"5540",f901c241:"5583","0bba5ab0":"5666",aba21aa0:"5742",d63f0d9b:"6027","1f391b9e":"6061","1f7682ec":"6067","21d75435":"6304",d1a683e4:"6403",c7666d49:"6474","11d458a9":"6760","3b8c55ea":"6803","1c800026":"6891","14eb3368":"6969","37a5b604":"6991","1883c3a9":"7087",a7bd4aaa:"7098","67ffb541":"7132","407ce553":"7315",a47e47c7:"7425",adf02ec5:"7437","7733a243":"7461","814f3328":"7472",a6aa9e1f:"7643","8a309442":"8042","6559d260":"8118","3a2db09e":"8121",f81c1134:"8130","5839614c":"8140",c15d9823:"8146","01a85c17":"8209","19ad7e9f":"8227","17dd133b":"8316","806d4637":"8485",b13aa1a2:"8507",d92a3c43:"8864","98ca0ee0":"8946",ef8b811a:"8947","868241d3":"9017",a94703ab:"9048","7fa9ea57":"9128",c71a47e4:"9387",c77c4085:"9482","5e95c892":"9647","87ed036d":"9670",bc089483:"9710","36994c47":"9858","6a9619ba":"9920","12b2b068":"9942"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,c)=>{var d=r.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(d in t)r.o(t,d)&&(r.m[d]=t[d]);if(o)var i=o(r)}for(a&&a(c);n<b.length;n++)f=b[n],r.o(e,f)&&e[f]&&e[f][0](),e[f]=0;return r.O(i)},c=self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[];c.forEach(a.bind(null,0)),c.push=a.bind(null,c.push.bind(c))})()})();
\ No newline at end of file
+(()=>{"use strict";var e,a,c,d,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={exports:{}};return b[e].call(c.exports,c,c.exports,r),c.exports}r.m=b,e=[],r.O=(a,c,d,f)=>{if(!c){var b=1/0;for(i=0;i<e.length;i++){c=e[i][0],d=e[i][1],f=e[i][2];for(var t=!0,o=0;o<c.length;o++)(!1&f||b>=f)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,f<b&&(b=f));if(t){e.splice(i--,1);var n=d();void 0!==n&&(a=n)}}return a}f=f||0;for(var i=e.length;i>0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[c,d,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&d&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({340:"c5561474",635:"c260b502",741:"1ce89024",849:"0058b4c6",867:"33fc5bb8",957:"c141421f",1108:"bc33eb1f",1188:"e7b22fe0",1235:"a7456010",1281:"d50fb5c7",1384:"8fdf13ba",1596:"f416550b",1903:"acecf23e",1921:"2024159c",2012:"f10ce86b",2138:"1a4e3797",2289:"916cecd1",2504:"54ab625b",2579:"9cc76f42",2634:"c4f5d8e4",2711:"9e4087bc",2785:"7b5bfa87",3117:"a26328e3",3126:"cddf45a4",3130:"3afb3224",3249:"ccc49370",3259:"117a0587",3291:"7cc2f0dc",3313:"a8f82c73",3316:"c48de377",3361:"c377a04b",3460:"a98e3d7d",3543:"96d1adfe",3599:"30c88dbf",4020:"44ff0b81",4166:"d4b6d0e6",4212:"621db11d",4286:"11a69d4a",4315:"651e9e03",4813:"6875c492",4825:"44147ff4",4863:"d1e6e3d8",5056:"ae8e96e2",5432:"7e1e4a75",5497:"46a40f56",5522:"cdcdfbab",5540:"d1a7dbc9",5583:"f901c241",5666:"0bba5ab0",5742:"aba21aa0",6027:"d63f0d9b",6061:"1f391b9e",6067:"1f7682ec",6304:"21d75435",6403:"d1a683e4",6474:"c7666d49",6760:"11d458a9",6803:"3b8c55ea",6891:"1c800026",6969:"14eb3368",6991:"37a5b604",7087:"1883c3a9",7098:"a7bd4aaa",7132:"67ffb541",7315:"407ce553",7425:"a47e47c7",7437:"adf02ec5",7461:"7733a243",7472:"814f3328",7643:"a6aa9e1f",8042:"8a309442",8118:"6559d260",8121:"3a2db09e",8130:"f81c1134",8140:"5839614c",8146:"c15d9823",8209:"01a85c17",8227:"19ad7e9f",8316:"17dd133b",8401:"17896441",8485:"806d4637",8507:"b13aa1a2",8864:"d92a3c43",8946:"98ca0ee0",8947:"ef8b811a",9017:"868241d3",9048:"a94703ab",9128:"7fa9ea57",9387:"c71a47e4",9482:"c77c4085",9647:"5e95c892",9670:"87ed036d",9710:"bc089483",9858:"36994c47",9920:"6a9619ba",9942:"12b2b068"}[e]||e)+"."+{340:"8dbece39",416:"d5c32938",635:"9468039b",741:"2296292d",849:"272726e6",867:"9d493afe",957:"0fd76349",1108:"c5d79c51",1188:"e6085ff5",1235:"e788d507",1281:"99b64109",1384:"32f7cc71",1596:"d359a0d4",1903:"302c9b19",1921:"8e7dc586",2012:"4ffec15d",2138:"d46dc5f1",2237:"c23ff5db",2289:"94aedafa",2504:"4482812e",2579:"8000e271",2634:"b2d80d44",2711:"d7b2888e",2785:"1c5fc558",3117:"b21a8621",3126:"ade07b02",3130:"4c52d26f",3249:"d5561e2c",3259:"2eb4c80a",3291:"97f33e9d",3313:"a44bdfa5",3316:"33b512d1",3347:"bd9c3960",3361:"304b9e45",3460:"83c44bf7",3543:"ef9fba8c",3599:"70c8f729",4020:"42b22afe",4166:"de292a95",4212:"fbb7780b",4286:"0b48b87d",4315:"387bd3d0",4813:"255d3067",4825:"a73dbf93",4863:"b6d39183",5056:"50814aef",5432:"51497e19",5497:"1a3404c7",5522:"953ede6d",5540:"cc8714f3",5583:"9339da55",5666:"7d862322",5742:"23cb5882",6027:"668cd119",6061:"73386fd6",6067:"298dd3a2",6304:"ba64159f",6403:"148f34e8",6474:"edd1fd74",6760:"b9d97434",6803:"6b3858e5",6891:"099dad7c",6969:"b1f4ec0d",6991:"00e7852a",7087:"2844b440",7098:"2786cce5",7132:"51383dc4",7315:"ff2084cf",7425:"208ef3d8",7437:"9654a22f",7461:"a1ab767a",7472:"a50bf01b",7643:"4907955f",8042:"98d3a87c",8118:"e80dab3d",8121:"95beead3",8130:"9c784d80",8140:"82e77c1c",8146:"d012537c",8158:"887a29fb",8209:"afb7d518",8227:"c6729e12",8316:"e4c62b60",8401:"7e876bf3",8485:"f7d72e3e",8498:"491c322f",8507:"81fc2d29",8864:"6b30aa7d",8913:"eae5cfc0",8946:"8b580311",8947:"0dbbe99e",9017:"1a857a9d",9048:"b67ea9de",9128:"ec532c62",9387:"f1c35766",9482:"6e5a0aef",9647:"6f38f138",9670:"11b3d692",9710:"93af3bdb",9858:"68a128de",9920:"2496f8e2",9942:"e726c7f9"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},f="chisel-lang:",r.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i<n.length;i++){var l=n[i];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==f+c){t=l;break}}t||(o=!0,(t=document.createElement("script")).charset="utf-8",t.timeout=120,r.nc&&t.setAttribute("nonce",r.nc),t.setAttribute("data-webpack",f+c),t.src=e),d[e]=[a];var u=(a,c)=>{t.onerror=t.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={17896441:"8401",c5561474:"340",c260b502:"635","1ce89024":"741","0058b4c6":"849","33fc5bb8":"867",c141421f:"957",bc33eb1f:"1108",e7b22fe0:"1188",a7456010:"1235",d50fb5c7:"1281","8fdf13ba":"1384",f416550b:"1596",acecf23e:"1903","2024159c":"1921",f10ce86b:"2012","1a4e3797":"2138","916cecd1":"2289","54ab625b":"2504","9cc76f42":"2579",c4f5d8e4:"2634","9e4087bc":"2711","7b5bfa87":"2785",a26328e3:"3117",cddf45a4:"3126","3afb3224":"3130",ccc49370:"3249","117a0587":"3259","7cc2f0dc":"3291",a8f82c73:"3313",c48de377:"3316",c377a04b:"3361",a98e3d7d:"3460","96d1adfe":"3543","30c88dbf":"3599","44ff0b81":"4020",d4b6d0e6:"4166","621db11d":"4212","11a69d4a":"4286","651e9e03":"4315","6875c492":"4813","44147ff4":"4825",d1e6e3d8:"4863",ae8e96e2:"5056","7e1e4a75":"5432","46a40f56":"5497",cdcdfbab:"5522",d1a7dbc9:"5540",f901c241:"5583","0bba5ab0":"5666",aba21aa0:"5742",d63f0d9b:"6027","1f391b9e":"6061","1f7682ec":"6067","21d75435":"6304",d1a683e4:"6403",c7666d49:"6474","11d458a9":"6760","3b8c55ea":"6803","1c800026":"6891","14eb3368":"6969","37a5b604":"6991","1883c3a9":"7087",a7bd4aaa:"7098","67ffb541":"7132","407ce553":"7315",a47e47c7:"7425",adf02ec5:"7437","7733a243":"7461","814f3328":"7472",a6aa9e1f:"7643","8a309442":"8042","6559d260":"8118","3a2db09e":"8121",f81c1134:"8130","5839614c":"8140",c15d9823:"8146","01a85c17":"8209","19ad7e9f":"8227","17dd133b":"8316","806d4637":"8485",b13aa1a2:"8507",d92a3c43:"8864","98ca0ee0":"8946",ef8b811a:"8947","868241d3":"9017",a94703ab:"9048","7fa9ea57":"9128",c71a47e4:"9387",c77c4085:"9482","5e95c892":"9647","87ed036d":"9670",bc089483:"9710","36994c47":"9858","6a9619ba":"9920","12b2b068":"9942"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,c)=>{var d=r.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(d in t)r.o(t,d)&&(r.m[d]=t[d]);if(o)var i=o(r)}for(a&&a(c);n<b.length;n++)f=b[n],r.o(e,f)&&e[f]&&e[f][0](),e[f]=0;return r.O(i)},c=self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[];c.forEach(a.bind(null,0)),c.push=a.bind(null,c.push.bind(c))})()})();
\ No newline at end of file
diff --git a/blog.html b/blog.html
index f890d46c9e..7454a24f93 100644
--- a/blog.html
+++ b/blog.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/archive.html b/blog/archive.html
index 4a668359ae..4be54f3686 100644
--- a/blog/archive.html
+++ b/blog/archive.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/authors.html b/blog/authors.html
index c24157824b..55d88a6fba 100644
--- a/blog/authors.html
+++ b/blog/authors.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/authors/seldridge.html b/blog/authors/seldridge.html
index 901d3d8285..0751d1f25a 100644
--- a/blog/authors/seldridge.html
+++ b/blog/authors/seldridge.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/restarting-the-blog.html b/blog/restarting-the-blog.html
index 2b882d62fe..789d0bcc72 100644
--- a/blog/restarting-the-blog.html
+++ b/blog/restarting-the-blog.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/tags.html b/blog/tags.html
index 6914bb4f05..5b52c3189e 100644
--- a/blog/tags.html
+++ b/blog/tags.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/tags/miscellaneous.html b/blog/tags/miscellaneous.html
index bf74793845..ed8f1ee212 100644
--- a/blog/tags/miscellaneous.html
+++ b/blog/tags/miscellaneous.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/community.html b/community.html
index 062cc36b98..4c3d7e6ec6 100644
--- a/community.html
+++ b/community.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs.html b/docs.html
index c6e40a96dd..7f45cd7fce 100644
--- a/docs.html
+++ b/docs.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix.html b/docs/appendix.html
index a30b708337..d7be1b9bc2 100644
--- a/docs/appendix.html
+++ b/docs/appendix.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix/experimental-features.html b/docs/appendix/experimental-features.html
index 0b70304f15..8ca27b2170 100644
--- a/docs/appendix/experimental-features.html
+++ b/docs/appendix/experimental-features.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -35,37 +35,37 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="module-variants">Module Varia
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="bundle-literals">Bundle Literals<a href="#bundle-literals" class="hash-link" aria-label="Direct link to Bundle Literals" title="Direct link to Bundle Literals">​</a></h2>
 <p>Bundle literals can be constructed via an experimental import:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">BundleLiterals</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyBundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       out_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h8</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       out_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h8</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Partial specification is allowed, which results in &quot;invalidated fields&quot; as
 described in <a href="/docs/explanations/unconnected-wires">Unconnected Wires</a>.
 Note that this can be used with <code>RegInit</code> to construct partially reset registers as
 described in the <a href="/docs/cookbooks/cookbook#how-do-i-partially-reset-an-aggregate-reg">Cookbook</a>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example2 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       out_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       out_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Bundle literals can also be nested arbitrarily.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> ChildBundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> ParentBundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ChildBundle</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example3 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ParentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ParentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">123.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ChildBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">foo </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">42.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example3</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_b_foo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h7B</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_b_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h2A</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example3</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_b_foo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h7B</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_b_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h2A</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="vec-literals">Vec Literals<a href="#vec-literals" class="hash-link" aria-label="Direct link to Vec Literals" title="Direct link to Vec Literals">​</a></h2>
 <p>Vec literals are very similar to Bundle literals and can be constructed via an experimental import.
 They can be constructed in two forms, with type and length inferred as in:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">VecLiterals</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> VecExample1 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Vec</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">0xa</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0xbb</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;hA</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;hB</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;hA</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;hB</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>or explicitly as in:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">VecLiterals</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> VecExample1a </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">0</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample1a</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h2</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample1a</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h2</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>The following examples all use the explicit form.
 With the explicit form partial specification is allowed, which results in
 &quot;invalidated fields&quot; as described in <a href="/docs/explanations/unconnected-wires">Unconnected Wires</a>.
 Note that this can be used with <code>RegInit</code> to construct partially reset registers as
 described in the <a href="/docs/cookbooks/cookbook#how-do-i-partially-reset-an-aggregate-reg">Cookbook</a>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> VecExample2 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">0</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">3</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">7.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_3</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_3 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h7</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_3</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_3 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h7</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Registers can be initialized from Vec literals</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> VecExample3 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> y </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegInit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">0</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0xAB</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0xCD</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0xEF</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">3</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0xFF</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> y</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample3</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_3</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;hAB</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;hCD</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;hEF</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_3 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;hFF</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample3</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_3</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;hAB</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;hCD</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;hEF</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_3 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;hFF</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Vec literals can also be nested arbitrarily.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> VecExample5 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ChildBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ChildBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token number" style="color:#36acaa">0</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ChildBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">foo </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">42.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ChildBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">foo </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">7.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample5</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1_foo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h2A</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h7</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">VecExample5</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_0_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_1_foo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_0_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h2A</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_1_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h7</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="loading-memories-for-simulation-or-fpga-initialization">Loading Memories for simulation or FPGA initialization<a href="#loading-memories-for-simulation-or-fpga-initialization" class="hash-link" aria-label="Direct link to Loading Memories for simulation or FPGA initialization" title="Direct link to Loading Memories for simulation or FPGA initialization">​</a></h2>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="inline-initialization-with-external-file">Inline initialization with external file<a href="#inline-initialization-with-external-file" class="hash-link" aria-label="Direct link to Inline initialization with external file" title="Direct link to Inline initialization with external file">​</a></h3>
 <p>Memories can be initialized by generating inline <code>readmemh</code> or <code>readmemb</code> statements in the output Verilog.</p>
diff --git a/docs/appendix/migrating-from-chiseltest.html b/docs/appendix/migrating-from-chiseltest.html
index 1c0c8230d4..25e03a09ab 100644
--- a/docs/appendix/migrating-from-chiseltest.html
+++ b/docs/appendix/migrating-from-chiseltest.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix/upgrading-from-chisel-3-4.html b/docs/appendix/upgrading-from-chisel-3-4.html
index 8c8097d361..cd18b67953 100644
--- a/docs/appendix/upgrading-from-chisel-3-4.html
+++ b/docs/appendix/upgrading-from-chisel-3-4.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix/upgrading-from-scala-2-11.html b/docs/appendix/upgrading-from-scala-2-11.html
index 2378ffdf42..d3b740d47b 100644
--- a/docs/appendix/upgrading-from-scala-2-11.html
+++ b/docs/appendix/upgrading-from-scala-2-11.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix/versioning.html b/docs/appendix/versioning.html
index b3dd9d10ae..1a41c26f9a 100644
--- a/docs/appendix/versioning.html
+++ b/docs/appendix/versioning.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/category/getting-started.html b/docs/category/getting-started.html
index 678c71488c..8d681f3b66 100644
--- a/docs/category/getting-started.html
+++ b/docs/category/getting-started.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks.html b/docs/cookbooks.html
index 054019793e..7637b515a4 100644
--- a/docs/cookbooks.html
+++ b/docs/cookbooks.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/cookbook.html b/docs/cookbooks/cookbook.html
index 0b32f35333..52bfd465ad 100644
--- a/docs/cookbooks/cookbook.html
+++ b/docs/cookbooks/cookbook.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -146,12 +146,12 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-create-an-optional-i
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-create-io-without-a-prefix">How do I create I/O without a prefix?<a href="#how-do-i-create-io-without-a-prefix" class="hash-link" aria-label="Direct link to How do I create I/O without a prefix?" title="Direct link to How do I create I/O without a prefix?">​</a></h2>
 <p>In most cases, you can simply call <code>IO</code> multiple times:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token operator" style="color:#393A34">%</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>If you have a <code>Bundle</code> from which you would like to create ports without the
 normal <code>val</code> prefix, you can use <code>FlatIO</code>:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyBundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> FlatIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bar </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">foo </span><span class="token operator" style="color:#393A34">+</span><span class="token operator" style="color:#393A34">%</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Note that <code>io_</code> is nowhere to be seen!</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-override-the-implicit-clock-or-reset-within-a-module">How do I override the implicit clock or reset within a Module?<a href="#how-do-i-override-the-implicit-clock-or-reset-within-a-module" class="hash-link" aria-label="Direct link to How do I override the implicit clock or reset within a Module?" title="Direct link to How do I override the implicit clock or reset within a Module?">​</a></h2>
 <p>To change the clock or reset for a region of code, use <code>withClock</code>, <code>withReset</code>, or <code>withClockAndReset</code>.
 See <a href="/docs/explanations/multi-clock">Multiple Clock Domains</a> for examples and details.</p>
@@ -159,7 +159,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-override-the-implici
 <p>For example, you could &quot;gate&quot; the default implicit clock as follows:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token keyword" style="color:#00009f">with</span><span class="token plain"> ImplicitClock </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> gate </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// We could just assign this to val implicitClock, but this allows us to give it a custom name</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> gatedClock </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">clock</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">asBool </span><span class="token operator" style="color:#393A34">||</span><span class="token plain"> gate</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">asClock</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// The trait requires us to implement this method referring to the clock</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Note that this is a def, but the actual clock value must be assigned to a val</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">override</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">protected</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> implicitClock </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> gatedClock</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> r </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Reg</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> r</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  r </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This gives the following Verilog:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               gate</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       gatedClock </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> clock </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> gate</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> r</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> gatedClock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    r </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> r</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               gate</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       gatedClock </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> clock </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> gate</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> r</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> gatedClock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    r </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> r</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>If you do not care about the name of the overriden clock, you can just assign it to <code>val implicitClock</code>:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">override</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">protected</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> implicitClock </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">clock</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">asBool </span><span class="token operator" style="color:#393A34">||</span><span class="token plain"> gate</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">asClock</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p><code>ImplicitReset</code> works analogously to <code>ImplicitClock</code>.</p>
@@ -170,7 +170,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-minimize-the-number-
 <p>Note that top modules or public modules cannot have unknown widths.</p>
 <p>Unlike <code>Vecs</code> which represent a singular Chisel type and must have the same width for every element,
 <code>Seq</code> is a purely Scala construct, so their elements are independent from the perspective of Chisel and can have different widths.</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">CountBits</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> countVector_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               countVector_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               countVector_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               countVector_3</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">CountBits</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> countVector_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               countVector_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               countVector_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               countVector_3</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-resolve-dynamic-index--is-too-widenarrow-for-extractee-">How do I resolve &quot;Dynamic index ... is too wide/narrow for extractee ...&quot;?<a href="#how-do-i-resolve-dynamic-index--is-too-widenarrow-for-extractee-" class="hash-link" aria-label="Direct link to How do I resolve &quot;Dynamic index ... is too wide/narrow for extractee ...&quot;?" title="Direct link to How do I resolve &quot;Dynamic index ... is too wide/narrow for extractee ...&quot;?">​</a></h2>
 <p>Chisel will warn if a dynamic index is not the correctly-sized width for indexing a Vec or UInt.
 &quot;Correctly-sized&quot; means that the width of the index should be the log2 of the size of the indexee.
@@ -205,22 +205,22 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-get-chisel-to-name-t
 <p>Currently, name information is lost when using dynamic indexing. For example:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Foo </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Vec</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> idx </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> en </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">idx</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> y </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> x </span><span class="token operator" style="color:#393A34">&amp;&amp;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">en</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> y</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>The above code loses the <code>x</code> name, instead using <code>_GEN_3</code> (the other <code>_GEN_*</code> signals are expected).</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_3</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_idx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_en</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{{</span><span class="token plain">io_in_3</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_2</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_0</span><span class="token operator" style="color:#393A34">}}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">io_idx</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> io_en</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_3</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_idx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_en</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{{</span><span class="token plain">io_in_3</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_2</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_0</span><span class="token operator" style="color:#393A34">}}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">io_idx</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> io_en</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This can be worked around by creating a wire and connecting the dynamic index to the wire:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> WireInit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">idx</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Which produces:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_3</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_idx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_en</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{{</span><span class="token plain">io_in_3</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_2</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_0</span><span class="token operator" style="color:#393A34">}}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">io_idx</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> io_en</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_3</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_idx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_en</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{{</span><span class="token plain">io_in_3</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_2</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">io_in_0</span><span class="token operator" style="color:#393A34">}}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">io_idx</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> io_en</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-can-i-dynamically-setparametrize-the-name-of-a-module">How can I dynamically set/parametrize the name of a module?<a href="#how-can-i-dynamically-setparametrize-the-name-of-a-module" class="hash-link" aria-label="Direct link to How can I dynamically set/parametrize the name of a module?" title="Direct link to How can I dynamically set/parametrize the name of a module?">​</a></h3>
 <p>You can override the <code>desiredName</code> function. This works with normal Chisel modules and <code>BlackBox</code>es. Example:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Coffee </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> BlackBox </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> I </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> O </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">override</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> desiredName </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;Tea&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Salt </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> drink </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Coffee</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">override</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> desiredName </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;SodiumMonochloride&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    drink</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">I </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">42.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Elaborating the Chisel module <code>Salt</code> yields our &quot;desired names&quot; for <code>Salt</code> and <code>Coffee</code> in the output Verilog:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">SodiumMonochloride</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        reset</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  Tea drink </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">I </span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32&#x27;h2A</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">O </span><span class="token punctuation" style="color:#393A34">(</span><span class="token comment" style="color:#999988;font-style:italic">/* unused */</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">SodiumMonochloride</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        reset</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  Tea drink </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">I </span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32&#x27;h2A</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">O </span><span class="token punctuation" style="color:#393A34">(</span><span class="token comment" style="color:#999988;font-style:italic">/* unused */</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="directionality">Directionality<a href="#directionality" class="hash-link" aria-label="Direct link to Directionality" title="Direct link to Directionality">​</a></h2>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-strip-directions-from-a-bidirectional-bundle-or-other-data">How do I strip directions from a bidirectional Bundle (or other Data)?<a href="#how-do-i-strip-directions-from-a-bidirectional-bundle-or-other-data" class="hash-link" aria-label="Direct link to How do I strip directions from a bidirectional Bundle (or other Data)?" title="Direct link to How do I strip directions from a bidirectional Bundle (or other Data)?">​</a></h3>
 <p>Given a bidirectional port like a <code>Decoupled</code>, you will get an error if you try to connect it directly
 to a register:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">util</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">Decoupled</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> BadRegConnect </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> enq </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Decoupled</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> monitor </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Reg</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">chiselTypeOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">enq</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  monitor </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">enq</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">getVerilogString</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BadRegConnect</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// circt.stage.phases.Exceptions$FirtoolNonZeroExitCode: /home/runner/.cache/llvm-firtool/1.99.2/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+285-e12935ed-SNAPSHOT) was published against firtool version 1.99.2.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ------------------------------------------------------------------------------</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ExitCode:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// STDOUT:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// STDERR:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// cookbook.md:1039:20: error: &#x27;firrtl.reg&#x27; op result #0 must be a passive non-&#x27;const&#x27; base type that does not contain analog, but got &#x27;!firrtl.bundle&lt;ready flip: uint&lt;1&gt;, valid: uint&lt;1&gt;, bits: uint&lt;8&gt;&gt;&#x27;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// cookbook.md:1039:20: note: see current operation: %4 = &quot;firrtl.reg&quot;(%arg0) &lt;{annotations = [], name = &quot;monitor&quot;, nameKind = #firrtl&lt;name_kind interesting_name&gt;}&gt; : (!firrtl.clock) -&gt; !firrtl.bundle&lt;ready flip: uint&lt;1&gt;, valid: uint&lt;1&gt;, bits: uint&lt;8&gt;&gt;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ------------------------------------------------------------------------------</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">getVerilogString</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BadRegConnect</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// circt.stage.phases.Exceptions$FirtoolNonZeroExitCode: /home/runner/.cache/llvm-firtool/1.100.0/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+286-ba4e01c3-SNAPSHOT) was published against firtool version 1.100.0.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ------------------------------------------------------------------------------</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ExitCode:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// STDOUT:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// STDERR:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// cookbook.md:1039:20: error: &#x27;firrtl.reg&#x27; op result #0 must be a passive non-&#x27;const&#x27; base type that does not contain analog, but got &#x27;!firrtl.bundle&lt;ready flip: uint&lt;1&gt;, valid: uint&lt;1&gt;, bits: uint&lt;8&gt;&gt;&#x27;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// cookbook.md:1039:20: note: see current operation: %4 = &quot;firrtl.reg&quot;(%arg0) &lt;{annotations = [], name = &quot;monitor&quot;, nameKind = #firrtl&lt;name_kind interesting_name&gt;}&gt; : (!firrtl.clock) -&gt; !firrtl.bundle&lt;ready flip: uint&lt;1&gt;, valid: uint&lt;1&gt;, bits: uint&lt;8&gt;&gt;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ------------------------------------------------------------------------------</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>While there is no construct to &quot;strip direction&quot; in Chisel3, wrapping a type in <code>Output(...)</code>
 (the default direction in Chisel3) will
 set all of the individual elements to output direction.
diff --git a/docs/cookbooks/dataview.html b/docs/cookbooks/dataview.html
index 0128c7e12a..8306db71e0 100644
--- a/docs/cookbooks/dataview.html
+++ b/docs/cookbooks/dataview.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -37,7 +37,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-view-a-bundle-as-a-p
 <p>For viewing <code>Bundles</code> as the type of the parent, it is as simple as using <code>viewAsSupertype</code> and providing a
 template object of the parent type:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">dataview</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Foo </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Bar </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Foo </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  bar</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAsSupertype</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo </span><span class="token comment" style="color:#999988;font-style:italic">// bar.foo := foo.foo</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  bar</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bar </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">123.</span><span class="token plain">U           </span><span class="token comment" style="color:#999988;font-style:italic">// all fields need to be connected</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               bar_bar</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h7B</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               bar_bar</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h7B</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-view-a-bundle-as-a-parent-type-when-the-parent-type-is-abstract-like-a-trait">How do I view a Bundle as a parent type when the parent type is abstract (like a trait)?<a href="#how-do-i-view-a-bundle-as-a-parent-type-when-the-parent-type-is-abstract-like-a-trait" class="hash-link" aria-label="Direct link to How do I view a Bundle as a parent type when the parent type is abstract (like a trait)?" title="Direct link to How do I view a Bundle as a parent type when the parent type is abstract (like a trait)?">​</a></h3>
 <p>Given the following <code>Bundles</code> that share a common <code>trait</code>:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">dataview</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">trait</span><span class="token plain"> Super </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> bitwidth</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">bitwidth</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bitwidth</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Super </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bitwidth</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Super </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
@@ -65,6 +65,6 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-can-i-use-viewas-instead-
 The mapping of corresponding fields is automatically determined by Chisel to be the fields defined
 in the supertype.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">dataview</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">x</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">x</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> x</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">x</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">x</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Define a DataView without having to specify the mapping!</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">implicit</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> view</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> DataView</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">Bar</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> PartialDataView</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">supertype</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">Bar</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">b </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">b</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">x</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  bar</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">Foo</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo </span><span class="token comment" style="color:#999988;font-style:italic">// bar.foo := foo.foo</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  bar</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bar </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">123.</span><span class="token plain">U       </span><span class="token comment" style="color:#999988;font-style:italic">// all fields need to be connected</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               bar_bar</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h7B</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/dataview.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/cookbooks/hierarchy"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Hierarchy Cookbook</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/cookbooks/serialization"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Serialization Cookbook</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#how-do-i-view-a-data-as-a-uint-or-vice-versa" class="table-of-contents__link toc-highlight">How do I view a Data as a UInt or vice versa?</a></li><li><a href="#how-do-i-create-a-dataview-for-a-bundle-has-a-type-parameter" class="table-of-contents__link toc-highlight">How do I create a DataView for a Bundle has a type parameter?</a></li><li><a href="#how-do-i-create-a-dataview-for-a-bundle-with-optional-fields" class="table-of-contents__link toc-highlight">How do I create a DataView for a Bundle with optional fields?</a></li><li><a href="#how-do-i-connect-a-subset-of-bundle-fields" class="table-of-contents__link toc-highlight">How do I connect a subset of Bundle fields?</a><ul><li><a href="#how-do-i-view-a-bundle-as-a-parent-type-superclass" class="table-of-contents__link toc-highlight">How do I view a Bundle as a parent type (superclass)?</a></li><li><a href="#how-do-i-view-a-bundle-as-a-parent-type-when-the-parent-type-is-abstract-like-a-trait" class="table-of-contents__link toc-highlight">How do I view a Bundle as a parent type when the parent type is abstract (like a trait)?</a></li><li><a href="#how-can-i-use-viewas-instead-of-viewassupertypetype" class="table-of-contents__link toc-highlight">How can I use <code>.viewAs</code> instead of <code>.viewAsSupertype(type)</code>?</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs">Docs</a></li><li class="footer__item"><a href="/api/latest" target="_blank" rel="noopener noreferrer" class="footer__link-item">ScalaDoc</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/freechipsproject/chisel3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/chisel_lang" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ChipsAlliance. Built with Docusaurus.</div></div></div></footer></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               bar_bar</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h7B</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/dataview.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/cookbooks/hierarchy"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Hierarchy Cookbook</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/cookbooks/serialization"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Serialization Cookbook</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#how-do-i-view-a-data-as-a-uint-or-vice-versa" class="table-of-contents__link toc-highlight">How do I view a Data as a UInt or vice versa?</a></li><li><a href="#how-do-i-create-a-dataview-for-a-bundle-has-a-type-parameter" class="table-of-contents__link toc-highlight">How do I create a DataView for a Bundle has a type parameter?</a></li><li><a href="#how-do-i-create-a-dataview-for-a-bundle-with-optional-fields" class="table-of-contents__link toc-highlight">How do I create a DataView for a Bundle with optional fields?</a></li><li><a href="#how-do-i-connect-a-subset-of-bundle-fields" class="table-of-contents__link toc-highlight">How do I connect a subset of Bundle fields?</a><ul><li><a href="#how-do-i-view-a-bundle-as-a-parent-type-superclass" class="table-of-contents__link toc-highlight">How do I view a Bundle as a parent type (superclass)?</a></li><li><a href="#how-do-i-view-a-bundle-as-a-parent-type-when-the-parent-type-is-abstract-like-a-trait" class="table-of-contents__link toc-highlight">How do I view a Bundle as a parent type when the parent type is abstract (like a trait)?</a></li><li><a href="#how-can-i-use-viewas-instead-of-viewassupertypetype" class="table-of-contents__link toc-highlight">How can I use <code>.viewAs</code> instead of <code>.viewAsSupertype(type)</code>?</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs">Docs</a></li><li class="footer__item"><a href="/api/latest" target="_blank" rel="noopener noreferrer" class="footer__link-item">ScalaDoc</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/freechipsproject/chisel3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/chisel_lang" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ChipsAlliance. Built with Docusaurus.</div></div></div></footer></div>
 </body>
 </html>
\ No newline at end of file
diff --git a/docs/cookbooks/hierarchy.html b/docs/cookbooks/hierarchy.html
index 40c8fc6aa9..c5eb283b6c 100644
--- a/docs/cookbooks/hierarchy.html
+++ b/docs/cookbooks/hierarchy.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -35,12 +35,12 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="using-definition-and-instance
 <p>In the following example, use <code>Definition</code>, <code>Instance</code>, <code>@instantiable</code> and <code>@public</code> to create
 multiple instances of one specific parameterization of a module, <code>AddOne</code>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">hierarchy</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">Definition</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> instantiable</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> public</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token annotation punctuation" style="color:#393A34">@instantiable</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AddTwo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> addOneDef </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Definition</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> i0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">addOneDef</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> i1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">addOneDef</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  i0</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  i1</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> i0</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out   </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> i1</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">10&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddTwo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _i0_out</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i0 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">10&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddTwo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _i0_out</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i0 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="using-instantiate">Using Instantiate<a href="#using-instantiate" class="hash-link" aria-label="Direct link to Using Instantiate" title="Direct link to Using Instantiate">​</a></h3>
 <p>Similar to the above, the following example uses <code>Instantiate</code> to create
 multiple instances of <code>AddOne</code>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">hierarchy</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">Instantiate</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AddTwoInstantiate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> i0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Instantiate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> i1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Instantiate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  i0</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  i1</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> i0</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out   </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> i1</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">16&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddTwoInstantiate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _i0_out</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i0 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">16&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddTwoInstantiate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">15</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _i0_out</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i0 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-access-internal-fields-of-an-instance">How do I access internal fields of an instance?<a href="#how-do-i-access-internal-fields-of-an-instance" class="hash-link" aria-label="Direct link to How do I access internal fields of an instance?" title="Direct link to How do I access internal fields of an instance?">​</a></h2>
 <p>You can mark internal members of a Module class or trait marked with <code>@instantiable</code> with the <code>@public</code> annotation.
 The requirements are that the field is publicly accessible, is a <code>val</code> or <code>lazy val</code>, and must have an implementation of <code>Lookupable</code>.</p>
@@ -72,7 +72,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-make-my-fields-acces
 you are careful about what you mark as <code>IsLookupable</code>.</p>
 <p>In the following example, we added the trait <code>IsLookupable</code> to allow the member to be marked <code>@public</code>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">hierarchy</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">Definition</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> instantiable</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> IsLookupable</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> public</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">case</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyCaseClass</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> IsLookupable</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token annotation punctuation" style="color:#393A34">@instantiable</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> MyCaseClass</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">10</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Top </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> inst </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Definition</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyModule</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  println</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string-interpolation id function" style="color:#d73a49">s</span><span class="token string-interpolation string" style="color:#e3116c">&quot;Width is </span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">${</span><span class="token string-interpolation interpolation expression">inst</span><span class="token string-interpolation interpolation expression punctuation" style="color:#393A34">.</span><span class="token string-interpolation interpolation expression">x</span><span class="token string-interpolation interpolation expression punctuation" style="color:#393A34">.</span><span class="token string-interpolation interpolation expression">width</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">}</span><span class="token string-interpolation string" style="color:#e3116c">&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Width is 10</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Circuit(Top,List(DefModule(repl.MdocSession$MdocApp5$MyModule@1b9e5c8d,MyModule,false,List(),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2))),chisel3.internal.firrtl.ir$Block@7863f906), DefModule(repl.MdocSession$MdocApp5$Top@38208fda,Top,true,List(),List(Port(Top.clock: IO[Clock],Input,SourceLine(hierarchy.md,111,7)), Port(Top.reset: IO[Bool],Input,SourceLine(hierarchy.md,111,7))),chisel3.internal.firrtl.ir$Block@f1b1c23)),List(),firrtl.renamemap.package$MutableRenameMap@66884379,List(),List(),List(Layer(UnlocatableSourceInfo,Verification,Extract(Some(verification)),List(Layer(UnlocatableSourceInfo,Assert,Extract(Some(verification/assert)),List(),chisel3.layers.Verification$Assert$@626d0a28), Layer(UnlocatableSourceInfo,Assume,Extract(Some(verification/assume)),List(),chisel3.layers.Verification$Assume$@5dc8f7c8), Layer(UnlocatableSourceInfo,Cover,Extract(Some(verification/cover)),List(),chisel3.layers.Verification$Cover$@786bcd48)),chisel3.layers.Verification$@7e5d979b)),List())</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Width is 10</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Circuit(Top,List(DefModule(repl.MdocSession$MdocApp5$MyModule@6ab0bed4,MyModule,false,List(),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2))),chisel3.internal.firrtl.ir$Block@3f49e283), DefModule(repl.MdocSession$MdocApp5$Top@48234eb8,Top,true,List(),List(Port(Top.clock: IO[Clock],Input,SourceLine(hierarchy.md,111,7)), Port(Top.reset: IO[Bool],Input,SourceLine(hierarchy.md,111,7))),chisel3.internal.firrtl.ir$Block@5abd5a92)),List(),firrtl.renamemap.package$MutableRenameMap@3514090f,List(),List(),List(Layer(UnlocatableSourceInfo,Verification,Extract(Some(verification)),List(Layer(UnlocatableSourceInfo,Assert,Extract(Some(verification/assert)),List(),chisel3.layers.Verification$Assert$@21b8322f), Layer(UnlocatableSourceInfo,Assume,Extract(Some(verification/assume)),List(),chisel3.layers.Verification$Assume$@73ad8b1b), Layer(UnlocatableSourceInfo,Cover,Extract(Some(verification/cover)),List(),chisel3.layers.Verification$Cover$@4e09695)),chisel3.layers.Verification$@59ec2429)),List())</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-make-case-classes-containing-data-or-modules-accessible-from-an-instance">How do I make case classes containing Data or Modules accessible from an instance?<a href="#how-do-i-make-case-classes-containing-data-or-modules-accessible-from-an-instance" class="hash-link" aria-label="Direct link to How do I make case classes containing Data or Modules accessible from an instance?" title="Direct link to How do I make case classes containing Data or Modules accessible from an instance?">​</a></h2>
 <p>For case classes containing <code>Data</code>, <code>BaseModule</code>, <code>MemBase</code> or <code>Instance</code> types, you can provide an implementation of the <code>Lookupable</code> typeclass.</p>
 <p><strong>Note that Lookupable for Modules is deprecated, please cast to Instance instead (with <code>.toInstance</code>).</strong></p>
@@ -105,7 +105,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-look-up-fields-from-
 <p>Just like <code>Instance</code>s, <code>Definition</code>&#x27;s also contain accessors for <code>@public</code> members.
 As such, you can directly access them:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">hierarchy</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">Definition</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> instantiable</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> public</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token annotation punctuation" style="color:#393A34">@instantiable</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> width</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> width </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> width</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Top </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> definition </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Definition</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">10</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  println</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string-interpolation id function" style="color:#d73a49">s</span><span class="token string-interpolation string" style="color:#e3116c">&quot;Width is: </span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">${</span><span class="token string-interpolation interpolation expression">definition</span><span class="token string-interpolation interpolation expression punctuation" style="color:#393A34">.</span><span class="token string-interpolation interpolation expression">width</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">}</span><span class="token string-interpolation string" style="color:#e3116c">&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Top</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        reset</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Top</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        reset</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-parameterize-a-module-by-its-children-instances">How do I parameterize a module by its children instances?<a href="#how-do-i-parameterize-a-module-by-its-children-instances" class="hash-link" aria-label="Direct link to How do I parameterize a module by its children instances?" title="Direct link to How do I parameterize a module by its children instances?">​</a></h2>
 <p>Prior to the introduction of this package, a parent module would have to pass all necessary parameters
 when instantiating a child module.
@@ -117,7 +117,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-parameterize-a-modul
 <p>In the following example, we create a definition of <code>AddOne</code>, and pass the definition to <code>AddTwo</code>.
 The width of the <code>AddTwo</code> ports are now derived from the parameterization of the <code>AddOne</code> instance.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">hierarchy</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">Definition</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> instantiable</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> public</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token annotation punctuation" style="color:#393A34">@instantiable</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> width</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> width </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> width</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AddTwo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">addOneDef</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Definition</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">AddOne</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> i0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">addOneDef</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> i1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">addOneDef</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">addOneDef</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">addOneDef</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  i0</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  i1</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> i0</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out   </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> i1</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">10&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddTwo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _i0_out</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i0 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddOne</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">10&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AddTwo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _i0_out</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i0 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  AddOne i1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_i0_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-use-the-new-hierarchy-specific-select-functions">How do I use the new hierarchy-specific Select functions?<a href="#how-do-i-use-the-new-hierarchy-specific-select-functions" class="hash-link" aria-label="Direct link to How do I use the new hierarchy-specific Select functions?" title="Direct link to How do I use the new hierarchy-specific Select functions?">​</a></h2>
 <p>Select functions can be applied after a module has been elaborated, either in a Chisel Aspect or in a parent module applied to a child module.</p>
 <p>There are seven hierarchy-specific functions, which (with the exception of <code>ios</code>) either return <code>Instance</code>&#x27;s or <code>Definition</code>&#x27;s:</p>
diff --git a/docs/cookbooks/naming.html b/docs/cookbooks/naming.html
index 53b970a77f..47ad63f807 100644
--- a/docs/cookbooks/naming.html
+++ b/docs/cookbooks/naming.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -26,11 +26,11 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="i-have-so-many-wires-with-the
 intermediate signals and can&#x27;t name them at all or has to make up a unique name for them.</p>
 <p>We recommend you manually insert calls to <code>prefix</code> to clarify these cases:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">prefix</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> ExamplePrefix </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  Seq</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">tabulate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> i </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    Seq</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">tabulate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> j </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      prefix</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string-interpolation id function" style="color:#d73a49">s</span><span class="token string-interpolation string" style="color:#e3116c">&quot;loop_</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">${</span><span class="token string-interpolation interpolation expression">i</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">}</span><span class="token string-interpolation string" style="color:#e3116c">_</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">${</span><span class="token string-interpolation interpolation expression">j</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">}</span><span class="token string-interpolation string" style="color:#e3116c">&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> WireInit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">i</span><span class="token operator" style="color:#393A34">*</span><span class="token number" style="color:#36acaa">0x10</span><span class="token operator" style="color:#393A34">+</span><span class="token plain">j</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        dontTouch</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">x</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ExamplePrefix</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        reset</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> loop_0_0_x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> loop_0_1_x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> loop_1_0_x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h10</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> loop_1_1_x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h11</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ExamplePrefix</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        reset</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> loop_0_0_x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> loop_0_1_x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> loop_1_0_x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h10</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> loop_1_1_x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8&#x27;h11</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-can-i-get-better-names-for-code-generated-by-when-clauses">How can I get better names for code generated by <code>when</code> clauses?<a href="#how-can-i-get-better-names-for-code-generated-by-when-clauses" class="hash-link" aria-label="Direct link to how-can-i-get-better-names-for-code-generated-by-when-clauses" title="Direct link to how-can-i-get-better-names-for-code-generated-by-when-clauses">​</a></h3>
 <p>The <code>prefix</code> API can help with code inside <code>when</code> clauses:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> ExampleWhenPrefix </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  Seq</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">tabulate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> i </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> j </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> i </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    prefix</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string-interpolation id function" style="color:#d73a49">s</span><span class="token string-interpolation string" style="color:#e3116c">&quot;clause_</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">${</span><span class="token string-interpolation interpolation expression">j</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">}</span><span class="token string-interpolation string" style="color:#e3116c">&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      when </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">==</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> j</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Reg</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        foo </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> j</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ExampleWhenPrefix</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> clause_1_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> clause_2_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    clause_1_foo </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    clause_2_foo </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h2</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">==</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h2</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">?</span><span class="token plain"> clause_2_foo </span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> clause_1_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ExampleWhenPrefix</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> clause_1_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> clause_2_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    clause_1_foo </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    clause_2_foo </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h2</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">==</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h2</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">?</span><span class="token plain"> clause_2_foo </span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> clause_1_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="i-still-see-_gen-signals-can-this-be-fixed">I still see _GEN signals, can this be fixed?<a href="#i-still-see-_gen-signals-can-this-be-fixed" class="hash-link" aria-label="Direct link to I still see _GEN signals, can this be fixed?" title="Direct link to I still see _GEN signals, can this be fixed?">​</a></h3>
 <p><code>_GEN</code> signals are usually generated from the FIRRTL compiler, rather than the Chisel library. We are working on
 renaming these signals with more context-dependent names, but it is a work in progress. Thanks for caring!</p>
@@ -86,11 +86,11 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="i-want-to-force-a-signal-or-i
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-can-i-omit-the-prefix-in-certain-parts-of-the-code">How can I omit the prefix in certain parts of the code?<a href="#how-can-i-omit-the-prefix-in-certain-parts-of-the-code" class="hash-link" aria-label="Direct link to How can I omit the prefix in certain parts of the code?" title="Direct link to How can I omit the prefix in certain parts of the code?">​</a></h3>
 <p>You can use the <code>noPrefix { ... }</code> to strip the prefix from all signals generated in that scope.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">noPrefix</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> ExampleNoPrefix </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">5.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> add </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> noPrefix </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// foo will not get a prefix</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    foo </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> add</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ExampleNoPrefix</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    foo </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">3&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ExampleNoPrefix</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    foo </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">3&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="i-am-still-not-getting-the-name-i-want-for-example-inlining-an-instance-changes-my-name">I am still not getting the name I want. For example, inlining an instance changes my name!<a href="#i-am-still-not-getting-the-name-i-want-for-example-inlining-an-instance-changes-my-name" class="hash-link" aria-label="Direct link to I am still not getting the name I want. For example, inlining an instance changes my name!" title="Direct link to I am still not getting the name I want. For example, inlining an instance changes my name!">​</a></h3>
 <p>In cases where a FIRRTL transform renames a signal/instance, you can use the <code>forcename</code> API:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">util</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">forceName</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> InlineInstance</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> WrapperExample </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> inst </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Wrapper</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  inst</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> inst</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Wrapper </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token keyword" style="color:#00009f">with</span><span class="token plain"> InlineInstance </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> inst </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyLeaf</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  forceName</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">inst</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;inst&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  inst</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> inst</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyLeaf </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyLeaf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">WrapperExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  MyLeaf inst </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyLeaf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">WrapperExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  MyLeaf inst </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This can be used to rename instances and non-aggregate typed signals.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/naming.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/cookbooks/cookbook"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">General Cookbook</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/cookbooks/hierarchy"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Hierarchy Cookbook</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#i-still-have-_t-signals-can-this-be-fixed" class="table-of-contents__link toc-highlight">I still have _T signals, can this be fixed?</a></li><li><a href="#i-have-so-many-wires-with-the-same-name-like-x-x_1-and-x_2-how-can-i-make-them-easier-to-understand" class="table-of-contents__link toc-highlight">I have so many wires with the same name, like <code>x</code>, <code>x_1</code> and <code>x_2</code>. How can I make them easier to understand?</a></li><li><a href="#how-can-i-get-better-names-for-code-generated-by-when-clauses" class="table-of-contents__link toc-highlight">How can I get better names for code generated by <code>when</code> clauses?</a></li><li><a href="#i-still-see-_gen-signals-can-this-be-fixed" class="table-of-contents__link toc-highlight">I still see _GEN signals, can this be fixed?</a></li><li><a href="#how-do-i-make-my-modules-have-more-stable-names-instead-of-module_1-and-module_42" class="table-of-contents__link toc-highlight">How do I make my modules have more stable names instead of &#39;Module_1&#39; and &#39;Module_42&#39;?</a></li><li><a href="#how-would-i-write-my-own-typename-for-my-data-types" class="table-of-contents__link toc-highlight">How would I write my own <code>typeName</code> for my data types?</a></li><li><a href="#i-dont-want-to-override-typename-over-and-over-is-there-any-easy-way-to-generate-a-typename" class="table-of-contents__link toc-highlight">I don&#39;t want to override <code>typeName</code> over and over! Is there any easy way to generate a <code>typeName</code>?</a></li><li><a href="#can-i-name-my-bundles-in-firrtl-so-i-dont-generate-extremely-long-bundle-types" class="table-of-contents__link toc-highlight">Can I name my bundles in FIRRTL, so I don&#39;t generate extremely long bundle types?</a></li><li><a href="#why-do-i-keep-seeing-_stripped-suffixing-everywhere-in-my-firrtl-i-didnt-specify-that-in-my-aliasname" class="table-of-contents__link toc-highlight">Why do I keep seeing _stripped suffixing everywhere in my FIRRTL? I didn&#39;t specify that in my <code>aliasName</code>.</a></li><li><a href="#i-want-to-add-some-hardware-or-assertions-but-each-time-i-do-all-the-signal-names-get-bumped" class="table-of-contents__link toc-highlight">I want to add some hardware or assertions, but each time I do all the signal names get bumped!</a></li><li><a href="#i-want-to-force-a-signal-or-instance-name-to-something-how-do-i-do-that" class="table-of-contents__link toc-highlight">I want to force a signal (or instance) name to something, how do I do that?</a></li><li><a href="#how-can-i-omit-the-prefix-in-certain-parts-of-the-code" class="table-of-contents__link toc-highlight">How can I omit the prefix in certain parts of the code?</a></li><li><a href="#i-am-still-not-getting-the-name-i-want-for-example-inlining-an-instance-changes-my-name" class="table-of-contents__link toc-highlight">I am still not getting the name I want. For example, inlining an instance changes my name!</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs">Docs</a></li><li class="footer__item"><a href="/api/latest" target="_blank" rel="noopener noreferrer" class="footer__link-item">ScalaDoc</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/freechipsproject/chisel3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/chisel_lang" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ChipsAlliance. Built with Docusaurus.</div></div></div></footer></div>
 </body>
 </html>
\ No newline at end of file
diff --git a/docs/cookbooks/objectmodel.html b/docs/cookbooks/objectmodel.html
index 9795e31cd6..c3aa26d000 100644
--- a/docs/cookbooks/objectmodel.html
+++ b/docs/cookbooks/objectmodel.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/serialization.html b/docs/cookbooks/serialization.html
index 5eee30e1ae..0a2fa59da1 100644
--- a/docs/cookbooks/serialization.html
+++ b/docs/cookbooks/serialization.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/troubleshooting.html b/docs/cookbooks/troubleshooting.html
index 636ec24baf..e13bfc9bf9 100644
--- a/docs/cookbooks/troubleshooting.html
+++ b/docs/cookbooks/troubleshooting.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers.html b/docs/developers.html
index 954ee3f4ae..0ceb0d2bfd 100644
--- a/docs/developers.html
+++ b/docs/developers.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers/lit-test.html b/docs/developers/lit-test.html
index da612e9254..061bb66d99 100644
--- a/docs/developers/lit-test.html
+++ b/docs/developers/lit-test.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers/scaladoc.html b/docs/developers/scaladoc.html
index c5523422ee..5778abb38a 100644
--- a/docs/developers/scaladoc.html
+++ b/docs/developers/scaladoc.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers/style.html b/docs/developers/style.html
index 736c06f30d..d0c211ac8d 100644
--- a/docs/developers/style.html
+++ b/docs/developers/style.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers/test-coverage.html b/docs/developers/test-coverage.html
index 7d6c69e5f8..fc1d521b7b 100644
--- a/docs/developers/test-coverage.html
+++ b/docs/developers/test-coverage.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations.html b/docs/explanations.html
index 03ffc5a7c7..e3af3e6459 100644
--- a/docs/explanations.html
+++ b/docs/explanations.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/annotations.html b/docs/explanations/annotations.html
index c3083a54db..8a2142236c 100644
--- a/docs/explanations/annotations.html
+++ b/docs/explanations/annotations.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/blackboxes.html b/docs/explanations/blackboxes.html
index b3bda3d531..697b047c19 100644
--- a/docs/explanations/blackboxes.html
+++ b/docs/explanations/blackboxes.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/bundles-and-vecs.html b/docs/explanations/bundles-and-vecs.html
index 2e1ac6bc48..94e5934ce3 100644
--- a/docs/explanations/bundles-and-vecs.html
+++ b/docs/explanations/bundles-and-vecs.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -40,7 +40,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="flipping-bundles">Flipping Bu
 <p>The <code>Flipped()</code> function recursively flips all elements in a Bundle/Record. This is very useful for building bidirectional interfaces that connect to each other (e.g. <code>Decoupled</code>). See below for an example.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> ABBundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyFlippedModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Normal instantiation of the bundle</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// &#x27;a&#x27; is an Input and &#x27;b&#x27; is an Output</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> normalBundle </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ABBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  normalBundle</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> normalBundle</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Flipped recursively flips the direction of all Bundle fields</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Now &#x27;a&#x27; is an Output and &#x27;b&#x27; is an Input</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> flippedBundle </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ABBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  flippedBundle</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> flippedBundle</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyFlippedModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  normalBundle_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> normalBundle_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         flippedBundle_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  flippedBundle_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> normalBundle_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> normalBundle_a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> flippedBundle_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> flippedBundle_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyFlippedModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  normalBundle_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> normalBundle_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         flippedBundle_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  flippedBundle_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> normalBundle_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> normalBundle_a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> flippedBundle_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> flippedBundle_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="mixedvec">MixedVec<a href="#mixedvec" class="hash-link" aria-label="Direct link to MixedVec" title="Direct link to MixedVec">​</a></h3>
 <p>(Chisel 3.2+)</p>
 <p>All elements of a <code>Vec</code> must have the same parameterization. If we want to create a Vec where the elements have the same type but different parameterizations, we can use a MixedVec:</p>
diff --git a/docs/explanations/chisel-enum.html b/docs/explanations/chisel-enum.html
index 5a09e8372b..6d4b544747 100644
--- a/docs/explanations/chisel-enum.html
+++ b/docs/explanations/chisel-enum.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -22,7 +22,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="functionality-and-examples">F
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// package CPUTypes {</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">object</span><span class="token plain"> AluMux1Sel </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> ChiselEnum </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> selectRS1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> selectPC </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Value</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// We can see the mapping by printing each Value</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">AluMux1Sel</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">all</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">foreach</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">println</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// AluMux1Sel(0=selectRS1)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// AluMux1Sel(1=selectPC)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Here we see a mux using the AluMux1Sel to select between different inputs.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> AluMux1Sel</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AluMux1Bundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> aluMux1Sel </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">AluMux1Sel</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> rs1Out     </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bits</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> pcOut      </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bits</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> aluMux1Out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bits</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AluMux1File </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AluMux1Bundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Default value for aluMux1Out</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aluMux1Out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  switch </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aluMux1Sel</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    is </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">selectRS1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aluMux1Out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">rs1Out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    is </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">selectPC</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aluMux1Out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">pcOut</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AluMux1File</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                io_aluMux1Sel</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_rs1Out</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                io_pcOut</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_aluMux1Out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_aluMux1Out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_aluMux1Sel </span><span class="token operator" style="color:#393A34">?</span><span class="token plain"> io_pcOut </span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> io_rs1Out</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AluMux1File</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                io_aluMux1Sel</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_rs1Out</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                io_pcOut</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_aluMux1Out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_aluMux1Out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_aluMux1Sel </span><span class="token operator" style="color:#393A34">?</span><span class="token plain"> io_pcOut </span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> io_rs1Out</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>ChiselEnum also allows for the user to directly set the Values by passing an <code>UInt</code> to <code>Value(...)</code>
 as shown below. Note that the magnitude of each <code>Value</code> must be strictly greater than the one before
 it.</p>
diff --git a/docs/explanations/chisel-type-vs-scala-type.html b/docs/explanations/chisel-type-vs-scala-type.html
index 8eb40e5197..0fce33de77 100644
--- a/docs/explanations/chisel-type-vs-scala-type.html
+++ b/docs/explanations/chisel-type-vs-scala-type.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -65,12 +65,12 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="asinstanceof-vs-astypeof-vs-c
 <p>This works if we do indeed have more information than the compiler:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">elaborate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ScalaCastingModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>But if we are wrong, we can get a Scala runtime exception:</p>
-<div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> NotMyBundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> baz </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">elaborate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ScalaCastingModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> NotMyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// java.lang.ClassCastException: class repl.MdocSession$MdocApp$$anonfun$79$NotMyBundle$1 cannot be cast to class repl.MdocSession$MdocApp$MyBundle (repl.MdocSession$MdocApp$$anonfun$79$NotMyBundle$1 and repl.MdocSession$MdocApp$MyBundle are in unnamed module of loader scala.reflect.internal.util.AbstractFileClassLoader @527e2530)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.SpecifiedDirection$.specifiedDirection(DataImpl.scala:73)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Output$.apply(DataImpl.scala:320)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.IO$.apply(IO.scala:34)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.experimental.BaseModule.IO(ModuleImpl.scala:927)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.experimental.prefix$.apply(prefix.scala:50)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule.&lt;init&gt;(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$.evaluate(Module.scala:10)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$._applyImpl(Module.scala:10)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$.do_apply(Module.scala:22)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.Builder$.buildImpl(Builder.scala:1080)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at logger.Logger$.makeScope(Logger.scala:146)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at logger.Logger$.makeScope(Logger.scala:133)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at ... ()</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> NotMyBundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> baz </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">elaborate</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> ScalaCastingModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> NotMyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// java.lang.ClassCastException: class repl.MdocSession$MdocApp$$anonfun$79$NotMyBundle$1 cannot be cast to class repl.MdocSession$MdocApp$MyBundle (repl.MdocSession$MdocApp$$anonfun$79$NotMyBundle$1 and repl.MdocSession$MdocApp$MyBundle are in unnamed module of loader scala.reflect.internal.util.AbstractFileClassLoader @365431ae)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.SpecifiedDirection$.specifiedDirection(DataImpl.scala:73)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Output$.apply(DataImpl.scala:320)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.IO$.apply(IO.scala:34)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.experimental.BaseModule.IO(ModuleImpl.scala:927)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.experimental.prefix$.apply(prefix.scala:50)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule.&lt;init&gt;(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$.evaluate(Module.scala:10)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$._applyImpl(Module.scala:10)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$.do_apply(Module.scala:22)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.Builder$.buildImpl(Builder.scala:1080)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at logger.Logger$.makeScope(Logger.scala:146)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at logger.Logger$.makeScope(Logger.scala:133)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at ... ()</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p><code>.asTypeOf</code> is a conversion from one <code>Data</code> subclass to another.
 It is commonly used to assign data to all-zeros, as described in <a href="https://www.chisel-lang.org/chisel3/docs/cookbooks/cookbook.html#how-can-i-tieoff-a-bundlevec-to-0" target="_blank" rel="noopener noreferrer">this cookbook recipe</a>, but it can
 also be used (though not really recommended, as there is no checking on
 width matches) to convert one Chisel type to another:</p>
-<div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> SimilarToMyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">w</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foobar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token operator" style="color:#393A34">*</span><span class="token plain">w</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">emitSystemVerilog</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> SimilarToMyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">asTypeOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// res12: String = &quot;&quot;&quot;// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// module _82_Anon(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        clock,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//                reset,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input  [2:0] in_foo,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//                in_bar,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output [5:0] out_foobar</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   assign out_foobar = {in_foo, in_bar};</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// &quot;&quot;&quot;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> SimilarToMyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">w</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foobar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token operator" style="color:#393A34">*</span><span class="token plain">w</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">emitSystemVerilog</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> SimilarToMyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">asTypeOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// res12: String = &quot;&quot;&quot;// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// module _82_Anon(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        clock,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//                reset,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input  [2:0] in_foo,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//                in_bar,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output [5:0] out_foobar</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   assign out_foobar = {in_foo, in_bar};</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// &quot;&quot;&quot;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>In contrast to <code>asInstanceOf</code> and <code>asTypeOf</code>,
 <code>chiselTypeOf</code> is not a casting operation. It returns a Scala object which
 can be used as shown in the examples above to create more Chisel types and
diff --git a/docs/explanations/combinational-circuits.html b/docs/explanations/combinational-circuits.html
index 8a2c8918d2..cfe23fac0e 100644
--- a/docs/explanations/combinational-circuits.html
+++ b/docs/explanations/combinational-circuits.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/connectable.html b/docs/explanations/connectable.html
index 42bcbc149f..cf5467ea93 100644
--- a/docs/explanations/connectable.html
+++ b/docs/explanations/connectable.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -221,7 +221,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="mono-direction-connection-ope
 <p>For simple connections where all members are aligned (non-flipped) w.r.t. one another, use <code>:=</code>:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> FullyAlignedBundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example0 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> incoming </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> FullyAlignedBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> outgoing </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> FullyAlignedBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  outgoing </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where each member of <code>incoming</code> drives every member of <code>outgoing</code>:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example0</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  incoming_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         incoming_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> outgoing_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         outgoing_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming_a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example0</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  incoming_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         incoming_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> outgoing_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         outgoing_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming_a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <blockquote>
 <p>You may be thinking &quot;Wait, I&#x27;m confused! Isn&#x27;t <code>incoming</code> flipped and <code>outgoing</code> aligned?&quot; -- Noo! Whether <code>incoming</code> is aligned with <code>outgoing</code> makes no sense; remember, you only evaluate alignment between members of the same component or Chisel type.
 Because components are always aligned to themselves, <code>outgoing</code> is aligned to <code>outgoing</code>, and <code>incoming</code> is aligned to <code>incoming</code>, there is no problem.
@@ -237,7 +237,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="bi-direction-connection-opera
 <p>For connections where you want &#x27;bulk-connect-like-semantics&#x27; where the aligned members are driven producer-to-consumer and flipped members are driven consumer-to-producer, use <code>:&lt;&gt;=</code>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example1 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> incoming </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> outgoing </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  outgoing </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where the aligned members are driven <code>incoming</code> to <code>outgoing</code> and flipped members are driven <code>outgoing</code> to <code>incoming</code>:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> incoming_flippedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         outgoing_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  outgoing_flippedChild</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> incoming_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> outgoing_flippedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> incoming_flippedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         outgoing_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  outgoing_flippedChild</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> incoming_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> outgoing_flippedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="port-direction-computation-versus-connection-direction-computation">Port-Direction Computation versus Connection-Direction Computation<a href="#port-direction-computation-versus-connection-direction-computation" class="hash-link" aria-label="Direct link to Port-Direction Computation versus Connection-Direction Computation" title="Direct link to Port-Direction Computation versus Connection-Direction Computation">​</a></h3>
 <p>A common question is if you use a mixed-alignment connection (such as <code>:&lt;&gt;=</code>) to connect submembers of parent components, does the alignment of the submember to their parent affect anything? The answer is no, because <em>alignment is always computed relative to what is being connected to, and members are always aligned with themselves.</em></p>
 <p>In the following example connecting from <code>incoming.alignedChild</code> to <code>outgoing.alignedChild</code>, whether <code>incoming.alignedChild</code> is aligned with <code>incoming</code> is irrelevant because the <code>:&lt;&gt;=</code> only computes alignment relative to the thing being connected to, and <code>incoming.alignedChild</code> is aligned with <code>incoming.alignedChild</code>.</p>
@@ -261,12 +261,12 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="aligned-connection-operator-"
 <p>For connections where you want the aligned-half of &#x27;bulk-connect-like-semantics&#x27; where the aligned members are driven producer-to-consumer and flipped members are ignored, use <code>:&lt;=</code> (the &quot;aligned connection&quot;).</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example2 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> incoming </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> outgoing </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  incoming</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">flippedChild </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare </span><span class="token comment" style="color:#999988;font-style:italic">// Otherwise FIRRTL throws an uninitialization error</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  outgoing </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> incoming</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where the aligned members are driven <code>incoming</code> to <code>outgoing</code> and flipped members are ignored:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> incoming_flippedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         outgoing_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  outgoing_flippedChild</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> incoming_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> incoming_flippedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         outgoing_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  outgoing_flippedChild</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> incoming_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="flipped-connection-operator-">Flipped connection operator (<code>:&gt;=</code>)<a href="#flipped-connection-operator-" class="hash-link" aria-label="Direct link to flipped-connection-operator-" title="Direct link to flipped-connection-operator-">​</a></h3>
 <p>For connections where you want the flipped-half of &#x27;bulk-connect-like-semantics&#x27; where the aligned members are ignored and flipped members are connected consumer-to-producer, use <code>:&gt;=</code> (the &quot;flipped connection&quot;, or &quot;backpressure connection&quot;).</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example3 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> incoming </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> outgoing </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  outgoing</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">alignedChild </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare </span><span class="token comment" style="color:#999988;font-style:italic">// Otherwise FIRRTL throws an uninitialization error</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  outgoing </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">&gt;=</span><span class="token plain"> incoming</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where the aligned members are ignored and the flipped members are driven <code>outgoing</code> to <code>incoming</code>:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example3</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> incoming_flippedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         outgoing_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  outgoing_flippedChild</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> incoming_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> outgoing_flippedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example3</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  incoming_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> incoming_flippedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         outgoing_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  outgoing_flippedChild</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> incoming_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> outgoing_flippedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> outgoing_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <blockquote>
 <p>Note: Astute observers will realize that <code>c :&lt;&gt;= p</code> is semantically equivalent to <code>c :&lt;= p</code> followed by <code>c :&gt;= p</code>.</p>
 </blockquote>
@@ -275,14 +275,14 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="coercing-mono-direction-conne
 This operator is useful for initializing wires whose types contain members of mixed alignment.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">BundleLiterals</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example4 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> w </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Wire</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  dontTouch</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">w</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// So we see it in the output Verilog</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  w </span><span class="token operator" style="color:#393A34">:</span><span class="token plain">#</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">alignedChild </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">flippedChild </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where all members are driven from the literal to <code>w</code>, regardless of alignment:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example4</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> w_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> w_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example4</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> w_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> w_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <blockquote>
 <p>Note: Astute observers will realize that <code>c :#= p</code> is semantically equivalent to <code>c :&lt;= p</code> followed by <code>p :&gt;= c</code> (note <code>p</code> and <code>c</code> switched places in the second connection).</p>
 </blockquote>
 <p>Another use case for <code>:#=</code> is for connecting a mixed-directional bundle to a fully-aligned monitor.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">BundleLiterals</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example4b </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> monitor </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> w </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Wire</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MixedAlignmentBundle</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  dontTouch</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">w</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// So we see it in the output Verilog</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  w </span><span class="token operator" style="color:#393A34">:</span><span class="token plain">#</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  monitor </span><span class="token operator" style="color:#393A34">:</span><span class="token plain">#</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> w</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where all members are driven from the literal to <code>w</code>, regardless of alignment:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example4b</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> monitor_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         monitor_flippedChild</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> w_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> w_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> monitor_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> w_alignedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> monitor_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> w_flippedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example4b</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> monitor_alignedChild</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">         monitor_flippedChild</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> w_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> w_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> monitor_alignedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> w_alignedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> monitor_flippedChild </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> w_flippedChild</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="connectable">Connectable<a href="#connectable" class="hash-link" aria-label="Direct link to Connectable" title="Direct link to Connectable">​</a></h2>
 <p>Sometimes a user wants to connect Chisel components which are not type equivalent.
 For example, a user may want to hook up anonymous <code>Record</code> components who may have an intersection of their fields being equivalent, but cannot because they are not structurally equivalent.
@@ -300,38 +300,38 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="connecting-records">Connectin
 </blockquote>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">scala</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">collection</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">immutable</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">SeqMap</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example9 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> abType </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Record </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> elements </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> SeqMap</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;a&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;b&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bcType </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Record </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> elements </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> SeqMap</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;b&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;c&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">abType</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">bcType</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  DontCare </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">&gt;=</span><span class="token plain"> p</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waive</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">elements</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;c&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waive</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">elements</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;a&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where <code>p.b</code> is driven from <code>c.b</code>:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example9</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> p_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  p_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> c_c</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  c_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> p_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> c_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> c_c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example9</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> p_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  p_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> c_c</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  c_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> p_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> c_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> c_c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="defaults-with-waived-connections">Defaults with waived connections<a href="#defaults-with-waived-connections" class="hash-link" aria-label="Direct link to Defaults with waived connections" title="Direct link to Defaults with waived connections">​</a></h3>
 <p>Another use case is to try to connect two <code>Record</code>s; for matching members, they should be connected, but for unmatched members, <em>they should be connected to a default value</em>.
 To accomplish this, use the other operators to initialize all <code>Record</code> members, then use <code>:&lt;&gt;=</code> with <code>.waive</code> to connect only the matching members.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">scala</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">collection</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">immutable</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">SeqMap</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example10 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> abType </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Record </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> elements </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> SeqMap</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;a&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;b&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bcType </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Record </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> elements </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> SeqMap</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;b&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;c&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Wire</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">abType</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Wire</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">bcType</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  dontTouch</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">p</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// So it doesn&#x27;t get constant-propped away for the example</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  dontTouch</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">c</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// So it doesn&#x27;t get constant-propped away for the example</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p </span><span class="token operator" style="color:#393A34">:</span><span class="token plain">#</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> abType</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">elements</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;a&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">elements</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;b&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c </span><span class="token operator" style="color:#393A34">:</span><span class="token plain">#</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> bcType</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Lit</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">elements</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;b&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">elements</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;c&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waive</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">elements</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;c&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waive</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">elements</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;a&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where <code>p.b</code> is driven from <code>c.b</code>, and <code>p.a</code>, <code>c.b</code>, and <code>c.c</code> are initialized to default values:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example10</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> p_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> c_c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> c_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> p_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> c_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example10</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> p_a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> c_c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> c_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> p_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> c_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="connecting-types-with-optional-members">Connecting types with optional members<a href="#connecting-types-with-optional-members" class="hash-link" aria-label="Direct link to Connecting types with optional members" title="Direct link to Connecting types with optional members">​</a></h3>
 <p>In the following example, we can use <code>:&lt;&gt;=</code> and <code>.waive</code> to connect two <code>MyDecoupledOpts</code>&#x27;s, where only one has a <code>bits</code> member.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyDecoupledOpt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">hasBits</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Boolean</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">hasBits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> Some</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">else</span><span class="token plain"> None</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example6 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyDecoupledOpt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyDecoupledOpt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">false</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waive</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">get</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// We can know to call .get because we can inspect in.bits.isEmpty</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where <code>ready</code> and <code>valid</code> are connected, and <code>bits</code> is ignored:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example6</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example6</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="always-ignore-errors-caused-by-extra-members-partial-connection-operator">Always ignore errors caused by extra members (partial connection operator)<a href="#always-ignore-errors-caused-by-extra-members-partial-connection-operator" class="hash-link" aria-label="Direct link to Always ignore errors caused by extra members (partial connection operator)" title="Direct link to Always ignore errors caused by extra members (partial connection operator)">​</a></h3>
 <p>The most unsafe connection is to connect only members that are present in both consumer and producer, and ignore all other members.
 This is unsafe because this connection will never error on any Chisel types.</p>
 <p>To do this, you can use <code>.waiveAll</code> and static cast to <code>Data</code>:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> OnlyA </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> OnlyB </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example11 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> OnlyA</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> OnlyB</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">out</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Data</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waiveAll </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Data</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waiveAll</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where nothing is connected:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example11</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">32&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example11</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">32&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="connecting-components-with-different-widths">Connecting components with different widths<a href="#connecting-components-with-different-widths" class="hash-link" aria-label="Direct link to Connecting components with different widths" title="Direct link to Connecting components with different widths">​</a></h3>
 <p>Non-<code>Connectable</code> operators implicitly truncate if a component with a larger width is connected to a component with a smaller width.
 <code>Connectable</code> operators disallow this implicit truncation behavior and require the driven component to be equal or larger in width that the sourcing component.</p>
 <p>If implicit truncation behavior is desired, then <code>Connectable</code> provides a <code>squeeze</code> mechanism which will allow the connection to continue with implicit truncation.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">scala</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">collection</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">immutable</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">SeqMap</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example14 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">squeeze</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where <code>p</code> is truncated prior to driving <code>c</code>:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example14</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> c</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example14</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> c</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="excluding-members-from-any-operator-on-a-connectable">Excluding members from any operator on a Connectable<a href="#excluding-members-from-any-operator-on-a-connectable" class="hash-link" aria-label="Direct link to Excluding members from any operator on a Connectable" title="Direct link to Excluding members from any operator on a Connectable">​</a></h3>
 <p>If a user wants to always exclude a field from a connect, use the <code>.exclude</code> mechanism which will never connect the field (as if it didn&#x27;t exist to the connection).</p>
 <p>Note that if a field matches in both producer and consumer, but only one is excluded, the other non-excluded field will still trigger an error; to fix this, use either <code>.waive</code> or <code>.exclude</code>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">scala</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">collection</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">immutable</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">SeqMap</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> BundleWithSpecialField </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> special </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example15 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BundleWithSpecialField</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BundleWithSpecialField</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">special </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B </span><span class="token comment" style="color:#999988;font-style:italic">// must initialize it</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">exclude</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">special</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">exclude</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">special</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where the <code>special</code> field is not connected:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example15</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> p_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        p_special</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> c_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       c_special</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> c_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> p_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> c_special </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example15</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> p_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        p_special</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> c_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       c_special</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> c_foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> p_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> c_special </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="techniques-for-connecting-structurally-inequivalent-chisel-types">Techniques for connecting structurally inequivalent Chisel types<a href="#techniques-for-connecting-structurally-inequivalent-chisel-types" class="hash-link" aria-label="Direct link to Techniques for connecting structurally inequivalent Chisel types" title="Direct link to Techniques for connecting structurally inequivalent Chisel types">​</a></h2>
 <p><code>DataView</code> and <code>.viewAsSupertype</code> create a view of the component that has a different Chisel type.
 This means that a user can first create a <code>DataView</code> of the consumer or producer (or both) so that the Chisel types are structurally equivalent.
@@ -361,7 +361,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="connecting-different-sub-type
 Because it changes the Chisel type to omit both <code>bits</code> fields, the <code>bits</code> fields are unconnected.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">dataview</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyDecoupledOtherBits </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> MyReadyValid </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example12 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyDecoupled</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyDecoupledOtherBits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAsSupertype</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyReadyValid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAsSupertype</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyReadyValid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Note that the <code>bits</code> fields are unconnected.</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example12</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">32&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example12</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">32&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>The second example will use a static cast and <code>.waive(_.bits)</code> to connect them as <code>MyReadyValid</code>.
 Note that because the static cast does not change the Chisel type, the connection finds that both consumer and producer have a <code>bits</code> field.
 This means that since they are structurally equivalent, they match and are connected.
@@ -369,7 +369,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="connecting-different-sub-type
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">dataview</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example13 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyDecoupled</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyDecoupledOtherBits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waiveAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">MyReadyValid</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waiveAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">MyReadyValid</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Note that the <code>bits</code> fields ARE connected, even though they are waived, as <code>.waive</code> just changes whether an error should be thrown if they are missing, NOT to not connect them if they are structurally equivalent.
 To always omit the connection, use <code>.exclude</code> on one side and either <code>.exclude</code> or <code>.waive</code> on the other side.</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example13</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example13</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="connecting-sub-types-to-super-types-by-waiving-extra-members">Connecting sub-types to super-types by waiving extra members<a href="#connecting-sub-types-to-super-types-by-waiving-extra-members" class="hash-link" aria-label="Direct link to Connecting sub-types to super-types by waiving extra members" title="Direct link to Connecting sub-types to super-types by waiving extra members">​</a></h3>
 <blockquote>
 <p>Note that in this example, it would be better to use <code>.viewAsSupertype</code>.</p>
@@ -377,7 +377,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="connecting-sub-types-to-super
 <p>In the following example, we can use <code>:&lt;&gt;=</code> to connect a <code>MyReadyValid</code> to a <code>MyDecoupled</code> by waiving the <code>bits</code> member.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyReadyValid </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyDecoupled </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> MyReadyValid </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example5 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyDecoupled</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyReadyValid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waiveAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">MyReadyValid</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where <code>ready</code> and <code>valid</code> are connected, and <code>bits</code> is ignored:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example5</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example5</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="connecting-different-sub-types">Connecting different sub-types<a href="#connecting-different-sub-types" class="hash-link" aria-label="Direct link to Connecting different sub-types" title="Direct link to Connecting different sub-types">​</a></h3>
 <blockquote>
 <p>Note that in this example, it would be better to use <code>.viewAsSupertype</code>.</p>
@@ -386,7 +386,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="connecting-different-sub-type
 <p>In the following example, we can use <code>:&lt;&gt;=</code> and <code>.waiveAs</code> to connect two different sub-types of <code>MyReadyValid</code>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> HasBits </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> MyReadyValid </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> HasEcho </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> MyReadyValid </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> echo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example7 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in  </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> HasBits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> HasEcho</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waiveAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">MyReadyValid</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">echo</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">waiveAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">MyReadyValid</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This generates the following Verilog, where <code>ready</code> and <code>valid</code> are connected, and <code>bits</code> and <code>echo</code> are ignored:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example7</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_echo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example7</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_echo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="faq">FAQ<a href="#faq" class="hash-link" aria-label="Direct link to FAQ" title="Direct link to FAQ">​</a></h2>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-connect-two-items-as-flexibly-as-possible-try-your-best-but-never-error">How do I connect two items as flexibly as possible (try your best but never error)<a href="#how-do-i-connect-two-items-as-flexibly-as-possible-try-your-best-but-never-error" class="hash-link" aria-label="Direct link to How do I connect two items as flexibly as possible (try your best but never error)" title="Direct link to How do I connect two items as flexibly as possible (try your best but never error)">​</a></h3>
 <p>Use <code>.unsafe</code> (both waives and allows squeezing of all fields).</p>
diff --git a/docs/explanations/connection-operators.html b/docs/explanations/connection-operators.html
index 71e69a176e..8d323a2927 100644
--- a/docs/explanations/connection-operators.html
+++ b/docs/explanations/connection-operators.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -21,14 +21,14 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="experiment-setup">Experiment
 <img decoding="async" loading="lazy" src="https://raw.githubusercontent.com/chipsalliance/chisel3/master/docs/src/images/connection-operators-experiment.svg?sanitize=true" alt="Experiment Image" class="img_ev3q"></p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Wrapper </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect Producer to IO</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer to consumer</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect consumer to IO</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> PipelineStage </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Below we can see the resulting Verilog for this example:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="concept-1--is-commutative">Concept 1: <code>&lt;&gt;</code> is Commutative<a href="#concept-1--is-commutative" class="hash-link" aria-label="Direct link to concept-1--is-commutative" title="Direct link to concept-1--is-commutative">​</a></h2>
 <p>This experiment is set up to test for the function of <code>&lt;&gt;</code> using the experiment above.</p>
 <p>Achieving this involves flipping the RHS and LHS of the <code>&lt;&gt;</code> operator and seeing how <code>&lt;&gt;</code>  will react.
 ( Scastie link for the experiment:<a href="https://scastie.scala-lang.org/Shorla/LVhlbkFQQnq7X3trHfgZZQ" target="_blank" rel="noopener noreferrer">https://scastie.scala-lang.org/Shorla/LVhlbkFQQnq7X3trHfgZZQ</a> )</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">util</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">DecoupledIO</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Wrapper </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer to I/O</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer  to consumer</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect consumer to I/O</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> PipelineStage </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Below we can see the resulting Verilog for this example:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="conclusion">Conclusion:<a href="#conclusion" class="hash-link" aria-label="Direct link to Conclusion:" title="Direct link to Conclusion:">​</a></h3>
 <p>The Verilog remained the same without incurring errors, showing that the <code>&lt;&gt;</code> operator is commutative.</p>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="concept-2--means-assign-all-lhs-signals-from-the-rhs-regardless-of-the-direction-on-the-lhs">Concept 2: <code>:=</code> means assign ALL LHS signals from the RHS, regardless of the direction on the LHS.<a href="#concept-2--means-assign-all-lhs-signals-from-the-rhs-regardless-of-the-direction-on-the-lhs" class="hash-link" aria-label="Direct link to concept-2--means-assign-all-lhs-signals-from-the-rhs-regardless-of-the-direction-on-the-lhs" title="Direct link to concept-2--means-assign-all-lhs-signals-from-the-rhs-regardless-of-the-direction-on-the-lhs">​</a></h2>
@@ -46,7 +46,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="concept-3-always-use--to-assi
 ( Scastie link for the experiment:<a href="https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1" target="_blank" rel="noopener noreferrer">https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1</a>)</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">util</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">DecoupledIO</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Wrapper </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">//connect Producer to IO</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> tmp </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Wire</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  tmp </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer to consumer</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">//connect consumer to IO</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> PipelineStage </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Below we can see the resulting Verilog for this example:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="conclusion-2">Conclusion:<a href="#conclusion-2" class="hash-link" aria-label="Direct link to Conclusion:" title="Direct link to Conclusion:">​</a></h3>
 <p>If <code>&lt;&gt;</code> were used to assign the unidrectioned wire <code>tmp</code> to DontCare, we would get an error. But in the example above, we used <code>:=</code> and no errors occurred.
 But when <code>:=</code> was used to assign the wire to DontCare, no errors will occur.</p>
@@ -57,7 +57,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="concept-4-you-can-use--or--to
 ( Scastie link for the experiment:<a href="https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1" target="_blank" rel="noopener noreferrer">https://scastie.scala-lang.org/Shorla/ZIGsWcylRqKJhZCkKWlSIA/1</a>)</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">util</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">DecoupledIO</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Wrapper </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">//connect Producer to IO</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> tmp </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Wire</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  tmp </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DontCare</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer to consumer</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">//connect consumer to IO</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> PipelineStage </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Below we can see the resulting Verilog for this example:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="conclusion-3">Conclusion:<a href="#conclusion-3" class="hash-link" aria-label="Direct link to Conclusion:" title="Direct link to Conclusion:">​</a></h3>
 <p>Both <code>&lt;&gt;</code> and <code>:=</code> can be used to assign directioned things (IOs) to DontCare as shown in <code>io.in</code> and <code>p.io.a</code> respectively. This is basically equivalent because in this case both <code>&lt;&gt;</code> and <code>:=</code> will determine the direction from the LHS.</p>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="concept-5---works-between-things-with-at-least-one-known-flow-an-io-or-childs-io">Concept 5: <code>&lt;&gt;</code>  works between things with at least one known flow (An IO or child&#x27;s IO).<a href="#concept-5---works-between-things-with-at-least-one-known-flow-an-io-or-childs-io" class="hash-link" aria-label="Direct link to concept-5---works-between-things-with-at-least-one-known-flow-an-io-or-childs-io" title="Direct link to concept-5---works-between-things-with-at-least-one-known-flow-an-io-or-childs-io">​</a></h2>
@@ -65,7 +65,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="concept-5---works-between-thi
 ( Scastie link for the experiment:<a href="https://scastie.scala-lang.org/Shorla/gKx9ReLVTTqDTk9vmw5ozg" target="_blank" rel="noopener noreferrer">https://scastie.scala-lang.org/Shorla/gKx9ReLVTTqDTk9vmw5ozg</a>)</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">util</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">DecoupledIO</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Wrapper </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">//connect Producer to IO</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// For this experiment, we add a temporary wire and see if it works...</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">//p.io.a &lt;&gt; io.in</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> tmp </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Wire</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect intermediate wire</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  tmp </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> tmp</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer to consumer</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">//connect consumer to IO</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> PipelineStage </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Below we can see the resulting Verilog for this example:</p>
-<div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">chisel3</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">docs</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">emitSystemVerilog</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Wrapper</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// res9: String = &quot;&quot;&quot;// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// module PipelineStage(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output       io_a_ready,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        io_a_valid,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input  [7:0] io_a_bits,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        io_b_ready,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output       io_b_valid,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output [7:0] io_b_bits</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   assign io_a_ready = io_b_ready;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   assign io_b_valid = io_a_valid;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   assign io_b_bits = io_a_bits;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// module Wrapper(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        clock,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//                reset,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output       io_in_ready,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        io_in_valid,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input  [7:0] io_in_bits,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        io_out_ready,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output       io_out_valid,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output [7:0] io_out_bits</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   wire       _c_io_a_ready;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   wire       _p_io_b_valid;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   wire [7:0] _p_io_b_bits;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   PipelineStage p (</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_ready (io_in_ready),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_valid (io_in_valid),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_bits  (io_in_bits),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_ready (_c_io_a_ready),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_valid (_p_io_b_valid),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_bits  (_p_io_b_bits)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   PipelineStage c (</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_ready (_c_io_a_ready),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_valid (_p_io_b_valid),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_bits  (_p_io_b_bits),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_ready (io_out_ready),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_valid (io_out_valid),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_bits  (io_out_bits)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// &quot;&quot;&quot;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">chisel3</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">docs</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">emitSystemVerilog</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Wrapper</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// res9: String = &quot;&quot;&quot;// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// module PipelineStage(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output       io_a_ready,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        io_a_valid,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input  [7:0] io_a_bits,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        io_b_ready,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output       io_b_valid,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output [7:0] io_b_bits</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   assign io_a_ready = io_b_ready;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   assign io_b_valid = io_a_valid;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   assign io_b_bits = io_a_bits;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// module Wrapper(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        clock,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//                reset,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output       io_in_ready,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        io_in_valid,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input  [7:0] io_in_bits,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   input        io_out_ready,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output       io_out_valid,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   output [7:0] io_out_bits</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   wire       _c_io_a_ready;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   wire       _p_io_b_valid;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   wire [7:0] _p_io_b_bits;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   PipelineStage p (</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_ready (io_in_ready),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_valid (io_in_valid),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_bits  (io_in_bits),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_ready (_c_io_a_ready),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_valid (_p_io_b_valid),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_bits  (_p_io_b_bits)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   PipelineStage c (</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_ready (_c_io_a_ready),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_valid (_p_io_b_valid),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_a_bits  (_p_io_b_bits),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_ready (io_out_ready),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_valid (io_out_valid),</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//     .io_b_bits  (io_out_bits)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   );</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// &quot;&quot;&quot;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="conclusion-4">Conclusion:<a href="#conclusion-4" class="hash-link" aria-label="Direct link to Conclusion:" title="Direct link to Conclusion:">​</a></h3>
 <p>The connection above went smoothly with no errors, this goes to show <code>&lt;&gt;</code> will work as long as there is at least one directioned thing (IO or submodule&#x27;s IO) to &quot;fix&quot; the direction.</p>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="concept-6--and--connect-signals-by-field-name">Concept 6: <code>&lt;&gt;</code> and <code>:=</code> connect signals by field name.<a href="#concept-6--and--connect-signals-by-field-name" class="hash-link" aria-label="Direct link to concept-6--and--connect-signals-by-field-name" title="Direct link to concept-6--and--connect-signals-by-field-name">​</a></h2>
@@ -73,7 +73,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="concept-6--and--connect-signa
 ( Scastie link for the experiment:<a href="https://scastie.scala-lang.org/Uf4tQquvQYigZAW705NFIQ" target="_blank" rel="noopener noreferrer">https://scastie.scala-lang.org/Uf4tQquvQYigZAW705NFIQ</a>)</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">util</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">DecoupledIO</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MockDecoupledIO </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Wrapper </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MockDecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MockDecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer to I/O</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer  to consumer</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect consumer to I/O</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> PipelineStage </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Below we can see the resulting Verilog for this example:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PipelineStage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_a_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_a_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_b_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_b_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_b_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_a_ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_b_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> io_b_bits </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io_a_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Wrapper</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_in_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in_bits</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">       io_out_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        io_out_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out_bits</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _c_io_a_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">       _p_io_b_valid</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _p_io_b_bits</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage p </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  PipelineStage c </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_c_io_a_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_a_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_p_io_b_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_ready </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_valid </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_valid</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io_b_bits  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out_bits</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>And here is another experiment, where we remove one of the fields of MockDecoupledIO:
 ( Scastie link for the experiment:<a href="https://scastie.scala-lang.org/ChtkhKCpS9CvJkjjqpdeIA" target="_blank" rel="noopener noreferrer">https://scastie.scala-lang.org/ChtkhKCpS9CvJkjjqpdeIA</a>)</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">util</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">DecoupledIO</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MockDecoupledIO </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> ready </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Bool</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">//val bits = Output(UInt(8.W))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Wrapper </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MockDecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MockDecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> p </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> PipelineStage</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer to I/O</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect producer  to consumer</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> p</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// connect consumer to I/O</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> c</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> PipelineStage </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DecoupledIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
diff --git a/docs/explanations/data-types.html b/docs/explanations/data-types.html
index 8eef73849a..51f6d4a9a3 100644
--- a/docs/explanations/data-types.html
+++ b/docs/explanations/data-types.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/dataview.html b/docs/explanations/dataview.html
index 48c3cc835d..e917d2a215 100644
--- a/docs/explanations/dataview.html
+++ b/docs/explanations/dataview.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -39,7 +39,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="a-motivating-example-axi4">A
 A more &quot;Chisel-y&quot; implementation of this interface might look like:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Note that both the AW and AR channels look similar and could use the same Bundle definition</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AXIAddressChannel</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> addrWidth</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> id </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> addr </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">addrWidth</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> len </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> size </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// ...</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">util</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">Decoupled</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// We can compose the various AXI channels together</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AXIBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> addrWidth</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> aw </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Decoupled</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AXIAddressChannel</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">addrWidth</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val ar = new AXIAddressChannel</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// ... Other channels here ...</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Instantiated as</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> axi </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AXIBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">20</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Of course, this would result in very different looking Verilog:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         axi_aw_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        axi_aw_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  axi_aw_bits_id</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">19</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> axi_aw_bits_addr</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  axi_aw_bits_len</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                axi_aw_bits_size</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_bits_id </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_bits_addr </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">20&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_bits_len </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_bits_size </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">MyModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         axi_aw_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        axi_aw_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  axi_aw_bits_id</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">19</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> axi_aw_bits_addr</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  axi_aw_bits_len</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                axi_aw_bits_size</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_bits_id </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_bits_addr </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">20&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_bits_len </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> axi_aw_bits_size </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>So how can we use our more structured types while maintaining expected Verilog interfaces?
 Meet DataView:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">dataview</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// We recommend putting DataViews in a companion object of one of the involved types</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">object</span><span class="token plain"> AXIBundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Don&#x27;t be afraid of the use of implicits, we will discuss this pattern in more detail later</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">implicit</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> axiView</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> DataView</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">VerilogAXIBundle</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> AXIBundle</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DataView</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// The first argument is a function constructing an object of View type (AXIBundle)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// from an object of the Target type (VerilogAXIBundle)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    vab </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AXIBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">vab</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">addrWidth</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// The remaining arguments are a mapping of the corresponding fields of the two types</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">AWVALID </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">AWREADY </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">AWID </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">id</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">AWADDR </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">addr</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">AWLEN </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">len</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">AWSIZE </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">size</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// ...</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
@@ -49,7 +49,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="a-motivating-example-axi4">A
 it were the more structured type:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> AXIStub </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> AXI </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> VerilogAXIBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">20</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> view </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> AXI</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">AXIBundle</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// We can now manipulate `AXI` via `view`</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  view</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">asTypeOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AXIAddressChannel</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">20</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// zero everything out by default</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  view</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">valid </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">B</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  when </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">view</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">ready</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    view</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">id </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">5.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    view</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">aw</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bits</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">addr </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1234.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// We can still manipulate AXI as well</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    AXI</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">AWLEN </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This will generate Verilog that matches the standard naming convention:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AXIStub</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        AXI_AWVALID</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         AXI_AWREADY</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  AXI_AWID</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">19</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> AXI_AWADDR</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  AXI_AWLEN</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                AXI_AWSIZE</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWVALID </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWID </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> AXI_AWREADY </span><span class="token operator" style="color:#393A34">?</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h5</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWADDR </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> AXI_AWREADY </span><span class="token operator" style="color:#393A34">?</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">20&#x27;h4D2</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">20&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWLEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> AXI_AWREADY</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWSIZE </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">AXIStub</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        AXI_AWVALID</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         AXI_AWREADY</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  AXI_AWID</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">19</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> AXI_AWADDR</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  AXI_AWLEN</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                AXI_AWSIZE</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWVALID </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWID </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> AXI_AWREADY </span><span class="token operator" style="color:#393A34">?</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h5</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWADDR </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> AXI_AWREADY </span><span class="token operator" style="color:#393A34">?</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">20&#x27;h4D2</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">20&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWLEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> AXI_AWREADY</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> AXI_AWSIZE </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Note that if both the <em>Target</em> and the <em>View</em> types are subtypes of <code>Data</code> (as they are in this example),
 the <code>DataView</code> is <em>invertible</em>.
 This means that we can easily create a <code>DataView[AXIBundle, VerilogAXIBundle]</code> from our existing
@@ -60,7 +60,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="a-motivating-example-axi4">A
 types:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> ConnectionExample </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> AXIBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">20</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Flipped</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> VerilogAXIBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">20</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">AXIBundle</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token generics punctuation" style="color:#393A34">&lt;</span><span class="token generics punctuation" style="color:#393A34">&gt;</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This results in the corresponding fields being connected in the emitted Verilog:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ConnectionExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_aw_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_aw_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  in_aw_bits_id</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">19</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_aw_bits_addr</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  in_aw_bits_len</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                in_aw_bits_size</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_AWVALID</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_AWREADY</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  out_AWID</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">19</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_AWADDR</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  out_AWLEN</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                out_AWSIZE</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWVALID</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_bits_id </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWID</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_bits_addr </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWADDR</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_bits_len </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWLEN</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_bits_size </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWSIZE</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_AWREADY </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_aw_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ConnectionExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         in_aw_ready</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        in_aw_valid</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  in_aw_bits_id</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">19</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_aw_bits_addr</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  in_aw_bits_len</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                in_aw_bits_size</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         out_AWVALID</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain">        out_AWREADY</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  out_AWID</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">19</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_AWADDR</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain">  out_AWLEN</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                out_AWSIZE</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_valid </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWVALID</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_bits_id </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWID</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_bits_addr </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWADDR</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_bits_len </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWLEN</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> in_aw_bits_size </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out_AWSIZE</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_AWREADY </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_aw_ready</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="other-use-cases">Other Use Cases<a href="#other-use-cases" class="hash-link" aria-label="Direct link to Other Use Cases" title="Direct link to Other Use Cases">​</a></h2>
 <p>While the ability to map between <code>Bundle</code> types as in the AXI4 example is pretty compelling,
 DataView has many other applications.
@@ -95,7 +95,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="totality-and-partialdataview"
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// We forgot BundleA.foo in the mapping!</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">implicit</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> myView</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> DataView</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">BundleA</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> BundleB</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DataView</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_ </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BundleB</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bar </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">fizz</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> BadMapping </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BundleA</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BundleB</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">BundleB</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// We must run Chisel to see the error</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">getVerilogString</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BadMapping</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// chisel3.experimental.dataview.package$InvalidViewException: Viewing BadMapping.in: IO[BundleA] as BundleB is non-Total!</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   Target field &#x27;_.foo&#x27; is missing.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   DataView used is DataView(defined @[dataview.md:228:59]).</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">//   If the view *should* be non-total, try a &#x27;PartialDataView&#x27;.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at ... ()</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp6$$anonfun$55$BadMapping$1$$anonfun$60.apply(dataview.md:232)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp6$$anonfun$55$BadMapping$1$$anonfun$60.apply(dataview.md:232)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.DataImpl.$anonfun$$colon$eq$1(DataImpl.scala:817)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at scala.runtime.java8.JFunction0$mcV$sp.apply(JFunction0$mcV$sp.scala:18)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.experimental.prefix$.apply(prefix.scala:33)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.DataImpl.$colon$eq(DataImpl.scala:817)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.DataImpl.$colon$eq$(DataImpl.scala:815)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Data.$colon$eq(Data.scala:31)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp6$$anonfun$55$BadMapping$1.&lt;init&gt;(dataview.md:232)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp6$$anonfun$55$$anonfun$apply$67.apply(dataview.md:234)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp6$$anonfun$55$$anonfun$apply$67.apply(dataview.md:234)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:97)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl.evaluate$(ModuleImpl.scala:63)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$.evaluate(Module.scala:10)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl._applyImpl(ModuleImpl.scala:36)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.ObjectModuleImpl._applyImpl$(ModuleImpl.scala:34)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$._applyImpl(Module.scala:10)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$.do_apply(Module.scala:22)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:58)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1090)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.Builder$.buildImpl(Builder.scala:1080)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1072)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at logger.Logger$.makeScope(Logger.scala:146)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at logger.Logger$.makeScope(Logger.scala:133)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at ... ()</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>As that error suggests, if we <em>want</em> the view to be non-total, we can use a <code>PartialDataView</code>:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// A PartialDataView does not have to be total for the Target</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">implicit</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> myView</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> DataView</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">BundleA</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> BundleB</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> PartialDataView</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">BundleA</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> BundleB</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_ </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BundleB</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">bar </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">fizz</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// myView: DataView[BundleA, BundleB] = PartialDataView(defined @[dataview.md:243:84])</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> PartialDataViewModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BundleA</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> BundleB</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">BundleB</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PartialDataViewModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in_bar</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_fizz</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_fizz </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_bar</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">PartialDataViewModule</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in_foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in_bar</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out_fizz</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_fizz </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in_bar</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>While <code>PartialDataViews</code> need not be total for the <em>Target</em>, both <code>PartialDataViews</code> and <code>DataViews</code>
 must always be total for the <em>View</em>.
 This has the consequence that <code>PartialDataViews</code> are <strong>not</strong> invertible in the same way as <code>DataViews</code>.</p>
@@ -178,11 +178,11 @@ <h4 class="anchor anchorWithStickyNavbar_LWe7" id="implicit-resolution-example">
 <p>This provides an implementation of <code>DataView</code> in the <em>implicit scope</em> as a &quot;default&quot; mapping between
 <code>Foo</code> and <code>Bar</code> (and it doesn&#x27;t even require an import!):</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> FooToBar </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  bar </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">Bar</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">FooToBar</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               foo_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar_c</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               bar_d</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_d </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">FooToBar</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               foo_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar_c</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               bar_d</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_d </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>However, it&#x27;s possible that some user of <code>Foo</code> and <code>Bar</code> wants different behavior,
 perhaps they would prefer more of &quot;swizzling&quot; behavior rather than a direct mapping:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">object</span><span class="token plain"> Swizzle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">implicit</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> swizzle</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> DataView</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">Foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> DataView</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_ </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">d</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">b </span><span class="token operator" style="color:#393A34">-&gt;</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">c</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Current scope always wins over implicit scope</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> Swizzle</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> FooToBarSwizzled </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  bar </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">viewAs</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">Bar</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">FooToBarSwizzled</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               foo_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar_c</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               bar_d</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_d </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">FooToBarSwizzled</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo_a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               foo_b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar_c</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               bar_d</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_c </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar_d </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> foo_a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="dataproduct">DataProduct<a href="#dataproduct" class="hash-link" aria-label="Direct link to DataProduct" title="Direct link to DataProduct">​</a></h3>
 <p><code>DataProduct</code> is a type class used by <code>DataView</code> to validate the correctness of a user-provided mapping.
 In order for a type to be &quot;viewable&quot; (ie. the <code>Target</code> type of a <code>DataView</code>), it must have an
diff --git a/docs/explanations/decoder.html b/docs/explanations/decoder.html
index d505364e02..17f82dbbb2 100644
--- a/docs/explanations/decoder.html
+++ b/docs/explanations/decoder.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/functional-abstraction.html b/docs/explanations/functional-abstraction.html
index 4bbd72707a..f8041365b5 100644
--- a/docs/explanations/functional-abstraction.html
+++ b/docs/explanations/functional-abstraction.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/functional-module-creation.html b/docs/explanations/functional-module-creation.html
index 8b8e76d436..81172c8ebf 100644
--- a/docs/explanations/functional-module-creation.html
+++ b/docs/explanations/functional-module-creation.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/instchoice.html b/docs/explanations/instchoice.html
index 5054da375c..2db4e373d0 100644
--- a/docs/explanations/instchoice.html
+++ b/docs/explanations/instchoice.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/interfaces-and-connections.html b/docs/explanations/interfaces-and-connections.html
index de5fc8bb6a..238f1a5578 100644
--- a/docs/explanations/interfaces-and-connections.html
+++ b/docs/explanations/interfaces-and-connections.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/intrinsics.html b/docs/explanations/intrinsics.html
index 2a6f38cb63..edec6688b8 100644
--- a/docs/explanations/intrinsics.html
+++ b/docs/explanations/intrinsics.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/layers.html b/docs/explanations/layers.html
index 7fd4c29321..f406d07d78 100644
--- a/docs/explanations/layers.html
+++ b/docs/explanations/layers.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -197,7 +197,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="simple-extract-layer">Simple
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">layer</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">Layer</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> LayerConfig</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> block</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">ltl</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">AssertProperty</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">object</span><span class="token plain"> A </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Layer</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">LayerConfig</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Extract</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Foo </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  sum </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">+</span><span class="token operator" style="color:#393A34">%</span><span class="token plain"> b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  block</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">A</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    withDisable</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Disable</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Never</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      AssertProperty</span><span class="token punctuation" style="color:#393A34">(</span><span class="token operator" style="color:#393A34">!</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">a </span><span class="token operator" style="color:#393A34">+</span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> b</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;overflow occurred&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>After compilation, we get the following SystemVerilog.  Comments that include
 <code>FILE</code> indicate the beginning of a new file:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> sum</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _sum_T </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> a</span><span class="token operator" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> b</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _sum_T</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;A/layers-Foo-A.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_A</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_A</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">bind</span><span class="token plain"> Foo Foo_A a_0 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_GEN  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_sum_T</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_A</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;A/Foo_A.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo_A</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">       clock</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  overflow_occurred</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">assert</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">property</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">@</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">~</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_GEN</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> sum</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _sum_T </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> a</span><span class="token operator" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> b</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _sum_T</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;A/layers-Foo-A.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_A</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_A</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">bind</span><span class="token plain"> Foo Foo_A a_0 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_GEN  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_sum_T</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_A</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;A/Foo_A.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo_A</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">       clock</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  overflow_occurred</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">assert</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">property</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">@</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">~</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_GEN</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>info</div><div class="admonitionContent_BuS1"><p>The above example was compiled with the firtool options
 <code>-enable-layers=Verification</code>, <code>-enable-layers=Verification.Assert</code>,
 <code>-enable-layers=Verification.Assume</code>, and <code>-enable-layers=Verification.Cover</code> to
@@ -212,7 +212,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="simple-inline-layer">Simple I
 guarded by an <code>`ifdef</code> sensitive to the preprocessor macro <code>layer_Foo$A</code>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">layer</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">Layer</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> LayerConfig</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> block</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">ltl</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">AssertProperty</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">object</span><span class="token plain"> A </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Layer</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">LayerConfig</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Inline</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Foo </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  sum </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">+</span><span class="token operator" style="color:#393A34">%</span><span class="token plain"> b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  block</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">A</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    withDisable</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Disable</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">Never</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      AssertProperty</span><span class="token punctuation" style="color:#393A34">(</span><span class="token operator" style="color:#393A34">!</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">a </span><span class="token operator" style="color:#393A34">+</span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> b</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;overflow occurred&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>After compilation, we get the following SystemVerilog.</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> sum</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _sum_T </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> a</span><span class="token operator" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> b</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> layer_Foo$A</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    overflow_occurred</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">assert</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">property</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">@</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">~</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_sum_T</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layer_Foo$A</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _sum_T</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               b</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> sum</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _sum_T </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> a</span><span class="token operator" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> b</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> layer_Foo$A</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    overflow_occurred</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">assert</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">property</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">@</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">~</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">_sum_T</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layer_Foo$A</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _sum_T</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="design-verification-example">Design Verification Example<a href="#design-verification-example" class="hash-link" aria-label="Direct link to Design Verification Example" title="Direct link to Design Verification Example">​</a></h3>
 <p>Consider a use case where a design or design verification engineer would like to
 add some asserts and debug prints to a module.  The logic necessary for the
@@ -274,6 +274,6 @@ <h4 class="anchor anchorWithStickyNavbar_LWe7" id="implementation-notes">Impleme
 FIRRTL must produce these files.</p></div></div>
 <h4 class="anchor anchorWithStickyNavbar_LWe7" id="verilog-output">Verilog Output<a href="#verilog-output" class="hash-link" aria-label="Direct link to Verilog Output" title="Direct link to Verilog Output">​</a></h4>
 <p>The complete Verilog output for this example is reproduced below:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">32&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/cover/layers-Foo-Verification-Cover.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-Foo-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_Verification_Cover</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_Verification_Cover</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_Verification_Cover</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assume/layers-Foo-Verification-Assume.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-Foo-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_Verification_Assume</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_Verification_Assume</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_Verification_Assume</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assert/layers-Foo-Verification-Assert.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-Foo-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_Verification_Assert</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_Verification_Assert</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">bind</span><span class="token plain"> Foo Foo_Verification_Assert verification_assert </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a     </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Foo</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">verification</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a_probe</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a_d0  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Foo</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">verification</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a_d0_probe</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">reset </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Foo</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">verification</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock_probe</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_Verification_Assert</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/layers-Foo-Verification.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_Verification</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_Verification</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">bind</span><span class="token plain"> Foo Foo_Verification verification </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a     </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">a</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">reset </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_Verification</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assert/Foo_Verification_Assert.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;STOP_COND&#x27; to add an extra gate to stop conditions.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> STOP_COND_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> STOP_COND</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> STOP_COND_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`STOP_COND</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// STOP_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> STOP_COND_ </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// STOP_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def STOP_COND_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;ASSERT_VERBOSE_COND&#x27; to add an extra gate to assert error printing.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> ASSERT_VERBOSE_COND_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> ASSERT_VERBOSE_COND</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> ASSERT_VERBOSE_COND_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`ASSERT_VERBOSE_COND</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// ASSERT_VERBOSE_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> ASSERT_VERBOSE_COND_ </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// ASSERT_VERBOSE_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def ASSERT_VERBOSE_COND_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo_Verification_Assert</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               a_d0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               clock</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> SYNTHESIS</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token operator" style="color:#393A34">~</span><span class="token plain">reset </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">&lt;</span><span class="token plain"> a_d0</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`ASSERT_VERBOSE_COND_</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          </span><span class="token kernel-function property" style="color:#36acaa">$error</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;Assertion failed: a must always increment\n&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`STOP_COND_</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          </span><span class="token kernel-function property" style="color:#36acaa">$fatal</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def SYNTHESIS</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/Foo_Verification.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;PRINTF_COND&#x27; to add an extra gate to prints.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> PRINTF_COND_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> PRINTF_COND</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_COND_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_COND</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_COND_ </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def PRINTF_COND_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo_Verification</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        reset</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">        clock_probe </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a_probe </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a_d0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a_d0_probe </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> a_d0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> layer_Foo$Verification$Debug</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> SYNTHESIS</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_COND_</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">~</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          </span><span class="token kernel-function property" style="color:#36acaa">$fwrite</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32&#x27;h80000002</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;a: %x, a_d0: %x&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> a_d0</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def SYNTHESIS</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layer_Foo$Verification$Debug</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    a_d0 </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/layers.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/explanations/intrinsics"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Intrinsics</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/explanations/memories"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Memories</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#verilog-abi" class="table-of-contents__link toc-highlight">Verilog ABI</a><ul><li><a href="#extract-layers" class="table-of-contents__link toc-highlight">Extract Layers</a></li><li><a href="#inline-layers" class="table-of-contents__link toc-highlight">Inline Layers</a></li></ul></li><li><a href="#user-defined-layers" class="table-of-contents__link toc-highlight">User-defined Layers</a></li><li><a href="#built-in-layers" class="table-of-contents__link toc-highlight">Built-in Layers</a></li><li><a href="#layer-coloring" class="table-of-contents__link toc-highlight">Layer-coloring</a><ul><li><a href="#layer-colored-probes-and-wires" class="table-of-contents__link toc-highlight">Layer-colored Probes and Wires</a></li><li><a href="#enabling-layers" class="table-of-contents__link toc-highlight">Enabling Layers</a></li></ul></li><li><a href="#examples" class="table-of-contents__link toc-highlight">Examples</a><ul><li><a href="#simple-extract-layer" class="table-of-contents__link toc-highlight">Simple Extract Layer</a></li><li><a href="#simple-inline-layer" class="table-of-contents__link toc-highlight">Simple Inline Layer</a></li><li><a href="#design-verification-example" class="table-of-contents__link toc-highlight">Design Verification Example</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs">Docs</a></li><li class="footer__item"><a href="/api/latest" target="_blank" rel="noopener noreferrer" class="footer__link-item">ScalaDoc</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/freechipsproject/chisel3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/chisel_lang" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ChipsAlliance. Built with Docusaurus.</div></div></div></footer></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">         clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">                reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> b </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">32&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/cover/layers-Foo-Verification-Cover.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-Foo-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_Verification_Cover</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_Verification_Cover</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_Verification_Cover</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assume/layers-Foo-Verification-Assume.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-Foo-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_Verification_Assume</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_Verification_Assume</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_Verification_Assume</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assert/layers-Foo-Verification-Assert.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-Foo-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_Verification_Assert</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_Verification_Assert</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">bind</span><span class="token plain"> Foo Foo_Verification_Assert verification_assert </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a     </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Foo</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">verification</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a_probe</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a_d0  </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Foo</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">verification</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a_d0_probe</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">reset </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Foo</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">verification</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock_probe</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_Verification_Assert</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/layers-Foo-Verification.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_Foo_Verification</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_Foo_Verification</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">bind</span><span class="token plain"> Foo Foo_Verification verification </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">a     </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">a</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">reset </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_Foo_Verification</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assert/Foo_Verification_Assert.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;STOP_COND&#x27; to add an extra gate to stop conditions.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> STOP_COND_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> STOP_COND</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> STOP_COND_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`STOP_COND</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// STOP_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> STOP_COND_ </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// STOP_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def STOP_COND_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;ASSERT_VERBOSE_COND&#x27; to add an extra gate to assert error printing.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> ASSERT_VERBOSE_COND_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> ASSERT_VERBOSE_COND</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> ASSERT_VERBOSE_COND_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`ASSERT_VERBOSE_COND</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// ASSERT_VERBOSE_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> ASSERT_VERBOSE_COND_ </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// ASSERT_VERBOSE_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def ASSERT_VERBOSE_COND_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo_Verification_Assert</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               a_d0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               clock</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> SYNTHESIS</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token operator" style="color:#393A34">~</span><span class="token plain">reset </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">&lt;</span><span class="token plain"> a_d0</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`ASSERT_VERBOSE_COND_</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          </span><span class="token kernel-function property" style="color:#36acaa">$error</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;Assertion failed: a must always increment\n&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`STOP_COND_</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          </span><span class="token kernel-function property" style="color:#36acaa">$fatal</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def SYNTHESIS</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/Foo_Verification.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;PRINTF_FD&#x27; to add a specified fd to prints.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> PRINTF_FD_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> PRINTF_FD</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_FD_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_FD</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_FD</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_FD_ </span><span class="token number" style="color:#36acaa">32&#x27;h80000002</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_FD</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def PRINTF_FD_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;PRINTF_COND&#x27; to add an extra gate to prints.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> PRINTF_COND_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> PRINTF_COND</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_COND_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_COND</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_COND_ </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def PRINTF_COND_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Foo_Verification</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        reset</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain">        clock_probe </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a_probe </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a_d0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">31</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> a_d0_probe </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> a_d0</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> layer_Foo$Verification$Debug</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> SYNTHESIS</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_COND_</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">~</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          </span><span class="token kernel-function property" style="color:#36acaa">$fwrite</span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_FD_</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;a: %x, a_d0: %x&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> a_d0</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def SYNTHESIS</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layer_Foo$Verification$Debug</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    a_d0 </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> a</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/layers.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/explanations/intrinsics"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Intrinsics</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/explanations/memories"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Memories</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#verilog-abi" class="table-of-contents__link toc-highlight">Verilog ABI</a><ul><li><a href="#extract-layers" class="table-of-contents__link toc-highlight">Extract Layers</a></li><li><a href="#inline-layers" class="table-of-contents__link toc-highlight">Inline Layers</a></li></ul></li><li><a href="#user-defined-layers" class="table-of-contents__link toc-highlight">User-defined Layers</a></li><li><a href="#built-in-layers" class="table-of-contents__link toc-highlight">Built-in Layers</a></li><li><a href="#layer-coloring" class="table-of-contents__link toc-highlight">Layer-coloring</a><ul><li><a href="#layer-colored-probes-and-wires" class="table-of-contents__link toc-highlight">Layer-colored Probes and Wires</a></li><li><a href="#enabling-layers" class="table-of-contents__link toc-highlight">Enabling Layers</a></li></ul></li><li><a href="#examples" class="table-of-contents__link toc-highlight">Examples</a><ul><li><a href="#simple-extract-layer" class="table-of-contents__link toc-highlight">Simple Extract Layer</a></li><li><a href="#simple-inline-layer" class="table-of-contents__link toc-highlight">Simple Inline Layer</a></li><li><a href="#design-verification-example" class="table-of-contents__link toc-highlight">Design Verification Example</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs">Docs</a></li><li class="footer__item"><a href="/api/latest" target="_blank" rel="noopener noreferrer" class="footer__link-item">ScalaDoc</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/freechipsproject/chisel3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/chisel_lang" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ChipsAlliance. Built with Docusaurus.</div></div></div></footer></div>
 </body>
 </html>
\ No newline at end of file
diff --git a/docs/explanations/memories.html b/docs/explanations/memories.html
index 7d19fd29b3..77b5b67758 100644
--- a/docs/explanations/memories.html
+++ b/docs/explanations/memories.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/moduleprefix.html b/docs/explanations/moduleprefix.html
index 1f8e5bddcf..eb43c6fbf0 100644
--- a/docs/explanations/moduleprefix.html
+++ b/docs/explanations/moduleprefix.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/modules.html b/docs/explanations/modules.html
index 6f7caff5b2..48d2dc6eda 100644
--- a/docs/explanations/modules.html
+++ b/docs/explanations/modules.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/motivation.html b/docs/explanations/motivation.html
index 4e839f754e..477cbe7d35 100644
--- a/docs/explanations/motivation.html
+++ b/docs/explanations/motivation.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/multi-clock.html b/docs/explanations/multi-clock.html
index 69660c7602..322366726d 100644
--- a/docs/explanations/multi-clock.html
+++ b/docs/explanations/multi-clock.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/muxes-and-input-selection.html b/docs/explanations/muxes-and-input-selection.html
index d95430bdc6..7bd9d9b6db 100644
--- a/docs/explanations/muxes-and-input-selection.html
+++ b/docs/explanations/muxes-and-input-selection.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/naming.html b/docs/explanations/naming.html
index 00ca7994f1..89e977a931 100644
--- a/docs/explanations/naming.html
+++ b/docs/explanations/naming.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -33,21 +33,21 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="compiler-plugin">Compiler Plu
 <p>If the line is within a bundle declaration or is a module instantiation, it is rewritten to replace the right hand
 side with a call to <code>autoNameRecursively</code>, which names the signal/module.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyBundle </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val foo = autoNameRecursively(&quot;foo&quot;)(Input(UInt(3.W)))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example1 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyBundle</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val io = autoNameRecursively(&quot;io&quot;)(IO(new MyBundle()))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">       clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">              reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_foo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">       clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">              reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_foo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Otherwise, it is rewritten to also include the name as a prefix to any signals generated while executing the right-hand-
 side of the val declaration:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example2 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val in = autoNameRecursively(&quot;in&quot;)(prefix(&quot;in&quot;)(IO(Input(UInt(2.W)))))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val out1 = autoNameRecursively(&quot;out1&quot;)(prefix(&quot;out1&quot;)(IO(Output(UInt(4.W)))))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val out2 = autoNameRecursively(&quot;out2&quot;)(prefix(&quot;out2&quot;)(IO(Output(UInt(4.W)))))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out3 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val out3 = autoNameRecursively(&quot;out3&quot;)(prefix(&quot;out3&quot;)(IO(Output(UInt(4.W)))))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> func</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> squared </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// val squared = autoNameRecursively(&quot;squared&quot;)(prefix(&quot;squared&quot;)(in * in))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out1 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> squared</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> delay </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">squared</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// val delay = autoNameRecursively(&quot;delay&quot;)(prefix(&quot;delay&quot;)(RegNext(squared)))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    delay</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> masked </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0xa</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> func</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val masked = autoNameRecursively(&quot;masked&quot;)(prefix(&quot;masked&quot;)(0xa.U &amp; func()))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Note that values created inside of `func()`` are prefixed with `masked`</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out2 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out3 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out3</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> masked_squared </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> masked_delay</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> masked </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked_delay </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;hA</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    masked_delay </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> masked_squared</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked_squared</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out3 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out3</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> masked_squared </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> masked_delay</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> masked </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked_delay </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;hA</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    masked_delay </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> masked_squared</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked_squared</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out3 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> masked </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Prefixing can also be derived from the name of signals on the left-hand side of a connection.
 While this is not implemented via the compiler plugin, the behavior should feel similar:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> ConnectPrefixing </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val in = autoNameRecursively(&quot;in&quot;)(prefix(&quot;in&quot;)(IO(Input(UInt(2.W)))))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val out1 = autoNameRecursively(&quot;out1&quot;)(prefix(&quot;out1&quot;)(IO(Output(UInt(4.W)))))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val out2 = autoNameRecursively(&quot;out2&quot;)(prefix(&quot;out2&quot;)(IO(Output(UInt(4.W)))))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out1 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// technically this is not wrapped in autoNameRecursively nor prefix</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// But the Chisel runtime will still use the name of `out1` as a prefix</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> squared </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out2 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> squared</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> delayed </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">squared</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// val delayed = autoNameRecursively(&quot;delayed&quot;)(prefix(&quot;delayed&quot;)(RegNext(squared)))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    delayed </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ConnectPrefixing</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out2</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1_squared </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1_delayed</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out1_delayed </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> out1_squared</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out1_delayed </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out1_squared</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ConnectPrefixing</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out2</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1_squared </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _GEN </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> _GEN</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1_delayed</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out1_delayed </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> out1_squared</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out1_delayed </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> out1_squared</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Note that the naming also works if the hardware type is nested in an <code>Option</code> or a subtype of <code>Iterable</code>:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example3 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val in = autoNameRecursively(&quot;in&quot;)(prefix(&quot;in&quot;)(IO(Input(UInt(2.W)))))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val out = autoNameRecursively(&quot;out&quot;)(prefix(&quot;out&quot;)(IO(Output(UInt(4.W)))))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> func</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> delay </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    delay </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> opt </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Some</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">func</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Note that the register in func() is prefixed with `opt`:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val opt = autoNameRecursively(&quot;opt&quot;)(prefix(&quot;opt&quot;)(Some(func()))</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> opt</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">get </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example3</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> opt_delay</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    opt_delay </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> opt_delay </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h2</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example3</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> opt_delay</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    opt_delay </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> opt_delay </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h2</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>There is also a slight variant (<code>autoNameRecursivelyProduct</code>) for naming hardware with names provided by an unapply:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> UnapplyExample </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> mkIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> mkIO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// val (in, out) = autoNameRecursivelyProduct(List(Some(&quot;in&quot;), Some(&quot;out&quot;)))(mkIO())</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">UnapplyExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">UnapplyExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Note that the compiler plugin will not insert a prefix in these cases because it is ambiguous what the prefix should be.
 Users who desire a prefix are encouraged to provide one as <a href="#prefixing">described below</a>.</p>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="prefixing">Prefixing<a href="#prefixing" class="hash-link" aria-label="Direct link to Prefixing" title="Direct link to Prefixing">​</a></h3>
@@ -55,35 +55,35 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="prefixing">Prefixing<a href="
 However, you as a user can also add your own prefixes by calling <code>prefix(...)</code>:</p>
 <p>Also note that the prefixes append to each other (including the prefix generated by the compiler plugin):</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example6 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> add </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> prefix</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;foo&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> add</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example6</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> add_foo_sum</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    add_foo_sum </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> add_foo_sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example6</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> add_foo_sum</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    add_foo_sum </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> add_foo_sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Sometimes you may want to disable the prefixing. This might occur if you are writing a library function and
 don&#x27;t want the prefixing behavior. In this case, you can call <code>noPrefix</code>:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example7 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> add </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> noPrefix </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> add</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example7</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> sum</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    sum </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example7</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> sum</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    sum </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="suggest-a-signals-name-or-the-instance-name-of-a-module">Suggest a Signal&#x27;s Name (or the instance name of a Module)<a href="#suggest-a-signals-name-or-the-instance-name-of-a-module" class="hash-link" aria-label="Direct link to Suggest a Signal&#x27;s Name (or the instance name of a Module)" title="Direct link to Suggest a Signal&#x27;s Name (or the instance name of a Module)">​</a></h3>
 <p>If you want to specify the name of a signal, you can always use the <code>.suggestName</code> API. Please note that the suggested
 name will still be prefixed (including by the plugin). You can always use the <code>noPrefix</code> object to strip this.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example8 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> add </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">suggestName</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;foo&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> add</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example8</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> add_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    add_foo </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> add_foo </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Example8</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> add_foo</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    add_foo </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> add_foo </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Note that using <code>.suggestName</code> does <strong>not</strong> affect prefixes derived from val names;
 however, it <em>can</em> affect prefixes derived from connections (eg. <code>:=</code>):</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> ConnectionPrefixExample </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> port </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">5.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// Even though this suggestName is before mul, the prefix used in this scope</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// is derived from `val out0`, so this does not affect the name of mul</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    port</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">suggestName</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;foo&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// out0_mul</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> mul </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in0 </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    port </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> mul </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    port</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out1 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// out1_sum</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in0 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Comes after so does *not* affect prefix above</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out1</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">suggestName</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;bar&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Comes before so *does* affect prefix below</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out2</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">suggestName</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;fizz&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out2 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// fizz_diff</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> diff </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> RegNext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in0 </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    diff </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ConnectionPrefixExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               fizz</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out0_mul</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1_sum</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> fizz_diff</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out0_mul </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in0</span><span class="token operator" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out1_sum </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    fizz_diff </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> out0_mul </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> out1_sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> fizz </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> fizz_diff </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">ConnectionPrefixExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">4</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> foo</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> bar</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               fizz</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out0_mul</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1_sum</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">reg</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> fizz_diff</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out0_mul </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in0</span><span class="token operator" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">*</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out1_sum </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    fizz_diff </span><span class="token operator" style="color:#393A34">&lt;=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> out0_mul </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> out1_sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> fizz </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> fizz_diff </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>As this example illustrates, this behavior is slightly inconsistent so is subject to change in a future version of Chisel.</p>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="behavior-for-unnamed-signals-aka-temporaries">Behavior for &quot;Unnamed signals&quot; (aka &quot;Temporaries&quot;)<a href="#behavior-for-unnamed-signals-aka-temporaries" class="hash-link" aria-label="Direct link to Behavior for &quot;Unnamed signals&quot; (aka &quot;Temporaries&quot;)" title="Direct link to Behavior for &quot;Unnamed signals&quot; (aka &quot;Temporaries&quot;)">​</a></h3>
 <p>If you want to signify that the name of a signal does not matter, you can prefix the name of your val with <code>_</code>.
 Chisel will preserve the convention of leading <code>_</code> signifying an unnamed signal across prefixes.
 For example:</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> TemporaryExample </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// We need 2 ports so firtool will maintain the common subexpression</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> port0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// out_port1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> port1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> _sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    port0 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _sum </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    port1 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _sum </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// port0 is returned so will get the name &quot;out&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    port0</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">TemporaryExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_port1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _out_sum_T </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _out_sum_T </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_port1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _out_sum_T </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">TemporaryExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               out_port1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _out_sum_T </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _out_sum_T </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out_port1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _out_sum_T </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>If an unnamed signal is itself used to generate a prefix, the leading <code>_</code> will be ignored to avoid double <code>__</code> in the names of further nested signals.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> TemporaryPrefixExample </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">3.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">4.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> _sum </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out0 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> x</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    x </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out1 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> _sum </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0x2</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">U</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">TemporaryPrefixExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _sum_x_T </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _sum_x_T</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _sum_x_T </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h2</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">TemporaryPrefixExample</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">wire</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> _sum_x_T </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in0 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out0 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _sum_x_T</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _sum_x_T </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h1</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2&#x27;h2</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-a-module-name">Set a Module Name<a href="#set-a-module-name" class="hash-link" aria-label="Direct link to Set a Module Name" title="Direct link to Set a Module Name">​</a></h3>
 <p>If you want to specify the module&#x27;s name (not the instance name of a module), you can always override the <code>desiredName</code>
 value. Note that you can parameterize the name by the module&#x27;s parameters. This is an excellent way to make your module
 names more stable and is highly recommended to do.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Example9</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">override</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> desiredName </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token string-interpolation id function" style="color:#d73a49">s</span><span class="token string-interpolation string" style="color:#e3116c">&quot;EXAMPLE9WITHWIDTH</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">$</span><span class="token string-interpolation interpolation expression">width</span><span class="token string-interpolation string" style="color:#e3116c">&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> add </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">suggestName</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;foo&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> add</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">EXAMPLE9WITHWIDTH8</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">6</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token operator" style="color:#393A34">}}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">EXAMPLE9WITHWIDTH1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/naming.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/explanations/muxes-and-input-selection"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Muxes and Input Selection</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/explanations/operators"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Operators</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#compiler-plugin" class="table-of-contents__link toc-highlight">Compiler Plugin</a></li><li><a href="#prefixing" class="table-of-contents__link toc-highlight">Prefixing</a></li><li><a href="#suggest-a-signals-name-or-the-instance-name-of-a-module" class="table-of-contents__link toc-highlight">Suggest a Signal&#39;s Name (or the instance name of a Module)</a></li><li><a href="#behavior-for-unnamed-signals-aka-temporaries" class="table-of-contents__link toc-highlight">Behavior for &quot;Unnamed signals&quot; (aka &quot;Temporaries&quot;)</a></li><li><a href="#set-a-module-name" class="table-of-contents__link toc-highlight">Set a Module Name</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs">Docs</a></li><li class="footer__item"><a href="/api/latest" target="_blank" rel="noopener noreferrer" class="footer__link-item">ScalaDoc</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/freechipsproject/chisel3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/chisel_lang" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ChipsAlliance. Built with Docusaurus.</div></div></div></footer></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">EXAMPLE9WITHWIDTH8</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">9</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token plain">in</span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">6</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1&#x27;h0</span><span class="token operator" style="color:#393A34">}}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">EXAMPLE9WITHWIDTH1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">{</span><span class="token number" style="color:#36acaa">2&#x27;h0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> in</span><span class="token operator" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/naming.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/explanations/muxes-and-input-selection"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Muxes and Input Selection</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/explanations/operators"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Operators</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#compiler-plugin" class="table-of-contents__link toc-highlight">Compiler Plugin</a></li><li><a href="#prefixing" class="table-of-contents__link toc-highlight">Prefixing</a></li><li><a href="#suggest-a-signals-name-or-the-instance-name-of-a-module" class="table-of-contents__link toc-highlight">Suggest a Signal&#39;s Name (or the instance name of a Module)</a></li><li><a href="#behavior-for-unnamed-signals-aka-temporaries" class="table-of-contents__link toc-highlight">Behavior for &quot;Unnamed signals&quot; (aka &quot;Temporaries&quot;)</a></li><li><a href="#set-a-module-name" class="table-of-contents__link toc-highlight">Set a Module Name</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs">Docs</a></li><li class="footer__item"><a href="/api/latest" target="_blank" rel="noopener noreferrer" class="footer__link-item">ScalaDoc</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/freechipsproject/chisel3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/chisel_lang" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ChipsAlliance. Built with Docusaurus.</div></div></div></footer></div>
 </body>
 </html>
\ No newline at end of file
diff --git a/docs/explanations/operators.html b/docs/explanations/operators.html
index 7eea36faa2..2e9324e792 100644
--- a/docs/explanations/operators.html
+++ b/docs/explanations/operators.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/polymorphism-and-parameterization.html b/docs/explanations/polymorphism-and-parameterization.html
index d338460a17..e0cbbcfa16 100644
--- a/docs/explanations/polymorphism-and-parameterization.html
+++ b/docs/explanations/polymorphism-and-parameterization.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -51,6 +51,6 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="parametrization-based-on-modu
 <p>You can also parametrize modules based on other modules rather than just types. The following is an example of a module parametrized by other modules as opposed to e.g. types.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">RawModule</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">BaseModule</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Provides a more specific interface since generic Module</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// provides no compile-time information on generic module&#x27;s IOs.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">trait</span><span class="token plain"> MyAdder </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> in1</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> UInt</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> in2</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> UInt</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">def</span><span class="token plain"> out</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> UInt</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Mod1 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token keyword" style="color:#00009f">with</span><span class="token plain"> MyAdder </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in2</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Mod2 </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> RawModule </span><span class="token keyword" style="color:#00009f">with</span><span class="token plain"> MyAdder </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> in2</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> X</span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">T </span><span class="token operator" style="color:#393A34">&lt;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> BaseModule </span><span class="token keyword" style="color:#00009f">with</span><span class="token plain"> MyAdder</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">genT</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">=&gt;</span><span class="token plain"> T</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> io </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> IO</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> Bundle </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> in2 </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Input</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Output</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">UInt</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">8.</span><span class="token plain">W</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> subMod </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Module</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">genT</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> subMod</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    subMod</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in1 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in1</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    subMod</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in2 </span><span class="token operator" style="color:#393A34">:</span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> io</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in2</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>Output:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Mod1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in2</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">X</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  Mod1 subMod </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in2 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Mod2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> in2</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">X</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  Mod2 subMod </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in2 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/polymorphism-and-parameterization.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/explanations/operators"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Operators</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/explanations/ports"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Ports</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#parameterized-functions" class="table-of-contents__link toc-highlight">Parameterized Functions</a></li><li><a href="#parameterized-classes" class="table-of-contents__link toc-highlight">Parameterized Classes</a></li><li><a href="#parametrization-based-on-modules" class="table-of-contents__link toc-highlight">Parametrization based on Modules</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs">Docs</a></li><li class="footer__item"><a href="/api/latest" target="_blank" rel="noopener noreferrer" class="footer__link-item">ScalaDoc</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/freechipsproject/chisel3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/chisel_lang" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ChipsAlliance. Built with Docusaurus.</div></div></div></footer></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Mod1</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> in2</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">X</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  Mod1 subMod </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in2 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Mod2</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               in2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">assign</span><span class="token plain"> out </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> in1 </span><span class="token operator" style="color:#393A34">-</span><span class="token plain"> in2</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">X</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">        clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_in1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">               io_in2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">output</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">7</span><span class="token punctuation" style="color:#393A34">:</span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> io_out</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  Mod2 subMod </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in1 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">in2 </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_in2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">out </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">io_out</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/chipsalliance/chisel/tree/main/docs/src/explanations/polymorphism-and-parameterization.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/explanations/operators"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Operators</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/explanations/ports"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Ports</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#parameterized-functions" class="table-of-contents__link toc-highlight">Parameterized Functions</a></li><li><a href="#parameterized-classes" class="table-of-contents__link toc-highlight">Parameterized Classes</a></li><li><a href="#parametrization-based-on-modules" class="table-of-contents__link toc-highlight">Parametrization based on Modules</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs">Docs</a></li><li class="footer__item"><a href="/api/latest" target="_blank" rel="noopener noreferrer" class="footer__link-item">ScalaDoc</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://gitter.im/freechipsproject/chisel3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Gitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/chisel_lang" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ChipsAlliance. Built with Docusaurus.</div></div></div></footer></div>
 </body>
 </html>
\ No newline at end of file
diff --git a/docs/explanations/ports.html b/docs/explanations/ports.html
index f11da7f0ac..5ed966fe4a 100644
--- a/docs/explanations/ports.html
+++ b/docs/explanations/ports.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/printing.html b/docs/explanations/printing.html
index c5157dc4e7..ec45600bb3 100644
--- a/docs/explanations/printing.html
+++ b/docs/explanations/printing.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/properties.html b/docs/explanations/properties.html
index b63956b46d..0d7e64b150 100644
--- a/docs/explanations/properties.html
+++ b/docs/explanations/properties.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/reset.html b/docs/explanations/reset.html
index e77414d130..85b390bf36 100644
--- a/docs/explanations/reset.html
+++ b/docs/explanations/reset.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/sequential-circuits.html b/docs/explanations/sequential-circuits.html
index 56e8c204de..3b8805298b 100644
--- a/docs/explanations/sequential-circuits.html
+++ b/docs/explanations/sequential-circuits.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/source-locators.html b/docs/explanations/source-locators.html
index cb387b4026..96ed7850b0 100644
--- a/docs/explanations/source-locators.html
+++ b/docs/explanations/source-locators.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/supported-hardware.html b/docs/explanations/supported-hardware.html
index 5ba506a17a..157b7b05ec 100644
--- a/docs/explanations/supported-hardware.html
+++ b/docs/explanations/supported-hardware.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/unconnected-wires.html b/docs/explanations/unconnected-wires.html
index 1767adb299..a388de0007 100644
--- a/docs/explanations/unconnected-wires.html
+++ b/docs/explanations/unconnected-wires.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/warnings.html b/docs/explanations/warnings.html
index 1f7e28be14..28aaae7e53 100644
--- a/docs/explanations/warnings.html
+++ b/docs/explanations/warnings.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/width-inference.html b/docs/explanations/width-inference.html
index a67485dba7..798599f2d4 100644
--- a/docs/explanations/width-inference.html
+++ b/docs/explanations/width-inference.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/installation.html b/docs/installation.html
index 0f96dc67f0..763a0b38a6 100644
--- a/docs/installation.html
+++ b/docs/installation.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/resources.html b/docs/resources.html
index 6a4186f140..32e74d47f8 100644
--- a/docs/resources.html
+++ b/docs/resources.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/resources/faqs.html b/docs/resources/faqs.html
index e4cef4d224..ea53d5991b 100644
--- a/docs/resources/faqs.html
+++ b/docs/resources/faqs.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -62,7 +62,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-me-verilog">Get me Verilo
 <p>or as a one-liner:</p>
 <div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">bash&gt; sbt &#x27;runMain intro.VerilogMain&#x27;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>After either of the above there will be a HelloWorld.v file in the current directory:</p>
-<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">HelloWorld</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:11:7</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:11:7</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        reset	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:11:7</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/cover/layers-HelloWorld-Verification-Cover.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-HelloWorld-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_HelloWorld_Verification_Cover</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_HelloWorld_Verification_Cover	</span><span class="token comment" style="color:#999988;font-style:italic">// &lt;stdin&gt;:6:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_HelloWorld_Verification_Cover	// &lt;stdin&gt;:6:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assume/layers-HelloWorld-Verification-Assume.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-HelloWorld-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_HelloWorld_Verification_Assume</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_HelloWorld_Verification_Assume	</span><span class="token comment" style="color:#999988;font-style:italic">// &lt;stdin&gt;:5:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_HelloWorld_Verification_Assume	// &lt;stdin&gt;:5:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assert/layers-HelloWorld-Verification-Assert.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-HelloWorld-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_HelloWorld_Verification_Assert</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_HelloWorld_Verification_Assert	</span><span class="token comment" style="color:#999988;font-style:italic">// &lt;stdin&gt;:4:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_HelloWorld_Verification_Assert	// &lt;stdin&gt;:4:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/layers-HelloWorld-Verification.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_HelloWorld_Verification</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_HelloWorld_Verification	</span><span class="token comment" style="color:#999988;font-style:italic">// &lt;stdin&gt;:3:3</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">bind</span><span class="token plain"> HelloWorld HelloWorld_Verification verification </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">reset </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_HelloWorld_Verification	// &lt;stdin&gt;:3:3</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/HelloWorld_Verification.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.99.2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;PRINTF_COND&#x27; to add an extra gate to prints.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> PRINTF_COND_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> PRINTF_COND</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_COND_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_COND</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_COND_ </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def PRINTF_COND_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">HelloWorld_Verification</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        clock	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> SYNTHESIS	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_COND_</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">~</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token kernel-function property" style="color:#36acaa">$fwrite</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">32&#x27;h80000002</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;hello world\n&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def SYNTHESIS</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="language-verilog codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-verilog codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">HelloWorld</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:11:7</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:11:7</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        reset	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:11:7</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/cover/layers-HelloWorld-Verification-Cover.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-HelloWorld-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_HelloWorld_Verification_Cover</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_HelloWorld_Verification_Cover	</span><span class="token comment" style="color:#999988;font-style:italic">// &lt;stdin&gt;:6:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_HelloWorld_Verification_Cover	// &lt;stdin&gt;:6:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assume/layers-HelloWorld-Verification-Assume.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-HelloWorld-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_HelloWorld_Verification_Assume</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_HelloWorld_Verification_Assume	</span><span class="token comment" style="color:#999988;font-style:italic">// &lt;stdin&gt;:5:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_HelloWorld_Verification_Assume	// &lt;stdin&gt;:5:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/assert/layers-HelloWorld-Verification-Assert.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`include</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;verification/layers-HelloWorld-Verification.sv&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_HelloWorld_Verification_Assert</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_HelloWorld_Verification_Assert	</span><span class="token comment" style="color:#999988;font-style:italic">// &lt;stdin&gt;:4:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_HelloWorld_Verification_Assert	// &lt;stdin&gt;:4:5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/layers-HelloWorld-Verification.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> layers_HelloWorld_Verification</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> layers_HelloWorld_Verification	</span><span class="token comment" style="color:#999988;font-style:italic">// &lt;stdin&gt;:3:3</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">bind</span><span class="token plain"> HelloWorld HelloWorld_Verification verification </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">reset </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">clock </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// layers_HelloWorld_Verification	// &lt;stdin&gt;:3:3</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ----- 8&lt; ----- FILE &quot;verification/HelloWorld_Verification.sv&quot; ----- 8&lt; -----</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Generated by CIRCT firtool-1.100.0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;PRINTF_FD&#x27; to add a specified fd to prints.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> PRINTF_FD_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> PRINTF_FD</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_FD_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_FD</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_FD</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_FD_ </span><span class="token number" style="color:#36acaa">32&#x27;h80000002</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_FD</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def PRINTF_FD_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Users can define &#x27;PRINTF_COND&#x27; to add an extra gate to prints.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> PRINTF_COND_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifdef</span><span class="token plain"> PRINTF_COND</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_COND_ </span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_COND</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`else</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token constant" style="color:#36acaa">`define</span><span class="token plain"> PRINTF_COND_ </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// PRINTF_COND</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def PRINTF_COND_</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">module</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">HelloWorld_Verification</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">input</span><span class="token plain"> reset</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        clock	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`ifndef</span><span class="token plain"> SYNTHESIS	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token important">always @</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">posedge</span><span class="token plain"> clock</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">begin</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      </span><span class="token keyword" style="color:#00009f">if</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_COND_</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">&amp;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">~</span><span class="token plain">reset</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        </span><span class="token kernel-function property" style="color:#36acaa">$fwrite</span><span class="token punctuation" style="color:#393A34">(</span><span class="token constant" style="color:#36acaa">`PRINTF_FD_</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;hello world\n&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain">	</span><span class="token comment" style="color:#999988;font-style:italic">// faqs.md:13:9</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    </span><span class="token keyword" style="color:#00009f">end</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// always @(posedge)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token constant" style="color:#36acaa">`endif</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// not def SYNTHESIS</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">endmodule</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>You can see additional options with</p>
 <div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">bash&gt; sbt &#x27;runMain intro.HelloWorld --help&#x27;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <p>This will return a comprehensive usage line with available options.</p>
diff --git a/generated/contributors.html b/generated/contributors.html
index 98ef4df4d2..9fc35ba59c 100644
--- a/generated/contributors.html
+++ b/generated/contributors.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/generated/scaladoc_links.html b/generated/scaladoc_links.html
index b181b27685..7a5d82878e 100644
--- a/generated/scaladoc_links.html
+++ b/generated/scaladoc_links.html
@@ -9,13 +9,13 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
 <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/chisel-tool.svg" alt="Chisel Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/chisel-tool.svg" alt="Chisel Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Chisel</b></a><a class="navbar__item navbar__link" href="/docs">Docs</a><a class="navbar__item navbar__link" href="/community">Community</a><a class="navbar__item navbar__link" href="/api">API</a><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://www.chipsalliance.org/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-chipsalliance-link" aria-label="ChipsAlliance link"></a><a href="https://github.com/chipsalliance/chisel" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Command+K)"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container container--fluid margin-vert--lg"><div class="row mdxPageWrapper_j9I6"><div class="col col--8"><article><ul>
 <li><a href="/api/latest/index.html" target="_blank" rel="noopener noreferrer">Latest (6.6.0)</a></li>
-<li><a href="https://s01.oss.sonatype.org/service/local/repositories/snapshots/archive/org/chipsalliance/chisel_2.13/7.0.0-M2+285-e12935ed-SNAPSHOT/chisel_2.13-7.0.0-M2+285-e12935ed-SNAPSHOT-javadoc.jar/!/index.html" target="_blank" rel="noopener noreferrer">Snapshot</a></li>
+<li><a href="https://s01.oss.sonatype.org/service/local/repositories/snapshots/archive/org/chipsalliance/chisel_2.13/7.0.0-M2+286-ba4e01c3-SNAPSHOT/chisel_2.13-7.0.0-M2+286-ba4e01c3-SNAPSHOT-javadoc.jar/!/index.html" target="_blank" rel="noopener noreferrer">Snapshot</a></li>
 <li><a href="https://javadoc.io/doc/org.chipsalliance/chisel_2.13/7.0.0-M2" target="_blank" rel="noopener noreferrer">7.0.0-M2</a></li>
 <li><a href="https://javadoc.io/doc/org.chipsalliance/chisel_2.13/6.6.0" target="_blank" rel="noopener noreferrer">6.6.0</a></li>
 <li><a href="https://javadoc.io/doc/org.chipsalliance/chisel_2.13/5.3.0" target="_blank" rel="noopener noreferrer">5.3.0</a></li>
diff --git a/index.html b/index.html
index c0ebff7d81..5375eb4571 100644
--- a/index.html
+++ b/index.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/search.html b/search.html
index 2c2a3ab7ba..0f04ff9550 100644
--- a/search.html
+++ b/search.html
@@ -9,7 +9,7 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ae3593a0.css">
-<script src="/assets/js/runtime~main.ecc71767.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.6f6687cd.js" defer="defer"></script>
 <script src="/assets/js/main.bbda3ac1.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">