util: Add a README file for the m5 utility.
[gem5.git] / util / cpt_upgraders / arm-gem5-gic-ext.py
1 # Copyright (c) 2015 ARM Limited
2 # All rights reserved
3 #
4 # The license below extends only to copyright in the software and shall
5 # not be construed as granting a license to any other intellectual
6 # property including but not limited to intellectual property relating
7 # to a hardware implementation of the functionality of the software
8 # licensed hereunder. You may use the software subject to the license
9 # terms below provided that you ensure that this notice is replicated
10 # unmodified and in its entirety in all distributions of the software,
11 # modified or unmodified, in source code or in binary form.
12 #
13 # Redistribution and use in source and binary forms, with or without
14 # modification, are permitted provided that the following conditions are
15 # met: redistributions of source code must retain the above copyright
16 # notice, this list of conditions and the following disclaimer;
17 # redistributions in binary form must reproduce the above copyright
18 # notice, this list of conditions and the following disclaimer in the
19 # documentation and/or other materials provided with the distribution;
20 # neither the name of the copyright holders nor the names of its
21 # contributors may be used to endorse or promote products derived from
22 # this software without specific prior written permission.
23 #
24 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35
36 def upgrader(cpt):
37 """The gem5 GIC extensions change the size of many GIC data
38 structures. Resize them to match the new GIC."""
39
40 import re
41 if cpt.get('root','isa') != 'arm':
42 return
43
44 old_cpu_max = 8
45 new_cpu_max = 256
46 sgi_max = 16
47 ppi_max = 16
48 per_cpu_regs = (
49 ("iccrpr", [ "0xff", ]),
50 ("cpuEnabled", [ "false", ]),
51 ("cpuPriority", [ "0xff", ]),
52 ("cpuBpr", [ "0", ]),
53 ("cpuHighestInt", [ "1023", ]),
54 ("cpuPpiPending", [ "0", ]),
55 ("cpuPpiActive", [ "0", ] ),
56 ("interrupt_time", [ "0", ]),
57 ("*bankedIntPriority", ["0", ] * (sgi_max + ppi_max)),
58 )
59 new_per_cpu_regs = (
60 ("cpuSgiPendingExt", "0"),
61 ("cpuSgiActiveExt", "0"),
62 )
63
64 for sec in cpt.sections():
65 if re.search('.*\.gic$', sec):
66 for reg, default in per_cpu_regs:
67 value = cpt.get(sec, reg).split(" ")
68 assert len(value) / len(default) == old_cpu_max, \
69 "GIC register size mismatch"
70 value += [ " ".join(default), ] * (new_cpu_max - old_cpu_max)
71 cpt.set(sec, reg, " ".join(value))
72
73 for reg, default in new_per_cpu_regs:
74 cpt.set(sec, reg, " ".join([ default, ] * new_cpu_max))