xref: /XiangShan/src/main/scala/xiangshan/package.scala (revision 870f462d572cd0ef6bf86c91dcda5a5fab6e99d3)
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
17import chisel3._
18import chisel3.util._
19import xiangshan.ExceptionNO._
20import xiangshan.backend.fu._
21import xiangshan.backend.fu.fpu._
22import xiangshan.backend.fu.vector._
23import xiangshan.backend.issue._
24import xiangshan.backend.fu.FuConfig
25
26package object xiangshan {
27  object SrcType {
28    def imm = "b000".U
29    def pc  = "b000".U
30    def xp  = "b001".U
31    def fp  = "b010".U
32    def vp  = "b100".U
33
34    // alias
35    def reg = this.xp
36    def DC  = imm // Don't Care
37    def X   = BitPat("b000")
38
39    def isPc(srcType: UInt) = srcType===pc
40    def isImm(srcType: UInt) = srcType===imm
41    def isReg(srcType: UInt) = srcType(0)
42    def isXp(srcType: UInt) = srcType(0)
43    def isFp(srcType: UInt) = srcType(1)
44    def isVp(srcType: UInt) = srcType(2)
45    def isPcOrImm(srcType: UInt) = isPc(srcType) || isImm(srcType)
46    def isNotReg(srcType: UInt): Bool = !srcType.orR
47    def isVfp(srcType: UInt) = isVp(srcType) || isFp(srcType)
48    def apply() = UInt(3.W)
49  }
50
51  object SrcState {
52    def busy    = "b0".U
53    def rdy     = "b1".U
54    // def specRdy = "b10".U // speculative ready, for future use
55    def apply() = UInt(1.W)
56
57    def isReady(state: UInt): Bool = state === this.rdy
58    def isBusy(state: UInt): Bool = state === this.busy
59  }
60
61  def FuOpTypeWidth = 9
62  object FuOpType {
63    def apply() = UInt(FuOpTypeWidth.W)
64    def X = BitPat("b00000000")
65  }
66
67  object VlduType {
68    def dummy = 0.U
69  }
70
71  object VstuType {
72    def dummy = 0.U
73  }
74
75  object CommitType {
76    def NORMAL = "b000".U  // int/fp
77    def BRANCH = "b001".U  // branch
78    def LOAD   = "b010".U  // load
79    def STORE  = "b011".U  // store
80
81    def apply() = UInt(3.W)
82    def isFused(commitType: UInt): Bool = commitType(2)
83    def isLoadStore(commitType: UInt): Bool = !isFused(commitType) && commitType(1)
84    def lsInstIsStore(commitType: UInt): Bool = commitType(0)
85    def isStore(commitType: UInt): Bool = isLoadStore(commitType) && lsInstIsStore(commitType)
86    def isBranch(commitType: UInt): Bool = commitType(0) && !commitType(1) && !isFused(commitType)
87  }
88
89  object RedirectLevel {
90    def flushAfter = "b0".U
91    def flush      = "b1".U
92
93    def apply() = UInt(1.W)
94    // def isUnconditional(level: UInt) = level(1)
95    def flushItself(level: UInt) = level(0)
96    // def isException(level: UInt) = level(1) && level(0)
97  }
98
99  object ExceptionVec {
100    val ExceptionVecSize = 16
101    def apply() = Vec(ExceptionVecSize, Bool())
102  }
103
104  object PMAMode {
105    def R = "b1".U << 0 //readable
106    def W = "b1".U << 1 //writeable
107    def X = "b1".U << 2 //executable
108    def I = "b1".U << 3 //cacheable: icache
109    def D = "b1".U << 4 //cacheable: dcache
110    def S = "b1".U << 5 //enable speculative access
111    def A = "b1".U << 6 //enable atomic operation, A imply R & W
112    def C = "b1".U << 7 //if it is cacheable is configable
113    def Reserved = "b0".U
114
115    def apply() = UInt(7.W)
116
117    def read(mode: UInt) = mode(0)
118    def write(mode: UInt) = mode(1)
119    def execute(mode: UInt) = mode(2)
120    def icache(mode: UInt) = mode(3)
121    def dcache(mode: UInt) = mode(4)
122    def speculate(mode: UInt) = mode(5)
123    def atomic(mode: UInt) = mode(6)
124    def configable_cache(mode: UInt) = mode(7)
125
126    def strToMode(s: String) = {
127      var result = 0.U(8.W)
128      if (s.toUpperCase.indexOf("R") >= 0) result = result + R
129      if (s.toUpperCase.indexOf("W") >= 0) result = result + W
130      if (s.toUpperCase.indexOf("X") >= 0) result = result + X
131      if (s.toUpperCase.indexOf("I") >= 0) result = result + I
132      if (s.toUpperCase.indexOf("D") >= 0) result = result + D
133      if (s.toUpperCase.indexOf("S") >= 0) result = result + S
134      if (s.toUpperCase.indexOf("A") >= 0) result = result + A
135      if (s.toUpperCase.indexOf("C") >= 0) result = result + C
136      result
137    }
138  }
139
140
141  object CSROpType {
142    def jmp  = "b000".U
143    def wrt  = "b001".U
144    def set  = "b010".U
145    def clr  = "b011".U
146    def wfi  = "b100".U
147    def wrti = "b101".U
148    def seti = "b110".U
149    def clri = "b111".U
150    def needAccess(op: UInt): Bool = op(1, 0) =/= 0.U
151  }
152
153  // jump
154  object JumpOpType {
155    def jal  = "b00".U
156    def jalr = "b01".U
157    def auipc = "b10".U
158//    def call = "b11_011".U
159//    def ret  = "b11_100".U
160    def jumpOpisJalr(op: UInt) = op(0)
161    def jumpOpisAuipc(op: UInt) = op(1)
162  }
163
164  object FenceOpType {
165    def fence  = "b10000".U
166    def sfence = "b10001".U
167    def fencei = "b10010".U
168    def nofence= "b00000".U
169  }
170
171  object ALUOpType {
172    // shift optype
173    def slliuw     = "b000_0000".U // slliuw: ZEXT(src1[31:0]) << shamt
174    def sll        = "b000_0001".U // sll:     src1 << src2
175
176    def bclr       = "b000_0010".U // bclr:    src1 & ~(1 << src2[5:0])
177    def bset       = "b000_0011".U // bset:    src1 | (1 << src2[5:0])
178    def binv       = "b000_0100".U // binv:    src1 ^ ~(1 << src2[5:0])
179
180    def srl        = "b000_0101".U // srl:     src1 >> src2
181    def bext       = "b000_0110".U // bext:    (src1 >> src2)[0]
182    def sra        = "b000_0111".U // sra:     src1 >> src2 (arithmetic)
183
184    def rol        = "b000_1001".U // rol:     (src1 << src2) | (src1 >> (xlen - src2))
185    def ror        = "b000_1011".U // ror:     (src1 >> src2) | (src1 << (xlen - src2))
186
187    // RV64 32bit optype
188    def addw       = "b001_0000".U // addw:      SEXT((src1 + src2)[31:0])
189    def oddaddw    = "b001_0001".U // oddaddw:   SEXT((src1[0] + src2)[31:0])
190    def subw       = "b001_0010".U // subw:      SEXT((src1 - src2)[31:0])
191
192    def addwbit    = "b001_0100".U // addwbit:   (src1 + src2)[0]
193    def addwbyte   = "b001_0101".U // addwbyte:  (src1 + src2)[7:0]
194    def addwzexth  = "b001_0110".U // addwzexth: ZEXT((src1  + src2)[15:0])
195    def addwsexth  = "b001_0111".U // addwsexth: SEXT((src1  + src2)[15:0])
196
197    def sllw       = "b001_1000".U // sllw:     SEXT((src1 << src2)[31:0])
198    def srlw       = "b001_1001".U // srlw:     SEXT((src1[31:0] >> src2)[31:0])
199    def sraw       = "b001_1010".U // sraw:     SEXT((src1[31:0] >> src2)[31:0])
200    def rolw       = "b001_1100".U
201    def rorw       = "b001_1101".U
202
203    // ADD-op
204    def adduw      = "b010_0000".U // adduw:  src1[31:0]  + src2
205    def add        = "b010_0001".U // add:     src1        + src2
206    def oddadd     = "b010_0010".U // oddadd:  src1[0]     + src2
207
208    def sr29add    = "b010_0100".U // sr29add: src1[63:29] + src2
209    def sr30add    = "b010_0101".U // sr30add: src1[63:30] + src2
210    def sr31add    = "b010_0110".U // sr31add: src1[63:31] + src2
211    def sr32add    = "b010_0111".U // sr32add: src1[63:32] + src2
212
213    def sh1adduw   = "b010_1000".U // sh1adduw: {src1[31:0], 1'b0} + src2
214    def sh1add     = "b010_1001".U // sh1add: {src1[62:0], 1'b0} + src2
215    def sh2adduw   = "b010_1010".U // sh2add_uw: {src1[31:0], 2'b0} + src2
216    def sh2add     = "b010_1011".U // sh2add: {src1[61:0], 2'b0} + src2
217    def sh3adduw   = "b010_1100".U // sh3add_uw: {src1[31:0], 3'b0} + src2
218    def sh3add     = "b010_1101".U // sh3add: {src1[60:0], 3'b0} + src2
219    def sh4add     = "b010_1111".U // sh4add: {src1[59:0], 4'b0} + src2
220
221    // SUB-op: src1 - src2
222    def sub        = "b011_0000".U
223    def sltu       = "b011_0001".U
224    def slt        = "b011_0010".U
225    def maxu       = "b011_0100".U
226    def minu       = "b011_0101".U
227    def max        = "b011_0110".U
228    def min        = "b011_0111".U
229
230    // branch
231    def beq        = "b111_0000".U
232    def bne        = "b111_0010".U
233    def blt        = "b111_1000".U
234    def bge        = "b111_1010".U
235    def bltu       = "b111_1100".U
236    def bgeu       = "b111_1110".U
237
238    // misc optype
239    def and        = "b100_0000".U
240    def andn       = "b100_0001".U
241    def or         = "b100_0010".U
242    def orn        = "b100_0011".U
243    def xor        = "b100_0100".U
244    def xnor       = "b100_0101".U
245    def orcb       = "b100_0110".U
246
247    def sextb      = "b100_1000".U
248    def packh      = "b100_1001".U
249    def sexth      = "b100_1010".U
250    def packw      = "b100_1011".U
251
252    def revb       = "b101_0000".U
253    def rev8       = "b101_0001".U
254    def pack       = "b101_0010".U
255    def orh48      = "b101_0011".U
256
257    def szewl1     = "b101_1000".U
258    def szewl2     = "b101_1001".U
259    def szewl3     = "b101_1010".U
260    def byte2      = "b101_1011".U
261
262    def andlsb     = "b110_0000".U
263    def andzexth   = "b110_0001".U
264    def orlsb      = "b110_0010".U
265    def orzexth    = "b110_0011".U
266    def xorlsb     = "b110_0100".U
267    def xorzexth   = "b110_0101".U
268    def orcblsb    = "b110_0110".U
269    def orcbzexth  = "b110_0111".U
270
271    def isAddw(func: UInt) = func(6, 4) === "b001".U && !func(3) && !func(1)
272    def isSimpleLogic(func: UInt) = func(6, 4) === "b100".U && !func(0)
273    def logicToLsb(func: UInt) = Cat("b110".U(3.W), func(3, 1), 0.U(1.W))
274    def logicToZexth(func: UInt) = Cat("b110".U(3.W), func(3, 1), 1.U(1.W))
275
276    def apply() = UInt(FuOpTypeWidth.W)
277  }
278
279  object VSETOpType {
280    val setVlmaxBit = 0
281    val keepVlBit   = 1
282    // destTypeBit == 0: write vl to rd
283    // destTypeBit == 1: write vconfig
284    val destTypeBit = 5
285
286    // vsetvli's uop
287    //   rs1!=x0, normal
288    //     uop0: r(rs1), w(vconfig)     | x[rs1],vtypei  -> vconfig
289    //     uop1: r(rs1), w(rd)          | x[rs1],vtypei  -> x[rd]
290    def uvsetvcfg_xi        = "b1010_0000".U
291    def uvsetrd_xi          = "b1000_0000".U
292    //   rs1==x0, rd!=x0, set vl to vlmax, set rd to vlmax, set vtype
293    //     uop0: w(vconfig)             | vlmax, vtypei  -> vconfig
294    //     uop1: w(rd)                  | vlmax, vtypei  -> x[rd]
295    def uvsetvcfg_vlmax_i   = "b1010_0001".U
296    def uvsetrd_vlmax_i     = "b1000_0001".U
297    //   rs1==x0, rd==x0, keep vl, set vtype
298    //     uop0: r(vconfig), w(vconfig) | ld_vconfig.vl, vtypei -> vconfig
299    def uvsetvcfg_keep_v    = "b1010_0010".U
300
301    // vsetvl's uop
302    //   rs1!=x0, normal
303    //     uop0: r(rs1,rs2), w(vconfig) | x[rs1],x[rs2]  -> vconfig
304    //     uop1: r(rs1,rs2), w(rd)      | x[rs1],x[rs2]  -> x[rd]
305    def uvsetvcfg_xx        = "b0110_0000".U
306    def uvsetrd_xx          = "b0100_0000".U
307    //   rs1==x0, rd!=x0, set vl to vlmax, set rd to vlmax, set vtype
308    //     uop0: r(rs2), w(vconfig)     | vlmax, vtypei  -> vconfig
309    //     uop1: r(rs2), w(rd)          | vlmax, vtypei  -> x[rd]
310    def uvsetvcfg_vlmax_x   = "b0110_0001".U
311    def uvsetrd_vlmax_x     = "b0100_0001".U
312    //   rs1==x0, rd==x0, keep vl, set vtype
313    //     uop0: r(rs2), w(vtmp)             | x[rs2]               -> vtmp
314    //     uop0: r(vconfig,vtmp), w(vconfig) | old_vconfig.vl, vtmp -> vconfig
315    def uvmv_v_x            = "b0110_0010".U
316    def uvsetvcfg_vv        = "b0111_0010".U
317
318    // vsetivli's uop
319    //     uop0: w(vconfig)             | vli, vtypei    -> vconfig
320    //     uop1: w(rd)                  | vli, vtypei    -> x[rd]
321    def uvsetvcfg_ii        = "b0010_0000".U
322    def uvsetrd_ii          = "b0000_0000".U
323
324    def isVsetvl  (func: UInt)  = func(6)
325    def isVsetvli (func: UInt)  = func(7)
326    def isVsetivli(func: UInt)  = func(7, 6) === 0.U
327    def isNormal  (func: UInt)  = func(1, 0) === 0.U
328    def isSetVlmax(func: UInt)  = func(setVlmaxBit)
329    def isKeepVl  (func: UInt)  = func(keepVlBit)
330    // RG: region
331    def writeIntRG(func: UInt)  = !func(5)
332    def writeVecRG(func: UInt)  = func(5)
333    def readIntRG (func: UInt)  = !func(4)
334    def readVecRG (func: UInt)  = func(4)
335    // modify fuOpType
336    def switchDest(func: UInt)  = func ^ (1 << destTypeBit).U
337    def keepVl(func: UInt)      = func | (1 << keepVlBit).U
338    def setVlmax(func: UInt)    = func | (1 << setVlmaxBit).U
339  }
340
341  object BRUOpType {
342    // branch
343    def beq        = "b000_000".U
344    def bne        = "b000_001".U
345    def blt        = "b000_100".U
346    def bge        = "b000_101".U
347    def bltu       = "b001_000".U
348    def bgeu       = "b001_001".U
349
350    def getBranchType(func: UInt) = func(3, 1)
351    def isBranchInvert(func: UInt) = func(0)
352  }
353
354  object MULOpType {
355    // mul
356    // bit encoding: | type (2bit) | isWord(1bit) | opcode(2bit) |
357    def mul    = "b00000".U
358    def mulh   = "b00001".U
359    def mulhsu = "b00010".U
360    def mulhu  = "b00011".U
361    def mulw   = "b00100".U
362
363    def mulw7  = "b01100".U
364    def isSign(op: UInt) = !op(1)
365    def isW(op: UInt) = op(2)
366    def isH(op: UInt) = op(1, 0) =/= 0.U
367    def getOp(op: UInt) = Cat(op(3), op(1, 0))
368  }
369
370  object DIVOpType {
371    // div
372    // bit encoding: | type (2bit) | isWord(1bit) | isSign(1bit) | opcode(1bit) |
373    def div    = "b10000".U
374    def divu   = "b10010".U
375    def rem    = "b10001".U
376    def remu   = "b10011".U
377
378    def divw   = "b10100".U
379    def divuw  = "b10110".U
380    def remw   = "b10101".U
381    def remuw  = "b10111".U
382
383    def isSign(op: UInt) = !op(1)
384    def isW(op: UInt) = op(2)
385    def isH(op: UInt) = op(0)
386  }
387
388  object MDUOpType {
389    // mul
390    // bit encoding: | type (2bit) | isWord(1bit) | opcode(2bit) |
391    def mul    = "b00000".U
392    def mulh   = "b00001".U
393    def mulhsu = "b00010".U
394    def mulhu  = "b00011".U
395    def mulw   = "b00100".U
396
397    def mulw7  = "b01100".U
398
399    // div
400    // bit encoding: | type (2bit) | isWord(1bit) | isSign(1bit) | opcode(1bit) |
401    def div    = "b10000".U
402    def divu   = "b10010".U
403    def rem    = "b10001".U
404    def remu   = "b10011".U
405
406    def divw   = "b10100".U
407    def divuw  = "b10110".U
408    def remw   = "b10101".U
409    def remuw  = "b10111".U
410
411    def isMul(op: UInt) = !op(4)
412    def isDiv(op: UInt) = op(4)
413
414    def isDivSign(op: UInt) = isDiv(op) && !op(1)
415    def isW(op: UInt) = op(2)
416    def isH(op: UInt) = (isDiv(op) && op(0)) || (isMul(op) && op(1, 0) =/= 0.U)
417    def getMulOp(op: UInt) = op(1, 0)
418  }
419
420  object LSUOpType {
421    // load pipeline
422
423    // normal load
424    // Note: bit(1, 0) are size, DO NOT CHANGE
425    // bit encoding: | load 0 | is unsigned(1bit) | size(2bit) |
426    def lb       = "b0000".U
427    def lh       = "b0001".U
428    def lw       = "b0010".U
429    def ld       = "b0011".U
430    def lbu      = "b0100".U
431    def lhu      = "b0101".U
432    def lwu      = "b0110".U
433
434    // Zicbop software prefetch
435    // bit encoding: | prefetch 1 | 0 | prefetch type (2bit) |
436    def prefetch_i = "b1000".U // TODO
437    def prefetch_r = "b1001".U
438    def prefetch_w = "b1010".U
439
440    def isPrefetch(op: UInt): Bool = op(3)
441
442    // store pipeline
443    // normal store
444    // bit encoding: | store 00 | size(2bit) |
445    def sb       = "b0000".U
446    def sh       = "b0001".U
447    def sw       = "b0010".U
448    def sd       = "b0011".U
449
450    // l1 cache op
451    // bit encoding: | cbo_zero 01 | size(2bit) 11 |
452    def cbo_zero  = "b0111".U
453
454    // llc op
455    // bit encoding: | prefetch 11 | suboptype(2bit) |
456    def cbo_clean = "b1100".U
457    def cbo_flush = "b1101".U
458    def cbo_inval = "b1110".U
459
460    def isCbo(op: UInt): Bool = op(3, 2) === "b11".U
461
462    // atomics
463    // bit(1, 0) are size
464    // since atomics use a different fu type
465    // so we can safely reuse other load/store's encodings
466    // bit encoding: | optype(4bit) | size (2bit) |
467    def lr_w      = "b000010".U
468    def sc_w      = "b000110".U
469    def amoswap_w = "b001010".U
470    def amoadd_w  = "b001110".U
471    def amoxor_w  = "b010010".U
472    def amoand_w  = "b010110".U
473    def amoor_w   = "b011010".U
474    def amomin_w  = "b011110".U
475    def amomax_w  = "b100010".U
476    def amominu_w = "b100110".U
477    def amomaxu_w = "b101010".U
478
479    def lr_d      = "b000011".U
480    def sc_d      = "b000111".U
481    def amoswap_d = "b001011".U
482    def amoadd_d  = "b001111".U
483    def amoxor_d  = "b010011".U
484    def amoand_d  = "b010111".U
485    def amoor_d   = "b011011".U
486    def amomin_d  = "b011111".U
487    def amomax_d  = "b100011".U
488    def amominu_d = "b100111".U
489    def amomaxu_d = "b101011".U
490
491    def size(op: UInt) = op(1,0)
492  }
493
494  object BKUOpType {
495
496    def clmul       = "b000000".U
497    def clmulh      = "b000001".U
498    def clmulr      = "b000010".U
499    def xpermn      = "b000100".U
500    def xpermb      = "b000101".U
501
502    def clz         = "b001000".U
503    def clzw        = "b001001".U
504    def ctz         = "b001010".U
505    def ctzw        = "b001011".U
506    def cpop        = "b001100".U
507    def cpopw       = "b001101".U
508
509    // 01xxxx is reserve
510    def aes64es     = "b100000".U
511    def aes64esm    = "b100001".U
512    def aes64ds     = "b100010".U
513    def aes64dsm    = "b100011".U
514    def aes64im     = "b100100".U
515    def aes64ks1i   = "b100101".U
516    def aes64ks2    = "b100110".U
517
518    // merge to two instruction sm4ks & sm4ed
519    def sm4ed0      = "b101000".U
520    def sm4ed1      = "b101001".U
521    def sm4ed2      = "b101010".U
522    def sm4ed3      = "b101011".U
523    def sm4ks0      = "b101100".U
524    def sm4ks1      = "b101101".U
525    def sm4ks2      = "b101110".U
526    def sm4ks3      = "b101111".U
527
528    def sha256sum0  = "b110000".U
529    def sha256sum1  = "b110001".U
530    def sha256sig0  = "b110010".U
531    def sha256sig1  = "b110011".U
532    def sha512sum0  = "b110100".U
533    def sha512sum1  = "b110101".U
534    def sha512sig0  = "b110110".U
535    def sha512sig1  = "b110111".U
536
537    def sm3p0       = "b111000".U
538    def sm3p1       = "b111001".U
539  }
540
541  object BTBtype {
542    def B = "b00".U  // branch
543    def J = "b01".U  // jump
544    def I = "b10".U  // indirect
545    def R = "b11".U  // return
546
547    def apply() = UInt(2.W)
548  }
549
550  object SelImm {
551    def IMM_X  = "b0111".U
552    def IMM_S  = "b1110".U
553    def IMM_SB = "b0001".U
554    def IMM_U  = "b0010".U
555    def IMM_UJ = "b0011".U
556    def IMM_I  = "b0100".U
557    def IMM_Z  = "b0101".U
558    def INVALID_INSTR = "b0110".U
559    def IMM_B6 = "b1000".U
560
561    def IMM_OPIVIS = "b1001".U
562    def IMM_OPIVIU = "b1010".U
563    def IMM_VSETVLI   = "b1100".U
564    def IMM_VSETIVLI  = "b1101".U
565
566    def X      = BitPat("b0000")
567
568    def apply() = UInt(4.W)
569
570    def mkString(immType: UInt) : String = {
571      val strMap = Map(
572        IMM_S.litValue         -> "S",
573        IMM_SB.litValue        -> "SB",
574        IMM_U.litValue         -> "U",
575        IMM_UJ.litValue        -> "UJ",
576        IMM_I.litValue         -> "I",
577        IMM_Z.litValue         -> "Z",
578        IMM_B6.litValue        -> "B6",
579        IMM_OPIVIS.litValue    -> "VIS",
580        IMM_OPIVIU.litValue    -> "VIU",
581        IMM_VSETVLI.litValue   -> "VSETVLI",
582        IMM_VSETIVLI.litValue  -> "VSETIVLI",
583        INVALID_INSTR.litValue -> "INVALID",
584      )
585      strMap(immType.litValue)
586    }
587  }
588
589  object UopSplitType {
590    def SCA_SIM          = "b000000".U //
591    def DIR              = "b010001".U // dirty: vset
592    def VEC_VVV          = "b010010".U // VEC_VVV
593    def VEC_VXV          = "b010011".U // VEC_VXV
594    def VEC_0XV          = "b010100".U // VEC_0XV
595    def VEC_VVW          = "b010101".U // VEC_VVW
596    def VEC_WVW          = "b010110".U // VEC_WVW
597    def VEC_VXW          = "b010111".U // VEC_VXW
598    def VEC_WXW          = "b011000".U // VEC_WXW
599    def VEC_WVV          = "b011001".U // VEC_WVV
600    def VEC_WXV          = "b011010".U // VEC_WXV
601    def VEC_EXT2         = "b011011".U // VF2 0 -> V
602    def VEC_EXT4         = "b011100".U // VF4 0 -> V
603    def VEC_EXT8         = "b011101".U // VF8 0 -> V
604    def VEC_VVM          = "b011110".U // VEC_VVM
605    def VEC_VXM          = "b011111".U // VEC_VXM
606    def VEC_SLIDE1UP     = "b100000".U // vslide1up.vx
607    def VEC_FSLIDE1UP    = "b100001".U // vfslide1up.vf
608    def VEC_SLIDE1DOWN   = "b100010".U // vslide1down.vx
609    def VEC_FSLIDE1DOWN  = "b100011".U // vfslide1down.vf
610    def VEC_VRED         = "b100100".U // VEC_VRED
611    def VEC_SLIDEUP      = "b100101".U // VEC_SLIDEUP
612    def VEC_ISLIDEUP     = "b100110".U // VEC_ISLIDEUP
613    def VEC_SLIDEDOWN    = "b100111".U // VEC_SLIDEDOWN
614    def VEC_ISLIDEDOWN   = "b101000".U // VEC_ISLIDEDOWN
615    def VEC_M0X          = "b101001".U // VEC_M0X  0MV
616    def VEC_MVV          = "b101010".U // VEC_MVV  VMV
617    def VEC_M0X_VFIRST   = "b101011".U //
618    def VEC_VWW          = "b101100".U //
619    def VEC_RGATHER      = "b101101".U // vrgather.vv, vrgather.vi
620    def VEC_RGATHER_VX   = "b101110".U // vrgather.vx
621    def VEC_RGATHEREI16  = "b101111".U // vrgatherei16.vv
622    def VEC_COMPRESS     = "b110000".U // vcompress.vm
623    def VEC_US_LD        = "b110001".U // vector unit strided load
624    def VEC_VFV          = "b111000".U // VEC_VFV
625    def VEC_VFW          = "b111001".U // VEC_VFW
626    def VEC_WFW          = "b111010".U // VEC_WVW
627    def VEC_VFM          = "b111011".U // VEC_VFM
628    def VEC_M0M          = "b000000".U // VEC_M0M
629    def VEC_MMM          = "b000000".U // VEC_MMM
630    def dummy     = "b111111".U
631
632    def X = BitPat("b000000")
633
634    def apply() = UInt(6.W)
635    def needSplit(UopSplitType: UInt) = UopSplitType(4) || UopSplitType(5)
636  }
637
638  object ExceptionNO {
639    def instrAddrMisaligned = 0
640    def instrAccessFault    = 1
641    def illegalInstr        = 2
642    def breakPoint          = 3
643    def loadAddrMisaligned  = 4
644    def loadAccessFault     = 5
645    def storeAddrMisaligned = 6
646    def storeAccessFault    = 7
647    def ecallU              = 8
648    def ecallS              = 9
649    def ecallM              = 11
650    def instrPageFault      = 12
651    def loadPageFault       = 13
652    // def singleStep          = 14
653    def storePageFault      = 15
654    def priorities = Seq(
655      breakPoint, // TODO: different BP has different priority
656      instrPageFault,
657      instrAccessFault,
658      illegalInstr,
659      instrAddrMisaligned,
660      ecallM, ecallS, ecallU,
661      storeAddrMisaligned,
662      loadAddrMisaligned,
663      storePageFault,
664      loadPageFault,
665      storeAccessFault,
666      loadAccessFault
667    )
668    def all = priorities.distinct.sorted
669    def frontendSet = Seq(
670      instrAddrMisaligned,
671      instrAccessFault,
672      illegalInstr,
673      instrPageFault
674    )
675    def partialSelect(vec: Vec[Bool], select: Seq[Int]): Vec[Bool] = {
676      val new_vec = Wire(ExceptionVec())
677      new_vec.foreach(_ := false.B)
678      select.foreach(i => new_vec(i) := vec(i))
679      new_vec
680    }
681    def selectFrontend(vec: Vec[Bool]): Vec[Bool] = partialSelect(vec, frontendSet)
682    def selectAll(vec: Vec[Bool]): Vec[Bool] = partialSelect(vec, ExceptionNO.all)
683    def selectByFu(vec:Vec[Bool], fuConfig: FuConfig): Vec[Bool] =
684      partialSelect(vec, fuConfig.exceptionOut)
685  }
686
687  // indicates where the memory access request comes from
688  // a dupliacte of this is in HuanCun.common and CoupledL2.common
689  // TODO: consider moving it to Utility, so that they could share the same definition
690  object MemReqSource extends Enumeration {
691    val NoWhere = Value("NoWhere")
692
693    val CPUInst = Value("CPUInst")
694    val CPULoadData = Value("CPULoadData")
695    val CPUStoreData = Value("CPUStoreData")
696    val CPUAtomicData = Value("CPUAtomicData")
697    val L1InstPrefetch = Value("L1InstPrefetch")
698    val L1DataPrefetch = Value("L1DataPrefetch")
699    val PTW = Value("PTW")
700    val L2Prefetch = Value("L2Prefetch")
701    val ReqSourceCount = Value("ReqSourceCount")
702
703    val reqSourceBits = log2Ceil(ReqSourceCount.id)
704  }
705
706  object TopDownCounters extends Enumeration {
707    val NoStall = Value("NoStall") // Base
708    // frontend
709    val OverrideBubble = Value("OverrideBubble")
710    val FtqUpdateBubble = Value("FtqUpdateBubble")
711    // val ControlRedirectBubble = Value("ControlRedirectBubble")
712    val TAGEMissBubble = Value("TAGEMissBubble")
713    val SCMissBubble = Value("SCMissBubble")
714    val ITTAGEMissBubble = Value("ITTAGEMissBubble")
715    val RASMissBubble = Value("RASMissBubble")
716    val MemVioRedirectBubble = Value("MemVioRedirectBubble")
717    val OtherRedirectBubble = Value("OtherRedirectBubble")
718    val FtqFullStall = Value("FtqFullStall")
719
720    val ICacheMissBubble = Value("ICacheMissBubble")
721    val ITLBMissBubble = Value("ITLBMissBubble")
722    val BTBMissBubble = Value("BTBMissBubble")
723    val FetchFragBubble = Value("FetchFragBubble")
724
725    // backend
726    // long inst stall at rob head
727    val DivStall = Value("DivStall") // int div, float div/sqrt
728    val IntNotReadyStall = Value("IntNotReadyStall") // int-inst at rob head not issue
729    val FPNotReadyStall = Value("FPNotReadyStall") // fp-inst at rob head not issue
730    val MemNotReadyStall = Value("MemNotReadyStall") // mem-inst at rob head not issue
731    // freelist full
732    val IntFlStall = Value("IntFlStall")
733    val FpFlStall = Value("FpFlStall")
734    // dispatch queue full
735    val IntDqStall = Value("IntDqStall")
736    val FpDqStall = Value("FpDqStall")
737    val LsDqStall = Value("LsDqStall")
738
739    // memblock
740    val LoadTLBStall = Value("LoadTLBStall")
741    val LoadL1Stall = Value("LoadL1Stall")
742    val LoadL2Stall = Value("LoadL2Stall")
743    val LoadL3Stall = Value("LoadL3Stall")
744    val LoadMemStall = Value("LoadMemStall")
745    val StoreStall = Value("StoreStall") // include store tlb miss
746    val AtomicStall = Value("AtomicStall") // atomic, load reserved, store conditional
747
748    // xs replay (different to gem5)
749    val LoadVioReplayStall = Value("LoadVioReplayStall")
750    val LoadMSHRReplayStall = Value("LoadMSHRReplayStall")
751
752    // bad speculation
753    val ControlRecoveryStall = Value("ControlRecoveryStall")
754    val MemVioRecoveryStall = Value("MemVioRecoveryStall")
755    val OtherRecoveryStall = Value("OtherRecoveryStall")
756
757    val FlushedInsts = Value("FlushedInsts") // control flushed, memvio flushed, others
758
759    val OtherCoreStall = Value("OtherCoreStall")
760
761    val NumStallReasons = Value("NumStallReasons")
762  }
763}
764