1 // Copyright (c) 2015 ARM Limited
2 // All rights reserved.
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 // Redistribution and use in source and binary forms, with or without
14 // modification, are permitted provided that the following conditions are
15 // met: redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer;
17 // redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution;
20 // neither the name of the copyright holders nor the names of its
21 // contributors may be used to endorse or promote products derived from
22 // this software without specific prior written permission.
24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 // Copyright 2009-2014 Sandia Coporation. Under the terms
37 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
38 // Government retains certain rights in this software.
40 // Copyright (c) 2009-2014, Sandia Corporation
41 // All rights reserved.
43 // For license information, see the LICENSE file in the current directory.
47 #ifdef fatal // gem5 sets this
52 using namespace SST::gem5
;
53 using namespace SST::MemHierarchy
;
55 ExtSlave::ExtSlave(gem5Component
*g5c
, Output
&out
,
56 ::ExternalSlave
& port
, std::string
&name
) :
58 comp(g5c
), out(out
), simPhase(CONSTRUCTION
), initPackets(NULL
),
59 link(comp
->configureLink(name
, new Event::Handler
<ExtSlave
>(this,
60 &ExtSlave::handleEvent
)))
63 out
.fatal(CALL_INFO
, 1, "Failed to configure link %s\n", name
.c_str());
67 void ExtSlave::init(unsigned phase
)
71 while (!initPackets
->empty()) {
72 link
->sendInitData(initPackets
->front());
73 initPackets
->pop_front();
81 ExtSlave::recvFunctional(PacketPtr pkt
)
83 if (simPhase
== CONSTRUCTION
) {
84 if (initPackets
== NULL
) {
85 initPackets
= new std::list
<MemEvent
*>;
87 ::MemCmd::Command pktCmd
= (::MemCmd::Command
)pkt
->cmd
.toInt();
88 assert(pktCmd
== ::MemCmd::WriteReq
);
89 Addr a
= pkt
->getAddr();
90 MemEvent
* ev
= new MemEvent(comp
, a
, a
, GetX
);
91 ev
->setPayload(pkt
->getSize(), pkt
->getPtr
<uint8_t>());
92 initPackets
->push_back(ev
);
94 panic("Functional accesses not allowed after construction phase");
99 ExtSlave::recvTimingReq(PacketPtr pkt
)
102 switch ((::MemCmd::Command
)pkt
->cmd
.toInt()) {
103 case ::MemCmd::HardPFReq
:
104 case ::MemCmd::SoftPFReq
:
105 case ::MemCmd::LoadLockedReq
:
106 case ::MemCmd::ReadExReq
:
107 case ::MemCmd::ReadReq
: cmd
= GetS
; break;
108 case ::MemCmd::StoreCondReq
:
109 case ::MemCmd::WriteReq
: cmd
= GetX
; break;
111 out
.fatal(CALL_INFO
, 1, "Don't know how to convert gem5 packet "
112 "command %s to SST\n", pkt
->cmd
.toString().c_str());
115 auto ev
= new MemEvent(comp
, pkt
->getAddr(), pkt
->getAddr(), cmd
);
116 ev
->setPayload(pkt
->getSize(), pkt
->getPtr
<uint8_t>());
117 if ((::MemCmd::Command
)pkt
->cmd
.toInt() == ::MemCmd::LoadLockedReq
)
119 else if ((::MemCmd::Command
)pkt
->cmd
.toInt() == ::MemCmd::StoreCondReq
)
120 ev
->setStoreConditional();
122 if (pkt
->req
->isLockedRMW()) ev
->setFlag(MemEvent::F_LOCKED
);
123 if (pkt
->req
->isUncacheable()) ev
->setFlag(MemEvent::F_NONCACHEABLE
);
124 if (pkt
->req
->hasContextId()) ev
->setGroupId(pkt
->req
->contextId());
125 // Prefetches not working with SST; it maybe be dropping them, treating them
126 // as not deserving of responses, or something else -- not sure yet.
127 // ev->setPrefetchFlag(pkt->req->isPrefetch());
129 if (simPhase
== INIT
) {
130 link
->sendInitData(ev
);
134 if (pkt
->needsResponse()) {
135 PacketMap
[ev
->getID()] = pkt
;
144 ExtSlave::handleEvent(Event
* ev
)
146 MemEvent
* event
= dynamic_cast<MemEvent
*>(ev
);
148 out
.fatal(CALL_INFO
, 1, "ExtSlave handleEvent received non-MemEvent\n");
152 Event::id_type id
= event
->getID();
154 PacketMap_t::iterator mi
= PacketMap
.find(id
);
155 if (mi
!= PacketMap
.end()) { // replying to prior request
156 PacketPtr pkt
= mi
->second
;
159 pkt
->makeResponse(); // Convert to a response packet
160 pkt
->setData(event
->getPayload().data());
162 // Resolve the success of Store Conditionals
163 if (pkt
->isLLSC() && pkt
->isWrite()) {
164 pkt
->req
->setExtraData(event
->isAtomic());
167 // Clear out bus delay notifications
168 pkt
->headerDelay
= pkt
->payloadDelay
= 0;
170 if (blocked() || !sendTimingResp(pkt
)) {
171 respQ
.push_back(pkt
);
173 } else { // we can handle unexpected invalidates, but nothing else.
174 Command cmd
= event
->getCmd();
177 // make Req/Pkt for Snoop/no response needed
178 // presently no consideration for masterId, packet type, flags...
179 RequestPtr req
= new Request(event
->getAddr(), event
->getSize(), 0, 0);
180 auto pkt
= new Packet(req
, ::MemCmd::InvalidateReq
);
182 // Clear out bus delay notifications
183 pkt
->headerDelay
= pkt
->payloadDelay
= 0;
185 sendTimingSnoopReq(pkt
);
191 ExtSlave::recvRespRetry()
193 while (blocked() && sendTimingResp(respQ
.front())) {