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 #ifndef __MEM_ADDR_MAPPER_HH__
41 #define __MEM_ADDR_MAPPER_HH__
43 #include "mem/mem_object.hh"
44 #include "params/AddrMapper.hh"
45 #include "params/RangeAddrMapper.hh"
48 * An address mapper changes the packet addresses in going from the
49 * slave port side of the mapper to the master port side. When the
50 * slave port is queried for the address ranges, it also performs the
51 * necessary range updates. Note that snoop requests that travel from
52 * the master port (i.e. the memory side) to the slave port are
53 * currently not modified.
56 class AddrMapper : public MemObject
61 AddrMapper(const AddrMapperParams* params);
63 virtual ~AddrMapper() { }
65 virtual BaseMasterPort& getMasterPort(const std::string& if_name,
66 PortID idx = InvalidPortID);
68 virtual BaseSlavePort& getSlavePort(const std::string& if_name,
69 PortID idx = InvalidPortID);
76 * This function does the actual remapping of one address to another.
77 * It is pure virtual in this case to to allow any implementation
79 * @param addr the address to remap
80 * @return the new address (can be unchanged)
82 virtual Addr remapAddr(Addr addr) const = 0;
84 class AddrMapperSenderState : public Packet::SenderState
90 * Construct a new sender state to remember the original address.
92 * @param _origAddr Address before remapping
94 AddrMapperSenderState(Addr _origAddr) : origAddr(_origAddr)
98 ~AddrMapperSenderState() { }
100 /** The original address the packet was destined for */
105 class MapperMasterPort : public MasterPort
110 MapperMasterPort(const std::string& _name, AddrMapper& _mapper)
111 : MasterPort(_name, &_mapper), mapper(_mapper)
116 void recvFunctionalSnoop(PacketPtr pkt)
118 mapper.recvFunctionalSnoop(pkt);
121 Tick recvAtomicSnoop(PacketPtr pkt)
123 return mapper.recvAtomicSnoop(pkt);
126 bool recvTimingResp(PacketPtr pkt)
128 return mapper.recvTimingResp(pkt);
131 void recvTimingSnoopReq(PacketPtr pkt)
133 mapper.recvTimingSnoopReq(pkt);
136 void recvRangeChange()
138 mapper.recvRangeChange();
141 bool isSnooping() const
143 return mapper.isSnooping();
146 unsigned deviceBlockSize() const
148 return mapper.deviceBlockSizeMaster();
153 mapper.recvRetryMaster();
162 /** Instance of master port, facing the memory side */
163 MapperMasterPort masterPort;
165 class MapperSlavePort : public SlavePort
170 MapperSlavePort(const std::string& _name, AddrMapper& _mapper)
171 : SlavePort(_name, &_mapper), mapper(_mapper)
176 void recvFunctional(PacketPtr pkt)
178 mapper.recvFunctional(pkt);
181 Tick recvAtomic(PacketPtr pkt)
183 return mapper.recvAtomic(pkt);
186 bool recvTimingReq(PacketPtr pkt)
188 return mapper.recvTimingReq(pkt);
191 bool recvTimingSnoopResp(PacketPtr pkt)
193 return mapper.recvTimingSnoopResp(pkt);
196 unsigned deviceBlockSize() const
198 return mapper.deviceBlockSizeSlave();
201 AddrRangeList getAddrRanges() const
203 return mapper.getAddrRanges();
208 mapper.recvRetrySlave();
217 /** Instance of slave port, i.e. on the CPU side */
218 MapperSlavePort slavePort;
220 void recvFunctional(PacketPtr pkt);
222 void recvFunctionalSnoop(PacketPtr pkt);
224 Tick recvAtomic(PacketPtr pkt);
226 Tick recvAtomicSnoop(PacketPtr pkt);
228 bool recvTimingReq(PacketPtr pkt);
230 bool recvTimingResp(PacketPtr pkt);
232 void recvTimingSnoopReq(PacketPtr pkt);
234 bool recvTimingSnoopResp(PacketPtr pkt);
236 unsigned deviceBlockSizeMaster();
238 unsigned deviceBlockSizeSlave();
240 virtual AddrRangeList getAddrRanges() const = 0;
242 bool isSnooping() const;
244 void recvRetryMaster();
246 void recvRetrySlave();
248 void recvRangeChange();
252 * Range address mapper that maps a set of original ranges to a set of
253 * remapped ranges, where a specific range is of the same size
254 * (original and remapped), only with an offset. It's useful for cases
255 * where memory is mapped to two different locations
257 class RangeAddrMapper : public AddrMapper
262 RangeAddrMapper(const RangeAddrMapperParams* p);
264 ~RangeAddrMapper() { }
266 AddrRangeList getAddrRanges() const;
271 * This contains a list of ranges the should be remapped. It must
272 * be the exact same length as remappedRanges which describes what
273 * manipulation should be done to each range.
275 std::vector<AddrRange> originalRanges;
278 * This contains a list of ranges that addresses should be
279 * remapped to. See the description for originalRanges above
281 std::vector<AddrRange> remappedRanges;
283 Addr remapAddr(Addr addr) const;
287 #endif //__MEM_ADDR_MAPPER_HH__