src/mem/AddrMapper.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 # 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 from m5.params import *
  37 from m5.SimObject import SimObject
  38
  39 # An address mapper changes the packet addresses in going from the
  40 # response port side of the mapper to the request port side. When the
  41 # response port is queried for the address ranges, it also performs the
  42 # necessary range updates. Note that snoop requests that travel from
  43 # the request port (i.e. the memory side) to the response port are
  44 # currently not modified.
  45 class AddrMapper(SimObject):
  46     type = 'AddrMapper'
  47     cxx_header = 'mem/addr_mapper.hh'
  48     abstract = True
  49
  50     # one port in each direction
  51     mem_side_port = RequestPort("This port sends requests and "
  52                                 "receives responses")
  53     master   = DeprecatedParam(mem_side_port,
  54                                '`master` is now called `mem_side_port`')
  55     cpu_side_port = ResponsePort("This port receives requests and "
  56                                  "sends responses")
  57     slave    = DeprecatedParam(cpu_side_port,
  58                                '`slave` is now called `cpu_side_port`')
  59
  60 # Range address mapper that maps a set of original ranges to a set of
  61 # remapped ranges, where a specific range is of the same size
  62 # (original and remapped), only with an offset.
  63 class RangeAddrMapper(AddrMapper):
  64     type = 'RangeAddrMapper'
  65     cxx_header = 'mem/addr_mapper.hh'
  66
  67     # These two vectors should be the exact same length and each range
  68     # should be the exact same size. Each range in original_ranges is
  69     # mapped to the corresponding element in the remapped_ranges. Note
  70     # that the same range can occur multiple times in the remapped
  71     # ranges for address aliasing.
  72     original_ranges = VectorParam.AddrRange(
  73         "Ranges of memory that should me remapped")
  74     remapped_ranges = VectorParam.AddrRange(
  75         "Ranges of memory that are being mapped to")