From e345d42960b23c768a7f29e59e9fd0f950ca2026 Mon Sep 17 00:00:00 2001
From: jackkoenig <jackkoenig@users.noreply.github.com>
Date: Mon, 22 Jul 2024 18:19:01 +0000
Subject: [PATCH] deploy: 68aec539ac2d9a6b6ec8b6f76f5db88cd7b99217

---
 404.html                                                      | 2 +-
 api.html                                                      | 4 ++--
 api/chisel3/latest.html                                       | 2 +-
 assets/js/{1ce89024.08956ad2.js => 1ce89024.335f922c.js}      | 2 +-
 assets/js/{7b5bfa87.2c05436e.js => 7b5bfa87.82a0116c.js}      | 2 +-
 assets/js/{7e1e4a75.9b2321cf.js => 7e1e4a75.1897c8b8.js}      | 2 +-
 assets/js/868241d3.79baa747.js                                | 1 +
 assets/js/868241d3.7d913b71.js                                | 1 -
 assets/js/{98ca0ee0.58acb062.js => 98ca0ee0.0cde3570.js}      | 2 +-
 .../js/{runtime~main.c232c68c.js => runtime~main.839beab8.js} | 2 +-
 community.html                                                | 2 +-
 docs.html                                                     | 2 +-
 docs/appendix.html                                            | 2 +-
 docs/appendix/experimental-features.html                      | 2 +-
 docs/appendix/migrating-from-chiseltest.html                  | 2 +-
 docs/appendix/upgrading-from-chisel-3-4.html                  | 2 +-
 docs/appendix/upgrading-from-scala-2-11.html                  | 2 +-
 docs/appendix/versioning.html                                 | 2 +-
 docs/category/getting-started.html                            | 2 +-
 docs/cookbooks.html                                           | 2 +-
 docs/cookbooks/cookbook.html                                  | 4 ++--
 docs/cookbooks/dataview.html                                  | 2 +-
 docs/cookbooks/hierarchy.html                                 | 4 ++--
 docs/cookbooks/naming.html                                    | 2 +-
 docs/cookbooks/serialization.html                             | 2 +-
 docs/cookbooks/troubleshooting.html                           | 2 +-
 docs/developers.html                                          | 2 +-
 docs/developers/scaladoc.html                                 | 2 +-
 docs/developers/style.html                                    | 2 +-
 docs/developers/test-coverage.html                            | 2 +-
 docs/explanations.html                                        | 2 +-
 docs/explanations/annotations.html                            | 2 +-
 docs/explanations/blackboxes.html                             | 2 +-
 docs/explanations/bundles-and-vecs.html                       | 2 +-
 docs/explanations/chisel-enum.html                            | 2 +-
 docs/explanations/chisel-type-vs-scala-type.html              | 4 ++--
 docs/explanations/combinational-circuits.html                 | 2 +-
 docs/explanations/connectable.html                            | 2 +-
 docs/explanations/connection-operators.html                   | 2 +-
 docs/explanations/data-types.html                             | 2 +-
 docs/explanations/dataview.html                               | 2 +-
 docs/explanations/decoder.html                                | 2 +-
 docs/explanations/functional-abstraction.html                 | 2 +-
 docs/explanations/functional-module-creation.html             | 2 +-
 docs/explanations/instchoice.html                             | 2 +-
 docs/explanations/interfaces-and-connections.html             | 2 +-
 docs/explanations/intrinsics.html                             | 2 +-
 docs/explanations/layers.html                                 | 2 +-
 docs/explanations/memories.html                               | 2 +-
 docs/explanations/modules.html                                | 2 +-
 docs/explanations/motivation.html                             | 2 +-
 docs/explanations/multi-clock.html                            | 2 +-
 docs/explanations/muxes-and-input-selection.html              | 2 +-
 docs/explanations/naming.html                                 | 2 +-
 docs/explanations/operators.html                              | 2 +-
 docs/explanations/polymorphism-and-parameterization.html      | 2 +-
 docs/explanations/ports.html                                  | 2 +-
 docs/explanations/printing.html                               | 2 +-
 docs/explanations/properties.html                             | 2 +-
 docs/explanations/reset.html                                  | 2 +-
 docs/explanations/sequential-circuits.html                    | 2 +-
 docs/explanations/source-locators.html                        | 2 +-
 docs/explanations/supported-hardware.html                     | 2 +-
 docs/explanations/unconnected-wires.html                      | 2 +-
 docs/explanations/warnings.html                               | 2 +-
 docs/explanations/width-inference.html                        | 2 +-
 docs/installation.html                                        | 2 +-
 docs/resources.html                                           | 2 +-
 docs/resources/faqs.html                                      | 2 +-
 generated/contributors.html                                   | 2 +-
 generated/scaladoc_links.html                                 | 4 ++--
 index.html                                                    | 2 +-
 search.html                                                   | 2 +-
 73 files changed, 77 insertions(+), 77 deletions(-)
 rename assets/js/{1ce89024.08956ad2.js => 1ce89024.335f922c.js} (98%)
 rename assets/js/{7b5bfa87.2c05436e.js => 7b5bfa87.82a0116c.js} (84%)
 rename assets/js/{7e1e4a75.9b2321cf.js => 7e1e4a75.1897c8b8.js} (91%)
 create mode 100644 assets/js/868241d3.79baa747.js
 delete mode 100644 assets/js/868241d3.7d913b71.js
 rename assets/js/{98ca0ee0.58acb062.js => 98ca0ee0.0cde3570.js} (57%)
 rename assets/js/{runtime~main.c232c68c.js => runtime~main.839beab8.js} (93%)

