1 package edu.berkeley.fleet.fpga.verilog;
2 import edu.berkeley.fleet.api.*;
3 import edu.berkeley.fleet.two.*;
4 import edu.berkeley.fleet.*;
5 import java.lang.reflect.*;
6 import edu.berkeley.sbp.chr.*;
7 import edu.berkeley.sbp.misc.*;
8 import edu.berkeley.sbp.meta.*;
9 import edu.berkeley.sbp.util.*;
12 import static edu.berkeley.fleet.two.FleetTwoFleet.*;
14 public class Verilog {
16 public static class SimpleValue implements Value {
17 public final String s;
18 public SimpleValue(String s) { this.s = s; }
19 public SimpleValue(String s, int high, int low) { this.s = s+"["+high+":"+low+"]"; }
20 public Value getBits(int high, int low) { return new SimpleValue(s, high, low); }
21 public Assignable getAssignableBits(int high, int low) { return new SimpleValue(s, high, low); }
22 public String getVerilogName() { return s; }
23 public String toString() { return s; }
26 public static class CatValue implements Value {
27 private final Value[] values;
28 public CatValue(Value[] values) { this.values = values; }
29 public Value getBits(int high, int low) {
30 throw new RuntimeException();
32 public Assignable getAssignableBits(int high, int low) {
33 throw new RuntimeException();
35 public String toString() { return getVerilogName(); }
36 public String getVerilogName() {
37 StringBuffer sb = new StringBuffer();
40 for(int i=0; i<values.length; i++) {
41 if (values[i]==null) continue;
42 if (!first) sb.append(", ");
43 sb.append(values[i].getVerilogName());
51 public static interface Action {
52 public String getVerilogAction();
55 public static interface Trigger {
56 public String getVerilogTrigger();
59 public static interface Assignable {
60 public String getVerilogName();
61 public Assignable getAssignableBits(int high, int low);
64 public static interface Value extends Assignable {
65 public String getVerilogName();
66 public Value getBits(int high, int low);
69 public static class ConditionalAction implements Action {
70 public String condition;
72 public ConditionalAction(String condition, Action action) {
73 this.condition = condition;
76 public String toString() { return getVerilogAction(); }
77 public String getVerilogAction() { return "if ("+condition+") begin "+action.getVerilogAction()+" end"; }
80 public static class ConditionalTrigger implements Trigger {
81 public String condition;
82 public Trigger trigger;
83 public ConditionalTrigger(String condition, Trigger trigger) {
84 this.condition = condition;
85 this.trigger = trigger;
86 if (trigger instanceof Module.Port)
87 ((Module.Port)trigger).hasLatch = true;
89 public String getVerilogTrigger() {
90 return "&& (("+condition+") ? (1 " + trigger.getVerilogTrigger() + ") : 1)";
94 public static class SimpleAssignable implements Assignable {
95 public final String s;
96 public SimpleAssignable(String s) { this.s = s; }
97 public String getVerilogName() { return s; }
98 public Assignable getAssignableBits(int high, int low) { return new SimpleValue(s, high, low); }
101 public static class AssignAction implements Action {
104 public AssignAction(Assignable left, Value right) {
105 this.left = left.getVerilogName();
106 this.right = right.getVerilogName().toString();
108 public AssignAction(Assignable left, String right) {
109 this.left = left.getVerilogName();
112 public String getVerilogAction() { return left + "<=" + right + ";"; }
113 public String toString() { return getVerilogAction(); }
116 public static class SimpleAction implements Action {
117 public final String verilog;
118 public SimpleAction(String verilog) { this.verilog = verilog; }
119 public String getVerilogAction() { return verilog; }
120 public String toString() { return verilog; }
123 public static class Module {
124 public void dump(String prefix) throws IOException {
125 PrintWriter pw = new PrintWriter(new OutputStreamWriter(new FileOutputStream(prefix+"/"+name+".v")));
128 for(InstantiatedModule m : instantiatedModules)
129 m.module.dump(prefix);
132 public final String name;
133 public String getName() { return name; }
134 public Port getPort(String name) { return ports.get(name); }
136 public HashSet<InstantiatedModule> instantiatedModules = new HashSet<InstantiatedModule>();
137 public final ArrayList<Event> events = new ArrayList<Event>();
139 // FIXME: always-alphabetical convention?
140 public final HashMap<String,Port> ports = new HashMap<String,Port>();
141 public final ArrayList<String> portorder = new ArrayList<String>();
142 public final HashMap<String,StateWire> statewires = new HashMap<String,StateWire>();
143 public final HashMap<String,Latch> latches = new HashMap<String,Latch>();
145 public StringBuffer crap = new StringBuffer();
146 public StringBuffer precrap = new StringBuffer();
147 //public void addCrap(String s) { crap.append(s); crap.append('\n'); }
148 public void addPreCrap(String s) { precrap.append(s); precrap.append('\n'); }
149 public void addPreCrap0(String s) { precrap.append(s); }
151 public Module(String name) {
155 public SourcePort createInputPort(String name, int width) {
156 if (ports.get(name)!=null) throw new RuntimeException();
157 return new SourcePort(name, width, true);
159 public SourcePort getInputPort(String name) {
160 SourcePort ret = (SourcePort)ports.get(name);
161 if (ret==null) throw new RuntimeException();
164 public SinkPort createOutputPort(String name, int width, String resetBehavior) {
165 if (ports.get(name)!=null) throw new RuntimeException();
166 return new SinkPort(name, width, true, resetBehavior);
168 public SinkPort createWirePort(String name, int width) {
169 if (ports.get(name)!=null) throw new RuntimeException();
170 return new SinkPort(name, width, false, "");
172 public SourcePort createWireSourcePort(String name, int width) {
173 if (ports.get(name)!=null) throw new RuntimeException();
174 return new SourcePort(name, width, false);
176 public SinkPort getOutputPort(String name) {
177 SinkPort ret = (SinkPort)ports.get(name);
178 if (ret==null) throw new RuntimeException();
182 public class StateWire {
183 public final String name;
184 public final boolean initiallyFull;
185 public String getName() { return name; }
186 public Action isFull() { return new SimpleAction(name+"==1"); }
187 public Action isEmpty() { return new SimpleAction(name+"==0"); }
188 public Action doFill() { return new SimpleAction(name+"<=1;"); }
189 public Action doDrain() { return new SimpleAction(name+"<=0;"); }
190 public String doReset() { return name+"<="+(initiallyFull?"1":"0")+";"; }
191 public StateWire(String name) { this(name, false); }
192 public StateWire(String name, boolean initiallyFull) {
194 this.initiallyFull = initiallyFull;
195 statewires.put(name, this);
197 public void dump(PrintWriter pw) {
198 pw.println(" reg "+name+";");
199 pw.println(" initial "+name+"="+(initiallyFull?"1":"0")+";");
203 public class Latch implements Assignable, Value {
204 public final String name;
205 public final int width;
206 public final long initial;
207 public Latch(String name, int width) { this(name, width, 0); }
208 public Latch(String name, int width, long initial) {
211 this.initial = initial;
212 latches.put(name, this);
214 public String getVerilogName() { return name; }
215 public Value getBits(int high, int low) { return new SimpleValue(getVerilogName(), high, low); }
216 public Assignable getAssignableBits(int high, int low) { return new SimpleValue(getVerilogName(), high, low); }
217 public String doReset() { return name+"<="+initial+";"; }
218 public void dump(PrintWriter pw) {
219 pw.println(" reg ["+(width-1)+":0] "+name+";");
220 pw.println(" initial "+name+"="+initial+";");
222 public void connect(SinkPort driven) {
223 driven.latchDriver = this;
227 public abstract class Port implements Action, Assignable, Trigger {
228 public abstract String doReset();
229 public final String name;
230 public String getName() { return name; }
231 public final int width;
232 public int getWidth() { return width; }
233 public boolean hasLatch = false;
234 public boolean external;
235 public Port(String name, int width, boolean external) {
238 this.external = external;
239 ports.put(name, this);
243 public String getVerilogName() { return name; }
244 public String getAck() { return name+"_a"; }
245 public String getReq() { return name+"_r"; }
246 public abstract String getInterface();
247 public abstract String getSimpleInterface();
248 public abstract String getDeclaration();
249 public abstract String getAssignments();
250 public abstract void connect(SinkPort driven);
253 public static class InstantiatedModule {
254 public final Module module;
255 public final Module thisModule;
257 public final HashMap<String,Port> ports = new HashMap<String,Port>();
258 public String getName() { return module.getName()+"_"+id; }
259 public InstantiatedModule(Module thisModule, Module module) {
260 this.thisModule = thisModule;
261 this.module = module;
262 this.id = thisModule.id++;
263 thisModule.instantiatedModules.add(this);
265 public void dump(PrintWriter pw) {
266 pw.println(" " + module.getName() + " " + getName() + "(clk, rst ");
267 for(String s : module.portorder)
268 pw.println(", " + getPort(s).getSimpleInterface());
269 if (module.name.equals("dram")) {
270 pw.println(" , dram_addr");
271 pw.println(" , dram_addr_r");
272 pw.println(" , dram_addr_a");
273 pw.println(" , dram_isread");
274 pw.println(" , dram_write_data");
275 pw.println(" , dram_write_data_push");
276 pw.println(" , dram_write_data_full");
277 pw.println(" , dram_read_data");
278 pw.println(" , dram_read_data_pop");
279 pw.println(" , dram_read_data_empty");
280 pw.println(" , dram_read_data_latency");
282 if (module.name.equals("ddr2")) {
283 pw.println(" , ddr2_addr");
284 pw.println(" , ddr2_addr_r");
285 pw.println(" , ddr2_addr_a");
286 pw.println(" , ddr2_isread");
287 pw.println(" , ddr2_write_data");
288 pw.println(" , ddr2_write_data_push");
289 pw.println(" , ddr2_write_data_full");
290 pw.println(" , ddr2_read_data");
291 pw.println(" , ddr2_read_data_pop");
292 pw.println(" , ddr2_read_data_empty");
293 pw.println(" , ddr2_read_data_latency");
295 if (module.name.equals("video")) {
296 pw.println(" , vga_clk");
297 pw.println(" , vga_psave");
298 pw.println(" , vga_hsync");
299 pw.println(" , vga_vsync");
300 pw.println(" , vga_sync");
301 pw.println(" , vga_blank");
302 pw.println(" , vga_r");
303 pw.println(" , vga_g");
304 pw.println(" , vga_b");
305 pw.println(" , vga_clkout");
309 public Port getPort(String name) {
310 return (module.ports.get(name) instanceof SinkPort) ? getOutputPort(name) : getInputPort(name);
312 public SinkPort getInputPort(String name) {
313 int width = module.getPort(name).getWidth();
314 SinkPort port = (SinkPort)ports.get(name);
316 port = thisModule.new SinkPort(getName()+"_"+name, width, false, "");
317 ports.put(name, port);
321 public SourcePort getOutputPort(String name) {
322 int width = module.getPort(name).getWidth();
323 SourcePort port = (SourcePort)ports.get(name);
325 port = thisModule.new SourcePort(getName()+"_"+name, width, false);
326 ports.put(name, port);
332 public class SourcePort extends Port implements Value {
333 public SourcePort(String name, int width, boolean external) {
334 super(name, width, external); }
335 public Value getBits(int high, int low) { return new SimpleValue(getVerilogName(), high, low); }
336 public Assignable getAssignableBits(int high, int low) { return new SimpleValue(getVerilogName(), high, low); }
337 public String getVerilogTrigger() { return " && " + getReq() + " && !"+getAck(); }
338 public String getVerilogAction() { return getAck() + " <= 1;"; }
339 public String getInterface() { return getReq()+", "+getAck()+"_, "+name+""; }
340 public String getSimpleInterface() { return getReq()+", "+getAck()+", "+name+""; }
341 public String testBit(int index, boolean value) {
342 return "("+name+"["+index+"]=="+(value?1:0)+")";
344 public String getDeclaration() {
345 StringBuffer sb = new StringBuffer();
347 sb.append("input " + name +"_r;\n");
348 sb.append("output " + name +"_a_;\n");
350 sb.append("input ["+(width-1)+":0]" + name +";\n");
352 sb.append("input [0:0]" + name +";\n"); // waste a bit, I guess
354 sb.append("wire " + name +"_r;\n");
356 sb.append("wire ["+(width-1)+":0]" + name +";\n");
359 sb.append("wire " + name +"_a;\n");
361 sb.append("reg " + name +"_a;\n");
362 sb.append("initial " + name +"_a = 0;\n");
364 return sb.toString();
366 public String doReset() { return hasLatch ? name+"_a<=1;" : ""; }
367 public String getAssignments() {
368 StringBuffer sb = new StringBuffer();
370 sb.append("assign " + name +"_a_ = " + name + "_a;\n");
371 return sb.toString();
373 public void connect(SinkPort driven) {
374 driven.driver = this;
377 public class SinkPort extends Port {
378 public SourcePort driver = null;
379 public boolean forceNoLatch = false;
380 public SinkPort driven = null;
381 public Latch latchDriver = null;
382 public final String resetBehavior;
383 public Assignable getAssignableBits(int high, int low) { return new SimpleValue(getVerilogName(), high, low); }
384 public String getVerilogAction() { return getReq() + " <= 1;"; }
385 public String getVerilogTrigger() { return " && !" + getReq() + " && !"+getAck(); }
386 public SinkPort(String name, int width, boolean external, String resetBehavior) {
387 super(name, width, external); this.resetBehavior=resetBehavior; }
388 public String getResetBehavior() { return resetBehavior; }
389 public String getInterface() { return name+"_r_, "+name+"_a, "+name+"_"; }
390 public String getSimpleInterface() { return name+"_r, "+name+"_a, "+name; }
391 public String getDeclaration() {
392 StringBuffer sb = new StringBuffer();
394 sb.append("output " + name +"_r_;\n");
395 sb.append("input " + name +"_a;\n");
397 sb.append("output ["+(width-1)+":0]" + name +"_;\n");
399 sb.append("output [0:0]" + name +"_;\n"); // waste a bit, I guess
401 sb.append("wire " + name +"_a;\n");
404 if (forceNoLatch || latchDriver!=null) {
405 sb.append("reg " + name +"_r;\n");
406 sb.append("initial " + name +"_r = 0;\n");
408 sb.append("wire ["+(width-1)+":0]" + name +";\n");
409 } else if (!hasLatch) {
410 sb.append("wire " + name +"_r;\n");
412 sb.append("wire ["+(width-1)+":0]" + name +";\n");
414 sb.append("reg " + name +"_r;\n");
415 sb.append("initial " + name +"_r = 0;\n");
417 sb.append("reg ["+(width-1)+":0]" + name +";\n");
418 if (!"/*NORESET*/".equals(resetBehavior))
419 sb.append("initial " + name +" = 0;\n");
422 return sb.toString();
424 public String doReset() {
425 return (forceNoLatch||latchDriver!=null)
428 ? (name+"_r<=0; "+("/*NORESET*/".equals(resetBehavior) ? "" : (name+"<=0;")))
431 public String getAssignments() {
432 StringBuffer sb = new StringBuffer();
434 sb.append("assign " + name +"_r_ = " + name + "_r;\n");
436 sb.append("assign " + name +"_ = " + name + ";\n");
438 if (driven != null) {
439 sb.append("assign " + driven.name +"_r = " + name + "_r;\n");
440 sb.append("assign " + name +"_a = " + driven.name + "_a;\n");
442 sb.append("assign " + driven.name +" = " + name + ";\n");
444 if (driver != null) {
445 sb.append("assign " + name +"_r = " + driver.name + "_r;\n");
446 sb.append("assign " + driver.name +"_a = " + name + "_a;\n");
448 sb.append("assign " + name +" = " + driver.name + ";\n");
450 if (latchDriver != null) {
452 sb.append("assign " + name +" = " + latchDriver.name + ";\n");
454 return sb.toString();
456 public void connect(SinkPort driven) {
457 this.driven = driven;
458 throw new RuntimeException();
462 public void dump(PrintWriter pw, boolean fix) {
463 pw.println("module "+name+"(clk, rst ");
464 for(String name : portorder) {
465 Port p = ports.get(name);
466 pw.println(" , " + p.getInterface());
468 if (this.name.equals("root")) {
469 pw.println(" , dram_addr");
470 pw.println(" , dram_addr_r");
471 pw.println(" , dram_addr_a");
472 pw.println(" , dram_isread");
473 pw.println(" , dram_write_data");
474 pw.println(" , dram_write_data_push");
475 pw.println(" , dram_write_data_full");
476 pw.println(" , dram_read_data");
477 pw.println(" , dram_read_data_pop");
478 pw.println(" , dram_read_data_empty");
479 pw.println(" , dram_read_data_latency");
480 pw.println(" , vga_clk");
481 pw.println(" , vga_psave");
482 pw.println(" , vga_hsync");
483 pw.println(" , vga_vsync");
484 pw.println(" , vga_sync");
485 pw.println(" , vga_blank");
486 pw.println(" , vga_r");
487 pw.println(" , vga_g");
488 pw.println(" , vga_b");
489 pw.println(" , vga_clkout");
490 pw.println(" , ddr2_addr");
491 pw.println(" , ddr2_addr_r");
492 pw.println(" , ddr2_addr_a");
493 pw.println(" , ddr2_isread");
494 pw.println(" , ddr2_write_data");
495 pw.println(" , ddr2_write_data_push");
496 pw.println(" , ddr2_write_data_full");
497 pw.println(" , ddr2_read_data");
498 pw.println(" , ddr2_read_data_pop");
499 pw.println(" , ddr2_read_data_empty");
500 pw.println(" , ddr2_read_data_latency");
504 pw.println(" input clk;");
505 pw.println(" input rst;");
506 if (this.name.equals("root")) {
507 pw.println("output [31:0] dram_addr;");
508 pw.println("output dram_addr_r;");
509 pw.println("input dram_addr_a;");
510 pw.println("output dram_isread;");
511 pw.println("output [63:0] dram_write_data;");
512 pw.println("output dram_write_data_push;");
513 pw.println("input dram_write_data_full;");
514 pw.println("input [63:0] dram_read_data;");
515 pw.println("output dram_read_data_pop;");
516 pw.println("input dram_read_data_empty;");
517 pw.println("input [1:0] dram_read_data_latency;");
518 pw.println("output [31:0] ddr2_addr;");
519 pw.println("output ddr2_addr_r;");
520 pw.println("input ddr2_addr_a;");
521 pw.println("output ddr2_isread;");
522 pw.println("output [63:0] ddr2_write_data;");
523 pw.println("output ddr2_write_data_push;");
524 pw.println("input ddr2_write_data_full;");
525 pw.println("input [63:0] ddr2_read_data;");
526 pw.println("output ddr2_read_data_pop;");
527 pw.println("input ddr2_read_data_empty;");
528 pw.println("input [1:0] ddr2_read_data_latency;");
529 pw.println("input vga_clk;");
530 pw.println("output vga_psave;");
531 pw.println("output vga_hsync;");
532 pw.println("output vga_vsync;");
533 pw.println("output vga_sync;");
534 pw.println("output vga_blank;");
535 pw.println("output [7:0] vga_r;");
536 pw.println("output [7:0] vga_g;");
537 pw.println("output [7:0] vga_b;");
538 pw.println("output vga_clkout;");
540 for(String name : ports.keySet()) {
541 Port p = ports.get(name);
542 pw.println(" " + p.getDeclaration());
544 for(StateWire sw : statewires.values())
546 for(Latch l : latches.values())
548 for(String name : ports.keySet()) {
549 Port p = ports.get(name);
550 pw.println(" " + p.getAssignments());
552 for(InstantiatedModule m : instantiatedModules) {
556 pw.println("always @(posedge clk) begin");
557 pw.println(" if (!rst) begin");
558 for(Latch l : latches.values())
559 pw.println(l.doReset());
560 for(StateWire sw : statewires.values())
561 pw.println(sw.doReset());
562 for(Port p : ports.values())
563 pw.println(p.doReset());
564 pw.println(" end else begin");
565 for(Port p : ports.values()) {
566 if (p instanceof SourcePort) {
567 SourcePort ip = (SourcePort)p;
569 pw.println("if (!"+ip.getReq()+" && "+ip.getAck()+") "+ip.getAck()+"<=0;");
571 SinkPort op = (SinkPort)p;
573 pw.println("if ("+op.getReq()+" && "+op.getAck()+") begin "+
575 op.getResetBehavior()+" end");
578 for(Event a : events) a.dump(pw, fix);
579 pw.println(" begin end");
584 pw.println("endmodule");
588 public Object[] triggers;
589 public Object[] actions;
590 public Event(Object[] triggers, Object action) { this(triggers, new Object[] { action }); }
591 public Event(Object[] triggers, Object[] actions) {
592 Module.this.events.add(this);
593 this.triggers = triggers;
594 this.actions = actions;
595 for(int i=0; i<triggers.length; i++)
596 if (triggers[i] instanceof Port)
597 ((Port)triggers[i]).hasLatch = true;
599 public void dump(PrintWriter pw, boolean fix) {
601 for(Object o : triggers) {
602 if (o instanceof Trigger) pw.print(((Trigger)o).getVerilogTrigger());
603 else pw.print(" && " + o);
605 pw.println(") begin ");
606 for(Object a : actions) if (a!=null) pw.println(((Action)a).getVerilogAction());
607 if (fix) pw.println("end /*else*/ ");
608 else pw.println("end else ");