src/main/scala/devices/spi/TLSPI.scala

   1 // See LICENSE for license details.
   2 package sifive.blocks.devices.spi
   3
   4 import Chisel._
   5 import freechips.rocketchip.config.Parameters
   6 import freechips.rocketchip.diplomacy._
   7 import freechips.rocketchip.regmapper._
   8 import freechips.rocketchip.tilelink._
   9 import freechips.rocketchip.interrupts._
  10 import freechips.rocketchip.util.HeterogeneousBag
  11 import sifive.blocks.util.{NonBlockingEnqueue, NonBlockingDequeue}
  12
  13 trait SPIParamsBase {
  14   val rAddress: BigInt
  15   val rSize: BigInt
  16   val rxDepth: Int
  17   val txDepth: Int
  18
  19   val csWidth: Int
  20   val frameBits: Int
  21   val delayBits: Int
  22   val divisorBits: Int
  23
  24   val sampleDelay: Int
  25
  26   lazy val csIdBits = log2Up(csWidth)
  27   lazy val lengthBits = log2Floor(frameBits) + 1
  28   lazy val countBits = math.max(lengthBits, delayBits)
  29
  30   lazy val txDepthBits = log2Floor(txDepth) + 1
  31   lazy val rxDepthBits = log2Floor(rxDepth) + 1
  32
  33 }
  34
  35 case class SPIParams(
  36     rAddress: BigInt,
  37     rSize: BigInt = 0x1000,
  38     rxDepth: Int = 8,
  39     txDepth: Int = 8,
  40     csWidth: Int = 1,
  41     frameBits: Int = 8,
  42     delayBits: Int = 8,
  43     divisorBits: Int = 12,
  44     sampleDelay: Int = 2)
  45   extends SPIParamsBase {
  46
  47   require(frameBits >= 4)
  48   require(sampleDelay >= 0)
  49 }
  50
  51 class SPITopModule(c: SPIParamsBase, outer: TLSPIBase)
  52   extends LazyModuleImp(outer) {
  53
  54   val io = IO(new Bundle {
  55     val port = new SPIPortIO(c)
  56   })
  57
  58   val ctrl = Reg(init = SPIControl.init(c))
  59
  60   val fifo = Module(new SPIFIFO(c))
  61   val mac = Module(new SPIMedia(c))
  62   io.port <> mac.io.port
  63
  64   fifo.io.ctrl.fmt := ctrl.fmt
  65   fifo.io.ctrl.cs <> ctrl.cs
  66   fifo.io.ctrl.wm := ctrl.wm
  67   mac.io.ctrl.sck := ctrl.sck
  68   mac.io.ctrl.dla := ctrl.dla
  69   mac.io.ctrl.cs <> ctrl.cs
  70
  71   val ie = Reg(init = new SPIInterrupts().fromBits(Bits(0)))
  72   val ip = fifo.io.ip
  73   val (io_int, _) = outer.intnode.out(0)
  74   io_int(0) := (ip.txwm && ie.txwm) || (ip.rxwm && ie.rxwm)
  75
  76   protected val regmapBase = Seq(
  77     SPICRs.sckdiv -> Seq(RegField(c.divisorBits, ctrl.sck.div)),
  78     SPICRs.sckmode -> Seq(
  79       RegField(1, ctrl.sck.pha),
  80       RegField(1, ctrl.sck.pol)),
  81     SPICRs.csid -> Seq(RegField(c.csIdBits, ctrl.cs.id)),
  82     SPICRs.csdef -> ctrl.cs.dflt.map(x => RegField(1, x)),
  83     SPICRs.csmode -> Seq(RegField(SPICSMode.width, ctrl.cs.mode)),
  84     SPICRs.dcssck -> Seq(RegField(c.delayBits, ctrl.dla.cssck)),
  85     SPICRs.dsckcs -> Seq(RegField(c.delayBits, ctrl.dla.sckcs)),
  86     SPICRs.dintercs -> Seq(RegField(c.delayBits, ctrl.dla.intercs)),
  87     SPICRs.dinterxfr -> Seq(RegField(c.delayBits, ctrl.dla.interxfr)),
  88
  89     SPICRs.fmt -> Seq(
  90       RegField(SPIProtocol.width, ctrl.fmt.proto),
  91       RegField(SPIEndian.width, ctrl.fmt.endian),
  92       RegField(SPIDirection.width, ctrl.fmt.iodir)),
  93     SPICRs.len -> Seq(RegField(c.lengthBits, ctrl.fmt.len)),
  94
  95     SPICRs.txfifo -> NonBlockingEnqueue(fifo.io.tx),
  96     SPICRs.rxfifo -> NonBlockingDequeue(fifo.io.rx),
  97
  98     SPICRs.txmark -> Seq(RegField(c.txDepthBits, ctrl.wm.tx)),
  99     SPICRs.rxmark -> Seq(RegField(c.rxDepthBits, ctrl.wm.rx)),
 100
 101     SPICRs.ie -> Seq(
 102       RegField(1, ie.txwm),
 103       RegField(1, ie.rxwm)),
 104     SPICRs.ip -> Seq(
 105       RegField.r(1, ip.txwm),
 106       RegField.r(1, ip.rxwm)))
 107 }
 108
 109 abstract class TLSPIBase(w: Int, c: SPIParamsBase)(implicit p: Parameters) extends LazyModule {
 110   require(isPow2(c.rSize))
 111   val device = new SimpleDevice("spi", Seq("sifive,spi0"))
 112   val rnode = TLRegisterNode(address = Seq(AddressSet(c.rAddress, c.rSize-1)), device = device, beatBytes = w)
 113   val intnode = IntSourceNode(IntSourcePortSimple(resources = device.int))
 114 }
 115
 116 class TLSPI(w: Int, c: SPIParams)(implicit p: Parameters) extends TLSPIBase(w,c)(p) {
 117   lazy val module = new SPITopModule(c, this) {
 118     mac.io.link <> fifo.io.link
 119     rnode.regmap(regmapBase:_*)
 120   }
 121 }