Fix spacing
[yosys.git] / techlibs / xilinx / synth_xilinx.cc
index a84f54e9958c664239beeb1e61c226ae7c872952..abdf7f9cc478c1f73d44fb06a0a96b51082d917a 100644 (file)
@@ -45,8 +45,9 @@ struct SynthXilinxPass : public ScriptPass
                log("    -top <module>\n");
                log("        use the specified module as top module\n");
                log("\n");
-               log("    -arch {xcup|xcu|xc7|xc6s}\n");
+               log("    -family {xcup|xcu|xc7|xc6s}\n");
                log("        run synthesis for the specified Xilinx architecture\n");
+               log("        generate the synthesis netlist for the specified family.\n");
                log("        default: xc7\n");
                log("\n");
                log("    -edif <file>\n");
@@ -61,9 +62,6 @@ struct SynthXilinxPass : public ScriptPass
                log("        generate an output netlist (and BLIF file) suitable for VPR\n");
                log("        (this feature is experimental and incomplete)\n");
                log("\n");
-               log("    -nocarry\n");
-               log("        disable inference of carry chains\n");
-               log("\n");
                log("    -nobram\n");
                log("        disable inference of block rams\n");
                log("\n");
@@ -73,9 +71,15 @@ struct SynthXilinxPass : public ScriptPass
                log("    -nosrl\n");
                log("        disable inference of shift registers\n");
                log("\n");
-               log("    -minmuxf <int>\n");
-               log("        enable inference of hard multiplexer resources (MuxFx) for muxes at or\n");
-               log("        above this number of inputs (minimum value 5).\n");
+               log("    -nocarry\n");
+               log("        do not use XORCY/MUXCY/CARRY4 cells in output netlist\n");
+               log("\n");
+               log("    -nowidelut\n");
+               log("        do not use MUXF[78] resources to implement LUTs larger than LUT6s\n");
+               log("\n");
+               log("    -widemux <int>\n");
+               log("        enable inference of hard multiplexer resources (MUXF[78]) for muxes at or\n");
+               log("        above this number of inputs (minimum value 2, recommended value >= 5).\n");
                log("        default: 0 (no inference)\n");
                log("\n");
                log("    -run <from_label>:<to_label>\n");
@@ -98,16 +102,16 @@ struct SynthXilinxPass : public ScriptPass
                log("\n");
        }
 
-       std::string top_opt, edif_file, blif_file, abc, arch;
-       bool flatten, retime, vpr, nocarry, nobram, nodram, nosrl;
-       int minmuxf;
+       std::string top_opt, edif_file, blif_file, family;
+       bool flatten, retime, vpr, nobram, nodram, nosrl, nocarry, nowidelut, abc9;
+       int widemux;
 
        void clear_flags() YS_OVERRIDE
        {
                top_opt = "-auto-top";
                edif_file.clear();
                blif_file.clear();
-               abc = "abc";
+               family = "xc7";
                flatten = false;
                retime = false;
                vpr = false;
@@ -115,8 +119,10 @@ struct SynthXilinxPass : public ScriptPass
                nobram = false;
                nodram = false;
                nosrl = false;
-               arch = "xc7";
-               minmuxf = 0;
+               nocarry = false;
+               nowidelut = false;
+               abc9 = false;
+               widemux = 0;
        }
 
        void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
@@ -131,8 +137,8 @@ struct SynthXilinxPass : public ScriptPass
                                top_opt = "-top " + args[++argidx];
                                continue;
                        }
