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