Add comment as per @cliffordwolf
[yosys.git] / passes / techmap / shregmap.cc
1 /*
2 * yosys -- Yosys Open SYnthesis Suite
3 *
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
5 *
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.
9 *
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.
17 *
18 */
19
20 #include "kernel/yosys.h"
21 #include "kernel/sigtools.h"
22
23 USING_YOSYS_NAMESPACE
24 PRIVATE_NAMESPACE_BEGIN
25
26 struct ShregmapTech
27 {
28 virtual ~ShregmapTech() { }
29 virtual void init(const Module * /*module*/, const SigMap &/*sigmap*/) {}
30 virtual void non_chain_user(const SigBit &/*bit*/, const Cell* /*cell*/, IdString /*port*/) {}
31 virtual bool analyze(vector<int> &taps, const vector<SigBit> &qbits) = 0;
32 virtual bool fixup(Cell *cell, dict<int, SigBit> &taps) = 0;
33 };
34
35 struct ShregmapOptions
36 {
37 int minlen, maxlen;
38 int keep_before, keep_after;
39 bool zinit, init, params, ffe;
40 dict<IdString, pair<IdString, IdString>> ffcells;
41 ShregmapTech *tech;
42
43 ShregmapOptions()
44 {
45 minlen = 2;
46 maxlen = 0;
47 keep_before = 0;
48 keep_after = 0;
49 zinit = false;
50 init = false;
51 params = false;
52 ffe = false;
53 tech = nullptr;
54 }
55 };
56
57 struct ShregmapTechGreenpak4 : ShregmapTech
58 {
59 bool analyze(vector<int> &taps, const vector<SigBit> &/*qbits*/)
60 {
61 if (GetSize(taps) > 2 && taps[0] == 0 && taps[2] < 17) {
62 taps.clear();
63 return true;
64 }
65
66 if (GetSize(taps) > 2)
67 return false;
68
69 if (taps.back() > 16) return false;
70
71 return true;
72 }
73
74 bool fixup(Cell *cell, dict<int, SigBit> &taps)
75 {
76 auto D = cell->getPort("\\D");
77 auto C = cell->getPort("\\C");
78
79 auto newcell = cell->module->addCell(NEW_ID, "\\GP_SHREG");
80 newcell->setPort("\\nRST", State::S1);
81 newcell->setPort("\\CLK", C);
82 newcell->setPort("\\IN", D);
83
84 int i = 0;
85 for (auto tap : taps) {
86 newcell->setPort(i ? "\\OUTB" : "\\OUTA", tap.second);
87 newcell->setParam(i ? "\\OUTB_TAP" : "\\OUTA_TAP", tap.first + 1);
88 i++;
89 }
90
91 cell->setParam("\\OUTA_INVERT", 0);
92 return false;
93 }
94 };
95
96 struct ShregmapTechXilinx7 : ShregmapTech
97 {
98 dict<SigBit, std::tuple<Cell*,int,int>> sigbit_to_shiftx_offset;
99 const ShregmapOptions &opts;
100
101 ShregmapTechXilinx7(const ShregmapOptions &opts) : opts(opts) {}
102
103 virtual void init(const Module* module, const SigMap &sigmap) override
104 {
105 for (const auto &i : module->cells_) {
106 auto cell = i.second;
107 if (cell->type == "$shiftx") {
108 if (cell->getParam("\\Y_WIDTH") != 1) continue;
109 int j = 0;
110 for (auto bit : sigmap(cell->getPort("\\A")))
111 sigbit_to_shiftx_offset[bit] = std::make_tuple(cell, j++, 0);
112 log_assert(j == cell->getParam("\\A_WIDTH").as_int());
113 }
114 else if (cell->type == "$mux") {
115 int j = 0;
116 for (auto bit : sigmap(cell->getPort("\\A")))
117 sigbit_to_shiftx_offset[bit] = std::make_tuple(cell, 0, j++);
118 j = 0;
119 for (auto bit : sigmap(cell->getPort("\\B")))
120 sigbit_to_shiftx_offset[bit] = std::make_tuple(cell, 1, j++);
121 }
122 }
123 }
124
125 virtual void non_chain_user(const SigBit &bit, const Cell *cell, IdString port) override
126 {
127 auto it = sigbit_to_shiftx_offset.find(bit);
128 if (it == sigbit_to_shiftx_offset.end())
129 return;
130 if (cell) {
131 if (cell->type == "$shiftx" && port == "\\A")
132 return;
133 if (cell->type == "$mux" && (port == "\\A" || port == "\\B"))
134 return;
135 }
136 sigbit_to_shiftx_offset.erase(it);
137 }
138
139 virtual bool analyze(vector<int> &taps, const vector<SigBit> &qbits) override
140 {
141 if (GetSize(taps) == 1)
142 return taps[0] >= opts.minlen-1 && sigbit_to_shiftx_offset.count(qbits[0]);
143
144 if (taps.back() < opts.minlen-1)
145 return false;
146
147 Cell *shiftx = nullptr;
148 int group = 0;
149 for (int i = 0; i < GetSize(taps); ++i) {
150 auto it = sigbit_to_shiftx_offset.find(qbits[i]);
151 if (it == sigbit_to_shiftx_offset.end())
152 return false;
153
154 // Check taps are sequential
155 if (i != taps[i])
156 return false;
157 // Check taps are not connected to a shift register,
158 // or sequential to the same shift register
159 if (i == 0) {
160 int offset;
161 std::tie(shiftx,offset,group) = it->second;
162 if (offset != i)
163 return false;
164 }
165 else {
166 Cell *shiftx_ = std::get<0>(it->second);
167 if (shiftx_ != shiftx)
168 return false;
169 int offset = std::get<1>(it->second);
170 if (offset != i)
171 return false;
172 int group_ = std::get<2>(it->second);
173 if (group_ != group)
174 return false;
175 }
176 }
177 log_assert(shiftx);
178
179 // Only map if $shiftx exclusively covers the shift register
180 if (shiftx->type == "$shiftx") {
181 if (GetSize(taps) > shiftx->getParam("\\A_WIDTH").as_int())
182 return false;
183 // Due to padding the most significant bits of A may be 1'bx,
184 // and if so, discount them
185 if (GetSize(taps) < shiftx->getParam("\\A_WIDTH").as_int()) {
186 const SigSpec A = shiftx->getPort("\\A");
187 const int A_width = shiftx->getParam("\\A_WIDTH").as_int();
188 for (int i = GetSize(taps); i < A_width; ++i)
189 if (A[i] != RTLIL::Sx) return false;
190 }
191 else if (GetSize(taps) != shiftx->getParam("\\A_WIDTH").as_int())
192 return false;
193 }
194 else if (shiftx->type == "$mux") {
195 if (GetSize(taps) != 2)
196 return false;
197 }
198 else log_abort();
199
200 return true;
201 }
202
203 virtual bool fixup(Cell *cell, dict<int, SigBit> &taps) override
204 {
205 const auto &tap = *taps.begin();
206 auto bit = tap.second;
207
208 auto it = sigbit_to_shiftx_offset.find(bit);
209 log_assert(it != sigbit_to_shiftx_offset.end());
210
211 auto newcell = cell->module->addCell(NEW_ID, "$__XILINX_SHREG_");
212 newcell->set_src_attribute(cell->get_src_attribute());
213 newcell->setParam("\\DEPTH", cell->getParam("\\DEPTH"));
214 newcell->setParam("\\INIT", cell->getParam("\\INIT"));
215 newcell->setParam("\\CLKPOL", cell->getParam("\\CLKPOL"));
216 newcell->setParam("\\ENPOL", cell->getParam("\\ENPOL"));
217
218 newcell->setPort("\\C", cell->getPort("\\C"));
219 newcell->setPort("\\D", cell->getPort("\\D"));
220 if (cell->hasPort("\\E"))
221 newcell->setPort("\\E", cell->getPort("\\E"));
222
223 Cell* shiftx = std::get<0>(it->second);
224 RTLIL::SigSpec l_wire, q_wire;
225 if (shiftx->type == "$shiftx") {
226 l_wire = shiftx->getPort("\\B");
227 q_wire = shiftx->getPort("\\Y");
228 shiftx->setPort("\\Y", cell->module->addWire(NEW_ID));
229 }
230 else if (shiftx->type == "$mux") {
231 l_wire = shiftx->getPort("\\S");
232 q_wire = shiftx->getPort("\\Y");
233 shiftx->setPort("\\Y", cell->module->addWire(NEW_ID));
234 }
235 else log_abort();
236
237 newcell->setPort("\\Q", q_wire);
238 newcell->setPort("\\L", l_wire);
239
240 return false;
241 }
242 };
243
244
245 struct ShregmapWorker
246 {
247 Module *module;
248 SigMap sigmap;
249
250 const ShregmapOptions &opts;
251 int dff_count, shreg_count;
252
253 pool<Cell*> remove_cells;
254 pool<SigBit> remove_init;
255
256 dict<SigBit, bool> sigbit_init;
257 dict<SigBit, Cell*> sigbit_chain_next;
258 dict<SigBit, Cell*> sigbit_chain_prev;
259 pool<SigBit> sigbit_with_non_chain_users;
260 pool<Cell*> chain_start_cells;
261
262 void make_sigbit_chain_next_prev()
263 {
264 for (auto wire : module->wires())
265 {
266 if (wire->port_output || wire->get_bool_attribute("\\keep")) {
267 for (auto bit : sigmap(wire)) {
268 sigbit_with_non_chain_users.insert(bit);
269 if (opts.tech) opts.tech->non_chain_user(bit, nullptr, {});
270 }
271 }
272
273 if (wire->attributes.count("\\init")) {
274 SigSpec initsig = sigmap(wire);
275 Const initval = wire->attributes.at("\\init");
276 for (int i = 0; i < GetSize(initsig) && i < GetSize(initval); i++)
277 if (initval[i] == State::S0 && !opts.zinit)
278 sigbit_init[initsig[i]] = false;
279 else if (initval[i] == State::S1)
280 sigbit_init[initsig[i]] = true;
281 }
282 }
283
284 for (auto cell : module->cells())
285 {
286 if (opts.ffcells.count(cell->type) && !cell->get_bool_attribute("\\keep"))
287 {
288 IdString d_port = opts.ffcells.at(cell->type).first;
289 IdString q_port = opts.ffcells.at(cell->type).second;
290
291 SigBit d_bit = sigmap(cell->getPort(d_port).as_bit());
292 SigBit q_bit = sigmap(cell->getPort(q_port).as_bit());
293
294 if (opts.init || sigbit_init.count(q_bit) == 0)
295 {
296 auto r = sigbit_chain_next.insert(std::make_pair(d_bit, cell));
297 if (!r.second) {
298 // Insertion not successful means that d_bit is already
299 // connected to another register, thus mark it as a
300 // non chain user ...
301 sigbit_with_non_chain_users.insert(d_bit);
302 // ... and clone d_bit into another wire, and use that
303 // wire as a different key in the d_bit-to-cell dictionary
304 // so that it can be identified as another chain
305 // (omitting this common flop)
306 // Link: https://github.com/YosysHQ/yosys/pull/1085
307 // NB: This relies on us not updating sigmap with this
308 // alias otherwise it would think they are the same
309 // wire
310 Wire *wire = module->addWire(NEW_ID);
311 module->connect(wire, d_bit);
312 sigbit_chain_next.insert(std::make_pair(wire, cell));
313 }
314
315 sigbit_chain_prev[q_bit] = cell;
316 continue;
317 }
318 }
319
320 for (auto conn : cell->connections())
321 if (cell->input(conn.first))
322 for (auto bit : sigmap(conn.second)) {
323 sigbit_with_non_chain_users.insert(bit);
324 if (opts.tech) opts.tech->non_chain_user(bit, cell, conn.first);
325 }
326 }
327 }
328
329 void find_chain_start_cells()
330 {
331 for (auto it : sigbit_chain_next)
332 {
333 if (opts.tech == nullptr && sigbit_with_non_chain_users.count(it.first))
334 goto start_cell;
335
336 if (sigbit_chain_prev.count(it.first) != 0)
337 {
338 Cell *c1 = sigbit_chain_prev.at(it.first);
339 Cell *c2 = it.second;
340
341 if (c1->type != c2->type)
342 goto start_cell;
343
344 if (c1->parameters != c2->parameters)
345 goto start_cell;
346
347 IdString d_port = opts.ffcells.at(c1->type).first;
348 IdString q_port = opts.ffcells.at(c1->type).second;
349
350 auto c1_conn = c1->connections();
351 auto c2_conn = c1->connections();
352
353 c1_conn.erase(d_port);
354 c1_conn.erase(q_port);
355
356 c2_conn.erase(d_port);
357 c2_conn.erase(q_port);
358
359 if (c1_conn != c2_conn)
360 goto start_cell;
361
362 continue;
363 }
364
365 start_cell:
366 chain_start_cells.insert(it.second);
367 }
368 }
369
370 vector<Cell*> create_chain(Cell *start_cell)
371 {
372 vector<Cell*> chain;
373
374 Cell *c = start_cell;
375 while (c != nullptr)
376 {
377 chain.push_back(c);
378
379 IdString q_port = opts.ffcells.at(c->type).second;
380 SigBit q_bit = sigmap(c->getPort(q_port).as_bit());
381
382 if (sigbit_chain_next.count(q_bit) == 0)
383 break;
384
385 c = sigbit_chain_next.at(q_bit);
386 if (chain_start_cells.count(c) != 0)
387 break;
388 }
389
390 return chain;
391 }
392
393 void process_chain(vector<Cell*> &chain)
394 {
395 if (GetSize(chain) < opts.keep_before + opts.minlen + opts.keep_after)
396 return;
397
398 int cursor = opts.keep_before;
399 while (cursor < GetSize(chain) - opts.keep_after)
400 {
401 int depth = GetSize(chain) - opts.keep_after - cursor;
402
403 if (opts.maxlen > 0)
404 depth = std::min(opts.maxlen, depth);
405
406 Cell *first_cell = chain[cursor];
407 IdString q_port = opts.ffcells.at(first_cell->type).second;
408 dict<int, SigBit> taps_dict;
409
410 if (opts.tech)
411 {
412 vector<SigBit> qbits;
413 vector<int> taps;
414
415 for (int i = 0; i < depth; i++)
416 {
417 Cell *cell = chain[cursor+i];
418 auto qbit = sigmap(cell->getPort(q_port));
419 qbits.push_back(qbit);
420
421 if (sigbit_with_non_chain_users.count(qbit))
422 taps.push_back(i);
423 }
424
425 while (depth > 0)
426 {
427 if (taps.empty() || taps.back() < depth-1)
428 taps.push_back(depth-1);
429
430 if (opts.tech->analyze(taps, qbits))
431 break;
432
433 taps.pop_back();
434 depth--;
435 }
436
437 depth = 0;
438 for (auto tap : taps) {
439 taps_dict[tap] = qbits.at(tap);
440 log_assert(depth < tap+1);
441 depth = tap+1;
442 }
443 }
444
445 if (depth < 2) {
446 cursor++;
447 continue;
448 }
449
450 Cell *last_cell = chain[cursor+depth-1];
451
452 log("Converting %s.%s ... %s.%s to a shift register with depth %d.\n",
453 log_id(module), log_id(first_cell), log_id(module), log_id(last_cell), depth);
454
455 dff_count += depth;
456 shreg_count += 1;
457
458 string shreg_cell_type_str = "$__SHREG";
459 if (opts.params) {
460 shreg_cell_type_str += "_";
461 } else {
462 if (first_cell->type[1] != '_')
463 shreg_cell_type_str += "_";
464 shreg_cell_type_str += first_cell->type.substr(1);
465 }
466
467 if (opts.init) {
468 vector<State> initval;
469 for (int i = depth-1; i >= 0; i--) {
470 SigBit bit = sigmap(chain[cursor+i]->getPort(q_port).as_bit());
471 if (sigbit_init.count(bit) == 0)
472 initval.push_back(State::Sx);
473 else if (sigbit_init.at(bit))
474 initval.push_back(State::S1);
475 else
476 initval.push_back(State::S0);
477 remove_init.insert(bit);
478 }
479 first_cell->setParam("\\INIT", initval);
480 }
481
482 if (opts.zinit)
483 for (int i = depth-1; i >= 0; i--) {
484 SigBit bit = sigmap(chain[cursor+i]->getPort(q_port).as_bit());
485 remove_init.insert(bit);
486 }
487
488 if (opts.params)
489 {
490 int param_clkpol = -1;
491 int param_enpol = 2;
492
493 if (first_cell->type == "$_DFF_N_") param_clkpol = 0;
494 if (first_cell->type == "$_DFF_P_") param_clkpol = 1;
495
496 if (first_cell->type == "$_DFFE_NN_") param_clkpol = 0, param_enpol = 0;
497 if (first_cell->type == "$_DFFE_NP_") param_clkpol = 0, param_enpol = 1;
498 if (first_cell->type == "$_DFFE_PN_") param_clkpol = 1, param_enpol = 0;
499 if (first_cell->type == "$_DFFE_PP_") param_clkpol = 1, param_enpol = 1;
500
501 log_assert(param_clkpol >= 0);
502 first_cell->setParam("\\CLKPOL", param_clkpol);
503 if (opts.ffe) first_cell->setParam("\\ENPOL", param_enpol);
504 }
505
506 first_cell->type = shreg_cell_type_str;
507 first_cell->setPort(q_port, last_cell->getPort(q_port));
508 first_cell->setParam("\\DEPTH", depth);
509
510 if (opts.tech != nullptr && !opts.tech->fixup(first_cell, taps_dict))
511 remove_cells.insert(first_cell);
512
513 for (int i = 1; i < depth; i++)
514 remove_cells.insert(chain[cursor+i]);
515 cursor += depth;
516 }
517 }
518
519 void cleanup()
520 {
521 for (auto cell : remove_cells)
522 module->remove(cell);
523
524 for (auto wire : module->wires())
525 {
526 if (wire->attributes.count("\\init") == 0)
527 continue;
528
529 SigSpec initsig = sigmap(wire);
530 Const &initval = wire->attributes.at("\\init");
531
532 for (int i = 0; i < GetSize(initsig) && i < GetSize(initval); i++)
533 if (remove_init.count(initsig[i]))
534 initval[i] = State::Sx;
535
536 if (SigSpec(initval).is_fully_undef())
537 wire->attributes.erase("\\init");
538 }
539
540 remove_cells.clear();
541 sigbit_chain_next.clear();
542 sigbit_chain_prev.clear();
543 chain_start_cells.clear();
544 }
545
546 ShregmapWorker(Module *module, const ShregmapOptions &opts) :
547 module(module), sigmap(module), opts(opts), dff_count(0), shreg_count(0)
548 {
549 if (opts.tech)
550 opts.tech->init(module, sigmap);
551
552 make_sigbit_chain_next_prev();
553 find_chain_start_cells();
554
555 for (auto c : chain_start_cells) {
556 vector<Cell*> chain = create_chain(c);
557 process_chain(chain);
558 }
559
560 cleanup();
561 }
562 };
563
564 struct ShregmapPass : public Pass {
565 ShregmapPass() : Pass("shregmap", "map shift registers") { }
566 void help() YS_OVERRIDE
567 {
568 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
569 log("\n");
570 log(" shregmap [options] [selection]\n");
571 log("\n");
572 log("This pass converts chains of $_DFF_[NP]_ gates to target specific shift register\n");
573 log("primitives. The generated shift register will be of type $__SHREG_DFF_[NP]_ and\n");
574 log("will use the same interface as the original $_DFF_*_ cells. The cell parameter\n");
575 log("'DEPTH' will contain the depth of the shift register. Use a target-specific\n");
576 log("'techmap' map file to convert those cells to the actual target cells.\n");
577 log("\n");
578 log(" -minlen N\n");
579 log(" minimum length of shift register (default = 2)\n");
580 log(" (this is the length after -keep_before and -keep_after)\n");
581 log("\n");
582 log(" -maxlen N\n");
583 log(" maximum length of shift register (default = no limit)\n");
584 log(" larger chains will be mapped to multiple shift register instances\n");
585 log("\n");
586 log(" -keep_before N\n");
587 log(" number of DFFs to keep before the shift register (default = 0)\n");
588 log("\n");
589 log(" -keep_after N\n");
590 log(" number of DFFs to keep after the shift register (default = 0)\n");
591 log("\n");
592 log(" -clkpol pos|neg|any\n");
593 log(" limit match to only positive or negative edge clocks. (default = any)\n");
594 log("\n");
595 log(" -enpol pos|neg|none|any_or_none|any\n");
596 log(" limit match to FFs with the specified enable polarity. (default = none)\n");
597 log("\n");
598 log(" -match <cell_type>[:<d_port_name>:<q_port_name>]\n");
599 log(" match the specified cells instead of $_DFF_N_ and $_DFF_P_. If\n");
600 log(" ':<d_port_name>:<q_port_name>' is omitted then 'D' and 'Q' is used\n");
601 log(" by default. E.g. the option '-clkpol pos' is just an alias for\n");
602 log(" '-match $_DFF_P_', which is an alias for '-match $_DFF_P_:D:Q'.\n");
603 log("\n");
604 log(" -params\n");
605 log(" instead of encoding the clock and enable polarity in the cell name by\n");
606 log(" deriving from the original cell name, simply name all generated cells\n");
607 log(" $__SHREG_ and use CLKPOL and ENPOL parameters. An ENPOL value of 2 is\n");
608 log(" used to denote cells without enable input. The ENPOL parameter is\n");
609 log(" omitted when '-enpol none' (or no -enpol option) is passed.\n");
610 log("\n");
611 log(" -zinit\n");
612 log(" assume the shift register is automatically zero-initialized, so it\n");
613 log(" becomes legal to merge zero initialized FFs into the shift register.\n");
614 log("\n");
615 log(" -init\n");
616 log(" map initialized registers to the shift reg, add an INIT parameter to\n");
617 log(" generated cells with the initialization value. (first bit to shift out\n");
618 log(" in LSB position)\n");
619 log("\n");
620 log(" -tech greenpak4\n");
621 log(" map to greenpak4 shift registers.\n");
622 log("\n");
623 log(" -tech xilinx\n");
624 log(" map to xilinx dynamic-length shift registers.\n");
625 log("\n");
626 }
627 void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
628 {
629 ShregmapOptions opts;
630 string clkpol, enpol;
631
632 log_header(design, "Executing SHREGMAP pass (map shift registers).\n");
633
634 size_t argidx;
635 for (argidx = 1; argidx < args.size(); argidx++)
636 {
637 if (args[argidx] == "-clkpol" && argidx+1 < args.size()) {
638 clkpol = args[++argidx];
639 continue;
640 }
641 if (args[argidx] == "-enpol" && argidx+1 < args.size()) {
642 enpol = args[++argidx];
643 continue;
644 }
645 if (args[argidx] == "-match" && argidx+1 < args.size()) {
646 vector<string> match_args = split_tokens(args[++argidx], ":");
647 if (GetSize(match_args) < 2)
648 match_args.push_back("D");
649 if (GetSize(match_args) < 3)
650 match_args.push_back("Q");
651 IdString id_cell_type(RTLIL::escape_id(match_args[0]));
652 IdString id_d_port_name(RTLIL::escape_id(match_args[1]));
653 IdString id_q_port_name(RTLIL::escape_id(match_args[2]));
654 opts.ffcells[id_cell_type] = make_pair(id_d_port_name, id_q_port_name);
655 continue;
656 }
657 if (args[argidx] == "-minlen" && argidx+1 < args.size()) {
658 opts.minlen = atoi(args[++argidx].c_str());
659 continue;
660 }
661 if (args[argidx] == "-maxlen" && argidx+1 < args.size()) {
662 opts.maxlen = atoi(args[++argidx].c_str());
663 continue;
664 }
665 if (args[argidx] == "-keep_before" && argidx+1 < args.size()) {
666 opts.keep_before = atoi(args[++argidx].c_str());
667 continue;
668 }
669 if (args[argidx] == "-keep_after" && argidx+1 < args.size()) {
670 opts.keep_after = atoi(args[++argidx].c_str());
671 continue;
672 }
673 if (args[argidx] == "-tech" && argidx+1 < args.size() && opts.tech == nullptr) {
674 string tech = args[++argidx];
675 if (tech == "greenpak4") {
676 clkpol = "pos";
677 opts.zinit = true;
678 opts.tech = new ShregmapTechGreenpak4;
679 }
680 else if (tech == "xilinx") {
681 opts.init = true;
682 opts.params = true;
683 enpol = "any_or_none";
684 opts.tech = new ShregmapTechXilinx7(opts);
685 } else {
686 argidx--;
687 break;
688 }
689 continue;
690 }
691 if (args[argidx] == "-zinit") {
692 opts.zinit = true;
693 continue;
694 }
695 if (args[argidx] == "-init") {
696 opts.init = true;
697 continue;
698 }
699 if (args[argidx] == "-params") {
700 opts.params = true;
701 continue;
702 }
703 break;
704 }
705 extra_args(args, argidx, design);
706
707 if (opts.zinit && opts.init)
708 log_cmd_error("Options -zinit and -init are exclusive!\n");
709
710 if (opts.ffcells.empty())
711 {
712 bool clk_pos = clkpol == "" || clkpol == "pos" || clkpol == "any";
713 bool clk_neg = clkpol == "" || clkpol == "neg" || clkpol == "any";
714
715 bool en_none = enpol == "" || enpol == "none" || enpol == "any_or_none";
716 bool en_pos = enpol == "pos" || enpol == "any" || enpol == "any_or_none";
717 bool en_neg = enpol == "neg" || enpol == "any" || enpol == "any_or_none";
718
719 if (clk_pos && en_none)
720 opts.ffcells["$_DFF_P_"] = make_pair(IdString("\\D"), IdString("\\Q"));
721 if (clk_neg && en_none)
722 opts.ffcells["$_DFF_N_"] = make_pair(IdString("\\D"), IdString("\\Q"));
723
724 if (clk_pos && en_pos)
725 opts.ffcells["$_DFFE_PP_"] = make_pair(IdString("\\D"), IdString("\\Q"));
726 if (clk_pos && en_neg)
727 opts.ffcells["$_DFFE_PN_"] = make_pair(IdString("\\D"), IdString("\\Q"));
728
729 if (clk_neg && en_pos)
730 opts.ffcells["$_DFFE_NP_"] = make_pair(IdString("\\D"), IdString("\\Q"));
731 if (clk_neg && en_neg)
732 opts.ffcells["$_DFFE_NN_"] = make_pair(IdString("\\D"), IdString("\\Q"));
733
734 if (en_pos || en_neg)
735 opts.ffe = true;
736 }
737 else
738 {
739 if (!clkpol.empty())
740 log_cmd_error("Options -clkpol and -match are exclusive!\n");
741 if (!enpol.empty())
742 log_cmd_error("Options -enpol and -match are exclusive!\n");
743 if (opts.params)
744 log_cmd_error("Options -params and -match are exclusive!\n");
745 }
746
747 int dff_count = 0;
748 int shreg_count = 0;
749
750 for (auto module : design->selected_modules()) {
751 ShregmapWorker worker(module, opts);
752 dff_count += worker.dff_count;
753 shreg_count += worker.shreg_count;
754 }
755
756 log("Converted %d dff cells into %d shift registers.\n", dff_count, shreg_count);
757
758 if (opts.tech != nullptr) {
759 delete opts.tech;
760 opts.tech = nullptr;
761 }
762 }
763 } ShregmapPass;
764
765 PRIVATE_NAMESPACE_END