xref: /XiangShan/src/main/scala/xiangshan/frontend/PreDecode.scala (revision aeedc8ee24c606b62f87b4a2382c7af1cca1fcd7)
109c6f1ddSLingrui98/***************************************************************************************
209c6f1ddSLingrui98* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
309c6f1ddSLingrui98* Copyright (c) 2020-2021 Peng Cheng Laboratory
409c6f1ddSLingrui98*
509c6f1ddSLingrui98* XiangShan is licensed under Mulan PSL v2.
609c6f1ddSLingrui98* You can use this software according to the terms and conditions of the Mulan PSL v2.
709c6f1ddSLingrui98* You may obtain a copy of Mulan PSL v2 at:
809c6f1ddSLingrui98*          http://license.coscl.org.cn/MulanPSL2
909c6f1ddSLingrui98*
1009c6f1ddSLingrui98* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
1109c6f1ddSLingrui98* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
1209c6f1ddSLingrui98* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
1309c6f1ddSLingrui98*
1409c6f1ddSLingrui98* See the Mulan PSL v2 for more details.
1509c6f1ddSLingrui98***************************************************************************************/
1609c6f1ddSLingrui98
1709c6f1ddSLingrui98package xiangshan.frontend
1809c6f1ddSLingrui98
198891a219SYinan Xuimport org.chipsalliance.cde.config.Parameters
2009c6f1ddSLingrui98import freechips.rocketchip.rocket.{RVCDecoder, ExpandedInstruction}
2109c6f1ddSLingrui98import chisel3.{util, _}
2209c6f1ddSLingrui98import chisel3.util._
2309c6f1ddSLingrui98import utils._
243c02ee8fSwakafaimport utility._
2509c6f1ddSLingrui98import xiangshan._
261d8f4dcbSJayimport xiangshan.frontend.icache._
2709c6f1ddSLingrui98import xiangshan.backend.decode.isa.predecode.PreDecodeInst
287e0f64b0SGuanghui Chengimport xiangshan.backend.fu.NewCSR.TriggerUtil
29330aad7fSGuokai Chenimport java.lang.reflect.Parameter
30f7af4c74Schengguanghuiimport xiangshan.backend.fu.util.SdtrigExt
3109c6f1ddSLingrui98
3209c6f1ddSLingrui98trait HasPdConst extends HasXSParameter with HasICacheParameters with HasIFUConst{
3309c6f1ddSLingrui98  def isRVC(inst: UInt) = (inst(1,0) =/= 3.U)
3409c6f1ddSLingrui98  def isLink(reg:UInt) = reg === 1.U || reg === 5.U
3509c6f1ddSLingrui98  def brInfo(instr: UInt) = {
3609c6f1ddSLingrui98    val brType::Nil = ListLookup(instr, List(BrType.notCFI), PreDecodeInst.brTable)
3709c6f1ddSLingrui98    val rd = Mux(isRVC(instr), instr(12), instr(11,7))
3809c6f1ddSLingrui98    val rs = Mux(isRVC(instr), Mux(brType === BrType.jal, 0.U, instr(11, 7)), instr(19, 15))
3909c6f1ddSLingrui98    val isCall = (brType === BrType.jal && !isRVC(instr) || brType === BrType.jalr) && isLink(rd) // Only for RV64
4009c6f1ddSLingrui98    val isRet = brType === BrType.jalr && isLink(rs) && !isCall
4109c6f1ddSLingrui98    List(brType, isCall, isRet)
4209c6f1ddSLingrui98  }
4309c6f1ddSLingrui98  def jal_offset(inst: UInt, rvc: Bool): UInt = {
4409c6f1ddSLingrui98    val rvc_offset = Cat(inst(12), inst(8), inst(10, 9), inst(6), inst(7), inst(2), inst(11), inst(5, 3), 0.U(1.W))
4509c6f1ddSLingrui98    val rvi_offset = Cat(inst(31), inst(19, 12), inst(20), inst(30, 21), 0.U(1.W))
4609c6f1ddSLingrui98    val max_width = rvi_offset.getWidth
4709c6f1ddSLingrui98    SignExt(Mux(rvc, SignExt(rvc_offset, max_width), SignExt(rvi_offset, max_width)), XLEN)
4809c6f1ddSLingrui98  }
4909c6f1ddSLingrui98  def br_offset(inst: UInt, rvc: Bool): UInt = {
5009c6f1ddSLingrui98    val rvc_offset = Cat(inst(12), inst(6, 5), inst(2), inst(11, 10), inst(4, 3), 0.U(1.W))
5109c6f1ddSLingrui98    val rvi_offset = Cat(inst(31), inst(7), inst(30, 25), inst(11, 8), 0.U(1.W))
5209c6f1ddSLingrui98    val max_width = rvi_offset.getWidth
5309c6f1ddSLingrui98    SignExt(Mux(rvc, SignExt(rvc_offset, max_width), SignExt(rvi_offset, max_width)), XLEN)
5409c6f1ddSLingrui98  }
5509c6f1ddSLingrui98
5609c6f1ddSLingrui98  def NOP = "h4501".U(16.W)
5709c6f1ddSLingrui98}
5809c6f1ddSLingrui98
5909c6f1ddSLingrui98object BrType {
6009c6f1ddSLingrui98  def notCFI   = "b00".U
6109c6f1ddSLingrui98  def branch  = "b01".U
6209c6f1ddSLingrui98  def jal     = "b10".U
6309c6f1ddSLingrui98  def jalr    = "b11".U
6409c6f1ddSLingrui98  def apply() = UInt(2.W)
6509c6f1ddSLingrui98}
6609c6f1ddSLingrui98
6709c6f1ddSLingrui98object ExcType {  //TODO:add exctype
6809c6f1ddSLingrui98  def notExc = "b000".U
6909c6f1ddSLingrui98  def apply() = UInt(3.W)
7009c6f1ddSLingrui98}
7109c6f1ddSLingrui98
7209c6f1ddSLingrui98class PreDecodeInfo extends Bundle {  // 8 bit
7309c6f1ddSLingrui98  val valid   = Bool()
7409c6f1ddSLingrui98  val isRVC   = Bool()
7509c6f1ddSLingrui98  val brType  = UInt(2.W)
7609c6f1ddSLingrui98  val isCall  = Bool()
7709c6f1ddSLingrui98  val isRet   = Bool()
7809c6f1ddSLingrui98  //val excType = UInt(3.W)
7909c6f1ddSLingrui98  def isBr    = brType === BrType.branch
8009c6f1ddSLingrui98  def isJal   = brType === BrType.jal
8109c6f1ddSLingrui98  def isJalr  = brType === BrType.jalr
8209c6f1ddSLingrui98  def notCFI  = brType === BrType.notCFI
8309c6f1ddSLingrui98}
8409c6f1ddSLingrui98
8509c6f1ddSLingrui98class PreDecodeResp(implicit p: Parameters) extends XSBundle with HasPdConst {
86a4e57ea3SLi Qianruo  val pd = Vec(PredictWidth, new PreDecodeInfo)
87a4e57ea3SLi Qianruo  val hasHalfValid = Vec(PredictWidth, Bool())
8848a62719SJenius  //val expInstr = Vec(PredictWidth, UInt(32.W))
8948a62719SJenius  val instr      = Vec(PredictWidth, UInt(32.W))
90a4e57ea3SLi Qianruo  val jumpOffset = Vec(PredictWidth, UInt(XLEN.W))
91a4e57ea3SLi Qianruo//  val hasLastHalf = Bool()
927e0f64b0SGuanghui Cheng  val triggered    = Vec(PredictWidth, TriggerAction())
9309c6f1ddSLingrui98}
9409c6f1ddSLingrui98
9509c6f1ddSLingrui98class PreDecode(implicit p: Parameters) extends XSModule with HasPdConst{
9609c6f1ddSLingrui98  val io = IO(new Bundle() {
979afa8a47STang Haojin    val in = Input(ValidIO(new IfuToPreDecode))
9809c6f1ddSLingrui98    val out = Output(new PreDecodeResp)
9909c6f1ddSLingrui98  })
10009c6f1ddSLingrui98
1019afa8a47STang Haojin  val data          = io.in.bits.data
102a4e57ea3SLi Qianruo//  val lastHalfMatch = io.in.lastHalfMatch
103a4e57ea3SLi Qianruo  val validStart, validEnd = Wire(Vec(PredictWidth, Bool()))
104a4e57ea3SLi Qianruo  val h_validStart, h_validEnd = Wire(Vec(PredictWidth, Bool()))
10509c6f1ddSLingrui98
106330aad7fSGuokai Chen  val validStart_half, validEnd_half = Wire(Vec(PredictWidth, Bool()))
107330aad7fSGuokai Chen  val h_validStart_half, h_validEnd_half = Wire(Vec(PredictWidth, Bool()))
108330aad7fSGuokai Chen
109330aad7fSGuokai Chen  val validStart_halfPlus1, validEnd_halfPlus1 = Wire(Vec(PredictWidth, Bool()))
110330aad7fSGuokai Chen  val h_validStart_halfPlus1, h_validEnd_halfPlus1 = Wire(Vec(PredictWidth, Bool()))
111330aad7fSGuokai Chen
112330aad7fSGuokai Chen  val validStart_diff, validEnd_diff = Wire(Vec(PredictWidth, Bool()))
113330aad7fSGuokai Chen  val h_validStart_diff, h_validEnd_diff = Wire(Vec(PredictWidth, Bool()))
114330aad7fSGuokai Chen
115330aad7fSGuokai Chen  val currentIsRVC = Wire(Vec(PredictWidth, Bool()))
116330aad7fSGuokai Chen
117330aad7fSGuokai Chen  validStart_half.map(_ := false.B)
118330aad7fSGuokai Chen  validEnd_half.map(_ := false.B)
119330aad7fSGuokai Chen  h_validStart_half.map(_ := false.B)
120330aad7fSGuokai Chen  h_validEnd_half.map(_ := false.B)
121330aad7fSGuokai Chen
122330aad7fSGuokai Chen  validStart_halfPlus1.map(_ := false.B)
123330aad7fSGuokai Chen  validEnd_halfPlus1.map(_ := false.B)
124330aad7fSGuokai Chen  h_validStart_halfPlus1.map(_ := false.B)
125330aad7fSGuokai Chen  h_validEnd_halfPlus1.map(_ := false.B)
126330aad7fSGuokai Chen
12709c6f1ddSLingrui98  val rawInsts = if (HasCExtension) VecInit((0 until PredictWidth).map(i => Cat(data(i+1), data(i))))
12809c6f1ddSLingrui98  else         VecInit((0 until PredictWidth).map(i => data(i)))
12909c6f1ddSLingrui98
13009c6f1ddSLingrui98  for (i <- 0 until PredictWidth) {
131a4e57ea3SLi Qianruo    val inst           = WireInit(rawInsts(i))
13248a62719SJenius    //val expander       = Module(new RVCExpander)
133330aad7fSGuokai Chen    currentIsRVC(i)   := isRVC(inst)
1349afa8a47STang Haojin    val currentPC      = io.in.bits.pc(i)
13548a62719SJenius    //expander.io.in             := inst
13609c6f1ddSLingrui98
13709c6f1ddSLingrui98    val brType::isCall::isRet::Nil = brInfo(inst)
138330aad7fSGuokai Chen    val jalOffset = jal_offset(inst, currentIsRVC(i))
139330aad7fSGuokai Chen    val brOffset  = br_offset(inst, currentIsRVC(i))
140a4e57ea3SLi Qianruo
141a4e57ea3SLi Qianruo    io.out.hasHalfValid(i)        := h_validStart(i)
142a4e57ea3SLi Qianruo
143a4e57ea3SLi Qianruo    io.out.triggered(i)   := DontCare//VecInit(Seq.fill(10)(false.B))
144a4e57ea3SLi Qianruo
145a4e57ea3SLi Qianruo
146a4e57ea3SLi Qianruo    io.out.pd(i).valid         := validStart(i)
147330aad7fSGuokai Chen    io.out.pd(i).isRVC         := currentIsRVC(i)
148330aad7fSGuokai Chen
149330aad7fSGuokai Chen    // for diff purpose only
15009c6f1ddSLingrui98    io.out.pd(i).brType        := brType
15109c6f1ddSLingrui98    io.out.pd(i).isCall        := isCall
15209c6f1ddSLingrui98    io.out.pd(i).isRet         := isRet
153ddb65c47SLi Qianruo
15448a62719SJenius    //io.out.expInstr(i)         := expander.io.out.bits
15548a62719SJenius    io.out.instr(i)              :=inst
156a4e57ea3SLi Qianruo    io.out.jumpOffset(i)       := Mux(io.out.pd(i).isBr, brOffset, jalOffset)
15709c6f1ddSLingrui98  }
15809c6f1ddSLingrui98
159330aad7fSGuokai Chen  // the first half is always reliable
160330aad7fSGuokai Chen  for (i <- 0 until PredictWidth / 2) {
161330aad7fSGuokai Chen    val lastIsValidEnd =   if (i == 0) { true.B } else { validEnd(i-1) || !HasCExtension.B }
162330aad7fSGuokai Chen    validStart(i)   := (lastIsValidEnd || !HasCExtension.B)
163330aad7fSGuokai Chen    validEnd(i)     := validStart(i) && currentIsRVC(i) || !validStart(i) || !HasCExtension.B
164330aad7fSGuokai Chen
165330aad7fSGuokai Chen    //prepared for last half match
166330aad7fSGuokai Chen    val h_lastIsValidEnd = if (i == 0) { false.B } else { h_validEnd(i-1) || !HasCExtension.B }
167330aad7fSGuokai Chen    h_validStart(i)   := (h_lastIsValidEnd || !HasCExtension.B)
168330aad7fSGuokai Chen    h_validEnd(i)     := h_validStart(i) && currentIsRVC(i) || !h_validStart(i) || !HasCExtension.B
169330aad7fSGuokai Chen  }
170330aad7fSGuokai Chen
171330aad7fSGuokai Chen  for (i <- 0 until PredictWidth) {
172330aad7fSGuokai Chen    val lastIsValidEnd =   if (i == 0) { true.B } else { validEnd_diff(i-1) || !HasCExtension.B }
173330aad7fSGuokai Chen    validStart_diff(i)   := (lastIsValidEnd || !HasCExtension.B)
174330aad7fSGuokai Chen    validEnd_diff(i)     := validStart_diff(i) && currentIsRVC(i) || !validStart_diff(i) || !HasCExtension.B
175330aad7fSGuokai Chen
176330aad7fSGuokai Chen    //prepared for last half match
177330aad7fSGuokai Chen    val h_lastIsValidEnd = if (i == 0) { false.B } else { h_validEnd_diff(i-1) || !HasCExtension.B }
178330aad7fSGuokai Chen    h_validStart_diff(i)   := (h_lastIsValidEnd || !HasCExtension.B)
179330aad7fSGuokai Chen    h_validEnd_diff(i)     := h_validStart_diff(i) && currentIsRVC(i) || !h_validStart_diff(i) || !HasCExtension.B
180330aad7fSGuokai Chen  }
181330aad7fSGuokai Chen
182330aad7fSGuokai Chen  // assume PredictWidth / 2 is a valid start
183330aad7fSGuokai Chen  for (i <- PredictWidth / 2 until PredictWidth) {
184330aad7fSGuokai Chen    val lastIsValidEnd =   if (i == PredictWidth / 2) { true.B } else { validEnd_half(i-1) || !HasCExtension.B }
185330aad7fSGuokai Chen    validStart_half(i)   := (lastIsValidEnd || !HasCExtension.B)
186330aad7fSGuokai Chen    validEnd_half(i)     := validStart_half(i) && currentIsRVC(i) || !validStart_half(i) || !HasCExtension.B
187330aad7fSGuokai Chen
188330aad7fSGuokai Chen    //prepared for last half match
189330aad7fSGuokai Chen    val h_lastIsValidEnd = if (i == PredictWidth / 2) { true.B } else { h_validEnd_half(i-1) || !HasCExtension.B }
190330aad7fSGuokai Chen    h_validStart_half(i)   := (h_lastIsValidEnd || !HasCExtension.B)
191330aad7fSGuokai Chen    h_validEnd_half(i)     := h_validStart_half(i) && currentIsRVC(i) || !h_validStart_half(i) || !HasCExtension.B
192330aad7fSGuokai Chen  }
193330aad7fSGuokai Chen
194330aad7fSGuokai Chen  // assume PredictWidth / 2 + 1 is a valid start (and PredictWidth / 2 is last half of RVI)
195330aad7fSGuokai Chen  for (i <- PredictWidth / 2 + 1 until PredictWidth) {
196330aad7fSGuokai Chen    val lastIsValidEnd =   if (i == PredictWidth / 2 + 1) { true.B } else { validEnd_halfPlus1(i-1) || !HasCExtension.B }
197330aad7fSGuokai Chen    validStart_halfPlus1(i)   := (lastIsValidEnd || !HasCExtension.B)
198330aad7fSGuokai Chen    validEnd_halfPlus1(i)     := validStart_halfPlus1(i) && currentIsRVC(i) || !validStart_halfPlus1(i) || !HasCExtension.B
199330aad7fSGuokai Chen
200330aad7fSGuokai Chen    //prepared for last half match
201330aad7fSGuokai Chen    val h_lastIsValidEnd = if (i == PredictWidth / 2 + 1) { true.B } else { h_validEnd_halfPlus1(i-1) || !HasCExtension.B }
202330aad7fSGuokai Chen    h_validStart_halfPlus1(i)   := (h_lastIsValidEnd || !HasCExtension.B)
203330aad7fSGuokai Chen    h_validEnd_halfPlus1(i)     := h_validStart_halfPlus1(i) && currentIsRVC(i) || !h_validStart_halfPlus1(i) || !HasCExtension.B
204330aad7fSGuokai Chen  }
205330aad7fSGuokai Chen  validStart_halfPlus1(PredictWidth / 2) := false.B // could be true but when true we select half, not halfPlus1
206330aad7fSGuokai Chen  validEnd_halfPlus1(PredictWidth / 2) := true.B
207330aad7fSGuokai Chen
208330aad7fSGuokai Chen  // assume h_PredictWidth / 2 is an end
209330aad7fSGuokai Chen  h_validStart_halfPlus1(PredictWidth / 2) := false.B // could be true but when true we select half, not halfPlus1
210330aad7fSGuokai Chen  h_validEnd_halfPlus1(PredictWidth / 2) := true.B
211330aad7fSGuokai Chen
212330aad7fSGuokai Chen  // if PredictWidth / 2 - 1 is a valid end, PredictWidth / 2 is a valid start
213330aad7fSGuokai Chen  for (i <- PredictWidth / 2 until PredictWidth) {
214330aad7fSGuokai Chen    validStart(i) := Mux(validEnd(PredictWidth / 2 - 1), validStart_half(i), validStart_halfPlus1(i))
215330aad7fSGuokai Chen    validEnd(i) := Mux(validEnd(PredictWidth / 2 - 1), validEnd_half(i), validEnd_halfPlus1(i))
216330aad7fSGuokai Chen    h_validStart(i) := Mux(h_validEnd(PredictWidth / 2 - 1), h_validStart_half(i), h_validStart_halfPlus1(i))
217330aad7fSGuokai Chen    h_validEnd(i) := Mux(h_validEnd(PredictWidth / 2 - 1), h_validEnd_half(i), h_validEnd_halfPlus1(i))
218330aad7fSGuokai Chen  }
219330aad7fSGuokai Chen
220330aad7fSGuokai Chen  val validStartMismatch = Wire(Bool())
221330aad7fSGuokai Chen  val validEndMismatch = Wire(Bool())
222330aad7fSGuokai Chen  val validH_ValidStartMismatch = Wire(Bool())
223330aad7fSGuokai Chen  val validH_ValidEndMismatch = Wire(Bool())
224330aad7fSGuokai Chen
225330aad7fSGuokai Chen  validStartMismatch := validStart.zip(validStart_diff).map{case(a,b) => a =/= b}.reduce(_||_)
226330aad7fSGuokai Chen  validEndMismatch := validEnd.zip(validEnd_diff).map{case(a,b) => a =/= b}.reduce(_||_)
227330aad7fSGuokai Chen  validH_ValidStartMismatch := h_validStart.zip(h_validStart_diff).map{case(a,b) => a =/= b}.reduce(_||_)
228330aad7fSGuokai Chen  validH_ValidEndMismatch := h_validEnd.zip(h_validEnd_diff).map{case(a,b) => a =/= b}.reduce(_||_)
229330aad7fSGuokai Chen
2309afa8a47STang Haojin  XSError(io.in.valid && validStartMismatch, p"validStart mismatch\n")
2319afa8a47STang Haojin  XSError(io.in.valid && validEndMismatch, p"validEnd mismatch\n")
2329afa8a47STang Haojin  XSError(io.in.valid && validH_ValidStartMismatch, p"h_validStart mismatch\n")
2339afa8a47STang Haojin  XSError(io.in.valid && validH_ValidEndMismatch, p"h_validEnd mismatch\n")
234330aad7fSGuokai Chen
235a4e57ea3SLi Qianruo//  io.out.hasLastHalf := !io.out.pd(PredictWidth - 1).isRVC && io.out.pd(PredictWidth - 1).valid
23609c6f1ddSLingrui98
23709c6f1ddSLingrui98  for (i <- 0 until PredictWidth) {
23809c6f1ddSLingrui98    XSDebug(true.B,
23948a62719SJenius      p"instr ${Hexadecimal(io.out.instr(i))}, " +
24009c6f1ddSLingrui98        p"validStart ${Binary(validStart(i))}, " +
24109c6f1ddSLingrui98        p"validEnd ${Binary(validEnd(i))}, " +
24209c6f1ddSLingrui98        p"isRVC ${Binary(io.out.pd(i).isRVC)}, " +
24309c6f1ddSLingrui98        p"brType ${Binary(io.out.pd(i).brType)}, " +
24409c6f1ddSLingrui98        p"isRet ${Binary(io.out.pd(i).isRet)}, " +
24509c6f1ddSLingrui98        p"isCall ${Binary(io.out.pd(i).isCall)}\n"
24609c6f1ddSLingrui98    )
24709c6f1ddSLingrui98  }
24809c6f1ddSLingrui98}
24909c6f1ddSLingrui98
250330aad7fSGuokai Chenclass IfuToF3PreDecode(implicit p: Parameters) extends XSBundle with HasPdConst {
251330aad7fSGuokai Chen  val instr      = Vec(PredictWidth, UInt(32.W))
252330aad7fSGuokai Chen}
253330aad7fSGuokai Chen
254330aad7fSGuokai Chenclass F3PreDecodeResp(implicit p: Parameters) extends XSBundle with HasPdConst {
255330aad7fSGuokai Chen  val pd = Vec(PredictWidth, new PreDecodeInfo)
256330aad7fSGuokai Chen}
257330aad7fSGuokai Chenclass F3Predecoder(implicit p: Parameters) extends XSModule with HasPdConst {
258330aad7fSGuokai Chen  val io = IO(new Bundle() {
259330aad7fSGuokai Chen    val in = Input(new IfuToF3PreDecode)
260330aad7fSGuokai Chen    val out = Output(new F3PreDecodeResp)
261330aad7fSGuokai Chen  })
262330aad7fSGuokai Chen  io.out.pd.zipWithIndex.map{ case (pd,i) =>
263330aad7fSGuokai Chen    pd.valid := DontCare
264330aad7fSGuokai Chen    pd.isRVC := DontCare
265330aad7fSGuokai Chen    pd.brType := brInfo(io.in.instr(i))(0)
266330aad7fSGuokai Chen    pd.isCall := brInfo(io.in.instr(i))(1)
267330aad7fSGuokai Chen    pd.isRet := brInfo(io.in.instr(i))(2)
268330aad7fSGuokai Chen  }
269330aad7fSGuokai Chen
270330aad7fSGuokai Chen}
271330aad7fSGuokai Chen
27209c6f1ddSLingrui98class RVCExpander(implicit p: Parameters) extends XSModule {
27309c6f1ddSLingrui98  val io = IO(new Bundle {
27409c6f1ddSLingrui98    val in = Input(UInt(32.W))
27509c6f1ddSLingrui98    val out = Output(new ExpandedInstruction)
276*aeedc8eeSGuokai Chen    val ill = Output(Bool())
27709c6f1ddSLingrui98  })
27809c6f1ddSLingrui98
279*aeedc8eeSGuokai Chen  val decoder = new RVCDecoder(io.in, XLEN, fLen, useAddiForMv = true)
280*aeedc8eeSGuokai Chen
28109c6f1ddSLingrui98  if (HasCExtension) {
282*aeedc8eeSGuokai Chen    io.out := decoder.decode
283*aeedc8eeSGuokai Chen    io.ill := decoder.ill
28409c6f1ddSLingrui98  } else {
285*aeedc8eeSGuokai Chen    io.out := decoder.passthrough
286*aeedc8eeSGuokai Chen    io.ill := false.B
28709c6f1ddSLingrui98  }
28809c6f1ddSLingrui98}
289a4e57ea3SLi Qianruo
290a4e57ea3SLi Qianruo/* ---------------------------------------------------------------------
291a4e57ea3SLi Qianruo * Predict result check
292a4e57ea3SLi Qianruo *
293a4e57ea3SLi Qianruo * ---------------------------------------------------------------------
294a4e57ea3SLi Qianruo */
295a4e57ea3SLi Qianruo
296a4e57ea3SLi Qianruoobject FaultType {
297a4e57ea3SLi Qianruo  def noFault         = "b000".U
298a4e57ea3SLi Qianruo  def jalFault        = "b001".U    //not CFI taken or invalid instruction taken
299a4e57ea3SLi Qianruo  def retFault        = "b010".U    //not CFI taken or invalid instruction taken
300a4e57ea3SLi Qianruo  def targetFault     = "b011".U
3015b3c20f7SJinYue  def notCFIFault    = "b100".U    //not CFI taken or invalid instruction taken
3025b3c20f7SJinYue  def invalidTaken    = "b101".U
303a4e57ea3SLi Qianruo  def apply() = UInt(3.W)
304a4e57ea3SLi Qianruo}
305a4e57ea3SLi Qianruo
306a4e57ea3SLi Qianruoclass CheckInfo extends Bundle {  // 8 bit
307a4e57ea3SLi Qianruo  val value  = UInt(3.W)
308a4e57ea3SLi Qianruo  def isjalFault      = value === FaultType.jalFault
309a4e57ea3SLi Qianruo  def isRetFault      = value === FaultType.retFault
310a4e57ea3SLi Qianruo  def istargetFault   = value === FaultType.targetFault
3115b3c20f7SJinYue  def invalidTakenFault    = value === FaultType.invalidTaken
3125b3c20f7SJinYue  def notCFIFault          = value === FaultType.notCFIFault
313a4e57ea3SLi Qianruo}
314a4e57ea3SLi Qianruo
315a4e57ea3SLi Qianruoclass PredCheckerResp(implicit p: Parameters) extends XSBundle with HasPdConst {
3165995c9e7SJenius  //to Ibuffer write port  (stage 1)
3175995c9e7SJenius  val stage1Out = new Bundle{
318a4e57ea3SLi Qianruo    val fixedRange  = Vec(PredictWidth, Bool())
319a4e57ea3SLi Qianruo    val fixedTaken  = Vec(PredictWidth, Bool())
3205995c9e7SJenius  }
3215995c9e7SJenius  //to Ftq write back port (stage 2)
3225995c9e7SJenius  val stage2Out = new Bundle{
323a4e57ea3SLi Qianruo    val fixedTarget = Vec(PredictWidth, UInt(VAddrBits.W))
324d10ddd67SGuokai Chen    val jalTarget = Vec(PredictWidth, UInt(VAddrBits.W))
325a4e57ea3SLi Qianruo    val fixedMissPred = Vec(PredictWidth,  Bool())
326a4e57ea3SLi Qianruo    val faultType   = Vec(PredictWidth, new CheckInfo)
327a4e57ea3SLi Qianruo  }
3285995c9e7SJenius}
329a4e57ea3SLi Qianruo
330a4e57ea3SLi Qianruo
331a4e57ea3SLi Qianruoclass PredChecker(implicit p: Parameters) extends XSModule with HasPdConst {
332a4e57ea3SLi Qianruo  val io = IO( new Bundle{
333a4e57ea3SLi Qianruo    val in = Input(new IfuToPredChecker)
334a4e57ea3SLi Qianruo    val out = Output(new PredCheckerResp)
335a4e57ea3SLi Qianruo  })
336a4e57ea3SLi Qianruo
337a4e57ea3SLi Qianruo  val (takenIdx, predTaken)     = (io.in.ftqOffset.bits, io.in.ftqOffset.valid)
338a4e57ea3SLi Qianruo  val predTarget                = (io.in.target)
339a4e57ea3SLi Qianruo  val (instrRange, instrValid)  = (io.in.instrRange, io.in.instrValid)
340a4e57ea3SLi Qianruo  val (pds, pc, jumpOffset)     = (io.in.pds, io.in.pc, io.in.jumpOffset)
341a4e57ea3SLi Qianruo
342a4e57ea3SLi Qianruo  val jalFaultVec, retFaultVec, targetFault, notCFITaken, invalidTaken = Wire(Vec(PredictWidth, Bool()))
343a4e57ea3SLi Qianruo
344a4e57ea3SLi Qianruo  /** remask fault may appear together with other faults, but other faults are exclusive
345a4e57ea3SLi Qianruo    * so other f ault mast use fixed mask to keep only one fault would be found and redirect to Ftq
346a4e57ea3SLi Qianruo    * we first detecct remask fault and then use fixedRange to do second check
347a4e57ea3SLi Qianruo    **/
348a4e57ea3SLi Qianruo
3495995c9e7SJenius  //Stage 1: detect remask fault
350a4e57ea3SLi Qianruo  /** first check: remask Fault */
351a4e57ea3SLi Qianruo  jalFaultVec         := VecInit(pds.zipWithIndex.map{case(pd, i) => pd.isJal && instrRange(i) && instrValid(i) && (takenIdx > i.U && predTaken || !predTaken) })
352a4e57ea3SLi Qianruo  retFaultVec         := VecInit(pds.zipWithIndex.map{case(pd, i) => pd.isRet && instrRange(i) && instrValid(i) && (takenIdx > i.U && predTaken || !predTaken) })
353a4e57ea3SLi Qianruo  val remaskFault      = VecInit((0 until PredictWidth).map(i => jalFaultVec(i) || retFaultVec(i)))
354a4e57ea3SLi Qianruo  val remaskIdx        = ParallelPriorityEncoder(remaskFault.asUInt)
355a4e57ea3SLi Qianruo  val needRemask       = ParallelOR(remaskFault)
356a4e57ea3SLi Qianruo  val fixedRange       = instrRange.asUInt & (Fill(PredictWidth, !needRemask) | Fill(PredictWidth, 1.U(1.W)) >> ~remaskIdx)
357a4e57ea3SLi Qianruo
3585995c9e7SJenius  io.out.stage1Out.fixedRange := fixedRange.asTypeOf((Vec(PredictWidth, Bool())))
359a4e57ea3SLi Qianruo
3605995c9e7SJenius  io.out.stage1Out.fixedTaken := VecInit(pds.zipWithIndex.map{case(pd, i) => instrValid (i) && fixedRange(i) && (pd.isRet || pd.isJal || takenIdx === i.U && predTaken && !pd.notCFI)  })
361a4e57ea3SLi Qianruo
362a4e57ea3SLi Qianruo  /** second check: faulse prediction fault and target fault */
363a4e57ea3SLi Qianruo  notCFITaken  := VecInit(pds.zipWithIndex.map{case(pd, i) => fixedRange(i) && instrValid(i) && i.U === takenIdx && pd.notCFI && predTaken })
364a4e57ea3SLi Qianruo  invalidTaken := VecInit(pds.zipWithIndex.map{case(pd, i) => fixedRange(i) && !instrValid(i)  && i.U === takenIdx  && predTaken })
365a4e57ea3SLi Qianruo
366a483ee06SGuokai Chen  val jumpTargets          = VecInit(pds.zipWithIndex.map{case(pd,i) => (pc(i) + jumpOffset(i)).asTypeOf(UInt(VAddrBits.W))})
367a4e57ea3SLi Qianruo  val seqTargets = VecInit((0 until PredictWidth).map(i => pc(i) + Mux(pds(i).isRVC || !instrValid(i), 2.U, 4.U ) ))
368a4e57ea3SLi Qianruo
3695995c9e7SJenius  //Stage 2: detect target fault
3705995c9e7SJenius  /** target calculation: in the next stage  */
3710c70648eSEaston Man  val fixedRangeNext = RegEnable(fixedRange, io.in.fire_in)
3720c70648eSEaston Man  val instrValidNext = RegEnable(instrValid, io.in.fire_in)
3730c70648eSEaston Man  val takenIdxNext   = RegEnable(takenIdx, io.in.fire_in)
3740c70648eSEaston Man  val predTakenNext  = RegEnable(predTaken, io.in.fire_in)
3750c70648eSEaston Man  val predTargetNext = RegEnable(predTarget, io.in.fire_in)
3760c70648eSEaston Man  val jumpTargetsNext = RegEnable(jumpTargets, io.in.fire_in)
3770c70648eSEaston Man  val seqTargetsNext = RegEnable(seqTargets, io.in.fire_in)
3780c70648eSEaston Man  val pdsNext = RegEnable(pds, io.in.fire_in)
3790c70648eSEaston Man  val jalFaultVecNext = RegEnable(jalFaultVec, io.in.fire_in)
3800c70648eSEaston Man  val retFaultVecNext = RegEnable(retFaultVec, io.in.fire_in)
3810c70648eSEaston Man  val notCFITakenNext = RegEnable(notCFITaken, io.in.fire_in)
3820c70648eSEaston Man  val invalidTakenNext = RegEnable(invalidTaken, io.in.fire_in)
383a4e57ea3SLi Qianruo
3845995c9e7SJenius  targetFault      := VecInit(pdsNext.zipWithIndex.map{case(pd,i) => fixedRangeNext(i) && instrValidNext(i) && (pd.isJal || pd.isBr) && takenIdxNext === i.U && predTakenNext  && (predTargetNext =/= jumpTargetsNext(i))})
3855995c9e7SJenius
3865995c9e7SJenius
3870c70648eSEaston Man  io.out.stage2Out.faultType.zipWithIndex.foreach{case(faultType, i) => faultType.value := Mux(jalFaultVecNext(i) , FaultType.jalFault ,
3885995c9e7SJenius                                                                             Mux(retFaultVecNext(i), FaultType.retFault ,
3895995c9e7SJenius                                                                             Mux(targetFault(i), FaultType.targetFault ,
3905995c9e7SJenius                                                                             Mux(notCFITakenNext(i) , FaultType.notCFIFault,
3915995c9e7SJenius                                                                             Mux(invalidTakenNext(i), FaultType.invalidTaken,  FaultType.noFault)))))}
3925995c9e7SJenius
3930c70648eSEaston Man  io.out.stage2Out.fixedMissPred.zipWithIndex.foreach{case(missPred, i ) => missPred := jalFaultVecNext(i) || retFaultVecNext(i) || notCFITakenNext(i) || invalidTakenNext(i) || targetFault(i)}
3940c70648eSEaston Man  io.out.stage2Out.fixedTarget.zipWithIndex.foreach{case(target, i) => target := Mux(jalFaultVecNext(i) || targetFault(i), jumpTargetsNext(i),  seqTargetsNext(i) )}
3950c70648eSEaston Man  io.out.stage2Out.jalTarget.zipWithIndex.foreach{case(target, i) => target := jumpTargetsNext(i) }
396a4e57ea3SLi Qianruo
397a4e57ea3SLi Qianruo}
398a4e57ea3SLi Qianruo
399f7af4c74Schengguanghuiclass FrontendTrigger(implicit p: Parameters) extends XSModule with SdtrigExt {
400a4e57ea3SLi Qianruo  val io = IO(new Bundle(){
401a4e57ea3SLi Qianruo    val frontendTrigger = Input(new FrontendTdataDistributeIO)
4027e0f64b0SGuanghui Cheng    val triggered     = Output(Vec(PredictWidth, TriggerAction()))
403a4e57ea3SLi Qianruo
404a4e57ea3SLi Qianruo    val pds           = Input(Vec(PredictWidth, new PreDecodeInfo))
405a4e57ea3SLi Qianruo    val pc            = Input(Vec(PredictWidth, UInt(VAddrBits.W)))
406a4e57ea3SLi Qianruo    val data          = if(HasCExtension) Input(Vec(PredictWidth + 1, UInt(16.W)))
407a4e57ea3SLi Qianruo                        else Input(Vec(PredictWidth, UInt(32.W)))
408a4e57ea3SLi Qianruo  })
409a4e57ea3SLi Qianruo
410a4e57ea3SLi Qianruo  val data          = io.data
411a4e57ea3SLi Qianruo
412a4e57ea3SLi Qianruo  val rawInsts = if (HasCExtension) VecInit((0 until PredictWidth).map(i => Cat(data(i+1), data(i))))
413a4e57ea3SLi Qianruo  else         VecInit((0 until PredictWidth).map(i => data(i)))
414a4e57ea3SLi Qianruo
4157e0f64b0SGuanghui Cheng  val tdataVec = RegInit(VecInit(Seq.fill(TriggerNum)(0.U.asTypeOf(new MatchTriggerIO))))
416f7af4c74Schengguanghui  when(io.frontendTrigger.tUpdate.valid) {
4177e0f64b0SGuanghui Cheng    tdataVec(io.frontendTrigger.tUpdate.bits.addr) := io.frontendTrigger.tUpdate.bits.tdata
418a4e57ea3SLi Qianruo  }
419f7af4c74Schengguanghui  val triggerEnableVec = RegInit(VecInit(Seq.fill(TriggerNum)(false.B))) // From CSR, controlled by priv mode, etc.
420f7af4c74Schengguanghui  triggerEnableVec := io.frontendTrigger.tEnableVec
421f7af4c74Schengguanghui  XSDebug(triggerEnableVec.asUInt.orR, "Debug Mode: At least one frontend trigger is enabled\n")
422a4e57ea3SLi Qianruo
4237e0f64b0SGuanghui Cheng  val triggerTimingVec = VecInit(tdataVec.map(_.timing))
4247e0f64b0SGuanghui Cheng  val triggerChainVec = VecInit(tdataVec.map(_.chain))
425f7af4c74Schengguanghui
4267e0f64b0SGuanghui Cheng  for (i <- 0 until TriggerNum) { PrintTriggerInfo(triggerEnableVec(i), tdataVec(i)) }
427a4e57ea3SLi Qianruo
4287e0f64b0SGuanghui Cheng  val debugMode = io.frontendTrigger.debugMode
4297e0f64b0SGuanghui Cheng  val triggerCanRaiseBpExp = io.frontendTrigger.triggerCanRaiseBpExp
43047e7896cSchengguanghui  //val triggerHitVec = Wire(Vec(PredictWidth, Vec(TriggerNum, Bool())))
43147e7896cSchengguanghui  val triggerHitVec = (0 until TriggerNum).map(j =>
4327e0f64b0SGuanghui Cheng      TriggerCmpConsecutive(io.pc, tdataVec(j).tdata2, tdataVec(j).matchType, triggerEnableVec(j)).map(
4337e0f64b0SGuanghui Cheng        hit => hit && !tdataVec(j).select && !debugMode)
43447e7896cSchengguanghui  ).transpose
43547e7896cSchengguanghui
436a4e57ea3SLi Qianruo  for (i <- 0 until PredictWidth) {
437f7af4c74Schengguanghui    val triggerCanFireVec = Wire(Vec(TriggerNum, Bool()))
43847e7896cSchengguanghui    TriggerCheckCanFire(TriggerNum, triggerCanFireVec, VecInit(triggerHitVec(i)), triggerTimingVec, triggerChainVec)
4397e0f64b0SGuanghui Cheng
4407e0f64b0SGuanghui Cheng    val actionVec = VecInit(tdataVec.map(_.action))
4417e0f64b0SGuanghui Cheng    val triggerAction = Wire(TriggerAction())
4427e0f64b0SGuanghui Cheng    TriggerUtil.triggerActionGen(triggerAction, triggerCanFireVec, actionVec, triggerCanRaiseBpExp)
4437e0f64b0SGuanghui Cheng
4447e0f64b0SGuanghui Cheng    // Priority may select last when no trigger fire.
4457e0f64b0SGuanghui Cheng    io.triggered(i) := triggerAction
4467e0f64b0SGuanghui Cheng    XSDebug(triggerCanFireVec.asUInt.orR, p"Debug Mode: Predecode Inst No. ${i} has trigger action vec ${triggerCanFireVec.asUInt.orR}\n")
447a4e57ea3SLi Qianruo  }
448a4e57ea3SLi Qianruo}
449