style: [patch 1/22] use /r/3648/ to reorganize includes
[gem5.git] / src / mem / external_master.cc
1 /*
2 * Copyright (c) 2012-2014 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Andrew Bardsley
38 * Curtis Dunham
39 */
40
41 #include "mem/external_master.hh"
42
43 #include <cctype>
44 #include <iomanip>
45
46 #include "debug/ExternalPort.hh"
47
48 std::map<std::string, ExternalMaster::Handler *>
49 ExternalMaster::portHandlers;
50
51 ExternalMaster::ExternalMaster(ExternalMasterParams *params) :
52 MemObject(params),
53 externalPort(NULL),
54 portName(params->name + ".port"),
55 portType(params->port_type),
56 portData(params->port_data)
57 {}
58
59 BaseMasterPort &
60 ExternalMaster::getMasterPort(const std::string &if_name,
61 PortID idx)
62 {
63 if (if_name == "port") {
64 DPRINTF(ExternalPort, "Trying to bind external port: %s %s\n",
65 portType, portName);
66
67 if (!externalPort) {
68 auto handlerIter = portHandlers.find(portType);
69
70 if (handlerIter == portHandlers.end())
71 fatal("Can't find port handler type '%s'\n", portType);
72
73 externalPort = portHandlers[portType]->getExternalPort(portName,
74 *this, portData);
75
76 if (!externalPort) {
77 fatal("%s: Can't find external port type: %s"
78 " port_data: '%s'\n", portName, portType, portData);
79 }
80 }
81 return *externalPort;
82 } else {
83 return MemObject::getMasterPort(if_name, idx);
84 }
85 }
86
87 void
88 ExternalMaster::init()
89 {
90 if (!externalPort) {
91 fatal("ExternalMaster %s: externalPort not set!\n", name());
92 } else if (!externalPort->isConnected()) {
93 fatal("ExternalMaster %s is unconnected!\n", name());
94 }
95 }
96
97 ExternalMaster *
98 ExternalMasterParams::create()
99 {
100 return new ExternalMaster(this);
101 }
102
103 void
104 ExternalMaster::registerHandler(const std::string &handler_name,
105 Handler *handler)
106 {
107 portHandlers[handler_name] = handler;
108 }