eb001/src/main/scala/backBoard/shin/ShinSlv.scala

package BACK

import chisel3._
import chisel3.util._

class ShinSlvIO_Bundle extends Bundle{

  val isOnline = Output(Bool())
  val isLast   = Input(Bool())
  val DCIn   = Input(Bool())

  val downSer = new Bundle{
    val out  = Output(Bool())
    val in   = Input(Bool())
  }
  val upSer = new Bundle{
    val out  = Output(Bool())
    val in   = Input(Bool())
  }

  val overCLK = Input(Bool())

}

abstract class ShinSlvPhyBase extends Module{
  val io: ShinSlvIO_Bundle = IO(new ShinSlvIO_Bundle)

  val downStreamCdrOut = Module(new CDROut)
  val downStreamCdrIn  = Module(new CDRIn )

  val upStreamCdrOut = Module(new CDROut)
  val upStreamCdrIn  = Module(new CDRIn )

  io.downSer.out := downStreamCdrOut.io.serDat
  downStreamCdrIn.io.serDat := io.downSer.in
  downStreamCdrIn.io.overCLK := io.overCLK

  io.upSer.out := upStreamCdrOut.io.serDat
  upStreamCdrIn.io.serDat := io.upSer.in
  upStreamCdrIn.io.overCLK := io.overCLK

  io.isOnline := true.B


  val downRegTemp = Reg(Vec( 32, UInt(8.W) ))
  val upReg       = WireDefault(VecInit((0 until 32).map{i => 0.U(8.W)}))

  val headByte = (new Header_Info_Bundle).getWidth/8
  require( headByte == 8 )
  require( headByte > 4, "At Least 4 more additional cycles to ensure CRC Failure boardcast to next nodes!\n") 

  val OpInitByte = 1
  val OpBoardCastByte = 16
  val OpUniCastByte = 32

  val maxLocalByte = OpInitByte max OpBoardCastByte max OpUniCastByte

  val downStreamFifo = Module( new Queue( new AXIS_Bundle(8), headByte + 4 ) )
  val upStreamFifo = Module( new Queue( new AXIS_Bundle(8), headByte + maxLocalByte + 4 ) ) //4 is reserve

  val isLastDevice = Wire(Bool())

}

trait ShinSlvPhyDownStreamRecv{ this: ShinSlvPhyBase =>

  val DownRecvStateIdle  = 0.U
  val DownRecvStateOHead = 1.U
  val DownRecvStateSData = 2.U
  val DownRecvStateFData = 3.U
  val DownRecvStateCRC   = 4.U


  val downOldHead = Reg( new Header_Info_Bundle )
  val downNewHead = Reg( new Header_Info_Bundle )



  val downRecvStateNext = Wire( UInt(3.W) )
  val downRecvStateCurr = RegNext( downRecvStateNext, 0.U )

  val downRecvCnt = Reg(UInt(10.W))


  val downLocalDataByte = Mux1H(Seq(
    (downOldHead.operator === 0.U) -> OpInitByte.U,
    (downOldHead.operator === 1.U) -> OpBoardCastByte.U,
    (downOldHead.operator === 2.U) -> OpUniCastByte.U,
  ))

  val isDownStreamError = RegInit( false.B )

  val downForwardDataByte = downNewHead.length

  val isLastDevice: Bool

  downRecvStateNext := Mux1H(Seq(
    (downRecvStateCurr === DownRecvStateIdle ) -> Mux( downStreamCdrIn.io.axis.valid, DownRecvStateOHead, DownRecvStateIdle ),
    (downRecvStateCurr === DownRecvStateOHead) -> Mux( downStreamCdrIn.io.axis.fire, Mux( ~downStreamCdrIn.io.axis.bits.tlast, Mux(downRecvCnt === ((headByte)-1).U,        DownRecvStateSData, DownRecvStateOHead), DownRecvStateIdle ), DownRecvStateOHead), 
    (downRecvStateCurr === DownRecvStateSData) -> Mux( downStreamCdrIn.io.axis.fire, Mux( ~downStreamCdrIn.io.axis.bits.tlast, Mux(downRecvCnt === (downLocalDataByte -1.U),  Mux( downRecvCnt === (downOldHead.length - 1.U), DownRecvStateCRC, DownRecvStateFData ), DownRecvStateSData), DownRecvStateIdle ), DownRecvStateSData),
    (downRecvStateCurr === DownRecvStateFData) -> Mux( downStreamCdrIn.io.axis.fire, Mux( ~downStreamCdrIn.io.axis.bits.tlast, Mux(downRecvCnt === (downForwardDataByte -1.U) , DownRecvStateCRC,   DownRecvStateFData), DownRecvStateIdle ), DownRecvStateFData),
    (downRecvStateCurr === DownRecvStateCRC  ) -> Mux( downStreamCdrIn.io.axis.fire & downStreamCdrIn.io.axis.bits.tlast, DownRecvStateIdle, DownRecvStateCRC ),
  ))

