[major] Add reference types. (#75)

Introduce "reference types" for indirect access to FIRRTL constructs. Add operations for generating probe references and using them to remotely access data (via XMR's).
chipsalliance · Mar 16, 2023 · b53f533 · b53f533
1 parent 42916db
commit b53f533
Show file tree

Hide file tree

Showing 3 changed files with 769 additions and 13 deletions.
diff --git a/include/firrtl.xml b/include/firrtl.xml
@@ -18,6 +18,8 @@
       <item>of</item>
       <item>wire</item>
       <item>node</item>
+      <item>ref</item>
+      <item>define</item>
     </list>
     <list name="types">
       <item>UInt</item>
@@ -28,6 +30,10 @@
       <item>Reset</item>
       <item>AsyncReset</item>
     </list>
+    <list name="outertype">
+      <item>Probe</item>
+      <item>RWProbe</item>
+    </list>
     <list name="typemodifiers">
       <item>const</item>
     </list>
@@ -81,11 +87,19 @@
       <item>assert</item>
       <item>assume</item>
       <item>cover</item>
+      <item>read</item>
+      <item>probe</item>
+      <item>rwprobe</item>
+      <item>force</item>
+      <item>release</item>
+      <item>force_initial</item>
+      <item>release_initial</item>
     </list>
     <contexts>
       <context name="Normal Text" attribute="ID" lineEndContext="#pop">
         <keyword attribute="Keyword" context="#stay" String="keywords" />
         <keyword attribute="Keyword" context="type" String="types" />
+        <keyword attribute="Keyword" context="outertype" String="outertype" />
         <keyword attribute="Keyword" context="#stay" String="typemodifiers" />
         <keyword attribute="Structure" context="#stay" String="structure" />
         <keyword attribute="PrimOp" context="#stay" String="primops" />
@@ -108,6 +122,7 @@
       <context name="memory" attribute="Keyword" lineEndContext="#stay">
         <Detect2Chars char="=" char1="&gt;" attribute="Operator" context="memoryRHS"/>
         <StringDetect String="read-under-write" attribute="Keyword" context="#pop!memoryLast"/>
+        <DetectChar char= ";" context="comment" attribute="Comment"/>
       </context>
       <context name="memoryRHS" attribute="ID" lineEndContext="#pop">
         <keyword String="types" attribute="Keyword" context="type"/>
@@ -133,11 +148,21 @@
       <context name="info" attribute="Info" lineEndContext="#stay">
         <DetectChar char="]" context="#pop"/>
       </context>
+      <context name="outertype" attribute="Keyword" lineEndContext="#pop">
+        <DetectChar char="&lt;" attribute="Operator" context="#stay"/>
+        <keyword String="types" attribute="Keyword" context="type"/>
+        <DetectChar char="{" context="field" attribute="Separator"/>
+        <DetectChar char="}" attribute="Separator" context="#pop#pop"/>
+        <DetectChar char= ";" context="comment" attribute="Comment"/>
+        <AnyChar String="&gt;," attribute="Operator" context="#pop"/>
+        <DetectChar char="[" attribute="Operator" context="widthOrDepthOrLit"/>
+      </context>
       <context name="type" attribute="String" lineEndContext="#pop">
         <AnyChar String="&lt;[(" attribute="Operator" context="widthOrDepthOrLit"/>
         <AnyChar String="," attribute="Separator" context="#pop"/>
         <AnyChar String="}" attribute="Separator" context="#pop#pop"/>
         <DetectChar char= ";" context="comment" attribute="Comment"/>
+        <AnyChar String="&gt;" attribute="Operator" context="#pop"/>
       </context>
       <context name="widthOrDepthOrLit" attribute="String" lineEndContext="#stay">
         <DetectChar char="&lt;" attribute="Operator" context="widthOrDepthOrLit"/>
@@ -146,6 +171,7 @@
       <context name="field" attribute="ID" lineEndContext="#stay">
         <StringDetect String="flip" attribute="Keyword" context="#stay"/>
         <keyword String="types" attribute="Keyword" context="type"/>
+        <keyword String="outertype" attribute="Keyword" context="outertype"/>
         <keyword String="typemodifiers" attribute="Keyword" context="#stay"/>
         <DetectChar char="{" attribute="Separator" context="field"/>
         <DetectChar char="}" attribute="Separator" context="#pop"/>

diff --git a/revision-history.yaml b/revision-history.yaml
@@ -15,6 +15,7 @@ revisionHistory:
     - Render inline annotations as JSON, fix typo in example.
     - Fix rendering of type modifiers (const) in document.
     - Fix grammar for registers.
+    - Add reference types and related statements.
   # Information about the old versions.  This should be static.
   oldVersions:
     - version: 1.2.0