abd050275a9d5a347b29c88648412dbe6a4d49ff
[soc.git] / src / soc / simple / issuer_verilog.py
1 """simple core issuer verilog generator
2 """
3
4 import argparse
5 from nmigen.cli import verilog
6
7 from openpower.consts import MSR
8 from soc.config.test.test_loadstore import TestMemPspec
9 from soc.simple.issuer import TestIssuer, TestIssuerInternal
10
11
12 if __name__ == '__main__':
13 parser = argparse.ArgumentParser(description="Simple core issuer " \
14 "verilog generator")
15 parser.add_argument("output_filename")
16 parser.add_argument("--enable-xics", dest='xics', action="store_true",
17 help="Enable interrupts",
18 default=True)
19 parser.add_argument("--disable-xics", dest='xics', action="store_false",
20 help="Disable interrupts",
21 default=False)
22 parser.add_argument("--enable-lessports", dest='lessports',
23 action="store_true",
24 help="Enable less regfile ports",
25 default=True)
26 parser.add_argument("--disable-lessports", dest='lessports',
27 action="store_false",
28 help="enable more regfile ports",
29 default=False)
30 parser.add_argument("--enable-core", dest='core', action="store_true",
31 help="Enable main core",
32 default=True)
33 parser.add_argument("--disable-core", dest='core', action="store_false",
34 help="disable main core",
35 default=False)
36 parser.add_argument("--enable-mmu", dest='mmu', action="store_true",
37 help="Enable mmu",
38 default=False)
39 parser.add_argument("--disable-mmu", dest='mmu', action="store_false",
40 help="Disable mmu",
41 default=False)
42 parser.add_argument("--enable-pll", dest='pll', action="store_true",
43 help="Enable pll",
44 default=False)
45 parser.add_argument("--disable-pll", dest='pll', action="store_false",
46 help="Disable pll",
47 default=False)
48 parser.add_argument("--enable-testgpio", action="store_true",
49 help="Disable gpio pins",
50 default=False)
51 parser.add_argument("--enable-sram4x4kblock", action="store_true",
52 help="Disable sram 4x4k block",
53 default=False)
54 parser.add_argument("--debug", default="jtag", help="Select debug " \
55 "interface [jtag | dmi] [default jtag]")
56 parser.add_argument("--enable-svp64", dest='svp64', action="store_true",
57 help="Enable SVP64",
58 default=True)
59 parser.add_argument("--disable-svp64", dest='svp64', action="store_false",
60 help="disable SVP64",
61 default=False)
62 parser.add_argument("--pc-reset", default="0",
63 help="Set PC at reset (default 0)")
64 parser.add_argument("--xlen", default=64, type=int,
65 help="Set register width [default 64]")
66 # create a module that's directly compatible as a drop-in replacement
67 # in microwatt.v
68 parser.add_argument("--microwatt-compat", dest='mwcompat',
69 action="store_true",
70 help="generate microwatt-compatible interface",
71 default=False)
72 parser.add_argument("--old-microwatt-compat", dest='old_mwcompat',
73 action="store_true",
74 help="generate old microwatt-compatible interface",
75 default=True)
76 parser.add_argument("--microwatt-debug", dest='mwdebug',
77 action="store_true",
78 help="generate old microwatt-compatible interface",
79 default=False)
80 # create a module with Fabric compatibility
81 parser.add_argument("--fabric-compat", dest='fabriccompat',
82 action="store_true",
83 help="generate Fabric-compatible interface",
84 default=False)
85 # small cache option
86 parser.add_argument("--small-cache", dest='smallcache',
87 action="store_true",
88 help="generate small caches",
89 default=False)
90
91 # allow overlaps in TestIssuer
92 parser.add_argument("--allow-overlap", dest='allow_overlap',
93 action="store_true",
94 help="allow overlap in TestIssuer",
95 default=False)
96
97 args = parser.parse_args()
98
99 # convenience: set some defaults
100 if args.mwcompat:
101 args.pll = False
102 args.debug = 'dmi'
103 args.core = True
104 args.xics = False
105 args.gpio = False
106 args.sram4x4kblock = False
107 args.svp64 = False
108
109 print(args)
110
111 units = {'alu': 1,
112 'cr': 1, 'branch': 1, 'trap': 1,
113 'logical': 1,
114 'spr': 1,
115 'div': 1,
116 'mul': 1,
117 'shiftrot': 1
118 }
119 if args.mmu:
120 units['mmu'] = 1 # enable MMU
121
122 # decide which memory type to configure
123 if args.mmu:
124 ldst_ifacetype = 'mmu_cache_wb'
125 imem_ifacetype = 'mmu_cache_wb'
126 else:
127 ldst_ifacetype = 'bare_wb'
128 imem_ifacetype = 'bare_wb'
129
130 # default MSR
131 msr_reset = (1<<MSR.LE) | (1<<MSR.SF) # 64-bit, little-endian default
132
133 # default PC
134 if args.pc_reset.startswith("0x"):
135 pc_reset = int(args.pc_reset, 16)
136 else:
137 pc_reset = int(args.pc_reset)
138
139 pspec = TestMemPspec(ldst_ifacetype=ldst_ifacetype,
140 imem_ifacetype=imem_ifacetype,
141 addr_wid=64,
142 mask_wid=8,
143 # pipeline and integer register file width
144 XLEN=args.xlen,
145 # must leave at 64
146 reg_wid=64,
147 # set to 32 for instruction-memory width=32
148 imem_reg_wid=64,
149 # set to 32 to make data wishbone bus 32-bit
150 #wb_data_wid=32,
151 xics=args.xics, # XICS interrupt controller
152 nocore=not args.core, # test coriolis2 ioring
153 regreduce = args.lessports, # less regfile ports
154 use_pll=args.pll, # bypass PLL
155 gpio=args.enable_testgpio, # for test purposes
156 sram4x4kblock=args.enable_sram4x4kblock, # add SRAMs
157 debug=args.debug, # set to jtag or dmi
158 svp64=args.svp64, # enable SVP64
159 microwatt_mmu=args.mmu, # enable MMU
160 microwatt_compat=args.mwcompat, # microwatt compatible
161 microwatt_old=args.old_mwcompat, # old microwatt api
162 microwatt_debug=args.mwdebug, # microwatt debug signals
163 fabric_compat=args.fabriccompat, # fabric compatible (overlaps with microwatt compat)
164 small_cache=args.smallcache, # small cache/TLB sizes
165 allow_overlap=args.allow_overlap, # allow overlap
166 units=units,
167 msr_reset=msr_reset,
168 pc_reset=pc_reset)
169 #if args.mwcompat:
170 # pspec.core_domain = 'sync'
171
172 print("mmu", pspec.__dict__["microwatt_mmu"])
173 print("nocore", pspec.__dict__["nocore"])
174 print("regreduce", pspec.__dict__["regreduce"])
175 print("gpio", pspec.__dict__["gpio"])
176 print("sram4x4kblock", pspec.__dict__["sram4x4kblock"])
177 print("xics", pspec.__dict__["xics"])
178 print("use_pll", pspec.__dict__["use_pll"])
179 print("debug", pspec.__dict__["debug"])
180 print("SVP64", pspec.__dict__["svp64"])
181 print("XLEN", pspec.__dict__["XLEN"])
182 print("MSR@reset", hex(pspec.__dict__["msr_reset"]))
183 print("PC@reset", hex(pspec.__dict__["pc_reset"]))
184 print("Microwatt compatibility", pspec.__dict__["microwatt_compat"])
185 print("Old Microwatt compatibility", pspec.__dict__["microwatt_old"])
186 print("Microwatt debug", pspec.__dict__["microwatt_debug"])
187 print("Fabric compatibility", pspec.__dict__["fabric_compat"])
188 print("Small Cache/TLB", pspec.__dict__["small_cache"])
189
190 if args.mwcompat:
191 dut = TestIssuerInternal(pspec)
192 name = "external_core_top"
193 else:
194 dut = TestIssuer(pspec)
195 name = "test_issuer"
196
197 vl = verilog.convert(dut, ports=dut.external_ports(), name=name)
198 with open(args.output_filename, "w") as f:
199 f.write(vl)