techlibs/xilinx/synth_xilinx.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/register.h"
  21 #include "kernel/celltypes.h"
  22 #include "kernel/rtlil.h"
  23 #include "kernel/log.h"
  24
  25 USING_YOSYS_NAMESPACE
  26 PRIVATE_NAMESPACE_BEGIN
  27
  28 bool check_label(bool &active, std::string run_from, std::string run_to, std::string label)
  29 {
  30         if (label == run_from)
  31                 active = true;
  32         if (label == run_to)
  33                 active = false;
  34         return active;
  35 }
  36
  37 struct SynthXilinxPass : public Pass {
  38         SynthXilinxPass() : Pass("synth_xilinx", "synthesis for Xilinx FPGAs") { }
  39         virtual void help()
  40         {
  41                 //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
  42                 log("\n");
  43                 log("    synth_xilinx [options]\n");
  44                 log("\n");
  45                 log("This command runs synthesis for Xilinx FPGAs. This command does not operate on\n");
  46                 log("partly selected designs. At the moment this command creates netlists that are\n");
  47                 log("compatible with 7-Series Xilinx devices.\n");
  48                 log("\n");
  49                 log("    -top <module>\n");
  50                 log("        use the specified module as top module\n");
  51                 log("\n");
  52                 log("    -edif <file>\n");
  53                 log("        write the design to the specified edif file. writing of an output file\n");
  54                 log("        is omitted if this parameter is not specified.\n");
  55                 log("\n");
  56                 log("    -run <from_label>:<to_label>\n");
  57                 log("        only run the commands between the labels (see below). an empty\n");
  58                 log("        from label is synonymous to 'begin', and empty to label is\n");
  59                 log("        synonymous to the end of the command list.\n");
  60                 log("\n");
  61                 log("    -flatten\n");
  62                 log("        flatten design before synthesis\n");
  63                 log("\n");
  64                 log("    -retime\n");
  65                 log("        run 'abc' with -dff option\n");
  66                 log("\n");
  67                 log("\n");
  68                 log("The following commands are executed by this synthesis command:\n");
  69                 log("\n");
  70                 log("    begin:\n");
  71                 log("        read_verilog -lib +/xilinx/cells_sim.v\n");
  72                 log("        read_verilog -lib +/xilinx/cells_xtra.v\n");
  73                 log("        read_verilog -lib +/xilinx/brams_bb.v\n");
  74                 log("        read_verilog -lib +/xilinx/drams_bb.v\n");
  75                 log("        hierarchy -check -top <top>\n");
  76                 log("\n");
  77                 log("    flatten:     (only if -flatten)\n");
  78                 log("        proc\n");
  79                 log("        flatten\n");
  80                 log("\n");
  81                 log("    coarse:\n");
  82                 log("        synth -run coarse\n");
  83                 log("\n");
  84                 log("    bram:\n");
  85                 log("        memory_bram -rules +/xilinx/brams.txt\n");
  86                 log("        techmap -map +/xilinx/brams_map.v\n");
  87                 log("\n");
  88                 log("    dram:\n");
  89                 log("        memory_bram -rules +/xilinx/drams.txt\n");
  90                 log("        techmap -map +/xilinx/drams_map.v\n");
  91                 log("\n");
  92                 log("    fine:\n");
  93                 log("        opt -fast -full\n");
  94                 log("        memory_map\n");
  95                 log("        dffsr2dff\n");
  96                 log("        dff2dffe\n");
  97                 log("        opt -full\n");
  98                 log("        techmap -map +/techmap.v -map +/xilinx/arith_map.v\n");
  99                 log("        opt -fast\n");
 100                 log("\n");
 101                 log("    map_luts:\n");
 102                 log("        abc -luts 2:2,3,6:5,10,20 [-dff]\n");
 103                 log("        clean\n");
 104                 log("\n");
 105                 log("    map_cells:\n");
 106                 log("        techmap -map +/xilinx/cells_map.v\n");
 107                 log("        dffinit -ff FDRE Q INIT -ff FDCE Q INIT -ff FDPE Q INIT\n");
 108                 log("        clean\n");
 109                 log("\n");
 110                 log("    check:\n");
 111                 log("        hierarchy -check\n");
 112                 log("        stat\n");
 113                 log("        check -noinit\n");
 114                 log("\n");
 115                 log("    edif:     (only if -edif)\n");
 116                 log("        write_edif <file-name>\n");
 117                 log("\n");
 118         }
 119         virtual void execute(std::vector<std::string> args, RTLIL::Design *design)
 120         {
 121                 std::string top_opt = "-auto-top";
 122                 std::string edif_file;
 123                 std::string run_from, run_to;
 124                 bool flatten = false;
 125                 bool retime = false;
 126
 127                 size_t argidx;
 128                 for (argidx = 1; argidx < args.size(); argidx++)
 129                 {
 130                         if (args[argidx] == "-top" && argidx+1 < args.size()) {
 131                                 top_opt = "-top " + args[++argidx];
 132                                 continue;
 133                         }
 134                         if (args[argidx] == "-edif" && argidx+1 < args.size()) {
 135                                 edif_file = args[++argidx];
 136                                 continue;
 137                         }
 138                         if (args[argidx] == "-run" && argidx+1 < args.size()) {
 139                                 size_t pos = args[argidx+1].find(':');
 140                                 if (pos == std::string::npos)
 141                                         break;
 142                                 run_from = args[++argidx].substr(0, pos);
 143                                 run_to = args[argidx].substr(pos+1);
 144                                 continue;
 145                         }
 146                         if (args[argidx] == "-flatten") {
 147                                 flatten = true;
 148                                 continue;
 149                         }
 150                         if (args[argidx] == "-retime") {
 151                                 retime = true;
 152                                 continue;
 153                         }
 154                         break;
 155                 }
 156                 extra_args(args, argidx, design);
 157
 158                 if (!design->full_selection())
 159                         log_cmd_error("This comannd only operates on fully selected designs!\n");
 160
 161                 bool active = run_from.empty();
 162
 163                 log_header(design, "Executing SYNTH_XILINX pass.\n");
 164                 log_push();
 165
 166                 if (check_label(active, run_from, run_to, "begin"))
 167                 {
 168                         Pass::call(design, "read_verilog -lib +/xilinx/cells_sim.v");
 169                         Pass::call(design, "read_verilog -lib +/xilinx/cells_xtra.v");
 170                         Pass::call(design, "read_verilog -lib +/xilinx/brams_bb.v");
 171                         Pass::call(design, "read_verilog -lib +/xilinx/drams_bb.v");
 172                         Pass::call(design, stringf("hierarchy -check %s", top_opt.c_str()));
 173                 }
 174
 175                 if (flatten && check_label(active, run_from, run_to, "flatten"))
 176                 {
 177                         Pass::call(design, "proc");
 178                         Pass::call(design, "flatten");
 179                 }
 180
 181                 if (check_label(active, run_from, run_to, "coarse"))
 182                 {
 183                         Pass::call(design, "synth -run coarse");
 184                 }
 185
 186                 if (check_label(active, run_from, run_to, "bram"))
 187                 {
 188                         Pass::call(design, "memory_bram -rules +/xilinx/brams.txt");
 189                         Pass::call(design, "techmap -map +/xilinx/brams_map.v");
 190                 }
 191
 192                 if (check_label(active, run_from, run_to, "dram"))
 193                 {
 194                         Pass::call(design, "memory_bram -rules +/xilinx/drams.txt");
 195                         Pass::call(design, "techmap -map +/xilinx/drams_map.v");
 196                 }
 197
 198                 if (check_label(active, run_from, run_to, "fine"))
 199                 {
 200                         Pass::call(design, "opt -fast -full");
 201                         Pass::call(design, "memory_map");
 202                         Pass::call(design, "dffsr2dff");
 203                         Pass::call(design, "dff2dffe");
 204                         Pass::call(design, "opt -full");
 205                         Pass::call(design, "techmap -map +/techmap.v -map +/xilinx/arith_map.v");
 206                         Pass::call(design, "opt -fast");
 207                 }
 208
 209                 if (check_label(active, run_from, run_to, "map_luts"))
 210                 {
 211                         Pass::call(design, "abc -luts 2:2,3,6:5,10,20" + string(retime ? " -dff" : ""));
 212                         Pass::call(design, "clean");
 213                 }
 214
 215                 if (check_label(active, run_from, run_to, "map_cells"))
 216                 {
 217                         Pass::call(design, "techmap -map +/xilinx/cells_map.v");
 218                         Pass::call(design, "dffinit -ff FDRE Q INIT -ff FDCE Q INIT -ff FDPE Q INIT");
 219                         Pass::call(design, "clean");
 220                 }
 221
 222                 if (check_label(active, run_from, run_to, "check"))
 223                 {
 224                         Pass::call(design, "hierarchy -check");
 225                         Pass::call(design, "stat");
 226                         Pass::call(design, "check -noinit");
 227                 }
 228
 229                 if (check_label(active, run_from, run_to, "edif"))
 230                 {
 231                         if (!edif_file.empty())
 232                                 Pass::call(design, stringf("write_edif %s", edif_file.c_str()));
 233                 }
 234
 235                 log_pop();
 236         }
 237 } SynthXilinxPass;
 238
 239 PRIVATE_NAMESPACE_END