aboutsummaryrefslogtreecommitdiff
path: root/src/main/stanza/firrtl-ir.stanza
blob: fbe224639f2a8274710d10222900e9c004c41b14 (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
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 PortDirection
public val INPUT = new PortDirection
public val OUTPUT = new PortDirection

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

public definterface AccDirection
public val READ = new AccDirection
public val WRITE = new AccDirection
public val INFER = new AccDirection
public val RDWR = new AccDirection

public definterface Width
public defstruct UnknownWidth <: Width
public defstruct IntWidth <: Width :
   width: Int
public defstruct LongWidth <: 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 MOD-OP = new PrimOp
public val QUO-OP = new PrimOp
public val REM-OP = new PrimOp
public val ADD-WRAP-OP = new PrimOp
public val SUB-WRAP-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 NEQUIV-OP = new PrimOp
public val EQUIV-OP = new PrimOp
public val MUX-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 DYN-SHIFT-LEFT-OP = new PrimOp
public val DYN-SHIFT-RIGHT-OP = new PrimOp
public val SHIFT-LEFT-OP = new PrimOp
public val SHIFT-RIGHT-OP = new PrimOp
public val NEG-OP = new PrimOp
public val CONVERT-OP = new PrimOp
public val BIT-NOT-OP = new PrimOp
public val BIT-AND-OP = new PrimOp
public val BIT-OR-OP = new PrimOp
public val BIT-XOR-OP = new PrimOp
public val CONCAT-OP = new PrimOp
public val BIT-SELECT-OP = new PrimOp
public val BITS-SELECT-OP = new PrimOp
public val BIT-AND-REDUCE-OP = new PrimOp
public val BIT-OR-REDUCE-OP = new PrimOp
public val BIT-XOR-REDUCE-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 Index <: Expression :
   exp: Expression
   value: Int
   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
public defstruct DefInstance <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   name: Symbol
   module: Expression
public defstruct DefMemory <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   name: Symbol
   type: VectorType
   seq?: True|False
   clock: Expression
public defstruct DefNode <: Stmt : ;LOW
   info: FileInfo with: (as-method => true)
   name: Symbol
   value: Expression
public defstruct DefAccessor <: Stmt :
   info: FileInfo with: (as-method => true)
   name: Symbol
   source: Expression
   index: Expression
   acc-dir: AccDirection
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 OnReset <: Stmt : 
   info: FileInfo with: (as-method => true)
   loc: Expression
   exp: Expression
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 EmptyStmt <: 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: PortDirection
   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