passes/proc/proc.cc

   1 /*
   2  *  yosys -- Yosys Open SYnthesis Suite
   3  *
   4  *  Copyright (C) 2012  Claire Xenia Wolf <claire@yosyshq.com>
   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/log.h"
  22 #include <stdlib.h>
  23 #include <stdio.h>
  24
  25 USING_YOSYS_NAMESPACE
  26 PRIVATE_NAMESPACE_BEGIN
  27
  28 struct ProcPass : public Pass {
  29         ProcPass() : Pass("proc", "translate processes to netlists") { }
  30         void help() override
  31         {
  32                 //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
  33                 log("\n");
  34                 log("    proc [options] [selection]\n");
  35                 log("\n");
  36                 log("This pass calls all the other proc_* passes in the most common order.\n");
  37                 log("\n");
  38                 log("    proc_clean\n");
  39                 log("    proc_rmdead\n");
  40                 log("    proc_prune\n");
  41                 log("    proc_init\n");
  42                 log("    proc_arst\n");
  43                 log("    proc_mux\n");
  44                 log("    proc_dlatch\n");
  45                 log("    proc_dff\n");
  46                 log("    proc_memwr\n");
  47                 log("    proc_clean\n");
  48                 log("    opt_expr -keepdc\n");
  49                 log("\n");
  50                 log("This replaces the processes in the design with multiplexers,\n");
  51                 log("flip-flops and latches.\n");
  52                 log("\n");
  53                 log("The following options are supported:\n");
  54                 log("\n");
  55                 log("    -nomux\n");
  56                 log("        Will omit the proc_mux pass.\n");
  57                 log("\n");
  58                 log("    -global_arst [!]<netname>\n");
  59                 log("        This option is passed through to proc_arst.\n");
  60                 log("\n");
  61                 log("    -ifx\n");
  62                 log("        This option is passed through to proc_mux. proc_rmdead is not\n");
  63                 log("        executed in -ifx mode.\n");
  64                 log("\n");
  65                 log("    -noopt\n");
  66                 log("        Will omit the opt_expr pass.\n");
  67                 log("\n");
  68         }
  69         void execute(std::vector<std::string> args, RTLIL::Design *design) override
  70         {
  71                 std::string global_arst;
  72                 bool ifxmode = false;
  73                 bool nomux = false;
  74                 bool noopt = false;
  75
  76                 log_header(design, "Executing PROC pass (convert processes to netlists).\n");
  77                 log_push();
  78
  79                 size_t argidx;
  80                 for (argidx = 1; argidx < args.size(); argidx++)
  81                 {
  82                         if (args[argidx] == "-nomux") {
  83                                 nomux = true;
  84                                 continue;
  85                         }
  86                         if (args[argidx] == "-global_arst" && argidx+1 < args.size()) {
  87                                 global_arst = args[++argidx];
  88                                 continue;
  89                         }
  90                         if (args[argidx] == "-ifx") {
  91                                 ifxmode = true;
  92                                 continue;
  93                         }
  94                         if (args[argidx] == "-noopt") {
  95                                 noopt = true;
  96                                 continue;
  97                         }
  98                         break;
  99                 }
 100                 extra_args(args, argidx, design);
 101
 102                 Pass::call(design, "proc_clean");
 103                 if (!ifxmode)
 104                         Pass::call(design, "proc_rmdead");
 105                 Pass::call(design, "proc_prune");
 106                 Pass::call(design, "proc_init");
 107                 if (global_arst.empty())
 108                         Pass::call(design, "proc_arst");
 109                 else
 110                         Pass::call(design, "proc_arst -global_arst " + global_arst);
 111                 if (!nomux)
 112                         Pass::call(design, ifxmode ? "proc_mux -ifx" : "proc_mux");
 113                 Pass::call(design, "proc_dlatch");
 114                 Pass::call(design, "proc_dff");
 115                 Pass::call(design, "proc_memwr");
 116                 Pass::call(design, "proc_clean");
 117                 if (!noopt)
 118                         Pass::call(design, "opt_expr -keepdc");
 119
 120                 log_pop();
 121         }
 122 } ProcPass;
 123
 124 PRIVATE_NAMESPACE_END