  when( downRecvStateCurr =/= downRecvStateNext ){
    downRecvCnt := 0.U
  } .elsewhen( downStreamCdrIn.io.axis.fire ){
    downRecvCnt := downRecvCnt + 1.U
  }

  //---------------

  when( downRecvStateCurr === DownRecvStateOHead & downStreamCdrIn.io.axis.fire ){
    downOldHead := Cat( downOldHead.asUInt.tail(8), downStreamCdrIn.io.axis.bits.tdata ).asTypeOf(new Header_Info_Bundle)
  }


  //---------------
  val isDownNewHeadCreated = downRecvStateCurr === DownRecvStateSData & downRecvStateNext === DownRecvStateFData //新头是由老头产生，担忧会欠拍
  when( isDownNewHeadCreated ){
    downNewHead.length   := Mux( downOldHead.length >= downLocalDataByte, downOldHead.length - downLocalDataByte, 0.U )
    downNewHead.operator := downOldHead.operator
    downNewHead.param    := downOldHead.param
  }


  when( downRecvStateCurr === DownRecvStateSData & downStreamCdrIn.io.axis.fire ){
    downRegTemp(downRecvCnt) := downStreamCdrIn.io.axis.bits.tdata
  }

  //---------------
  downStreamFifo.io.enq.valid :=
    downRecvStateCurr === DownRecvStateFData & downStreamCdrIn.io.axis.fire & ~isLastDevice
  downStreamFifo.io.enq.bits.tdata := downStreamCdrIn.io.axis.bits.tdata
  downStreamFifo.io.enq.bits.tuser := downStreamCdrIn.io.axis.bits.tuser
  downStreamFifo.io.enq.bits.tlast := downRecvCnt === (downForwardDataByte -1.U) | downStreamCdrIn.io.axis.bits.tlast

  downStreamCdrIn.io.axis.ready := 
    (downRecvStateCurr === DownRecvStateOHead) |
    (downRecvStateCurr === DownRecvStateSData) |
    ((downRecvStateCurr === DownRecvStateFData) & downStreamFifo.io.enq.ready) |
    (downRecvStateCurr === DownRecvStateCRC  )

  when( downRecvStateCurr === DownRecvStateIdle & downRecvStateNext === DownRecvStateOHead){
    isDownStreamError := false.B
  } .elsewhen( downStreamFifo.io.enq.fire & downStreamFifo.io.enq.bits.tuser ){
    isDownStreamError := true.B
    printf("Warning, Wrong Package Received in DownStream, That could not happened!\n")
  } .elsewhen( downRecvStateCurr === DownRecvStateOHead & downRecvStateNext === DownRecvStateIdle ){
    isDownStreamError := true.B
    printf("Warning, Wrong Package Received in DownStream, That could not happened!\n")
  } .elsewhen( downRecvStateCurr === DownRecvStateSData & downRecvStateNext === DownRecvStateIdle ){
    isDownStreamError := true.B
    printf("Warning, Wrong Package Received in DownStream, That could not happened!\n")
  } .elsewhen( downRecvStateCurr === DownRecvStateFData & downRecvStateNext === DownRecvStateIdle ){
    isDownStreamError := true.B
    printf("Warning, Wrong Package Received in DownStream, That could not happened!\n")
  } .elsewhen( downRecvStateCurr === DownRecvStateCRC & (downRecvCnt > 3.U | (downStreamCdrIn.io.axis.fire & downStreamCdrIn.io.axis.bits.tlast & downRecvCnt < 3.U)) ){
    isDownStreamError := true.B
    printf("Warning, Wrong Package Received in DownStream, That could not happened!\n")
  } .elsewhen( isDownNewHeadCreated & downOldHead.length < downLocalDataByte ){ //本包的负载不能满足本级数据需求，传输错误
    isDownStreamError := true.B
    printf("Warning, Wrong Package Received in DownStream, That could not happened!\n")
  } .elsewhen( isDownNewHeadCreated & isLastDevice & downOldHead.length =/= downLocalDataByte ){
    printf("Warning, Wrong Package Received in DownStream, SoftWare Check!\n")
  }



