summaryrefslogtreecommitdiff
path: root/passes/fsm/fsm.cc
blob: 2fae760915ee78d83b25e9d674177e88eccb2f7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 *  yosys -- Yosys Open SYnthesis Suite
 *
 *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
 *  
 *  Permission to use, copy, modify, and/or distribute this software for any
 *  purpose with or without fee is hereby granted, provided that the above
 *  copyright notice and this permission notice appear in all copies.
 *  
 *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 *  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 *  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 *  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 */

#include "kernel/register.h"
#include "kernel/log.h"
#include <stdlib.h>
#include <stdio.h>

struct FsmPass : public Pass {
	FsmPass() : Pass("fsm", "extract and optimize finite state machines") { }
	virtual void help()
	{
		//   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
		log("\n");
		log("    fsm [options] [selection]\n");
		log("\n");
		log("This pass calls all the other fsm_* passes in a useful order. This performs\n");
		log("FSM extraction and optimiziation. It also calls opt_clean as needed:\n");
		log("\n");
		log("    fsm_detect          unless got option -nodetect\n");
		log("    fsm_extract\n");
		log("\n");
		log("    fsm_opt\n");
		log("    opt_clean\n");
		log("    fsm_opt\n");
		log("\n");
		log("    fsm_expand          if got option -expand\n");
		log("    opt_clean           if got option -expand\n");
		log("    fsm_opt             if got option -expand\n");
		log("\n");
		log("    fsm_recode          unless got option -norecode\n");
		log("\n");
		log("    fsm_info\n");
		log("\n");
		log("    fsm_export          if got option -export\n");
		log("    fsm_map             unless got option -nomap\n");
		log("\n");
		log("Options:\n");
		log("\n");
		log("    -expand, -norecode, -export, -nomap\n");
		log("        enable or disable passes as indicated above\n");
		log("\n");
		log("    -encoding tye\n");
		log("    -fm_set_fsm_file file\n");
		log("        passed through to fsm_recode pass\n");
		log("\n");
	}
	virtual void execute(std::vector<std::string> args, RTLIL::Design *design)
	{
		bool flag_nomap = false;
		bool flag_norecode = false;
		bool flag_nodetect = false;
		bool flag_expand = false;
		bool flag_export = false;
		std::string fm_set_fsm_file_opt;
		std::string encoding_opt;

		log_header("Executing FSM pass (extract and optimize FSM).\n");
		log_push();

		size_t argidx;
		for (argidx = 1; argidx < args.size(); argidx++) {
			std::string arg = args[argidx];
			if (arg == "-fm_set_fsm_file" && argidx+1 < args.size() && fm_set_fsm_file_opt.empty()) {
				fm_set_fsm_file_opt = " -fm_set_fsm_file " + args[++argidx];
				continue;
			}
			if (arg == "-encoding" && argidx+1 < args.size() && fm_set_fsm_file_opt.empty()) {
				encoding_opt = " -encoding " + args[++argidx];
				continue;
			}
			if (arg == "-nodetect") {
				flag_nodetect = true;
				continue;
			}
			if (arg == "-norecode") {
				flag_norecode = true;
				continue;
			}
			if (arg == "-nomap") {
				flag_nomap = true;
				continue;
			}
			if (arg == "-expand") {
				flag_expand = true;
				continue;
			}
			if (arg == "-export") {
				flag_export = true;
				continue;
			}
			break;
		}
		extra_args(args, argidx, design);

		if (!flag_nodetect)
			Pass::call(design, "fsm_detect");
		Pass::call(design, "fsm_extract");

		Pass::call(design, "fsm_opt");
		Pass::call(design, "opt_clean");
		Pass::call(design, "fsm_opt");

		if (flag_expand) {
			Pass::call(design, "fsm_expand");
			Pass::call(design, "opt_clean");
			Pass::call(design, "fsm_opt");
		}

		if (!flag_norecode)
			Pass::call(design, "fsm_recode" + fm_set_fsm_file_opt + encoding_opt);
		Pass::call(design, "fsm_info");

		if (flag_export)
			Pass::call(design, "fsm_export");

		if (!flag_nomap)
			Pass::call(design, "fsm_map");

		log_pop();
	}
} FsmPass;