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