  assert( ~(downRecvStateCurr === DownRecvStateFData & ~downStreamFifo.io.enq.ready), "Assert Failed, downStream Forward Fifo is OverFlow!" )




}

trait ShinSlvPhyDownStreamSend{ this: ShinSlvPhyBase =>
  val DownSendStateIdle  = 0.U
  val DownSendStateNHead = 1.U
  val DownSendStateFData = 2.U

  val downSendCnt = Reg(UInt(10.W))

  val isDownNewHeadCreated: Bool
  val isLastDevice: Bool
  val downForwardDataByte: UInt
  val downNewHead: Header_Info_Bundle
  val isDownStreamError: Bool


  val downSendSteteNext = Wire( UInt(3.W) )
  val downSendStateCurr = RegNext( downSendSteteNext, 0.U )

  downSendSteteNext := Mux1H(Seq(
    ( downSendStateCurr === DownSendStateIdle  ) -> Mux( isDownNewHeadCreated & ~isLastDevice, DownSendStateNHead, DownSendStateIdle ),
    ( downSendStateCurr === DownSendStateNHead ) -> Mux( downSendCnt === ((headByte)-1).U & downStreamCdrOut.io.axis.fire,       DownSendStateFData, DownSendStateNHead ),
    ( downSendStateCurr === DownSendStateFData ) -> Mux( downSendCnt === (downForwardDataByte -1.U) & downStreamCdrOut.io.axis.fire, DownSendStateIdle,  DownSendStateFData),
  ))

  when( downSendStateCurr =/= downSendSteteNext ){
    downSendCnt := 0.U
  } .elsewhen( downStreamCdrOut.io.axis.fire ){
    downSendCnt := downSendCnt + 1.U
  }

  downStreamCdrOut.io.axis.valid :=
    downSendStateCurr === DownSendStateNHead | downSendStateCurr === DownSendStateFData

  downStreamCdrOut.io.axis.bits.tdata := Mux1H(Seq(
    ( downSendStateCurr === DownSendStateNHead ) -> (downNewHead.asUInt << (downSendCnt << 3)).apply(63,56),
    ( downSendStateCurr === DownSendStateFData ) -> downStreamFifo.io.deq.bits.tdata,
  ))

  downStreamCdrOut.io.axis.bits.tlast := ( downSendStateCurr === DownSendStateFData ) & downStreamFifo.io.deq.bits.tlast


  downStreamCdrOut.io.axis.bits.tuser :=
    (( downSendStateCurr === DownSendStateFData ) & downStreamFifo.io.deq.bits.tuser ) |
    isDownStreamError

  downStreamFifo.io.deq.ready :=
    downSendStateCurr === DownSendStateFData & downStreamCdrOut.io.axis.ready

  assert( ~(downStreamCdrIn.io.axis.valid & ~downStreamCdrIn.io.axis.ready) )  
}

abstract class ShinSlvPhyDownStream extends ShinSlvPhyBase
with ShinSlvPhyDownStreamRecv
with ShinSlvPhyDownStreamSend{
  
}

trait ShinSlvPhyUpStreamRecv{ this: ShinSlvPhyDownStream =>

  val UpRecvStateIdle  = 0.U
  val UpRecvStateOHead = 1.U
  val UpRecvStateFData = 2.U
  val UpRecvStateCRC   = 3.U

  val upOldHead = Reg( new Header_Info_Bundle )
  val upNewHead = Reg( new Header_Info_Bundle )


  val upRecvSteteNext = Wire( UInt(3.W) )
  val upRecvStateCurr = RegNext( upRecvSteteNext, 0.U )

  val upRecvCnt = Reg(UInt(10.W))

  val isLastDevice: Bool