diff --git a/404.html b/404.html
index 46bd4234c79..4e0180b9480 100644
--- a/404.html
+++ b/404.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Page Not Found | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | Chisel"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/404.html"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/404.html" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/api.html b/api.html
index e126b2fa08d..2e2563aff65 100644
--- a/api.html
+++ b/api.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">API Docs | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/api"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="API Docs | Chisel"><meta data-rh="true" name="description" content="Chisel API Documentation"><meta data-rh="true" property="og:description" content="Chisel API Documentation"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/api"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/api" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/api" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -12,7 +12,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.5.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+9-7bf8b596-SNAPSHOT/chisel_2.13-7.0.0-M2+9-7bf8b596-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+10-68aec539-SNAPSHOT/chisel_2.13-7.0.0-M2+10-68aec539-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.5.0" target="_blank" rel="noopener noreferrer">6.5.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 ba7cb9aa1cb..5b96216e7a2 100644
--- a/api/chisel3/latest.html
+++ b/api/chisel3/latest.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Chisel</title><meta data-rh="true" property="og:title" content="Chisel"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/api/chisel3/latest"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/api/chisel3/latest"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/api/chisel3/latest" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/api/chisel3/latest" hreflang="x-default"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/assets/js/1ce89024.08956ad2.js b/assets/js/1ce89024.335f922c.js
similarity index 98%
rename from assets/js/1ce89024.08956ad2.js
rename to assets/js/1ce89024.335f922c.js
index 39538a5864e..dfb051913a7 100644
--- a/assets/js/1ce89024.08956ad2.js
+++ b/assets/js/1ce89024.335f922c.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[741],{4008:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>r});var t=i(4848),o=i(8453),a=i(1871);const s={sidebar_position:2},l="Hierarchy Cookbook",c={id:"cookbooks/hierarchy",title:"Hierarchy Cookbook",description:"How do I instantiate multiple instances with the same module parameterization?",source:"@site/docs/cookbooks/hierarchy.md",sourceDirName:"cookbooks",slug:"/cookbooks/hierarchy",permalink:"/docs/cookbooks/hierarchy",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/hierarchy.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"chiselSidebar",previous:{title:"Naming Cookbook",permalink:"/docs/cookbooks/naming"},next:{title:"DataView Cookbook",permalink:"/docs/cookbooks/dataview"}},d={},r=[{value:"How do I instantiate multiple instances with the same module parameterization?",id:"how-do-i-instantiate-multiple-instances-with-the-same-module-parameterization",level:2},{value:"Using Definition and Instance",id:"using-definition-and-instance",level:3},{value:"Using Instantiate",id:"using-instantiate",level:3},{value:"How do I access internal fields of an instance?",id:"how-do-i-access-internal-fields-of-an-instance",level:2},{value:"How do I make my parameters accessible from an instance?",id:"how-do-i-make-my-parameters-accessible-from-an-instance",level:2},{value:"How do I look up parameters from a Definition, if I don&#39;t want to instantiate it?",id:"how-do-i-look-up-parameters-from-a-definition-if-i-dont-want-to-instantiate-it",level:2},{value:"How do I parameterize a module by its children instances?",id:"how-do-i-parameterize-a-module-by-its-children-instances",level:2},{value:"How do I use the new hierarchy-specific Select functions?",id:"how-do-i-use-the-new-hierarchy-specific-select-functions",level:2}];function h(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"hierarchy-cookbook",children:"Hierarchy Cookbook"}),"\n","\n","\n",(0,t.jsx)(a.A,{toc:r}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-instantiate-multiple-instances-with-the-same-module-parameterization",children:"How do I instantiate multiple instances with the same module parameterization?"}),"\n",(0,t.jsx)(n.p,{children:'Prior to this package, Chisel users relied on deduplication in a FIRRTL compiler to combine\nstructurally equivalent modules into one module (aka "deduplication").\nThis package introduces the following new APIs to enable multiply-instantiated modules directly in Chisel.'}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Definition(...)"})," enables elaborating a module, but does not actually instantiate that module.\nInstead, it returns a ",(0,t.jsx)(n.code,{children:"Definition"})," class which represents that module's definition."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Instance(...)"})," takes a ",(0,t.jsx)(n.code,{children:"Definition"})," and instantiates it, returning an ",(0,t.jsx)(n.code,{children:"Instance"})," object."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Instantiate(...)"})," provides an API similar to ",(0,t.jsx)(n.code,{children:"Module(...)"}),", except it uses\n",(0,t.jsx)(n.code,{children:"Definition"})," and ",(0,t.jsx)(n.code,{children:"Instance"})," to only elaborate modules once for a given set of\nparameters. It returns an ",(0,t.jsx)(n.code,{children:"Instance"})," object."]}),"\n",(0,t.jsxs)(n.p,{children:["Modules (classes or traits) which will be used with the ",(0,t.jsx)(n.code,{children:"Definition"}),"/",(0,t.jsx)(n.code,{children:"Instance"})," api should be marked\nwith the ",(0,t.jsx)(n.code,{children:"@instantiable"})," annotation at the class/trait definition."]}),"\n",(0,t.jsxs)(n.p,{children:["To make a Module's members variables accessible from an ",(0,t.jsx)(n.code,{children:"Instance"})," object, they must be annotated\nwith the ",(0,t.jsx)(n.code,{children:"@public"})," annotation. Note that this is only accessible from a Scala sense\u2014this is not\nin and of itself a mechanism for cross-module references."]}),"\n",(0,t.jsx)(n.h3,{id:"using-definition-and-instance",children:"Using Definition and Instance"}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, use ",(0,t.jsx)(n.code,{children:"Definition"}),", ",(0,t.jsx)(n.code,{children:"Instance"}),", ",(0,t.jsx)(n.code,{children:"@instantiable"})," and ",(0,t.jsx)(n.code,{children:"@public"})," to create\nmultiple instances of one specific parameterization of a module, ",(0,t.jsx)(n.code,{children:"AddOne"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass AddOne(width: Int) extends Module {\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass AddTwo(width: Int) extends Module {\n  val in  = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt(width.W)))\n  val addOneDef = Definition(new AddOne(width))\n  val i0 = Instance(addOneDef)\n  val i1 = Instance(addOneDef)\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.78.1\nmodule AddOne(\t// hierarchy.md:14:2\n  input  [9:0] in,\t// hierarchy.md:16:23\n  output [9:0] out\t// hierarchy.md:17:23\n);\n\n  assign out = in + 10'h1;\t// hierarchy.md:14:2, :18:13\nendmodule\n\nmodule AddTwo(\t// hierarchy.md:22:7\n  input        clock,\t// hierarchy.md:22:7\n               reset,\t// hierarchy.md:22:7\n  input  [9:0] in,\t// hierarchy.md:23:15\n  output [9:0] out\t// hierarchy.md:24:15\n);\n\n  wire [9:0] _i0_out;\t// hierarchy.md:26:20\n  AddOne i0 (\t// hierarchy.md:26:20\n    .in  (in),\n    .out (_i0_out)\n  );\t// hierarchy.md:26:20\n  AddOne i1 (\t// hierarchy.md:27:20\n    .in  (_i0_out),\t// hierarchy.md:26:20\n    .out (out)\n  );\t// hierarchy.md:27:20\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"using-instantiate",children:"Using Instantiate"}),"\n",(0,t.jsxs)(n.p,{children:["Similar to the above, the following example uses ",(0,t.jsx)(n.code,{children:"Instantiate"})," to create\nmultiple instances of ",(0,t.jsx)(n.code,{children:"AddOne"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.hierarchy.Instantiate\n\nclass AddTwoInstantiate(width: Int) extends Module {\n  val in  = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt(width.W)))\n  val i0 = Instantiate(new AddOne(width))\n  val i1 = Instantiate(new AddOne(width))\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.78.1\nmodule AddOne(\t// hierarchy.md:14:2\n  input  [15:0] in,\t// hierarchy.md:16:23\n  output [15:0] out\t// hierarchy.md:17:23\n);\n\n  assign out = in + 16'h1;\t// hierarchy.md:14:2, :18:13\nendmodule\n\nmodule AddTwoInstantiate(\t// hierarchy.md:46:7\n  input         clock,\t// hierarchy.md:46:7\n                reset,\t// hierarchy.md:46:7\n  input  [15:0] in,\t// hierarchy.md:47:15\n  output [15:0] out\t// hierarchy.md:48:15\n);\n\n  wire [15:0] _i0_out;\t// hierarchy.md:49:23\n  AddOne i0 (\t// hierarchy.md:49:23\n    .in  (in),\n    .out (_i0_out)\n  );\t// hierarchy.md:49:23\n  AddOne i1 (\t// hierarchy.md:50:23\n    .in  (_i0_out),\t// hierarchy.md:49:23\n    .out (out)\n  );\t// hierarchy.md:50:23\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-access-internal-fields-of-an-instance",children:"How do I access internal fields of an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["You can mark internal members of a class or trait marked with ",(0,t.jsx)(n.code,{children:"@instantiable"})," with the ",(0,t.jsx)(n.code,{children:"@public"})," annotation.\nThe requirements are that the field is publicly accessible, is a ",(0,t.jsx)(n.code,{children:"val"})," or ",(0,t.jsx)(n.code,{children:"lazy val"}),", and is a valid type.\nThe list of valid types are:"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"IsInstantiable"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"IsLookupable"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"Data"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"BaseModule"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Iterable"}),"/",(0,t.jsx)(n.code,{children:"Option "}),"containing a type that meets these requirements"]}),"\n",(0,t.jsxs)(n.li,{children:["Basic type like ",(0,t.jsx)(n.code,{children:"String"}),", ",(0,t.jsx)(n.code,{children:"Int"}),", ",(0,t.jsx)(n.code,{children:"BigInt"})," etc."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["To mark a superclass's member as ",(0,t.jsx)(n.code,{children:"@public"}),", use the following pattern (shown with ",(0,t.jsx)(n.code,{children:"val clock"}),")."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{instantiable, public}\n\n@instantiable\nclass MyModule extends Module {\n  @public val clock = clock\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["You'll get the following error message for improperly marking something as ",(0,t.jsx)(n.code,{children:"@public"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{instantiable, public}\n\nobject NotValidType\n\n@instantiable\nclass MyModule extends Module {\n  @public val x = NotValidType\n}\n// error: @public is only legal within a class or trait marked @instantiable, and only on vals of type Data, BaseModule, MemBase, IsInstantiable, IsLookupable, or Instance[_], or in an Iterable, Option, Either, or Tuple2\n// val x = circt.stage.ChiselStage.emitCHIRRTL(new Top)\n//     ^\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-my-parameters-accessible-from-an-instance",children:"How do I make my parameters accessible from an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["If an instance's parameters are simple (e.g. ",(0,t.jsx)(n.code,{children:"Int"}),", ",(0,t.jsx)(n.code,{children:"String"})," etc.) they can be marked directly with ",(0,t.jsx)(n.code,{children:"@public"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Often, parameters are more complicated and are contained in case classes.\nIn such cases, mark the case class with the ",(0,t.jsx)(n.code,{children:"IsLookupable"})," trait.\nThis indicates to Chisel that instances of the ",(0,t.jsx)(n.code,{children:"IsLookupable"})," class may be accessed from within instances."]}),"\n",(0,t.jsxs)(n.p,{children:["However, ensure that these parameters are true for ",(0,t.jsx)(n.strong,{children:"all"})," instances of a definition.\nFor example, if our parameters contained an id field which was instance-specific but defaulted to zero,\nthen the definition's id would be returned for all instances.\nThis change in behavior could lead to bugs if other code presumed the id field was correct."]}),"\n",(0,t.jsxs)(n.p,{children:["Thus, it is important that when converting normal modules to use this package,\nyou are careful about what you mark as ",(0,t.jsx)(n.code,{children:"IsLookupable"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, we added the trait ",(0,t.jsx)(n.code,{children:"IsLookupable"})," to allow the member to be marked ",(0,t.jsx)(n.code,{children:"@public"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, IsLookupable, public}\n\ncase class MyCaseClass(width: Int) extends IsLookupable\n\n@instantiable\nclass MyModule extends Module {\n  @public val x = MyCaseClass(10)\n}\n\nclass Top extends Module {\n  val inst = Instance(Definition(new MyModule))\n  println(s"Width is ${inst.x.width}")\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Width is 10\nCircuit(Top,List(DefModule(repl.MdocSession$MdocApp5$MyModule@7a6fe955,MyModule,false,List(),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2))),Vector()), DefModule(repl.MdocSession$MdocApp5$Top@1c468bf2,Top,true,List(),List(Port(Top.clock: IO[Clock],Input,SourceLine(hierarchy.md,111,7)), Port(Top.reset: IO[Bool],Input,SourceLine(hierarchy.md,111,7))),Vector(DefInstance(SourceLine(hierarchy.md,112,22),ModuleClone(repl.MdocSession$MdocApp5$MyModule@7a6fe955),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2)))), Connect(SourceLine(hierarchy.md,112,22),Node(MyModule.inst.clock: IO[Clock]),Node(Top.clock: IO[Clock])), Connect(SourceLine(hierarchy.md,112,22),Node(MyModule.inst.reset: IO[Reset]),Node(Top.reset: IO[Bool]))))),List(),firrtl.renamemap.package$MutableRenameMap@510592db,List(),List(),List(),List())\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-look-up-parameters-from-a-definition-if-i-dont-want-to-instantiate-it",children:"How do I look up parameters from a Definition, if I don't want to instantiate it?"}),"\n",(0,t.jsxs)(n.p,{children:["Just like ",(0,t.jsx)(n.code,{children:"Instance"}),"s, ",(0,t.jsx)(n.code,{children:"Definition"}),"'s also contain accessors for ",(0,t.jsx)(n.code,{children:"@public"})," members.\nAs such, you can directly access them:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, instantiable, public}\n\n@instantiable\nclass AddOne(val width: Int) extends RawModule {\n  @public val width = width\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass Top extends Module {\n  val definition = Definition(new AddOne(10))\n  println(s"Width is: ${definition.width}")\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.78.1\nmodule Top(\t// hierarchy.md:157:7\n  input clock,\t// hierarchy.md:157:7\n        reset\t// hierarchy.md:157:7\n);\n\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-parameterize-a-module-by-its-children-instances",children:"How do I parameterize a module by its children instances?"}),"\n",(0,t.jsx)(n.p,{children:"Prior to the introduction of this package, a parent module would have to pass all necessary parameters\nwhen instantiating a child module.\nThis had the unfortunate consequence of requiring a parent's parameters to always contain the child's\nparameters, which was an unnecessary coupling which lead to some anti-patterns."}),"\n",(0,t.jsxs)(n.p,{children:["Now, a parent can take a child ",(0,t.jsx)(n.code,{children:"Definition"})," as an argument, and instantiate it directly.\nIn addition, it can analyze the parameters used in the definition to parameterize itself.\nIn a sense, now the child can actually parameterize the parent."]}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, we create a definition of ",(0,t.jsx)(n.code,{children:"AddOne"}),", and pass the definition to ",(0,t.jsx)(n.code,{children:"AddTwo"}),".\nThe width of the ",(0,t.jsx)(n.code,{children:"AddTwo"})," ports are now derived from the parameterization of the ",(0,t.jsx)(n.code,{children:"AddOne"})," instance."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass AddOne(val width: Int) extends Module {\n  @public val width = width\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass AddTwo(addOneDef: Definition[AddOne]) extends Module {\n  val i0 = Instance(addOneDef)\n  val i1 = Instance(addOneDef)\n  val in  = IO(Input(UInt(addOneDef.width.W)))\n  val out = IO(Output(UInt(addOneDef.width.W)))\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.78.1\nmodule AddOne(\t// hierarchy.md:181:2\n  input  [9:0] in,\t// hierarchy.md:184:23\n  output [9:0] out\t// hierarchy.md:185:23\n);\n\n  assign out = in + 10'h1;\t// hierarchy.md:181:2, :186:13\nendmodule\n\nmodule AddTwo(\t// hierarchy.md:190:7\n  input        clock,\t// hierarchy.md:190:7\n               reset,\t// hierarchy.md:190:7\n  input  [9:0] in,\t// hierarchy.md:193:15\n  output [9:0] out\t// hierarchy.md:194:15\n);\n\n  wire [9:0] _i0_out;\t// hierarchy.md:191:20\n  AddOne i0 (\t// hierarchy.md:191:20\n    .in  (in),\n    .out (_i0_out)\n  );\t// hierarchy.md:191:20\n  AddOne i1 (\t// hierarchy.md:192:20\n    .in  (_i0_out),\t// hierarchy.md:191:20\n    .out (out)\n  );\t// hierarchy.md:192:20\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-use-the-new-hierarchy-specific-select-functions",children:"How do I use the new hierarchy-specific Select functions?"}),"\n",(0,t.jsx)(n.p,{children:"Select functions can be applied after a module has been elaborated, either in a Chisel Aspect or in a parent module applied to a child module."}),"\n",(0,t.jsxs)(n.p,{children:["There are seven hierarchy-specific functions, which (with the exception of ",(0,t.jsx)(n.code,{children:"ios"}),") either return ",(0,t.jsx)(n.code,{children:"Instance"}),"'s or ",(0,t.jsx)(n.code,{children:"Definition"}),"'s:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"instancesIn(parent)"}),": Return all instances directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"instancesOf[type](parent)"}),": Return all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"allInstancesOf[type](root)"}),": Return all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly and indirectly instantiated, locally and deeply, starting from ",(0,t.jsx)(n.code,{children:"root"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"definitionsIn"}),": Return definitions of all instances directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"definitionsOf[type]"}),": Return definitions of all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"allDefinitionsOf[type]"}),": Return all definitions of instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly and indirectly instantiated, locally and deeply, starting from ",(0,t.jsx)(n.code,{children:"root"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"ios"}),": Returns all the I/Os of the provided definition or instance."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["To demonstrate this, consider the following. We mock up an example where we are using the ",(0,t.jsx)(n.code,{children:"Select.allInstancesOf"})," and ",(0,t.jsx)(n.code,{children:"Select.allDefinitionsOf"})," to annotate instances and the definition of ",(0,t.jsx)(n.code,{children:"EmptyModule"}),". When converting the ",(0,t.jsx)(n.code,{children:"ChiselAnnotation"})," to firrtl's ",(0,t.jsx)(n.code,{children:"Annotation"}),", we print out the resulting ",(0,t.jsx)(n.code,{children:"Target"}),". As shown, despite ",(0,t.jsx)(n.code,{children:"EmptyModule"})," actually only being elaborated once, we still provide different targets depending on how the instance or definition is selected."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, Hierarchy, instantiable, public}\nimport firrtl.annotations.{IsModule, NoTargetAnnotation}\ncase object EmptyAnnotation extends NoTargetAnnotation\ncase class MyChiselAnnotation(m: Hierarchy[RawModule], tag: String) extends experimental.ChiselAnnotation {\n  def toFirrtl = {\n    println(tag + ": " + m.toTarget)\n    EmptyAnnotation\n  }\n}\n\n@instantiable\nclass EmptyModule extends Module {\n  println("Elaborating EmptyModule!")\n}\n\n@instantiable\nclass TwoEmptyModules extends Module {\n  val definition = Definition(new EmptyModule)\n  val i0         = Instance(definition)\n  val i1         = Instance(definition)\n}\n\nclass Top extends Module {\n  val definition = Definition(new TwoEmptyModules)\n  val instance   = Instance(definition)\n  aop.Select.allInstancesOf[EmptyModule](instance).foreach { i =>\n    experimental.annotate(MyChiselAnnotation(i, "instance"))\n  }\n  aop.Select.allDefinitionsOf[EmptyModule](instance).foreach { d =>\n    experimental.annotate(MyChiselAnnotation(d, "definition"))\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Elaborating EmptyModule!\ninstance: ~Top|Top/instance:TwoEmptyModules/i0:EmptyModule\ninstance: ~Top|Top/instance:TwoEmptyModules/i1:EmptyModule\ndefinition: ~Top|EmptyModule\n"})}),"\n",(0,t.jsxs)(n.p,{children:["You can also use ",(0,t.jsx)(n.code,{children:"Select.ios"})," on either a ",(0,t.jsx)(n.code,{children:"Definition"})," or an ",(0,t.jsx)(n.code,{children:"Instance"})," to annotate the I/Os appropriately:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'case class MyIOAnnotation(m: Data, tag: String) extends experimental.ChiselAnnotation {\n  def toFirrtl = {\n    println(tag + ": " + m.toTarget)\n    EmptyAnnotation\n  }\n}\n\n@instantiable\nclass InOutModule extends Module {\n  @public val in = IO(Input(Bool()))\n  @public val out = IO(Output(Bool()))\n  out := in\n}\n\n@instantiable\nclass TwoInOutModules extends Module {\n  val in = IO(Input(Bool()))\n  val out = IO(Output(Bool()))\n  val definition = Definition(new InOutModule)\n  val i0         = Instance(definition)\n  val i1         = Instance(definition)\n  i0.in := in\n  i1.in := i0.out\n  out := i1.out\n}\n\nclass InOutTop extends Module {\n  val definition = Definition(new TwoInOutModules)\n  val instance   = Instance(definition)\n  aop.Select.allInstancesOf[InOutModule](instance).foreach { i =>\n    aop.Select.ios(i).foreach { io =>\n      experimental.annotate(MyIOAnnotation(io, "instance io"))\n  }}\n  aop.Select.allDefinitionsOf[InOutModule](instance).foreach { d =>\n    aop.Select.ios(d).foreach {io =>\n      experimental.annotate(MyIOAnnotation(io, "definition io"))\n  }}\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"instance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>clock\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>reset\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>in\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>out\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>clock\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>reset\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>in\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>out\ndefinition io: ~InOutTop|InOutModule>clock\ndefinition io: ~InOutTop|InOutModule>reset\ndefinition io: ~InOutTop|InOutModule>in\ndefinition io: ~InOutTop|InOutModule>out\n"})})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},1871:(e,n,i)=>{i.d(n,{A:()=>s});i(6540);var t=i(5195);const o={tableOfContentsInline:"tableOfContentsInline_prmo"};var a=i(4848);function s(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:s}=e;return(0,a.jsx)("div",{className:o.tableOfContentsInline,children:(0,a.jsx)(t.A,{toc:n,minHeadingLevel:i,maxHeadingLevel:s,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,i)=>{i.d(n,{A:()=>f});var t=i(6540),o=i(6342);function a(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),i=Array(7).fill(-1);n.forEach(((e,n)=>{const t=i.slice(2,e.level);e.parentIndex=Math.max(...t),i[e.level]=n}));const t=[];return n.forEach((e=>{const{parentIndex:i,...o}=e;i>=0?n[i].children.push(o):t.push(o)})),t}function s(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=s({toc:e.children,minHeadingLevel:i,maxHeadingLevel:t});return function(e){return e.level>=i&&e.level<=t}(e)?[{...e,children:n}]:n}))}function l(e){const n=e.getBoundingClientRect();return n.top===n.bottom?l(e.parentNode):n}function c(e,n){let{anchorTopOffset:i}=n;const t=e.find((e=>l(e).top>=i));if(t){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(l(t))?t:e[e.indexOf(t)-1]??null}return e[e.length-1]??null}function d(){const e=(0,t.useRef)(0),{navbar:{hideOnScroll:n}}=(0,o.p)();return(0,t.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function r(e){const n=(0,t.useRef)(void 0),i=d();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:o,minHeadingLevel:a,maxHeadingLevel:s}=e;function l(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),l=function(e){let{minHeadingLevel:n,maxHeadingLevel:i}=e;const t=[];for(let o=n;o<=i;o+=1)t.push(`h${o}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:a,maxHeadingLevel:s}),d=c(l,{anchorTopOffset:i.current}),r=e.find((e=>d&&d.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,i){i?(n.current&&n.current!==e&&n.current.classList.remove(o),e.classList.add(o),n.current=e):e.classList.remove(o)}(e,e===r)}))}return document.addEventListener("scroll",l),document.addEventListener("resize",l),l(),()=>{document.removeEventListener("scroll",l),document.removeEventListener("resize",l)}}),[e,i])}var h=i(8774),u=i(4848);function p(e){let{toc:n,className:i,linkClassName:t,isChild:o}=e;return n.length?(0,u.jsx)("ul",{className:o?void 0:i,children:n.map((e=>(0,u.jsxs)("li",{children:[(0,u.jsx)(h.A,{to:`#${e.id}`,className:t??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,u.jsx)(p,{isChild:!0,toc:e.children,className:i,linkClassName:t})]},e.id)))}):null}const m=t.memo(p);function f(e){let{toc:n,className:i="table-of-contents table-of-contents__left-border",linkClassName:l="table-of-contents__link",linkActiveClassName:c,minHeadingLevel:d,maxHeadingLevel:h,...p}=e;const f=(0,o.p)(),x=d??f.tableOfContents.minHeadingLevel,I=h??f.tableOfContents.maxHeadingLevel,y=function(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:o}=e;return(0,t.useMemo)((()=>s({toc:a(n),minHeadingLevel:i,maxHeadingLevel:o})),[n,i,o])}({toc:n,minHeadingLevel:x,maxHeadingLevel:I});return r((0,t.useMemo)((()=>{if(l&&c)return{linkClassName:l,linkActiveClassName:c,minHeadingLevel:x,maxHeadingLevel:I}}),[l,c,x,I])),(0,u.jsx)(m,{toc:y,className:i,linkClassName:l,...p})}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>l});var t=i(6540);const o={},a=t.createContext(o);function s(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[741],{4008:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>r});var t=i(4848),o=i(8453),a=i(1871);const s={sidebar_position:2},l="Hierarchy Cookbook",c={id:"cookbooks/hierarchy",title:"Hierarchy Cookbook",description:"How do I instantiate multiple instances with the same module parameterization?",source:"@site/docs/cookbooks/hierarchy.md",sourceDirName:"cookbooks",slug:"/cookbooks/hierarchy",permalink:"/docs/cookbooks/hierarchy",draft:!1,unlisted:!1,editUrl:"https://github.com/chipsalliance/chisel/tree/main/docs/src/cookbooks/hierarchy.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"chiselSidebar",previous:{title:"Naming Cookbook",permalink:"/docs/cookbooks/naming"},next:{title:"DataView Cookbook",permalink:"/docs/cookbooks/dataview"}},d={},r=[{value:"How do I instantiate multiple instances with the same module parameterization?",id:"how-do-i-instantiate-multiple-instances-with-the-same-module-parameterization",level:2},{value:"Using Definition and Instance",id:"using-definition-and-instance",level:3},{value:"Using Instantiate",id:"using-instantiate",level:3},{value:"How do I access internal fields of an instance?",id:"how-do-i-access-internal-fields-of-an-instance",level:2},{value:"How do I make my parameters accessible from an instance?",id:"how-do-i-make-my-parameters-accessible-from-an-instance",level:2},{value:"How do I look up parameters from a Definition, if I don&#39;t want to instantiate it?",id:"how-do-i-look-up-parameters-from-a-definition-if-i-dont-want-to-instantiate-it",level:2},{value:"How do I parameterize a module by its children instances?",id:"how-do-i-parameterize-a-module-by-its-children-instances",level:2},{value:"How do I use the new hierarchy-specific Select functions?",id:"how-do-i-use-the-new-hierarchy-specific-select-functions",level:2}];function h(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"hierarchy-cookbook",children:"Hierarchy Cookbook"}),"\n","\n","\n",(0,t.jsx)(a.A,{toc:r}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-instantiate-multiple-instances-with-the-same-module-parameterization",children:"How do I instantiate multiple instances with the same module parameterization?"}),"\n",(0,t.jsx)(n.p,{children:'Prior to this package, Chisel users relied on deduplication in a FIRRTL compiler to combine\nstructurally equivalent modules into one module (aka "deduplication").\nThis package introduces the following new APIs to enable multiply-instantiated modules directly in Chisel.'}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Definition(...)"})," enables elaborating a module, but does not actually instantiate that module.\nInstead, it returns a ",(0,t.jsx)(n.code,{children:"Definition"})," class which represents that module's definition."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Instance(...)"})," takes a ",(0,t.jsx)(n.code,{children:"Definition"})," and instantiates it, returning an ",(0,t.jsx)(n.code,{children:"Instance"})," object."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Instantiate(...)"})," provides an API similar to ",(0,t.jsx)(n.code,{children:"Module(...)"}),", except it uses\n",(0,t.jsx)(n.code,{children:"Definition"})," and ",(0,t.jsx)(n.code,{children:"Instance"})," to only elaborate modules once for a given set of\nparameters. It returns an ",(0,t.jsx)(n.code,{children:"Instance"})," object."]}),"\n",(0,t.jsxs)(n.p,{children:["Modules (classes or traits) which will be used with the ",(0,t.jsx)(n.code,{children:"Definition"}),"/",(0,t.jsx)(n.code,{children:"Instance"})," api should be marked\nwith the ",(0,t.jsx)(n.code,{children:"@instantiable"})," annotation at the class/trait definition."]}),"\n",(0,t.jsxs)(n.p,{children:["To make a Module's members variables accessible from an ",(0,t.jsx)(n.code,{children:"Instance"})," object, they must be annotated\nwith the ",(0,t.jsx)(n.code,{children:"@public"})," annotation. Note that this is only accessible from a Scala sense\u2014this is not\nin and of itself a mechanism for cross-module references."]}),"\n",(0,t.jsx)(n.h3,{id:"using-definition-and-instance",children:"Using Definition and Instance"}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, use ",(0,t.jsx)(n.code,{children:"Definition"}),", ",(0,t.jsx)(n.code,{children:"Instance"}),", ",(0,t.jsx)(n.code,{children:"@instantiable"})," and ",(0,t.jsx)(n.code,{children:"@public"})," to create\nmultiple instances of one specific parameterization of a module, ",(0,t.jsx)(n.code,{children:"AddOne"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass AddOne(width: Int) extends Module {\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass AddTwo(width: Int) extends Module {\n  val in  = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt(width.W)))\n  val addOneDef = Definition(new AddOne(width))\n  val i0 = Instance(addOneDef)\n  val i1 = Instance(addOneDef)\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.78.1\nmodule AddOne(\t// hierarchy.md:14:2\n  input  [9:0] in,\t// hierarchy.md:16:23\n  output [9:0] out\t// hierarchy.md:17:23\n);\n\n  assign out = in + 10'h1;\t// hierarchy.md:14:2, :18:13\nendmodule\n\nmodule AddTwo(\t// hierarchy.md:22:7\n  input        clock,\t// hierarchy.md:22:7\n               reset,\t// hierarchy.md:22:7\n  input  [9:0] in,\t// hierarchy.md:23:15\n  output [9:0] out\t// hierarchy.md:24:15\n);\n\n  wire [9:0] _i0_out;\t// hierarchy.md:26:20\n  AddOne i0 (\t// hierarchy.md:26:20\n    .in  (in),\n    .out (_i0_out)\n  );\t// hierarchy.md:26:20\n  AddOne i1 (\t// hierarchy.md:27:20\n    .in  (_i0_out),\t// hierarchy.md:26:20\n    .out (out)\n  );\t// hierarchy.md:27:20\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h3,{id:"using-instantiate",children:"Using Instantiate"}),"\n",(0,t.jsxs)(n.p,{children:["Similar to the above, the following example uses ",(0,t.jsx)(n.code,{children:"Instantiate"})," to create\nmultiple instances of ",(0,t.jsx)(n.code,{children:"AddOne"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3.experimental.hierarchy.Instantiate\n\nclass AddTwoInstantiate(width: Int) extends Module {\n  val in  = IO(Input(UInt(width.W)))\n  val out = IO(Output(UInt(width.W)))\n  val i0 = Instantiate(new AddOne(width))\n  val i1 = Instantiate(new AddOne(width))\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.78.1\nmodule AddOne(\t// hierarchy.md:14:2\n  input  [15:0] in,\t// hierarchy.md:16:23\n  output [15:0] out\t// hierarchy.md:17:23\n);\n\n  assign out = in + 16'h1;\t// hierarchy.md:14:2, :18:13\nendmodule\n\nmodule AddTwoInstantiate(\t// hierarchy.md:46:7\n  input         clock,\t// hierarchy.md:46:7\n                reset,\t// hierarchy.md:46:7\n  input  [15:0] in,\t// hierarchy.md:47:15\n  output [15:0] out\t// hierarchy.md:48:15\n);\n\n  wire [15:0] _i0_out;\t// hierarchy.md:49:23\n  AddOne i0 (\t// hierarchy.md:49:23\n    .in  (in),\n    .out (_i0_out)\n  );\t// hierarchy.md:49:23\n  AddOne i1 (\t// hierarchy.md:50:23\n    .in  (_i0_out),\t// hierarchy.md:49:23\n    .out (out)\n  );\t// hierarchy.md:50:23\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-access-internal-fields-of-an-instance",children:"How do I access internal fields of an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["You can mark internal members of a class or trait marked with ",(0,t.jsx)(n.code,{children:"@instantiable"})," with the ",(0,t.jsx)(n.code,{children:"@public"})," annotation.\nThe requirements are that the field is publicly accessible, is a ",(0,t.jsx)(n.code,{children:"val"})," or ",(0,t.jsx)(n.code,{children:"lazy val"}),", and is a valid type.\nThe list of valid types are:"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"IsInstantiable"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"IsLookupable"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"Data"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"BaseModule"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"Iterable"}),"/",(0,t.jsx)(n.code,{children:"Option "}),"containing a type that meets these requirements"]}),"\n",(0,t.jsxs)(n.li,{children:["Basic type like ",(0,t.jsx)(n.code,{children:"String"}),", ",(0,t.jsx)(n.code,{children:"Int"}),", ",(0,t.jsx)(n.code,{children:"BigInt"})," etc."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["To mark a superclass's member as ",(0,t.jsx)(n.code,{children:"@public"}),", use the following pattern (shown with ",(0,t.jsx)(n.code,{children:"val clock"}),")."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{instantiable, public}\n\n@instantiable\nclass MyModule extends Module {\n  @public val clock = clock\n}\n"})}),"\n",(0,t.jsxs)(n.p,{children:["You'll get the following error message for improperly marking something as ",(0,t.jsx)(n.code,{children:"@public"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{instantiable, public}\n\nobject NotValidType\n\n@instantiable\nclass MyModule extends Module {\n  @public val x = NotValidType\n}\n// error: @public is only legal within a class or trait marked @instantiable, and only on vals of type Data, BaseModule, MemBase, IsInstantiable, IsLookupable, or Instance[_], or in an Iterable, Option, Either, or Tuple2\n// val x = circt.stage.ChiselStage.emitCHIRRTL(new Top)\n//     ^\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-make-my-parameters-accessible-from-an-instance",children:"How do I make my parameters accessible from an instance?"}),"\n",(0,t.jsxs)(n.p,{children:["If an instance's parameters are simple (e.g. ",(0,t.jsx)(n.code,{children:"Int"}),", ",(0,t.jsx)(n.code,{children:"String"})," etc.) they can be marked directly with ",(0,t.jsx)(n.code,{children:"@public"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Often, parameters are more complicated and are contained in case classes.\nIn such cases, mark the case class with the ",(0,t.jsx)(n.code,{children:"IsLookupable"})," trait.\nThis indicates to Chisel that instances of the ",(0,t.jsx)(n.code,{children:"IsLookupable"})," class may be accessed from within instances."]}),"\n",(0,t.jsxs)(n.p,{children:["However, ensure that these parameters are true for ",(0,t.jsx)(n.strong,{children:"all"})," instances of a definition.\nFor example, if our parameters contained an id field which was instance-specific but defaulted to zero,\nthen the definition's id would be returned for all instances.\nThis change in behavior could lead to bugs if other code presumed the id field was correct."]}),"\n",(0,t.jsxs)(n.p,{children:["Thus, it is important that when converting normal modules to use this package,\nyou are careful about what you mark as ",(0,t.jsx)(n.code,{children:"IsLookupable"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, we added the trait ",(0,t.jsx)(n.code,{children:"IsLookupable"})," to allow the member to be marked ",(0,t.jsx)(n.code,{children:"@public"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, IsLookupable, public}\n\ncase class MyCaseClass(width: Int) extends IsLookupable\n\n@instantiable\nclass MyModule extends Module {\n  @public val x = MyCaseClass(10)\n}\n\nclass Top extends Module {\n  val inst = Instance(Definition(new MyModule))\n  println(s"Width is ${inst.x.width}")\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Width is 10\nCircuit(Top,List(DefModule(repl.MdocSession$MdocApp5$MyModule@423039b6,MyModule,false,List(),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2))),Vector()), DefModule(repl.MdocSession$MdocApp5$Top@25217a39,Top,true,List(),List(Port(Top.clock: IO[Clock],Input,SourceLine(hierarchy.md,111,7)), Port(Top.reset: IO[Bool],Input,SourceLine(hierarchy.md,111,7))),Vector(DefInstance(SourceLine(hierarchy.md,112,22),ModuleClone(repl.MdocSession$MdocApp5$MyModule@423039b6),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2)))), Connect(SourceLine(hierarchy.md,112,22),Node(MyModule.inst.clock: IO[Clock]),Node(Top.clock: IO[Clock])), Connect(SourceLine(hierarchy.md,112,22),Node(MyModule.inst.reset: IO[Reset]),Node(Top.reset: IO[Bool]))))),List(),firrtl.renamemap.package$MutableRenameMap@383f282f,List(),List(),List(),List())\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-look-up-parameters-from-a-definition-if-i-dont-want-to-instantiate-it",children:"How do I look up parameters from a Definition, if I don't want to instantiate it?"}),"\n",(0,t.jsxs)(n.p,{children:["Just like ",(0,t.jsx)(n.code,{children:"Instance"}),"s, ",(0,t.jsx)(n.code,{children:"Definition"}),"'s also contain accessors for ",(0,t.jsx)(n.code,{children:"@public"})," members.\nAs such, you can directly access them:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, instantiable, public}\n\n@instantiable\nclass AddOne(val width: Int) extends RawModule {\n  @public val width = width\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass Top extends Module {\n  val definition = Definition(new AddOne(10))\n  println(s"Width is: ${definition.width}")\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.78.1\nmodule Top(\t// hierarchy.md:157:7\n  input clock,\t// hierarchy.md:157:7\n        reset\t// hierarchy.md:157:7\n);\n\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-parameterize-a-module-by-its-children-instances",children:"How do I parameterize a module by its children instances?"}),"\n",(0,t.jsx)(n.p,{children:"Prior to the introduction of this package, a parent module would have to pass all necessary parameters\nwhen instantiating a child module.\nThis had the unfortunate consequence of requiring a parent's parameters to always contain the child's\nparameters, which was an unnecessary coupling which lead to some anti-patterns."}),"\n",(0,t.jsxs)(n.p,{children:["Now, a parent can take a child ",(0,t.jsx)(n.code,{children:"Definition"})," as an argument, and instantiate it directly.\nIn addition, it can analyze the parameters used in the definition to parameterize itself.\nIn a sense, now the child can actually parameterize the parent."]}),"\n",(0,t.jsxs)(n.p,{children:["In the following example, we create a definition of ",(0,t.jsx)(n.code,{children:"AddOne"}),", and pass the definition to ",(0,t.jsx)(n.code,{children:"AddTwo"}),".\nThe width of the ",(0,t.jsx)(n.code,{children:"AddTwo"})," ports are now derived from the parameterization of the ",(0,t.jsx)(n.code,{children:"AddOne"})," instance."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:"import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, instantiable, public}\n\n@instantiable\nclass AddOne(val width: Int) extends Module {\n  @public val width = width\n  @public val in  = IO(Input(UInt(width.W)))\n  @public val out = IO(Output(UInt(width.W)))\n  out := in + 1.U\n}\n\nclass AddTwo(addOneDef: Definition[AddOne]) extends Module {\n  val i0 = Instance(addOneDef)\n  val i1 = Instance(addOneDef)\n  val in  = IO(Input(UInt(addOneDef.width.W)))\n  val out = IO(Output(UInt(addOneDef.width.W)))\n  i0.in := in\n  i1.in := i0.out\n  out   := i1.out\n}\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-verilog",children:"// Generated by CIRCT firtool-1.78.1\nmodule AddOne(\t// hierarchy.md:181:2\n  input  [9:0] in,\t// hierarchy.md:184:23\n  output [9:0] out\t// hierarchy.md:185:23\n);\n\n  assign out = in + 10'h1;\t// hierarchy.md:181:2, :186:13\nendmodule\n\nmodule AddTwo(\t// hierarchy.md:190:7\n  input        clock,\t// hierarchy.md:190:7\n               reset,\t// hierarchy.md:190:7\n  input  [9:0] in,\t// hierarchy.md:193:15\n  output [9:0] out\t// hierarchy.md:194:15\n);\n\n  wire [9:0] _i0_out;\t// hierarchy.md:191:20\n  AddOne i0 (\t// hierarchy.md:191:20\n    .in  (in),\n    .out (_i0_out)\n  );\t// hierarchy.md:191:20\n  AddOne i1 (\t// hierarchy.md:192:20\n    .in  (_i0_out),\t// hierarchy.md:191:20\n    .out (out)\n  );\t// hierarchy.md:192:20\nendmodule\n\n"})}),"\n",(0,t.jsx)(n.h2,{id:"how-do-i-use-the-new-hierarchy-specific-select-functions",children:"How do I use the new hierarchy-specific Select functions?"}),"\n",(0,t.jsx)(n.p,{children:"Select functions can be applied after a module has been elaborated, either in a Chisel Aspect or in a parent module applied to a child module."}),"\n",(0,t.jsxs)(n.p,{children:["There are seven hierarchy-specific functions, which (with the exception of ",(0,t.jsx)(n.code,{children:"ios"}),") either return ",(0,t.jsx)(n.code,{children:"Instance"}),"'s or ",(0,t.jsx)(n.code,{children:"Definition"}),"'s:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"instancesIn(parent)"}),": Return all instances directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"instancesOf[type](parent)"}),": Return all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"allInstancesOf[type](root)"}),": Return all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly and indirectly instantiated, locally and deeply, starting from ",(0,t.jsx)(n.code,{children:"root"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"definitionsIn"}),": Return definitions of all instances directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"definitionsOf[type]"}),": Return definitions of all instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly instantiated locally within ",(0,t.jsx)(n.code,{children:"parent"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"allDefinitionsOf[type]"}),": Return all definitions of instances of provided ",(0,t.jsx)(n.code,{children:"type"})," directly and indirectly instantiated, locally and deeply, starting from ",(0,t.jsx)(n.code,{children:"root"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"ios"}),": Returns all the I/Os of the provided definition or instance."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["To demonstrate this, consider the following. We mock up an example where we are using the ",(0,t.jsx)(n.code,{children:"Select.allInstancesOf"})," and ",(0,t.jsx)(n.code,{children:"Select.allDefinitionsOf"})," to annotate instances and the definition of ",(0,t.jsx)(n.code,{children:"EmptyModule"}),". When converting the ",(0,t.jsx)(n.code,{children:"ChiselAnnotation"})," to firrtl's ",(0,t.jsx)(n.code,{children:"Annotation"}),", we print out the resulting ",(0,t.jsx)(n.code,{children:"Target"}),". As shown, despite ",(0,t.jsx)(n.code,{children:"EmptyModule"})," actually only being elaborated once, we still provide different targets depending on how the instance or definition is selected."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'import chisel3._\nimport chisel3.experimental.hierarchy.{Definition, Instance, Hierarchy, instantiable, public}\nimport firrtl.annotations.{IsModule, NoTargetAnnotation}\ncase object EmptyAnnotation extends NoTargetAnnotation\ncase class MyChiselAnnotation(m: Hierarchy[RawModule], tag: String) extends experimental.ChiselAnnotation {\n  def toFirrtl = {\n    println(tag + ": " + m.toTarget)\n    EmptyAnnotation\n  }\n}\n\n@instantiable\nclass EmptyModule extends Module {\n  println("Elaborating EmptyModule!")\n}\n\n@instantiable\nclass TwoEmptyModules extends Module {\n  val definition = Definition(new EmptyModule)\n  val i0         = Instance(definition)\n  val i1         = Instance(definition)\n}\n\nclass Top extends Module {\n  val definition = Definition(new TwoEmptyModules)\n  val instance   = Instance(definition)\n  aop.Select.allInstancesOf[EmptyModule](instance).foreach { i =>\n    experimental.annotate(MyChiselAnnotation(i, "instance"))\n  }\n  aop.Select.allDefinitionsOf[EmptyModule](instance).foreach { d =>\n    experimental.annotate(MyChiselAnnotation(d, "definition"))\n  }\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"Elaborating EmptyModule!\ninstance: ~Top|Top/instance:TwoEmptyModules/i0:EmptyModule\ninstance: ~Top|Top/instance:TwoEmptyModules/i1:EmptyModule\ndefinition: ~Top|EmptyModule\n"})}),"\n",(0,t.jsxs)(n.p,{children:["You can also use ",(0,t.jsx)(n.code,{children:"Select.ios"})," on either a ",(0,t.jsx)(n.code,{children:"Definition"})," or an ",(0,t.jsx)(n.code,{children:"Instance"})," to annotate the I/Os appropriately:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-scala",children:'case class MyIOAnnotation(m: Data, tag: String) extends experimental.ChiselAnnotation {\n  def toFirrtl = {\n    println(tag + ": " + m.toTarget)\n    EmptyAnnotation\n  }\n}\n\n@instantiable\nclass InOutModule extends Module {\n  @public val in = IO(Input(Bool()))\n  @public val out = IO(Output(Bool()))\n  out := in\n}\n\n@instantiable\nclass TwoInOutModules extends Module {\n  val in = IO(Input(Bool()))\n  val out = IO(Output(Bool()))\n  val definition = Definition(new InOutModule)\n  val i0         = Instance(definition)\n  val i1         = Instance(definition)\n  i0.in := in\n  i1.in := i0.out\n  out := i1.out\n}\n\nclass InOutTop extends Module {\n  val definition = Definition(new TwoInOutModules)\n  val instance   = Instance(definition)\n  aop.Select.allInstancesOf[InOutModule](instance).foreach { i =>\n    aop.Select.ios(i).foreach { io =>\n      experimental.annotate(MyIOAnnotation(io, "instance io"))\n  }}\n  aop.Select.allDefinitionsOf[InOutModule](instance).foreach { d =>\n    aop.Select.ios(d).foreach {io =>\n      experimental.annotate(MyIOAnnotation(io, "definition io"))\n  }}\n}\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"instance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>clock\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>reset\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>in\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i0:InOutModule>out\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>clock\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>reset\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>in\ninstance io: ~InOutTop|InOutTop/instance:TwoInOutModules/i1:InOutModule>out\ndefinition io: ~InOutTop|InOutModule>clock\ndefinition io: ~InOutTop|InOutModule>reset\ndefinition io: ~InOutTop|InOutModule>in\ndefinition io: ~InOutTop|InOutModule>out\n"})})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},1871:(e,n,i)=>{i.d(n,{A:()=>s});i(6540);var t=i(5195);const o={tableOfContentsInline:"tableOfContentsInline_prmo"};var a=i(4848);function s(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:s}=e;return(0,a.jsx)("div",{className:o.tableOfContentsInline,children:(0,a.jsx)(t.A,{toc:n,minHeadingLevel:i,maxHeadingLevel:s,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,i)=>{i.d(n,{A:()=>f});var t=i(6540),o=i(6342);function a(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),i=Array(7).fill(-1);n.forEach(((e,n)=>{const t=i.slice(2,e.level);e.parentIndex=Math.max(...t),i[e.level]=n}));const t=[];return n.forEach((e=>{const{parentIndex:i,...o}=e;i>=0?n[i].children.push(o):t.push(o)})),t}function s(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=s({toc:e.children,minHeadingLevel:i,maxHeadingLevel:t});return function(e){return e.level>=i&&e.level<=t}(e)?[{...e,children:n}]:n}))}function l(e){const n=e.getBoundingClientRect();return n.top===n.bottom?l(e.parentNode):n}function c(e,n){let{anchorTopOffset:i}=n;const t=e.find((e=>l(e).top>=i));if(t){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(l(t))?t:e[e.indexOf(t)-1]??null}return e[e.length-1]??null}function d(){const e=(0,t.useRef)(0),{navbar:{hideOnScroll:n}}=(0,o.p)();return(0,t.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function r(e){const n=(0,t.useRef)(void 0),i=d();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:o,minHeadingLevel:a,maxHeadingLevel:s}=e;function l(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),l=function(e){let{minHeadingLevel:n,maxHeadingLevel:i}=e;const t=[];for(let o=n;o<=i;o+=1)t.push(`h${o}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:a,maxHeadingLevel:s}),d=c(l,{anchorTopOffset:i.current}),r=e.find((e=>d&&d.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,i){i?(n.current&&n.current!==e&&n.current.classList.remove(o),e.classList.add(o),n.current=e):e.classList.remove(o)}(e,e===r)}))}return document.addEventListener("scroll",l),document.addEventListener("resize",l),l(),()=>{document.removeEventListener("scroll",l),document.removeEventListener("resize",l)}}),[e,i])}var h=i(8774),u=i(4848);function p(e){let{toc:n,className:i,linkClassName:t,isChild:o}=e;return n.length?(0,u.jsx)("ul",{className:o?void 0:i,children:n.map((e=>(0,u.jsxs)("li",{children:[(0,u.jsx)(h.A,{to:`#${e.id}`,className:t??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,u.jsx)(p,{isChild:!0,toc:e.children,className:i,linkClassName:t})]},e.id)))}):null}const m=t.memo(p);function f(e){let{toc:n,className:i="table-of-contents table-of-contents__left-border",linkClassName:l="table-of-contents__link",linkActiveClassName:c,minHeadingLevel:d,maxHeadingLevel:h,...p}=e;const f=(0,o.p)(),x=d??f.tableOfContents.minHeadingLevel,I=h??f.tableOfContents.maxHeadingLevel,y=function(e){let{toc:n,minHeadingLevel:i,maxHeadingLevel:o}=e;return(0,t.useMemo)((()=>s({toc:a(n),minHeadingLevel:i,maxHeadingLevel:o})),[n,i,o])}({toc:n,minHeadingLevel:x,maxHeadingLevel:I});return r((0,t.useMemo)((()=>{if(l&&c)return{linkClassName:l,linkActiveClassName:c,minHeadingLevel:x,maxHeadingLevel:I}}),[l,c,x,I])),(0,u.jsx)(m,{toc:y,className:i,linkClassName:l,...p})}},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>l});var t=i(6540);const o={},a=t.createContext(o);function s(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/7b5bfa87.2c05436e.js b/assets/js/7b5bfa87.82a0116c.js
similarity index 84%
rename from assets/js/7b5bfa87.2c05436e.js
rename to assets/js/7b5bfa87.82a0116c.js
index e805ac1c6e4..60a911254a3 100644
--- a/assets/js/7b5bfa87.2c05436e.js
+++ b/assets/js/7b5bfa87.82a0116c.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[2785],{924:(a,e,n)=>{n.r(e),n.d(e,{assets:()=>i,contentTitle:()=>c,default:()=>$,frontMatter:()=>s,metadata:()=>o,toc:()=>r});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={},r=[{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 p(a){const e={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...a.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(e.h1,{id:"chisel-type-vs-scala-type",children:"Chisel Type vs Scala Type"}),"\n",(0,l.jsxs)(e.p,{children:["The Scala compiler cannot distinguish between Chisel's representation of hardware such as ",(0,l.jsx)(e.code,{children:"false.B"}),", ",(0,l.jsx)(e.code,{children:"Reg(Bool())"}),"\nand pure Chisel types (e.g. ",(0,l.jsx)(e.code,{children:"Bool()"}),"). You can get runtime errors passing a Chisel type when hardware is expected, and vice versa."]}),"\n",(0,l.jsx)(e.h2,{id:"scala-type-vs-chisel-type-vs-hardware",children:"Scala Type vs Chisel Type vs Hardware"}),"\n",(0,l.jsxs)(e.p,{children:["The ",(0,l.jsx)(e.em,{children:"Scala"})," type of the Data is recognized by the Scala compiler, such as ",(0,l.jsx)(e.code,{children:"Bool"}),", ",(0,l.jsx)(e.code,{children:"Decoupled[UInt]"})," or ",(0,l.jsx)(e.code,{children:"MyBundle"})," in"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"class MyBundle(w: Int) extends Bundle {\n  val foo = UInt(w.W)\n  val bar = UInt(w.W)\n}\n"})}),"\n",(0,l.jsxs)(e.p,{children:["The ",(0,l.jsx)(e.em,{children:"Chisel"})," type of a ",(0,l.jsx)(e.code,{children:"Data"})," is a Scala object. It captures all the fields actually present,\nby names, and their types including widths.\nFor example, ",(0,l.jsx)(e.code,{children:"MyBundle(3)"})," creates a Chisel Type with fields ",(0,l.jsx)(e.code,{children:"foo: UInt(3.W),  bar: UInt(3.W))"}),"."]}),"\n",(0,l.jsxs)(e.p,{children:["Hardware is ",(0,l.jsx)(e.code,{children:"Data"}),' that is "bound" to synthesizable hardware. For example ',(0,l.jsx)(e.code,{children:"false.B"})," or ",(0,l.jsx)(e.code,{children:"Reg(Bool())"}),".\nThe binding is what determines the actual directionality of each field, it is not a property of the Chisel type."]}),"\n",(0,l.jsxs)(e.p,{children:["A literal is a ",(0,l.jsx)(e.code,{children:"Data"})," that is respresentable as a literal value without being wrapped in Wire, Reg, or IO."]}),"\n",(0,l.jsx)(e.h2,{id:"chisel-type-vs-hardware-vs-literals",children:"Chisel Type vs Hardware vs Literals"}),"\n",(0,l.jsxs)(e.p,{children:["The below code demonstrates how objects with the same Scala type (",(0,l.jsx)(e.code,{children:"MyBundle"}),") can have different properties."]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"import chisel3.experimental.BundleLiterals._\n\nclass MyModule(gen: () => MyBundle) extends Module {\n                                                            //   Hardware   Literal\n    val xType:    MyBundle     = new MyBundle(3)            //      -          -\n    val dirXType: MyBundle     = Input(new MyBundle(3))     //      -          -\n    val xReg:     MyBundle     = Reg(new MyBundle(3))       //      x          -\n    val xIO:      MyBundle     = IO(Input(new MyBundle(3))) //      x          -\n    val xRegInit: MyBundle     = RegInit(xIO)               //      x          -\n    val xLit:     MyBundle     = xType.Lit(                 //      x          x\n      _.foo -> 0.U(3.W),\n      _.bar -> 0.U(3.W)\n    )\n    val y:        MyBundle = gen()                          //      ?          ?\n\n    // Need to initialize all hardware values\n    xReg := DontCare\n}\n"})}),"\n",(0,l.jsx)(e.h2,{id:"chisel-type-vs-hardware----specific-functions-and-errors",children:"Chisel Type vs Hardware -- Specific Functions and Errors"}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".asTypeOf"})," works for both hardware and Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"elaborate(new Module {\n  val chiselType = new MyBundle(3)\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val a = 0.U.asTypeOf(chiselType)\n  val b = 0.U.asTypeOf(hardware)\n})\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only ",(0,l.jsx)(e.code,{children:":="})," to hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val chiselType = new MyBundle(3)\n  chiselType := DontCare\n})\n// chisel3.package$ExpectedHardwareException: data to be connected 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21$$anon$3.<init>(chisel-type-vs-scala-type.md:90)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:88)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:88)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only ",(0,l.jsx)(e.code,{children:":="})," from hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = IO(new MyBundle(3))\n  val moarHardware = Wire(new MyBundle(3))\n  moarHardware := DontCare\n  hardware := moarHardware\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val hardware = IO(new MyBundle(3))\n  val chiselType = new MyBundle(3)\n  hardware := chiselType\n})\n// chisel3.package$ExpectedHardwareException: data to be connected 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27$$anon$5.<init>(chisel-type-vs-scala-type.md:115)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:112)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:112)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Have to pass hardware to ",(0,l.jsx)(e.code,{children:"chiselTypeOf"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val chiselType = chiselTypeOf(hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val chiselType = new MyBundle(3)\n  val crash = chiselTypeOf(chiselType)\n})\n// chisel3.package$ExpectedHardwareException: 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:138)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39.apply(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7.<init>(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:136)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:136)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Have to pass hardware to ",(0,l.jsx)(e.code,{children:"*Init"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val moarHardware = WireInit(hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val crash = WireInit(new MyBundle(3))\n})\n// chisel3.package$ExpectedHardwareException: wire initializer 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:160)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45.apply(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9.<init>(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:159)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:159)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can't pass hardware to a ",(0,l.jsx)(e.code,{children:"Wire"}),", ",(0,l.jsx)(e.code,{children:"Reg"}),", ",(0,l.jsx)(e.code,{children:"IO"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  val crash = Wire(hardware)\n})\n// chisel3.package$ExpectedChiselTypeException: wire type '_44_Anon.hardware: Wire[MyBundle]' must be a Chisel type, not hardware\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:182)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51.apply(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11.<init>(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:180)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:180)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".Lit"})," can only be called on Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardwareLit = (new MyBundle(3)).Lit(\n    _.foo -> 0.U,\n    _.bar -> 0.U\n  )\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"//Not this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  val crash = hardware.Lit(\n    _.foo -> 0.U,\n    _.bar -> 0.U\n  )\n})\n// chisel3.package$ExpectedChiselTypeException: bundle literal constructor model '_52_Anon.hardware: Wire[MyBundle]' must be a Chisel type, not hardware\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:206)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56.apply(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13.<init>(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:204)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:204)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only use a Chisel type within a ",(0,l.jsx)(e.code,{children:"Bundle"})," definition:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new Bundle {\n    val nested = new MyBundle(3)\n  })\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val crash = Wire(new Bundle {\n    val nested = Wire(new MyBundle(3))\n  })\n})\n// chisel3.package$ExpectedChiselTypeException: Bundle: AnonymousBundle contains hardware fields: nested: _60_Anon.crash_nested: Wire[MyBundle]\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:232)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62.apply(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16.<init>(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:231)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:231)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only call ",(0,l.jsx)(e.code,{children:"directionOf"})," on Hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"import chisel3.reflect.DataMirror\n\nclass Child extends Module{\n  val hardware = IO(new MyBundle(3))\n  hardware := DontCare\n  val chiselType = new MyBundle(3)\n}\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val child = Module(new Child())\n  child.hardware := DontCare\n  val direction = DataMirror.directionOf(child.hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\nval child = Module(new Child())\n  child.hardware := DontCare\n  val direction = DataMirror.directionOf(child.chiselType)\n})\n// chisel3.package$ExpectedHardwareException: node requested directionality on 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68$$anon$19.<init>(chisel-type-vs-scala-type.md:271)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:268)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:268)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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 @2c476dc)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.SpecifiedDirection$.specifiedDirection(Data.scala:75)\n// \tat chisel3.Output$.apply(Data.scala:314)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(Module.scala:878)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule.<init>(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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\nChiselStage.emitSystemVerilog(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.78.1\n// module _82_Anon(\t// chisel-type-vs-scala-type.md:323:47\n//   input        clock,\t// chisel-type-vs-scala-type.md:323:47\n//                reset,\t// chisel-type-vs-scala-type.md:323:47\n//   input  [2:0] in_foo,\t// chisel-type-vs-scala-type.md:324:14\n//                in_bar,\t// chisel-type-vs-scala-type.md:324:14\n//   output [5:0] out_foobar\t// chisel-type-vs-scala-type.md:325:15\n// );\n// \n//   assign out_foobar = {in_foo, in_bar};\t// chisel-type-vs-scala-type.md:323:47, :327:21\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 $(a={}){const{wrapper:e}={...(0,t.R)(),...a.components};return e?(0,l.jsx)(e,{...a,children:(0,l.jsx)(p,{...a})}):p(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],{924:(a,e,n)=>{n.r(e),n.d(e,{assets:()=>i,contentTitle:()=>c,default:()=>$,frontMatter:()=>s,metadata:()=>o,toc:()=>r});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={},r=[{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 p(a){const e={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...a.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(e.h1,{id:"chisel-type-vs-scala-type",children:"Chisel Type vs Scala Type"}),"\n",(0,l.jsxs)(e.p,{children:["The Scala compiler cannot distinguish between Chisel's representation of hardware such as ",(0,l.jsx)(e.code,{children:"false.B"}),", ",(0,l.jsx)(e.code,{children:"Reg(Bool())"}),"\nand pure Chisel types (e.g. ",(0,l.jsx)(e.code,{children:"Bool()"}),"). You can get runtime errors passing a Chisel type when hardware is expected, and vice versa."]}),"\n",(0,l.jsx)(e.h2,{id:"scala-type-vs-chisel-type-vs-hardware",children:"Scala Type vs Chisel Type vs Hardware"}),"\n",(0,l.jsxs)(e.p,{children:["The ",(0,l.jsx)(e.em,{children:"Scala"})," type of the Data is recognized by the Scala compiler, such as ",(0,l.jsx)(e.code,{children:"Bool"}),", ",(0,l.jsx)(e.code,{children:"Decoupled[UInt]"})," or ",(0,l.jsx)(e.code,{children:"MyBundle"})," in"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"class MyBundle(w: Int) extends Bundle {\n  val foo = UInt(w.W)\n  val bar = UInt(w.W)\n}\n"})}),"\n",(0,l.jsxs)(e.p,{children:["The ",(0,l.jsx)(e.em,{children:"Chisel"})," type of a ",(0,l.jsx)(e.code,{children:"Data"})," is a Scala object. It captures all the fields actually present,\nby names, and their types including widths.\nFor example, ",(0,l.jsx)(e.code,{children:"MyBundle(3)"})," creates a Chisel Type with fields ",(0,l.jsx)(e.code,{children:"foo: UInt(3.W),  bar: UInt(3.W))"}),"."]}),"\n",(0,l.jsxs)(e.p,{children:["Hardware is ",(0,l.jsx)(e.code,{children:"Data"}),' that is "bound" to synthesizable hardware. For example ',(0,l.jsx)(e.code,{children:"false.B"})," or ",(0,l.jsx)(e.code,{children:"Reg(Bool())"}),".\nThe binding is what determines the actual directionality of each field, it is not a property of the Chisel type."]}),"\n",(0,l.jsxs)(e.p,{children:["A literal is a ",(0,l.jsx)(e.code,{children:"Data"})," that is respresentable as a literal value without being wrapped in Wire, Reg, or IO."]}),"\n",(0,l.jsx)(e.h2,{id:"chisel-type-vs-hardware-vs-literals",children:"Chisel Type vs Hardware vs Literals"}),"\n",(0,l.jsxs)(e.p,{children:["The below code demonstrates how objects with the same Scala type (",(0,l.jsx)(e.code,{children:"MyBundle"}),") can have different properties."]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"import chisel3.experimental.BundleLiterals._\n\nclass MyModule(gen: () => MyBundle) extends Module {\n                                                            //   Hardware   Literal\n    val xType:    MyBundle     = new MyBundle(3)            //      -          -\n    val dirXType: MyBundle     = Input(new MyBundle(3))     //      -          -\n    val xReg:     MyBundle     = Reg(new MyBundle(3))       //      x          -\n    val xIO:      MyBundle     = IO(Input(new MyBundle(3))) //      x          -\n    val xRegInit: MyBundle     = RegInit(xIO)               //      x          -\n    val xLit:     MyBundle     = xType.Lit(                 //      x          x\n      _.foo -> 0.U(3.W),\n      _.bar -> 0.U(3.W)\n    )\n    val y:        MyBundle = gen()                          //      ?          ?\n\n    // Need to initialize all hardware values\n    xReg := DontCare\n}\n"})}),"\n",(0,l.jsx)(e.h2,{id:"chisel-type-vs-hardware----specific-functions-and-errors",children:"Chisel Type vs Hardware -- Specific Functions and Errors"}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".asTypeOf"})," works for both hardware and Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"elaborate(new Module {\n  val chiselType = new MyBundle(3)\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val a = 0.U.asTypeOf(chiselType)\n  val b = 0.U.asTypeOf(hardware)\n})\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only ",(0,l.jsx)(e.code,{children:":="})," to hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val chiselType = new MyBundle(3)\n  chiselType := DontCare\n})\n// chisel3.package$ExpectedHardwareException: data to be connected 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21$$anon$3.<init>(chisel-type-vs-scala-type.md:90)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:88)\n// \tat repl.MdocSession$MdocApp$$anonfun$21$$anonfun$apply$21.apply(chisel-type-vs-scala-type.md:88)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only ",(0,l.jsx)(e.code,{children:":="})," from hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = IO(new MyBundle(3))\n  val moarHardware = Wire(new MyBundle(3))\n  moarHardware := DontCare\n  hardware := moarHardware\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val hardware = IO(new MyBundle(3))\n  val chiselType = new MyBundle(3)\n  hardware := chiselType\n})\n// chisel3.package$ExpectedHardwareException: data to be connected 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27$$anon$5.<init>(chisel-type-vs-scala-type.md:115)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:112)\n// \tat repl.MdocSession$MdocApp$$anonfun$29$$anonfun$apply$27.apply(chisel-type-vs-scala-type.md:112)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Have to pass hardware to ",(0,l.jsx)(e.code,{children:"chiselTypeOf"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val chiselType = chiselTypeOf(hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val chiselType = new MyBundle(3)\n  val crash = chiselTypeOf(chiselType)\n})\n// chisel3.package$ExpectedHardwareException: 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39$$anonfun$apply$36.apply(chisel-type-vs-scala-type.md:138)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39.apply(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7$$anonfun$39.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34$$anon$7.<init>(chisel-type-vs-scala-type.md:138)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:136)\n// \tat repl.MdocSession$MdocApp$$anonfun$37$$anonfun$apply$34.apply(chisel-type-vs-scala-type.md:136)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Have to pass hardware to ",(0,l.jsx)(e.code,{children:"*Init"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n  val moarHardware = WireInit(hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val crash = WireInit(new MyBundle(3))\n})\n// chisel3.package$ExpectedHardwareException: wire initializer 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45$$anonfun$apply$41.apply(chisel-type-vs-scala-type.md:160)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45.apply(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9$$anonfun$45.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40$$anon$9.<init>(chisel-type-vs-scala-type.md:160)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:159)\n// \tat repl.MdocSession$MdocApp$$anonfun$44$$anonfun$apply$40.apply(chisel-type-vs-scala-type.md:159)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can't pass hardware to a ",(0,l.jsx)(e.code,{children:"Wire"}),", ",(0,l.jsx)(e.code,{children:"Reg"}),", ",(0,l.jsx)(e.code,{children:"IO"}),":"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  val crash = Wire(hardware)\n})\n// chisel3.package$ExpectedChiselTypeException: wire type '_44_Anon.hardware: Wire[MyBundle]' must be a Chisel type, not hardware\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51$$anonfun$apply$47.apply(chisel-type-vs-scala-type.md:182)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51.apply(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11$$anonfun$51.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44$$anon$11.<init>(chisel-type-vs-scala-type.md:182)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:180)\n// \tat repl.MdocSession$MdocApp$$anonfun$49$$anonfun$apply$44.apply(chisel-type-vs-scala-type.md:180)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:[(0,l.jsx)(e.code,{children:".Lit"})," can only be called on Chisel type:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardwareLit = (new MyBundle(3)).Lit(\n    _.foo -> 0.U,\n    _.bar -> 0.U\n  )\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"//Not this...\nelaborate(new Module {\n  val hardware = Wire(new MyBundle(3))\n  val crash = hardware.Lit(\n    _.foo -> 0.U,\n    _.bar -> 0.U\n  )\n})\n// chisel3.package$ExpectedChiselTypeException: bundle literal constructor model '_52_Anon.hardware: Wire[MyBundle]' must be a Chisel type, not hardware\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56$$anonfun$apply$55.apply(chisel-type-vs-scala-type.md:206)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56.apply(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13$$anonfun$56.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52$$anon$13.<init>(chisel-type-vs-scala-type.md:206)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:204)\n// \tat repl.MdocSession$MdocApp$$anonfun$54$$anonfun$apply$52.apply(chisel-type-vs-scala-type.md:204)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only use a Chisel type within a ",(0,l.jsx)(e.code,{children:"Bundle"})," definition:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val hardware = Wire(new Bundle {\n    val nested = new MyBundle(3)\n  })\n  hardware := DontCare\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\n  val crash = Wire(new Bundle {\n    val nested = Wire(new MyBundle(3))\n  })\n})\n// chisel3.package$ExpectedChiselTypeException: Bundle: AnonymousBundle contains hardware fields: nested: _60_Anon.crash_nested: Wire[MyBundle]\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62$$anonfun$apply$61.apply(chisel-type-vs-scala-type.md:232)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62.apply(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16$$anonfun$62.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60$$anon$16.<init>(chisel-type-vs-scala-type.md:232)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:231)\n// \tat repl.MdocSession$MdocApp$$anonfun$61$$anonfun$apply$60.apply(chisel-type-vs-scala-type.md:231)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\n// \tat logger.Logger$.$anonfun$makeScope$4(Logger.scala:148)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat logger.Logger$.makeScope(Logger.scala:146)\n// \tat logger.Logger$.makeScope(Logger.scala:133)\n// \tat ... ()\n// \tat ... (Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace)\n"})}),"\n",(0,l.jsxs)(e.p,{children:["Can only call ",(0,l.jsx)(e.code,{children:"directionOf"})," on Hardware:"]}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"import chisel3.reflect.DataMirror\n\nclass Child extends Module{\n  val hardware = IO(new MyBundle(3))\n  hardware := DontCare\n  val chiselType = new MyBundle(3)\n}\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Do this...\nelaborate(new Module {\n  val child = Module(new Child())\n  child.hardware := DontCare\n  val direction = DataMirror.directionOf(child.hardware)\n})\n"})}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-scala",children:"// Not this...\nelaborate(new Module {\nval child = Module(new Child())\n  child.hardware := DontCare\n  val direction = DataMirror.directionOf(child.chiselType)\n})\n// chisel3.package$ExpectedHardwareException: node requested directionality on 'MyBundle' must be hardware, not a bare Chisel type. Perhaps you forgot to wrap it in Wire(_) or IO(_)?\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68$$anon$19.<init>(chisel-type-vs-scala-type.md:271)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:268)\n// \tat repl.MdocSession$MdocApp$$anonfun$70$$anonfun$apply$68.apply(chisel-type-vs-scala-type.md:268)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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 @5a83c515)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.SpecifiedDirection$.specifiedDirection(Data.scala:75)\n// \tat chisel3.Output$.apply(Data.scala:314)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(Module.scala:878)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md)\n// \tat chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)\n// \tat repl.MdocSession$MdocApp$ScalaCastingModule.<init>(chisel-type-vs-scala-type.md:293)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)\n// \tat repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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\nChiselStage.emitSystemVerilog(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.78.1\n// module _82_Anon(\t// chisel-type-vs-scala-type.md:323:47\n//   input        clock,\t// chisel-type-vs-scala-type.md:323:47\n//                reset,\t// chisel-type-vs-scala-type.md:323:47\n//   input  [2:0] in_foo,\t// chisel-type-vs-scala-type.md:324:14\n//                in_bar,\t// chisel-type-vs-scala-type.md:324:14\n//   output [5:0] out_foobar\t// chisel-type-vs-scala-type.md:325:15\n// );\n// \n//   assign out_foobar = {in_foo, in_bar};\t// chisel-type-vs-scala-type.md:323:47, :327:21\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 $(a={}){const{wrapper:e}={...(0,t.R)(),...a.components};return e?(0,l.jsx)(e,{...a,children:(0,l.jsx)(p,{...a})}):p(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.9b2321cf.js b/assets/js/7e1e4a75.1897c8b8.js
similarity index 91%
rename from assets/js/7e1e4a75.9b2321cf.js
rename to assets/js/7e1e4a75.1897c8b8.js
index 75d60c61aef..38d807fe0fd 100644
--- a/assets/js/7e1e4a75.9b2321cf.js
+++ b/assets/js/7e1e4a75.1897c8b8.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[5432],{9730:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>c,toc:()=>d});var t=o(4848),a=o(8453),i=o(1871);const l={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:"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",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{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","\n",(0,t.jsx)(i.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._\nimport circt.stage.ChiselStage\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\nChiselStage.emitSystemVerilog(new Foo(new MyBundle))\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 (bar,foo)\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:301)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:301)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md:301)\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:301)\n// \tat repl.MdocSession$MdocApp17$$anonfun$55$$anonfun$apply$43.apply(cookbook.md:320)\n// \tat repl.MdocSession$MdocApp17$$anonfun$55$$anonfun$apply$43.apply(cookbook.md:320)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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 (foo,gen)\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:301)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:301)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md:301)\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:301)\n// \tat repl.MdocSession$MdocApp17$$anonfun$57$$anonfun$apply$44.apply(cookbook.md:339)\n// \tat repl.MdocSession$MdocApp17$$anonfun$57$$anonfun$apply$44.apply(cookbook.md:339)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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:"getVerilogString(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 'foo' 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:370)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51$$anonfun$apply$52.apply(cookbook.md:370)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(Module.scala:878)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51.apply(cookbook.md:370)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51.apply(cookbook.md:370)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62.apply(cookbook.md:370)\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:370)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$$anonfun$apply$55.apply(cookbook.md:372)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$$anonfun$apply$55.apply(cookbook.md:372)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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:"getVerilogString(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:444)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74$$anonfun$apply$63.apply(cookbook.md:444)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74.apply(cookbook.md:444)\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:444)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$$anonfun$apply$67.apply(cookbook.md:449)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$$anonfun$apply$67.apply(cookbook.md:449)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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._\nimport circt.stage.ChiselStage\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:589)\n// \tat repl.MdocSession$MdocApp26$$anonfun$104$$anonfun$apply$90.apply(cookbook.md:597)\n// \tat repl.MdocSession$MdocApp26$$anonfun$104$$anonfun$apply$90.apply(cookbook.md:597)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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.78.1\nmodule MyModule(\t// cookbook.md:691:7\n  input        clock,\t// cookbook.md:691:7\n               reset,\t// cookbook.md:691:7\n  input  [7:0] in,\t// cookbook.md:692:14\n  output [7:0] out\t// cookbook.md:693:15\n);\n\n  assign out = in + 8'h1;\t// cookbook.md:691:7, :695:13\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.78.1\nmodule MyModule(\t// cookbook.md:720:7\n  input        clock,\t// cookbook.md:720:7\n               reset,\t// cookbook.md:720:7\n  input  [7:0] foo,\t// cookbook.md:721:18\n  output [7:0] bar\t// cookbook.md:721:18\n);\n\n  assign bar = foo + 8'h1;\t// cookbook.md:720:7, :723:20\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.78.1\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.78.1\nmodule CountBits(\t// cookbook.md:780:7\n  input  [3:0] bits,\t// cookbook.md:781:16\n  output [2:0] countVector_0,\t// cookbook.md:782:23\n               countVector_1,\t// cookbook.md:782:23\n               countVector_2,\t// cookbook.md:782:23\n               countVector_3\t// cookbook.md:782:23\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 829: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 855: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:"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.78.1\nmodule Foo(\t// cookbook.md:933:7\n  input        clock,\t// cookbook.md:933:7\n               reset,\t// cookbook.md:933:7\n               io_in_0,\t// cookbook.md:934:14\n               io_in_1,\t// cookbook.md:934:14\n               io_in_2,\t// cookbook.md:934:14\n               io_in_3,\t// cookbook.md:934:14\n  input  [1:0] io_idx,\t// cookbook.md:934:14\n  input        io_en,\t// cookbook.md:934:14\n  output       io_out\t// cookbook.md:934:14\n);\n\n  wire [3:0] _GEN = {{io_in_3}, {io_in_2}, {io_in_1}, {io_in_0}};\t// cookbook.md:942:13\n  assign io_out = _GEN[io_idx] & io_en;\t// cookbook.md:933:7, :942:13\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.78.1\nmodule Foo2(\t// cookbook.md:956:7\n  input        clock,\t// cookbook.md:956:7\n               reset,\t// cookbook.md:956:7\n               io_in_0,\t// cookbook.md:957:14\n               io_in_1,\t// cookbook.md:957:14\n               io_in_2,\t// cookbook.md:957:14\n               io_in_3,\t// cookbook.md:957:14\n  input  [1:0] io_idx,\t// cookbook.md:957:14\n  input        io_en,\t// cookbook.md:957:14\n  output       io_out\t// cookbook.md:957:14\n);\n\n  wire [3:0] _GEN = {{io_in_3}, {io_in_2}, {io_in_1}, {io_in_0}};\t// cookbook.md:964:19\n  assign io_out = _GEN[io_idx] & io_en;\t// cookbook.md:956:7, :964:19, :965:13\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.78.1\n// external module Tea\n\nmodule SodiumMonochloride(\t// cookbook.md:994:7\n  input clock,\t// cookbook.md:994:7\n        reset\t// cookbook.md:994:7\n);\n\n  Tea drink (\t// cookbook.md:996:23\n    .I (32'h2A),\n    .O (/* unused */)\n  );\t// cookbook.md:996:23\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 circt.stage.ChiselStage\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:"ChiselStage.emitSystemVerilog(new BadRegConnect)\n// circt.stage.phases.Exceptions$FirtoolNonZeroExitCode: /home/runner/.cache/llvm-firtool/1.78.1/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+9-7bf8b596-SNAPSHOT) was published against firtool version 1.78.1.\n// ------------------------------------------------------------------------------\n// ExitCode:\n// 1\n// STDOUT:\n// \n// STDERR:\n// cookbook.md:1029: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:1029: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 circt.stage.ChiselStage\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,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1871:(e,n,o)=>{o.d(n,{A:()=>l});o(6540);var t=o(5195);const a={tableOfContentsInline:"tableOfContentsInline_prmo"};var i=o(4848);function l(e){let{toc:n,minHeadingLevel:o,maxHeadingLevel:l}=e;return(0,i.jsx)("div",{className:a.tableOfContentsInline,children:(0,i.jsx)(t.A,{toc:n,minHeadingLevel:o,maxHeadingLevel:l,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,o)=>{o.d(n,{A:()=>g});var t=o(6540),a=o(6342);function i(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),o=Array(7).fill(-1);n.forEach(((e,n)=>{const t=o.slice(2,e.level);e.parentIndex=Math.max(...t),o[e.level]=n}));const t=[];return n.forEach((e=>{const{parentIndex:o,...a}=e;o>=0?n[o].children.push(a):t.push(a)})),t}function l(e){let{toc:n,minHeadingLevel:o,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=l({toc:e.children,minHeadingLevel:o,maxHeadingLevel:t});return function(e){return e.level>=o&&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:o}=n;const t=e.find((e=>s(e).top>=o));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,a.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),o=r();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:a,minHeadingLevel:i,maxHeadingLevel:l}=e;function s(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),s=function(e){let{minHeadingLevel:n,maxHeadingLevel:o}=e;const t=[];for(let a=n;a<=o;a+=1)t.push(`h${a}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:i,maxHeadingLevel:l}),r=c(s,{anchorTopOffset:o.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,o){o?(n.current&&n.current!==e&&n.current.classList.remove(a),e.classList.add(a),n.current=e):e.classList.remove(a)}(e,e===d)}))}return document.addEventListener("scroll",s),document.addEventListener("resize",s),s(),()=>{document.removeEventListener("scroll",s),document.removeEventListener("resize",s)}}),[e,o])}var u=o(8774),h=o(4848);function p(e){let{toc:n,className:o,linkClassName:t,isChild:a}=e;return n.length?(0,h.jsx)("ul",{className:a?void 0:o,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:o,linkClassName:t})]},e.id)))}):null}const m=t.memo(p);function g(e){let{toc:n,className:o="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,a.p)(),x=r??g.tableOfContents.minHeadingLevel,f=u??g.tableOfContents.maxHeadingLevel,w=function(e){let{toc:n,minHeadingLevel:o,maxHeadingLevel:a}=e;return(0,t.useMemo)((()=>l({toc:i(n),minHeadingLevel:o,maxHeadingLevel:a})),[n,o,a])}({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:o,linkClassName:s,...p})}},8453:(e,n,o)=>{o.d(n,{R:()=>l,x:()=>s});var t=o(6540);const a={},i=t.createContext(a);function l(e){const n=t.useContext(i);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(a):e.components||a:l(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[5432],{9730:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>c,toc:()=>d});var t=o(4848),a=o(8453),i=o(1871);const l={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:"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",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{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","\n",(0,t.jsx)(i.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._\nimport circt.stage.ChiselStage\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\nChiselStage.emitSystemVerilog(new Foo(new MyBundle))\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 (bar,foo)\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:301)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:301)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md:301)\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:301)\n// \tat repl.MdocSession$MdocApp17$$anonfun$55$$anonfun$apply$43.apply(cookbook.md:320)\n// \tat repl.MdocSession$MdocApp17$$anonfun$55$$anonfun$apply$43.apply(cookbook.md:320)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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 (foo,gen)\n// \tat ... ()\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:301)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50$$anonfun$apply$37.apply(cookbook.md:301)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$Top$$anonfun$50.apply(cookbook.md:301)\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:301)\n// \tat repl.MdocSession$MdocApp17$$anonfun$57$$anonfun$apply$44.apply(cookbook.md:339)\n// \tat repl.MdocSession$MdocApp17$$anonfun$57$$anonfun$apply$44.apply(cookbook.md:339)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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:"getVerilogString(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 'foo' 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:370)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51$$anonfun$apply$52.apply(cookbook.md:370)\n// \tat chisel3.IO$.apply(IO.scala:34)\n// \tat chisel3.experimental.BaseModule.IO(Module.scala:878)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51.apply(cookbook.md:370)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62$$anonfun$apply$51.apply(cookbook.md:370)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$MisusedFunctionArguments$1$$anonfun$62.apply(cookbook.md:370)\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:370)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$$anonfun$apply$55.apply(cookbook.md:372)\n// \tat repl.MdocSession$MdocApp17$$anonfun$59$$anonfun$apply$55.apply(cookbook.md:372)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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:"getVerilogString(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:444)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74$$anonfun$apply$63.apply(cookbook.md:444)\n// \tat chisel3.experimental.prefix$.apply(prefix.scala:50)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$NewModule$1$$anonfun$74.apply(cookbook.md:444)\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:444)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$$anonfun$apply$67.apply(cookbook.md:449)\n// \tat repl.MdocSession$MdocApp17$$anonfun$70$$anonfun$apply$67.apply(cookbook.md:449)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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._\nimport circt.stage.ChiselStage\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:589)\n// \tat repl.MdocSession$MdocApp26$$anonfun$104$$anonfun$apply$90.apply(cookbook.md:597)\n// \tat repl.MdocSession$MdocApp26$$anonfun$104$$anonfun$apply$90.apply(cookbook.md:597)\n// \tat chisel3.Module$.evaluate(Module.scala:94)\n// \tat chisel3.Module$.do_apply(Module.scala:37)\n// \tat chisel3.stage.phases.Elaborate.$anonfun$transform$2(Elaborate.scala:53)\n// \tat chisel3.internal.Builder$.$anonfun$buildImpl$1(Builder.scala:1072)\n// \tat scala.util.DynamicVariable.withValue(DynamicVariable.scala:59)\n// \tat chisel3.internal.Builder$.buildImpl(Builder.scala:1062)\n// \tat chisel3.internal.Builder$.$anonfun$build$1(Builder.scala:1054)\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.78.1\nmodule MyModule(\t// cookbook.md:691:7\n  input        clock,\t// cookbook.md:691:7\n               reset,\t// cookbook.md:691:7\n  input  [7:0] in,\t// cookbook.md:692:14\n  output [7:0] out\t// cookbook.md:693:15\n);\n\n  assign out = in + 8'h1;\t// cookbook.md:691:7, :695:13\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.78.1\nmodule MyModule(\t// cookbook.md:720:7\n  input        clock,\t// cookbook.md:720:7\n               reset,\t// cookbook.md:720:7\n  input  [7:0] foo,\t// cookbook.md:721:18\n  output [7:0] bar\t// cookbook.md:721:18\n);\n\n  assign bar = foo + 8'h1;\t// cookbook.md:720:7, :723:20\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.78.1\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.78.1\nmodule CountBits(\t// cookbook.md:780:7\n  input  [3:0] bits,\t// cookbook.md:781:16\n  output [2:0] countVector_0,\t// cookbook.md:782:23\n               countVector_1,\t// cookbook.md:782:23\n               countVector_2,\t// cookbook.md:782:23\n               countVector_3\t// cookbook.md:782:23\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 829: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 855: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:"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.78.1\nmodule Foo(\t// cookbook.md:933:7\n  input        clock,\t// cookbook.md:933:7\n               reset,\t// cookbook.md:933:7\n               io_in_0,\t// cookbook.md:934:14\n               io_in_1,\t// cookbook.md:934:14\n               io_in_2,\t// cookbook.md:934:14\n               io_in_3,\t// cookbook.md:934:14\n  input  [1:0] io_idx,\t// cookbook.md:934:14\n  input        io_en,\t// cookbook.md:934:14\n  output       io_out\t// cookbook.md:934:14\n);\n\n  wire [3:0] _GEN = {{io_in_3}, {io_in_2}, {io_in_1}, {io_in_0}};\t// cookbook.md:942:13\n  assign io_out = _GEN[io_idx] & io_en;\t// cookbook.md:933:7, :942:13\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.78.1\nmodule Foo2(\t// cookbook.md:956:7\n  input        clock,\t// cookbook.md:956:7\n               reset,\t// cookbook.md:956:7\n               io_in_0,\t// cookbook.md:957:14\n               io_in_1,\t// cookbook.md:957:14\n               io_in_2,\t// cookbook.md:957:14\n               io_in_3,\t// cookbook.md:957:14\n  input  [1:0] io_idx,\t// cookbook.md:957:14\n  input        io_en,\t// cookbook.md:957:14\n  output       io_out\t// cookbook.md:957:14\n);\n\n  wire [3:0] _GEN = {{io_in_3}, {io_in_2}, {io_in_1}, {io_in_0}};\t// cookbook.md:964:19\n  assign io_out = _GEN[io_idx] & io_en;\t// cookbook.md:956:7, :964:19, :965:13\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.78.1\n// external module Tea\n\nmodule SodiumMonochloride(\t// cookbook.md:994:7\n  input clock,\t// cookbook.md:994:7\n        reset\t// cookbook.md:994:7\n);\n\n  Tea drink (\t// cookbook.md:996:23\n    .I (32'h2A),\n    .O (/* unused */)\n  );\t// cookbook.md:996:23\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 circt.stage.ChiselStage\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:"ChiselStage.emitSystemVerilog(new BadRegConnect)\n// circt.stage.phases.Exceptions$FirtoolNonZeroExitCode: /home/runner/.cache/llvm-firtool/1.78.1/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+10-68aec539-SNAPSHOT) was published against firtool version 1.78.1.\n// ------------------------------------------------------------------------------\n// ExitCode:\n// 1\n// STDOUT:\n// \n// STDERR:\n// cookbook.md:1029: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:1029: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 circt.stage.ChiselStage\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,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},1871:(e,n,o)=>{o.d(n,{A:()=>l});o(6540);var t=o(5195);const a={tableOfContentsInline:"tableOfContentsInline_prmo"};var i=o(4848);function l(e){let{toc:n,minHeadingLevel:o,maxHeadingLevel:l}=e;return(0,i.jsx)("div",{className:a.tableOfContentsInline,children:(0,i.jsx)(t.A,{toc:n,minHeadingLevel:o,maxHeadingLevel:l,className:"table-of-contents",linkClassName:null})})}},5195:(e,n,o)=>{o.d(n,{A:()=>g});var t=o(6540),a=o(6342);function i(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),o=Array(7).fill(-1);n.forEach(((e,n)=>{const t=o.slice(2,e.level);e.parentIndex=Math.max(...t),o[e.level]=n}));const t=[];return n.forEach((e=>{const{parentIndex:o,...a}=e;o>=0?n[o].children.push(a):t.push(a)})),t}function l(e){let{toc:n,minHeadingLevel:o,maxHeadingLevel:t}=e;return n.flatMap((e=>{const n=l({toc:e.children,minHeadingLevel:o,maxHeadingLevel:t});return function(e){return e.level>=o&&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:o}=n;const t=e.find((e=>s(e).top>=o));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,a.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),o=r();(0,t.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:t,linkActiveClassName:a,minHeadingLevel:i,maxHeadingLevel:l}=e;function s(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(t),s=function(e){let{minHeadingLevel:n,maxHeadingLevel:o}=e;const t=[];for(let a=n;a<=o;a+=1)t.push(`h${a}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:i,maxHeadingLevel:l}),r=c(s,{anchorTopOffset:o.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,o){o?(n.current&&n.current!==e&&n.current.classList.remove(a),e.classList.add(a),n.current=e):e.classList.remove(a)}(e,e===d)}))}return document.addEventListener("scroll",s),document.addEventListener("resize",s),s(),()=>{document.removeEventListener("scroll",s),document.removeEventListener("resize",s)}}),[e,o])}var u=o(8774),h=o(4848);function p(e){let{toc:n,className:o,linkClassName:t,isChild:a}=e;return n.length?(0,h.jsx)("ul",{className:a?void 0:o,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:o,linkClassName:t})]},e.id)))}):null}const m=t.memo(p);function g(e){let{toc:n,className:o="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,a.p)(),x=r??g.tableOfContents.minHeadingLevel,f=u??g.tableOfContents.maxHeadingLevel,w=function(e){let{toc:n,minHeadingLevel:o,maxHeadingLevel:a}=e;return(0,t.useMemo)((()=>l({toc:i(n),minHeadingLevel:o,maxHeadingLevel:a})),[n,o,a])}({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:o,linkClassName:s,...p})}},8453:(e,n,o)=>{o.d(n,{R:()=>l,x:()=>s});var t=o(6540);const a={},i=t.createContext(a);function l(e){const n=t.useContext(i);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(a):e.components||a:l(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/868241d3.79baa747.js b/assets/js/868241d3.79baa747.js
new file mode 100644
index 00000000000..0ee81152e1c
--- /dev/null
+++ b/assets/js/868241d3.79baa747.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[9017],{7333:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>r});var c=s(4848),t=s(8453);const i={},a=void 0,l={type:"mdx",permalink:"/generated/scaladoc_links",source:"@site/src/pages/generated/scaladoc_links.md",description:"- Latest (6.5.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.5.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+10-68aec539-SNAPSHOT/chisel_2.13-7.0.0-M2+10-68aec539-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.5.0",children:"6.5.0"})}),"\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/5.3.0",children:"5.3.0"})}),"\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.6.1",children:"3.6.1"})}),"\n",(0,c.jsx)(n.li,{children:(0,c.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.5.6",children:"3.5.6"})}),"\n"]})}function d(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>l});var c=s(6540);const t={},i=c.createContext(t);function a(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/868241d3.7d913b71.js b/assets/js/868241d3.7d913b71.js
deleted file mode 100644
index 7730d640ae1..00000000000
--- a/assets/js/868241d3.7d913b71.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[9017],{7333:(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.5.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.5.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+9-7bf8b596-SNAPSHOT/chisel_2.13-7.0.0-M2+9-7bf8b596-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.5.0",children:"6.5.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/98ca0ee0.58acb062.js b/assets/js/98ca0ee0.0cde3570.js
similarity index 57%
rename from assets/js/98ca0ee0.58acb062.js
rename to assets/js/98ca0ee0.0cde3570.js
index b81a81ed08b..db2627ea772 100644
--- a/assets/js/98ca0ee0.58acb062.js
+++ b/assets/js/98ca0ee0.0cde3570.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[8946,9017],{5893:(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(7333);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}];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)}},7333:(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.5.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.5.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+9-7bf8b596-SNAPSHOT/chisel_2.13-7.0.0-M2+9-7bf8b596-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.5.0",children:"6.5.0"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/5.3.0",children:"5.3.0"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.6.1",children:"3.6.1"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.5.6",children:"3.5.6"})}),"\n"]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const i={},c=s.createContext(i);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[]).push([[8946,9017],{5893:(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(7333);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}];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)}},7333:(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.5.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.5.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+10-68aec539-SNAPSHOT/chisel_2.13-7.0.0-M2+10-68aec539-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.5.0",children:"6.5.0"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/org.chipsalliance/chisel_2.13/5.3.0",children:"5.3.0"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.6.1",children:"3.6.1"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.5.6",children:"3.5.6"})}),"\n"]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const i={},c=s.createContext(i);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/runtime~main.c232c68c.js b/assets/js/runtime~main.839beab8.js
similarity index 93%
rename from assets/js/runtime~main.c232c68c.js
rename to assets/js/runtime~main.839beab8.js
index c7243bf6284..46e93b24ee8 100644
--- a/assets/js/runtime~main.c232c68c.js
+++ b/assets/js/runtime~main.839beab8.js
@@ -1 +1 @@
-(()=>{"use strict";var e,a,d,b,c,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={exports:{}};return f[e].call(d.exports,d,d.exports,r),d.exports}r.m=f,e=[],r.O=(a,d,b,c)=>{if(!d){var f=1/0;for(i=0;i<e.length;i++){d=e[i][0],b=e[i][1],c=e[i][2];for(var t=!0,o=0;o<d.length;o++)(!1&c||f>=c)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,c<f&&(f=c));if(t){e.splice(i--,1);var n=b();void 0!==n&&(a=n)}}return a}c=c||0;for(var i=e.length;i>0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[d,b,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var f={};a=a||[null,d({}),d([]),d(d)];for(var t=2&b&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(c,f),c},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({340:"c5561474",741:"1ce89024",1108:"bc33eb1f",1188:"e7b22fe0",1281:"d50fb5c7",1357:"87b43d15",1384:"8fdf13ba",1596:"f416550b",1921:"2024159c",1979:"9cfbec6b",2012:"f10ce86b",2138:"1a4e3797",2289:"916cecd1",2504:"54ab625b",2579:"9cc76f42",2634:"c4f5d8e4",2785:"7b5bfa87",3117:"a26328e3",3126:"cddf45a4",3130:"3afb3224",3291:"7cc2f0dc",3313:"a8f82c73",3316:"c48de377",3460:"a98e3d7d",3543:"96d1adfe",3599:"30c88dbf",4020:"44ff0b81",4166:"d4b6d0e6",4286:"11a69d4a",4315:"651e9e03",4825:"44147ff4",4863:"d1e6e3d8",5056:"ae8e96e2",5432:"7e1e4a75",5497:"46a40f56",5522:"cdcdfbab",5540:"d1a7dbc9",5583:"f901c241",5666:"0bba5ab0",5742:"c377a04b",6061:"1f391b9e",6067:"1f7682ec",6259:"556f9cb0",6304:"21d75435",6403:"d1a683e4",6474:"c7666d49",6709:"c3800170",6760:"11d458a9",6803:"3b8c55ea",6969:"14eb3368",6991:"37a5b604",7087:"1883c3a9",7098:"a7bd4aaa",7132:"67ffb541",7315:"407ce553",7425:"a47e47c7",7437:"adf02ec5",8118:"6559d260",8227:"19ad7e9f",8316:"17dd133b",8401:"17896441",8485:"806d4637",8507:"b13aa1a2",8581:"935f2afb",8864:"d92a3c43",8946:"98ca0ee0",9017:"868241d3",9048:"a94703ab",9128:"7fa9ea57",9387:"c71a47e4",9647:"5e95c892",9670:"87ed036d",9710:"bc089483",9920:"6a9619ba",9942:"12b2b068"}[e]||e)+"."+{340:"2a86726f",416:"d5c32938",741:"08956ad2",1108:"73a85b4c",1188:"b37becdb",1281:"731f5350",1357:"17470d5c",1384:"79f03779",1596:"1ceba669",1921:"ea204555",1979:"e4e33567",2012:"2096bdf4",2138:"09d5ffe5",2237:"c1ab8b5a",2289:"530d5b66",2504:"c8a6834c",2579:"d67bb198",2634:"c5377180",2785:"2c05436e",3117:"4386600b",3126:"0e9d453a",3130:"46c05042",3291:"0c23ed75",3313:"f51db01c",3316:"2657941c",3460:"1c5a22d0",3543:"d8496b98",3599:"d8d7e9aa",3794:"35034f12",4020:"5cf60c66",4166:"547803d5",4286:"5282e6c7",4315:"4851e79f",4825:"994c2df0",4863:"abbdfa9b",5056:"ed5a202a",5432:"9b2321cf",5497:"f792daf2",5522:"a605fbae",5540:"58654cac",5583:"b056d9a6",5666:"1e7c9e57",5742:"ee2a24ca",6061:"9d3ff995",6067:"0fceaace",6259:"3363753d",6304:"5e682e30",6403:"1f47dcec",6474:"bb195891",6709:"9ba42d11",6760:"670d958e",6803:"1f5fc799",6969:"0bcc7e8d",6991:"a9655923",7087:"96db2d80",7098:"fb8f4b1d",7132:"9800d031",7315:"63eddd57",7425:"46016d7a",7437:"4a2fd9ba",8118:"c7ffc560",8158:"887a29fb",8227:"e5504390",8316:"a1e1e39e",8401:"19366d16",8485:"e8db32ed",8507:"b458ceda",8581:"65df0442",8864:"f3c5be57",8913:"eae5cfc0",8946:"58acb062",9017:"7d913b71",9048:"ca12ef2b",9128:"cb82e05b",9387:"dff32f23",9647:"539b71e6",9670:"550cd114",9710:"071ce7a7",9920:"74a4701a",9942:"027aa455"}[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),b={},c="chisel-lang:",r.l=(e,a,d,f)=>{if(b[e])b[e].push(a);else{var t,o;if(void 0!==d)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")==c+d){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",c+d),t.src=e),b[e]=[a];var u=(a,d)=>{t.onerror=t.onload=null,clearTimeout(s);var c=b[e];if(delete b[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(d))),a)return a(d)},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","1ce89024":"741",bc33eb1f:"1108",e7b22fe0:"1188",d50fb5c7:"1281","87b43d15":"1357","8fdf13ba":"1384",f416550b:"1596","2024159c":"1921","9cfbec6b":"1979",f10ce86b:"2012","1a4e3797":"2138","916cecd1":"2289","54ab625b":"2504","9cc76f42":"2579",c4f5d8e4:"2634","7b5bfa87":"2785",a26328e3:"3117",cddf45a4:"3126","3afb3224":"3130","7cc2f0dc":"3291",a8f82c73:"3313",c48de377:"3316",a98e3d7d:"3460","96d1adfe":"3543","30c88dbf":"3599","44ff0b81":"4020",d4b6d0e6:"4166","11a69d4a":"4286","651e9e03":"4315","44147ff4":"4825",d1e6e3d8:"4863",ae8e96e2:"5056","7e1e4a75":"5432","46a40f56":"5497",cdcdfbab:"5522",d1a7dbc9:"5540",f901c241:"5583","0bba5ab0":"5666",c377a04b:"5742","1f391b9e":"6061","1f7682ec":"6067","556f9cb0":"6259","21d75435":"6304",d1a683e4:"6403",c7666d49:"6474",c3800170:"6709","11d458a9":"6760","3b8c55ea":"6803","14eb3368":"6969","37a5b604":"6991","1883c3a9":"7087",a7bd4aaa:"7098","67ffb541":"7132","407ce553":"7315",a47e47c7:"7425",adf02ec5:"7437","6559d260":"8118","19ad7e9f":"8227","17dd133b":"8316","806d4637":"8485",b13aa1a2:"8507","935f2afb":"8581",d92a3c43:"8864","98ca0ee0":"8946","868241d3":"9017",a94703ab:"9048","7fa9ea57":"9128",c71a47e4:"9387","5e95c892":"9647","87ed036d":"9670",bc089483:"9710","6a9619ba":"9920","12b2b068":"9942"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,d)=>{var b=r.o(e,a)?e[a]:void 0;if(0!==b)if(b)d.push(b[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var c=new Promise(((d,c)=>b=e[a]=[d,c]));d.push(b[2]=c);var f=r.p+r.u(a),t=new Error;r.l(f,(d=>{if(r.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var c=d&&("load"===d.type?"missing":d.type),f=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+f+")",t.name="ChunkLoadError",t.type=c,t.request=f,b[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var b,c,f=d[0],t=d[1],o=d[2],n=0;if(f.some((a=>0!==e[a]))){for(b in t)r.o(t,b)&&(r.m[b]=t[b]);if(o)var i=o(r)}for(a&&a(d);n<f.length;n++)c=f[n],r.o(e,c)&&e[c]&&e[c][0](),e[c]=0;return r.O(i)},d=self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[];d.forEach(a.bind(null,0)),d.push=a.bind(null,d.push.bind(d))})()})();
\ No newline at end of file
+(()=>{"use strict";var e,a,d,b,c,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={exports:{}};return f[e].call(d.exports,d,d.exports,r),d.exports}r.m=f,e=[],r.O=(a,d,b,c)=>{if(!d){var f=1/0;for(i=0;i<e.length;i++){d=e[i][0],b=e[i][1],c=e[i][2];for(var t=!0,o=0;o<d.length;o++)(!1&c||f>=c)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,c<f&&(f=c));if(t){e.splice(i--,1);var n=b();void 0!==n&&(a=n)}}return a}c=c||0;for(var i=e.length;i>0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[d,b,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var f={};a=a||[null,d({}),d([]),d(d)];for(var t=2&b&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(c,f),c},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({340:"c5561474",741:"1ce89024",1108:"bc33eb1f",1188:"e7b22fe0",1281:"d50fb5c7",1357:"87b43d15",1384:"8fdf13ba",1596:"f416550b",1921:"2024159c",1979:"9cfbec6b",2012:"f10ce86b",2138:"1a4e3797",2289:"916cecd1",2504:"54ab625b",2579:"9cc76f42",2634:"c4f5d8e4",2785:"7b5bfa87",3117:"a26328e3",3126:"cddf45a4",3130:"3afb3224",3291:"7cc2f0dc",3313:"a8f82c73",3316:"c48de377",3460:"a98e3d7d",3543:"96d1adfe",3599:"30c88dbf",4020:"44ff0b81",4166:"d4b6d0e6",4286:"11a69d4a",4315:"651e9e03",4825:"44147ff4",4863:"d1e6e3d8",5056:"ae8e96e2",5432:"7e1e4a75",5497:"46a40f56",5522:"cdcdfbab",5540:"d1a7dbc9",5583:"f901c241",5666:"0bba5ab0",5742:"c377a04b",6061:"1f391b9e",6067:"1f7682ec",6259:"556f9cb0",6304:"21d75435",6403:"d1a683e4",6474:"c7666d49",6709:"c3800170",6760:"11d458a9",6803:"3b8c55ea",6969:"14eb3368",6991:"37a5b604",7087:"1883c3a9",7098:"a7bd4aaa",7132:"67ffb541",7315:"407ce553",7425:"a47e47c7",7437:"adf02ec5",8118:"6559d260",8227:"19ad7e9f",8316:"17dd133b",8401:"17896441",8485:"806d4637",8507:"b13aa1a2",8581:"935f2afb",8864:"d92a3c43",8946:"98ca0ee0",9017:"868241d3",9048:"a94703ab",9128:"7fa9ea57",9387:"c71a47e4",9647:"5e95c892",9670:"87ed036d",9710:"bc089483",9920:"6a9619ba",9942:"12b2b068"}[e]||e)+"."+{340:"2a86726f",416:"d5c32938",741:"335f922c",1108:"73a85b4c",1188:"b37becdb",1281:"731f5350",1357:"17470d5c",1384:"79f03779",1596:"1ceba669",1921:"ea204555",1979:"e4e33567",2012:"2096bdf4",2138:"09d5ffe5",2237:"c1ab8b5a",2289:"530d5b66",2504:"c8a6834c",2579:"d67bb198",2634:"c5377180",2785:"82a0116c",3117:"4386600b",3126:"0e9d453a",3130:"46c05042",3291:"0c23ed75",3313:"f51db01c",3316:"2657941c",3460:"1c5a22d0",3543:"d8496b98",3599:"d8d7e9aa",3794:"35034f12",4020:"5cf60c66",4166:"547803d5",4286:"5282e6c7",4315:"4851e79f",4825:"994c2df0",4863:"abbdfa9b",5056:"ed5a202a",5432:"1897c8b8",5497:"f792daf2",5522:"a605fbae",5540:"58654cac",5583:"b056d9a6",5666:"1e7c9e57",5742:"ee2a24ca",6061:"9d3ff995",6067:"0fceaace",6259:"3363753d",6304:"5e682e30",6403:"1f47dcec",6474:"bb195891",6709:"9ba42d11",6760:"670d958e",6803:"1f5fc799",6969:"0bcc7e8d",6991:"a9655923",7087:"96db2d80",7098:"fb8f4b1d",7132:"9800d031",7315:"63eddd57",7425:"46016d7a",7437:"4a2fd9ba",8118:"c7ffc560",8158:"887a29fb",8227:"e5504390",8316:"a1e1e39e",8401:"19366d16",8485:"e8db32ed",8507:"b458ceda",8581:"65df0442",8864:"f3c5be57",8913:"eae5cfc0",8946:"0cde3570",9017:"79baa747",9048:"ca12ef2b",9128:"cb82e05b",9387:"dff32f23",9647:"539b71e6",9670:"550cd114",9710:"071ce7a7",9920:"74a4701a",9942:"027aa455"}[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),b={},c="chisel-lang:",r.l=(e,a,d,f)=>{if(b[e])b[e].push(a);else{var t,o;if(void 0!==d)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")==c+d){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",c+d),t.src=e),b[e]=[a];var u=(a,d)=>{t.onerror=t.onload=null,clearTimeout(s);var c=b[e];if(delete b[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(d))),a)return a(d)},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","1ce89024":"741",bc33eb1f:"1108",e7b22fe0:"1188",d50fb5c7:"1281","87b43d15":"1357","8fdf13ba":"1384",f416550b:"1596","2024159c":"1921","9cfbec6b":"1979",f10ce86b:"2012","1a4e3797":"2138","916cecd1":"2289","54ab625b":"2504","9cc76f42":"2579",c4f5d8e4:"2634","7b5bfa87":"2785",a26328e3:"3117",cddf45a4:"3126","3afb3224":"3130","7cc2f0dc":"3291",a8f82c73:"3313",c48de377:"3316",a98e3d7d:"3460","96d1adfe":"3543","30c88dbf":"3599","44ff0b81":"4020",d4b6d0e6:"4166","11a69d4a":"4286","651e9e03":"4315","44147ff4":"4825",d1e6e3d8:"4863",ae8e96e2:"5056","7e1e4a75":"5432","46a40f56":"5497",cdcdfbab:"5522",d1a7dbc9:"5540",f901c241:"5583","0bba5ab0":"5666",c377a04b:"5742","1f391b9e":"6061","1f7682ec":"6067","556f9cb0":"6259","21d75435":"6304",d1a683e4:"6403",c7666d49:"6474",c3800170:"6709","11d458a9":"6760","3b8c55ea":"6803","14eb3368":"6969","37a5b604":"6991","1883c3a9":"7087",a7bd4aaa:"7098","67ffb541":"7132","407ce553":"7315",a47e47c7:"7425",adf02ec5:"7437","6559d260":"8118","19ad7e9f":"8227","17dd133b":"8316","806d4637":"8485",b13aa1a2:"8507","935f2afb":"8581",d92a3c43:"8864","98ca0ee0":"8946","868241d3":"9017",a94703ab:"9048","7fa9ea57":"9128",c71a47e4:"9387","5e95c892":"9647","87ed036d":"9670",bc089483:"9710","6a9619ba":"9920","12b2b068":"9942"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,d)=>{var b=r.o(e,a)?e[a]:void 0;if(0!==b)if(b)d.push(b[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var c=new Promise(((d,c)=>b=e[a]=[d,c]));d.push(b[2]=c);var f=r.p+r.u(a),t=new Error;r.l(f,(d=>{if(r.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var c=d&&("load"===d.type?"missing":d.type),f=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+f+")",t.name="ChunkLoadError",t.type=c,t.request=f,b[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var b,c,f=d[0],t=d[1],o=d[2],n=0;if(f.some((a=>0!==e[a]))){for(b in t)r.o(t,b)&&(r.m[b]=t[b]);if(o)var i=o(r)}for(a&&a(d);n<f.length;n++)c=f[n],r.o(e,c)&&e[c]&&e[c][0](),e[c]=0;return r.O(i)},d=self.webpackChunkchisel_lang=self.webpackChunkchisel_lang||[];d.forEach(a.bind(null,0)),d.push=a.bind(null,d.push.bind(d))})()})();
\ No newline at end of file
diff --git a/community.html b/community.html
index 2f637df053b..535a477b562 100644
--- a/community.html
+++ b/community.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Community | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/community"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Community | Chisel"><meta data-rh="true" name="description" content="Chisel Users Community"><meta data-rh="true" property="og:description" content="Chisel Users Community"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/community"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/community" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/community" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs.html b/docs.html
index 3a3ccaab463..31ed453c147 100644
--- a/docs.html
+++ b/docs.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Introduction | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Introduction | Chisel"><meta data-rh="true" name="description" content="Chisel (Constructing"><meta data-rh="true" property="og:description" content="Chisel (Constructing"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix.html b/docs/appendix.html
index 0d6ac636faf..7019b6d8b43 100644
--- a/docs/appendix.html
+++ b/docs/appendix.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Appendix | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/appendix"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Appendix | Chisel"><meta data-rh="true" name="description" content="This section covers some less-common Chisel topics."><meta data-rh="true" property="og:description" content="This section covers some less-common Chisel topics."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/appendix"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 7d21ab8b7d5..6646be78bba 100644
--- a/docs/appendix/experimental-features.html
+++ b/docs/appendix/experimental-features.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Experimental Features | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/appendix/experimental-features"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Experimental Features | Chisel"><meta data-rh="true" name="description" content="Chisel has a number of new features that are worth checking out.  This page is an informal list of these features and projects."><meta data-rh="true" property="og:description" content="Chisel has a number of new features that are worth checking out.  This page is an informal list of these features and projects."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/appendix/experimental-features"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/experimental-features" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/experimental-features" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 0f7fb1a97e7..f2de6d9fc0e 100644
--- a/docs/appendix/migrating-from-chiseltest.html
+++ b/docs/appendix/migrating-from-chiseltest.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Migrating from ChiselTest | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/appendix/migrating-from-chiseltest"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Migrating from ChiselTest | Chisel"><meta data-rh="true" name="description" content="Background"><meta data-rh="true" property="og:description" content="Background"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/appendix/migrating-from-chiseltest"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/migrating-from-chiseltest" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/migrating-from-chiseltest" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 110e0cb6f5d..b313249ba32 100644
--- a/docs/appendix/upgrading-from-chisel-3-4.html
+++ b/docs/appendix/upgrading-from-chisel-3-4.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Upgrading From Chisel 3.4 to 3.5 | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/appendix/upgrading-from-chisel-3-4"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Upgrading From Chisel 3.4 to 3.5 | Chisel"><meta data-rh="true" name="description" content="Upgrading From Chisel 3.4 to 3.5"><meta data-rh="true" property="og:description" content="Upgrading From Chisel 3.4 to 3.5"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/appendix/upgrading-from-chisel-3-4"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/upgrading-from-chisel-3-4" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/upgrading-from-chisel-3-4" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 0d4a2781b4e..617a683f460 100644
--- a/docs/appendix/upgrading-from-scala-2-11.html
+++ b/docs/appendix/upgrading-from-scala-2-11.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Upgrading From Scala 2.11 | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/appendix/upgrading-from-scala-2-11"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Upgrading From Scala 2.11 | Chisel"><meta data-rh="true" name="description" content="Upgrading From Scala 2.11 to 2.12"><meta data-rh="true" property="og:description" content="Upgrading From Scala 2.11 to 2.12"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/appendix/upgrading-from-scala-2-11"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/upgrading-from-scala-2-11" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/upgrading-from-scala-2-11" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/appendix/versioning.html b/docs/appendix/versioning.html
index 2eeb1712d53..115cfea99fc 100644
--- a/docs/appendix/versioning.html
+++ b/docs/appendix/versioning.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Versioning | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/appendix/versioning"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Versioning | Chisel"><meta data-rh="true" name="description" content="Chisel follows Semantic Versioning 2.0.0."><meta data-rh="true" property="og:description" content="Chisel follows Semantic Versioning 2.0.0."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/appendix/versioning"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/versioning" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/appendix/versioning" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 7a0295899b4..0ee4c8d095b 100644
--- a/docs/category/getting-started.html
+++ b/docs/category/getting-started.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Getting Started | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/category/getting-started"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Getting Started | Chisel"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/category/getting-started"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/category/getting-started" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/category/getting-started" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks.html b/docs/cookbooks.html
index a0f4ddb5572..c57bbc2d2d8 100644
--- a/docs/cookbooks.html
+++ b/docs/cookbooks.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Cookbooks | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/cookbooks"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Cookbooks | Chisel"><meta data-rh="true" name="description" content="Welcome to the Chisel Cookbooks, where we capture frequently-used design patterns or troubleshooting questions."><meta data-rh="true" property="og:description" content="Welcome to the Chisel Cookbooks, where we capture frequently-used design patterns or troubleshooting questions."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/cookbooks"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/cookbook.html b/docs/cookbooks/cookbook.html
index 462a462e8d5..65d2076fdad 100644
--- a/docs/cookbooks/cookbook.html
+++ b/docs/cookbooks/cookbook.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">General Cookbook | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/cookbooks/cookbook"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="General Cookbook | Chisel"><meta data-rh="true" name="description" content="Please note that these examples make use of Chisel&#x27;s scala-style printing."><meta data-rh="true" property="og:description" content="Please note that these examples make use of Chisel&#x27;s scala-style printing."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/cookbooks/cookbook"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/cookbook" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/cookbook" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -210,7 +210,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">circt</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">stage</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">ChiselStage</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">ChiselStage</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">emitSystemVerilog</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> 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.78.1/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+9-7bf8b596-SNAPSHOT) was published against firtool version 1.78.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">// ------------------------------------------------------------------------------</span><span class="token plain"></span><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:1029: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:1029:20: note: see current operation: %4 = &quot;firrtl.reg&quot;(%arg0) {annotations = [], name = &quot;monitor&quot;, nameKind = #firrtl&lt;name_kind interesting_name&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">ChiselStage</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">emitSystemVerilog</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> 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.78.1/bin/firtool returned a non-zero exit code. Note that this version of Chisel (7.0.0-M2+10-68aec539-SNAPSHOT) was published against firtool version 1.78.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">// ------------------------------------------------------------------------------</span><span class="token plain"></span><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:1029: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:1029:20: note: see current operation: %4 = &quot;firrtl.reg&quot;(%arg0) {annotations = [], name = &quot;monitor&quot;, nameKind = #firrtl&lt;name_kind interesting_name&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 1982345fd02..03682ffe115 100644
--- a/docs/cookbooks/dataview.html
+++ b/docs/cookbooks/dataview.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">DataView Cookbook | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/cookbooks/dataview"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="DataView Cookbook | Chisel"><meta data-rh="true" name="description" content="How do I view a Data as a UInt or vice versa?"><meta data-rh="true" property="og:description" content="How do I view a Data as a UInt or vice versa?"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/cookbooks/dataview"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/dataview" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/dataview" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/hierarchy.html b/docs/cookbooks/hierarchy.html
index 35b7cf6b3f7..21896425f3d 100644
--- a/docs/cookbooks/hierarchy.html
+++ b/docs/cookbooks/hierarchy.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Hierarchy Cookbook | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/cookbooks/hierarchy"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Hierarchy Cookbook | Chisel"><meta data-rh="true" name="description" content="How do I instantiate multiple instances with the same module parameterization?"><meta data-rh="true" property="og:description" content="How do I instantiate multiple instances with the same module parameterization?"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/cookbooks/hierarchy"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/hierarchy" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/hierarchy" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -66,7 +66,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-make-my-parameters-a
 you are careful about what you mark as <code>IsLookupable</code>.</p>
 <p>In the following example, we added the trait <code>IsLookupable</code> to allow the member to be marked <code>@public</code>.</p>
 <div class="language-scala codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-scala codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token plain">_</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token namespace" style="opacity:0.7">chisel3</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">experimental</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token namespace" style="opacity:0.7">hierarchy</span><span class="token namespace punctuation" style="opacity:0.7;color:#393A34">.</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">Definition</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> instantiable</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> IsLookupable</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> public</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">case</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyCaseClass</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">width</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Int</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> IsLookupable</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token annotation punctuation" style="color:#393A34">@instantiable</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MyModule </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token annotation punctuation" style="color:#393A34">@public</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> MyCaseClass</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">10</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Top </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> Module </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> inst </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> Instance</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Definition</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> MyModule</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  println</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string-interpolation id function" style="color:#d73a49">s</span><span class="token string-interpolation string" style="color:#e3116c">&quot;Width is </span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">${</span><span class="token string-interpolation interpolation expression">inst</span><span class="token string-interpolation interpolation expression punctuation" style="color:#393A34">.</span><span class="token string-interpolation interpolation expression">x</span><span class="token string-interpolation interpolation expression punctuation" style="color:#393A34">.</span><span class="token string-interpolation interpolation expression">width</span><span class="token string-interpolation interpolation punctuation" style="color:#393A34">}</span><span class="token string-interpolation string" style="color:#e3116c">&quot;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
-<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Width is 10</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Circuit(Top,List(DefModule(repl.MdocSession$MdocApp5$MyModule@7a6fe955,MyModule,false,List(),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2))),Vector()), DefModule(repl.MdocSession$MdocApp5$Top@1c468bf2,Top,true,List(),List(Port(Top.clock: IO[Clock],Input,SourceLine(hierarchy.md,111,7)), Port(Top.reset: IO[Bool],Input,SourceLine(hierarchy.md,111,7))),Vector(DefInstance(SourceLine(hierarchy.md,112,22),ModuleClone(repl.MdocSession$MdocApp5$MyModule@7a6fe955),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2)))), Connect(SourceLine(hierarchy.md,112,22),Node(MyModule.inst.clock: IO[Clock]),Node(Top.clock: IO[Clock])), Connect(SourceLine(hierarchy.md,112,22),Node(MyModule.inst.reset: IO[Reset]),Node(Top.reset: IO[Bool]))))),List(),firrtl.renamemap.package$MutableRenameMap@510592db,List(),List(),List(),List())</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
+<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Width is 10</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Circuit(Top,List(DefModule(repl.MdocSession$MdocApp5$MyModule@423039b6,MyModule,false,List(),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2))),Vector()), DefModule(repl.MdocSession$MdocApp5$Top@25217a39,Top,true,List(),List(Port(Top.clock: IO[Clock],Input,SourceLine(hierarchy.md,111,7)), Port(Top.reset: IO[Bool],Input,SourceLine(hierarchy.md,111,7))),Vector(DefInstance(SourceLine(hierarchy.md,112,22),ModuleClone(repl.MdocSession$MdocApp5$MyModule@423039b6),List(Port(MyModule.clock: IO[Clock],Input,SourceLine(hierarchy.md,105,2)), Port(MyModule.reset: IO[Reset],Input,SourceLine(hierarchy.md,105,2)))), Connect(SourceLine(hierarchy.md,112,22),Node(MyModule.inst.clock: IO[Clock]),Node(Top.clock: IO[Clock])), Connect(SourceLine(hierarchy.md,112,22),Node(MyModule.inst.reset: IO[Reset]),Node(Top.reset: IO[Bool]))))),List(),firrtl.renamemap.package$MutableRenameMap@383f282f,List(),List(),List(),List())</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
 <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-look-up-parameters-from-a-definition-if-i-dont-want-to-instantiate-it">How do I look up parameters from a Definition, if I don&#x27;t want to instantiate it?<a href="#how-do-i-look-up-parameters-from-a-definition-if-i-dont-want-to-instantiate-it" class="hash-link" aria-label="Direct link to How do I look up parameters from a Definition, if I don&#x27;t want to instantiate it?" title="Direct link to How do I look up parameters from a Definition, if I don&#x27;t want to instantiate it?">​</a></h2>
 <p>Just like <code>Instance</code>s, <code>Definition</code>&#x27;s also contain accessors for <code>@public</code> members.
 As such, you can directly access them:</p>
