5a29e8f162584f122ec8aa2a618e1c342e158a72
1 # SPDX-License: LGPLv3+
2 # Copyright (C) 2020, 2021 Luke Kenneth Casson Leighton <lkcl@lkcl.net>
3 # Copyright (C) 2020, Michael Nolan
5 """Enums used in OpenPOWER ISA decoding
7 Note: for SV, from v3.1B p12:
9 The designated SPR sandbox consists of non-privileged SPRs 704-719 and
10 privileged SPRs 720-735.
12 Note: the option exists to select a much shorter list of SPRs, to reduce
13 regfile size in HDL. this is SPRreduced and the supported list is in
17 from enum
import Enum
, unique
20 from os
.path
import dirname
, join
21 from collections
import namedtuple
25 filedir
= os
.path
.dirname(os
.path
.abspath(__file__
))
26 basedir
= dirname(dirname(dirname(filedir
)))
27 tabledir
= join(basedir
, 'openpower')
28 isatables
= join(tabledir
, 'isatables')
29 print ("find_wiki_dir", isatables
)
33 def find_wiki_file(name
):
34 return join(find_wiki_dir(), name
)
38 file_path
= find_wiki_file(name
)
39 with
open(file_path
, 'r') as csvfile
:
40 reader
= csv
.DictReader(csvfile
)
44 # names of the fields in the tables that don't correspond to an enum
45 single_bit_flags
= ['inv A', 'inv out',
46 'cry out', 'BR', 'sgn ext', 'rsrv', '32b',
47 'sgn', 'lk', 'sgl pipe']
49 # default values for fields in the table
50 default_values
= {'unit': "NONE", 'internal op': "OP_ILLEGAL",
51 'in1': "RA", 'in2': 'NONE', 'in3': 'NONE', 'out': 'NONE',
55 'rc': 'NONE', 'cry in': 'ZERO', 'form': 'NONE'}
58 def get_signal_name(name
):
61 return name
.lower().replace(' ', '_')
63 # this corresponds to which Function Unit (pipeline-with-Reservation-Stations)
64 # is to process and guard the operation. they are roughly divided by having
65 # the same register input/output signature (X-Form, etc.)
82 SV
= 1 << 12 # Simple-V https://libre-soc.org/openpower/sv
117 SVL
= 29 # Simple-V for setvl instruction
119 # Simple-V svp64 fields https://libre-soc.org/openpower/sv/svp64/
143 Idx_1_2
= 5 # due to weird BA/BB for crops
147 class SVP64PredMode(Enum
):
154 class SVP64PredInt(Enum
):
166 class SVP64PredCR(Enum
):
178 class SVP64RMMode(Enum
):
187 class SVP64width(Enum
):
195 class SVP64subvl(Enum
):
203 class SVP64sat(Enum
):
209 # supported instructions: make sure to keep up-to-date with CSV files
210 # just like everything else
212 "NONE", "add", "addc", "addco", "adde", "addeo", "addi", "addic", "addic.",
213 "addis", "addme", "addmeo", "addo", "addze", "addzeo", "and", "andc",
214 "andi.", "andis.", "attn", "b", "bc", "bcctr", "bclr", "bctar",
215 "bpermd", "cmp", "cmpb", "cmpeqb", "cmpi", "cmpl", "cmpli", "cmprb",
216 "cntlzd", "cntlzw", "cnttzd", "cnttzw", "crand", "crandc", "creqv",
217 "crnand", "crnor", "cror", "crorc", "crxor", "darn", "dcbf", "dcbst",
218 "dcbt", "dcbtst", "dcbz", "divd", "divde", "divdeo", "divdeu",
219 "divdeuo", "divdo", "divdu", "divduo", "divw", "divwe", "divweo",
220 "divweu", "divweuo", "divwo", "divwu", "divwuo", "eqv", "extsb",
221 "extsh", "extsw", "extswsli", "hrfid", "icbi", "icbt", "isel", "isync",
222 "lbarx", "lbz", "lbzu", "lbzux", "lbzx", "ld", "ldarx", "ldbrx",
223 "ldu", "ldux", "ldx", "lha", "lharx", "lhau", "lhaux", "lhax",
224 "lhbrx", "lhz", "lhzu", "lhzux", "lhzx", "lwa", "lwarx", "lwaux",
225 "lwax", "lwbrx", "lwz", "lwzcix", "lwzu", "lwzux", "lwzx", "mcrf", "mcrxr",
226 "mcrxrx", "mfcr/mfocrf", "mfmsr", "mfspr", "modsd", "modsw", "modud",
227 "moduw", "mtcrf/mtocrf", "mtmsr", "mtmsrd", "mtspr", "mulhd", "mulhdu",
228 "mulhw", "mulhwu", "mulld", "mulldo", "mulli", "mullw", "mullwo",
229 "nand", "neg", "nego", "nop", "nor", "or", "orc", "ori", "oris",
230 "popcntb", "popcntd", "popcntw", "prtyd", "prtyw", "rfid", "rldcl",
231 "rldcr", "rldic", "rldicl", "rldicr", "rldimi", "rlwimi", "rlwinm",
233 "setvl", # https://libre-soc.org/openpower/sv/setvl
234 "sim_cfg", "slbia", "sld", "slw", "srad", "sradi", "sraw",
235 "srawi", "srd", "srw", "stb", "stbcix", "stbcx", "stbu", "stbux", "stbx",
236 "std", "stdbrx", "stdcx", "stdu", "stdux", "stdx", "sth", "sthbrx", "sthcx",
237 "sthu", "sthux", "sthx", "stw", "stwbrx", "stwcx", "stwu", "stwux",
238 "stwx", "subf", "subfc", "subfco", "subfe", "subfeo", "subfic",
239 "subfme", "subfmeo", "subfo", "subfze", "subfzeo", "sync", "td",
240 "tdi", "tlbie", "tlbiel", "tw", "twi", "xor", "xori", "xoris",
243 # two-way lookup of instruction-to-index and vice-versa
246 for i
, insn
in enumerate(_insns
):
250 # Internal Operation numbering. Add new opcodes here (FPADD, FPMUL etc.)
255 OP_ILLEGAL
= 0 # important that this is zero (see power_decoder.py)
337 RS
= 4 # for some ALU/Logical operations
355 RS
= 13 # for shiftrot (M-Form)
362 RB
= 2 # for shiftrot (M-Form)
384 class LDSTMode(Enum
):
419 class CROutSel(Enum
):
428 # SPRs - Special-Purpose Registers. See V3.0B Figure 18 p971 and
429 # http://libre-riscv.org/openpower/isatables/sprs.csv
430 # http://bugs.libre-riscv.org/show_bug.cgi?id=261
432 def get_spr_enum(full_file
):
433 """get_spr_enum - creates an Enum of SPRs, dynamically
434 has the option to reduce the enum to a much shorter list.
435 this saves drastically on the size of the regfile
437 short_list
= {'PIDR', 'DAR', 'PRTBL', 'DSISR', 'SVSRR0', 'SVSTATE',
438 'SPRG0_priv', 'SPRG1_priv', 'SPRG2_priv', 'SPRG3_priv',
442 for row
in get_csv("sprs.csv"):
443 if full_file
or row
['SPR'] in short_list
:
446 spr_info
= namedtuple('spr_info', 'SPR priv_mtspr priv_mfspr length idx')
450 info
= spr_info(SPR
=row
['SPR'], priv_mtspr
=row
['priv_mtspr'],
451 priv_mfspr
=row
['priv_mfspr'], length
=int(row
['len']),
453 spr_dict
[int(row
['Idx'])] = info
454 spr_byname
[row
['SPR']] = info
455 fields
= [(row
['SPR'], int(row
['Idx'])) for row
in spr_csv
]
456 SPR
= Enum('SPR', fields
)
457 return SPR
, spr_dict
, spr_byname
459 SPRfull
, spr_dict
, spr_byname
= get_spr_enum(full_file
=True)
460 SPRreduced
, _
, _
= get_spr_enum(full_file
=False)
470 if __name__
== '__main__':
471 # find out what the heck is in SPR enum :)
472 print("sprs full", len(SPRfull
))
474 print("sprs reduced", len(SPRreduced
))
475 print(dir(SPRreduced
))
477 print(SPRfull
.__members
__['TAR'])
479 print(x
, x
.value
, str(x
), x
.name
)
481 print("function", Function
.ALU
.name
)