  upRecvSteteNext := Mux1H(Seq(
    (upRecvStateCurr === UpRecvStateIdle ) -> Mux( upStreamCdrIn.io.axis.valid, UpRecvStateOHead, UpRecvStateIdle ),
    (upRecvStateCurr === UpRecvStateOHead) -> Mux( upStreamCdrIn.io.axis.fire, Mux( ~upStreamCdrIn.io.axis.bits.tlast, Mux( upRecvCnt === ((headByte)-1).U,         UpRecvStateFData, UpRecvStateOHead), UpRecvStateIdle), UpRecvStateOHead ),
    (upRecvStateCurr === UpRecvStateFData) -> Mux( upStreamCdrIn.io.axis.fire, Mux( ~upStreamCdrIn.io.axis.bits.tlast, Mux( upRecvCnt === (upOldHead.length - 1.U), UpRecvStateCRC,   UpRecvStateFData), UpRecvStateIdle), UpRecvStateFData ),
    (upRecvStateCurr === UpRecvStateCRC  ) -> Mux( upStreamCdrIn.io.axis.fire & upStreamCdrIn.io.axis.bits.tlast, UpRecvStateIdle, UpRecvStateCRC ),
  ))

  when( upRecvStateCurr =/= upRecvSteteNext){
    upRecvCnt := 0.U
  } .elsewhen( upStreamCdrIn.io.axis.fire ){
    upRecvCnt := upRecvCnt + 1.U
  }



  val isLastDownStreamEnd = ( isLastDevice & (downRecvStateCurr === DownRecvStateCRC & downRecvStateNext === DownRecvStateIdle))


  //---------------

  when( (upRecvStateCurr === UpRecvStateOHead & upStreamCdrIn.io.axis.fire) ){
    upOldHead := Cat( upOldHead.asUInt.tail(8), upStreamCdrIn.io.axis.bits.tdata ).asTypeOf(new Header_Info_Bundle)
  } .elsewhen( isLastDownStreamEnd ){
    upOldHead.operator := downOldHead.operator
    upOldHead.length   := 0.U
    upOldHead.param    := downOldHead.param
  }






  //---------------


 val upLocalDataByte = Mux1H(Seq(
    (upOldHead.operator === 0.U) -> OpInitByte.U,
    (upOldHead.operator === 1.U) -> OpBoardCastByte.U,
    (upOldHead.operator === 2.U) -> OpUniCastByte.U,
  ))



  val isUpNewHeadCreated = 
    RegNext(upRecvStateCurr === UpRecvStateOHead & upRecvSteteNext === UpRecvStateFData, false.B) | //补一拍
    isLastDownStreamEnd

  when( isUpNewHeadCreated ){
    upNewHead.length   := upOldHead.length + upLocalDataByte
    upNewHead.operator := upOldHead.operator
    upNewHead.param    := upOldHead.param
  } 

  val upForwardDataByte = upNewHead.length



  //---------------
  upStreamFifo.io.enq.valid :=
    upRecvStateCurr === UpRecvStateFData & upStreamCdrIn.io.axis.fire
  upStreamFifo.io.enq.bits.tdata := upStreamCdrIn.io.axis.bits.tdata
  upStreamFifo.io.enq.bits.tuser := upStreamCdrIn.io.axis.bits.tuser
  upStreamFifo.io.enq.bits.tlast := upRecvCnt === (upForwardDataByte -1.U) | upStreamCdrIn.io.axis.bits.tlast


  upStreamCdrIn.io.axis.ready := 
    (upRecvStateCurr === UpRecvStateOHead) |
    ((upRecvStateCurr === UpRecvStateFData) & upStreamFifo.io.enq.ready) |
    (upRecvStateCurr === UpRecvStateCRC  )





  val isUpStreamError = RegInit( false.B )


