diff --git a/404.html b/404.html
index e8705842d0..d7bbabb007 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/api.html b/api.html
index 3af97bff4c..1629f81372 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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+483-d6552d4c-SNAPSHOT/chisel_2.13-7.0.0-M2+483-d6552d4c-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+484-327305d9-SNAPSHOT/chisel_2.13-7.0.0-M2+484-327305d9-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 12b66d985e..4b3e472412 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/assets/js/7b5bfa87.7d4d4a76.js b/assets/js/7b5bfa87.ae3bf0cd.js
similarity index 85%
rename from assets/js/7b5bfa87.7d4d4a76.js
rename to assets/js/7b5bfa87.ae3bf0cd.js
index 6b6c3ce4fc..e7d659c986 100644
--- a/assets/js/7b5bfa87.7d4d4a76.js
+++ b/assets/js/7b5bfa87.ae3bf0cd.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:85)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:83)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:83)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:110)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:107)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:107)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:133)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:133)\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:133)\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:133)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:131)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:131)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:155)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:155)\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:155)\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:155)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:154)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:154)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:177)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:177)\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:177)\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:177)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:175)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:175)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:201)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:201)\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:201)\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:201)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:199)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:199)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:227)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:227)\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:227)\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:227)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:226)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:226)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:266)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:263)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:263)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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 @8ecfa11)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:288)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:288)\n// \tat chisel3.SpecifiedDirection$.specifiedDirection(DataImpl.scala:72)\n// \tat chisel3.Output$.apply(DataImpl.scala:317)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:288)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:288)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(ModuleImpl.scala:893)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:288)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:288)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:288)\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:288)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:304)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:304)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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.107.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
+"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:85)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:83)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:83)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:110)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:107)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:107)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:133)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:133)\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:133)\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:133)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:131)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:131)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:155)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:155)\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:155)\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:155)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:154)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:154)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:177)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:177)\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:177)\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:177)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:175)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:175)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:201)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:201)\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:201)\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:201)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:199)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:199)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:227)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:227)\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:227)\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:227)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:226)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:226)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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:266)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:263)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:263)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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 @712aaf3c)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:288)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:288)\n// \tat chisel3.SpecifiedDirection$.specifiedDirection(DataImpl.scala:72)\n// \tat chisel3.Output$.apply(DataImpl.scala:317)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:288)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:288)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(ModuleImpl.scala:893)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:288)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:288)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:288)\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:288)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:304)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:304)\n// \tat chisel3.ObjectModuleImpl.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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.107.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/7e1e4a75.3b5afade.js b/assets/js/7e1e4a75.b989098b.js
similarity index 99%
rename from assets/js/7e1e4a75.3b5afade.js
rename to assets/js/7e1e4a75.b989098b.js
index 2bda04e828..c97a5aa949 100644
--- a/assets/js/7e1e4a75.3b5afade.js
+++ b/assets/js/7e1e4a75.b989098b.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[5432],{1871:(e,n,a)=>{a.d(n,{A:()=>i});a(6540);var t=a(5195);const l={tableOfContentsInline:"tableOfContentsInline_prmo"};var o=a(4848);function i(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:i}=e;return(0,o.jsx)("div",{className:l.tableOfContentsInline,children:(0,o.jsx)(t.A,{toc:n,minHeadingLevel:a,maxHeadingLevel:i,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,a)=>{a.d(n,{A:()=>g});var t=a(6540),l=a(6342);function o(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,...l}=e;a>=0?n[a].children.push(l):t.push(l)})),t}function i(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=i({toc:e.children,minHeadingLevel:a,maxHeadingLevel:t});return function(e){return e.level>=a&&e.level<=t}(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 t=e.find((e=>s(e).top>=a));if(t){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(s(t))?t:e[e.indexOf(t)-1]??null}return e[e.length-1]??null}function r(){const e=(0,t.useRef)(0),{navbar:{hideOnScroll:n}}=(0,l.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=r();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:l,minHeadingLevel:o,maxHeadingLevel:i}=e;function s(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),s=function(e){let{minHeadingLevel:n,maxHeadingLevel:a}=e;const t=[];for(let l=n;l<=a;l+=1)t.push(`h${l}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:o,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(l),e.classList.add(l),n.current=e):e.classList.remove(l)}(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:t,isChild:l}=e;return n.length?(0,h.jsx)("ul",{className:l?void 0:a,children:n.map((e=>(0,h.jsxs)("li",{children:[(0,h.jsx)(u.A,{to:`#${e.id}`,className:t??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,h.jsx)(p,{isChild:!0,toc:e.children,className:a,linkClassName:t})]},e.id)))}):null}const m=t.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,l.p)(),x=r??g.tableOfContents.minHeadingLevel,f=u??g.tableOfContents.maxHeadingLevel,w=function(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:l}=e;return(0,t.useMemo)((()=>i({toc:o(n),minHeadingLevel:a,maxHeadingLevel:l})),[n,a,l])}({toc:n,minHeadingLevel:x,maxHeadingLevel:f});return d((0,t.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})}},7363:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=a(4848),l=a(8453),o=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,l.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"general-cookbook",children:"General Cookbook"})}),"\n",(0,t.jsxs)(n.p,{children:["Please note that these examples make use of ",(0,t.jsx)(n.a,{href:"../explanations/printing#scala-style",children:"Chisel's scala-style printing"}),"."]}),"\n","\n",(0,t.jsx)(o.A,{toc:d}),"\n",(0,t.jsx)(n.h2,{id:"type-conversions",children:"Type Conversions"}),"\n",(0,t.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,t.jsxs)(n.p,{children:["Call ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html#asUInt:chisel3.UInt",children:(0,t.jsx)(n.code,{children:"asUInt"})})," on the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html",children:(0,t.jsx)(n.code,{children:"Bundle"})})," instance."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["Use the ",(0,t.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,t.jsx)(n.code,{children:"asTypeOf"})})," method to reinterpret the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html",children:(0,t.jsx)(n.code,{children:"UInt"})})," as the type of the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html",children:(0,t.jsx)(n.code,{children:"Bundle"})}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h3,{id:"how-can-i-tieoff-a-bundlevec-to-0",children:"How can I tieoff a Bundle/Vec to 0?"}),"\n",(0,t.jsxs)(n.p,{children:["You can use ",(0,t.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,t.jsx)(n.code,{children:"chiselTypeOf"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["Use ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/VecInit$.html",children:(0,t.jsx)(n.code,{children:"VecInit"})})," given a ",(0,t.jsx)(n.code,{children:"Seq[Bool]"})," generated using the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html#asBools:Seq%5Bchisel3.Bool%5D",children:(0,t.jsx)(n.code,{children:"asBools"})})," method."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["Use the builtin function ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Vec.html#asUInt:chisel3.UInt",children:(0,t.jsx)(n.code,{children:"asUInt"})})]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["See the ",(0,t.jsx)(n.a,{href:"dataview#how-do-i-connect-a-subset-of-bundle-fields",children:"DataView cookbook"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"vectors-and-registers",children:"Vectors and Registers"}),"\n",(0,t.jsx)(n.h3,{id:"can-i-make-a-2d-or-3d-vector",children:"Can I make a 2D or 3D Vector?"}),"\n",(0,t.jsxs)(n.p,{children:["Yes. Using ",(0,t.jsx)(n.code,{children:"VecInit"})," you can make Vectors that hold Vectors of Chisel types. Methods ",(0,t.jsx)(n.code,{children:"fill"})," and ",(0,t.jsx)(n.code,{children:"tabulate"})," make these multi-dimensional Vectors."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h3,{id:"how-do-i-create-a-vector-of-registers",children:"How do I create a Vector of Registers?"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Rule!  Use Reg of Vec not Vec of Reg!"})}),"\n",(0,t.jsxs)(n.p,{children:["You create a ",(0,t.jsx)(n.a,{href:"#how-do-i-create-a-reg-of-type-vec",children:"Reg of type Vec"}),". Because Vecs are a ",(0,t.jsx)(n.em,{children:"type"})," (like ",(0,t.jsx)(n.code,{children:"UInt"}),", ",(0,t.jsx)(n.code,{children:"Bool"}),") rather than a ",(0,t.jsx)(n.em,{children:"value"}),", we must bind the Vec to some concrete ",(0,t.jsx)(n.em,{children:"value"}),"."]}),"\n",(0,t.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,t.jsxs)(n.p,{children:["For more information, the API Documentation for ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Vec.html",children:(0,t.jsx)(n.code,{children:"Vec"})})," provides more information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h3,{id:"how-do-i-partially-reset-an-aggregate-reg",children:"How do I partially reset an Aggregate Reg?"}),"\n",(0,t.jsxs)(n.p,{children:["The easiest way is to use a partially-specified ",(0,t.jsx)(n.a,{href:"../appendix/experimental-features#bundle-literals",children:"Bundle Literal"}),"\nor ",(0,t.jsx)(n.a,{href:"../appendix/experimental-features#vec-literals",children:"Vec Literal"})," to match the type of the Reg."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsx)(n.code,{children:"DontCare"})," that\nyou do not wish to be reset."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h2,{id:"bundles",children:"Bundles"}),"\n",(0,t.jsx)(n.h3,{id:"how-do-i-deal-with-aliased-bundle-fields",children:"How do I deal with aliased Bundle fields?"}),"\n",(0,t.jsxs)(n.p,{children:["Following the ",(0,t.jsx)(n.code,{children:"gen"})," pattern when creating Bundles can result in some opaque error messages:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.pre,{children:(0,t.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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsxs)(n.p,{children:["This error is saying that fields ",(0,t.jsx)(n.code,{children:"foo"})," and ",(0,t.jsx)(n.code,{children:"bar"})," of ",(0,t.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,t.jsx)(n.code,{children:"foo"})," and ",(0,t.jsx)(n.code,{children:"bar"})," but cannot when they are referentially the same."]}),"\n",(0,t.jsx)(n.p,{children:"Note that the following example looks different but will give you exactly the same issue:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["By making ",(0,t.jsx)(n.code,{children:"gen"})," a ",(0,t.jsx)(n.code,{children:"val"}),", it becomes a public field of the ",(0,t.jsx)(n.code,{children:"class"}),", just like ",(0,t.jsx)(n.code,{children:"foo"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsx)(n.p,{children:"There are several ways to solve this issue with their own advantages and disadvantages."}),"\n",(0,t.jsx)(n.h4,{id:"1-0-arity-function-parameters",children:"1. 0-arity function parameters"}),"\n",(0,t.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,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Note that the type of ",(0,t.jsx)(n.code,{children:"gen"})," is now ",(0,t.jsx)(n.code,{children:"() => T"}),".\nBecause it is now a function and not a subtype of ",(0,t.jsx)(n.code,{children:"Data"}),", you can safely make ",(0,t.jsx)(n.code,{children:"gen"})," a ",(0,t.jsx)(n.code,{children:"val"})," without\nit becoming a hardware field of the ",(0,t.jsx)(n.code,{children:"Bundle"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Note that this also means you must pass ",(0,t.jsx)(n.code,{children:"gen"})," as a function, for example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"chisel3.docs.emitSystemVerilog(new Top(new UsingAFunctionBundle(() => UInt(8.W))))\n"})}),"\n",(0,t.jsx)(n.h5,{id:"aliased-warning",children:"Aliased Warning"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Warning"}),": you must ensure that ",(0,t.jsx)(n.code,{children:"gen"})," creates fresh objects rather than capturing an already constructed value:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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:893)\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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsxs)(n.p,{children:["In the above example, value ",(0,t.jsx)(n.code,{children:"fizz"})," and fields ",(0,t.jsx)(n.code,{children:"foo"})," and ",(0,t.jsx)(n.code,{children:"bar"})," of ",(0,t.jsx)(n.code,{children:"out"})," are all the same object in memory."]}),"\n",(0,t.jsx)(n.h4,{id:"2-by-name-function-parameters",children:"2. By-name function parameters"}),"\n",(0,t.jsxs)(n.p,{children:["Functionally the same as (1) but with more subtle syntax, you can use ",(0,t.jsx)(n.a,{href:"https://docs.scala-lang.org/tour/by-name-parameters.html",children:"Scala by-name function parameters"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["With this usage, you do not include ",(0,t.jsx)(n.code,{children:"() =>"})," when passing the argument:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"chisel3.docs.emitSystemVerilog(new Top(new UsingByNameParameters(UInt(8.W))))\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that as this is just syntactic sugar over (1), the ",(0,t.jsx)(n.a,{href:"#aliased-warning",children:"same warning applies"}),"."]}),"\n",(0,t.jsx)(n.h4,{id:"3-directioned-bundle-fields",children:"3. Directioned Bundle fields"}),"\n",(0,t.jsxs)(n.p,{children:["You can alternatively wrap the fields with ",(0,t.jsx)(n.code,{children:"Output(...)"}),", which creates fresh instances of the passed argument.\nChisel treats ",(0,t.jsx)(n.code,{children:"Output"}),' as the "default direction" so if all fields are outputs, the ',(0,t.jsx)(n.code,{children:"Bundle"})," is functionally equivalent to a ",(0,t.jsx)(n.code,{children:"Bundle"})," with no directioned fields."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsx)(n.code,{children:"Output"}),"."]}),"\n",(0,t.jsxs)(n.h4,{id:"4-call-clonetype-directly",children:["4. Call ",(0,t.jsx)(n.code,{children:".cloneType"})," directly"]}),"\n",(0,t.jsxs)(n.p,{children:["You can also just call ",(0,t.jsx)(n.code,{children:".cloneType"})," on your ",(0,t.jsx)(n.code,{children:"gen"})," argument directly.\nWhile we try to hide this implementation detail from the user, ",(0,t.jsx)(n.code,{children:".cloneType"})," is the mechanism by which Chisel creates fresh instances of ",(0,t.jsx)(n.code,{children:"Data"})," objects:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.h3,{id:"-how-do-i-deal-with-the-unable-to-clone-error",children:[(0,t.jsx)("a",{name:"bundle-unable-to-clone"}),' How do I deal with the "unable to clone" error?']}),"\n",(0,t.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,t.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,t.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,t.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,t.jsx)(n.code,{children:"chiselTypeClone"})," method\nin ",(0,t.jsx)(n.code,{children:"chisel3.reflect.DataMirror"}),". Here's an example with the Bundle whose fields\nwon't get cloned:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsxs)(n.p,{children:["You can use ",(0,t.jsx)(n.code,{children:"chiselTypeClone"})," to clone the elements as:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["The advised way is to use ",(0,t.jsx)(n.code,{children:"ChiselEnum"})," to construct enumerated types representing the state of the FSM.\nState transitions are then handled with ",(0,t.jsx)(n.code,{children:"switch"}),"/",(0,t.jsx)(n.code,{children:"is"})," and ",(0,t.jsx)(n.code,{children:"when"}),"/",(0,t.jsx)(n.code,{children:".elsewhen"}),"/",(0,t.jsx)(n.code,{children:".otherwise"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Note: the ",(0,t.jsx)(n.code,{children:"is"})," statement can take multiple conditions e.g. ",(0,t.jsx)(n.code,{children:"is (sTwo1s, sOne1) { ... }"}),"."]}),"\n",(0,t.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,t.jsxs)(n.p,{children:["In Verilog, you can do something like the following which will unpack a the value ",(0,t.jsx)(n.code,{children:"z"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"The easiest way to accomplish this in Chisel would be:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["If you ",(0,t.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,t.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,t.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,t.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,t.jsx)(n.code,{children:"io.out(0)"})," is not allowed."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"If you try to compile this, you will get an error."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsxs)(n.p,{children:["Chisel3 ",(0,t.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,t.jsx)(n.code,{children:"Bundle"})," or a ",(0,t.jsx)(n.code,{children:"Vec"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["If you must express it this way, one approach is to blast your ",(0,t.jsx)(n.code,{children:"UInt"})," to a ",(0,t.jsx)(n.code,{children:"Vec"})," of ",(0,t.jsx)(n.code,{children:"Bool"})," and back:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h2,{id:"how-do-i-create-an-optional-io",children:"How do I create an optional I/O?"}),"\n",(0,t.jsxs)(n.p,{children:["The following example is a module which includes the optional port ",(0,t.jsx)(n.code,{children:"out2"})," only if the given parameter is ",(0,t.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["The following is an example where an entire ",(0,t.jsx)(n.code,{children:"IO"})," is optional:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h2,{id:"how-do-i-create-io-without-a-prefix",children:"How do I create I/O without a prefix?"}),"\n",(0,t.jsxs)(n.p,{children:["In most cases, you can simply call ",(0,t.jsx)(n.code,{children:"IO"})," multiple times:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.jsxs)(n.p,{children:["If you have a ",(0,t.jsx)(n.code,{children:"Bundle"})," from which you would like to create ports without the\nnormal ",(0,t.jsx)(n.code,{children:"val"})," prefix, you can use ",(0,t.jsx)(n.code,{children:"FlatIO"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Note that ",(0,t.jsx)(n.code,{children:"io_"})," is nowhere to be seen!"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.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,t.jsxs)(n.p,{children:["To change the clock or reset for a region of code, use ",(0,t.jsx)(n.code,{children:"withClock"}),", ",(0,t.jsx)(n.code,{children:"withReset"}),", or ",(0,t.jsx)(n.code,{children:"withClockAndReset"}),".\nSee ",(0,t.jsx)(n.a,{href:"../explanations/multi-clock",children:"Multiple Clock Domains"})," for examples and details."]}),"\n",(0,t.jsxs)(n.p,{children:["To override the clock or reset for the entire scope of the ",(0,t.jsx)(n.code,{children:"Module"}),", you can mixin the ",(0,t.jsx)(n.code,{children:"ImplicitClock"})," and ",(0,t.jsx)(n.code,{children:"ImplicitReset"})," traits."]}),"\n",(0,t.jsx)(n.p,{children:'For example, you could "gate" the default implicit clock as follows:'}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"This gives the following Verilog:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.jsxs)(n.p,{children:["If you do not care about the name of the overriden clock, you can just assign it to ",(0,t.jsx)(n.code,{children:"val implicitClock"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"override protected val implicitClock = (clock.asBool || gate).asClock\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"ImplicitReset"})," works analogously to ",(0,t.jsx)(n.code,{children:"ImplicitClock"}),"."]}),"\n",(0,t.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,t.jsxs)(n.p,{children:["Use inferred width and a ",(0,t.jsx)(n.code,{children:"Seq"})," instead of a ",(0,t.jsx)(n.code,{children:"Vec"}),":"]}),"\n",(0,t.jsx)(n.p,{children:"Consider:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"Note that top modules or public modules cannot have unknown widths."}),"\n",(0,t.jsxs)(n.p,{children:["Unlike ",(0,t.jsx)(n.code,{children:"Vecs"})," which represent a singular Chisel type and must have the same width for every element,\n",(0,t.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,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.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,t.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,t.jsxs)(n.p,{children:["When the index does not have enough bits to address all entries or bits in the extractee, you can ",(0,t.jsx)(n.code,{children:".pad"})," the index to increase the width."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["This can be fixed with ",(0,t.jsx)(n.code,{children:"pad"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"This can be fixed with bit extraction:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Note that size 1 ",(0,t.jsx)(n.code,{children:"Vecs"})," and ",(0,t.jsx)(n.code,{children:"UInts"})," should be indexed by a zero-width ",(0,t.jsx)(n.code,{children:"UInt"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Because ",(0,t.jsx)(n.code,{children:"pad"})," only pads if the desired width is less than the current width of the argument,\nyou can use ",(0,t.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,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Another option for dynamic bit selection of ",(0,t.jsx)(n.code,{children:"UInts"})," (but not ",(0,t.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,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:['Verilog has "case equality" (',(0,t.jsx)(n.code,{children:"==="}),") and inequality (",(0,t.jsx)(n.code,{children:"!=="}),") operators.\nThey are typically used to ignore unknown (",(0,t.jsx)(n.code,{children:"X"}),") values in assertions."]}),"\n",(0,t.jsxs)(n.p,{children:["Chisel does not support Verilog ",(0,t.jsx)(n.code,{children:"X"})," directly, but it is possible to check if a value is ",(0,t.jsx)(n.code,{children:"X"})," with ",(0,t.jsx)(n.code,{children:"chisel3.util.circt.isX"}),".\n",(0,t.jsx)(n.code,{children:"isX"})," is commonly used to guard assertions against ",(0,t.jsx)(n.code,{children:"X"})," which gives similar behavior to Verilog case equality."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h2,{id:"predictable-naming",children:"Predictable Naming"}),"\n",(0,t.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,t.jsxs)(n.p,{children:["Use the compiler plugin, and check out the ",(0,t.jsx)(n.a,{href:"naming",children:"Naming Cookbook"})," if that still does not do what you want."]}),"\n",(0,t.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,t.jsx)(n.p,{children:"Currently, name information is lost when using dynamic indexing. For example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["The above code loses the ",(0,t.jsx)(n.code,{children:"x"})," name, instead using ",(0,t.jsx)(n.code,{children:"_GEN_3"})," (the other ",(0,t.jsx)(n.code,{children:"_GEN_*"})," signals are expected)."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.jsx)(n.p,{children:"This can be worked around by creating a wire and connecting the dynamic index to the wire:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"val x = WireInit(io.in(io.idx))\n"})}),"\n",(0,t.jsx)(n.p,{children:"Which produces:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.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,t.jsxs)(n.p,{children:["You can override the ",(0,t.jsx)(n.code,{children:"desiredName"})," function. This works with normal Chisel modules and ",(0,t.jsx)(n.code,{children:"BlackBox"}),"es. Example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Elaborating the Chisel module ",(0,t.jsx)(n.code,{children:"Salt"}),' yields our "desired names" for ',(0,t.jsx)(n.code,{children:"Salt"})," and ",(0,t.jsx)(n.code,{children:"Coffee"})," in the output Verilog:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.jsx)(n.h2,{id:"directionality",children:"Directionality"}),"\n",(0,t.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,t.jsxs)(n.p,{children:["Given a bidirectional port like a ",(0,t.jsx)(n.code,{children:"Decoupled"}),", you will get an error if you try to connect it directly\nto a register:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new BadRegConnect)\n// circt.stage.phases.Exceptions$FirtoolNonZeroExitCode: /home/runner/.cache/llvm-firtool/1.107.0/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+483-d6552d4c-SNAPSHOT) was published against firtool version 1.107.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,t.jsxs)(n.p,{children:['While there is no construct to "strip direction" in Chisel3, wrapping a type in ',(0,t.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,t.jsx)(n.pre,{children:(0,t.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,l.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>s});var t=a(6540);const l={},o=t.createContext(l);function i(e){const n=t.useContext(o);return t.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:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[5432],{1871:(e,n,a)=>{a.d(n,{A:()=>i});a(6540);var t=a(5195);const l={tableOfContentsInline:"tableOfContentsInline_prmo"};var o=a(4848);function i(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:i}=e;return(0,o.jsx)("div",{className:l.tableOfContentsInline,children:(0,o.jsx)(t.A,{toc:n,minHeadingLevel:a,maxHeadingLevel:i,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,a)=>{a.d(n,{A:()=>g});var t=a(6540),l=a(6342);function o(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,...l}=e;a>=0?n[a].children.push(l):t.push(l)})),t}function i(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=i({toc:e.children,minHeadingLevel:a,maxHeadingLevel:t});return function(e){return e.level>=a&&e.level<=t}(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 t=e.find((e=>s(e).top>=a));if(t){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(s(t))?t:e[e.indexOf(t)-1]??null}return e[e.length-1]??null}function r(){const e=(0,t.useRef)(0),{navbar:{hideOnScroll:n}}=(0,l.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=r();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:l,minHeadingLevel:o,maxHeadingLevel:i}=e;function s(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),s=function(e){let{minHeadingLevel:n,maxHeadingLevel:a}=e;const t=[];for(let l=n;l<=a;l+=1)t.push(`h${l}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:o,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(l),e.classList.add(l),n.current=e):e.classList.remove(l)}(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:t,isChild:l}=e;return n.length?(0,h.jsx)("ul",{className:l?void 0:a,children:n.map((e=>(0,h.jsxs)("li",{children:[(0,h.jsx)(u.A,{to:`#${e.id}`,className:t??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,h.jsx)(p,{isChild:!0,toc:e.children,className:a,linkClassName:t})]},e.id)))}):null}const m=t.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,l.p)(),x=r??g.tableOfContents.minHeadingLevel,f=u??g.tableOfContents.maxHeadingLevel,w=function(e){let{toc:n,minHeadingLevel:a,maxHeadingLevel:l}=e;return(0,t.useMemo)((()=>i({toc:o(n),minHeadingLevel:a,maxHeadingLevel:l})),[n,a,l])}({toc:n,minHeadingLevel:x,maxHeadingLevel:f});return d((0,t.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})}},7363:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=a(4848),l=a(8453),o=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,l.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"general-cookbook",children:"General Cookbook"})}),"\n",(0,t.jsxs)(n.p,{children:["Please note that these examples make use of ",(0,t.jsx)(n.a,{href:"../explanations/printing#scala-style",children:"Chisel's scala-style printing"}),"."]}),"\n","\n",(0,t.jsx)(o.A,{toc:d}),"\n",(0,t.jsx)(n.h2,{id:"type-conversions",children:"Type Conversions"}),"\n",(0,t.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,t.jsxs)(n.p,{children:["Call ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html#asUInt:chisel3.UInt",children:(0,t.jsx)(n.code,{children:"asUInt"})})," on the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html",children:(0,t.jsx)(n.code,{children:"Bundle"})})," instance."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["Use the ",(0,t.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,t.jsx)(n.code,{children:"asTypeOf"})})," method to reinterpret the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html",children:(0,t.jsx)(n.code,{children:"UInt"})})," as the type of the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Bundle.html",children:(0,t.jsx)(n.code,{children:"Bundle"})}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h3,{id:"how-can-i-tieoff-a-bundlevec-to-0",children:"How can I tieoff a Bundle/Vec to 0?"}),"\n",(0,t.jsxs)(n.p,{children:["You can use ",(0,t.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,t.jsx)(n.code,{children:"chiselTypeOf"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["Use ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/VecInit$.html",children:(0,t.jsx)(n.code,{children:"VecInit"})})," given a ",(0,t.jsx)(n.code,{children:"Seq[Bool]"})," generated using the ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/UInt.html#asBools:Seq%5Bchisel3.Bool%5D",children:(0,t.jsx)(n.code,{children:"asBools"})})," method."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["Use the builtin function ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Vec.html#asUInt:chisel3.UInt",children:(0,t.jsx)(n.code,{children:"asUInt"})})]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["See the ",(0,t.jsx)(n.a,{href:"dataview#how-do-i-connect-a-subset-of-bundle-fields",children:"DataView cookbook"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"vectors-and-registers",children:"Vectors and Registers"}),"\n",(0,t.jsx)(n.h3,{id:"can-i-make-a-2d-or-3d-vector",children:"Can I make a 2D or 3D Vector?"}),"\n",(0,t.jsxs)(n.p,{children:["Yes. Using ",(0,t.jsx)(n.code,{children:"VecInit"})," you can make Vectors that hold Vectors of Chisel types. Methods ",(0,t.jsx)(n.code,{children:"fill"})," and ",(0,t.jsx)(n.code,{children:"tabulate"})," make these multi-dimensional Vectors."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h3,{id:"how-do-i-create-a-vector-of-registers",children:"How do I create a Vector of Registers?"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Rule!  Use Reg of Vec not Vec of Reg!"})}),"\n",(0,t.jsxs)(n.p,{children:["You create a ",(0,t.jsx)(n.a,{href:"#how-do-i-create-a-reg-of-type-vec",children:"Reg of type Vec"}),". Because Vecs are a ",(0,t.jsx)(n.em,{children:"type"})," (like ",(0,t.jsx)(n.code,{children:"UInt"}),", ",(0,t.jsx)(n.code,{children:"Bool"}),") rather than a ",(0,t.jsx)(n.em,{children:"value"}),", we must bind the Vec to some concrete ",(0,t.jsx)(n.em,{children:"value"}),"."]}),"\n",(0,t.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,t.jsxs)(n.p,{children:["For more information, the API Documentation for ",(0,t.jsx)(n.a,{href:"https://www.chisel-lang.org/api/latest/chisel3/Vec.html",children:(0,t.jsx)(n.code,{children:"Vec"})})," provides more information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h3,{id:"how-do-i-partially-reset-an-aggregate-reg",children:"How do I partially reset an Aggregate Reg?"}),"\n",(0,t.jsxs)(n.p,{children:["The easiest way is to use a partially-specified ",(0,t.jsx)(n.a,{href:"../appendix/experimental-features#bundle-literals",children:"Bundle Literal"}),"\nor ",(0,t.jsx)(n.a,{href:"../appendix/experimental-features#vec-literals",children:"Vec Literal"})," to match the type of the Reg."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsx)(n.code,{children:"DontCare"})," that\nyou do not wish to be reset."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h2,{id:"bundles",children:"Bundles"}),"\n",(0,t.jsx)(n.h3,{id:"how-do-i-deal-with-aliased-bundle-fields",children:"How do I deal with aliased Bundle fields?"}),"\n",(0,t.jsxs)(n.p,{children:["Following the ",(0,t.jsx)(n.code,{children:"gen"})," pattern when creating Bundles can result in some opaque error messages:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.pre,{children:(0,t.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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsxs)(n.p,{children:["This error is saying that fields ",(0,t.jsx)(n.code,{children:"foo"})," and ",(0,t.jsx)(n.code,{children:"bar"})," of ",(0,t.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,t.jsx)(n.code,{children:"foo"})," and ",(0,t.jsx)(n.code,{children:"bar"})," but cannot when they are referentially the same."]}),"\n",(0,t.jsx)(n.p,{children:"Note that the following example looks different but will give you exactly the same issue:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["By making ",(0,t.jsx)(n.code,{children:"gen"})," a ",(0,t.jsx)(n.code,{children:"val"}),", it becomes a public field of the ",(0,t.jsx)(n.code,{children:"class"}),", just like ",(0,t.jsx)(n.code,{children:"foo"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsx)(n.p,{children:"There are several ways to solve this issue with their own advantages and disadvantages."}),"\n",(0,t.jsx)(n.h4,{id:"1-0-arity-function-parameters",children:"1. 0-arity function parameters"}),"\n",(0,t.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,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Note that the type of ",(0,t.jsx)(n.code,{children:"gen"})," is now ",(0,t.jsx)(n.code,{children:"() => T"}),".\nBecause it is now a function and not a subtype of ",(0,t.jsx)(n.code,{children:"Data"}),", you can safely make ",(0,t.jsx)(n.code,{children:"gen"})," a ",(0,t.jsx)(n.code,{children:"val"})," without\nit becoming a hardware field of the ",(0,t.jsx)(n.code,{children:"Bundle"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Note that this also means you must pass ",(0,t.jsx)(n.code,{children:"gen"})," as a function, for example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"chisel3.docs.emitSystemVerilog(new Top(new UsingAFunctionBundle(() => UInt(8.W))))\n"})}),"\n",(0,t.jsx)(n.h5,{id:"aliased-warning",children:"Aliased Warning"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Warning"}),": you must ensure that ",(0,t.jsx)(n.code,{children:"gen"})," creates fresh objects rather than capturing an already constructed value:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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:893)\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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsxs)(n.p,{children:["In the above example, value ",(0,t.jsx)(n.code,{children:"fizz"})," and fields ",(0,t.jsx)(n.code,{children:"foo"})," and ",(0,t.jsx)(n.code,{children:"bar"})," of ",(0,t.jsx)(n.code,{children:"out"})," are all the same object in memory."]}),"\n",(0,t.jsx)(n.h4,{id:"2-by-name-function-parameters",children:"2. By-name function parameters"}),"\n",(0,t.jsxs)(n.p,{children:["Functionally the same as (1) but with more subtle syntax, you can use ",(0,t.jsx)(n.a,{href:"https://docs.scala-lang.org/tour/by-name-parameters.html",children:"Scala by-name function parameters"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["With this usage, you do not include ",(0,t.jsx)(n.code,{children:"() =>"})," when passing the argument:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"chisel3.docs.emitSystemVerilog(new Top(new UsingByNameParameters(UInt(8.W))))\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Note that as this is just syntactic sugar over (1), the ",(0,t.jsx)(n.a,{href:"#aliased-warning",children:"same warning applies"}),"."]}),"\n",(0,t.jsx)(n.h4,{id:"3-directioned-bundle-fields",children:"3. Directioned Bundle fields"}),"\n",(0,t.jsxs)(n.p,{children:["You can alternatively wrap the fields with ",(0,t.jsx)(n.code,{children:"Output(...)"}),", which creates fresh instances of the passed argument.\nChisel treats ",(0,t.jsx)(n.code,{children:"Output"}),' as the "default direction" so if all fields are outputs, the ',(0,t.jsx)(n.code,{children:"Bundle"})," is functionally equivalent to a ",(0,t.jsx)(n.code,{children:"Bundle"})," with no directioned fields."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsx)(n.code,{children:"Output"}),"."]}),"\n",(0,t.jsxs)(n.h4,{id:"4-call-clonetype-directly",children:["4. Call ",(0,t.jsx)(n.code,{children:".cloneType"})," directly"]}),"\n",(0,t.jsxs)(n.p,{children:["You can also just call ",(0,t.jsx)(n.code,{children:".cloneType"})," on your ",(0,t.jsx)(n.code,{children:"gen"})," argument directly.\nWhile we try to hide this implementation detail from the user, ",(0,t.jsx)(n.code,{children:".cloneType"})," is the mechanism by which Chisel creates fresh instances of ",(0,t.jsx)(n.code,{children:"Data"})," objects:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.h3,{id:"-how-do-i-deal-with-the-unable-to-clone-error",children:[(0,t.jsx)("a",{name:"bundle-unable-to-clone"}),' How do I deal with the "unable to clone" error?']}),"\n",(0,t.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,t.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,t.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,t.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,t.jsx)(n.code,{children:"chiselTypeClone"})," method\nin ",(0,t.jsx)(n.code,{children:"chisel3.reflect.DataMirror"}),". Here's an example with the Bundle whose fields\nwon't get cloned:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsxs)(n.p,{children:["You can use ",(0,t.jsx)(n.code,{children:"chiselTypeClone"})," to clone the elements as:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:["The advised way is to use ",(0,t.jsx)(n.code,{children:"ChiselEnum"})," to construct enumerated types representing the state of the FSM.\nState transitions are then handled with ",(0,t.jsx)(n.code,{children:"switch"}),"/",(0,t.jsx)(n.code,{children:"is"})," and ",(0,t.jsx)(n.code,{children:"when"}),"/",(0,t.jsx)(n.code,{children:".elsewhen"}),"/",(0,t.jsx)(n.code,{children:".otherwise"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Note: the ",(0,t.jsx)(n.code,{children:"is"})," statement can take multiple conditions e.g. ",(0,t.jsx)(n.code,{children:"is (sTwo1s, sOne1) { ... }"}),"."]}),"\n",(0,t.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,t.jsxs)(n.p,{children:["In Verilog, you can do something like the following which will unpack a the value ",(0,t.jsx)(n.code,{children:"z"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"The easiest way to accomplish this in Chisel would be:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["If you ",(0,t.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,t.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,t.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,t.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,t.jsx)(n.code,{children:"io.out(0)"})," is not allowed."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"If you try to compile this, you will get an error."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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.$anonfun$evaluate$2(ModuleImpl.scala:73)\n// \tat chisel3.internal.Builder$State$.guard(Builder.scala:1244)\n// \tat chisel3.ObjectModuleImpl.evaluate(ModuleImpl.scala:72)\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:59)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1063)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1053)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1045)\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,t.jsxs)(n.p,{children:["Chisel3 ",(0,t.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,t.jsx)(n.code,{children:"Bundle"})," or a ",(0,t.jsx)(n.code,{children:"Vec"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["If you must express it this way, one approach is to blast your ",(0,t.jsx)(n.code,{children:"UInt"})," to a ",(0,t.jsx)(n.code,{children:"Vec"})," of ",(0,t.jsx)(n.code,{children:"Bool"})," and back:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h2,{id:"how-do-i-create-an-optional-io",children:"How do I create an optional I/O?"}),"\n",(0,t.jsxs)(n.p,{children:["The following example is a module which includes the optional port ",(0,t.jsx)(n.code,{children:"out2"})," only if the given parameter is ",(0,t.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["The following is an example where an entire ",(0,t.jsx)(n.code,{children:"IO"})," is optional:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h2,{id:"how-do-i-create-io-without-a-prefix",children:"How do I create I/O without a prefix?"}),"\n",(0,t.jsxs)(n.p,{children:["In most cases, you can simply call ",(0,t.jsx)(n.code,{children:"IO"})," multiple times:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.jsxs)(n.p,{children:["If you have a ",(0,t.jsx)(n.code,{children:"Bundle"})," from which you would like to create ports without the\nnormal ",(0,t.jsx)(n.code,{children:"val"})," prefix, you can use ",(0,t.jsx)(n.code,{children:"FlatIO"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Note that ",(0,t.jsx)(n.code,{children:"io_"})," is nowhere to be seen!"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.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,t.jsxs)(n.p,{children:["To change the clock or reset for a region of code, use ",(0,t.jsx)(n.code,{children:"withClock"}),", ",(0,t.jsx)(n.code,{children:"withReset"}),", or ",(0,t.jsx)(n.code,{children:"withClockAndReset"}),".\nSee ",(0,t.jsx)(n.a,{href:"../explanations/multi-clock",children:"Multiple Clock Domains"})," for examples and details."]}),"\n",(0,t.jsxs)(n.p,{children:["To override the clock or reset for the entire scope of the ",(0,t.jsx)(n.code,{children:"Module"}),", you can mixin the ",(0,t.jsx)(n.code,{children:"ImplicitClock"})," and ",(0,t.jsx)(n.code,{children:"ImplicitReset"})," traits."]}),"\n",(0,t.jsx)(n.p,{children:'For example, you could "gate" the default implicit clock as follows:'}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"This gives the following Verilog:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.jsxs)(n.p,{children:["If you do not care about the name of the overriden clock, you can just assign it to ",(0,t.jsx)(n.code,{children:"val implicitClock"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"override protected val implicitClock = (clock.asBool || gate).asClock\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"ImplicitReset"})," works analogously to ",(0,t.jsx)(n.code,{children:"ImplicitClock"}),"."]}),"\n",(0,t.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,t.jsxs)(n.p,{children:["Use inferred width and a ",(0,t.jsx)(n.code,{children:"Seq"})," instead of a ",(0,t.jsx)(n.code,{children:"Vec"}),":"]}),"\n",(0,t.jsx)(n.p,{children:"Consider:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"Note that top modules or public modules cannot have unknown widths."}),"\n",(0,t.jsxs)(n.p,{children:["Unlike ",(0,t.jsx)(n.code,{children:"Vecs"})," which represent a singular Chisel type and must have the same width for every element,\n",(0,t.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,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.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,t.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,t.jsxs)(n.p,{children:["When the index does not have enough bits to address all entries or bits in the extractee, you can ",(0,t.jsx)(n.code,{children:".pad"})," the index to increase the width."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["This can be fixed with ",(0,t.jsx)(n.code,{children:"pad"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.p,{children:"This can be fixed with bit extraction:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Note that size 1 ",(0,t.jsx)(n.code,{children:"Vecs"})," and ",(0,t.jsx)(n.code,{children:"UInts"})," should be indexed by a zero-width ",(0,t.jsx)(n.code,{children:"UInt"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Because ",(0,t.jsx)(n.code,{children:"pad"})," only pads if the desired width is less than the current width of the argument,\nyou can use ",(0,t.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,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Another option for dynamic bit selection of ",(0,t.jsx)(n.code,{children:"UInts"})," (but not ",(0,t.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,t.jsx)(n.pre,{children:(0,t.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,t.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,t.jsxs)(n.p,{children:['Verilog has "case equality" (',(0,t.jsx)(n.code,{children:"==="}),") and inequality (",(0,t.jsx)(n.code,{children:"!=="}),") operators.\nThey are typically used to ignore unknown (",(0,t.jsx)(n.code,{children:"X"}),") values in assertions."]}),"\n",(0,t.jsxs)(n.p,{children:["Chisel does not support Verilog ",(0,t.jsx)(n.code,{children:"X"})," directly, but it is possible to check if a value is ",(0,t.jsx)(n.code,{children:"X"})," with ",(0,t.jsx)(n.code,{children:"chisel3.util.circt.isX"}),".\n",(0,t.jsx)(n.code,{children:"isX"})," is commonly used to guard assertions against ",(0,t.jsx)(n.code,{children:"X"})," which gives similar behavior to Verilog case equality."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.h2,{id:"predictable-naming",children:"Predictable Naming"}),"\n",(0,t.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,t.jsxs)(n.p,{children:["Use the compiler plugin, and check out the ",(0,t.jsx)(n.a,{href:"naming",children:"Naming Cookbook"})," if that still does not do what you want."]}),"\n",(0,t.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,t.jsx)(n.p,{children:"Currently, name information is lost when using dynamic indexing. For example:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["The above code loses the ",(0,t.jsx)(n.code,{children:"x"})," name, instead using ",(0,t.jsx)(n.code,{children:"_GEN_3"})," (the other ",(0,t.jsx)(n.code,{children:"_GEN_*"})," signals are expected)."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.jsx)(n.p,{children:"This can be worked around by creating a wire and connecting the dynamic index to the wire:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"val x = WireInit(io.in(io.idx))\n"})}),"\n",(0,t.jsx)(n.p,{children:"Which produces:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.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,t.jsxs)(n.p,{children:["You can override the ",(0,t.jsx)(n.code,{children:"desiredName"})," function. This works with normal Chisel modules and ",(0,t.jsx)(n.code,{children:"BlackBox"}),"es. Example:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["Elaborating the Chisel module ",(0,t.jsx)(n.code,{children:"Salt"}),' yields our "desired names" for ',(0,t.jsx)(n.code,{children:"Salt"})," and ",(0,t.jsx)(n.code,{children:"Coffee"})," in the output Verilog:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.107.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,t.jsx)(n.h2,{id:"directionality",children:"Directionality"}),"\n",(0,t.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,t.jsxs)(n.p,{children:["Given a bidirectional port like a ",(0,t.jsx)(n.code,{children:"Decoupled"}),", you will get an error if you try to connect it directly\nto a register:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"getVerilogString(new BadRegConnect)\n// circt.stage.phases.Exceptions$FirtoolNonZeroExitCode: /home/runner/.cache/llvm-firtool/1.107.0/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+484-327305d9-SNAPSHOT) was published against firtool version 1.107.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,t.jsxs)(n.p,{children:['While there is no construct to "strip direction" in Chisel3, wrapping a type in ',(0,t.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,t.jsx)(n.pre,{children:(0,t.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,l.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>s});var t=a(6540);const l={},o=t.createContext(l);function i(e){const n=t.useContext(o);return t.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:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/868241d3.2ae71a2a.js b/assets/js/868241d3.2ae71a2a.js
new file mode 100644
index 0000000000..180d875362
--- /dev/null
+++ b/assets/js/868241d3.2ae71a2a.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:()=>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+484-327305d9-SNAPSHOT/chisel_2.13-7.0.0-M2+484-327305d9-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/868241d3.6b987a98.js b/assets/js/868241d3.6b987a98.js
deleted file mode 100644
index d648480262..0000000000
--- a/assets/js/868241d3.6b987a98.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 c=s(4848),t=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,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+483-d6552d4c-SNAPSHOT/chisel_2.13-7.0.0-M2+483-d6552d4c-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:()=>l,x:()=>a});var c=s(6540);const t={},i=c.createContext(t);function l(e){const n=c.useContext(i);return c.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(t):e.components||t:l(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/98ca0ee0.57f10c8f.js b/assets/js/98ca0ee0.ad77b002.js
similarity index 95%
rename from assets/js/98ca0ee0.57f10c8f.js
rename to assets/js/98ca0ee0.ad77b002.js
index f9dc776613..64414a39eb 100644
--- a/assets/js/98ca0ee0.57f10c8f.js
+++ b/assets/js/98ca0ee0.ad77b002.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[8946,9017],{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+483-d6552d4c-SNAPSHOT/chisel_2.13-7.0.0-M2+483-d6552d4c-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)}},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)}},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],{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+484-327305d9-SNAPSHOT/chisel_2.13-7.0.0-M2+484-327305d9-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)}},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)}},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/runtime~main.8eeb4ee2.js b/assets/js/runtime~main.47e25e89.js
similarity index 75%
rename from assets/js/runtime~main.8eeb4ee2.js
rename to assets/js/runtime~main.47e25e89.js
index f0d6edab5f..418e9b98ae 100644
--- a/assets/js/runtime~main.8eeb4ee2.js
+++ b/assets/js/runtime~main.47e25e89.js
@@ -1 +1 @@
-(()=>{"use strict";var e,a,c,d,b,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={exports:{}};return f[e].call(c.exports,c,c.exports,r),c.exports}r.m=f,e=[],r.O=(a,c,d,b)=>{if(!c){var f=1/0;for(i=0;i<e.length;i++){c=e[i][0],d=e[i][1],b=e[i][2];for(var t=!0,o=0;o<c.length;o++)(!1&b||f>=b)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,b<f&&(f=b));if(t){e.splice(i--,1);var n=d();void 0!==n&&(a=n)}}return a}b=b||0;for(var i=e.length;i>0&&e[i-1][2]>b;i--)e[i]=e[i-1];e[i]=[c,d,b]},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 b=Object.create(null);r.r(b);var f={};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=>f[a]=()=>e[a]));return f.default=()=>e,r.d(b,f),b},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:"8c5503c3",849:"272726e6",867:"85f39b80",957:"0fd76349",1108:"c5d79c51",1188:"a44ac642",1235:"e788d507",1281:"5a54c82b",1384:"32f7cc71",1596:"d359a0d4",1903:"302c9b19",1921:"8e7dc586",2012:"11c7409d",2138:"bec5bc75",2237:"303ade5b",2289:"79c17662",2504:"4482812e",2579:"8000e271",2634:"a295c587",2711:"dc6a2cc3",2785:"7d4d4a76",3117:"e2bc5842",3126:"078c4c6f",3130:"4c52d26f",3249:"c2c02add",3259:"c0c1359f",3291:"850cf5b5",3313:"8876e937",3316:"346c06b5",3347:"f14d4ef9",3361:"304b9e45",3460:"83c44bf7",3543:"ef9fba8c",3599:"70c8f729",4020:"42b22afe",4166:"471b0999",4212:"fbb7780b",4286:"0b48b87d",4315:"387bd3d0",4813:"e3ab515c",4825:"a73dbf93",4863:"7995f8de",5056:"50814aef",5432:"3b5afade",5497:"e5c27643",5522:"957872b5",5540:"cc8714f3",5583:"734da6e2",5666:"f0806194",5742:"23cb5882",6027:"668cd119",6061:"0d329ebe",6067:"298dd3a2",6304:"ba64159f",6403:"928559fc",6474:"ee1792a0",6760:"b9d97434",6803:"6b3858e5",6891:"099dad7c",6969:"5152d3f6",6991:"daff21ef",7087:"2844b440",7098:"2786cce5",7132:"bfa04e04",7315:"ff2084cf",7425:"208ef3d8",7437:"9654a22f",7461:"8b934903",7472:"a50bf01b",7643:"48e7a38c",8042:"98d3a87c",8118:"e80dab3d",8121:"95beead3",8130:"9c784d80",8140:"82e77c1c",8146:"d012537c",8158:"887a29fb",8209:"aa209370",8227:"c6729e12",8316:"cbd30989",8401:"7f78e67d",8485:"6fc895ce",8498:"9e945fa4",8507:"81fc2d29",8864:"6b30aa7d",8913:"eae5cfc0",8946:"57f10c8f",8947:"0dbbe99e",9017:"6b987a98",9048:"b67ea9de",9128:"ec532c62",9387:"f1c35766",9482:"f363bdb2",9647:"6f38f138",9670:"417ea86d",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={},b="chisel-lang:",r.l=(e,a,c,f)=>{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")==b+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",b+c),t.src=e),d[e]=[a];var u=(a,c)=>{t.onerror=t.onload=null,clearTimeout(s);var b=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),b&&b.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 b=new Promise(((c,b)=>d=e[a]=[c,b]));c.push(d[2]=b);var f=r.p+r.u(a),t=new Error;r.l(f,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var b=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+b+": "+f+")",t.name="ChunkLoadError",t.type=b,t.request=f,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,b,f=c[0],t=c[1],o=c[2],n=0;if(f.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<f.length;n++)b=f[n],r.o(e,b)&&e[b]&&e[b][0](),e[b]=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:"8c5503c3",849:"272726e6",867:"85f39b80",957:"0fd76349",1108:"c5d79c51",1188:"a44ac642",1235:"e788d507",1281:"5a54c82b",1384:"32f7cc71",1596:"d359a0d4",1903:"302c9b19",1921:"8e7dc586",2012:"11c7409d",2138:"bec5bc75",2237:"303ade5b",2289:"79c17662",2504:"4482812e",2579:"8000e271",2634:"a295c587",2711:"dc6a2cc3",2785:"ae3bf0cd",3117:"e2bc5842",3126:"078c4c6f",3130:"4c52d26f",3249:"c2c02add",3259:"c0c1359f",3291:"850cf5b5",3313:"8876e937",3316:"346c06b5",3347:"f14d4ef9",3361:"304b9e45",3460:"83c44bf7",3543:"ef9fba8c",3599:"70c8f729",4020:"42b22afe",4166:"471b0999",4212:"fbb7780b",4286:"0b48b87d",4315:"387bd3d0",4813:"e3ab515c",4825:"a73dbf93",4863:"7995f8de",5056:"50814aef",5432:"b989098b",5497:"e5c27643",5522:"957872b5",5540:"cc8714f3",5583:"734da6e2",5666:"f0806194",5742:"23cb5882",6027:"668cd119",6061:"0d329ebe",6067:"298dd3a2",6304:"ba64159f",6403:"928559fc",6474:"ee1792a0",6760:"b9d97434",6803:"6b3858e5",6891:"099dad7c",6969:"5152d3f6",6991:"daff21ef",7087:"2844b440",7098:"2786cce5",7132:"bfa04e04",7315:"ff2084cf",7425:"208ef3d8",7437:"9654a22f",7461:"8b934903",7472:"a50bf01b",7643:"48e7a38c",8042:"98d3a87c",8118:"e80dab3d",8121:"95beead3",8130:"9c784d80",8140:"82e77c1c",8146:"d012537c",8158:"887a29fb",8209:"aa209370",8227:"c6729e12",8316:"cbd30989",8401:"7f78e67d",8485:"6fc895ce",8498:"9e945fa4",8507:"81fc2d29",8864:"6b30aa7d",8913:"eae5cfc0",8946:"ad77b002",8947:"0dbbe99e",9017:"2ae71a2a",9048:"b67ea9de",9128:"ec532c62",9387:"f1c35766",9482:"f363bdb2",9647:"6f38f138",9670:"417ea86d",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 3d1c3bbcda..4a7421d106 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/archive.html b/blog/archive.html
index 0df6b99883..4e48982d74 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/authors.html b/blog/authors.html
index aa2da5cec2..4702db3249 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/authors/seldridge.html b/blog/authors/seldridge.html
index 6e33f7f4b1..b0bfd34f23 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 52326afd76..daefcedc9a 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/tags.html b/blog/tags.html
index 580c23e39b..54b5a59795 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/blog/tags/miscellaneous.html b/blog/tags/miscellaneous.html
index 5a36c7e370..4606871c29 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/community.html b/community.html
index 88cab675f4..2911d8c619 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs.html b/docs.html
index cc20c3ee03..55e74badb5 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix.html b/docs/appendix.html
index cf0d0b5edb..9f12848f90 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 0f5139e9e7..af4dca6599 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix/migrating-from-chiseltest.html b/docs/appendix/migrating-from-chiseltest.html
index 22ca35b8e6..ba290c781c 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 74ad79537c..3fa1d19c33 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 7c90e98733..751428fd59 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix/versioning.html b/docs/appendix/versioning.html
index bfef10d3fe..59757452b9 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 cd748705f5..157ad51b78 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks.html b/docs/cookbooks.html
index 820ce867bd..1d2fcb135e 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/cookbook.html b/docs/cookbooks/cookbook.html
index ca83671a07..0297e63cd0 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -220,7 +220,7 @@ <h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-strip-directions-fro
 <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.107.0/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+483-d6552d4c-SNAPSHOT) was published against firtool version 1.107.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>
