mirror of
https://github.com/YosysHQ/yosys
synced 2025-10-30 19:22:31 +00:00
116 lines
4.5 KiB
C++
116 lines
4.5 KiB
C++
/*
|
|
* yosys -- Yosys Open SYnthesis Suite
|
|
*
|
|
* Copyright (C) 2024 Martin Povišer <povik@cutebit.org>
|
|
*
|
|
* 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/yosys.h"
|
|
|
|
USING_YOSYS_NAMESPACE
|
|
PRIVATE_NAMESPACE_BEGIN
|
|
|
|
struct BoxDerivePass : Pass {
|
|
BoxDerivePass() : Pass("box_derive", "derive box modules") {}
|
|
void help() override
|
|
{
|
|
// |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
|
|
log("\n");
|
|
log(" box_derive [-base <base_module>] [-naming_attr <attr>] [selection]\n");
|
|
log("\n");
|
|
log("As part of the assembly of the design hierarchy done by the 'hierarchy' command,\n");
|
|
log("specializations of parametric modules are derived on demand: for each choice of\n");
|
|
log("parameter values appearing in the design, a copy of the parametric module is\n");
|
|
log("derived which is specialized to that choice.\n");
|
|
log("\n");
|
|
log("This derivation process ignores blackboxes and whiteboxes (boxes). To supplement,\n");
|
|
log("this 'box_derive' command can be used to request the derivation of modules based\n");
|
|
log("on box instances appearing in the design, which is desirable in certain use\n");
|
|
log("cases. Only the selected cells are considered as the instances that steer the\n");
|
|
log("derivation process.\n");
|
|
log("\n");
|
|
log(" -base <base_module>\n");
|
|
log(" instead of deriving the module that directly corresponds to each box\n");
|
|
log(" instance, derive a specialization of <base_module> (this option applies\n");
|
|
log(" to all selected box cells)\n");
|
|
log("\n");
|
|
log(" -naming_attr <attr>\n");
|
|
log(" once a specialization is derived, use the value of the module attribute\n");
|
|
log(" <attr> for a name which should be used for the derived module (this\n");
|
|
log(" replaces the internal Yosys naming scheme in which the names of derived\n");
|
|
log(" modules start with '$paramod$')\n");
|
|
log("\n");
|
|
}
|
|
void execute(std::vector<std::string> args, RTLIL::Design *d) override
|
|
{
|
|
log_header(d, "Executing BOX_DERIVE pass. (derive modules for boxes)\n");
|
|
|
|
size_t argidx;
|
|
IdString naming_attr;
|
|
IdString base_name;
|
|
for (argidx = 1; argidx < args.size(); argidx++) {
|
|
if (args[argidx] == "-naming_attr" && argidx + 1 < args.size())
|
|
naming_attr = RTLIL::escape_id(args[++argidx]);
|
|
else if (args[argidx] == "-base" && argidx + 1 < args.size())
|
|
base_name = RTLIL::escape_id(args[++argidx]);
|
|
else
|
|
break;
|
|
}
|
|
extra_args(args, argidx, d);
|
|
|
|
Module *base_override = nullptr;
|
|
if (!base_name.empty()) {
|
|
base_override = d->module(base_name);
|
|
if (!base_override)
|
|
log_cmd_error("Base module %s not found.\n", log_id(base_name));
|
|
}
|
|
|
|
dict<std::pair<RTLIL::IdString, dict<RTLIL::IdString, RTLIL::Const>>, Module*> done;
|
|
|
|
for (auto module : d->selected_modules()) {
|
|
for (auto cell : module->selected_cells()) {
|
|
Module *inst_module = d->module(cell->type);
|
|
if (!inst_module || !inst_module->get_blackbox_attribute())
|
|
continue;
|
|
|
|
Module *base = inst_module;
|
|
if (base_override)
|
|
base = base_override;
|
|
|
|
auto index = std::make_pair(base->name, cell->parameters);
|
|
|
|
if (cell->parameters.empty() || done.count(index))
|
|
continue;
|
|
|
|
IdString derived_type = base->derive(d, cell->parameters);
|
|
Module *derived = d->module(derived_type);
|
|
log_assert(derived && "Failed to derive module\n");
|
|
log_debug("derived %s\n", derived_type);
|
|
|
|
if (!naming_attr.empty() && derived->has_attribute(naming_attr)) {
|
|
IdString new_name = RTLIL::escape_id(derived->get_string_attribute(naming_attr));
|
|
if (!new_name.isPublic())
|
|
log_error("Derived module %s cannot be renamed to private name %s.\n",
|
|
log_id(derived), log_id(new_name));
|
|
derived->attributes.erase(naming_attr);
|
|
d->rename(derived, new_name);
|
|
}
|
|
|
|
done[index] = derived;
|
|
}
|
|
}
|
|
}
|
|
} BoxDerivePass;
|
|
|
|
PRIVATE_NAMESPACE_END
|