2 * Copyright (c) 2012 ARM Limited
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.
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.
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.
37 * Authors: Andreas Hansson
40 #include "mem/addr_mapper.hh"
42 AddrMapper::AddrMapper(const AddrMapperParams
* p
)
44 masterPort(name() + "-master", *this),
45 slavePort(name() + "-slave", *this)
52 if (!slavePort
.isConnected() || !masterPort
.isConnected())
53 fatal("Address mapper is not connected on both sides.\n");
57 AddrMapper::getPort(const std::string
&if_name
, PortID idx
)
59 if (if_name
== "master") {
61 } else if (if_name
== "slave") {
64 return MemObject::getPort(if_name
, idx
);
69 AddrMapper::recvFunctional(PacketPtr pkt
)
71 Addr orig_addr
= pkt
->getAddr();
72 pkt
->setAddr(remapAddr(orig_addr
));
73 masterPort
.sendFunctional(pkt
);
74 pkt
->setAddr(orig_addr
);
78 AddrMapper::recvFunctionalSnoop(PacketPtr pkt
)
80 Addr orig_addr
= pkt
->getAddr();
81 pkt
->setAddr(remapAddr(orig_addr
));
82 slavePort
.sendFunctionalSnoop(pkt
);
83 pkt
->setAddr(orig_addr
);
87 AddrMapper::recvAtomic(PacketPtr pkt
)
89 Addr orig_addr
= pkt
->getAddr();
90 pkt
->setAddr(remapAddr(orig_addr
));
91 Tick ret_tick
= masterPort
.sendAtomic(pkt
);
92 pkt
->setAddr(orig_addr
);
97 AddrMapper::recvAtomicSnoop(PacketPtr pkt
)
99 Addr orig_addr
= pkt
->getAddr();
100 pkt
->setAddr(remapAddr(orig_addr
));
101 Tick ret_tick
= slavePort
.sendAtomicSnoop(pkt
);
102 pkt
->setAddr(orig_addr
);
107 AddrMapper::recvTimingReq(PacketPtr pkt
)
109 Addr orig_addr
= pkt
->getAddr();
110 bool needsResponse
= pkt
->needsResponse();
111 bool cacheResponding
= pkt
->cacheResponding();
113 if (needsResponse
&& !cacheResponding
) {
114 pkt
->pushSenderState(new AddrMapperSenderState(orig_addr
));
117 pkt
->setAddr(remapAddr(orig_addr
));
119 // Attempt to send the packet
120 bool successful
= masterPort
.sendTimingReq(pkt
);
122 // If not successful, restore the address and sender state
124 pkt
->setAddr(orig_addr
);
127 delete pkt
->popSenderState();
135 AddrMapper::recvTimingResp(PacketPtr pkt
)
137 AddrMapperSenderState
* receivedState
=
138 dynamic_cast<AddrMapperSenderState
*>(pkt
->senderState
);
140 // Restore initial sender state
141 if (receivedState
== NULL
)
142 panic("AddrMapper %s got a response without sender state\n",
145 Addr remapped_addr
= pkt
->getAddr();
147 // Restore the state and address
148 pkt
->senderState
= receivedState
->predecessor
;
149 pkt
->setAddr(receivedState
->origAddr
);
151 // Attempt to send the packet
152 bool successful
= slavePort
.sendTimingResp(pkt
);
154 // If packet successfully sent, delete the sender state, otherwise
157 delete receivedState
;
159 // Don't delete anything and let the packet look like we did
161 pkt
->senderState
= receivedState
;
162 pkt
->setAddr(remapped_addr
);
168 AddrMapper::recvTimingSnoopReq(PacketPtr pkt
)
170 slavePort
.sendTimingSnoopReq(pkt
);
174 AddrMapper::recvTimingSnoopResp(PacketPtr pkt
)
176 return masterPort
.sendTimingSnoopResp(pkt
);
180 AddrMapper::isSnooping() const
182 if (slavePort
.isSnooping())
183 fatal("AddrMapper doesn't support remapping of snooping requests\n");
188 AddrMapper::recvReqRetry()
190 slavePort
.sendRetryReq();
194 AddrMapper::recvRespRetry()
196 masterPort
.sendRetryResp();
200 AddrMapper::recvRangeChange()
202 slavePort
.sendRangeChange();
205 RangeAddrMapper::RangeAddrMapper(const RangeAddrMapperParams
* p
) :
207 originalRanges(p
->original_ranges
),
208 remappedRanges(p
->remapped_ranges
)
210 if (originalRanges
.size() != remappedRanges
.size())
211 fatal("AddrMapper: original and shadowed range list must "
214 for (size_t x
= 0; x
< originalRanges
.size(); x
++) {
215 if (originalRanges
[x
].size() != remappedRanges
[x
].size())
216 fatal("AddrMapper: original and shadowed range list elements"
217 " aren't all of the same size\n");
222 RangeAddrMapperParams::create()
224 return new RangeAddrMapper(this);
228 RangeAddrMapper::remapAddr(Addr addr
) const
230 for (int i
= 0; i
< originalRanges
.size(); ++i
) {
231 if (originalRanges
[i
].contains(addr
)) {
232 Addr offset
= addr
- originalRanges
[i
].start();
233 return offset
+ remappedRanges
[i
].start();
241 RangeAddrMapper::getAddrRanges() const
243 // Simply return the original ranges as given by the parameters
244 AddrRangeList
ranges(originalRanges
.begin(), originalRanges
.end());