Renamed extend() to extend_xx(), changed most users to extend_u0()
[yosys.git] / passes / proc / proc_arst.cc
index 8e57d0efc774d831dc511b85cd557fc0e1827530..0874d0981ae6e0b383afd918052c772be08e007c 100644 (file)
 #include <stdlib.h>
 #include <stdio.h>
 
-static bool check_signal(RTLIL::Module *mod, RTLIL::SigSpec signal, RTLIL::SigSpec ref, bool &polarity)
+YOSYS_NAMESPACE_BEGIN
+extern void proc_clean_case(RTLIL::CaseRule *cs, bool &did_something, int &count, int max_depth);
+YOSYS_NAMESPACE_END
+
+USING_YOSYS_NAMESPACE
+PRIVATE_NAMESPACE_BEGIN
+
+bool check_signal(RTLIL::Module *mod, RTLIL::SigSpec signal, RTLIL::SigSpec ref, bool &polarity)
 {
-       if (signal.width != 1)
+       if (signal.size() != 1)
                return false;
        if (signal == ref)
                return true;
 
-       for (auto &cell_it : mod->cells) {
-               RTLIL::Cell *cell = cell_it.second;
-               if (cell->type == "$reduce_or" && cell->connections["\\Y"] == signal)
-                       return check_signal(mod, cell->connections["\\A"], ref, polarity);
-               if (cell->type == "$reduce_bool" && cell->connections["\\Y"] == signal)
-                       return check_signal(mod, cell->connections["\\A"], ref, polarity);
-               if (cell->type == "$logic_not" && cell->connections["\\Y"] == signal) {
+       for (auto cell : mod->cells())
+       {
+               if (cell->type == "$reduce_or" && cell->getPort("\\Y") == signal)
+                       return check_signal(mod, cell->getPort("\\A"), ref, polarity);
+
+               if (cell->type == "$reduce_bool" && cell->getPort("\\Y") == signal)
+                       return check_signal(mod, cell->getPort("\\A"), ref, polarity);
+
+               if (cell->type == "$logic_not" && cell->getPort("\\Y") == signal) {
                        polarity = !polarity;
-                       return check_signal(mod, cell->connections["\\A"], ref, polarity);
+                       return check_signal(mod, cell->getPort("\\A"), ref, polarity);
                }
-               if (cell->type == "$not" && cell->connections["\\Y"] == signal) {
+
+               if (cell->type == "$not" && cell->getPort("\\Y") == signal) {
                        polarity = !polarity;
-                       return check_signal(mod, cell->connections["\\A"], ref, polarity);
+                       return check_signal(mod, cell->getPort("\\A"), ref, polarity);
                }
-               if (cell->type == "$eq" && cell->connections["\\Y"] == signal) {
-                       if (cell->connections["\\A"].is_fully_const()) {
-                               if (!cell->connections["\\A"].as_bool())
+
+               if ((cell->type == "$eq" || cell->type == "$eqx") && cell->getPort("\\Y") == signal) {
+                       if (cell->getPort("\\A").is_fully_const()) {
+                               if (!cell->getPort("\\A").as_bool())
                                        polarity = !polarity;
-                               return check_signal(mod, cell->connections["\\B"], ref, polarity);
+                               return check_signal(mod, cell->getPort("\\B"), ref, polarity);
                        }
-                       if (cell->connections["\\B"].is_fully_const()) {
-                               if (!cell->connections["\\B"].as_bool())
+                       if (cell->getPort("\\B").is_fully_const()) {
+                               if (!cell->getPort("\\B").as_bool())
                                        polarity = !polarity;
-                               return check_signal(mod, cell->connections["\\A"], ref, polarity);
+                               return check_signal(mod, cell->getPort("\\A"), ref, polarity);
                        }
                }
-               if (cell->type == "$ne" && cell->connections["\\Y"] == signal) {
-                       if (cell->connections["\\A"].is_fully_const()) {
-                               if (cell->connections["\\A"].as_bool())
+
+               if ((cell->type == "$ne" || cell->type == "$nex") && cell->getPort("\\Y") == signal) {
+                       if (cell->getPort("\\A").is_fully_const()) {
+                               if (cell->getPort("\\A").as_bool())
                                        polarity = !polarity;
-                               return check_signal(mod, cell->connections["\\B"], ref, polarity);
+                               return check_signal(mod, cell->getPort("\\B"), ref, polarity);
                        }
-                       if (cell->connections["\\B"].is_fully_const()) {
-                               if (cell->connections["\\B"].as_bool())
+                       if (cell->getPort("\\B").is_fully_const()) {
+                               if (cell->getPort("\\B").as_bool())
                                        polarity = !polarity;
-                               return check_signal(mod, cell->connections["\\A"], ref, polarity);
+                               return check_signal(mod, cell->getPort("\\A"), ref, polarity);
                        }
                }
        }
@@ -73,17 +85,17 @@ static bool check_signal(RTLIL::Module *mod, RTLIL::SigSpec signal, RTLIL::SigSp
        return false;
 }
 
-static void apply_const(RTLIL::Module *mod, const RTLIL::SigSpec rspec, RTLIL::SigSpec &rval, RTLIL::CaseRule *cs, RTLIL::SigSpec const_sig, bool polarity, bool unknown)
+void apply_const(RTLIL::Module *mod, const RTLIL::SigSpec rspec, RTLIL::SigSpec &rval, RTLIL::CaseRule *cs, RTLIL::SigSpec const_sig, bool polarity, bool unknown)
 {
        for (auto &action : cs->actions) {
                if (unknown)
-                       rspec.replace(action.first, RTLIL::SigSpec(RTLIL::State::Sm, action.second.width), &rval);
+                       rspec.replace(action.first, RTLIL::SigSpec(RTLIL::State::Sm, action.second.size()), &rval);
                else
                        rspec.replace(action.first, action.second, &rval);
        }
 
        for (auto sw : cs->switches) {
-               if (sw->signal.width == 0) {
+               if (sw->signal.size() == 0) {
                        for (auto cs2 : sw->cases)
                                apply_const(mod, rspec, rval, cs2, const_sig, polarity, unknown);
                }
@@ -106,7 +118,7 @@ static void apply_const(RTLIL::Module *mod, const RTLIL::SigSpec rspec, RTLIL::S
        }
 }
 
-static void eliminate_const(RTLIL::Module *mod, RTLIL::CaseRule *cs, RTLIL::SigSpec const_sig, bool polarity)
+void eliminate_const(RTLIL::Module *mod, RTLIL::CaseRule *cs, RTLIL::SigSpec const_sig, bool polarity)
 {
        for (auto sw : cs->switches) {
                bool this_polarity = polarity;
@@ -132,10 +144,18 @@ static void eliminate_const(RTLIL::Module *mod, RTLIL::CaseRule *cs, RTLIL::SigS
                                eliminate_const(mod, cs2, const_sig, polarity);
                }
        }
+
+       int dummy_count = 0;
+       bool did_something = true;
+       while (did_something) {
+               did_something = false;
+               proc_clean_case(cs, did_something, dummy_count, 1);
+       }
 }
 
-static void proc_arst(RTLIL::Module *mod, RTLIL::Process *proc, SigMap &assign_map)
+void proc_arst(RTLIL::Module *mod, RTLIL::Process *proc, SigMap &assign_map)
 {
+restart_proc_arst:
        if (proc->root_case.switches.size() != 1)
                return;
 
@@ -145,11 +165,18 @@ static void proc_arst(RTLIL::Module *mod, RTLIL::Process *proc, SigMap &assign_m
                if (sync->type == RTLIL::SyncType::STp || sync->type == RTLIL::SyncType::STn) {
                        bool polarity = sync->type == RTLIL::SyncType::STp;
                        if (check_signal(mod, root_sig, sync->signal, polarity)) {
-                               log("Found async reset %s in `%s.%s'.\n", log_signal(sync->signal), mod->name.c_str(), proc->name.c_str());
-                               sync->type = sync->type == RTLIL::SyncType::STp ? RTLIL::SyncType::ST1 : RTLIL::SyncType::ST0;
+                               if (proc->syncs.size() == 1) {
+                                       log("Found VHDL-style edge-trigger %s in `%s.%s'.\n", log_signal(sync->signal), mod->name.c_str(), proc->name.c_str());
+                               } else {
+                                       log("Found async reset %s in `%s.%s'.\n", log_signal(sync->signal), mod->name.c_str(), proc->name.c_str());
+                                       sync->type = sync->type == RTLIL::SyncType::STp ? RTLIL::SyncType::ST1 : RTLIL::SyncType::ST0;
+                               }
                                for (auto &action : sync->actions) {
                                        RTLIL::SigSpec rspec = action.second;
-                                       RTLIL::SigSpec rval = RTLIL::SigSpec(RTLIL::State::Sm, rspec.width);
+                                       RTLIL::SigSpec rval = RTLIL::SigSpec(RTLIL::State::Sm, rspec.size());
+                                       for (int i = 0; i < GetSize(rspec); i++)
+                                               if (rspec[i].wire == NULL)
+                                                       rval[i] = rspec[i];
                                        RTLIL::SigSpec last_rval;
                                        for (int count = 0; rval != last_rval; count++) {
                                                last_rval = rval;
@@ -168,24 +195,93 @@ static void proc_arst(RTLIL::Module *mod, RTLIL::Process *proc, SigMap &assign_m
                                        action.second = rval;
                                }
                                eliminate_const(mod, &proc->root_case, root_sig, polarity);
+                               goto restart_proc_arst;
                        }
                }
        }
 }
 
 struct ProcArstPass : public Pass {
-       ProcArstPass() : Pass("proc_arst") { }
+       ProcArstPass() : Pass("proc_arst", "detect asynchronous resets") { }
+       virtual void help()
+       {
+               //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
+               log("\n");
+               log("    proc_arst [-global_arst [!]<netname>] [selection]\n");
+               log("\n");
+               log("This pass identifies asynchronous resets in the processes and converts them\n");
+               log("to a different internal representation that is suitable for generating\n");
+               log("flip-flop cells with asynchronous resets.\n");
+               log("\n");
+               log("    -global_arst [!]<netname>\n");
+               log("        In modules that have a net with the given name, use this net as async\n");
+               log("        reset for registers that have been assign initial values in their\n");
+               log("        declaration ('reg foobar = constant_value;'). Use the '!' modifier for\n");
+               log("        active low reset signals. Note: the frontend stores the default value\n");
+               log("        in the 'init' attribute on the net.\n");
+               log("\n");
+       }
        virtual void execute(std::vector<std::string> args, RTLIL::Design *design)
        {
-               log_header("Executing PROC_ARST pass (detect async resets in processes).\n");
+               std::string global_arst;
+               bool global_arst_neg = false;
 
-               extra_args(args, 1, design);
+               log_header("Executing PROC_ARST pass (detect async resets in processes).\n");
 
-               for (auto &mod_it : design->modules) {
-                       SigMap assign_map(mod_it.second);
-                       for (auto &proc_it : mod_it.second->processes)
-                               proc_arst(mod_it.second, proc_it.second, assign_map);
+               size_t argidx;
+               for (argidx = 1; argidx < args.size(); argidx++)
+               {
+                       if (args[argidx] == "-global_arst" && argidx+1 < args.size()) {
+                               global_arst = args[++argidx];
+                               if (!global_arst.empty() && global_arst[0] == '!') {
+                                       global_arst_neg = true;
+                                       global_arst = global_arst.substr(1);
+                               }
+                               global_arst = RTLIL::escape_id(global_arst);
+                               continue;
+                       }
+                       break;
                }
+
+               extra_args(args, argidx, design);
+
+               for (auto mod : design->modules())
+                       if (design->selected(mod)) {
+                               SigMap assign_map(mod);
+                               for (auto &proc_it : mod->processes) {
+                                       if (!design->selected(mod, proc_it.second))
+                                               continue;
+                                       proc_arst(mod, proc_it.second, assign_map);
+                                       if (global_arst.empty() || mod->wire(global_arst) == nullptr)
+                                               continue;
+                                       std::vector<RTLIL::SigSig> arst_actions;
+                                       for (auto sync : proc_it.second->syncs)
+                                               if (sync->type == RTLIL::SyncType::STp || sync->type == RTLIL::SyncType::STn)
+                                                       for (auto &act : sync->actions) {
+                                                               RTLIL::SigSpec arst_sig, arst_val;
+                                                               for (auto &chunk : act.first.chunks())
+                                                                       if (chunk.wire && chunk.wire->attributes.count("\\init")) {
+                                                                               RTLIL::SigSpec value = chunk.wire->attributes.at("\\init");
+                                                                               value.extend_xx(chunk.wire->width, false);
+                                                                               arst_sig.append(chunk);
+                                                                               arst_val.append(value.extract(chunk.offset, chunk.width));
+                                                                       }
+                                                               if (arst_sig.size()) {
+                                                                       log("Added global reset to process %s: %s <- %s\n",
+                                                                                       proc_it.first.c_str(), log_signal(arst_sig), log_signal(arst_val));
+                                                                       arst_actions.push_back(RTLIL::SigSig(arst_sig, arst_val));
+                                                               }
+                                                       }
+                                       if (!arst_actions.empty()) {
+                                               RTLIL::SyncRule *sync = new RTLIL::SyncRule;
+                                               sync->type = global_arst_neg ? RTLIL::SyncType::ST0 : RTLIL::SyncType::ST1;
+                                               sync->signal = mod->wire(global_arst);
+                                               sync->actions = arst_actions;
+                                               proc_it.second->syncs.push_back(sync);
+                                       }
+                               }
+                       }
        }
 } ProcArstPass;
  
+PRIVATE_NAMESPACE_END