1# Copyright (c) 2012-2013 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) 2015 The University of Bologna
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# Authors: Erfan Azarkhish
40
41from m5.params import *
42from m5.objects.XBar import *
43
44# References:
45# [1] http://www.open-silicon.com/open-silicon-ips/hmc/
46# [2] Ahn, J.; Yoo, S.; Choi, K., "Low-Power Hybrid Memory Cubes With Link
47#   Power Management and Two-Level Prefetching," TVLSI 2015
48
49# The HMCController class highlights the fact that a component is required
50# between host and HMC to convert the host protocol (AXI for example) to the
51# serial links protocol. Moreover, this component should have large internal
52# queueing to hide the access latency of the HMC.
53# Plus, this controller can implement more advanced global scheduling policies
54# and can reorder and steer transactions if required. A good example of such
55# component is available in [1].
56# Also in [2] there is a similar component which is connected to all serial
57# links, and it schedules the requests to the ones which are not busy.
58# These two references clarify two things:
59# 1. The serial links support the same address range and packets can travel
60#  over any of them.
61# 2. One host can be connected to more than 1 serial link simply to achieve
62#  higher bandwidth, and not for any other reason.
63
64# In this model, we have used a round-robin counter, because it is the
65# simplest way to schedule packets over the non-busy serial links. However,
66# more advanced scheduling algorithms are possible and even host can dedicate
67# each serial link to a portion of the address space and interleave packets
68# over them. Yet in this model, we have not made any such assumptions on the
69# address space.
70
71class HMCController(NoncoherentXBar):
72        type = 'HMCController'
73        cxx_header = "mem/hmc_controller.hh"
74