  when( (upRecvStateCurr === UpRecvStateIdle & upRecvSteteNext === UpRecvStateOHead) | isLastDownStreamEnd ){
    isUpStreamError := false.B
  } .elsewhen( upStreamFifo.io.enq.fire & upStreamFifo.io.enq.bits.tuser ){
    isUpStreamError := true.B
    printf("Warning, Wrong Package Received in UpStream, That could not happened!\n")
  } .elsewhen( upRecvStateCurr === UpRecvStateOHead & upRecvSteteNext === UpRecvStateIdle ){
    isUpStreamError := true.B
    printf("Warning, Wrong Package Received in UpStream, That could not happened!\n")
  } .elsewhen( upRecvStateCurr === UpRecvStateFData & upRecvSteteNext === UpRecvStateIdle ){
    isUpStreamError := true.B
    printf("Warning, Wrong Package Received in UpStream, That could not happened!\n")
  } .elsewhen( upRecvStateCurr === UpRecvStateCRC & (upRecvCnt > 3.U | (upStreamCdrIn.io.axis.fire & upStreamCdrIn.io.axis.bits.tlast & upRecvCnt < 3.U)) ){
    isUpStreamError := true.B
    printf("Warning, Wrong Package Received in UpStream, That could not happened!\n")
  }



  assert( ~(upRecvStateCurr === UpRecvStateFData & ~upStreamFifo.io.enq.ready), "Assert Failed, upStream Forward Fifo is OverFlow!" )


}

trait ShinSlvPhyUpStreamSend{ this: ShinSlvPhyDownStream =>


  val UpSendStateIdle  = 0.U
  val UpSendStateNHead = 1.U
  val UpSendStateLData = 2.U
  val UpSendStateFData = 3.U



  val upSendStateNext = Wire( UInt(3.W) )
  val upSendStateCurr = RegNext( downSendSteteNext, 0.U )

  val upSendCnt = Reg(UInt(10.W))

  val isUpNewHeadCreated: Bool
  val upLocalDataByte: UInt
  val isLastDevice: Bool
  val upForwardDataByte: UInt
  val upNewHead: Header_Info_Bundle
  val isUpStreamError: Bool

  upSendStateNext := Mux1H(Seq(
    ( upSendStateCurr === UpSendStateIdle  ) -> Mux( isUpNewHeadCreated, UpSendStateNHead, UpSendStateIdle ),
    ( upSendStateCurr === UpSendStateNHead ) -> Mux( upSendCnt === ((headByte)-1).U & upStreamCdrOut.io.axis.fire,          UpSendStateLData, UpSendStateNHead),
    ( upSendStateCurr === UpSendStateLData ) -> Mux( upSendCnt === (upLocalDataByte   - 1.U) & upStreamCdrOut.io.axis.fire, Mux( isLastDevice, UpSendStateIdle, UpSendStateFData), UpSendStateLData),
    ( upSendStateCurr === UpSendStateFData ) -> Mux( upSendCnt === (upForwardDataByte - 1.U) & upStreamCdrOut.io.axis.fire, UpSendStateIdle,  UpSendStateFData),
  ))

  when( upSendStateCurr =/= upSendStateNext ){
    upSendCnt := 0.U
  } .elsewhen( upStreamCdrOut.io.axis.fire ){
    upSendCnt := upSendCnt + 1.U
  }




  upStreamCdrOut.io.axis.valid :=
    upSendStateCurr === UpSendStateNHead | upSendStateCurr === UpSendStateLData | upSendStateCurr === UpSendStateFData

  upStreamCdrOut.io.axis.bits.tdata := Mux1H(Seq(
    ( upSendStateCurr === UpSendStateNHead ) -> (upNewHead.asUInt << (upSendCnt << 3)).apply(63,56),
    ( upSendStateCurr === UpSendStateLData ) -> upReg(upSendCnt),
    ( upSendStateCurr === UpSendStateFData ) -> upStreamFifo.io.deq.bits.tdata,
  ))

  upStreamCdrOut.io.axis.bits.tlast := ( upSendStateCurr === UpSendStateFData ) & upStreamFifo.io.deq.bits.tlast

  upStreamCdrOut.io.axis.bits.tuser :=
    (( upSendStateCurr === UpSendStateFData ) & upStreamFifo.io.deq.bits.tuser ) |
    isUpStreamError

  upStreamFifo.io.deq.ready :=
    upSendStateCurr === UpSendStateFData & upStreamCdrOut.io.axis.ready

  assert( ~(upStreamCdrIn.io.axis.valid & ~upStreamCdrIn.io.axis.ready) )

  val isUpStreamEnd = (upSendStateCurr =/= UpSendStateIdle) & (upSendStateNext === UpSendStateIdle)

}



