move htif to uncore

uncore/src/main/scala/htif.scala

@@ -0,0 +1,267 @@
+package rocket
+
+import Chisel._
+import Node._
+import uncore._
+
+class HostIO(val w: Int) extends Bundle
+{
+  val clk = Bool(OUTPUT)
+  val clk_edge = Bool(OUTPUT)
+  val in = Decoupled(Bits(width = w)).flip
+  val out = Decoupled(Bits(width = w))
+  val debug_stats_pcr = Bool(OUTPUT)
+}
+
+class PCRReq extends Bundle
+{
+  val rw = Bool()
+  val addr = Bits(width = 5)
+  val data = Bits(width = 64)
+}
+
+class HTIFIO(ntiles: Int) extends Bundle
+{
+  val reset = Bool(INPUT)
+  val id = UInt(INPUT, log2Up(ntiles))
+  val pcr_req = Decoupled(new PCRReq).flip
+  val pcr_rep = Decoupled(Bits(width = 64))
+  val ipi_req = Decoupled(Bits(width = log2Up(ntiles)))
+  val ipi_rep = Decoupled(Bool()).flip
+  val debug_stats_pcr = Bool(OUTPUT)
+    // wired directly to stats register
+    // expected to be used to quickly indicate to testbench to do logging b/c in 'interesting' work
+}
+
+class SCRIO(n: Int) extends Bundle
+{
+  val rdata = Vec.fill(n){Bits(INPUT, 64)}
+  val wen = Bool(OUTPUT)
+  val waddr = UInt(OUTPUT, log2Up(n))
+  val wdata = Bits(OUTPUT, 64)
+}
+
+class HTIF(w: Int, pcr_RESET: Int, nSCR: Int)(implicit conf: TileLinkConfiguration) extends Module with ClientCoherenceAgent
+{
+  implicit val (ln, co) = (conf.ln, conf.co)
+  val nTiles = ln.nClients-1 // This HTIF is itself a TileLink client
+  val io = new Bundle {
+    val host = new HostIO(w)
+    val cpu = Vec.fill(nTiles){new HTIFIO(nTiles).flip}
+    val mem = new TileLinkIO
+    val scr = new SCRIO(nSCR)
+  }
+
+  io.host.debug_stats_pcr := io.cpu.map(_.debug_stats_pcr).reduce(_||_)
+    // system is 'interesting' if any tile is 'interesting'
+
+  val short_request_bits = 64
+  val long_request_bits = 576
+  require(short_request_bits % w == 0)
+
+  val rx_count_w = 13 + log2Up(64) - log2Up(w) // data size field is 12 bits
+  val rx_count = Reg(init=UInt(0,rx_count_w))
+  val rx_shifter = Reg(Bits(width = short_request_bits))
+  val rx_shifter_in = Cat(io.host.in.bits, rx_shifter(short_request_bits-1,w))
+  val next_cmd = rx_shifter_in(3,0)
+  val cmd = Reg(Bits())
+  val size = Reg(Bits())
+  val pos = Reg(Bits())
+  val seqno = Reg(Bits())
+  val addr = Reg(Bits())
+  when (io.host.in.valid && io.host.in.ready) {
+    rx_shifter := rx_shifter_in
+    rx_count := rx_count + UInt(1)
+    when (rx_count === UInt(short_request_bits/w-1)) {
+      cmd := next_cmd
+      size := rx_shifter_in(15,4)
+      pos := rx_shifter_in(15,4+OFFSET_BITS-3)
+      seqno := rx_shifter_in(23,16)
+      addr := rx_shifter_in(63,24)
+    }
+  }
+
+  val rx_word_count = (rx_count >> UInt(log2Up(short_request_bits/w)))
+  val rx_word_done = io.host.in.valid && rx_count(log2Up(short_request_bits/w)-1,0).andR
+  val packet_ram_depth = long_request_bits/short_request_bits-1
+  val packet_ram = Vec.fill(packet_ram_depth){Reg(Bits(width = short_request_bits))}
+  when (rx_word_done && io.host.in.ready) {
+    packet_ram(rx_word_count(log2Up(packet_ram_depth)-1,0) - UInt(1)) := rx_shifter_in
+  }
+
+  val cmd_readmem :: cmd_writemem :: cmd_readcr :: cmd_writecr :: cmd_ack :: cmd_nack :: Nil = Enum(UInt(), 6)
+
+  val pcr_addr = addr(io.cpu(0).pcr_req.bits.addr.width-1, 0)
+  val pcr_coreid = addr(log2Up(nTiles)-1+20+1,20)
+  val pcr_wdata = packet_ram(0)
+
+  val bad_mem_packet = size(OFFSET_BITS-1-3,0).orR || addr(OFFSET_BITS-1-3,0).orR
+  val nack = Mux(cmd === cmd_readmem || cmd === cmd_writemem, bad_mem_packet,
+             Mux(cmd === cmd_readcr || cmd === cmd_writecr, size != UInt(1),
+             Bool(true)))
+
+  val tx_count = Reg(init=UInt(0, rx_count_w))
+  val tx_subword_count = tx_count(log2Up(short_request_bits/w)-1,0)
+  val tx_word_count = tx_count(rx_count_w-1, log2Up(short_request_bits/w))
+  val packet_ram_raddr = tx_word_count(log2Up(packet_ram_depth)-1,0) - UInt(1)
+  when (io.host.out.valid && io.host.out.ready) {
+    tx_count := tx_count + UInt(1)
+  }
+
+  val rx_done = rx_word_done && Mux(rx_word_count === UInt(0), next_cmd != cmd_writemem && next_cmd != cmd_writecr, rx_word_count === size || rx_word_count(log2Up(packet_ram_depth)-1,0) === UInt(0))
+  val tx_size = Mux(!nack && (cmd === cmd_readmem || cmd === cmd_readcr || cmd === cmd_writecr), size, UInt(0))
+  val tx_done = io.host.out.ready && tx_subword_count.andR && (tx_word_count === tx_size || tx_word_count > UInt(0) && packet_ram_raddr.andR)
+
+  val mem_acked = Reg(init=Bool(false))
+  val mem_gxid = Reg(Bits())
+  val mem_gsrc = Reg(UInt(width = conf.ln.idBits))
+  val mem_needs_ack = Reg(Bool())
+  when (io.mem.grant.valid) { 
+    mem_acked := Bool(true)
+    mem_gxid := io.mem.grant.bits.payload.master_xact_id
+    mem_gsrc := io.mem.grant.bits.header.src
+    mem_needs_ack := conf.co.requiresAck(io.mem.grant.bits.payload)
+  }
+  io.mem.grant.ready := Bool(true)
+
+  val state_rx :: state_pcr_req :: state_pcr_resp :: state_mem_req :: state_mem_wdata :: state_mem_wresp :: state_mem_rdata :: state_mem_finish :: state_tx :: Nil = Enum(UInt(), 9)
+  val state = Reg(init=state_rx)
+
+  val rx_cmd = Mux(rx_word_count === UInt(0), next_cmd, cmd)
+  when (state === state_rx && rx_done) {
+    state := Mux(rx_cmd === cmd_readmem || rx_cmd === cmd_writemem, state_mem_req,
+             Mux(rx_cmd === cmd_readcr || rx_cmd === cmd_writecr, state_pcr_req,
+             state_tx))
+  }
+
+  val mem_cnt = Reg(init=UInt(0, log2Up(REFILL_CYCLES)))
+  val x_init = Module(new Queue(new Acquire, 1))
+  when (state === state_mem_req && x_init.io.enq.ready) {
+    state := Mux(cmd === cmd_writemem, state_mem_wdata, state_mem_rdata)
+  }
+  when (state === state_mem_wdata && io.mem.acquire.data.ready) {
+    when (mem_cnt.andR)  {
+      state := state_mem_wresp
+    }
+    mem_cnt := mem_cnt + UInt(1)
+  }
+  when (state === state_mem_wresp) {
+    when (mem_acked) {
+      state := state_mem_finish
+      mem_acked := Bool(false)
+    }
+  }
+  when (state === state_mem_rdata) {
+    when (io.mem.grant.valid) {
+      when (mem_cnt.andR)  {
+        state := state_mem_finish
+      }
+      mem_cnt := mem_cnt + UInt(1)
+    }
+    mem_acked := Bool(false)
+  }
+  when (state === state_mem_finish && io.mem.grant_ack.ready) {
+    state := Mux(cmd === cmd_readmem || pos === UInt(1),  state_tx, state_rx)
+    pos := pos - UInt(1)
+    addr := addr + UInt(1 << OFFSET_BITS-3)
+  }
+  when (state === state_tx && tx_done) {
+    when (tx_word_count === tx_size) {
+      rx_count := UInt(0)
+      tx_count := UInt(0)
+    }
+    state := Mux(cmd === cmd_readmem && pos != UInt(0), state_mem_req, state_rx)
+  }
+
+  var mem_req_data: Bits = null
+  for (i <- 0 until MEM_DATA_BITS/short_request_bits) {
+    val idx = Cat(mem_cnt, UInt(i, log2Up(MEM_DATA_BITS/short_request_bits)))
+    when (state === state_mem_rdata && io.mem.grant.valid) {
+      packet_ram(idx) := io.mem.grant.bits.payload.data((i+1)*short_request_bits-1, i*short_request_bits)
+    }
+    mem_req_data = Cat(packet_ram(idx), mem_req_data)
+  }
+  x_init.io.enq.valid := state === state_mem_req
+  val init_addr = addr.toUInt >> UInt(OFFSET_BITS-3)
+  x_init.io.enq.bits := Mux(cmd === cmd_writemem, 
+    Acquire(co.getUncachedWriteAcquireType, init_addr, UInt(0)), 
+    Acquire(co.getUncachedReadAcquireType, init_addr, UInt(0)))
+  io.mem.acquire.meta <> FIFOedLogicalNetworkIOWrapper(x_init.io.deq, UInt(conf.ln.nClients), UInt(0)) // By convention HTIF is the client with the largest id
+  io.mem.acquire.data.valid := state === state_mem_wdata
+  io.mem.acquire.data.bits.payload.data := mem_req_data
+  io.mem.grant_ack.valid := (state === state_mem_finish) && mem_needs_ack
+  io.mem.grant_ack.bits.payload.master_xact_id := mem_gxid
+  io.mem.grant_ack.bits.header.dst := mem_gsrc
+  io.mem.probe.ready := Bool(false)
+  io.mem.release.meta.valid := Bool(false)
+  io.mem.release.data.valid := Bool(false)
+
+  val pcrReadData = Reg(Bits(width = io.cpu(0).pcr_rep.bits.getWidth))
+  for (i <- 0 until nTiles) {
+    val my_reset = Reg(init=Bool(true))
+    val my_ipi = Reg(init=Bool(false))
+
+    val cpu = io.cpu(i)
+    val me = pcr_coreid === UInt(i)
+    cpu.pcr_req.valid := state === state_pcr_req && me && pcr_addr != UInt(pcr_RESET)
+    cpu.pcr_req.bits.rw := cmd === cmd_writecr
+    cpu.pcr_req.bits.addr := pcr_addr
+    cpu.pcr_req.bits.data := pcr_wdata
+    cpu.reset := my_reset
+
+    when (cpu.ipi_rep.ready) {
+      my_ipi := Bool(false)
+    }
+    cpu.ipi_rep.valid := my_ipi
+    cpu.ipi_req.ready := Bool(true)
+    for (j <- 0 until nTiles) {
+      when (io.cpu(j).ipi_req.valid && io.cpu(j).ipi_req.bits === UInt(i)) {
+        my_ipi := Bool(true)
+      }
+    }
+
+    when (cpu.pcr_req.valid && cpu.pcr_req.ready) {
+      state := state_pcr_resp
+    }
+    when (state === state_pcr_req && me && pcr_addr === UInt(pcr_RESET)) {
+      when (cmd === cmd_writecr) {
+        my_reset := pcr_wdata(0)
+      }
+      pcrReadData := my_reset.toBits
+      state := state_tx
+    }
+
+    cpu.pcr_rep.ready := Bool(true)
+    when (cpu.pcr_rep.valid) {
+      pcrReadData := cpu.pcr_rep.bits
+      state := state_tx
+    }
+  }
+
+  val scr_addr = addr(log2Up(nSCR)-1, 0)
+  val scr_rdata = Vec.fill(io.scr.rdata.size){Bits(width = 64)}
+  for (i <- 0 until scr_rdata.size)
+    scr_rdata(i) := io.scr.rdata(i)
+  scr_rdata(0) := UInt(nTiles)
+  scr_rdata(1) := UInt(((REFILL_CYCLES*MEM_DATA_BITS/8) << x_init.io.enq.bits.addr.getWidth) >> 20)
+
+  io.scr.wen := Bool(false)
+  io.scr.wdata := pcr_wdata
+  io.scr.waddr := scr_addr.toUInt
+  when (state === state_pcr_req && pcr_coreid === SInt(-1)) {
+    io.scr.wen := cmd === cmd_writecr
+    pcrReadData := scr_rdata(scr_addr)
+    state := state_tx
+  }
+
+  val tx_cmd = Mux(nack, cmd_nack, cmd_ack)
+  val tx_cmd_ext = Cat(Bits(0, 4-tx_cmd.getWidth), tx_cmd)
+  val tx_header = Cat(addr, seqno, tx_size, tx_cmd_ext)
+  val tx_data = Mux(tx_word_count === UInt(0), tx_header,
+                Mux(cmd === cmd_readcr || cmd === cmd_writecr, pcrReadData,
+                packet_ram(packet_ram_raddr)))
+
+  io.host.in.ready := state === state_rx
+  io.host.out.valid := state === state_tx
+  io.host.out.bits := tx_data >> Cat(tx_count(log2Up(short_request_bits/w)-1,0), Bits(0, log2Up(w)))
+}