src/arch/arm/ArmSystem.py

   1 # Copyright (c) 2009, 2012-2013, 2015-2018 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 # Authors: Ali Saidi
  37 #          Glenn Bergmans
  38
  39 from m5.params import *
  40 from m5.SimObject import *
  41 from m5.util.fdthelper import *
  42
  43 from System import System
  44
  45 class ArmMachineType(Enum):
  46     map = {
  47         'RealViewEB' : 827,
  48         'RealViewPBX' : 1901,
  49         'VExpress_EMM' : 2272,
  50         'VExpress_EMM64' : 2272,
  51         'DTOnly' : -1,
  52     }
  53
  54 class ArmSystem(System):
  55     type = 'ArmSystem'
  56     cxx_header = "arch/arm/system.hh"
  57     multi_proc = Param.Bool(True, "Multiprocessor system?")
  58     boot_loader = VectorParam.String([],
  59         "File that contains the boot loader code. Zero or more files may be "
  60         "specified. The first boot loader that matches the kernel's "
  61         "architecture will be used.")
  62     gic_cpu_addr = Param.Addr(0, "Addres of the GIC CPU interface")
  63     flags_addr = Param.Addr(0, "Address of the flags register for MP booting")
  64     have_security = Param.Bool(False,
  65         "True if Security Extensions are implemented")
  66     have_virtualization = Param.Bool(False,
  67         "True if Virtualization Extensions are implemented")
  68     have_lpae = Param.Bool(True, "True if LPAE is implemented")
  69     highest_el_is_64 = Param.Bool(False,
  70         "True if the register width of the highest implemented exception level "
  71         "is 64 bits (ARMv8)")
  72     reset_addr_64 = Param.Addr(0x0,
  73         "Reset address if the highest implemented exception level is 64 bits "
  74         "(ARMv8)")
  75     auto_reset_addr_64 = Param.Bool(False,
  76         "Determine reset address from kernel entry point if no boot loader")
  77     phys_addr_range_64 = Param.UInt8(40,
  78         "Supported physical address range in bits when using AArch64 (ARMv8)")
  79     have_large_asid_64 = Param.Bool(False,
  80         "True if ASID is 16 bits in AArch64 (ARMv8)")
  81
  82     m5ops_base = Param.Addr(0,
  83         "Base of the 64KiB PA range used for memory-mapped m5ops. Set to 0 "
  84         "to disable.")
  85
  86     def generateDeviceTree(self, state):
  87         # Generate a device tree root node for the system by creating the root
  88         # node and adding the generated subnodes of all children.
  89         # When a child needs to add multiple nodes, this is done by also
  90         # creating a node called '/' which will then be merged with the
  91         # root instead of appended.
  92
  93         def generateMemNode(mem_range):
  94             node = FdtNode("memory@%x" % long(mem_range.start))
  95             node.append(FdtPropertyStrings("device_type", ["memory"]))
  96             node.append(FdtPropertyWords("reg",
  97                 state.addrCells(mem_range.start) +
  98                 state.sizeCells(mem_range.size()) ))
  99             return node
 100
 101         root = FdtNode('/')
 102         root.append(state.addrCellsProperty())
 103         root.append(state.sizeCellsProperty())
 104
 105         # Add memory nodes
 106         for mem_range in self.mem_ranges:
 107             root.append(generateMemNode(mem_range))
 108
 109         for node in self.recurseDeviceTree(state):
 110             # Merge root nodes instead of adding them (for children
 111             # that need to add multiple root level nodes)
 112             if node.get_name() == root.get_name():
 113                 root.merge(node)
 114             else:
 115                 root.append(node)
 116
 117         return root
 118
 119 class GenericArmSystem(ArmSystem):
 120     type = 'GenericArmSystem'
 121     cxx_header = "arch/arm/system.hh"
 122     machine_type = Param.ArmMachineType('DTOnly',
 123         "Machine id from http://www.arm.linux.org.uk/developer/machines/")
 124     atags_addr = Param.Addr("Address where default atags structure should " \
 125                                 "be written")
 126     dtb_filename = Param.String("",
 127         "File that contains the Device Tree Blob. Don't use DTB if empty.")
 128     early_kernel_symbols = Param.Bool(False,
 129         "enable early kernel symbol tables before MMU")
 130     enable_context_switch_stats_dump = Param.Bool(False, "enable stats/task info dumping at context switch boundaries")
 131
 132     panic_on_panic = Param.Bool(False, "Trigger a gem5 panic if the " \
 133                                     "guest kernel panics")
 134     panic_on_oops = Param.Bool(False, "Trigger a gem5 panic if the " \
 135                                    "guest kernel oopses")
 136
 137 class LinuxArmSystem(GenericArmSystem):
 138     type = 'LinuxArmSystem'
 139     cxx_header = "arch/arm/linux/system.hh"
 140
 141     @cxxMethod
 142     def dumpDmesg(self):
 143         """Dump dmesg from the simulated kernel to standard out"""
 144         pass
 145
 146     # Have Linux systems for ARM auto-calc their load_addr_mask for proper
 147     # kernel relocation.
 148     load_addr_mask = 0x0
 149
 150 class FreebsdArmSystem(GenericArmSystem):
 151     type = 'FreebsdArmSystem'
 152     cxx_header = "arch/arm/freebsd/system.hh"