-                       if (args[argidx] == "-arch" && argidx+1 < args.size()) {
-                               arch = args[++argidx];
+                       if ((args[argidx] == "-family" || args[argidx] == "-arch") && argidx+1 < args.size()) {
+                               family = args[++argidx];
                                continue;
                        }
                        if (args[argidx] == "-edif" && argidx+1 < args.size()) {
@@ -159,6 +165,14 @@ struct SynthXilinxPass : public ScriptPass
                                retime = true;
                                continue;
                        }
+                       if (args[argidx] == "-nocarry") {
+                               nocarry = true;
+                               continue;
+                       }
+                       if (args[argidx] == "-nowidelut") {
+                               nowidelut = true;
+                               continue;
+                       }
                        if (args[argidx] == "-vpr") {
                                vpr = true;
                                continue;
@@ -179,23 +193,23 @@ struct SynthXilinxPass : public ScriptPass
                                nosrl = true;
                                continue;
                        }
-                       if (args[argidx] == "-minmuxf" && argidx+1 < args.size()) {
-                               minmuxf = atoi(args[++argidx].c_str());
+                       if (args[argidx] == "-widemux" && argidx+1 < args.size()) {
+                               widemux = std::stoi(args[++argidx]);
                                continue;
                        }
                        if (args[argidx] == "-abc9") {
-                               abc = "abc9";
+                               abc9 = true;
                                continue;
                        }
                        break;
                }
                extra_args(args, argidx, design);
 
-               if (arch != "xcup" && arch != "xcu" && arch != "xc7" && arch != "xc6s")
-                       log_cmd_error("Invalid Xilinx -arch setting: %s\n", arch.c_str());
+               if (family != "xcup" && family != "xcu" && family != "xc7" && family != "xc6s")
+                       log_cmd_error("Invalid Xilinx -family setting: %s\n", family.c_str());
 
-               if (minmuxf != 0 && minmuxf < 5)
-                       log_cmd_error("-minmuxf value must be 0 or >= 5.\n");
+               if (widemux != 0 && widemux < 2)
+                       log_cmd_error("-widemux value must be 0 or >= 2.\n");
 
                if (!design->full_selection())
                        log_cmd_error("This command only operates on fully selected designs!\n");
@@ -225,36 +239,20 @@ struct SynthXilinxPass : public ScriptPass
                }
 
                if (check_label("coarse")) {
-                       run("proc");
-                       if (flatten || help_mode)
-                               run("flatten", "(with -flatten only)");
-                       run("opt_expr");
-                       run("opt_clean");
-                       run("check");
-                       run("opt");
                        if (help_mode)
-                               run("wreduce [c:* t:$mux %d]", "(selection for '-minmuxf' only)");
+                               run("synth -keepdc -run coarse [-flatten]", "(with '-flatten')");
                        else
-                               run("wreduce" + std::string(minmuxf > 0 ? " c:* t:$mux %d" : ""));
-                       run("peepopt");
-                       run("opt_clean");
-                       run("alumacc");
-                       run("share");
-                       run("opt");
-                       run("fsm");
-                       run("opt -fast");
-                       run("memory -nomap");
-                       run("opt_clean");
+                               run("synth -keepdc -run coarse" + std::string(flatten ? "" : " -flatten"), "(with '-flatten')");
 
-                       if (minmuxf > 0 || help_mode)
-                               run("muxpack", "    ('-minmuxf' only)");
+                       if (widemux > 0 || help_mode)
+                               run("muxpack", "    ('-widemux' only)");
 
                        // shregmap -tech xilinx can cope with $shiftx and $mux
                        //   cells for identifying variable-length shift registers,
                        //   so attempt to convert $pmux-es to the former
                        // Also: wide multiplexer inference benefits from this too
-                       if (!(nosrl && minmuxf == 0) || help_mode)
-                               run("pmux2shiftx", "(skip if '-nosrl' and '-minmuxf' < 5)");
+                       if (!(nosrl && widemux == 0) || help_mode)
+                               run("pmux2shiftx", "(skip if '-nosrl' and '-widemux=0')");
                }
 
                if (check_label("bram", "(skip if '-nobram')")) {
@@ -272,33 +270,40 @@ struct SynthXilinxPass : public ScriptPass
                }
 
                if (check_label("fine")) {
-                       run("opt -fast");
+                       if (widemux > 0)
+                               run("opt -fast -mux_bool -undriven -fine"); // Necessary to omit -mux_undef otherwise muxcover
+                                                                           // performs less efficiently
+                       else
+                               run("opt -fast -full");
                        run("memory_map");
                        run("dffsr2dff");
                        run("dff2dffe");
-                       if (minmuxf > 0 || help_mode) {
-                               run("simplemap t:$mux", "                        ('-minmuxf' only)");
-                               if (minmuxf > 0 || help_mode) {
-                                       // NB: Cost of mux2 is 100; mux8 should cost between 3 and 4
-                                       //     of those so that 4:1 muxes and below are implemented
-                                       //     out of mux2s
-                                       std::string muxcover_args = " -dmux=0";
-                                       switch (minmuxf) {
-                                               case  5: muxcover_args += " -mux8=350 -mux16=400"; break;
-                                               case  6: muxcover_args += " -mux8=450 -mux16=500"; break;
-                                               case  7: muxcover_args += " -mux8=550 -mux16=600"; break;
-                                               case  8: muxcover_args += " -mux8=650 -mux16=700"; break;
-                                               case  9: muxcover_args += " -mux16=750"; break;
-                                               case 10: muxcover_args += " -mux16=850"; break;
-                                               case 11: muxcover_args += " -mux16=950"; break;
-                                               case 12: muxcover_args += " -mux16=1050"; break;
-                                               case 13: muxcover_args += " -mux16=1150"; break;
-                                               case 14: muxcover_args += " -mux16=1250"; break;
-                                               case 15: muxcover_args += " -mux16=1350"; break;
-                                               default: muxcover_args += " -mux16=1450"; break;
-                                       }
-                                       run("muxcover " + muxcover_args, "('-minmuxf' only)");
+                       if (help_mode) {
+                               run("simplemap t:$mux", "         ('-widemux' only)");
+                               run("muxcover <internal options>, ('-widemux' only)");
+                       }
+                       else if (widemux > 0) {
+                               run("simplemap t:$mux");
+                               constexpr int cost_mux2 = 100;
+                               std::string muxcover_args = stringf(" -nodecode -mux2=%d", cost_mux2);
+                               switch (widemux) {
+                                       case  2: muxcover_args += stringf(" -mux4=%d -mux8=%d -mux16=%d", cost_mux2+1, cost_mux2+2, cost_mux2+3); break;
+                                       case  3:
+                                       case  4: muxcover_args += stringf(" -mux4=%d -mux8=%d -mux16=%d", cost_mux2*(widemux-1)-2, cost_mux2*(widemux-1)-1, cost_mux2*(widemux-1)); break;
+                                       case  5:
+                                       case  6:
+                                       case  7:
+                                       case  8: muxcover_args += stringf(" -mux8=%d -mux16=%d", cost_mux2*(widemux-1)-1, cost_mux2*(widemux-1)); break;
+                                       case  9:
+                                       case 10:
+                                       case 11:
+                                       case 12:
+                                       case 13:
+                                       case 14:
+                                       case 15:
+                                       default: muxcover_args += stringf(" -mux16=%d", cost_mux2*(widemux-1)-1); break;
                                }
+                               run("muxcover " + muxcover_args);
                        }
                        run("opt -full");
 
@@ -313,15 +318,15 @@ struct SynthXilinxPass : public ScriptPass
                        std::string techmap_args = " -map +/techmap.v";
                        if (help_mode)
                                techmap_args += " [-map +/xilinx/mux_map.v]";
-                       else if (minmuxf > 0)
-                               techmap_args += stringf(" -D MIN_MUX_INPUTS=%d -map +/xilinx/mux_map.v", minmuxf);
+                       else if (widemux > 0)
+                               techmap_args += stringf(" -D MIN_MUX_INPUTS=%d -map +/xilinx/mux_map.v", widemux);
                        if (help_mode)
                                techmap_args += " [-map +/xilinx/arith_map.v]";
                        else if (!nocarry) {
                                techmap_args += " -map +/xilinx/arith_map.v";
                                if (vpr)
                                        techmap_args += " -D _EXPLICIT_CARRY";
-                               else if (abc == "abc9")
+                               else if (abc9)
                                        techmap_args += " -D _CLB_CARRY";
                        }
                        run("techmap " + techmap_args);
@@ -330,20 +335,30 @@ struct SynthXilinxPass : public ScriptPass
 
                if (check_label("map_cells")) {
                        std::string techmap_args = "-map +/techmap.v -D _ABC -map +/xilinx/cells_map.v";
-                       if (minmuxf > 0)
-                               techmap_args += stringf(" -D MIN_MUX_INPUTS=%d", minmuxf);
+                       if (widemux > 0)
+                               techmap_args += stringf(" -D MIN_MUX_INPUTS=%d", widemux);
                        run("techmap " + techmap_args);
                        run("clean");
                }
 
                if (check_label("map_luts")) {
                        run("opt_expr -mux_undef");
-                       if (abc == "abc9")
-                               run(abc + " -lut +/xilinx/abc_xc7.lut -box +/xilinx/abc_xc7.box -W " + XC7_WIRE_DELAY + string(retime ? " -dff" : ""));
-                       else if (help_mode)
-                               run(abc + " -luts 2:2,3,6:5,10,20 [-dff]");
-                       else
-                               run(abc + " -luts 2:2,3,6:5,10,20" + string(retime ? " -dff" : ""));
+                       if (help_mode)
+                               run("abc -luts 2:2,3,6:5[,10,20] [-dff]", "(skip if 'nowidelut', only for '-retime')");
+                       else if (abc9) {
+                               if (family != "xc7")
+                                       log_warning("'synth_xilinx -abc9' currently supports '-family xc7' only.\n");
+                               if (nowidelut)
+                                       run("abc9 -lut +/xilinx/abc_xc7_nowide.lut -box +/xilinx/abc_xc7.box -W " + std::string(XC7_WIRE_DELAY) + string(retime ? " -dff" : ""));
+                               else
+                                       run("abc9 -lut +/xilinx/abc_xc7.lut -box +/xilinx/abc_xc7.box -W " + std::string(XC7_WIRE_DELAY) + string(retime ? " -dff" : ""));
+                       }
+                       else {
+                               if (nowidelut)
+                                       run("abc -luts 2:2,3,6:5" + string(retime ? " -dff" : ""));
+                               else
+                                       run("abc -luts 2:2,3,6:5,10,20" + string(retime ? " -dff" : ""));
+                       }
                        run("clean");
 
                        // This shregmap call infers fixed length shift registers after abc