1 # Copyright (c) 2012, 2015, 2017, 2019 ARM Limited
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.
13 # Copyright (c) 2005-2008 The Regents of The University of Michigan
14 # All rights reserved.
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.
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.
39 # Authors: Nathan Binkert
42 from m5
.objects
.System
import System
43 from m5
.params
import *
44 from m5
.proxy
import *
45 from m5
.SimObject
import SimObject
47 from m5
.objects
.ClockedObject
import ClockedObject
49 class BaseXBar(ClockedObject
):
52 cxx_header
= "mem/xbar.hh"
54 slave
= VectorSlavePort("Vector port for connecting masters")
55 master
= VectorMasterPort("Vector port for connecting slaves")
57 # Latencies governing the time taken for the variuos paths a
58 # packet has through the crossbar. Note that the crossbar itself
59 # does not add the latency due to assumptions in the coherency
60 # mechanism. Instead the latency is annotated on the packet and
61 # left to the neighbouring modules.
63 # A request incurs the frontend latency, possibly snoop filter
64 # lookup latency, and forward latency. A response incurs the
65 # response latency. Frontend latency encompasses arbitration and
66 # deciding what to do when a request arrives. the forward latency
67 # is the latency involved once a decision is made to forward the
68 # request. The response latency, is similar to the forward
69 # latency, but for responses rather than requests.
70 frontend_latency
= Param
.Cycles("Frontend latency")
71 forward_latency
= Param
.Cycles("Forward latency")
72 response_latency
= Param
.Cycles("Response latency")
74 # Width governing the throughput of the crossbar
75 width
= Param
.Unsigned("Datapath width per port (bytes)")
77 # The default port can be left unconnected, or be used to connect
78 # a default slave port
79 default
= MasterPort("Port for connecting an optional default slave")
81 # The default port can be used unconditionally, or based on
82 # address range, in which case it may overlap with other
83 # ports. The default range is always checked first, thus creating
84 # a two-level hierarchical lookup. This is useful e.g. for the PCI
86 use_default_range
= Param
.Bool(False, "Perform address mapping for " \
89 class NoncoherentXBar(BaseXBar
):
90 type = 'NoncoherentXBar'
91 cxx_header
= "mem/noncoherent_xbar.hh"
93 class CoherentXBar(BaseXBar
):
95 cxx_header
= "mem/coherent_xbar.hh"
97 # The coherent crossbar additionally has snoop responses that are
98 # forwarded after a specific latency.
99 snoop_response_latency
= Param
.Cycles("Snoop response latency")
101 # An optional snoop filter
102 snoop_filter
= Param
.SnoopFilter(NULL
, "Selected snoop filter")
104 # Maximum number of outstanding snoop requests for sanity checks
105 max_outstanding_snoops
= Param
.Int(512, "Max. outstanding snoops allowed")
107 # Maximum routing table size for sanity checks
108 max_routing_table_size
= Param
.Int(512, "Max. routing table size")
110 # Determine how this crossbar handles packets where caches have
111 # already committed to responding, by establishing if the crossbar
112 # is the point of coherency or not.
113 point_of_coherency
= Param
.Bool(False, "Consider this crossbar the " \
114 "point of coherency")
116 # Specify whether this crossbar is the point of unification.
117 point_of_unification
= Param
.Bool(False, "Consider this crossbar the " \
118 "point of unification")
120 system
= Param
.System(Parent
.any
, "System that the crossbar belongs to.")
122 class SnoopFilter(SimObject
):
124 cxx_header
= "mem/snoop_filter.hh"
126 # Lookup latency of the snoop filter, added to requests that pass
127 # through a coherent crossbar.
128 lookup_latency
= Param
.Cycles(1, "Lookup latency")
130 system
= Param
.System(Parent
.any
, "System that the crossbar belongs to.")
132 # Sanity check on max capacity to track, adjust if needed.
133 max_capacity
= Param
.MemorySize('8MB', "Maximum capacity of snoop filter")
135 # We use a coherent crossbar to connect multiple masters to the L2
136 # caches. Normally this crossbar would be part of the cache itself.
137 class L2XBar(CoherentXBar
):
138 # 256-bit crossbar by default
141 # Assume that most of this is covered by the cache latencies, with
142 # no more than a single pipeline stage for any packet.
146 snoop_response_latency
= 1
148 # Use a snoop-filter by default, and set the latency to zero as
149 # the lookup is assumed to overlap with the frontend latency of
151 snoop_filter
= SnoopFilter(lookup_latency
= 0)
153 # This specialisation of the coherent crossbar is to be considered
154 # the point of unification, it connects the dcache and the icache
155 # to the first level of unified cache.
156 point_of_unification
= True
158 # One of the key coherent crossbar instances is the system
159 # interconnect, tying together the CPU clusters, GPUs, and any I/O
160 # coherent masters, and DRAM controllers.
161 class SystemXBar(CoherentXBar
):
162 # 128-bit crossbar by default
165 # A handful pipeline stages for each portion of the latency
170 snoop_response_latency
= 4
172 # Use a snoop-filter by default
173 snoop_filter
= SnoopFilter(lookup_latency
= 1)
175 # This specialisation of the coherent crossbar is to be considered
176 # the point of coherency, as there are no (coherent) downstream
178 point_of_coherency
= True
180 # This specialisation of the coherent crossbar is to be considered
181 # the point of unification, it connects the dcache and the icache
182 # to the first level of unified cache. This is needed for systems
183 # without caches where the SystemXBar is also the point of
185 point_of_unification
= True
187 # In addition to the system interconnect, we typically also have one
188 # or more on-chip I/O crossbars. Note that at some point we might want
189 # to also define an off-chip I/O crossbar such as PCIe.
190 class IOXBar(NoncoherentXBar
):
191 # 128-bit crossbar by default
194 # Assume a simpler datapath than a coherent crossbar, incuring
195 # less pipeline stages for decision making and forwarding of