+<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.107.0/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+484-327305d9-SNAPSHOT) was published against firtool version 1.107.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 03c0e29ab2..088f9d3002 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/hierarchy.html b/docs/cookbooks/hierarchy.html
index 0bcb089246..90a5f30f45 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/naming.html b/docs/cookbooks/naming.html
index 1b9154ed06..67e73d2ea5 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/objectmodel.html b/docs/cookbooks/objectmodel.html
index 9512ba4152..a087173b92 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/serialization.html b/docs/cookbooks/serialization.html
index 0eb86c584d..b968f7c3cb 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/troubleshooting.html b/docs/cookbooks/troubleshooting.html
index 69c81dc2aa..fa8340fb24 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers.html b/docs/developers.html
index da458cb7e9..c6463cf7da 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 ffb6c28bba..f6e6051e47 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers/scaladoc.html b/docs/developers/scaladoc.html
index 65b5b599dc..ba3a2961e9 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers/style.html b/docs/developers/style.html
index ac3bed0509..784b838060 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 4ec1725bf9..888fd060c1 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations.html b/docs/explanations.html
index 57bdd3ca59..5f66b69a91 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/annotations.html b/docs/explanations/annotations.html
index a15dcb99b4..af21a616b9 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/blackboxes.html b/docs/explanations/blackboxes.html
index 34e62ec0de..763d554edd 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 8bcf2e7384..5c4ef68b45 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/chisel-enum.html b/docs/explanations/chisel-enum.html
index 046fa3e180..018866401c 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/chisel-type-vs-scala-type.html b/docs/explanations/chisel-type-vs-scala-type.html
index 797de21d9d..636dc2b566 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -65,7 +65,7 @@ <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 @8ecfa11)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:72)</span><span class="token plain"></span><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:317)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:893)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:304)</span><span class="token plain"></span><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:304)</span><span class="token plain"></span><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.$anonfun$evaluate$2(ModuleImpl.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.internal.Builder$State$.guard(Builder.scala:1244)</span><span class="token plain"></span><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:72)</span><span class="token plain"></span><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: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$.$anonfun$buildImpl$1(Builder.scala:1063)</span><span class="token plain"></span><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:1053)</span><span class="token plain"></span><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:1045)</span><span class="token plain"></span><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 @712aaf3c)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:72)</span><span class="token plain"></span><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:317)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:893)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:288)</span><span class="token plain"></span><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:304)</span><span class="token plain"></span><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:304)</span><span class="token plain"></span><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.$anonfun$evaluate$2(ModuleImpl.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.internal.Builder$State$.guard(Builder.scala:1244)</span><span class="token plain"></span><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:72)</span><span class="token plain"></span><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: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$.$anonfun$buildImpl$1(Builder.scala:1063)</span><span class="token plain"></span><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:1053)</span><span class="token plain"></span><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:1045)</span><span class="token plain"></span><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
diff --git a/docs/explanations/combinational-circuits.html b/docs/explanations/combinational-circuits.html
index a34518fa79..b67eeba47a 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/connectable.html b/docs/explanations/connectable.html
index f90bfb8fed..836f92d6a8 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/connection-operators.html b/docs/explanations/connection-operators.html
index ab81a13115..11ed162228 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/data-types.html b/docs/explanations/data-types.html
index 37677418d8..045d5e082c 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/dataview.html b/docs/explanations/dataview.html
index 1bea31c38b..44994f781d 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/decoder.html b/docs/explanations/decoder.html
index 5b182bd584..975495b75c 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 1e8295eb96..ad5634bc12 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 007b13aeea..190cbc5f5c 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/instchoice.html b/docs/explanations/instchoice.html
index df42eadd3a..6c19084188 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 0ca09da935..d7a82edece 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/intrinsics.html b/docs/explanations/intrinsics.html
index 8fd6d5f092..0c37b3380e 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/layers.html b/docs/explanations/layers.html
index f996900591..71fd555b36 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/memories.html b/docs/explanations/memories.html
index 32a8e1e406..b4ef0c0934 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/moduleprefix.html b/docs/explanations/moduleprefix.html
index f9ae7eaf20..1ae8a7d721 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/modules.html b/docs/explanations/modules.html
index 9726d366c0..bb651aa658 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/motivation.html b/docs/explanations/motivation.html
index f119356359..875a414747 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 cce1f89bcc..a36b48ae10 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 c829ad431f..48676b9c2c 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/naming.html b/docs/explanations/naming.html
index f24368c290..118b726218 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/operators.html b/docs/explanations/operators.html
index cf2773bbe5..c24734831c 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 5f6e5b5e58..857686cf08 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/ports.html b/docs/explanations/ports.html
index 658bbff152..b83f1c3793 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/printing.html b/docs/explanations/printing.html
index 550e83c10b..760e82a068 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/properties.html b/docs/explanations/properties.html
index 6014158711..c588f45a2f 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/reset.html b/docs/explanations/reset.html
index 81606404e6..5c4c11f857 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 56c6b6fe63..d66f1ea6c6 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 9636d89a65..a6165c2929 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 1317462279..969146b5f4 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 4dae145677..87fd874961 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/warnings.html b/docs/explanations/warnings.html
index 6309cfd20e..23947a77a4 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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 720d5761ae..90dc7730de 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/installation.html b/docs/installation.html
index 341bb511c6..d127e830be 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/resources.html b/docs/resources.html
index 2b005a4db7..4d0a33f92e 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/resources/faqs.html b/docs/resources/faqs.html
index 825058ffb4..4b2a20eeaf 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/generated/contributors.html b/generated/contributors.html
index 15dacbd8e0..6e341bd617 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/generated/scaladoc_links.html b/generated/scaladoc_links.html
index 2ad425c7bc..eac45344f9 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.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+483-d6552d4c-SNAPSHOT/chisel_2.13-7.0.0-M2+483-d6552d4c-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+484-327305d9-SNAPSHOT/chisel_2.13-7.0.0-M2+484-327305d9-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 c1735ccc2c..835470b8dc 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/releases/snapshot/download/chisel-example.scala b/releases/snapshot/download/chisel-example.scala
index ec6e3abb4f..fa28f9369a 100644
--- a/releases/snapshot/download/chisel-example.scala
+++ b/releases/snapshot/download/chisel-example.scala
@@ -1,7 +1,7 @@
 //> using repository "sonatype-s01:snapshots"
 //> using scala "2.13.15"
-//> using dep "org.chipsalliance::chisel:7.0.0-M2+483-d6552d4c-SNAPSHOT"
-//> using plugin "org.chipsalliance:::chisel-plugin:7.0.0-M2+483-d6552d4c-SNAPSHOT"
+//> using dep "org.chipsalliance::chisel:7.0.0-M2+484-327305d9-SNAPSHOT"
+//> using plugin "org.chipsalliance:::chisel-plugin:7.0.0-M2+484-327305d9-SNAPSHOT"
 //> using options "-unchecked", "-deprecation", "-language:reflectiveCalls", "-feature", "-Xcheckinit", "-Xfatal-warnings", "-Ywarn-dead-code", "-Ywarn-unused", "-Ymacro-annotations"
 
 import chisel3._
diff --git a/search.html b/search.html
index 7cf99b7285..da7ad7ffdc 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.96e3454e.css">
-<script src="/assets/js/runtime~main.8eeb4ee2.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.47e25e89.js" defer="defer"></script>
 <script src="/assets/js/main.d1e3e899.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