diff --git a/docs/cookbooks/naming.html b/docs/cookbooks/naming.html
index d6362c73532..d78f374e7e8 100644
--- a/docs/cookbooks/naming.html
+++ b/docs/cookbooks/naming.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Naming Cookbook | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/cookbooks/naming"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Naming Cookbook | Chisel"><meta data-rh="true" name="description" content="I still have _T signals, can this be fixed?"><meta data-rh="true" property="og:description" content="I still have _T signals, can this be fixed?"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/cookbooks/naming"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/naming" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/naming" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/serialization.html b/docs/cookbooks/serialization.html
index db16440c4ab..6516b5af771 100644
--- a/docs/cookbooks/serialization.html
+++ b/docs/cookbooks/serialization.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Serialization Cookbook | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/cookbooks/serialization"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Serialization Cookbook | Chisel"><meta data-rh="true" name="description" content="Why do I need to serialize Modules"><meta data-rh="true" property="og:description" content="Why do I need to serialize Modules"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/cookbooks/serialization"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/serialization" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/serialization" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/cookbooks/troubleshooting.html b/docs/cookbooks/troubleshooting.html
index 31f82e9de0b..510a843b7a7 100644
--- a/docs/cookbooks/troubleshooting.html
+++ b/docs/cookbooks/troubleshooting.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Troubleshooting | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/cookbooks/troubleshooting"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Troubleshooting | Chisel"><meta data-rh="true" name="description" content="This page is a starting point for recording common and not so common problems in developing with Chisel3.  In particular, those situations where there is a work around that will keep you going."><meta data-rh="true" property="og:description" content="This page is a starting point for recording common and not so common problems in developing with Chisel3.  In particular, those situations where there is a work around that will keep you going."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/cookbooks/troubleshooting"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/troubleshooting" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/cookbooks/troubleshooting" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers.html b/docs/developers.html
index dd1f7eb75e8..f685044bd45 100644
--- a/docs/developers.html
+++ b/docs/developers.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Developer Documentation | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/developers"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Developer Documentation | Chisel"><meta data-rh="true" name="description" content="Tips and tricks for Chisel developers:"><meta data-rh="true" property="og:description" content="Tips and tricks for Chisel developers:"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/developers"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/developers" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/developers" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers/scaladoc.html b/docs/developers/scaladoc.html
index 2b74d3a76da..62794ff0597 100644
--- a/docs/developers/scaladoc.html
+++ b/docs/developers/scaladoc.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Scaladoc | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/developers/scaladoc"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Scaladoc | Chisel"><meta data-rh="true" name="description" content="Scaladoc"><meta data-rh="true" property="og:description" content="Scaladoc"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/developers/scaladoc"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/developers/scaladoc" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/developers/scaladoc" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/developers/style.html b/docs/developers/style.html
index b00b98e1b9a..dd1b9a376fc 100644
--- a/docs/developers/style.html
+++ b/docs/developers/style.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Style Guide | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/developers/style"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Style Guide | Chisel"><meta data-rh="true" name="description" content="This document describes the syle used within the chisel3"><meta data-rh="true" property="og:description" content="This document describes the syle used within the chisel3"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/developers/style"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/developers/style" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/developers/style" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 24dd0c54cf6..bc94aaaf955 100644
--- a/docs/developers/test-coverage.html
+++ b/docs/developers/test-coverage.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Test Coverage | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/developers/test-coverage"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Test Coverage | Chisel"><meta data-rh="true" name="description" content="Test Coverage Setup"><meta data-rh="true" property="og:description" content="Test Coverage Setup"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/developers/test-coverage"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/developers/test-coverage" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/developers/test-coverage" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations.html b/docs/explanations.html
index 7296e1b827f..da93b62bf6c 100644
--- a/docs/explanations.html
+++ b/docs/explanations.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Explanations | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Explanations | Chisel"><meta data-rh="true" name="description" content="Explanation documentation gives background and context."><meta data-rh="true" property="og:description" content="Explanation documentation gives background and context."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/annotations.html b/docs/explanations/annotations.html
index 0b6512a2864..f245baabe1a 100644
--- a/docs/explanations/annotations.html
+++ b/docs/explanations/annotations.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Annotations | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/annotations"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Annotations | Chisel"><meta data-rh="true" name="description" content="Annotations are metadata containers associated with zero or more &quot;things&quot; in a FIRRTL circuit."><meta data-rh="true" property="og:description" content="Annotations are metadata containers associated with zero or more &quot;things&quot; in a FIRRTL circuit."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/annotations"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/annotations" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/annotations" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/blackboxes.html b/docs/explanations/blackboxes.html
index d1dcb20e7b5..dffabf936f5 100644
--- a/docs/explanations/blackboxes.html
+++ b/docs/explanations/blackboxes.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Blackboxes | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/blackboxes"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Blackboxes | Chisel"><meta data-rh="true" name="description" content="Chisel BlackBoxes are used to instantiate externally defined modules. This construct is useful"><meta data-rh="true" property="og:description" content="Chisel BlackBoxes are used to instantiate externally defined modules. This construct is useful"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/blackboxes"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/blackboxes" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/blackboxes" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 3ab9f5a13d4..422d66615b8 100644
--- a/docs/explanations/bundles-and-vecs.html
+++ b/docs/explanations/bundles-and-vecs.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Bundles and Vecs | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/bundles-and-vecs"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Bundles and Vecs | Chisel"><meta data-rh="true" name="description" content="Bundle and Vec are classes that allow the user to expand the set of Chisel datatypes with aggregates of other types."><meta data-rh="true" property="og:description" content="Bundle and Vec are classes that allow the user to expand the set of Chisel datatypes with aggregates of other types."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/bundles-and-vecs"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/bundles-and-vecs" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/bundles-and-vecs" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 23bb01aa63a..f5231016633 100644
--- a/docs/explanations/chisel-enum.html
+++ b/docs/explanations/chisel-enum.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Enumerations | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/chisel-enum"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Enumerations | Chisel"><meta data-rh="true" name="description" content="The ChiselEnum type can be used to reduce the chance of error when encoding mux selectors, opcodes, and functional unit operations."><meta data-rh="true" property="og:description" content="The ChiselEnum type can be used to reduce the chance of error when encoding mux selectors, opcodes, and functional unit operations."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/chisel-enum"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/chisel-enum" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/chisel-enum" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 a3e1926cb70..ad6dfebd266 100644
--- a/docs/explanations/chisel-type-vs-scala-type.html
+++ b/docs/explanations/chisel-type-vs-scala-type.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Chisel Type vs Scala Type | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/chisel-type-vs-scala-type"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Chisel Type vs Scala Type | Chisel"><meta data-rh="true" name="description" content="The Scala compiler cannot distinguish between Chisel&#x27;s representation of hardware such as false.B, Reg(Bool())"><meta data-rh="true" property="og:description" content="The Scala compiler cannot distinguish between Chisel&#x27;s representation of hardware such as false.B, Reg(Bool())"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/chisel-type-vs-scala-type"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/chisel-type-vs-scala-type" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/chisel-type-vs-scala-type" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
@@ -60,7 +60,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 @2c476dc)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.SpecifiedDirection$.specifiedDirection(Data.scala:75)</span><span class="token plain"></span><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(Data.scala:314)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.IO$.apply(IO.scala:34)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.experimental.BaseModule.IO(Module.scala:878)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.experimental.prefix$.apply(prefix.scala:50)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule.&lt;init&gt;(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$.evaluate(Module.scala:94)</span><span class="token plain"></span><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:37)</span><span class="token plain"></span><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:53)</span><span class="token plain"></span><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:1072)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at 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:1062)</span><span class="token plain"></span><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:1054)</span><span class="token plain"></span><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 @5a83c515)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72$$anonfun$apply$73.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.SpecifiedDirection$.specifiedDirection(Data.scala:75)</span><span class="token plain"></span><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(Data.scala:314)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71$$anonfun$apply$72.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.IO$.apply(IO.scala:34)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.experimental.BaseModule.IO(Module.scala:878)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76$$anonfun$apply$71.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.experimental.prefix$.apply(prefix.scala:50)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule$$anonfun$76.apply(chisel-type-vs-scala-type.md)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.internal.plugin.package$.autoNameRecursively(package.scala:33)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$ScalaCastingModule.&lt;init&gt;(chisel-type-vs-scala-type.md:293)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at repl.MdocSession$MdocApp$$anonfun$79$$anonfun$apply$75.apply(chisel-type-vs-scala-type.md:309)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at chisel3.Module$.evaluate(Module.scala:94)</span><span class="token plain"></span><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:37)</span><span class="token plain"></span><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:53)</span><span class="token plain"></span><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:1072)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// 	at 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:1062)</span><span class="token plain"></span><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:1054)</span><span class="token plain"></span><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 ac857df501f..b48b5ed77f6 100644
--- a/docs/explanations/combinational-circuits.html
+++ b/docs/explanations/combinational-circuits.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Combinational Circuits | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/combinational-circuits"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Combinational Circuits | Chisel"><meta data-rh="true" name="description" content="A circuit is represented as a graph of nodes in Chisel.  Each node is"><meta data-rh="true" property="og:description" content="A circuit is represented as a graph of nodes in Chisel.  Each node is"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/combinational-circuits"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/combinational-circuits" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/combinational-circuits" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/connectable.html b/docs/explanations/connectable.html
index 68376476c3b..6557261aaf3 100644
--- a/docs/explanations/connectable.html
+++ b/docs/explanations/connectable.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Connectable Operators | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/connectable"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Connectable Operators | Chisel"><meta data-rh="true" name="description" content="Table of Contents"><meta data-rh="true" property="og:description" content="Table of Contents"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/connectable"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/connectable" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/connectable" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 5d44f2ff311..0c73556d740 100644
--- a/docs/explanations/connection-operators.html
+++ b/docs/explanations/connection-operators.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Deep Dive into &lt;&gt; and := Connection Operators | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/connection-operators"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Deep Dive into &lt;&gt; and := Connection Operators | Chisel"><meta data-rh="true" name="description" content="Chisel contains two connection operators, := and `. This document provides a deeper explanation of the differences of the two and when to use one or the other. The differences are demonstrated with experiments using Scastie examples which use DecoupledIO`."><meta data-rh="true" property="og:description" content="Chisel contains two connection operators, := and `. This document provides a deeper explanation of the differences of the two and when to use one or the other. The differences are demonstrated with experiments using Scastie examples which use DecoupledIO`."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/connection-operators"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/connection-operators" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/connection-operators" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 12961089290..441ed0868a2 100644
--- a/docs/explanations/data-types.html
+++ b/docs/explanations/data-types.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Chisel Data Types | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/data-types"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Chisel Data Types | Chisel"><meta data-rh="true" name="description" content="Chisel datatypes are used to specify the type of values held in state"><meta data-rh="true" property="og:description" content="Chisel datatypes are used to specify the type of values held in state"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/data-types"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/data-types" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/data-types" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/dataview.html b/docs/explanations/dataview.html
index 28b80ae86c8..32386fbf83f 100644
--- a/docs/explanations/dataview.html
+++ b/docs/explanations/dataview.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">DataView | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/dataview"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="DataView | Chisel"><meta data-rh="true" name="description" content="New in Chisel 3.5"><meta data-rh="true" property="og:description" content="New in Chisel 3.5"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/dataview"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/dataview" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/dataview" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/decoder.html b/docs/explanations/decoder.html
index 3f1f5b0a632..2ac0f5717fb 100644
--- a/docs/explanations/decoder.html
+++ b/docs/explanations/decoder.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Decoders | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/decoder"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Decoders | Chisel"><meta data-rh="true" name="description" content="It is common in a complex design to recognize certain patterns from a big UInt coming from a data bus and dispatch"><meta data-rh="true" property="og:description" content="It is common in a complex design to recognize certain patterns from a big UInt coming from a data bus and dispatch"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/decoder"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/decoder" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/decoder" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 978bae02ec0..47ab9daf610 100644
--- a/docs/explanations/functional-abstraction.html
+++ b/docs/explanations/functional-abstraction.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Functional Abstraction | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/functional-abstraction"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Functional Abstraction | Chisel"><meta data-rh="true" name="description" content="We can define functions to factor out a repeated piece of logic that"><meta data-rh="true" property="og:description" content="We can define functions to factor out a repeated piece of logic that"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/functional-abstraction"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/functional-abstraction" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/functional-abstraction" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 df609945e71..d9228513073 100644
--- a/docs/explanations/functional-module-creation.html
+++ b/docs/explanations/functional-module-creation.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Functional Module Creation | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/functional-module-creation"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Functional Module Creation | Chisel"><meta data-rh="true" name="description" content="Objects in Scala have a pre-existing creation function (method) called apply."><meta data-rh="true" property="og:description" content="Objects in Scala have a pre-existing creation function (method) called apply."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/functional-module-creation"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/functional-module-creation" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/functional-module-creation" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/instchoice.html b/docs/explanations/instchoice.html
index 2439c2c70e7..b709beb4ffb 100644
--- a/docs/explanations/instchoice.html
+++ b/docs/explanations/instchoice.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Instance Choices | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/instchoice"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Instance Choices | Chisel"><meta data-rh="true" name="description" content="Instance Choices are instances of modules whose targets are configurable post-elaboration."><meta data-rh="true" property="og:description" content="Instance Choices are instances of modules whose targets are configurable post-elaboration."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/instchoice"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/instchoice" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/instchoice" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 02413f7e01e..ff37fb5f2b7 100644
--- a/docs/explanations/interfaces-and-connections.html
+++ b/docs/explanations/interfaces-and-connections.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Interfaces and Connections | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/interfaces-and-connections"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Interfaces and Connections | Chisel"><meta data-rh="true" name="description" content="For more sophisticated modules it is often useful to define and instantiate interface classes while defining the IO for a module. First and foremost, interface classes promote reuse allowing users to capture once and for all common interfaces in a useful form."><meta data-rh="true" property="og:description" content="For more sophisticated modules it is often useful to define and instantiate interface classes while defining the IO for a module. First and foremost, interface classes promote reuse allowing users to capture once and for all common interfaces in a useful form."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/interfaces-and-connections"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/interfaces-and-connections" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/interfaces-and-connections" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/intrinsics.html b/docs/explanations/intrinsics.html
index 188ac91e83e..af902c6d797 100644
--- a/docs/explanations/intrinsics.html
+++ b/docs/explanations/intrinsics.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Intrinsics | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/intrinsics"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Intrinsics | Chisel"><meta data-rh="true" name="description" content="Chisel Intrinsics are used to express implementation defined functionality."><meta data-rh="true" property="og:description" content="Chisel Intrinsics are used to express implementation defined functionality."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/intrinsics"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/intrinsics" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/intrinsics" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/layers.html b/docs/explanations/layers.html
index 174f8a375a5..b2cb404685e 100644
--- a/docs/explanations/layers.html
+++ b/docs/explanations/layers.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Layers | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/layers"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Layers | Chisel"><meta data-rh="true" name="description" content="Layers are used to describe optional functionality of a Chisel circuit that a"><meta data-rh="true" property="og:description" content="Layers are used to describe optional functionality of a Chisel circuit that a"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/layers"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/layers" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/layers" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/memories.html b/docs/explanations/memories.html
index 79bea6f06de..0acabaf2593 100644
--- a/docs/explanations/memories.html
+++ b/docs/explanations/memories.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Memories | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/memories"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Memories | Chisel"><meta data-rh="true" name="description" content="Chisel provides facilities for creating both read only and read/write memories."><meta data-rh="true" property="og:description" content="Chisel provides facilities for creating both read only and read/write memories."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/memories"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/memories" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/memories" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/modules.html b/docs/explanations/modules.html
index 0619f09ed35..3c2490ef610 100644
--- a/docs/explanations/modules.html
+++ b/docs/explanations/modules.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Modules | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/modules"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Modules | Chisel"><meta data-rh="true" name="description" content="Chisel modules are very similar to Verilog modules in"><meta data-rh="true" property="og:description" content="Chisel modules are very similar to Verilog modules in"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/modules"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/modules" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/modules" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/motivation.html b/docs/explanations/motivation.html
index 92665a2f187..a9502b82c86 100644
--- a/docs/explanations/motivation.html
+++ b/docs/explanations/motivation.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Motivation | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/motivation"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Motivation | Chisel"><meta data-rh="true" name="description" content="We were motivated to develop a new hardware language by years of"><meta data-rh="true" property="og:description" content="We were motivated to develop a new hardware language by years of"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/motivation"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/motivation" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/motivation" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 771cb3ed9f2..ce210f93083 100644
--- a/docs/explanations/multi-clock.html
+++ b/docs/explanations/multi-clock.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Multiple Clock Domains | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/multi-clock"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Multiple Clock Domains | Chisel"><meta data-rh="true" name="description" content="Chisel 3 supports multiple clock domains as follows."><meta data-rh="true" property="og:description" content="Chisel 3 supports multiple clock domains as follows."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/multi-clock"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/multi-clock" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/multi-clock" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 4ccba4cb623..af52f078d78 100644
--- a/docs/explanations/muxes-and-input-selection.html
+++ b/docs/explanations/muxes-and-input-selection.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Muxes and Input Selection | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/muxes-and-input-selection"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Muxes and Input Selection | Chisel"><meta data-rh="true" name="description" content="Selecting inputs is very useful in hardware description, and therefore Chisel provides several built-in generic input-selection implementations."><meta data-rh="true" property="og:description" content="Selecting inputs is very useful in hardware description, and therefore Chisel provides several built-in generic input-selection implementations."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/muxes-and-input-selection"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/muxes-and-input-selection" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/muxes-and-input-selection" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/naming.html b/docs/explanations/naming.html
index c27285fcf97..ea713a6d20b 100644
--- a/docs/explanations/naming.html
+++ b/docs/explanations/naming.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Naming | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/naming"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Naming | Chisel"><meta data-rh="true" name="description" content="Historically, Chisel has had trouble reliably capturing the names of signals. The reasons for this are due to (1)"><meta data-rh="true" property="og:description" content="Historically, Chisel has had trouble reliably capturing the names of signals. The reasons for this are due to (1)"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/naming"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/naming" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/naming" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/operators.html b/docs/explanations/operators.html
index 2ad86837455..eba8b70e4ee 100644
--- a/docs/explanations/operators.html
+++ b/docs/explanations/operators.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Operators | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/operators"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Operators | Chisel"><meta data-rh="true" name="description" content="Chisel defines a set of hardware operators:"><meta data-rh="true" property="og:description" content="Chisel defines a set of hardware operators:"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/operators"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/operators" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/operators" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 864d5a4dfc0..105ffe58a42 100644
--- a/docs/explanations/polymorphism-and-parameterization.html
+++ b/docs/explanations/polymorphism-and-parameterization.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Polymorphism and Parameterization | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/polymorphism-and-parameterization"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Polymorphism and Parameterization | Chisel"><meta data-rh="true" name="description" content="This section is advanced and can be skipped at first reading."><meta data-rh="true" property="og:description" content="This section is advanced and can be skipped at first reading."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/polymorphism-and-parameterization"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/polymorphism-and-parameterization" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/polymorphism-and-parameterization" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/ports.html b/docs/explanations/ports.html
index 3545a10b646..56b0ddbc3d5 100644
--- a/docs/explanations/ports.html
+++ b/docs/explanations/ports.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Ports | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/ports"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Ports | Chisel"><meta data-rh="true" name="description" content="Ports are used as interfaces to hardware components.  A port is simply"><meta data-rh="true" property="og:description" content="Ports are used as interfaces to hardware components.  A port is simply"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/ports"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/ports" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/ports" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/printing.html b/docs/explanations/printing.html
index 2ec8b1d3a35..d75da58f4f1 100644
--- a/docs/explanations/printing.html
+++ b/docs/explanations/printing.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Printing | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/printing"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Printing | Chisel"><meta data-rh="true" name="description" content="Chisel provides the printf function for debugging purposes. It comes in two flavors:"><meta data-rh="true" property="og:description" content="Chisel provides the printf function for debugging purposes. It comes in two flavors:"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/printing"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/printing" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/printing" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/properties.html b/docs/explanations/properties.html
index 02cd1aad7f7..126dfdcd41c 100644
--- a/docs/explanations/properties.html
+++ b/docs/explanations/properties.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Properties | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/properties"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Properties | Chisel"><meta data-rh="true" name="description" content="Chisel properties represent information about the design that is not hardware."><meta data-rh="true" property="og:description" content="Chisel properties represent information about the design that is not hardware."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/properties"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/properties" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/properties" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/reset.html b/docs/explanations/reset.html
index a427832a05e..7e3a2d64fc3 100644
--- a/docs/explanations/reset.html
+++ b/docs/explanations/reset.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Reset | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/reset"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Reset | Chisel"><meta data-rh="true" name="description" content="As of Chisel 3.2.0, Chisel 3 supports both synchronous and asynchronous reset,"><meta data-rh="true" property="og:description" content="As of Chisel 3.2.0, Chisel 3 supports both synchronous and asynchronous reset,"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/reset"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/reset" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/reset" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 ae49d89016b..74132327b64 100644
--- a/docs/explanations/sequential-circuits.html
+++ b/docs/explanations/sequential-circuits.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Sequential Circuits | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/sequential-circuits"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Sequential Circuits | Chisel"><meta data-rh="true" name="description" content="The simplest form of state element supported by Chisel is a positive edge-triggered register, which can be instantiated as:"><meta data-rh="true" property="og:description" content="The simplest form of state element supported by Chisel is a positive edge-triggered register, which can be instantiated as:"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/sequential-circuits"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/sequential-circuits" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/sequential-circuits" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 a10ece9c0e5..c5c916ff533 100644
--- a/docs/explanations/source-locators.html
+++ b/docs/explanations/source-locators.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Source Locators | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/source-locators"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Source Locators | Chisel"><meta data-rh="true" name="description" content="When elaborating a Chisel design and emitting a FIRRTL file or Verilog file, Chisel will automatically"><meta data-rh="true" property="og:description" content="When elaborating a Chisel design and emitting a FIRRTL file or Verilog file, Chisel will automatically"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/source-locators"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/source-locators" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/source-locators" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 3d88c84b9d5..5b4711b570a 100644
--- a/docs/explanations/supported-hardware.html
+++ b/docs/explanations/supported-hardware.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Supported Hardware | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/supported-hardware"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Supported Hardware | Chisel"><meta data-rh="true" name="description" content="While Chisel focuses on binary logic, Chisel can support analog and tri-state wires with the Analog type - see Datatypes in Chisel."><meta data-rh="true" property="og:description" content="While Chisel focuses on binary logic, Chisel can support analog and tri-state wires with the Analog type - see Datatypes in Chisel."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/supported-hardware"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/supported-hardware" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/supported-hardware" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 d83986607a4..0fd04ddbe17 100644
--- a/docs/explanations/unconnected-wires.html
+++ b/docs/explanations/unconnected-wires.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Unconnected Wires | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/unconnected-wires"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Unconnected Wires | Chisel"><meta data-rh="true" name="description" content="The Invalidate API (#645) adds support to Chisel"><meta data-rh="true" property="og:description" content="The Invalidate API (#645) adds support to Chisel"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/unconnected-wires"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/unconnected-wires" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/unconnected-wires" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/explanations/warnings.html b/docs/explanations/warnings.html
index 128f0af5c0e..c242f51349f 100644
--- a/docs/explanations/warnings.html
+++ b/docs/explanations/warnings.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Warnings | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/warnings"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Warnings | Chisel"><meta data-rh="true" name="description" content="Warnings in Chisel are used for deprecating old APIs or semantics for later removal."><meta data-rh="true" property="og:description" content="Warnings in Chisel are used for deprecating old APIs or semantics for later removal."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/warnings"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/warnings" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/warnings" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 2f7af643f38..a0e75dc6a42 100644
--- a/docs/explanations/width-inference.html
+++ b/docs/explanations/width-inference.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Width Inference | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/explanations/width-inference"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Width Inference | Chisel"><meta data-rh="true" name="description" content="Chisel provides bit width inference to reduce design effort. Users are encouraged to manually specify widths of ports and registers to prevent any surprises, but otherwise unspecified widths will be inferred by the FIRRTL compiler."><meta data-rh="true" property="og:description" content="Chisel provides bit width inference to reduce design effort. Users are encouraged to manually specify widths of ports and registers to prevent any surprises, but otherwise unspecified widths will be inferred by the FIRRTL compiler."><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/explanations/width-inference"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/width-inference" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/explanations/width-inference" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/installation.html b/docs/installation.html
index cccf3576bf7..0f2d1f6fc97 100644
--- a/docs/installation.html
+++ b/docs/installation.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Installation | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/installation"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Installation | Chisel"><meta data-rh="true" name="description" content="How to install and run Chisel"><meta data-rh="true" property="og:description" content="How to install and run Chisel"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/installation"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/installation" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/installation" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/resources.html b/docs/resources.html
index af8395f881b..9ece5d42ee7 100644
--- a/docs/resources.html
+++ b/docs/resources.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Chisel Resources | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/resources"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Chisel Resources | Chisel"><meta data-rh="true" name="description" content="The best resource to learn about Chisel is the online Chisel Bootcamp. This runs in your browser and assumes no prior Scala knowledge. (You may also run this locally via the backing chisel-bootcamp GitHub repository.)"><meta data-rh="true" property="og:description" content="The best resource to learn about Chisel is the online Chisel Bootcamp. This runs in your browser and assumes no prior Scala knowledge. (You may also run this locally via the backing chisel-bootcamp GitHub repository.)"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/resources"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/resources" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/resources" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/docs/resources/faqs.html b/docs/resources/faqs.html
index 7d9094fe562..615738cfc35 100644
--- a/docs/resources/faqs.html
+++ b/docs/resources/faqs.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Frequently Asked Questions | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/docs/resources/faqs"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Frequently Asked Questions | Chisel"><meta data-rh="true" name="description" content="* Where should I start if I want to learn Chisel?"><meta data-rh="true" property="og:description" content="* Where should I start if I want to learn Chisel?"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/docs/resources/faqs"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/resources/faqs" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/docs/resources/faqs" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/generated/contributors.html b/generated/contributors.html
index a1734bef4e0..1a57278bb08 100644
--- a/generated/contributors.html
+++ b/generated/contributors.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Chisel</title><meta data-rh="true" property="og:title" content="Chisel"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/generated/contributors"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" name="description" content="- @abejgonzalez"><meta data-rh="true" property="og:description" content="- @abejgonzalez"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/generated/contributors"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/generated/contributors" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/generated/contributors" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/generated/scaladoc_links.html b/generated/scaladoc_links.html
index 25599db51f7..e8b8a4af46d 100644
--- a/generated/scaladoc_links.html
+++ b/generated/scaladoc_links.html
@@ -4,13 +4,13 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Chisel</title><meta data-rh="true" property="og:title" content="Chisel"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/generated/scaladoc_links"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" name="description" content="- Latest (6.5.0)"><meta data-rh="true" property="og:description" content="- Latest (6.5.0)"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/generated/scaladoc_links"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/generated/scaladoc_links" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/generated/scaladoc_links" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.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 localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)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></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"><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.5.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+9-7bf8b596-SNAPSHOT/chisel_2.13-7.0.0-M2+9-7bf8b596-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+10-68aec539-SNAPSHOT/chisel_2.13-7.0.0-M2+10-68aec539-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.5.0" target="_blank" rel="noopener noreferrer">6.5.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 8d83f72e135..7a2f28228c0 100644
--- a/index.html
+++ b/index.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Chisel | Chisel</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Chisel | Chisel"><meta data-rh="true" name="description" content="Software-defined hardware"><meta data-rh="true" property="og:description" content="Software-defined hardware"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n   <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n   <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n   <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span>  (default value)</p>\n   <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",(function(){void 0===window.docusaurus&&insertBanner()}))</script><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
diff --git a/search.html b/search.html
index ae8251cc011..c2e4b9b4224 100644
--- a/search.html
+++ b/search.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.1.1">
 <title data-rh="true">Search the documentation | Chisel</title><meta data-rh="true" property="og:title" content="Chisel"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" name="twitter:image" content="https://www.chisel-lang.org/img/chisel-tool.svg"><meta data-rh="true" property="og:url" content="https://www.chisel-lang.org/search"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="robots" content="noindex, follow"><link data-rh="true" rel="icon" href="/img/chisel-tool-icon.svg"><link data-rh="true" rel="canonical" href="https://www.chisel-lang.org/search"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/search" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.chisel-lang.org/search" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TTFNIAC3CJ-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Chisel" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e0eb6f43.css">
-<script src="/assets/js/runtime~main.c232c68c.js" defer="defer"></script>
+<script src="/assets/js/runtime~main.839beab8.js" defer="defer"></script>
 <script src="/assets/js/main.74859d55.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">