riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

write_cxxrtl: add basic documentation.

This commit is contained in:
whitequark 2020-04-05 10:03:23 +00:00
parent 753e34007d
commit 4737f426ff
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
backends/cxxrtl/cxxrtl.cc
View File

@ -1601,7 +1601,22 @@ struct CxxrtlBackend : public Backend {
log("\n");
log(" write_cxxrtl [options] [filename]\n");
log("\n");
log("Write C++ code for simulating the design.\n");
log("Write C++ code for simulating the design. The generated code requires a driver;\n");
log("the following simple driver is provided as an example:\n");
log("\n");
log(" #include \"top.cc\"\n");
log("\n");
log(" int main() {\n");
log(" cxxrtl_design::p_top top;\n");
log(" while (1) {\n");
log(" top.p_clk.next = value<1> {1u};\n");
log(" top.step();\n");
log(" top.p_clk.next = value<1> {0u};\n");
log(" top.step();\n");
log(" }\n");
log(" }\n");
log("\n");
log("The following options are supported by this backend:\n");
log("\n");
log(" -O <level>\n");
log(" set the optimization level. the default is -O%d. higher optimization\n", DEFAULT_OPT_LEVEL);