mirror of
				https://github.com/YosysHQ/yosys
				synced 2025-11-04 05:19:11 +00:00 
			
		
		
		
	o Not all derived methods were marked 'override', but it is a great feature of C++11 that we should make use of. o While at it: touched header files got a -*- c++ -*- for emacs to provide support for that language. o use YS_OVERRIDE for all override keywords (though we should probably use the plain keyword going forward now that C++11 is established)
		
			
				
	
	
		
			419 lines
		
	
	
	
		
			15 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			419 lines
		
	
	
	
		
			15 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
/*
 | 
						|
 *  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/yosys.h"
 | 
						|
#include "kernel/sigtools.h"
 | 
						|
 | 
						|
USING_YOSYS_NAMESPACE
 | 
						|
PRIVATE_NAMESPACE_BEGIN
 | 
						|
 | 
						|
void split_portname_pair(std::string &port1, std::string &port2)
 | 
						|
{
 | 
						|
	size_t pos = port1.find_first_of(':');
 | 
						|
	if (pos != std::string::npos) {
 | 
						|
		port2 = port1.substr(pos+1);
 | 
						|
		port1 = port1.substr(0, pos);
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
struct IopadmapPass : public Pass {
 | 
						|
	IopadmapPass() : Pass("iopadmap", "technology mapping of i/o pads (or buffers)") { }
 | 
						|
	void help() YS_OVERRIDE
 | 
						|
	{
 | 
						|
		log("\n");
 | 
						|
		log("    iopadmap [options] [selection]\n");
 | 
						|
		log("\n");
 | 
						|
		log("Map module inputs/outputs to PAD cells from a library. This pass\n");
 | 
						|
		log("can only map to very simple PAD cells. Use 'techmap' to further map\n");
 | 
						|
		log("the resulting cells to more sophisticated PAD cells.\n");
 | 
						|
		log("\n");
 | 
						|
		log("    -inpad <celltype> <portname>[:<portname>]\n");
 | 
						|
		log("        Map module input ports to the given cell type with the\n");
 | 
						|
		log("        given output port name. if a 2nd portname is given, the\n");
 | 
						|
		log("        signal is passed through the pad call, using the 2nd\n");
 | 
						|
		log("        portname as the port facing the module port.\n");
 | 
						|
		log("\n");
 | 
						|
		log("    -outpad <celltype> <portname>[:<portname>]\n");
 | 
						|
		log("    -inoutpad <celltype> <portname>[:<portname>]\n");
 | 
						|
		log("        Similar to -inpad, but for output and inout ports.\n");
 | 
						|
		log("\n");
 | 
						|
		log("    -toutpad <celltype> <portname>:<portname>[:<portname>]\n");
 | 
						|
		log("        Merges $_TBUF_ cells into the output pad cell. This takes precedence\n");
 | 
						|
		log("        over the other -outpad cell. The first portname is the enable input\n");
 | 
						|
		log("        of the tristate driver.\n");
 | 
						|
		log("\n");
 | 
						|
		log("    -tinoutpad <celltype> <portname>:<portname>:<portname>[:<portname>]\n");
 | 
						|
		log("        Merges $_TBUF_ cells into the inout pad cell. This takes precedence\n");
 | 
						|
		log("        over the other -inoutpad cell. The first portname is the enable input\n");
 | 
						|
		log("        of the tristate driver and the 2nd portname is the internal output\n");
 | 
						|
		log("        buffering the external signal.\n");
 | 
						|
		log("\n");
 | 
						|
		log("    -widthparam <param_name>\n");
 | 
						|
		log("        Use the specified parameter name to set the port width.\n");
 | 
						|
		log("\n");
 | 
						|
		log("    -nameparam <param_name>\n");
 | 
						|
		log("        Use the specified parameter to set the port name.\n");
 | 
						|
		log("\n");
 | 
						|
		log("    -bits\n");
 | 
						|
		log("        create individual bit-wide buffers even for ports that\n");
 | 
						|
		log("        are wider. (the default behavior is to create word-wide\n");
 | 
						|
		log("        buffers using -widthparam to set the word size on the cell.)\n");
 | 
						|
		log("\n");
 | 
						|
		log("Tristate PADS (-toutpad, -tinoutpad) always operate in -bits mode.\n");
 | 
						|
		log("\n");
 | 
						|
	}
 | 
						|
	void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
 | 
						|
	{
 | 
						|
		log_header(design, "Executing IOPADMAP pass (mapping inputs/outputs to IO-PAD cells).\n");
 | 
						|
 | 
						|
		std::string inpad_celltype, inpad_portname, inpad_portname2;
 | 
						|
		std::string outpad_celltype, outpad_portname, outpad_portname2;
 | 
						|
		std::string inoutpad_celltype, inoutpad_portname, inoutpad_portname2;
 | 
						|
		std::string toutpad_celltype, toutpad_portname, toutpad_portname2, toutpad_portname3;
 | 
						|
		std::string tinoutpad_celltype, tinoutpad_portname, tinoutpad_portname2, tinoutpad_portname3, tinoutpad_portname4;
 | 
						|
		std::string widthparam, nameparam;
 | 
						|
		bool flag_bits = false;
 | 
						|
 | 
						|
		size_t argidx;
 | 
						|
		for (argidx = 1; argidx < args.size(); argidx++)
 | 
						|
		{
 | 
						|
			std::string arg = args[argidx];
 | 
						|
			if (arg == "-inpad" && argidx+2 < args.size()) {
 | 
						|
				inpad_celltype = args[++argidx];
 | 
						|
				inpad_portname = args[++argidx];
 | 
						|
				split_portname_pair(inpad_portname, inpad_portname2);
 | 
						|
				continue;
 | 
						|
			}
 | 
						|
			if (arg == "-outpad" && argidx+2 < args.size()) {
 | 
						|
				outpad_celltype = args[++argidx];
 | 
						|
				outpad_portname = args[++argidx];
 | 
						|
				split_portname_pair(outpad_portname, outpad_portname2);
 | 
						|
				continue;
 | 
						|
			}
 | 
						|
			if (arg == "-inoutpad" && argidx+2 < args.size()) {
 | 
						|
				inoutpad_celltype = args[++argidx];
 | 
						|
				inoutpad_portname = args[++argidx];
 | 
						|
				split_portname_pair(inoutpad_portname, inoutpad_portname2);
 | 
						|
				continue;
 | 
						|
			}
 | 
						|
			if (arg == "-toutpad" && argidx+2 < args.size()) {
 | 
						|
				toutpad_celltype = args[++argidx];
 | 
						|
				toutpad_portname = args[++argidx];
 | 
						|
				split_portname_pair(toutpad_portname, toutpad_portname2);
 | 
						|
				split_portname_pair(toutpad_portname2, toutpad_portname3);
 | 
						|
				continue;
 | 
						|
			}
 | 
						|
			if (arg == "-tinoutpad" && argidx+2 < args.size()) {
 | 
						|
				tinoutpad_celltype = args[++argidx];
 | 
						|
				tinoutpad_portname = args[++argidx];
 | 
						|
				split_portname_pair(tinoutpad_portname, tinoutpad_portname2);
 | 
						|
				split_portname_pair(tinoutpad_portname2, tinoutpad_portname3);
 | 
						|
				split_portname_pair(tinoutpad_portname3, tinoutpad_portname4);
 | 
						|
				continue;
 | 
						|
			}
 | 
						|
			if (arg == "-widthparam" && argidx+1 < args.size()) {
 | 
						|
				widthparam = args[++argidx];
 | 
						|
				continue;
 | 
						|
			}
 | 
						|
			if (arg == "-nameparam" && argidx+1 < args.size()) {
 | 
						|
				nameparam = args[++argidx];
 | 
						|
				continue;
 | 
						|
			}
 | 
						|
			if (arg == "-bits") {
 | 
						|
				flag_bits = true;
 | 
						|
				continue;
 | 
						|
			}
 | 
						|
			break;
 | 
						|
		}
 | 
						|
		extra_args(args, argidx, design);
 | 
						|
 | 
						|
		for (auto module : design->selected_modules())
 | 
						|
		{
 | 
						|
			dict<IdString, pool<int>> skip_wires;
 | 
						|
			pool<SigBit> skip_wire_bits;
 | 
						|
			SigMap sigmap(module);
 | 
						|
 | 
						|
			for (auto cell : module->cells())
 | 
						|
			{
 | 
						|
				if (cell->type == RTLIL::escape_id(inpad_celltype) && cell->hasPort(RTLIL::escape_id(inpad_portname2)))
 | 
						|
					for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(inpad_portname2))))
 | 
						|
						skip_wire_bits.insert(bit);
 | 
						|
 | 
						|
				if (cell->type == RTLIL::escape_id(outpad_celltype) && cell->hasPort(RTLIL::escape_id(outpad_portname2)))
 | 
						|
					for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(outpad_portname2))))
 | 
						|
						skip_wire_bits.insert(bit);
 | 
						|
 | 
						|
				if (cell->type == RTLIL::escape_id(inoutpad_celltype) && cell->hasPort(RTLIL::escape_id(inoutpad_portname2)))
 | 
						|
					for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(inoutpad_portname2))))
 | 
						|
						skip_wire_bits.insert(bit);
 | 
						|
 | 
						|
				if (cell->type == RTLIL::escape_id(toutpad_celltype) && cell->hasPort(RTLIL::escape_id(toutpad_portname3)))
 | 
						|
					for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(toutpad_portname3))))
 | 
						|
						skip_wire_bits.insert(bit);
 | 
						|
 | 
						|
				if (cell->type == RTLIL::escape_id(tinoutpad_celltype) && cell->hasPort(RTLIL::escape_id(tinoutpad_portname4)))
 | 
						|
					for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(tinoutpad_portname4))))
 | 
						|
						skip_wire_bits.insert(bit);
 | 
						|
			}
 | 
						|
 | 
						|
			if (!toutpad_celltype.empty() || !tinoutpad_celltype.empty())
 | 
						|
			{
 | 
						|
				dict<SigBit, pair<IdString, pool<IdString>>> tbuf_bits;
 | 
						|
				pool<pair<IdString, IdString>> norewrites;
 | 
						|
				SigMap rewrites;
 | 
						|
 | 
						|
				for (auto cell : module->cells())
 | 
						|
					if (cell->type == "$_TBUF_") {
 | 
						|
						SigBit bit = sigmap(cell->getPort("\\Y").as_bit());
 | 
						|
						tbuf_bits[bit].first = cell->name;
 | 
						|
					}
 | 
						|
 | 
						|
				for (auto cell : module->cells())
 | 
						|
				for (auto port : cell->connections())
 | 
						|
				for (auto bit : sigmap(port.second))
 | 
						|
					if (tbuf_bits.count(bit))
 | 
						|
						tbuf_bits.at(bit).second.insert(cell->name);
 | 
						|
 | 
						|
				for (auto wire : module->selected_wires())
 | 
						|
				{
 | 
						|
					if (!wire->port_output)
 | 
						|
						continue;
 | 
						|
 | 
						|
					for (int i = 0; i < GetSize(wire); i++)
 | 
						|
					{
 | 
						|
						SigBit wire_bit(wire, i);
 | 
						|
						SigBit mapped_wire_bit = sigmap(wire_bit);
 | 
						|
 | 
						|
						if (tbuf_bits.count(mapped_wire_bit) == 0)
 | 
						|
							continue;
 | 
						|
 | 
						|
						if (skip_wire_bits.count(mapped_wire_bit))
 | 
						|
							continue;
 | 
						|
 | 
						|
						auto &tbuf_cache = tbuf_bits.at(mapped_wire_bit);
 | 
						|
						Cell *tbuf_cell = module->cell(tbuf_cache.first);
 | 
						|
 | 
						|
						if (tbuf_cell == nullptr)
 | 
						|
							continue;
 | 
						|
 | 
						|
						SigBit en_sig = tbuf_cell->getPort("\\E").as_bit();
 | 
						|
						SigBit data_sig = tbuf_cell->getPort("\\A").as_bit();
 | 
						|
 | 
						|
						if (wire->port_input && !tinoutpad_celltype.empty())
 | 
						|
						{
 | 
						|
							log("Mapping port %s.%s[%d] using %s.\n", log_id(module), log_id(wire), i, tinoutpad_celltype.c_str());
 | 
						|
 | 
						|
							Cell *cell = module->addCell(NEW_ID, RTLIL::escape_id(tinoutpad_celltype));
 | 
						|
							Wire *owire = module->addWire(NEW_ID);
 | 
						|
 | 
						|
							cell->setPort(RTLIL::escape_id(tinoutpad_portname), en_sig);
 | 
						|
							cell->setPort(RTLIL::escape_id(tinoutpad_portname2), owire);
 | 
						|
							cell->setPort(RTLIL::escape_id(tinoutpad_portname3), data_sig);
 | 
						|
							cell->setPort(RTLIL::escape_id(tinoutpad_portname4), wire_bit);
 | 
						|
							cell->attributes["\\keep"] = RTLIL::Const(1);
 | 
						|
 | 
						|
							for (auto cn : tbuf_cache.second) {
 | 
						|
								auto c = module->cell(cn);
 | 
						|
								if (c == nullptr)
 | 
						|
									continue;
 | 
						|
								for (auto port : c->connections()) {
 | 
						|
									SigSpec sig = port.second;
 | 
						|
									bool newsig = false;
 | 
						|
									for (auto &bit : sig)
 | 
						|
										if (sigmap(bit) == mapped_wire_bit) {
 | 
						|
											bit = owire;
 | 
						|
											newsig = true;
 | 
						|
										}
 | 
						|
									if (newsig)
 | 
						|
										c->setPort(port.first, sig);
 | 
						|
								}
 | 
						|
							}
 | 
						|
 | 
						|
 | 
						|
							module->remove(tbuf_cell);
 | 
						|
							skip_wires[wire->name].insert(i);
 | 
						|
 | 
						|
							norewrites.insert(make_pair(cell->name, RTLIL::escape_id(tinoutpad_portname4)));
 | 
						|
							rewrites.add(sigmap(wire_bit), owire);
 | 
						|
							continue;
 | 
						|
						}
 | 
						|
 | 
						|
						if (!wire->port_input && !toutpad_celltype.empty())
 | 
						|
						{
 | 
						|
							log("Mapping port %s.%s[%d] using %s.\n", log_id(module), log_id(wire), i, toutpad_celltype.c_str());
 | 
						|
 | 
						|
							Cell *cell = module->addCell(NEW_ID, RTLIL::escape_id(toutpad_celltype));
 | 
						|
 | 
						|
							cell->setPort(RTLIL::escape_id(toutpad_portname), en_sig);
 | 
						|
							cell->setPort(RTLIL::escape_id(toutpad_portname2), data_sig);
 | 
						|
							cell->setPort(RTLIL::escape_id(toutpad_portname3), wire_bit);
 | 
						|
							cell->attributes["\\keep"] = RTLIL::Const(1);
 | 
						|
 | 
						|
							for (auto cn : tbuf_cache.second) {
 | 
						|
								auto c = module->cell(cn);
 | 
						|
								if (c == nullptr)
 | 
						|
									continue;
 | 
						|
								for (auto port : c->connections()) {
 | 
						|
									SigSpec sig = port.second;
 | 
						|
									bool newsig = false;
 | 
						|
									for (auto &bit : sig)
 | 
						|
										if (sigmap(bit) == mapped_wire_bit) {
 | 
						|
											bit = data_sig;
 | 
						|
											newsig = true;
 | 
						|
										}
 | 
						|
									if (newsig)
 | 
						|
										c->setPort(port.first, sig);
 | 
						|
								}
 | 
						|
							}
 | 
						|
 | 
						|
							module->remove(tbuf_cell);
 | 
						|
							skip_wires[wire->name].insert(i);
 | 
						|
							continue;
 | 
						|
						}
 | 
						|
					}
 | 
						|
				}
 | 
						|
 | 
						|
				if (GetSize(norewrites))
 | 
						|
				{
 | 
						|
					for (auto cell : module->cells())
 | 
						|
					for (auto port : cell->connections())
 | 
						|
					{
 | 
						|
						if (norewrites.count(make_pair(cell->name, port.first)))
 | 
						|
							continue;
 | 
						|
 | 
						|
						SigSpec orig_sig = sigmap(port.second);
 | 
						|
						SigSpec new_sig = rewrites(orig_sig);
 | 
						|
 | 
						|
						if (orig_sig != new_sig)
 | 
						|
							cell->setPort(port.first, new_sig);
 | 
						|
					}
 | 
						|
				}
 | 
						|
			}
 | 
						|
 | 
						|
			for (auto wire : module->selected_wires())
 | 
						|
			{
 | 
						|
				if (!wire->port_id)
 | 
						|
					continue;
 | 
						|
 | 
						|
				std::string celltype, portname, portname2;
 | 
						|
				pool<int> skip_bit_indices;
 | 
						|
 | 
						|
				if (skip_wires.count(wire->name)) {
 | 
						|
					if (!flag_bits)
 | 
						|
						continue;
 | 
						|
					skip_bit_indices = skip_wires.at(wire->name);
 | 
						|
				}
 | 
						|
 | 
						|
				for (int i = 0; i < GetSize(wire); i++)
 | 
						|
					if (skip_wire_bits.count(sigmap(SigBit(wire, i))))
 | 
						|
						skip_bit_indices.insert(i);
 | 
						|
 | 
						|
				if (GetSize(wire) == GetSize(skip_bit_indices))
 | 
						|
					continue;
 | 
						|
 | 
						|
				if (wire->port_input && !wire->port_output) {
 | 
						|
					if (inpad_celltype.empty()) {
 | 
						|
						log("Don't map input port %s.%s: Missing option -inpad.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name));
 | 
						|
						continue;
 | 
						|
					}
 | 
						|
					celltype = inpad_celltype;
 | 
						|
					portname = inpad_portname;
 | 
						|
					portname2 = inpad_portname2;
 | 
						|
				} else
 | 
						|
				if (!wire->port_input && wire->port_output) {
 | 
						|
					if (outpad_celltype.empty()) {
 | 
						|
						log("Don't map output port %s.%s: Missing option -outpad.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name));
 | 
						|
						continue;
 | 
						|
					}
 | 
						|
					celltype = outpad_celltype;
 | 
						|
					portname = outpad_portname;
 | 
						|
					portname2 = outpad_portname2;
 | 
						|
				} else
 | 
						|
				if (wire->port_input && wire->port_output) {
 | 
						|
					if (inoutpad_celltype.empty()) {
 | 
						|
						log("Don't map inout port %s.%s: Missing option -inoutpad.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name));
 | 
						|
						continue;
 | 
						|
					}
 | 
						|
					celltype = inoutpad_celltype;
 | 
						|
					portname = inoutpad_portname;
 | 
						|
					portname2 = inoutpad_portname2;
 | 
						|
				} else
 | 
						|
					log_abort();
 | 
						|
 | 
						|
				if (!flag_bits && wire->width != 1 && widthparam.empty()) {
 | 
						|
					log("Don't map multi-bit port %s.%s: Missing option -widthparam or -bits.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name));
 | 
						|
					continue;
 | 
						|
				}
 | 
						|
 | 
						|
				log("Mapping port %s.%s using %s.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name), celltype.c_str());
 | 
						|
 | 
						|
				RTLIL::Wire *new_wire = NULL;
 | 
						|
				if (!portname2.empty()) {
 | 
						|
					new_wire = module->addWire(NEW_ID, wire);
 | 
						|
					module->swap_names(new_wire, wire);
 | 
						|
					wire->attributes.clear();
 | 
						|
				}
 | 
						|
 | 
						|
				if (flag_bits)
 | 
						|
				{
 | 
						|
					for (int i = 0; i < wire->width; i++)
 | 
						|
					{
 | 
						|
						if (skip_bit_indices.count(i)) {
 | 
						|
							if (wire->port_output)
 | 
						|
								module->connect(SigSpec(new_wire, i), SigSpec(wire, i));
 | 
						|
							else
 | 
						|
								module->connect(SigSpec(wire, i), SigSpec(new_wire, i));
 | 
						|
							continue;
 | 
						|
						}
 | 
						|
 | 
						|
						RTLIL::Cell *cell = module->addCell(NEW_ID, RTLIL::escape_id(celltype));
 | 
						|
						cell->setPort(RTLIL::escape_id(portname), RTLIL::SigSpec(wire, i));
 | 
						|
						if (!portname2.empty())
 | 
						|
							cell->setPort(RTLIL::escape_id(portname2), RTLIL::SigSpec(new_wire, i));
 | 
						|
						if (!widthparam.empty())
 | 
						|
							cell->parameters[RTLIL::escape_id(widthparam)] = RTLIL::Const(1);
 | 
						|
						if (!nameparam.empty())
 | 
						|
							cell->parameters[RTLIL::escape_id(nameparam)] = RTLIL::Const(stringf("%s[%d]", RTLIL::id2cstr(wire->name), i));
 | 
						|
						cell->attributes["\\keep"] = RTLIL::Const(1);
 | 
						|
					}
 | 
						|
				}
 | 
						|
				else
 | 
						|
				{
 | 
						|
					RTLIL::Cell *cell = module->addCell(NEW_ID, RTLIL::escape_id(celltype));
 | 
						|
					cell->setPort(RTLIL::escape_id(portname), RTLIL::SigSpec(wire));
 | 
						|
					if (!portname2.empty())
 | 
						|
						cell->setPort(RTLIL::escape_id(portname2), RTLIL::SigSpec(new_wire));
 | 
						|
					if (!widthparam.empty())
 | 
						|
						cell->parameters[RTLIL::escape_id(widthparam)] = RTLIL::Const(wire->width);
 | 
						|
					if (!nameparam.empty())
 | 
						|
						cell->parameters[RTLIL::escape_id(nameparam)] = RTLIL::Const(RTLIL::id2cstr(wire->name));
 | 
						|
					cell->attributes["\\keep"] = RTLIL::Const(1);
 | 
						|
				}
 | 
						|
 | 
						|
				wire->port_id = 0;
 | 
						|
				wire->port_input = false;
 | 
						|
				wire->port_output = false;
 | 
						|
			}
 | 
						|
 | 
						|
			module->fixup_ports();
 | 
						|
		}
 | 
						|
	}
 | 
						|
} IopadmapPass;
 | 
						|
 | 
						|
PRIVATE_NAMESPACE_END
 |