gem5  v21.1.0.2
external_master.hh
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 
56 #ifndef __MEM_EXTERNAL_MASTER_HH__
57 #define __MEM_EXTERNAL_MASTER_HH__
58 
59 #include "mem/port.hh"
60 #include "params/ExternalMaster.hh"
61 #include "sim/sim_object.hh"
62 
63 namespace gem5
64 {
65 
66 class ExternalMaster : public SimObject
67 {
68  public:
70  class ExternalPort : public RequestPort
71  {
72  protected:
74 
75  public:
76  ExternalPort(const std::string &name_,
77  ExternalMaster &owner_) :
78  RequestPort(name_, &owner_), owner(owner_)
79  { }
80 
82 
85  };
86 
87  /* Handlers are specific to *types* of port not specific port
88  * instantiations. A handler will typically build a bridge to the
89  * external port from gem5 and provide gem5 with a RequestPort that can be
90  * bound to for each call to Handler::getExternalPort.*/
91  class Handler
92  {
93  public:
97  const std::string &name, ExternalMaster &owner,
98  const std::string &port_data) = 0;
99  };
100 
101  protected:
104 
106  std::string portName;
107 
109  std::string portType;
110 
112  std::string portData;
113 
118  static std::map<std::string, Handler *> portHandlers;
119 
120  public:
121  ExternalMaster(const ExternalMasterParams &params);
122 
124  Port &getPort(const std::string &if_name,
125  PortID idx=InvalidPortID) override;
126 
129  static void registerHandler(const std::string &handler_name,
130  Handler *handler);
131 
132  void init() override;
133 
135 };
136 
137 } // namespace gem5
138 
139 #endif //__MEM_EXTERNAL_MASTER_HH__
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::ExternalMaster::getPort
Port & getPort(const std::string &if_name, PortID idx=InvalidPortID) override
Port interface.
Definition: external_master.cc:63
gem5::ExternalMaster::portData
std::string portData
Handler-specific port configuration.
Definition: external_master.hh:112
gem5::InvalidPortID
const PortID InvalidPortID
Definition: types.hh:253
gem5::ExternalMaster::ExternalPort::owner
ExternalMaster & owner
Definition: external_master.hh:73
gem5::RequestPort
A RequestPort is a specialisation of a Port, which implements the default protocol for the three diff...
Definition: port.hh:77
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
gem5::SimObject::params
const Params & params() const
Definition: sim_object.hh:176
sim_object.hh
port.hh
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::ExternalMaster::id
const RequestorID id
Definition: external_master.hh:134
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::ExternalMaster
Definition: external_master.hh:66
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
gem5::ExternalMaster::Handler::getExternalPort
virtual ExternalPort * getExternalPort(const std::string &name, ExternalMaster &owner, const std::string &port_data)=0
Create or find an external port which can be bound.
gem5::ExternalMaster::ExternalMaster
ExternalMaster(const ExternalMasterParams &params)
Definition: external_master.cc:53
gem5::ExternalMaster::ExternalPort::ExternalPort
ExternalPort(const std::string &name_, ExternalMaster &owner_)
Definition: external_master.hh:76
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::ExternalMaster::ExternalPort::~ExternalPort
~ExternalPort()
Definition: external_master.hh:81
gem5::RequestorID
uint16_t RequestorID
Definition: request.hh:95
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