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

register.cc: Include properties in docs

This commit is contained in:
Krystine Sherwin 2024-05-16 12:16:24 +12:00
parent 4c9c4c1419
commit 063a6bc2d7
No known key found for this signature in database
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
kernel/register.cc
View File

@ -892,7 +892,7 @@ struct HelpPass : public Pass {
} }
fclose(f); fclose(f);
} }
void write_cell_rst(Yosys::SimHelper cell, Yosys::CellType) void write_cell_rst(Yosys::SimHelper cell, Yosys::CellType ct)
{ {
// open // open
FILE *f = fopen(stringf("docs/source/cell/%s.rst", cell.filesafe_name().c_str()).c_str(), "wt"); FILE *f = fopen(stringf("docs/source/cell/%s.rst", cell.filesafe_name().c_str()).c_str(), "wt");
@ -919,9 +919,21 @@ struct HelpPass : public Pass {
fprintf(f, " %s\n", line.c_str()); fprintf(f, " %s\n", line.c_str());
} }
// properties
fprintf(f, "\nProperties");
fprintf(f, "\n----------\n\n");
dict<string, bool> prop_dict = {
{"is_evaluable", ct.is_evaluable},
{"is_combinatorial", ct.is_combinatorial},
{"is_synthesizable", ct.is_synthesizable},
};
for (auto &it : prop_dict) {
fprintf(f, "- %s: %s\n", it.first.c_str(), it.second ? "true" : "false");
}
// source code // source code
fprintf(f, "\nSimulation model (Verilog)\n"); fprintf(f, "\nSimulation model (Verilog)");
fprintf(f, "--------------------------\n\n"); fprintf(f, "\n--------------------------\n\n");
fprintf(f, ".. code-block:: verilog\n"); fprintf(f, ".. code-block:: verilog\n");
fprintf(f, " :caption: %s\n\n", cell.source.c_str()); fprintf(f, " :caption: %s\n\n", cell.source.c_str());
std::stringstream ss2; std::stringstream ss2;