gem5  v21.1.0.2
external_master.cc
Go to the documentation of this file.
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 
38 #include "mem/external_master.hh"
39 
40 #include <cctype>
41 #include <iomanip>
42 
43 #include "base/trace.hh"
44 #include "debug/ExternalPort.hh"
45 #include "sim/system.hh"
46 
47 namespace gem5
48 {
49 
50 std::map<std::string, ExternalMaster::Handler *>
52 
53 ExternalMaster::ExternalMaster(const ExternalMasterParams &params) :
54  SimObject(params),
55  externalPort(NULL),
56  portName(params.name + ".port"),
57  portType(params.port_type),
58  portData(params.port_data),
59  id(params.system->getRequestorId(this))
60 {}
61 
62 Port &
63 ExternalMaster::getPort(const std::string &if_name, PortID idx)
64 {
65  if (if_name == "port") {
66  DPRINTF(ExternalPort, "Trying to bind external port: %s %s\n",
68 
69  if (!externalPort) {
70  auto handlerIter = portHandlers.find(portType);
71 
72  if (handlerIter == portHandlers.end())
73  fatal("Can't find port handler type '%s'\n", portType);
74 
75  externalPort = portHandlers[portType]->getExternalPort(portName,
76  *this, portData);
77 
78  if (!externalPort) {
79  fatal("%s: Can't find external port type: %s"
80  " port_data: '%s'\n", portName, portType, portData);
81  }
82  }
83  return *externalPort;
84  } else {
85  return SimObject::getPort(if_name, idx);
86  }
87 }
88 
89 void
91 {
92  if (!externalPort) {
93  fatal("ExternalMaster %s: externalPort not set!\n", name());
94  } else if (!externalPort->isConnected()) {
95  fatal("ExternalMaster %s is unconnected!\n", name());
96  }
97 }
98 
99 void
100 ExternalMaster::registerHandler(const std::string &handler_name,
101  Handler *handler)
102 {
103  portHandlers[handler_name] = handler;
104 }
105 
106 } // namespace gem5
fatal
#define fatal(...)
This implements a cprintf based fatal() function.
Definition: logging.hh:189
gem5::PortID
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:252
gem5::ExternalMaster::portName
std::string portName
Name of the bound port.
Definition: external_master.hh:106
gem5::SimObject::getPort
virtual Port & getPort(const std::string &if_name, PortID idx=InvalidPortID)
Get a port with a given name and index.
Definition: sim_object.cc:126
gem5::ExternalMaster::getPort
Port & getPort(const std::string &if_name, PortID idx=InvalidPortID) override
Port interface.
Definition: external_master.cc:63
system.hh
gem5::ExternalMaster::portData
std::string portData
Handler-specific port configuration.
Definition: external_master.hh:112
gem5::X86ISA::system
Bitfield< 15 > system
Definition: misc.hh:1003
external_master.hh
gem5::ExternalMaster::portHandlers
static std::map< std::string, Handler * > portHandlers
Registered handlers.
Definition: external_master.hh:118
gem5::Named::name
virtual std::string name() const
Definition: named.hh:47
DPRINTF
#define DPRINTF(x,...)
Definition: trace.hh:186
gem5::ExternalMaster::registerHandler
static void registerHandler(const std::string &handler_name, Handler *handler)
Register a handler which can provide ports with port_type == handler_name.
Definition: external_master.cc:100
gem5::Port::isConnected
bool isConnected() const
Is this port currently connected to a peer?
Definition: port.hh:133
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::ExternalMaster::ExternalPort
Derive from this class to create an external port interface.
Definition: external_master.hh:70
gem5::ExternalMaster::Handler
Definition: external_master.hh:91
name
const std::string & name()
Definition: trace.cc:49
gem5::ExternalMaster::ExternalMaster
ExternalMaster(const ExternalMasterParams &params)
Definition: external_master.cc:53
gem5::Port
Ports are used to interface objects to each other.
Definition: port.hh:61
gem5::ExternalMaster::portType
std::string portType
Key to select a port handler.
Definition: external_master.hh:109
gem5::ArmISA::id
Bitfield< 33 > id
Definition: misc_types.hh:250
trace.hh
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::ExternalMaster::init
void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: external_master.cc:90
gem5::ExternalMaster::externalPort
ExternalPort * externalPort
The peer port for the gem5 port "port".
Definition: external_master.hh:103

Generated on Tue Sep 21 2021 12:25:32 for gem5 by doxygen 1.8.17