2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
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.
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.
21 // *** NOTE TO THE READER ***
23 // Maybe you have just opened this file in the hope to learn more about the
24 // Yosys API. Let me congratulate you on this great decision! ;)
26 // If you want to know how the design is represented by Yosys in the memory,
27 // you should read "kernel/rtlil.h".
29 // If you want to know how to register a command with Yosys, you could read
30 // "kernel/register.h", but it would be easier to just look at a simple
31 // example instead. A simple one would be "passes/cmds/log.cc".
33 // This header is very boring. It just defines some general things that
34 // belong nowhere else and includes the interesting headers.
36 // Find more information in the "CodingReadme" file.
48 #include <initializer_list>
61 #define PRIVATE_NAMESPACE_BEGIN namespace {
62 #define PRIVATE_NAMESPACE_END }
63 #define YOSYS_NAMESPACE_BEGIN namespace Yosys {
64 #define YOSYS_NAMESPACE_END }
65 #define YOSYS_NAMESPACE_PREFIX Yosys::
66 #define USING_YOSYS_NAMESPACE using namespace Yosys;
68 #if __cplusplus >= 201103L
69 # define OVERRIDE override
85 std::string
stringf(const char *fmt
, ...);
86 std::string
vstringf(const char *fmt
, va_list ap
);
87 template<typename T
> int SIZE(const T
&obj
) { return obj
.size(); }
88 int SIZE(RTLIL::Wire
*wire
);
92 #include "kernel/log.h"
93 #include "kernel/rtlil.h"
94 #include "kernel/register.h"
99 void yosys_shutdown();
101 #ifdef YOSYS_ENABLE_TCL
103 Tcl_Interp
*yosys_get_tcl_interp();
107 extern RTLIL::Design
*yosys_design
;
109 RTLIL::IdString
new_id(std::string file
, int line
, std::string func
);
112 YOSYS_NAMESPACE_PREFIX new_id(__FILE__, __LINE__, __FUNCTION__)
115 ([]() { static YOSYS_NAMESPACE_PREFIX RTLIL::IdString _id(_str); return _id; })()
117 RTLIL::Design
*yosys_get_design();
118 std::string
proc_self_dirname();
119 std::string
proc_share_dirname();
120 const char *create_prompt(RTLIL::Design
*design
, int recursion_counter
);
122 void run_frontend(std::string filename
, std::string command
, RTLIL::Design
*design
, std::string
*backend_command
, std::string
*from_to_label
);
123 void run_pass(std::string command
, RTLIL::Design
*design
);
124 void run_backend(std::string filename
, std::string command
, RTLIL::Design
*design
);
125 void shell(RTLIL::Design
*design
);
127 // from kernel/version_*.o (cc source generated from Makefile)
128 extern const char *yosys_version_str
;
130 // from passes/cmds/design.cc
131 extern std::map
<std::string
, RTLIL::Design
*> saved_designs
;
132 extern std::vector
<RTLIL::Design
*> pushed_designs
;
134 // from passes/cmds/pluginc.cc
135 extern std::map
<std::string
, void*> loaded_plugins
;
136 extern std::map
<std::string
, std::string
> loaded_plugin_aliases
;
137 void load_plugin(std::string filename
, std::vector
<std::string
> aliases
);