abc9_ops: still emit delay table even box has no timing
[yosys.git] / passes / techmap / shregmap.cc
index 3adcd89681251e744bb94cea31093fa610e04854..be00e50305b3179e184f8f698d801779164cb2f9 100644 (file)
@@ -26,9 +26,7 @@ PRIVATE_NAMESPACE_BEGIN
 struct ShregmapTech
 {
        virtual ~ShregmapTech() { }
-       virtual void init(const Module * /*module*/, const SigMap &/*sigmap*/) {}
-       virtual void non_chain_user(const SigBit &/*bit*/, const Cell* /*cell*/, IdString /*port*/) {}
-       virtual bool analyze(vector<int> &taps, const vector<SigBit> &qbits) = 0;
+       virtual bool analyze(vector<int> &taps) = 0;
        virtual bool fixup(Cell *cell, dict<int, SigBit> &taps) = 0;
 };
 
@@ -56,7 +54,7 @@ struct ShregmapOptions
 
 struct ShregmapTechGreenpak4 : ShregmapTech
 {
-       bool analyze(vector<int> &taps, const vector<SigBit> &/*qbits*/)
+       bool analyze(vector<int> &taps)
        {
                if (GetSize(taps) > 2 && taps[0] == 0 && taps[2] < 17) {
                        taps.clear();
@@ -73,175 +71,26 @@ struct ShregmapTechGreenpak4 : ShregmapTech
 
        bool fixup(Cell *cell, dict<int, SigBit> &taps)
        {
-               auto D = cell->getPort("\\D");
-               auto C = cell->getPort("\\C");
+               auto D = cell->getPort(ID(D));
+               auto C = cell->getPort(ID(C));
 
-               auto newcell = cell->module->addCell(NEW_ID, "\\GP_SHREG");
-               newcell->setPort("\\nRST", State::S1);
-               newcell->setPort("\\CLK", C);
-               newcell->setPort("\\IN", D);
+               auto newcell = cell->module->addCell(NEW_ID, ID(GP_SHREG));
+               newcell->setPort(ID(nRST), State::S1);
+               newcell->setPort(ID(CLK), C);
+               newcell->setPort(ID(IN), D);
 
                int i = 0;
                for (auto tap : taps) {
-                       newcell->setPort(i ? "\\OUTB" : "\\OUTA", tap.second);
-                       newcell->setParam(i ? "\\OUTB_TAP" : "\\OUTA_TAP", tap.first + 1);
+                       newcell->setPort(i ? ID(OUTB) : ID(OUTA), tap.second);
+                       newcell->setParam(i ? ID(OUTB_TAP) : ID(OUTA_TAP), tap.first + 1);
                        i++;
                }
 
-               cell->setParam("\\OUTA_INVERT", 0);
+               cell->setParam(ID(OUTA_INVERT), 0);
                return false;
        }
 };
 
-struct ShregmapTechXilinx7 : ShregmapTech
-{
-       dict<SigBit, std::tuple<Cell*,int,int>> sigbit_to_shiftx_offset;
-       const ShregmapOptions &opts;
-
-       ShregmapTechXilinx7(const ShregmapOptions &opts) : opts(opts) {}
-
-       virtual void init(const Module* module, const SigMap &sigmap) override
-       {
-               for (const auto &i : module->cells_) {
-                       auto cell = i.second;
-                       if (cell->type == "$shiftx") {
-                               if (cell->getParam("\\Y_WIDTH") != 1) continue;
-                               int j = 0;
-                               for (auto bit : sigmap(cell->getPort("\\A")))
-                                       sigbit_to_shiftx_offset[bit] = std::make_tuple(cell, j++, 0);
-                               log_assert(j == cell->getParam("\\A_WIDTH").as_int());
-                       }
-                       else if (cell->type == "$mux") {
-                               int j = 0;
-                               for (auto bit : sigmap(cell->getPort("\\A")))
-                                       sigbit_to_shiftx_offset[bit] = std::make_tuple(cell, 0, j++);
-                               j = 0;
-                               for (auto bit : sigmap(cell->getPort("\\B")))
-                                       sigbit_to_shiftx_offset[bit] = std::make_tuple(cell, 1, j++);
-                       }
-               }
-       }
-
-       virtual void non_chain_user(const SigBit &bit, const Cell *cell, IdString port) override
-       {
-               auto it = sigbit_to_shiftx_offset.find(bit);
-               if (it == sigbit_to_shiftx_offset.end())
-                       return;
-               if (cell) {
-                       if (cell->type == "$shiftx" && port == "\\A")
-                               return;
-                       if (cell->type == "$mux" && (port == "\\A" || port == "\\B"))
-                               return;
-               }
-               sigbit_to_shiftx_offset.erase(it);
-       }
-
-       virtual bool analyze(vector<int> &taps, const vector<SigBit> &qbits) override
-       {
-               if (GetSize(taps) == 1)
-                       return taps[0] >= opts.minlen-1 && sigbit_to_shiftx_offset.count(qbits[0]);
-
-               if (taps.back() < opts.minlen-1)
-                       return false;
-
-               Cell *shiftx = nullptr;
-               int group = 0;
-               for (int i = 0; i < GetSize(taps); ++i) {
-                       auto it = sigbit_to_shiftx_offset.find(qbits[i]);
-                       if (it == sigbit_to_shiftx_offset.end())
-                               return false;
-
-                       // Check taps are sequential
-                       if (i != taps[i])
-                               return false;
-                       // Check taps are not connected to a shift register,
-                       // or sequential to the same shift register
-                       if (i == 0) {
-                               int offset;
-                               std::tie(shiftx,offset,group) = it->second;
-                               if (offset != i)
-                                       return false;
-                       }
-                       else {
-                               Cell *shiftx_ = std::get<0>(it->second);
-                               if (shiftx_ != shiftx)
-                                       return false;
-                               int offset = std::get<1>(it->second);
-                               if (offset != i)
-                                       return false;
-                               int group_ = std::get<2>(it->second);
-                               if (group_ != group)
-                                       return false;
-                       }
-               }
-               log_assert(shiftx);
-
-               // Only map if $shiftx exclusively covers the shift register
-               if (shiftx->type == "$shiftx") {
-                       if (GetSize(taps) > shiftx->getParam("\\A_WIDTH").as_int())
-                               return false;
-                       // Due to padding the most significant bits of A may be 1'bx,
-                       //   and if so, discount them
-                       if (GetSize(taps) < shiftx->getParam("\\A_WIDTH").as_int()) {
-                               const SigSpec A = shiftx->getPort("\\A");
-                               const int A_width = shiftx->getParam("\\A_WIDTH").as_int();
-                               for (int i = GetSize(taps); i < A_width; ++i)
-                                       if (A[i] != RTLIL::Sx) return false;
-                       }
-                       else if (GetSize(taps) != shiftx->getParam("\\A_WIDTH").as_int())
-                               return false;
-               }
-               else if (shiftx->type == "$mux") {
-                       if (GetSize(taps) != 2)
-                               return false;
-               }
-               else log_abort();
-
-               return true;
-       }
-
-       virtual bool fixup(Cell *cell, dict<int, SigBit> &taps) override
-       {
-               const auto &tap = *taps.begin();
-               auto bit = tap.second;
-
-               auto it = sigbit_to_shiftx_offset.find(bit);
-               log_assert(it != sigbit_to_shiftx_offset.end());
-
-               auto newcell = cell->module->addCell(NEW_ID, "$__XILINX_SHREG_");
-               newcell->set_src_attribute(cell->get_src_attribute());
-               newcell->setParam("\\DEPTH", cell->getParam("\\DEPTH"));
-               newcell->setParam("\\INIT", cell->getParam("\\INIT"));
-               newcell->setParam("\\CLKPOL", cell->getParam("\\CLKPOL"));
-               newcell->setParam("\\ENPOL", cell->getParam("\\ENPOL"));
-
-               newcell->setPort("\\C", cell->getPort("\\C"));
-               newcell->setPort("\\D", cell->getPort("\\D"));
-               if (cell->hasPort("\\E"))
-                       newcell->setPort("\\E", cell->getPort("\\E"));
-
-               Cell* shiftx = std::get<0>(it->second);
-               RTLIL::SigSpec l_wire, q_wire;
-               if (shiftx->type == "$shiftx") {
-                       l_wire = shiftx->getPort("\\B");
-                       q_wire = shiftx->getPort("\\Y");
-                       shiftx->setPort("\\Y", cell->module->addWire(NEW_ID));
-               }
-               else if (shiftx->type == "$mux") {
-                       l_wire = shiftx->getPort("\\S");
-                       q_wire = shiftx->getPort("\\Y");
-                       shiftx->setPort("\\Y", cell->module->addWire(NEW_ID));
-               }
-               else log_abort();
-
-               newcell->setPort("\\Q", q_wire);
-               newcell->setPort("\\L", l_wire);
-
-               return false;
-       }
-};
-
-
 struct ShregmapWorker
 {
        Module *module;
@@ -263,16 +112,14 @@ struct ShregmapWorker
        {
                for (auto wire : module->wires())
                {
-                       if (wire->port_output || wire->get_bool_attribute("\\keep")) {
-                               for (auto bit : sigmap(wire)) {
+                       if (wire->port_output || wire->get_bool_attribute(ID::keep)) {
+                               for (auto bit : sigmap(wire))
                                        sigbit_with_non_chain_users.insert(bit);
-                                       if (opts.tech) opts.tech->non_chain_user(bit, nullptr, {});
-                               }
                        }
 
-                       if (wire->attributes.count("\\init")) {
+                       if (wire->attributes.count(ID(init))) {
                                SigSpec initsig = sigmap(wire);
-                               Const initval = wire->attributes.at("\\init");
+                               Const initval = wire->attributes.at(ID(init));
                                for (int i = 0; i < GetSize(initsig) && i < GetSize(initval); i++)
                                        if (initval[i] == State::S0 && !opts.zinit)
                                                sigbit_init[initsig[i]] = false;
@@ -283,7 +130,7 @@ struct ShregmapWorker
 
                for (auto cell : module->cells())
                {
-                       if (opts.ffcells.count(cell->type) && !cell->get_bool_attribute("\\keep"))
+                       if (opts.ffcells.count(cell->type) && !cell->get_bool_attribute(ID::keep))
                        {
                                IdString d_port = opts.ffcells.at(cell->type).first;
                                IdString q_port = opts.ffcells.at(cell->type).second;
@@ -294,8 +141,21 @@ struct ShregmapWorker
                                if (opts.init || sigbit_init.count(q_bit) == 0)
                                {
                                        auto r = sigbit_chain_next.insert(std::make_pair(d_bit, cell));
-                                       if (!r.second)
+                                       if (!r.second) {
+                                               // Insertion not successful means that d_bit is already
+                                               // connected to another register, thus mark it as a
+                                               // non chain user ...
                                                sigbit_with_non_chain_users.insert(d_bit);
+                                               // ... and clone d_bit into another wire, and use that
+                                               // wire as a different key in the d_bit-to-cell dictionary
+                                               // so that it can be identified as another chain
+                                               // (omitting this common flop)
+                                               // Link: https://github.com/YosysHQ/yosys/pull/1085
+                                               Wire *wire = module->addWire(NEW_ID);
+                                               module->connect(wire, d_bit);
+                                               sigmap.add(wire, d_bit);
+                                               sigbit_chain_next.insert(std::make_pair(wire, cell));
+                                       }
 
                                        sigbit_chain_prev[q_bit] = cell;
                                        continue;
@@ -304,10 +164,8 @@ struct ShregmapWorker
 
                        for (auto conn : cell->connections())
                                if (cell->input(conn.first))
-                                       for (auto bit : sigmap(conn.second)) {
+                                       for (auto bit : sigmap(conn.second))
                                                sigbit_with_non_chain_users.insert(bit);
-                                               if (opts.tech) opts.tech->non_chain_user(bit, cell, conn.first);
-                                       }
                }
        }
 
@@ -315,14 +173,14 @@ struct ShregmapWorker
        {
                for (auto it : sigbit_chain_next)
                {
-                       Cell *c1, *c2 = it.second;
-
                        if (opts.tech == nullptr && sigbit_with_non_chain_users.count(it.first))
                                goto start_cell;
 
-                       c1 = sigbit_chain_prev.at(it.first, nullptr);
-                       if (c1 != nullptr)
+                       if (sigbit_chain_prev.count(it.first) != 0)
                        {
+                               Cell *c1 = sigbit_chain_prev.at(it.first);
+                               Cell *c2 = it.second;
+
                                if (c1->type != c2->type)
                                        goto start_cell;
 
@@ -332,17 +190,8 @@ struct ShregmapWorker
                                IdString d_port = opts.ffcells.at(c1->type).first;
                                IdString q_port = opts.ffcells.at(c1->type).second;
 
-                               // If the previous cell's D has other non chain users,
-                               // then it is possible that this previous cell could
-                               // be a start of the chain
-                               SigBit d_bit = sigmap(c1->getPort(d_port).as_bit());
-                               if (sigbit_with_non_chain_users.count(d_bit)) {
-                                       c2 = c1;
-                                       goto start_cell;
-                               }
-
                                auto c1_conn = c1->connections();
-                               auto c2_conn = c1->connections();
+                               auto c2_conn = c2->connections();
 
                                c1_conn.erase(d_port);
                                c1_conn.erase(q_port);
@@ -357,7 +206,7 @@ struct ShregmapWorker
                        }
 
                start_cell:
-                       chain_start_cells.insert(c2);
+                       chain_start_cells.insert(it.second);
                }
        }
 
@@ -421,7 +270,7 @@ struct ShregmapWorker
                                        if (taps.empty() || taps.back() < depth-1)
                                                taps.push_back(depth-1);
 
-                                       if (opts.tech->analyze(taps, qbits))
+                                       if (opts.tech->analyze(taps))
                                                break;
 
                                        taps.pop_back();
@@ -470,7 +319,7 @@ struct ShregmapWorker
                                                initval.push_back(State::S0);
                                        remove_init.insert(bit);
                                }
-                               first_cell->setParam("\\INIT", initval);
+                               first_cell->setParam(ID(INIT), initval);
                        }
 
                        if (opts.zinit)
@@ -484,22 +333,22 @@ struct ShregmapWorker
                                int param_clkpol = -1;
                                int param_enpol = 2;
 
-                               if (first_cell->type == "$_DFF_N_") param_clkpol = 0;
-                               if (first_cell->type == "$_DFF_P_") param_clkpol = 1;
+                               if (first_cell->type == ID($_DFF_N_)) param_clkpol = 0;
+                               if (first_cell->type == ID($_DFF_P_)) param_clkpol = 1;
 
-                               if (first_cell->type == "$_DFFE_NN_") param_clkpol = 0, param_enpol = 0;
-                               if (first_cell->type == "$_DFFE_NP_") param_clkpol = 0, param_enpol = 1;
-                               if (first_cell->type == "$_DFFE_PN_") param_clkpol = 1, param_enpol = 0;
-                               if (first_cell->type == "$_DFFE_PP_") param_clkpol = 1, param_enpol = 1;
+                               if (first_cell->type == ID($_DFFE_NN_)) param_clkpol = 0, param_enpol = 0;
+                               if (first_cell->type == ID($_DFFE_NP_)) param_clkpol = 0, param_enpol = 1;
+                               if (first_cell->type == ID($_DFFE_PN_)) param_clkpol = 1, param_enpol = 0;
+                               if (first_cell->type == ID($_DFFE_PP_)) param_clkpol = 1, param_enpol = 1;
 
                                log_assert(param_clkpol >= 0);
-                               first_cell->setParam("\\CLKPOL", param_clkpol);
-                               if (opts.ffe) first_cell->setParam("\\ENPOL", param_enpol);
+                               first_cell->setParam(ID(CLKPOL), param_clkpol);
+                               if (opts.ffe) first_cell->setParam(ID(ENPOL), param_enpol);
                        }
 
                        first_cell->type = shreg_cell_type_str;
                        first_cell->setPort(q_port, last_cell->getPort(q_port));
-                       first_cell->setParam("\\DEPTH", depth);
+                       first_cell->setParam(ID(DEPTH), depth);
 
                        if (opts.tech != nullptr && !opts.tech->fixup(first_cell, taps_dict))
                                remove_cells.insert(first_cell);
@@ -517,18 +366,18 @@ struct ShregmapWorker
 
                for (auto wire : module->wires())
                {
-                       if (wire->attributes.count("\\init") == 0)
+                       if (wire->attributes.count(ID(init)) == 0)
                                continue;
 
                        SigSpec initsig = sigmap(wire);
-                       Const &initval = wire->attributes.at("\\init");
+                       Const &initval = wire->attributes.at(ID(init));
 
                        for (int i = 0; i < GetSize(initsig) && i < GetSize(initval); i++)
                                if (remove_init.count(initsig[i]))
                                        initval[i] = State::Sx;
 
                        if (SigSpec(initval).is_fully_undef())
-                               wire->attributes.erase("\\init");
+                               wire->attributes.erase(ID(init));
                }
 
                remove_cells.clear();
@@ -540,9 +389,6 @@ struct ShregmapWorker
        ShregmapWorker(Module *module, const ShregmapOptions &opts) :
                        module(module), sigmap(module), opts(opts), dff_count(0), shreg_count(0)
        {
-               if (opts.tech)
-                       opts.tech->init(module, sigmap);
-
                make_sigbit_chain_next_prev();
                find_chain_start_cells();
 
@@ -614,9 +460,6 @@ struct ShregmapPass : public Pass {
                log("    -tech greenpak4\n");
                log("        map to greenpak4 shift registers.\n");
                log("\n");
-               log("    -tech xilinx\n");
-               log("        map to xilinx dynamic-length shift registers.\n");
-               log("\n");
        }
        void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
        {
@@ -670,12 +513,6 @@ struct ShregmapPass : public Pass {
                                        clkpol = "pos";
                                        opts.zinit = true;
                                        opts.tech = new ShregmapTechGreenpak4;
-                               }
-                               else if (tech == "xilinx") {
-                                       opts.init = true;
-                                       opts.params = true;
-                                       enpol = "any_or_none";
-                                       opts.tech = new ShregmapTechXilinx7(opts);
                                } else {
                                        argidx--;
                                        break;
@@ -711,19 +548,19 @@ struct ShregmapPass : public Pass {
                        bool en_neg = enpol == "neg" || enpol == "any" || enpol == "any_or_none";
 
                        if (clk_pos && en_none)
-                               opts.ffcells["$_DFF_P_"] = make_pair(IdString("\\D"), IdString("\\Q"));
+                               opts.ffcells[ID($_DFF_P_)] = make_pair(IdString(ID(D)), IdString(ID(Q)));
                        if (clk_neg && en_none)
-                               opts.ffcells["$_DFF_N_"] = make_pair(IdString("\\D"), IdString("\\Q"));
+                               opts.ffcells[ID($_DFF_N_)] = make_pair(IdString(ID(D)), IdString(ID(Q)));
 
                        if (clk_pos && en_pos)
-                               opts.ffcells["$_DFFE_PP_"] = make_pair(IdString("\\D"), IdString("\\Q"));
+                               opts.ffcells[ID($_DFFE_PP_)] = make_pair(IdString(ID(D)), IdString(ID(Q)));
                        if (clk_pos && en_neg)
-                               opts.ffcells["$_DFFE_PN_"] = make_pair(IdString("\\D"), IdString("\\Q"));
+                               opts.ffcells[ID($_DFFE_PN_)] = make_pair(IdString(ID(D)), IdString(ID(Q)));
 
                        if (clk_neg && en_pos)
-                               opts.ffcells["$_DFFE_NP_"] = make_pair(IdString("\\D"), IdString("\\Q"));
+                               opts.ffcells[ID($_DFFE_NP_)] = make_pair(IdString(ID(D)), IdString(ID(Q)));
                        if (clk_neg && en_neg)
-                               opts.ffcells["$_DFFE_NN_"] = make_pair(IdString("\\D"), IdString("\\Q"));
+                               opts.ffcells[ID($_DFFE_NN_)] = make_pair(IdString(ID(D)), IdString(ID(Q)));
 
                        if (en_pos || en_neg)
                                opts.ffe = true;