src/mem/AbstractMemory.py

   1 # Copyright (c) 2012 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 # Copyright (c) 2005-2008 The Regents of The University of Michigan
  14 # All rights reserved.
  15 #
  16 # Redistribution and use in source and binary forms, with or without
  17 # modification, are permitted provided that the following conditions are
  18 # met: redistributions of source code must retain the above copyright
  19 # notice, this list of conditions and the following disclaimer;
  20 # redistributions in binary form must reproduce the above copyright
  21 # notice, this list of conditions and the following disclaimer in the
  22 # documentation and/or other materials provided with the distribution;
  23 # neither the name of the copyright holders nor the names of its
  24 # contributors may be used to endorse or promote products derived from
  25 # this software without specific prior written permission.
  26 #
  27 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38
  39 from m5.params import *
  40 from m5.objects.ClockedObject import ClockedObject
  41
  42 class AbstractMemory(ClockedObject):
  43     type = 'AbstractMemory'
  44     abstract = True
  45     cxx_header = "mem/abstract_mem.hh"
  46
  47     # A default memory size of 128 MiB (starting at 0) is used to
  48     # simplify the regressions
  49     range = Param.AddrRange('128MiB',
  50                             "Address range (potentially interleaved)")
  51     null = Param.Bool(False, "Do not store data, always return zero")
  52
  53     # All memories are passed to the global physical memory, and
  54     # certain memories may be excluded from the global address map,
  55     # e.g. by the testers that use shadow memories as a reference
  56     in_addr_map = Param.Bool(True, "Memory part of the global address map")
  57
  58     # When KVM acceleration is used, memory is mapped into the guest process
  59     # address space and accessed directly. Some memories may need to be
  60     # excluded from this mapping if they overlap with other memory ranges or
  61     # are not accessible by the CPU.
  62     kvm_map = Param.Bool(True, "Should KVM map this memory for the guest")
  63
  64     # Should the bootloader include this memory when passing
  65     # configuration information about the physical memory layout to
  66     # the kernel, e.g. using ATAG or ACPI
  67     conf_table_reported = Param.Bool(True, "Report to configuration table")
  68
  69     # Image file to load into this memory as its initial contents. This is
  70     # particularly useful for ROMs.
  71     image_file = Param.String('',
  72             "Image to load into memory as its initial contents")