aboutsummaryrefslogtreecommitdiff
path: root/src/main/stanza/firrtl-ir.stanza
blob: fdb7659a5175ef692c8706b2d4a38832a4408113 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
;Copyright (c) 2014 - 2016 The Regents of the University of
;California (Regents). All Rights Reserved.  Redistribution and use in
;source and binary forms, with or without modification, are permitted
;provided that the following conditions are met:
;   * Redistributions of source code must retain the above
;     copyright notice, this list of conditions and the following
;     two paragraphs of disclaimer.
;   * Redistributions in binary form must reproduce the above
;     copyright notice, this list of conditions and the following
;     two paragraphs of disclaimer in the documentation and/or other materials
;     provided with the distribution.
;   * Neither the name of the Regents nor the names of its contributors
;     may be used to endorse or promote products derived from this
;     software without specific prior written permission.
;IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
;SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
;ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
;REGENTS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
;REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
;LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
;A PARTICULAR PURPOSE. THE SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF
;ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". REGENTS HAS NO OBLIGATION
;TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
;MODIFICATIONS.
defpackage firrtl/ir2 :
   import core
   import verse
   import bigint2
   
public defmulti info! (x:?) -> FileInfo
public defmethod info! (x:?) : FileInfo()

public val vector-expand-delin = `$
public val bundle-expand-delin = `$
public val module-expand-delin = `$
public val scope-delin = `_
public val inline-delin = `_
public val delin = `_

public definterface Direction
public val INPUT = new Direction
public val OUTPUT = new Direction

public definterface Flip
public val DEFAULT = new Flip
public val REVERSE = new Flip

public definterface Width
public defstruct UnknownWidth <: Width
public defn IntWidth (width:Int) : IntWidth(to-long(width))
public defstruct IntWidth <: Width :
   width: Long

public definterface PrimOp
public val ADD-OP = new PrimOp
public val SUB-OP = new PrimOp
public val MUL-OP = new PrimOp
public val DIV-OP = new PrimOp
public val REM-OP = new PrimOp
public val LESS-OP = new PrimOp
public val LESS-EQ-OP = new PrimOp
public val GREATER-OP = new PrimOp
public val GREATER-EQ-OP = new PrimOp
public val NEQUAL-OP = new PrimOp
public val EQUAL-OP = new PrimOp
public val PAD-OP = new PrimOp
public val AS-UINT-OP = new PrimOp
public val AS-SINT-OP = new PrimOp
public val AS-CLOCK-OP = new PrimOp
public val SHIFT-LEFT-OP = new PrimOp
public val SHIFT-RIGHT-OP = new PrimOp
public val DYN-SHIFT-LEFT-OP = new PrimOp
public val DYN-SHIFT-RIGHT-OP = new PrimOp
public val NEG-OP = new PrimOp
public val CONVERT-OP = new PrimOp
public val NOT-OP = new PrimOp
public val AND-OP = new PrimOp
public val OR-OP = new PrimOp
public val XOR-OP = new PrimOp
public val AND-REDUCE-OP = new PrimOp
public val OR-REDUCE-OP = new PrimOp
public val XOR-REDUCE-OP = new PrimOp
public val CONCAT-OP = new PrimOp
public val BITS-SELECT-OP = new PrimOp
public val HEAD-OP = new PrimOp
public val TAIL-OP = new PrimOp

public definterface Expression
public defmulti type (e:Expression) -> Type

public defstruct Ref <: Expression :
   name: Symbol
   type: Type with: (as-method => true)
public defstruct SubField <: Expression :
   exp: Expression
   name: Symbol
   type: Type with: (as-method => true)
public defstruct SubIndex <: Expression :
   exp: Expression
   value: Int
   type: Type with: (as-method => true)
public defstruct SubAccess <: Expression :
   exp: Expression
   index: Expression
   type: Type with: (as-method => true)
public defstruct Mux <: Expression :
   cond: Expression
   tval: Expression
   fval: Expression
   type: Type with: (as-method => true)
public defstruct ValidIf <: Expression :
   cond: Expression
   value: Expression
   type: Type with: (as-method => true)
public defstruct UIntValue <: Expression :
   value: BigInt
   width: Width
public defstruct SIntValue <: Expression :
   value: BigInt
   width: Width
public defstruct DoPrim <: Expression :
   op: PrimOp
   args: List<Expression>
   consts: List<Int>
   type: Type with: (as-method => true)

public definterface Stmt
public defmulti info (s:Stmt) -> FileInfo

public defstruct DefWire <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   name: Symbol
   type: Type
public defstruct DefRegister <: Stmt :
   info: FileInfo with: (as-method => true)
   name: Symbol
   type: Type
   clock: Expression
   reset: Expression
   init: Expression
public defstruct DefInstance <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   name: Symbol
   module: Symbol
public defstruct DefMemory <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   name: Symbol
   data-type: Type
   depth: Int
   write-latency: Int
   read-latency: Int
   readers: List<Symbol>
   writers: List<Symbol>
   readwriters: List<Symbol>
public defstruct DefNode <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   name: Symbol
   value: Expression
public defstruct DefPoison <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   name: Symbol
   type: Type
public defstruct Conditionally <: Stmt :
   info: FileInfo with: (as-method => true)
   pred: Expression
   conseq: Stmt
   alt: Stmt
public defstruct Begin <: Stmt : ;LOW
   body: List<Stmt>
public defstruct BulkConnect <: Stmt : 
   info: FileInfo with: (as-method => true)
   loc: Expression
   exp: Expression
public defstruct Connect <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   loc: Expression
   exp: Expression
public defstruct IsInvalid <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   exp: Expression
public defstruct Stop <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   ret: Int
   clk: Expression
   en: Expression
public defstruct Print <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   string: String
   args: List<Expression>
   clk: Expression
   en: Expression
public defstruct Empty <: Stmt ;LOW


public definterface Type
public defstruct UIntType <: Type :
   width: Width
public defstruct SIntType <: Type :
   width: Width
public defstruct BundleType <: Type :
   fields: List<Field>
public defstruct VectorType <: Type :
   type: Type
   size: Int
public defstruct ClockType <: Type
public defstruct UnknownType <: Type

public defstruct Field :
   name: Symbol
   flip: Flip
   type: Type

public defstruct Port :
   info: FileInfo
   name: Symbol
   direction: Direction
   type: Type

public definterface Module
public defmulti name (m:Module) -> Symbol
public defmulti ports (m:Module) -> List<Port>
public defmulti info (m:Module) -> FileInfo

public defstruct InModule <: Module :
   info: FileInfo with: (as-method => true)
   name: Symbol with: (as-method => true)
   ports: List<Port> with: (as-method => true)
   body: Stmt

public defstruct ExModule <: Module :
   info: FileInfo with: (as-method => true)
   name: Symbol with: (as-method => true)
   ports: List<Port> with: (as-method => true)

public defstruct Circuit :
   info: FileInfo
   modules: List<Module>
   main: Symbol