xref: /XiangShan/src/main/scala/xiangshan/backend/fu/Fence.scala (revision 14219479ccefc0a257c1be4c95fde0bba47f72d3)
1/***************************************************************************************
2* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
3* Copyright (c) 2020-2021 Peng Cheng Laboratory
4*
5* XiangShan is licensed under Mulan PSL v2.
6* You can use this software according to the terms and conditions of the Mulan PSL v2.
7* You may obtain a copy of Mulan PSL v2 at:
8*          http://license.coscl.org.cn/MulanPSL2
9*
10* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
11* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
12* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
13*
14* See the Mulan PSL v2 for more details.
15***************************************************************************************/
16
17package xiangshan.backend.fu
18
19import chisel3._
20import chisel3.util._
21import org.chipsalliance.cde.config.Parameters
22import utility.XSDebug
23import xiangshan.ExceptionNO.{illegalInstr, virtualInstr}
24import xiangshan._
25
26class FenceIO(implicit p: Parameters) extends XSBundle {
27  val sfence = Output(new SfenceBundle)
28  val fencei = Output(Bool())
29  val sbuffer = new FenceToSbuffer
30  val disableSfence = Input(Bool())
31  val disableHfenceg = Input(Bool())
32  val disableHfencev = Input(Bool())
33}
34
35class FenceToSbuffer extends Bundle {
36  val flushSb = Output(Bool())
37  val sbIsEmpty = Input(Bool())
38}
39
40class Fence(cfg: FuConfig)(implicit p: Parameters) extends FuncUnit(cfg) {
41
42  val sfence = io.fenceio.get.sfence
43  val fencei = io.fenceio.get.fencei
44  val toSbuffer = io.fenceio.get.sbuffer
45  val disableSfence = io.fenceio.get.disableSfence
46  val disableHfenceg = io.fenceio.get.disableHfenceg
47  val disableHfencev = io.fenceio.get.disableHfencev
48  val (valid, src1) = (
49    io.in.valid,
50    io.in.bits.data.src(0)
51  )
52
53  val s_idle :: s_wait :: s_tlb :: s_icache :: s_fence :: s_nofence :: Nil = Enum(6)
54
55  val state = RegInit(s_idle)
56  /* fsm
57   * s_idle    : init state, send sbflush
58   * s_wait  : send sbflush, wait for sbEmpty
59   * s_tlb   : flush tlb, just hold one cycle
60   * s_icache: flush icache, just hold one cycle
61   * s_fence : do nothing, for timing optimiaztion
62   * s_nofence: do nothing , for Svinval extension
63   */
64
65  val sbuffer = toSbuffer.flushSb
66  val sbEmpty = toSbuffer.sbIsEmpty
67  val uop = RegEnable(io.in.bits, io.in.fire)
68  val func = uop.ctrl.fuOpType
69
70  // NOTE: icache & tlb & sbuffer must receive flush signal at any time
71  sbuffer      := state === s_wait && !(func === FenceOpType.sfence && disableSfence)
72  fencei       := state === s_icache
73  sfence.valid := state === s_tlb && ((!disableSfence && func === FenceOpType.sfence) || (!disableHfencev && func === FenceOpType.hfence_v) || (!disableHfenceg && func === FenceOpType.hfence_g))
74  sfence.bits.rs1  := uop.data.imm(4, 0) === 0.U
75  sfence.bits.rs2  := uop.data.imm(9, 5) === 0.U
76  sfence.bits.flushPipe := uop.ctrl.flushPipe.get
77  sfence.bits.hv := !disableHfencev && func === FenceOpType.hfence_v
78  sfence.bits.hg := !disableHfenceg && func === FenceOpType.hfence_g
79  sfence.bits.addr := RegEnable(io.in.bits.data.src(0), io.in.fire)
80  sfence.bits.id   := RegEnable(io.in.bits.data.src(1), io.in.fire)
81
82  when (state === s_idle && io.in.valid) { state := s_wait }
83  when (state === s_wait && func === FenceOpType.fencei && sbEmpty) { state := s_icache }
84  when (state === s_wait && ((func === FenceOpType.sfence && (sbEmpty || disableSfence))
85    || (func === FenceOpType.hfence_g && (sbEmpty || disableHfenceg))
86    || (func === FenceOpType.hfence_v && (sbEmpty || disableHfencev)))) { state := s_tlb }
87  when (state === s_wait && func === FenceOpType.fence  && sbEmpty) { state := s_fence }
88  when (state === s_wait && func === FenceOpType.nofence  && sbEmpty) { state := s_nofence }
89  when (state =/= s_idle && state =/= s_wait) { state := s_idle }
90
91  io.in.ready := state === s_idle
92  io.out.valid := state =/= s_idle && state =/= s_wait
93  io.out.bits.res.data := 0.U
94  io.out.bits.ctrl.robIdx := uop.ctrl.robIdx
95  io.out.bits.res.pc.get := uop.data.pc.get
96  io.out.bits.ctrl.pdest := uop.ctrl.pdest
97  io.out.bits.ctrl.flushPipe.get := uop.ctrl.flushPipe.get
98  io.out.bits.ctrl.exceptionVec.get := 0.U.asTypeOf(io.out.bits.ctrl.exceptionVec.get)
99  io.out.bits.perfDebugInfo := io.in.bits.perfDebugInfo
100
101  XSDebug(io.in.valid, p"In(${io.in.valid} ${io.in.ready}) state:${state} Inpc:0x${Hexadecimal(io.in.bits.data.pc.get)} InrobIdx:${io.in.bits.ctrl.robIdx}\n")
102  XSDebug(state =/= s_idle, p"state:${state} sbuffer(flush:${sbuffer} empty:${sbEmpty}) fencei:${fencei} sfence:${sfence}\n")
103  XSDebug(io.out.valid, p" Out(${io.out.valid} ${io.out.ready}) state:${state} Outpc:0x${Hexadecimal(io.out.bits.res.pc.get)} OutrobIdx:${io.out.bits.ctrl.robIdx}\n")
104
105  assert(!io.out.valid || io.out.ready, "when fence is out valid, out ready should always be true")
106}
107