projects / yosys.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Fix iopadmap for cases where IO pins already have buffers on them
[yosys.git] / passes / techmap / iopadmap.cc
1 /*
2 * yosys -- Yosys Open SYnthesis Suite
3 *
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
5 *
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.
9 *
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.
17 *
18 */
19
20 #include "kernel/yosys.h"
21 #include "kernel/sigtools.h"
22
23 USING_YOSYS_NAMESPACE
24 PRIVATE_NAMESPACE_BEGIN
25
26 void split_portname_pair(std::string &port1, std::string &port2)
27 {
28 size_t pos = port1.find_first_of(':');
29 if (pos != std::string::npos) {
30 port2 = port1.substr(pos+1);
31 port1 = port1.substr(0, pos);
32 }
33 }
34
35 struct IopadmapPass : public Pass {
36 IopadmapPass() : Pass("iopadmap", "technology mapping of i/o pads (or buffers)") { }
37 virtual void help()
38 {
39 log("\n");
40 log(" iopadmap [options] [selection]\n");
41 log("\n");
42 log("Map module inputs/outputs to PAD cells from a library. This pass\n");
43 log("can only map to very simple PAD cells. Use 'techmap' to further map\n");
44 log("the resulting cells to more sophisticated PAD cells.\n");
45 log("\n");
46 log(" -inpad <celltype> <portname>[:<portname>]\n");
47 log(" Map module input ports to the given cell type with the\n");
48 log(" given output port name. if a 2nd portname is given, the\n");
49 log(" signal is passed through the pad call, using the 2nd\n");
50 log(" portname as the port facing the module port.\n");
51 log("\n");
52 log(" -outpad <celltype> <portname>[:<portname>]\n");
53 log(" -inoutpad <celltype> <portname>[:<portname>]\n");
54 log(" Similar to -inpad, but for output and inout ports.\n");
55 log("\n");
56 log(" -toutpad <celltype> <portname>:<portname>[:<portname>]\n");
57 log(" Merges $_TBUF_ cells into the output pad cell. This takes precedence\n");
58 log(" over the other -outpad cell. The first portname is the enable input\n");
59 log(" of the tristate driver.\n");
60 log("\n");
61 log(" -tinoutpad <celltype> <portname>:<portname>:<portname>[:<portname>]\n");
62 log(" Merges $_TBUF_ cells into the inout pad cell. This takes precedence\n");
63 log(" over the other -inoutpad cell. The first portname is the enable input\n");
64 log(" of the tristate driver and the 2nd portname is the internal output\n");
65 log(" buffering the external signal.\n");
66 log("\n");
67 log(" -widthparam <param_name>\n");
68 log(" Use the specified parameter name to set the port width.\n");
69 log("\n");
70 log(" -nameparam <param_name>\n");
71 log(" Use the specified parameter to set the port name.\n");
72 log("\n");
73 log(" -bits\n");
74 log(" create individual bit-wide buffers even for ports that\n");
75 log(" are wider. (the default behavior is to create word-wide\n");
76 log(" buffers using -widthparam to set the word size on the cell.)\n");
77 log("\n");
78 log("Tristate PADS (-toutpad, -tinoutpad) always operate in -bits mode.\n");
79 log("\n");
80 }
81 virtual void execute(std::vector<std::string> args, RTLIL::Design *design)
82 {
83 log_header(design, "Executing IOPADMAP pass (mapping inputs/outputs to IO-PAD cells).\n");
84
85 std::string inpad_celltype, inpad_portname, inpad_portname2;
86 std::string outpad_celltype, outpad_portname, outpad_portname2;
87 std::string inoutpad_celltype, inoutpad_portname, inoutpad_portname2;
88 std::string toutpad_celltype, toutpad_portname, toutpad_portname2, toutpad_portname3;
89 std::string tinoutpad_celltype, tinoutpad_portname, tinoutpad_portname2, tinoutpad_portname3, tinoutpad_portname4;
90 std::string widthparam, nameparam;
91 bool flag_bits = false;
92
93 size_t argidx;
94 for (argidx = 1; argidx < args.size(); argidx++)
95 {
96 std::string arg = args[argidx];
97 if (arg == "-inpad" && argidx+2 < args.size()) {
98 inpad_celltype = args[++argidx];
99 inpad_portname = args[++argidx];
100 split_portname_pair(inpad_portname, inpad_portname2);
101 continue;
102 }
103 if (arg == "-outpad" && argidx+2 < args.size()) {
104 outpad_celltype = args[++argidx];
105 outpad_portname = args[++argidx];
106 split_portname_pair(outpad_portname, outpad_portname2);
107 continue;
108 }
109 if (arg == "-inoutpad" && argidx+2 < args.size()) {
110 inoutpad_celltype = args[++argidx];
111 inoutpad_portname = args[++argidx];
112 split_portname_pair(inoutpad_portname, inoutpad_portname2);
113 continue;
114 }
115 if (arg == "-toutpad" && argidx+2 < args.size()) {
116 toutpad_celltype = args[++argidx];
117 toutpad_portname = args[++argidx];
118 split_portname_pair(toutpad_portname, toutpad_portname2);
119 split_portname_pair(toutpad_portname2, toutpad_portname3);
120 continue;
121 }
122 if (arg == "-tinoutpad" && argidx+2 < args.size()) {
123 tinoutpad_celltype = args[++argidx];
124 tinoutpad_portname = args[++argidx];
125 split_portname_pair(tinoutpad_portname, tinoutpad_portname2);
126 split_portname_pair(tinoutpad_portname2, tinoutpad_portname3);
127 split_portname_pair(tinoutpad_portname3, tinoutpad_portname4);
128 continue;
129 }
130 if (arg == "-widthparam" && argidx+1 < args.size()) {
131 widthparam = args[++argidx];
132 continue;
133 }
134 if (arg == "-nameparam" && argidx+1 < args.size()) {
135 nameparam = args[++argidx];
136 continue;
137 }
138 if (arg == "-bits") {
139 flag_bits = true;
140 continue;
141 }
142 break;
143 }
144 extra_args(args, argidx, design);
145
146 for (auto module : design->selected_modules())
147 {
148 dict<IdString, pool<int>> skip_wires;
149 pool<SigBit> skip_wire_bits;
150 SigMap sigmap(module);
151
152 for (auto cell : module->cells())
153 {
154 if (cell->type == RTLIL::escape_id(inpad_celltype) && cell->hasPort(RTLIL::escape_id(inpad_portname2)))
155 for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(inpad_portname2))))
156 skip_wire_bits.insert(bit);
157
158 if (cell->type == RTLIL::escape_id(outpad_celltype) && cell->hasPort(RTLIL::escape_id(outpad_portname2)))
159 for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(outpad_portname2))))
160 skip_wire_bits.insert(bit);
161
162 if (cell->type == RTLIL::escape_id(inoutpad_celltype) && cell->hasPort(RTLIL::escape_id(inoutpad_portname2)))
163 for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(inoutpad_portname2))))
164 skip_wire_bits.insert(bit);
165
166 if (cell->type == RTLIL::escape_id(toutpad_celltype) && cell->hasPort(RTLIL::escape_id(toutpad_portname3)))
167 for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(toutpad_portname3))))
168 skip_wire_bits.insert(bit);
169
170 if (cell->type == RTLIL::escape_id(tinoutpad_celltype) && cell->hasPort(RTLIL::escape_id(tinoutpad_portname4)))
171 for (auto bit : sigmap(cell->getPort(RTLIL::escape_id(tinoutpad_portname4))))
172 skip_wire_bits.insert(bit);
173 }
174
175 if (!toutpad_celltype.empty() || !tinoutpad_celltype.empty())
176 {
177 dict<SigBit, pair<IdString, pool<IdString>>> tbuf_bits;
178
179 for (auto cell : module->cells())
180 if (cell->type == "$_TBUF_") {
181 SigBit bit = sigmap(cell->getPort("\\Y").as_bit());
182 tbuf_bits[bit].first = cell->name;
183 }
184
185 for (auto cell : module->cells())
186 for (auto port : cell->connections())
187 for (auto bit : sigmap(port.second))
188 if (tbuf_bits.count(bit))
189 tbuf_bits.at(bit).second.insert(cell->name);
190
191 for (auto wire : module->selected_wires())
192 {
193 if (!wire->port_output)
194 continue;
195
196 for (int i = 0; i < GetSize(wire); i++)
197 {
198 SigBit wire_bit(wire, i);
199 SigBit mapped_wire_bit = sigmap(wire_bit);
200
201 if (tbuf_bits.count(mapped_wire_bit) == 0)
202 continue;
203
204 if (skip_wire_bits.count(mapped_wire_bit))
205 continue;
206
207 auto &tbuf_cache = tbuf_bits.at(mapped_wire_bit);
208 Cell *tbuf_cell = module->cell(tbuf_cache.first);
209
210 if (tbuf_cell == nullptr)
211 continue;
212
213 SigBit en_sig = tbuf_cell->getPort("\\E").as_bit();
214 SigBit data_sig = tbuf_cell->getPort("\\A").as_bit();
215
216 if (wire->port_input && !tinoutpad_celltype.empty())
217 {
218 log("Mapping port %s.%s[%d] using %s.\n", log_id(module), log_id(wire), i, tinoutpad_celltype.c_str());
219
220 Cell *cell = module->addCell(NEW_ID, RTLIL::escape_id(tinoutpad_celltype));
221 Wire *owire = module->addWire(NEW_ID);
222
223 cell->setPort(RTLIL::escape_id(tinoutpad_portname), en_sig);
224 cell->setPort(RTLIL::escape_id(tinoutpad_portname2), owire);
225 cell->setPort(RTLIL::escape_id(tinoutpad_portname3), data_sig);
226 cell->setPort(RTLIL::escape_id(tinoutpad_portname4), wire_bit);
227 cell->attributes["\\keep"] = RTLIL::Const(1);
228
229 for (auto cn : tbuf_cache.second) {
230 auto c = module->cell(cn);
231 if (c == nullptr)
232 continue;
233 for (auto port : c->connections()) {
234 SigSpec sig = port.second;
235 bool newsig = false;
236 for (auto &bit : sig)
237 if (sigmap(bit) == mapped_wire_bit) {
238 bit = owire;
239 newsig = true;
240 }
241 if (newsig)
242 c->setPort(port.first, sig);
243 }
244 }
245
246
247 module->remove(tbuf_cell);
248 skip_wires[wire->name].insert(i);
249 continue;
250 }
251
252 if (!wire->port_input && !toutpad_celltype.empty())
253 {
254 log("Mapping port %s.%s[%d] using %s.\n", log_id(module), log_id(wire), i, toutpad_celltype.c_str());
255
256 Cell *cell = module->addCell(NEW_ID, RTLIL::escape_id(toutpad_celltype));
257
258 cell->setPort(RTLIL::escape_id(toutpad_portname), en_sig);
259 cell->setPort(RTLIL::escape_id(toutpad_portname2), data_sig);
260 cell->setPort(RTLIL::escape_id(toutpad_portname3), wire_bit);
261 cell->attributes["\\keep"] = RTLIL::Const(1);
262
263 for (auto cn : tbuf_cache.second) {
264 auto c = module->cell(cn);
265 if (c == nullptr)
266 continue;
267 for (auto port : c->connections()) {
268 SigSpec sig = port.second;
269 bool newsig = false;
270 for (auto &bit : sig)
271 if (sigmap(bit) == mapped_wire_bit) {
272 bit = data_sig;
273 newsig = true;
274 }
275 if (newsig)
276 c->setPort(port.first, sig);
277 }
278 }
279
280 module->remove(tbuf_cell);
281 skip_wires[wire->name].insert(i);
282 continue;
283 }
284 }
285 }
286 }
287
288 for (auto wire : module->selected_wires())
289 {
290 if (!wire->port_id)
291 continue;
292
293 std::string celltype, portname, portname2;
294 pool<int> skip_bit_indices;
295
296 if (skip_wires.count(wire->name)) {
297 if (!flag_bits)
298 continue;
299 skip_bit_indices = skip_wires.at(wire->name);
300 }
301
302 for (int i = 0; i < GetSize(wire); i++)
303 if (skip_wire_bits.count(sigmap(SigBit(wire, i))))
304 skip_bit_indices.insert(i);
305
306 if (GetSize(wire) == GetSize(skip_bit_indices))
307 continue;
308
309 if (wire->port_input && !wire->port_output) {
310 if (inpad_celltype.empty()) {
311 log("Don't map input port %s.%s: Missing option -inpad.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name));
312 continue;
313 }
314 celltype = inpad_celltype;
315 portname = inpad_portname;
316 portname2 = inpad_portname2;
317 } else
318 if (!wire->port_input && wire->port_output) {
319 if (outpad_celltype.empty()) {
320 log("Don't map output port %s.%s: Missing option -outpad.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name));
321 continue;
322 }
323 celltype = outpad_celltype;
324 portname = outpad_portname;
325 portname2 = outpad_portname2;
326 } else
327 if (wire->port_input && wire->port_output) {
328 if (inoutpad_celltype.empty()) {
329 log("Don't map inout port %s.%s: Missing option -inoutpad.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name));
330 continue;
331 }
332 celltype = inoutpad_celltype;
333 portname = inoutpad_portname;
334 portname2 = inoutpad_portname2;
335 } else
336 log_abort();
337
338 if (!flag_bits && wire->width != 1 && widthparam.empty()) {
339 log("Don't map multi-bit port %s.%s: Missing option -widthparam or -bits.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name));
340 continue;
341 }
342
343 log("Mapping port %s.%s using %s.\n", RTLIL::id2cstr(module->name), RTLIL::id2cstr(wire->name), celltype.c_str());
344
345 RTLIL::Wire *new_wire = NULL;
346 if (!portname2.empty()) {
347 new_wire = module->addWire(NEW_ID, wire);
348 module->swap_names(new_wire, wire);
349 wire->attributes.clear();
350 }
351
352 if (flag_bits)
353 {
354 for (int i = 0; i < wire->width; i++)
355 {
356 if (skip_bit_indices.count(i)) {
357 if (wire->port_output)
358 module->connect(SigSpec(new_wire, i), SigSpec(wire, i));
359 else
360 module->connect(SigSpec(wire, i), SigSpec(new_wire, i));
361 continue;
362 }
363
364 RTLIL::Cell *cell = module->addCell(NEW_ID, RTLIL::escape_id(celltype));
365 cell->setPort(RTLIL::escape_id(portname), RTLIL::SigSpec(wire, i));
366 if (!portname2.empty())
367 cell->setPort(RTLIL::escape_id(portname2), RTLIL::SigSpec(new_wire, i));
368 if (!widthparam.empty())
369 cell->parameters[RTLIL::escape_id(widthparam)] = RTLIL::Const(1);
370 if (!nameparam.empty())
371 cell->parameters[RTLIL::escape_id(nameparam)] = RTLIL::Const(stringf("%s[%d]", RTLIL::id2cstr(wire->name), i));
372 cell->attributes["\\keep"] = RTLIL::Const(1);
373 }
374 }
375 else
376 {
377 RTLIL::Cell *cell = module->addCell(NEW_ID, RTLIL::escape_id(celltype));
378 cell->setPort(RTLIL::escape_id(portname), RTLIL::SigSpec(wire));
379 if (!portname2.empty())
380 cell->setPort(RTLIL::escape_id(portname2), RTLIL::SigSpec(new_wire));
381 if (!widthparam.empty())
382 cell->parameters[RTLIL::escape_id(widthparam)] = RTLIL::Const(wire->width);
383 if (!nameparam.empty())
384 cell->parameters[RTLIL::escape_id(nameparam)] = RTLIL::Const(RTLIL::id2cstr(wire->name));
385 cell->attributes["\\keep"] = RTLIL::Const(1);
386 }
387
388 wire->port_id = 0;
389 wire->port_input = false;
390 wire->port_output = false;
391 }
392
393 module->fixup_ports();
394 }
395 }
396 } IopadmapPass;
397
398 PRIVATE_NAMESPACE_END