src/edu/berkeley/fleet/fpga/Fpga.java

   1 package edu.berkeley.fleet.fpga;
   2 import edu.berkeley.fleet.fpga.*;
   3 import edu.berkeley.fleet.api.*;
   4 import edu.berkeley.fleet.two.*;
   5 import edu.berkeley.fleet.*;
   6 import java.lang.reflect.*;
   7 import edu.berkeley.sbp.chr.*;
   8 import edu.berkeley.sbp.misc.*;
   9 import edu.berkeley.sbp.meta.*;
  10 import edu.berkeley.sbp.util.*;
  11 import java.util.*;
  12 import java.io.*;
  13 import edu.berkeley.fleet.two.*;
  14 import static edu.berkeley.fleet.two.FleetTwoFleet.*;
  15 import static edu.berkeley.fleet.fpga.verilog.Verilog.*;
  16 import edu.berkeley.fleet.two.PercolatedPort;
  17
  18
  19 public class Fpga extends FleetTwoFleet {
  20
  21     public  Module top;
  22     Ship debugShip;
  23
  24     public LinkedHashMap<String,FpgaShip> ships = new LinkedHashMap<String,FpgaShip>();
  25     public Iterator<Ship> iterator() { return (Iterator<Ship>)(Object)ships.values().iterator(); }
  26
  27     public Ship getShip(String type, int ordinal) {
  28         for(Ship s : this)
  29             if (s.getType().equals(type))
  30                 if (--ordinal < 0)
  31                     return s;
  32         return null;
  33     }
  34
  35     public static void main(String[] s) throws Exception {
  36         new Fpga(new Module("main")).top.dump(s[0]);
  37         PrintWriter pw;
  38
  39         pw = new PrintWriter(new OutputStreamWriter(new FileOutputStream(s[0]+"/timescale.v")));
  40         pw.println("`timescale 1ns / 10ps");
  41         pw.close();
  42
  43         pw = new PrintWriter(new OutputStreamWriter(new FileOutputStream(s[0]+"/vram.v")));
  44         pw.println("`define BRAM_ADDR_WIDTH 19");
  45         pw.println("`define BRAM_DATA_WIDTH 3");
  46         pw.println("`define BRAM_SIZE (640*480)");
  47         pw.println("`define BRAM_NAME vram");
  48         pw.println("`include \"bram.inc\"");
  49         pw.close();
  50     }
  51
  52     public Module getVerilogModule() { return top; }
  53
  54     public FleetProcess run(Instruction[] instructions) {
  55         try {
  56             return new Client(this, "none", instructions);
  57         } catch (Exception e) { throw new RuntimeException(e); }
  58     }
  59
  60     protected BitVector getDestAddr(Path path) {
  61         return ((FpgaPath)path).toBitVector();
  62     }
  63
  64     // Setup //////////////////////////////////////////////////////////////////////////////
  65
  66     Ship createShip(String type) throws IOException {
  67         ShipDescription sd = new ShipDescription(this, type, new BufferedReader(new InputStreamReader(new FileInputStream("ships/"+type+".ship"))));
  68         int count = 0;
  69         for(Ship ship : ships.values()) if (ship.getType().equals(type)) count++;
  70         String name = type+count;
  71         FpgaShip ship = new FpgaShip(this, sd);
  72         ships.put(name, ship);
  73         return ship;
  74     }
  75
  76     public Fpga() throws Exception { this(new Module("main")); }
  77     public Fpga(Module top) throws Exception {
  78         this.top = top;
  79         debugShip = createShip("Debug");
  80
  81         //boolean small = true;
  82         boolean small = false;
  83
  84         if (small) {
  85             for(int i=0; i<2; i++) createShip("Alu");
  86             for(int i=0; i<1; i++) createShip("Memory");
  87             for(int i=0; i<2; i++) createShip("Fifo");
  88             createShip("Counter");
  89             createShip("CarrySaveAdder");
  90             createShip("Rotator");
  91             createShip("Lut3");
  92
  93         } else {
  94
  95             for(int i=0; i<2; i++)  createShip("Memory");
  96             for(int i=0; i<8; i++)  createShip("Alu");
  97             for(int i=0; i<1; i++)  createShip("Fifo");
  98             for(int i=0; i<12; i++) createShip("Counter");
  99
 100             //createShip("CarrySaveAdder");
 101             //createShip("Rotator");
 102             createShip("Random");
 103             createShip("Button");
 104
 105         }
 106
 107         createShip("Timer");
 108         createShip("DDR2");
 109         createShip("Dvi");
 110
 111         // for FifoShip
 112         new Module.InstantiatedModule(top, new FifoModule(8, WIDTH_WORD));
 113
 114         ArrayList dests   = new ArrayList<FabricElement>();
 115         ArrayList sources = new ArrayList<FabricElement>();
 116         for(FpgaShip ship : (Iterable<FpgaShip>)(Object)this) {
 117             for(Dock port : ship) {
 118                 if (port.isInputDock()) {
 119                     sources.add(((FpgaDock)port));
 120                     dests.add(port.getInstructionDestination());
 121                     dests.add(port.getDataDestination());
 122                 } else {
 123                     sources.add(((FpgaDock)port));
 124                     dests.add(port.getInstructionDestination());
 125                     dests.add(port.getDataDestination());
 126                 }
 127             }
 128             for(Module.SourcePort sp0 : ship.docklessPorts.values()) {
 129                 final Module.SourcePort sp = sp0;
 130                 sources.add(new FabricElement.AbstractFabricElement() {
 131                         private FabricElement upstream;
 132                         public int      getPathLength(FpgaDestination dest) { return upstream.getPathLength(dest); }
 133                         public FpgaPath getPath(FpgaDestination dest, BitVector signal) { return upstream.getPath(dest, signal); }
 134                         public void addOutput(FabricElement out, Module.Port outPort) {
 135                             this.upstream = out;
 136                             sp.connect((Module.SinkPort)outPort);
 137                         }
 138                     });
 139             }
 140         }
 141         FabricElement top_horn = mkNode((FabricElement[])dests.toArray(new FabricElement[0]), true);
 142         mkNode((FabricElement[])sources.toArray(new FabricElement[0]), false)
 143             .addOutput(top_horn, top_horn.getInputPort());
 144     }
 145
 146     public FabricElement mkNode(FabricElement[] ports, boolean is_horn) { return mkNode(ports, is_horn, 0, ports.length); }
 147     public FabricElement mkNode(FabricElement[] ports, boolean is_horn, int start, int end) {
 148         switch(end-start) {
 149             case 0: throw new RuntimeException("this should never happen");
 150             case 1: return ports[start];
 151             default: {
 152                 FabricElement leftPort  = mkNode(ports, is_horn,  start,         (end+start)/2);
 153                 FabricElement rightPort = mkNode(ports, is_horn,  (end+start)/2, end);
 154                 return is_horn
 155                     ? new HornModule.HornInstance(this, top,     leftPort, rightPort)
 156                     : new FunnelModule.FunnelInstance(this, top, leftPort, rightPort);
 157             }
 158         }
 159     }
 160
 161
 162     // Expand //////////////////////////////////////////////////////////////////////////////
 163
 164     public void expand(ShipDescription sd) {
 165         try {
 166             if (sd.getSection("fpga")==null) return;
 167             if (getShip(sd.getName(),0)==null) return;  // no ships of this type
 168             String filename = sd.getName().toLowerCase();
 169
 170             if (sd.getSection("ucf") != null) {
 171                 File outf = new File("build/fpga/"+filename+".ucf");
 172                 FileOutputStream out = new FileOutputStream(outf);
 173                 PrintWriter pw = new PrintWriter(out);
 174                 pw.println(sd.getSection("ucf"));
 175                 pw.flush();
 176                 pw.close();
 177             }
 178
 179             File outf = new File("build/fpga/"+filename+".v");
 180             new File(outf.getParent()).mkdirs();
 181             System.err.println("writing to " + outf);
 182             FileOutputStream out = new FileOutputStream(outf);
 183             PrintWriter pw = new PrintWriter(out);
 184
 185             pw.println("`define WORDWIDTH                "+WIDTH_WORD);
 186             pw.println("`define CODEBAG_SIZE_BITS        "+CBD_SIZE.valmaskwidth);
 187             pw.println();
 188
 189             for(DockDescription dd : sd.ports()) {
 190                 String name = dd.getName();
 191                 pw.println("`define "+name+"_full    ("+name+"_r && !"+name+"_a)");
 192                 pw.println("`define "+name+"_empty  (!"+name+"_r && !"+name+"_a)");
 193                 if (dd.isInputDock()) {
 194                     // gets stuck on colliding-tokens
 195                     //pw.println("`define drain_"+name+"  if ("+name+"_r && !"+name+"_a) "+name+"_a <= 1;");
 196
 197                     // gets stuck on colliding-tokens
 198                     //pw.println("`define drain_"+name+"  if ("+name+"_r) "+name+"_a <= 1;");
 199
 200                     // also gets stuck
 201                     //pw.println("`define drain_"+name+"  if (!"+name+"_a) "+name+"_a <= 1;");
 202                     pw.println("`define drain_"+name+"  "+name+"_a <= 1;");
 203                 } else {
 204                     pw.println("`define fill_"+name+"  "+name+"_r <= 1;");
 205                 }
 206             }
 207
 208             pw.print("`define reset ");
 209             for(DockDescription bb : sd.ports()) {
 210                 String bb_name = bb.getName();
 211                 if (bb.isInputDock()) pw.print(bb_name+"_a <= 1; ");
 212                 else                  pw.print(bb_name+"_r <= 0; ");
 213             }
 214             pw.println();
 215
 216             pw.print("`define cleanup ");
 217
 218             // output docks
 219             for(DockDescription dd : sd.ports())
 220                 if (!dd.isInputDock())
 221                     pw.print("if ( "+dd.getName()+"_r && "+dd.getName()+"_a) "+dd.getName()+"_r <= 0; ");
 222
 223             // input docks: if all inputs are flushing, drain them all
 224             pw.print("if (1");
 225             for(DockDescription bb : sd.ports())
 226                 if (bb.isInputDock())
 227                     pw.print(" && "+bb.getName()+"_f");
 228             pw.print(") begin ");
 229             for(DockDescription bb : sd.ports())
 230                 if (bb.isInputDock())
 231                     pw.print(bb.getName()+"_a <= 1; ");
 232
 233             // input docks: if no inputs are flushing, do normal stuff
 234             pw.print("end else if (1");
 235             for(DockDescription bb : sd.ports())
 236                 if (bb.isInputDock())
 237                     pw.print(" && !"+bb.getName()+"_f");
 238             pw.print(") begin ");
 239
 240             for(DockDescription bb : sd.ports())
 241                 if (bb.isInputDock())
 242                     pw.print("if (!"+bb.getName()+"_r_ && "+bb.getName()+"_a) "+bb.getName()+"_a <= 0; ");
 243
 244             // input docks: if some-but-not-all inputs are flushing, drain all non-flushing docks
 245             pw.print("end else begin ");
 246
 247             for(DockDescription bb : sd.ports())
 248                 if (bb.isInputDock()) {
 249                     pw.print("if (!"+bb.getName()+"_r && "+bb.getName()+"_a) "+bb.getName()+"_a <= 0; ");
 250                     pw.print("if ("+bb.getName()+"_r && !"+bb.getName()+"_a) "+bb.getName()+"_a <= 1; ");
 251                 }
 252
 253             pw.print(" end");
 254
 255             pw.println();
 256
 257             pw.println("module " + filename + "( clk, rst ");
 258             for(DockDescription bb : sd.ports()) {
 259                 String bb_name = bb.getName();
 260                 pw.print("        ");
 261                 if (bb.isInputDock()) {
 262                     pw.print(", " + bb_name+"_r_");
 263                     pw.print(", " + bb_name+"_a_");
 264                     pw.print(", " + bb_name+"_d");
 265                 } else {
 266                     pw.print(", " + bb_name+"_r_");
 267                     pw.print(", " + bb_name+"_a");
 268                     pw.print(", " + bb_name+"_d_");
 269                 }
 270                 pw.println();
 271             }
 272             for(PercolatedPort pp : sd.percolatedPorts) {
 273                 pw.print("    , ");
 274                 pw.println(pp.name);
 275             }
 276             pw.println("        );");
 277             pw.println();
 278             pw.println("    input clk;");
 279             pw.println("    input rst;");
 280             for(PercolatedPort pp : sd.percolatedPorts) {
 281                 switch(pp.type) {
 282                     case UP:    pw.print("output"); break;
 283                     case DOWN:  pw.print("input");  break;
 284                     case INOUT: pw.print("inout");  break;
 285                 }
 286                 pw.print("  ");
 287                 if (pp.width > 1)
 288                     pw.print("["+(pp.width-1)+":0]");
 289                 pw.print(" ");
 290                 pw.print(pp.name);
 291                 pw.println(";");
 292             }
 293
 294             for(DockDescription bb : sd.ports()) {
 295                 String bb_name = bb.getName();
 296                 int width = bb.isDockless() ? WIDTH_PACKET : WIDTH_WORD;
 297                 if (bb.isInputDock()) {
 298                     pw.println("        input   ["+width+":0] "+bb_name+"_d;");
 299                     pw.println("        input   "+bb_name+"_r_;");
 300                     pw.println("        wire    "+bb_name+"_r;");
 301                     pw.println("        assign  "+bb_name+"_r = "+bb_name+"_r_ & ~"+bb_name+"_d["+width+"];");
 302                     pw.println("        output  "+bb_name+"_a_;");
 303                     pw.println("        reg     "+bb_name+"_a;");
 304                     pw.println("        initial "+bb_name+"_a  = 0;");
 305                     pw.println("        wire    "+bb_name+"_f;");
 306                     pw.println("        assign  "+bb_name+"_f  = "+bb_name+"_r_ & "+bb_name+"_d["+width+"] && ~"+bb_name+"_a;");
 307                     pw.println("        assign  "+bb_name+"_a_ = "+bb_name+"_a;");
 308                 } else {
 309                     pw.println("        output  ["+width+":0] "+bb_name+"_d_;");
 310                     pw.println("        input   "+bb_name+"_a;");
 311                     pw.println("        output  "+bb_name+"_r_;");
 312                     pw.println("        reg     "+bb_name+"_r;");
 313                     pw.println("        initial "+bb_name+"_r  = 0;");
 314                     pw.println("        assign  "+bb_name+"_r_ = "+bb_name+"_r;");
 315                 }
 316                 pw.println();
 317             }
 318
 319             if (filename.equals("fifo")) {
 320                 pw.println("  wire in_a__;");
 321                 pw.println("  wire out_r__;");
 322                 pw.println("  fifo8x37 fifo8x37(clk, rst,");
 323                 pw.println("                    in_r,    in_a__, in_d,");
 324                 pw.println("                    out_r__, out_a,  out_d_);");
 325                 pw.println("  always @(posedge clk) begin");
 326                 pw.println("    if (rst) begin");
 327                 pw.println("      `reset");
 328                 pw.println("    end else begin");
 329                 pw.println("      `cleanup");
 330                 pw.println("      out_r <= out_r__;");
 331                 pw.println("      if (in_a__) in_a  <= 1;");
 332                 pw.println("    end");
 333                 pw.println("  end");
 334             } else {
 335                 pw.println(sd.getSection("fpga"));
 336             }
 337
 338             pw.println("endmodule");
 339
 340             pw.flush();
 341             pw.close();
 342         } catch (Exception e) { throw new RuntimeException(e); }
 343     }
 344
 345 }