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(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             createShip("Timer");
  93             createShip("DDR2");
  94             createShip("Dvi");
  95
  96         } else {
  97
  98             for(int i=0; i<3; i++)  createShip("Memory");
  99             for(int i=0; i<3; i++)  createShip("Alu");
 100             for(int i=0; i<2; i++)  createShip("Fifo");
 101             for(int i=0; i<11; i++) createShip("Counter");
 102
 103             /*
 104             for(int i=0; i<3; i++)  createShip("Memory");
 105             for(int i=0; i<3; i++)  createShip("Alu");
 106             for(int i=0; i<2; i++)  createShip("Fifo");
 107             for(int i=0; i<14; i++) createShip("Counter");
 108
 109             // "really big" configuration: 138 docks
 110             for(int i=0; i<4; i++)  createShip("Alu");
 111             */
 112
 113             //createShip("CarrySaveAdder");
 114             //createShip("Rotator");
 115             //createShip("Lut3");
 116
 117             createShip("Timer");
 118             createShip("DDR2");
 119             createShip("Dvi");
 120         }
 121
 122         // for FifoShip
 123         new Module.InstantiatedModule(top, new FifoModule(8, WIDTH_WORD));
 124
 125         ArrayList dests   = new ArrayList<FabricElement>();
 126         ArrayList sources = new ArrayList<FabricElement>();
 127         for(FpgaShip ship : (Iterable<FpgaShip>)(Object)this) {
 128             for(Dock port : ship) {
 129                 if (port.isInputDock()) {
 130                     sources.add(((FpgaDock)port));
 131                     dests.add(port.getInstructionDestination());
 132                     dests.add(port.getDataDestination());
 133                 } else {
 134                     sources.add(((FpgaDock)port));
 135                     dests.add(port.getInstructionDestination());
 136                     dests.add(port.getDataDestination());
 137                 }
 138             }
 139             for(Module.SourcePort sp0 : ship.docklessPorts.values()) {
 140                 final Module.SourcePort sp = sp0;
 141                 sources.add(new FabricElement.AbstractFabricElement() {
 142                         private FabricElement upstream;
 143                         public FpgaPath getPath(FpgaDestination dest, BitVector signal) { return upstream.getPath(dest, signal); }
 144                         public void addOutput(FabricElement out, Module.Port outPort) {
 145                             this.upstream = out;
 146                             sp.connect((Module.SinkPort)outPort);
 147                         }
 148                     });
 149             }
 150         }
 151         FabricElement top_horn = mkNode((FabricElement[])dests.toArray(new FabricElement[0]), true);
 152         mkNode((FabricElement[])sources.toArray(new FabricElement[0]), false)
 153             .addOutput(top_horn, top_horn.getInputPort());
 154     }
 155
 156     public FabricElement mkNode(FabricElement[] ports, boolean is_horn) { return mkNode(ports, is_horn, 0, ports.length); }
 157     public FabricElement mkNode(FabricElement[] ports, boolean is_horn, int start, int end) {
 158         switch(end-start) {
 159             case 0: throw new RuntimeException("this should never happen");
 160             case 1: return ports[start];
 161             default: {
 162                 FabricElement leftPort  = mkNode(ports, is_horn,  start,         (end+start)/2);
 163                 FabricElement rightPort = mkNode(ports, is_horn,  (end+start)/2, end);
 164                 return is_horn
 165                     ? new HornModule.HornInstance(this, top,     leftPort, rightPort)
 166                     : new FunnelModule.FunnelInstance(this, top, leftPort, rightPort);
 167             }
 168         }
 169     }
 170
 171
 172     // Expand //////////////////////////////////////////////////////////////////////////////
 173
 174     public void expand(ShipDescription sd) {
 175         try {
 176             if (sd.getSection("fpga")==null) return;
 177             String filename = sd.getName().toLowerCase();
 178
 179             if (sd.getSection("ucf") != null) {
 180                 File outf = new File("build/fpga/"+filename+".ucf");
 181                 FileOutputStream out = new FileOutputStream(outf);
 182                 PrintWriter pw = new PrintWriter(out);
 183                 pw.println(sd.getSection("ucf"));
 184                 pw.flush();
 185                 pw.close();
 186             }
 187
 188             File outf = new File("build/fpga/"+filename+".v");
 189             new File(outf.getParent()).mkdirs();
 190             System.err.println("writing to " + outf);
 191             FileOutputStream out = new FileOutputStream(outf);
 192             PrintWriter pw = new PrintWriter(out);
 193
 194             pw.println("`define WORDWIDTH                "+WIDTH_WORD);
 195             pw.println("`define CODEBAG_SIZE_BITS        "+CBD_SIZE.valmaskwidth);
 196             pw.println();
 197
 198             for(DockDescription dd : sd.ports()) {
 199                 String name = dd.getName();
 200                 pw.println("`define "+name+"_full    ("+name+"_r && !"+name+"_a)");
 201                 pw.println("`define "+name+"_empty  (!"+name+"_r && !"+name+"_a)");
 202                 if (dd.isInputDock()) {
 203                     // gets stuck on colliding-tokens
 204                     //pw.println("`define drain_"+name+"  if ("+name+"_r && !"+name+"_a) "+name+"_a <= 1;");
 205
 206                     // gets stuck on colliding-tokens
 207                     //pw.println("`define drain_"+name+"  if ("+name+"_r) "+name+"_a <= 1;");
 208
 209                     // also gets stuck
 210                     //pw.println("`define drain_"+name+"  if (!"+name+"_a) "+name+"_a <= 1;");
 211                     pw.println("`define drain_"+name+"  "+name+"_a <= 1;");
 212                 } else {
 213                     pw.println("`define fill_"+name+"  "+name+"_r <= 1;");
 214                 }
 215             }
 216
 217             pw.print("`define reset ");
 218             for(DockDescription bb : sd.ports()) {
 219                 String bb_name = bb.getName();
 220                 if (bb.isInputDock()) pw.print(bb_name+"_a <= 1; ");
 221                 else                  pw.print(bb_name+"_r <= 0; ");
 222             }
 223             pw.println();
 224
 225             pw.print("`define cleanup ");
 226
 227             // output docks
 228             for(DockDescription dd : sd.ports())
 229                 if (!dd.isInputDock())
 230                     pw.print("if ( "+dd.getName()+"_r && "+dd.getName()+"_a) "+dd.getName()+"_r <= 0; ");
 231
 232             // input docks: if all inputs are flushing, drain them all
 233             pw.print("if (1");
 234             for(DockDescription bb : sd.ports())
 235                 if (bb.isInputDock())
 236                     pw.print(" && "+bb.getName()+"_f");
 237             pw.print(") begin ");
 238             for(DockDescription bb : sd.ports())
 239                 if (bb.isInputDock())
 240                     pw.print(bb.getName()+"_a <= 1; ");
 241
 242             // input docks: if no inputs are flushing, do normal stuff
 243             pw.print("end else if (1");
 244             for(DockDescription bb : sd.ports())
 245                 if (bb.isInputDock())
 246                     pw.print(" && !"+bb.getName()+"_f");
 247             pw.print(") begin ");
 248
 249             for(DockDescription bb : sd.ports())
 250                 if (bb.isInputDock())
 251                     pw.print("if (!"+bb.getName()+"_r_ && "+bb.getName()+"_a) "+bb.getName()+"_a <= 0; ");
 252
 253             // input docks: if some-but-not-all inputs are flushing, drain all non-flushing docks
 254             pw.print("end else begin ");
 255
 256             for(DockDescription bb : sd.ports())
 257                 if (bb.isInputDock()) {
 258                     pw.print("if (!"+bb.getName()+"_r && "+bb.getName()+"_a) "+bb.getName()+"_a <= 0; ");
 259                     pw.print("if ("+bb.getName()+"_r && !"+bb.getName()+"_a) "+bb.getName()+"_a <= 1; ");
 260                 }
 261
 262             pw.print(" end");
 263
 264             pw.println();
 265
 266             pw.println("module " + filename + "( clk, rst ");
 267             for(DockDescription bb : sd.ports()) {
 268                 String bb_name = bb.getName();
 269                 pw.print("        ");
 270                 if (bb.isInputDock()) {
 271                     pw.print(", " + bb_name+"_r_");
 272                     pw.print(", " + bb_name+"_a_");
 273                     pw.print(", " + bb_name+"_d");
 274                 } else {
 275                     pw.print(", " + bb_name+"_r_");
 276                     pw.print(", " + bb_name+"_a");
 277                     pw.print(", " + bb_name+"_d_");
 278                 }
 279                 pw.println();
 280             }
 281             for(PercolatedPort pp : sd.percolatedPorts) {
 282                 pw.print("    , ");
 283                 pw.println(pp.name);
 284             }
 285             pw.println("        );");
 286             pw.println();
 287             pw.println("    input clk;");
 288             pw.println("    input rst;");
 289             for(PercolatedPort pp : sd.percolatedPorts) {
 290                 switch(pp.type) {
 291                     case UP:    pw.print("output"); break;
 292                     case DOWN:  pw.print("input");  break;
 293                     case INOUT: pw.print("inout");  break;
 294                 }
 295                 pw.print("  ");
 296                 if (pp.width > 1)
 297                     pw.print("["+(pp.width-1)+":0]");
 298                 pw.print(" ");
 299                 pw.print(pp.name);
 300                 pw.println(";");
 301             }
 302
 303             for(DockDescription bb : sd.ports()) {
 304                 String bb_name = bb.getName();
 305                 int width = bb.isDockless() ? WIDTH_PACKET : WIDTH_WORD;
 306                 if (bb.isInputDock()) {
 307                     pw.println("        input   ["+width+":0] "+bb_name+"_d;");
 308                     pw.println("        input   "+bb_name+"_r_;");
 309                     pw.println("        wire    "+bb_name+"_r;");
 310                     pw.println("        assign  "+bb_name+"_r = "+bb_name+"_r_ & ~"+bb_name+"_d["+width+"];");
 311                     pw.println("        output  "+bb_name+"_a_;");
 312                     pw.println("        reg     "+bb_name+"_a;");
 313                     pw.println("        initial "+bb_name+"_a  = 0;");
 314                     pw.println("        wire    "+bb_name+"_f;");
 315                     pw.println("        assign  "+bb_name+"_f  = "+bb_name+"_r_ & "+bb_name+"_d["+width+"] && ~"+bb_name+"_a;");
 316                     pw.println("        assign  "+bb_name+"_a_ = "+bb_name+"_a;");
 317                 } else {
 318                     pw.println("        output  ["+width+":0] "+bb_name+"_d_;");
 319                     pw.println("        input   "+bb_name+"_a;");
 320                     pw.println("        output  "+bb_name+"_r_;");
 321                     pw.println("        reg     "+bb_name+"_r;");
 322                     pw.println("        initial "+bb_name+"_r  = 0;");
 323                     pw.println("        assign  "+bb_name+"_r_ = "+bb_name+"_r;");
 324                 }
 325                 pw.println();
 326             }
 327
 328             if (filename.equals("fifo")) {
 329                 pw.println("  wire in_a__;");
 330                 pw.println("  wire out_r__;");
 331                 pw.println("  fifo8x37 fifo8x37(clk, rst,");
 332                 pw.println("                    in_r,    in_a__, in_d,");
 333                 pw.println("                    out_r__, out_a,  out_d_);");
 334                 pw.println("  always @(posedge clk) begin");
 335                 pw.println("    if (rst) begin");
 336                 pw.println("      `reset");
 337                 pw.println("    end else begin");
 338                 pw.println("      `cleanup");
 339                 pw.println("      out_r <= out_r__;");
 340                 pw.println("      if (in_a__) in_a  <= 1;");
 341                 pw.println("    end");
 342                 pw.println("  end");
 343             } else {
 344                 pw.println(sd.getSection("fpga"));
 345             }
 346
 347             pw.println("endmodule");
 348
 349             pw.flush();
 350             pw.close();
 351         } catch (Exception e) { throw new RuntimeException(e); }
 352     }
 353
 354 }