2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include "kernel/rtlil.h"
21 #include "kernel/register.h"
22 #include "kernel/sigtools.h"
23 #include "kernel/celltypes.h"
24 #include "kernel/cellaigs.h"
25 #include "kernel/log.h"
33 PRIVATE_NAMESPACE_BEGIN
35 pool
<string
> used_names
;
36 dict
<IdString
, string
> namecache
;
39 typedef unsigned FDirection
;
40 static const FDirection FD_NODIRECTION
= 0x0;
41 static const FDirection FD_IN
= 0x1;
42 static const FDirection FD_OUT
= 0x2;
43 static const FDirection FD_INOUT
= 0x3;
44 static const int FIRRTL_MAX_DSH_WIDTH_ERROR
= 20; // For historic reasons, this is actually one greater than the maximum allowed shift width
46 // Get a port direction with respect to a specific module.
47 FDirection
getPortFDirection(IdString id
, Module
*module
)
49 Wire
*wire
= module
->wires_
.at(id
);
50 FDirection direction
= FD_NODIRECTION
;
51 if (wire
&& wire
->port_id
)
55 if (wire
->port_output
)
66 new_id
= stringf("_%d", autoid_counter
++);
67 if (used_names
.count(new_id
) == 0) break;
70 used_names
.insert(new_id
);
74 const char *make_id(IdString id
)
76 if (namecache
.count(id
) != 0)
77 return namecache
.at(id
).c_str();
79 string new_id
= log_id(id
);
81 for (int i
= 0; i
< GetSize(new_id
); i
++)
84 if ('a' <= ch
&& ch
<= 'z') continue;
85 if ('A' <= ch
&& ch
<= 'Z') continue;
86 if ('0' <= ch
&& ch
<= '9' && i
!= 0) continue;
87 if ('_' == ch
) continue;
91 while (used_names
.count(new_id
) != 0)
94 namecache
[id
] = new_id
;
95 used_names
.insert(new_id
);
96 return namecache
.at(id
).c_str();
104 dict
<SigBit
, pair
<string
, int>> reverse_wire_map
;
106 RTLIL::Design
*design
;
109 // Define read/write ports and memories.
110 // We'll collect their definitions and emit the corresponding FIRRTL definitions at the appropriate point in module construction.
111 // For the moment, we don't handle $readmemh or $readmemb.
112 // These will be part of a subsequent PR.
121 read_port(string name
, bool clk_enable
, bool clk_parity
, bool transparent
, RTLIL::SigSpec clk
, RTLIL::SigSpec ena
, RTLIL::SigSpec addr
) : name(name
), clk_enable(clk_enable
), clk_parity(clk_parity
), transparent(transparent
), clk(clk
), ena(ena
), addr(addr
) {
122 // Current (3/13/2019) conventions:
123 // generate a constant 0 for clock and a constant 1 for enable if they are undefined.
124 if (!clk
.is_fully_def())
125 this->clk
= SigSpec(RTLIL::Const(0, 1));
126 if (!ena
.is_fully_def())
127 this->ena
= SigSpec(RTLIL::Const(1, 1));
129 string
gen_read(const char * indent
) {
130 string addr_expr
= make_expr(addr
);
131 string ena_expr
= make_expr(ena
);
132 string clk_expr
= make_expr(clk
);
133 string addr_str
= stringf("%s%s.addr <= %s\n", indent
, name
.c_str(), addr_expr
.c_str());
134 string ena_str
= stringf("%s%s.en <= %s\n", indent
, name
.c_str(), ena_expr
.c_str());
135 string clk_str
= stringf("%s%s.clk <= asClock(%s)\n", indent
, name
.c_str(), clk_expr
.c_str());
136 return addr_str
+ ena_str
+ clk_str
;
139 struct write_port
: read_port
{
141 write_port(string name
, bool clk_enable
, bool clk_parity
, bool transparent
, RTLIL::SigSpec clk
, RTLIL::SigSpec ena
, RTLIL::SigSpec addr
, RTLIL::SigSpec mask
) : read_port(name
, clk_enable
, clk_parity
, transparent
, clk
, ena
, addr
), mask(mask
) {
142 if (!clk
.is_fully_def())
143 this->clk
= SigSpec(RTLIL::Const(0));
144 if (!ena
.is_fully_def())
145 this->ena
= SigSpec(RTLIL::Const(0));
146 if (!mask
.is_fully_def())
147 this->ena
= SigSpec(RTLIL::Const(1));
149 string
gen_read(const char * /* indent */) {
150 log_error("gen_read called on write_port: %s\n", name
.c_str());
151 return stringf("gen_read called on write_port: %s\n", name
.c_str());
153 string
gen_write(const char * indent
) {
154 string addr_expr
= make_expr(addr
);
155 string ena_expr
= make_expr(ena
);
156 string clk_expr
= make_expr(clk
);
157 string mask_expr
= make_expr(mask
);
158 string mask_str
= stringf("%s%s.mask <= %s\n", indent
, name
.c_str(), mask_expr
.c_str());
159 string addr_str
= stringf("%s%s.addr <= %s\n", indent
, name
.c_str(), addr_expr
.c_str());
160 string ena_str
= stringf("%s%s.en <= %s\n", indent
, name
.c_str(), ena_expr
.c_str());
161 string clk_str
= stringf("%s%s.clk <= asClock(%s)\n", indent
, name
.c_str(), clk_expr
.c_str());
162 return addr_str
+ ena_str
+ clk_str
+ mask_str
;
165 /* Memories defined within this module. */
167 Cell
*pCell
; // for error reporting
168 string name
; // memory name
169 int abits
; // number of address bits
170 int size
; // size (in units) of the memory
171 int width
; // size (in bits) of each element
174 vector
<read_port
> read_ports
;
175 vector
<write_port
> write_ports
;
176 std::string init_file
;
177 std::string init_file_srcFileSpec
;
179 memory(Cell
*pCell
, string name
, int abits
, int size
, int width
) : pCell(pCell
), name(name
), abits(abits
), size(size
), width(width
), read_latency(0), write_latency(1), init_file(""), init_file_srcFileSpec("") {
180 // Provide defaults for abits or size if one (but not the other) is specified.
181 if (this->abits
== 0 && this->size
!= 0) {
182 this->abits
= ceil_log2(this->size
);
183 } else if (this->abits
!= 0 && this->size
== 0) {
184 this->size
= 1 << this->abits
;
186 // Sanity-check this construction.
187 if (this->name
== "") {
188 log_error("Nameless memory%s\n", this->atLine());
190 if (this->abits
== 0 && this->size
== 0) {
191 log_error("Memory %s has zero address bits and size%s\n", this->name
.c_str(), this->atLine());
193 if (this->width
== 0) {
194 log_error("Memory %s has zero width%s\n", this->name
.c_str(), this->atLine());
197 // We need a default constructor for the dict insert.
198 memory() : pCell(0), read_latency(0), write_latency(1), init_file(""), init_file_srcFileSpec(""){}
200 const char *atLine() {
203 auto p
= pCell
->attributes
.find("\\src");
204 srcLine
= " at " + p
->second
.decode_string();
207 return srcLine
.c_str();
209 void add_memory_read_port(read_port
&rp
) {
210 read_ports
.push_back(rp
);
212 void add_memory_write_port(write_port
&wp
) {
213 write_ports
.push_back(wp
);
215 void add_memory_file(std::string init_file
, std::string init_file_srcFileSpec
) {
216 this->init_file
= init_file
;
217 this->init_file_srcFileSpec
= init_file_srcFileSpec
;
221 dict
<string
, memory
> memories
;
223 void register_memory(memory
&m
)
225 memories
[m
.name
] = m
;
228 void register_reverse_wire_map(string id
, SigSpec sig
)
230 for (int i
= 0; i
< GetSize(sig
); i
++)
231 reverse_wire_map
[sig
[i
]] = make_pair(id
, i
);
234 FirrtlWorker(Module
*module
, std::ostream
&f
, RTLIL::Design
*theDesign
) : module(module
), f(f
), design(theDesign
), indent(" ")
238 static string
make_expr(const SigSpec
&sig
)
242 for (auto chunk
: sig
.chunks())
246 if (chunk
.wire
== nullptr)
248 std::vector
<RTLIL::State
> bits
= chunk
.data
;
249 new_expr
= stringf("UInt<%d>(\"h", GetSize(bits
));
251 while (GetSize(bits
) % 4 != 0)
252 bits
.push_back(State::S0
);
254 for (int i
= GetSize(bits
)-4; i
>= 0; i
-= 4)
257 if (bits
[i
+0] == State::S1
) val
+= 1;
258 if (bits
[i
+1] == State::S1
) val
+= 2;
259 if (bits
[i
+2] == State::S1
) val
+= 4;
260 if (bits
[i
+3] == State::S1
) val
+= 8;
261 new_expr
.push_back(val
< 10 ? '0' + val
: 'a' + val
- 10);
266 else if (chunk
.offset
== 0 && chunk
.width
== chunk
.wire
->width
)
268 new_expr
= make_id(chunk
.wire
->name
);
272 string wire_id
= make_id(chunk
.wire
->name
);
273 new_expr
= stringf("bits(%s, %d, %d)", wire_id
.c_str(), chunk
.offset
+ chunk
.width
- 1, chunk
.offset
);
279 expr
= "cat(" + new_expr
+ ", " + expr
+ ")";
285 std::string
fid(RTLIL::IdString internal_id
)
287 return make_id(internal_id
);
290 std::string
cellname(RTLIL::Cell
*cell
)
292 return fid(cell
->name
).c_str();
295 void process_instance(RTLIL::Cell
*cell
, vector
<string
> &wire_exprs
)
297 std::string cell_type
= fid(cell
->type
);
298 std::string instanceOf
;
299 // If this is a parameterized module, its parent module is encoded in the cell type
300 if (cell
->type
.substr(0, 8) == "$paramod")
302 std::string::iterator it
;
303 for (it
= cell_type
.begin(); it
< cell_type
.end(); it
++)
306 case '\\': /* FALL_THROUGH */
307 case '=': /* FALL_THROUGH */
308 case '\'': /* FALL_THROUGH */
309 case '$': instanceOf
.append("_"); break;
310 default: instanceOf
.append(1, *it
); break;
316 instanceOf
= cell_type
;
319 std::string cell_name
= cellname(cell
);
320 std::string cell_name_comment
;
321 if (cell_name
!= fid(cell
->name
))
322 cell_name_comment
= " /* " + fid(cell
->name
) + " */ ";
324 cell_name_comment
= "";
325 // Find the module corresponding to this instance.
326 auto instModule
= design
->module(cell
->type
);
327 // If there is no instance for this, just return.
328 if (instModule
== NULL
)
330 log_warning("No instance for %s.%s\n", cell_type
.c_str(), cell_name
.c_str());
333 wire_exprs
.push_back(stringf("%s" "inst %s%s of %s", indent
.c_str(), cell_name
.c_str(), cell_name_comment
.c_str(), instanceOf
.c_str()));
335 for (auto it
= cell
->connections().begin(); it
!= cell
->connections().end(); ++it
) {
336 if (it
->second
.size() > 0) {
337 const SigSpec
&secondSig
= it
->second
;
338 const std::string firstName
= cell_name
+ "." + make_id(it
->first
);
339 const std::string secondExpr
= make_expr(secondSig
);
340 // Find the direction for this port.
341 FDirection dir
= getPortFDirection(it
->first
, instModule
);
342 std::string sourceExpr
, sinkExpr
;
343 const SigSpec
*sinkSig
= nullptr;
346 log_warning("Instance port connection %s.%s is INOUT; treating as OUT\n", cell_type
.c_str(), log_signal(it
->second
));
349 sourceExpr
= firstName
;
350 sinkExpr
= secondExpr
;
351 sinkSig
= &secondSig
;
354 log_warning("Instance port connection %s.%s is NODIRECTION; treating as IN\n", cell_type
.c_str(), log_signal(it
->second
));
357 sourceExpr
= secondExpr
;
358 sinkExpr
= firstName
;
361 log_error("Instance port %s.%s unrecognized connection direction 0x%x !\n", cell_type
.c_str(), log_signal(it
->second
), dir
);
364 // Check for subfield assignment.
365 std::string bitsString
= "bits(";
366 if (sinkExpr
.substr(0, bitsString
.length()) == bitsString
) {
367 if (sinkSig
== nullptr)
368 log_error("Unknown subfield %s.%s\n", cell_type
.c_str(), sinkExpr
.c_str());
369 // Don't generate the assignment here.
370 // Add the source and sink to the "reverse_wire_map" and we'll output the assignment
371 // as part of the coalesced subfield assignments for this wire.
372 register_reverse_wire_map(sourceExpr
, *sinkSig
);
374 wire_exprs
.push_back(stringf("\n%s%s <= %s", indent
.c_str(), sinkExpr
.c_str(), sourceExpr
.c_str()));
378 wire_exprs
.push_back(stringf("\n"));
382 // Given an expression for a shift amount, and a maximum width,
383 // generate the FIRRTL expression for equivalent dynamic shift taking into account FIRRTL shift semantics.
384 std::string
gen_dshl(const string b_expr
, const int b_padded_width
)
386 string result
= b_expr
;
387 if (b_padded_width
>= FIRRTL_MAX_DSH_WIDTH_ERROR
) {
388 int max_shift_width_bits
= FIRRTL_MAX_DSH_WIDTH_ERROR
- 1;
389 string max_shift_string
= stringf("UInt<%d>(%d)", max_shift_width_bits
, (1<<max_shift_width_bits
) - 1);
390 // Deal with the difference in semantics between FIRRTL and verilog
391 result
= stringf("mux(gt(%s, %s), %s, bits(%s, %d, 0))", b_expr
.c_str(), max_shift_string
.c_str(), max_shift_string
.c_str(), b_expr
.c_str(), max_shift_width_bits
- 1);
398 f
<< stringf(" module %s:\n", make_id(module
->name
));
399 vector
<string
> port_decls
, wire_decls
, cell_exprs
, wire_exprs
;
401 for (auto wire
: module
->wires())
403 const auto wireName
= make_id(wire
->name
);
404 // If a wire has initial data, issue a warning since FIRRTL doesn't currently support it.
405 if (wire
->attributes
.count("\\init")) {
406 log_warning("Initial value (%s) for (%s.%s) not supported\n",
407 wire
->attributes
.at("\\init").as_string().c_str(),
408 log_id(module
), log_id(wire
));
412 if (wire
->port_input
&& wire
->port_output
)
413 log_error("Module port %s.%s is inout!\n", log_id(module
), log_id(wire
));
414 port_decls
.push_back(stringf(" %s %s: UInt<%d>\n", wire
->port_input
? "input" : "output",
415 wireName
, wire
->width
));
419 wire_decls
.push_back(stringf(" wire %s: UInt<%d>\n", wireName
, wire
->width
));
423 for (auto cell
: module
->cells())
425 bool extract_y_bits
= false; // Assume no extraction of final bits will be required.
426 // Is this cell is a module instance?
427 if (cell
->type
[0] != '$')
429 process_instance(cell
, wire_exprs
);
432 if (cell
->type
.in("$not", "$logic_not", "$neg", "$reduce_and", "$reduce_or", "$reduce_xor", "$reduce_bool", "$reduce_xnor"))
434 string y_id
= make_id(cell
->name
);
435 bool is_signed
= cell
->parameters
.at("\\A_SIGNED").as_bool();
436 int y_width
= cell
->parameters
.at("\\Y_WIDTH").as_int();
437 string a_expr
= make_expr(cell
->getPort("\\A"));
438 wire_decls
.push_back(stringf(" wire %s: UInt<%d>\n", y_id
.c_str(), y_width
));
440 if (cell
->parameters
.at("\\A_SIGNED").as_bool()) {
441 a_expr
= "asSInt(" + a_expr
+ ")";
444 // Don't use the results of logical operations (a single bit) to control padding
445 if (!(cell
->type
.in("$eq", "$eqx", "$gt", "$ge", "$lt", "$le", "$ne", "$nex", "$reduce_bool", "$logic_not") && y_width
== 1) ) {
446 a_expr
= stringf("pad(%s, %d)", a_expr
.c_str(), y_width
);
450 bool always_uint
= false;
451 if (cell
->type
== "$not") primop
= "not";
452 else if (cell
->type
== "$neg") {
454 is_signed
= true; // Result of "neg" is signed (an SInt).
455 } else if (cell
->type
== "$logic_not") {
457 a_expr
= stringf("%s, UInt(0)", a_expr
.c_str());
459 else if (cell
->type
== "$reduce_and") primop
= "andr";
460 else if (cell
->type
== "$reduce_or") primop
= "orr";
461 else if (cell
->type
== "$reduce_xor") primop
= "xorr";
462 else if (cell
->type
== "$reduce_xnor") {
464 a_expr
= stringf("xorr(%s)", a_expr
.c_str());
466 else if (cell
->type
== "$reduce_bool") {
468 // Use the sign of the a_expr and its width as the type (UInt/SInt) and width of the comparand.
469 bool a_signed
= cell
->parameters
.at("\\A_SIGNED").as_bool();
470 int a_width
= cell
->parameters
.at("\\A_WIDTH").as_int();
471 a_expr
= stringf("%s, %cInt<%d>(0)", a_expr
.c_str(), a_signed
? 'S' : 'U', a_width
);
474 string expr
= stringf("%s(%s)", primop
.c_str(), a_expr
.c_str());
476 if ((is_signed
&& !always_uint
))
477 expr
= stringf("asUInt(%s)", expr
.c_str());
479 cell_exprs
.push_back(stringf(" %s <= %s\n", y_id
.c_str(), expr
.c_str()));
480 register_reverse_wire_map(y_id
, cell
->getPort("\\Y"));
484 if (cell
->type
.in("$add", "$sub", "$mul", "$div", "$mod", "$xor", "$and", "$or", "$eq", "$eqx",
485 "$gt", "$ge", "$lt", "$le", "$ne", "$nex", "$shr", "$sshr", "$sshl", "$shl",
486 "$logic_and", "$logic_or"))
488 string y_id
= make_id(cell
->name
);
489 bool is_signed
= cell
->parameters
.at("\\A_SIGNED").as_bool();
490 int y_width
= cell
->parameters
.at("\\Y_WIDTH").as_int();
491 string a_expr
= make_expr(cell
->getPort("\\A"));
492 string b_expr
= make_expr(cell
->getPort("\\B"));
493 int b_padded_width
= cell
->parameters
.at("\\B_WIDTH").as_int();
494 wire_decls
.push_back(stringf(" wire %s: UInt<%d>\n", y_id
.c_str(), y_width
));
496 if (cell
->parameters
.at("\\A_SIGNED").as_bool()) {
497 a_expr
= "asSInt(" + a_expr
+ ")";
499 // Shift amount is always unsigned, and needn't be padded to result width.
500 if (!cell
->type
.in("$shr", "$sshr", "$shl", "$sshl")) {
501 if (cell
->parameters
.at("\\B_SIGNED").as_bool()) {
502 b_expr
= "asSInt(" + b_expr
+ ")";
504 if (b_padded_width
< y_width
) {
505 auto b_sig
= cell
->getPort("\\B");
506 b_padded_width
= y_width
;
510 auto a_sig
= cell
->getPort("\\A");
512 if (cell
->parameters
.at("\\A_SIGNED").as_bool() & (cell
->type
== "$shr")) {
513 a_expr
= "asUInt(" + a_expr
+ ")";
517 bool always_uint
= false;
518 if (cell
->type
== "$add") primop
= "add";
519 else if (cell
->type
== "$sub") primop
= "sub";
520 else if (cell
->type
== "$mul") primop
= "mul";
521 else if (cell
->type
== "$div") primop
= "div";
522 else if (cell
->type
== "$mod") primop
= "rem";
523 else if (cell
->type
== "$and") {
527 else if (cell
->type
== "$or" ) {
531 else if (cell
->type
== "$xor") {
535 else if ((cell
->type
== "$eq") | (cell
->type
== "$eqx")) {
539 else if ((cell
->type
== "$ne") | (cell
->type
== "$nex")) {
543 else if (cell
->type
== "$gt") {
547 else if (cell
->type
== "$ge") {
551 else if (cell
->type
== "$lt") {
555 else if (cell
->type
== "$le") {
559 else if ((cell
->type
== "$shl") | (cell
->type
== "$sshl")) {
560 // FIRRTL will widen the result (y) by the amount of the shift.
561 // We'll need to offset this by extracting the un-widened portion as Verilog would do.
562 extract_y_bits
= true;
563 // Is the shift amount constant?
564 auto b_sig
= cell
->getPort("\\B");
565 if (b_sig
.is_fully_const()) {
567 b_expr
= std::to_string(b_sig
.as_int());
570 // Convert from FIRRTL left shift semantics.
571 b_expr
= gen_dshl(b_expr
, b_padded_width
);
574 else if ((cell
->type
== "$shr") | (cell
->type
== "$sshr")) {
575 // We don't need to extract a specific range of bits.
576 extract_y_bits
= false;
577 // Is the shift amount constant?
578 auto b_sig
= cell
->getPort("\\B");
579 if (b_sig
.is_fully_const()) {
581 b_expr
= std::to_string(b_sig
.as_int());
586 else if ((cell
->type
== "$logic_and")) {
588 a_expr
= "neq(" + a_expr
+ ", UInt(0))";
589 b_expr
= "neq(" + b_expr
+ ", UInt(0))";
592 else if ((cell
->type
== "$logic_or")) {
594 a_expr
= "neq(" + a_expr
+ ", UInt(0))";
595 b_expr
= "neq(" + b_expr
+ ", UInt(0))";
599 if (!cell
->parameters
.at("\\B_SIGNED").as_bool()) {
600 b_expr
= "asUInt(" + b_expr
+ ")";
603 string expr
= stringf("%s(%s, %s)", primop
.c_str(), a_expr
.c_str(), b_expr
.c_str());
605 // Deal with FIRRTL's "shift widens" semantics
606 if (extract_y_bits
) {
607 expr
= stringf("bits(%s, %d, 0)", expr
.c_str(), y_width
- 1);
610 if ((is_signed
&& !always_uint
) || cell
->type
.in("$sub"))
611 expr
= stringf("asUInt(%s)", expr
.c_str());
613 cell_exprs
.push_back(stringf(" %s <= %s\n", y_id
.c_str(), expr
.c_str()));
614 register_reverse_wire_map(y_id
, cell
->getPort("\\Y"));
619 if (cell
->type
.in("$mux"))
621 string y_id
= make_id(cell
->name
);
622 int width
= cell
->parameters
.at("\\WIDTH").as_int();
623 string a_expr
= make_expr(cell
->getPort("\\A"));
624 string b_expr
= make_expr(cell
->getPort("\\B"));
625 string s_expr
= make_expr(cell
->getPort("\\S"));
626 wire_decls
.push_back(stringf(" wire %s: UInt<%d>\n", y_id
.c_str(), width
));
628 string expr
= stringf("mux(%s, %s, %s)", s_expr
.c_str(), b_expr
.c_str(), a_expr
.c_str());
630 cell_exprs
.push_back(stringf(" %s <= %s\n", y_id
.c_str(), expr
.c_str()));
631 register_reverse_wire_map(y_id
, cell
->getPort("\\Y"));
636 if (cell
->type
.in("$mem"))
638 string mem_id
= make_id(cell
->name
);
639 int abits
= cell
->parameters
.at("\\ABITS").as_int();
640 int width
= cell
->parameters
.at("\\WIDTH").as_int();
641 int size
= cell
->parameters
.at("\\SIZE").as_int();
642 memory
m(cell
, mem_id
, abits
, size
, width
);
643 int rd_ports
= cell
->parameters
.at("\\RD_PORTS").as_int();
644 int wr_ports
= cell
->parameters
.at("\\WR_PORTS").as_int();
646 Const initdata
= cell
->parameters
.at("\\INIT");
647 for (State bit
: initdata
.bits
)
648 if (bit
!= State::Sx
)
649 log_error("Memory with initialization data: %s.%s\n", log_id(module
), log_id(cell
));
651 Const rd_clk_enable
= cell
->parameters
.at("\\RD_CLK_ENABLE");
652 Const wr_clk_enable
= cell
->parameters
.at("\\WR_CLK_ENABLE");
653 Const wr_clk_polarity
= cell
->parameters
.at("\\WR_CLK_POLARITY");
655 int offset
= cell
->parameters
.at("\\OFFSET").as_int();
657 log_error("Memory with nonzero offset: %s.%s\n", log_id(module
), log_id(cell
));
659 for (int i
= 0; i
< rd_ports
; i
++)
661 if (rd_clk_enable
[i
] != State::S0
)
662 log_error("Clocked read port %d on memory %s.%s.\n", i
, log_id(module
), log_id(cell
));
664 SigSpec addr_sig
= cell
->getPort("\\RD_ADDR").extract(i
*abits
, abits
);
665 SigSpec data_sig
= cell
->getPort("\\RD_DATA").extract(i
*width
, width
);
666 string addr_expr
= make_expr(addr_sig
);
667 string
name(stringf("%s.r%d", m
.name
.c_str(), i
));
668 bool clk_enable
= false;
669 bool clk_parity
= true;
670 bool transparency
= false;
671 SigSpec ena_sig
= RTLIL::SigSpec(RTLIL::State::S1
, 1);
672 SigSpec clk_sig
= RTLIL::SigSpec(RTLIL::State::S0
, 1);
673 read_port
rp(name
, clk_enable
, clk_parity
, transparency
, clk_sig
, ena_sig
, addr_sig
);
674 m
.add_memory_read_port(rp
);
675 cell_exprs
.push_back(rp
.gen_read(indent
.c_str()));
676 register_reverse_wire_map(stringf("%s.data", name
.c_str()), data_sig
);
679 for (int i
= 0; i
< wr_ports
; i
++)
681 if (wr_clk_enable
[i
] != State::S1
)
682 log_error("Unclocked write port %d on memory %s.%s.\n", i
, log_id(module
), log_id(cell
));
684 if (wr_clk_polarity
[i
] != State::S1
)
685 log_error("Negedge write port %d on memory %s.%s.\n", i
, log_id(module
), log_id(cell
));
687 string
name(stringf("%s.w%d", m
.name
.c_str(), i
));
688 bool clk_enable
= true;
689 bool clk_parity
= true;
690 bool transparency
= false;
691 SigSpec addr_sig
=cell
->getPort("\\WR_ADDR").extract(i
*abits
, abits
);
692 string addr_expr
= make_expr(addr_sig
);
693 SigSpec data_sig
=cell
->getPort("\\WR_DATA").extract(i
*width
, width
);
694 string data_expr
= make_expr(data_sig
);
695 SigSpec clk_sig
= cell
->getPort("\\WR_CLK").extract(i
);
696 string clk_expr
= make_expr(clk_sig
);
698 SigSpec wen_sig
= cell
->getPort("\\WR_EN").extract(i
*width
, width
);
699 string wen_expr
= make_expr(wen_sig
[0]);
701 for (int i
= 1; i
< GetSize(wen_sig
); i
++)
702 if (wen_sig
[0] != wen_sig
[i
])
703 log_error("Complex write enable on port %d on memory %s.%s.\n", i
, log_id(module
), log_id(cell
));
705 SigSpec mask_sig
= RTLIL::SigSpec(RTLIL::State::S1
, 1);
706 write_port
wp(name
, clk_enable
, clk_parity
, transparency
, clk_sig
, wen_sig
[0], addr_sig
, mask_sig
);
707 m
.add_memory_write_port(wp
);
708 cell_exprs
.push_back(stringf("%s%s.data <= %s\n", indent
.c_str(), name
.c_str(), data_expr
.c_str()));
709 cell_exprs
.push_back(wp
.gen_write(indent
.c_str()));
715 if (cell
->type
.in("$memwr", "$memrd", "$meminit"))
717 std::string cell_type
= fid(cell
->type
);
718 std::string mem_id
= make_id(cell
->parameters
["\\MEMID"].decode_string());
719 int abits
= cell
->parameters
.at("\\ABITS").as_int();
720 int width
= cell
->parameters
.at("\\WIDTH").as_int();
721 memory
*mp
= nullptr;
722 if (cell
->type
== "$meminit" ) {
723 log_error("$meminit (%s.%s.%s) currently unsupported\n", log_id(module
), log_id(cell
), mem_id
.c_str());
725 // It's a $memwr or $memrd. Remember the read/write port parameters for the eventual FIRRTL memory definition.
726 auto addrSig
= cell
->getPort("\\ADDR");
727 auto dataSig
= cell
->getPort("\\DATA");
728 auto enableSig
= cell
->getPort("\\EN");
729 auto clockSig
= cell
->getPort("\\CLK");
730 Const clk_enable
= cell
->parameters
.at("\\CLK_ENABLE");
731 Const clk_polarity
= cell
->parameters
.at("\\CLK_POLARITY");
733 // Do we already have an entry for this memory?
734 if (memories
.count(mem_id
) == 0) {
735 memory
m(cell
, mem_id
, abits
, 0, width
);
738 mp
= &memories
.at(mem_id
);
740 bool transparency
= false;
741 string data_expr
= make_expr(dataSig
);
742 if (cell
->type
.in("$memwr")) {
743 portNum
= (int) mp
->write_ports
.size();
744 write_port
wp(stringf("%s.w%d", mem_id
.c_str(), portNum
), clk_enable
.as_bool(), clk_polarity
.as_bool(), transparency
, clockSig
, enableSig
, addrSig
, dataSig
);
745 mp
->add_memory_write_port(wp
);
746 cell_exprs
.push_back(stringf("%s%s.data <= %s\n", indent
.c_str(), wp
.name
.c_str(), data_expr
.c_str()));
747 cell_exprs
.push_back(wp
.gen_write(indent
.c_str()));
748 } else if (cell
->type
.in("$memrd")) {
749 portNum
= (int) mp
->read_ports
.size();
750 read_port
rp(stringf("%s.r%d", mem_id
.c_str(), portNum
), clk_enable
.as_bool(), clk_polarity
.as_bool(), transparency
, clockSig
, enableSig
, addrSig
);
751 mp
->add_memory_read_port(rp
);
752 cell_exprs
.push_back(rp
.gen_read(indent
.c_str()));
753 register_reverse_wire_map(stringf("%s.data", rp
.name
.c_str()), dataSig
);
759 if (cell
->type
.in("$dff"))
761 bool clkpol
= cell
->parameters
.at("\\CLK_POLARITY").as_bool();
763 log_error("Negative edge clock on FF %s.%s.\n", log_id(module
), log_id(cell
));
765 string q_id
= make_id(cell
->name
);
766 int width
= cell
->parameters
.at("\\WIDTH").as_int();
767 string expr
= make_expr(cell
->getPort("\\D"));
768 string clk_expr
= "asClock(" + make_expr(cell
->getPort("\\CLK")) + ")";
770 wire_decls
.push_back(stringf(" reg %s: UInt<%d>, %s\n", q_id
.c_str(), width
, clk_expr
.c_str()));
772 cell_exprs
.push_back(stringf(" %s <= %s\n", q_id
.c_str(), expr
.c_str()));
773 register_reverse_wire_map(q_id
, cell
->getPort("\\Q"));
778 // This may be a parameterized module - paramod.
779 if (cell
->type
.substr(0, 8) == "$paramod")
781 process_instance(cell
, wire_exprs
);
784 if (cell
->type
== "$shiftx") {
785 // assign y = a[b +: y_width];
786 // We'll extract the correct bits as part of the primop.
788 string y_id
= make_id(cell
->name
);
789 int y_width
= cell
->parameters
.at("\\Y_WIDTH").as_int();
790 string a_expr
= make_expr(cell
->getPort("\\A"));
791 // Get the initial bit selector
792 string b_expr
= make_expr(cell
->getPort("\\B"));
793 wire_decls
.push_back(stringf(" wire %s: UInt<%d>\n", y_id
.c_str(), y_width
));
795 if (cell
->getParam("\\B_SIGNED").as_bool()) {
796 // Use validif to constrain the selection (test the sign bit)
797 auto b_string
= b_expr
.c_str();
798 int b_sign
= cell
->parameters
.at("\\B_WIDTH").as_int() - 1;
799 b_expr
= stringf("validif(not(bits(%s, %d, %d)), %s)", b_string
, b_sign
, b_sign
, b_string
);
801 string expr
= stringf("dshr(%s, %s)", a_expr
.c_str(), b_expr
.c_str());
803 cell_exprs
.push_back(stringf(" %s <= %s\n", y_id
.c_str(), expr
.c_str()));
804 register_reverse_wire_map(y_id
, cell
->getPort("\\Y"));
807 if (cell
->type
== "$shift") {
808 // assign y = a >> b;
809 // where b may be negative
811 string y_id
= make_id(cell
->name
);
812 int y_width
= cell
->parameters
.at("\\Y_WIDTH").as_int();
813 string a_expr
= make_expr(cell
->getPort("\\A"));
814 string b_expr
= make_expr(cell
->getPort("\\B"));
815 auto b_string
= b_expr
.c_str();
816 int b_padded_width
= cell
->parameters
.at("\\B_WIDTH").as_int();
818 wire_decls
.push_back(stringf(" wire %s: UInt<%d>\n", y_id
.c_str(), y_width
));
820 if (cell
->getParam("\\B_SIGNED").as_bool()) {
821 // We generate a left or right shift based on the sign of b.
822 std::string dshl
= stringf("bits(dshl(%s, %s), 0, %d)", a_expr
.c_str(), gen_dshl(b_expr
, b_padded_width
).c_str(), y_width
);
823 std::string dshr
= stringf("dshr(%s, %s)", a_expr
.c_str(), b_string
);
824 expr
= stringf("mux(%s < 0, %s, %s)",
830 expr
= stringf("dshr(%s, %s)", a_expr
.c_str(), b_string
);
832 cell_exprs
.push_back(stringf(" %s <= %s\n", y_id
.c_str(), expr
.c_str()));
833 register_reverse_wire_map(y_id
, cell
->getPort("\\Y"));
836 log_warning("Cell type not supported: %s (%s.%s)\n", log_id(cell
->type
), log_id(module
), log_id(cell
));
839 for (auto conn
: module
->connections())
841 string y_id
= next_id();
842 int y_width
= GetSize(conn
.first
);
843 string expr
= make_expr(conn
.second
);
845 wire_decls
.push_back(stringf(" wire %s: UInt<%d>\n", y_id
.c_str(), y_width
));
846 cell_exprs
.push_back(stringf(" %s <= %s\n", y_id
.c_str(), expr
.c_str()));
847 register_reverse_wire_map(y_id
, conn
.first
);
850 for (auto wire
: module
->wires())
854 if (wire
->port_input
)
858 bool is_valid
= false;
859 bool make_unconn_id
= false;
861 while (cursor
< wire
->width
)
866 SigBit
start_bit(wire
, cursor
);
868 if (reverse_wire_map
.count(start_bit
))
870 pair
<string
, int> start_map
= reverse_wire_map
.at(start_bit
);
872 while (cursor
+chunk_width
< wire
->width
)
874 SigBit
stop_bit(wire
, cursor
+chunk_width
);
876 if (reverse_wire_map
.count(stop_bit
) == 0)
879 pair
<string
, int> stop_map
= reverse_wire_map
.at(stop_bit
);
880 stop_map
.second
-= chunk_width
;
882 if (start_map
!= stop_map
)
888 new_expr
= stringf("bits(%s, %d, %d)", start_map
.first
.c_str(),
889 start_map
.second
+ chunk_width
- 1, start_map
.second
);
894 if (unconn_id
.empty()) {
895 unconn_id
= next_id();
896 make_unconn_id
= true;
898 new_expr
= unconn_id
;
904 expr
= "cat(" + new_expr
+ ", " + expr
+ ")";
906 cursor
+= chunk_width
;
910 if (make_unconn_id
) {
911 wire_decls
.push_back(stringf(" wire %s: UInt<1>\n", unconn_id
.c_str()));
912 wire_decls
.push_back(stringf(" %s is invalid\n", unconn_id
.c_str()));
914 wire_exprs
.push_back(stringf(" %s <= %s\n", make_id(wire
->name
), expr
.c_str()));
916 if (make_unconn_id
) {
919 wire_decls
.push_back(stringf(" %s is invalid\n", make_id(wire
->name
)));
923 for (auto str
: port_decls
)
928 for (auto str
: wire_decls
)
933 // If we have any memory definitions, output them.
934 for (auto kv
: memories
) {
935 memory
&m
= kv
.second
;
936 f
<< stringf(" mem %s:\n", m
.name
.c_str());
937 f
<< stringf(" data-type => UInt<%d>\n", m
.width
);
938 f
<< stringf(" depth => %d\n", m
.size
);
939 for (int i
= 0; i
< (int) m
.read_ports
.size(); i
+= 1) {
940 f
<< stringf(" reader => r%d\n", i
);
942 for (int i
= 0; i
< (int) m
.write_ports
.size(); i
+= 1) {
943 f
<< stringf(" writer => w%d\n", i
);
945 f
<< stringf(" read-latency => %d\n", m
.read_latency
);
946 f
<< stringf(" write-latency => %d\n", m
.write_latency
);
947 f
<< stringf(" read-under-write => undefined\n");
951 for (auto str
: cell_exprs
)
956 for (auto str
: wire_exprs
)
961 struct FirrtlBackend
: public Backend
{
962 FirrtlBackend() : Backend("firrtl", "write design to a FIRRTL file") { }
963 void help() YS_OVERRIDE
965 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
967 log(" write_firrtl [options] [filename]\n");
969 log("Write a FIRRTL netlist of the current design.\n");
970 log("The following commands are executed by this command:\n");
974 void execute(std::ostream
*&f
, std::string filename
, std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
976 size_t argidx
= args
.size(); // We aren't expecting any arguments.
978 // If we weren't explicitly passed a filename, use the last argument (if it isn't a flag).
979 if (filename
== "") {
980 if (argidx
> 0 && args
[argidx
- 1][0] != '-') {
981 // extra_args and friends need to see this argument.
983 filename
= args
[argidx
];
986 extra_args(f
, filename
, args
, argidx
);
988 if (!design
->full_selection())
989 log_cmd_error("This command only operates on fully selected designs!\n");
991 log_header(design
, "Executing FIRRTL backend.\n");
994 Pass::call(design
, stringf("pmuxtree"));
999 // Get the top module, or a reasonable facsimile - we need something for the circuit name.
1000 Module
*top
= design
->top_module();
1001 Module
*last
= nullptr;
1002 // Generate module and wire names.
1003 for (auto module
: design
->modules()) {
1004 make_id(module
->name
);
1006 if (top
== nullptr && module
->get_bool_attribute("\\top")) {
1009 for (auto wire
: module
->wires())
1011 make_id(wire
->name
);
1017 *f
<< stringf("circuit %s:\n", make_id(top
->name
));
1019 for (auto module
: design
->modules())
1021 FirrtlWorker
worker(module
, *f
, design
);
1030 PRIVATE_NAMESPACE_END