// trait ShinSlvPhyCloseLoop{ this: ShinSlvPhyDownStream =>
//   val isLastDevice: Bool


// }


abstract class ShinSlvLinkBase extends ShinSlvPhyDownStream
with ShinSlvPhyUpStreamRecv
with ShinSlvPhyUpStreamSend
// with ShinSlvPhyCloseLoop
{

}

trait ShinSlvLinkInit{ this: ShinSlvLinkBase =>
  //定义初始化任务
  //下行定长包，各从机计算所在位置，更新ip地址寄存器，最后一个暂时通过IO实现闭环
  //以下行包头解析时间，从机位置号，标定数据计算更新RTC时间寄存器
  //上行根据包长，从站确定尾部伙伴数量（备用），
  //以上行包头解析时间放置本地时间
  //更新末尾寄存器

  //热拔出 可以通过 io自动闭环，通过返回包缩短识别
  //热插入 必须带回寄存器信息，重新初始化，多发尾数据将被抛弃

  //初始化应该下发 64*8 byte数据 对应 length = 512为slv0 504为slv1 ...


  val isInit = RegInit(false.B)
  val isLastInit = Reg(Bool())
  val slvID = Reg(UInt(7.W))
  val slvNum = Reg(UInt(7.W))
  val slvRTC = Reg(UInt(64.W))

  isLastDevice := isLastInit | io.isLast

  val isLegalInitDownHead = 
    downOldHead.operator === 0.U & 
     downOldHead.length(2,0) === "b000".U

  val isDownUpdate = RegInit(false.B)
  val isUpUpdate   = RegInit(false.B)

  val isLastDownStreamEnd: Bool
  val isUpStreamEnd: Bool
  val upOldHead: Header_Info_Bundle
  val isUpNewHeadCreated: Bool


  when( (isDownNewHeadCreated | isLastDownStreamEnd) & isLegalInitDownHead ){
    slvID := 64.U - (downOldHead.length >> 3)
    isDownUpdate := true.B
  } .elsewhen( isUpStreamEnd ){
    isDownUpdate := false.B
  }

  when( (isDownNewHeadCreated | isLastDownStreamEnd) & isLegalInitDownHead ){
    slvRTC := (64.U - (downOldHead.length >> 3)) << 5 // * 32
  } .otherwise{
    slvRTC := slvRTC + 1.U
  }

  when( isLastDownStreamEnd & isLegalInitDownHead ){
    isLastInit := true.B
  } .elsewhen( isDownNewHeadCreated & isLegalInitDownHead ){
    isLastInit := false.B
  }

  val isLegalInitUpHead = 
    upOldHead.operator === 0.U & 
    upOldHead.length(2,0) === "b000".U

  when( isUpNewHeadCreated ){
    when( isLastDownStreamEnd ){
      slvNum := 65.U - (downOldHead.length >> 3)
      isUpUpdate := true.B
    } .elsewhen(isLegalInitUpHead){
      slvNum := (slvID + (upOldHead.length >> 3)) + 1.U
      isUpUpdate := true.B
    }
  } .elsewhen( isUpStreamEnd ){
    isUpUpdate := false.B
  }

  when( isUpStreamEnd ){
    isInit := ~isDownStreamError & ~isUpStreamError & isDownUpdate & isUpUpdate
  }

  val upRegMuxInit = isLegalInitUpHead
  when( upRegMuxInit ){
    upReg(0) := slvRTC(7,0)
    upReg(1) := slvRTC(15,8)
    upReg(2) := slvRTC(23,16)
    upReg(3) := slvRTC(31,24)
    upReg(4) := slvRTC(39,32)
    upReg(5) := slvRTC(47,40)
    upReg(6) := slvRTC(55,48)
    upReg(7) := slvRTC(63,56)
  }



}


trait ShinSlvLinkBCast{ this: ShinSlvLinkBase =>

}

trait ShinSlvLinkUCast{ this: ShinSlvLinkBase =>

}

class ShinSlvBase extends ShinSlvLinkBase
with ShinSlvLinkInit
with ShinSlvLinkBCast
with ShinSlvLinkUCast{
  assert( VecInit(upRegMuxInit).count((x:Bool) => (x === true.B)) <= 1.U, "Assert Failed, upReg Collision Used!\n" )


  val led = IO(UInt(8.W))
  led := slvID
}