addr_mapper.hh revision 9542
19259SAli.Saidi@ARM.com/* 29259SAli.Saidi@ARM.com * Copyright (c) 2012 ARM Limited 39259SAli.Saidi@ARM.com * All rights reserved 49259SAli.Saidi@ARM.com * 59259SAli.Saidi@ARM.com * The license below extends only to copyright in the software and shall 69259SAli.Saidi@ARM.com * not be construed as granting a license to any other intellectual 79259SAli.Saidi@ARM.com * property including but not limited to intellectual property relating 89259SAli.Saidi@ARM.com * to a hardware implementation of the functionality of the software 99259SAli.Saidi@ARM.com * licensed hereunder. You may use the software subject to the license 109259SAli.Saidi@ARM.com * terms below provided that you ensure that this notice is replicated 119259SAli.Saidi@ARM.com * unmodified and in its entirety in all distributions of the software, 129259SAli.Saidi@ARM.com * modified or unmodified, in source code or in binary form. 139259SAli.Saidi@ARM.com * 149259SAli.Saidi@ARM.com * Redistribution and use in source and binary forms, with or without 159259SAli.Saidi@ARM.com * modification, are permitted provided that the following conditions are 169259SAli.Saidi@ARM.com * met: redistributions of source code must retain the above copyright 179259SAli.Saidi@ARM.com * notice, this list of conditions and the following disclaimer; 189259SAli.Saidi@ARM.com * redistributions in binary form must reproduce the above copyright 199259SAli.Saidi@ARM.com * notice, this list of conditions and the following disclaimer in the 209259SAli.Saidi@ARM.com * documentation and/or other materials provided with the distribution; 219259SAli.Saidi@ARM.com * neither the name of the copyright holders nor the names of its 229259SAli.Saidi@ARM.com * contributors may be used to endorse or promote products derived from 239259SAli.Saidi@ARM.com * this software without specific prior written permission. 249259SAli.Saidi@ARM.com * 259259SAli.Saidi@ARM.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 269259SAli.Saidi@ARM.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 279259SAli.Saidi@ARM.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 289259SAli.Saidi@ARM.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 299259SAli.Saidi@ARM.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 309259SAli.Saidi@ARM.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 319259SAli.Saidi@ARM.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 329259SAli.Saidi@ARM.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 339259SAli.Saidi@ARM.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 349259SAli.Saidi@ARM.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 359259SAli.Saidi@ARM.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 369259SAli.Saidi@ARM.com * 379259SAli.Saidi@ARM.com * Authors: Andreas Hansson 389259SAli.Saidi@ARM.com */ 399259SAli.Saidi@ARM.com 409259SAli.Saidi@ARM.com#ifndef __MEM_ADDR_MAPPER_HH__ 419259SAli.Saidi@ARM.com#define __MEM_ADDR_MAPPER_HH__ 429259SAli.Saidi@ARM.com 439259SAli.Saidi@ARM.com#include "mem/mem_object.hh" 449259SAli.Saidi@ARM.com#include "params/AddrMapper.hh" 459259SAli.Saidi@ARM.com#include "params/RangeAddrMapper.hh" 469259SAli.Saidi@ARM.com 479259SAli.Saidi@ARM.com/** 489259SAli.Saidi@ARM.com * An address mapper changes the packet addresses in going from the 499259SAli.Saidi@ARM.com * slave port side of the mapper to the master port side. When the 509259SAli.Saidi@ARM.com * slave port is queried for the address ranges, it also performs the 519259SAli.Saidi@ARM.com * necessary range updates. Note that snoop requests that travel from 529259SAli.Saidi@ARM.com * the master port (i.e. the memory side) to the slave port are 539259SAli.Saidi@ARM.com * currently not modified. 549259SAli.Saidi@ARM.com */ 559259SAli.Saidi@ARM.com 569259SAli.Saidi@ARM.comclass AddrMapper : public MemObject 579259SAli.Saidi@ARM.com{ 589259SAli.Saidi@ARM.com 599259SAli.Saidi@ARM.com public: 609259SAli.Saidi@ARM.com 619259SAli.Saidi@ARM.com AddrMapper(const AddrMapperParams* params); 629259SAli.Saidi@ARM.com 639259SAli.Saidi@ARM.com virtual ~AddrMapper() { } 649259SAli.Saidi@ARM.com 659294Sandreas.hansson@arm.com virtual BaseMasterPort& getMasterPort(const std::string& if_name, 669294Sandreas.hansson@arm.com PortID idx = InvalidPortID); 679259SAli.Saidi@ARM.com 689294Sandreas.hansson@arm.com virtual BaseSlavePort& getSlavePort(const std::string& if_name, 699294Sandreas.hansson@arm.com PortID idx = InvalidPortID); 709259SAli.Saidi@ARM.com 719259SAli.Saidi@ARM.com virtual void init(); 729259SAli.Saidi@ARM.com 739259SAli.Saidi@ARM.com protected: 749259SAli.Saidi@ARM.com 759259SAli.Saidi@ARM.com /** 769259SAli.Saidi@ARM.com * This function does the actual remapping of one address to another. 779259SAli.Saidi@ARM.com * It is pure virtual in this case to to allow any implementation 789259SAli.Saidi@ARM.com * required. 799259SAli.Saidi@ARM.com * @param addr the address to remap 809259SAli.Saidi@ARM.com * @return the new address (can be unchanged) 819259SAli.Saidi@ARM.com */ 829259SAli.Saidi@ARM.com virtual Addr remapAddr(Addr addr) const = 0; 839259SAli.Saidi@ARM.com 849259SAli.Saidi@ARM.com class AddrMapperSenderState : public Packet::SenderState 859259SAli.Saidi@ARM.com { 869259SAli.Saidi@ARM.com 879259SAli.Saidi@ARM.com public: 889259SAli.Saidi@ARM.com 899259SAli.Saidi@ARM.com /** 909542Sandreas.hansson@arm.com * Construct a new sender state to remember the original address. 919259SAli.Saidi@ARM.com * 929259SAli.Saidi@ARM.com * @param _origAddr Address before remapping 939259SAli.Saidi@ARM.com */ 949542Sandreas.hansson@arm.com AddrMapperSenderState(Addr _origAddr) : origAddr(_origAddr) 959259SAli.Saidi@ARM.com { } 969259SAli.Saidi@ARM.com 979259SAli.Saidi@ARM.com /** Destructor */ 989259SAli.Saidi@ARM.com ~AddrMapperSenderState() { } 999259SAli.Saidi@ARM.com 1009259SAli.Saidi@ARM.com /** The original address the packet was destined for */ 1019259SAli.Saidi@ARM.com Addr origAddr; 1029259SAli.Saidi@ARM.com 1039259SAli.Saidi@ARM.com }; 1049259SAli.Saidi@ARM.com 1059259SAli.Saidi@ARM.com class MapperMasterPort : public MasterPort 1069259SAli.Saidi@ARM.com { 1079259SAli.Saidi@ARM.com 1089259SAli.Saidi@ARM.com public: 1099259SAli.Saidi@ARM.com 1109259SAli.Saidi@ARM.com MapperMasterPort(const std::string& _name, AddrMapper& _mapper) 1119259SAli.Saidi@ARM.com : MasterPort(_name, &_mapper), mapper(_mapper) 1129259SAli.Saidi@ARM.com { } 1139259SAli.Saidi@ARM.com 1149259SAli.Saidi@ARM.com protected: 1159259SAli.Saidi@ARM.com 1169259SAli.Saidi@ARM.com void recvFunctionalSnoop(PacketPtr pkt) 1179259SAli.Saidi@ARM.com { 1189259SAli.Saidi@ARM.com mapper.recvFunctionalSnoop(pkt); 1199259SAli.Saidi@ARM.com } 1209259SAli.Saidi@ARM.com 1219259SAli.Saidi@ARM.com Tick recvAtomicSnoop(PacketPtr pkt) 1229259SAli.Saidi@ARM.com { 1239259SAli.Saidi@ARM.com return mapper.recvAtomicSnoop(pkt); 1249259SAli.Saidi@ARM.com } 1259259SAli.Saidi@ARM.com 1269259SAli.Saidi@ARM.com bool recvTimingResp(PacketPtr pkt) 1279259SAli.Saidi@ARM.com { 1289259SAli.Saidi@ARM.com return mapper.recvTimingResp(pkt); 1299259SAli.Saidi@ARM.com } 1309259SAli.Saidi@ARM.com 1319259SAli.Saidi@ARM.com void recvTimingSnoopReq(PacketPtr pkt) 1329259SAli.Saidi@ARM.com { 1339259SAli.Saidi@ARM.com mapper.recvTimingSnoopReq(pkt); 1349259SAli.Saidi@ARM.com } 1359259SAli.Saidi@ARM.com 1369259SAli.Saidi@ARM.com void recvRangeChange() 1379259SAli.Saidi@ARM.com { 1389259SAli.Saidi@ARM.com mapper.recvRangeChange(); 1399259SAli.Saidi@ARM.com } 1409259SAli.Saidi@ARM.com 1419259SAli.Saidi@ARM.com bool isSnooping() const 1429259SAli.Saidi@ARM.com { 1439259SAli.Saidi@ARM.com return mapper.isSnooping(); 1449259SAli.Saidi@ARM.com } 1459259SAli.Saidi@ARM.com 1469259SAli.Saidi@ARM.com unsigned deviceBlockSize() const 1479259SAli.Saidi@ARM.com { 1489259SAli.Saidi@ARM.com return mapper.deviceBlockSizeMaster(); 1499259SAli.Saidi@ARM.com } 1509259SAli.Saidi@ARM.com 1519259SAli.Saidi@ARM.com void recvRetry() 1529259SAli.Saidi@ARM.com { 1539259SAli.Saidi@ARM.com mapper.recvRetryMaster(); 1549259SAli.Saidi@ARM.com } 1559259SAli.Saidi@ARM.com 1569259SAli.Saidi@ARM.com private: 1579259SAli.Saidi@ARM.com 1589259SAli.Saidi@ARM.com AddrMapper& mapper; 1599259SAli.Saidi@ARM.com 1609259SAli.Saidi@ARM.com }; 1619259SAli.Saidi@ARM.com 1629259SAli.Saidi@ARM.com /** Instance of master port, facing the memory side */ 1639259SAli.Saidi@ARM.com MapperMasterPort masterPort; 1649259SAli.Saidi@ARM.com 1659259SAli.Saidi@ARM.com class MapperSlavePort : public SlavePort 1669259SAli.Saidi@ARM.com { 1679259SAli.Saidi@ARM.com 1689259SAli.Saidi@ARM.com public: 1699259SAli.Saidi@ARM.com 1709259SAli.Saidi@ARM.com MapperSlavePort(const std::string& _name, AddrMapper& _mapper) 1719259SAli.Saidi@ARM.com : SlavePort(_name, &_mapper), mapper(_mapper) 1729259SAli.Saidi@ARM.com { } 1739259SAli.Saidi@ARM.com 1749259SAli.Saidi@ARM.com protected: 1759259SAli.Saidi@ARM.com 1769259SAli.Saidi@ARM.com void recvFunctional(PacketPtr pkt) 1779259SAli.Saidi@ARM.com { 1789259SAli.Saidi@ARM.com mapper.recvFunctional(pkt); 1799259SAli.Saidi@ARM.com } 1809259SAli.Saidi@ARM.com 1819259SAli.Saidi@ARM.com Tick recvAtomic(PacketPtr pkt) 1829259SAli.Saidi@ARM.com { 1839259SAli.Saidi@ARM.com return mapper.recvAtomic(pkt); 1849259SAli.Saidi@ARM.com } 1859259SAli.Saidi@ARM.com 1869259SAli.Saidi@ARM.com bool recvTimingReq(PacketPtr pkt) 1879259SAli.Saidi@ARM.com { 1889259SAli.Saidi@ARM.com return mapper.recvTimingReq(pkt); 1899259SAli.Saidi@ARM.com } 1909259SAli.Saidi@ARM.com 1919259SAli.Saidi@ARM.com bool recvTimingSnoopResp(PacketPtr pkt) 1929259SAli.Saidi@ARM.com { 1939259SAli.Saidi@ARM.com return mapper.recvTimingSnoopResp(pkt); 1949259SAli.Saidi@ARM.com } 1959259SAli.Saidi@ARM.com 1969259SAli.Saidi@ARM.com unsigned deviceBlockSize() const 1979259SAli.Saidi@ARM.com { 1989259SAli.Saidi@ARM.com return mapper.deviceBlockSizeSlave(); 1999259SAli.Saidi@ARM.com } 2009259SAli.Saidi@ARM.com 2019259SAli.Saidi@ARM.com AddrRangeList getAddrRanges() const 2029259SAli.Saidi@ARM.com { 2039259SAli.Saidi@ARM.com return mapper.getAddrRanges(); 2049259SAli.Saidi@ARM.com } 2059259SAli.Saidi@ARM.com 2069259SAli.Saidi@ARM.com void recvRetry() 2079259SAli.Saidi@ARM.com { 2089259SAli.Saidi@ARM.com mapper.recvRetrySlave(); 2099259SAli.Saidi@ARM.com } 2109259SAli.Saidi@ARM.com 2119259SAli.Saidi@ARM.com private: 2129259SAli.Saidi@ARM.com 2139259SAli.Saidi@ARM.com AddrMapper& mapper; 2149259SAli.Saidi@ARM.com 2159259SAli.Saidi@ARM.com }; 2169259SAli.Saidi@ARM.com 2179259SAli.Saidi@ARM.com /** Instance of slave port, i.e. on the CPU side */ 2189259SAli.Saidi@ARM.com MapperSlavePort slavePort; 2199259SAli.Saidi@ARM.com 2209259SAli.Saidi@ARM.com void recvFunctional(PacketPtr pkt); 2219259SAli.Saidi@ARM.com 2229259SAli.Saidi@ARM.com void recvFunctionalSnoop(PacketPtr pkt); 2239259SAli.Saidi@ARM.com 2249259SAli.Saidi@ARM.com Tick recvAtomic(PacketPtr pkt); 2259259SAli.Saidi@ARM.com 2269259SAli.Saidi@ARM.com Tick recvAtomicSnoop(PacketPtr pkt); 2279259SAli.Saidi@ARM.com 2289259SAli.Saidi@ARM.com bool recvTimingReq(PacketPtr pkt); 2299259SAli.Saidi@ARM.com 2309259SAli.Saidi@ARM.com bool recvTimingResp(PacketPtr pkt); 2319259SAli.Saidi@ARM.com 2329259SAli.Saidi@ARM.com void recvTimingSnoopReq(PacketPtr pkt); 2339259SAli.Saidi@ARM.com 2349259SAli.Saidi@ARM.com bool recvTimingSnoopResp(PacketPtr pkt); 2359259SAli.Saidi@ARM.com 2369259SAli.Saidi@ARM.com unsigned deviceBlockSizeMaster(); 2379259SAli.Saidi@ARM.com 2389259SAli.Saidi@ARM.com unsigned deviceBlockSizeSlave(); 2399259SAli.Saidi@ARM.com 2409259SAli.Saidi@ARM.com virtual AddrRangeList getAddrRanges() const = 0; 2419259SAli.Saidi@ARM.com 2429259SAli.Saidi@ARM.com bool isSnooping() const; 2439259SAli.Saidi@ARM.com 2449259SAli.Saidi@ARM.com void recvRetryMaster(); 2459259SAli.Saidi@ARM.com 2469259SAli.Saidi@ARM.com void recvRetrySlave(); 2479259SAli.Saidi@ARM.com 2489259SAli.Saidi@ARM.com void recvRangeChange(); 2499259SAli.Saidi@ARM.com}; 2509259SAli.Saidi@ARM.com 2519259SAli.Saidi@ARM.com/** 2529259SAli.Saidi@ARM.com * Range address mapper that maps a set of original ranges to a set of 2539259SAli.Saidi@ARM.com * remapped ranges, where a specific range is of the same size 2549259SAli.Saidi@ARM.com * (original and remapped), only with an offset. It's useful for cases 2559259SAli.Saidi@ARM.com * where memory is mapped to two different locations 2569259SAli.Saidi@ARM.com */ 2579259SAli.Saidi@ARM.comclass RangeAddrMapper : public AddrMapper 2589259SAli.Saidi@ARM.com{ 2599259SAli.Saidi@ARM.com 2609259SAli.Saidi@ARM.com public: 2619259SAli.Saidi@ARM.com 2629259SAli.Saidi@ARM.com RangeAddrMapper(const RangeAddrMapperParams* p); 2639259SAli.Saidi@ARM.com 2649259SAli.Saidi@ARM.com ~RangeAddrMapper() { } 2659259SAli.Saidi@ARM.com 2669259SAli.Saidi@ARM.com AddrRangeList getAddrRanges() const; 2679259SAli.Saidi@ARM.com 2689259SAli.Saidi@ARM.com protected: 2699259SAli.Saidi@ARM.com 2709259SAli.Saidi@ARM.com /** 2719259SAli.Saidi@ARM.com * This contains a list of ranges the should be remapped. It must 2729259SAli.Saidi@ARM.com * be the exact same length as remappedRanges which describes what 2739259SAli.Saidi@ARM.com * manipulation should be done to each range. 2749259SAli.Saidi@ARM.com */ 2759259SAli.Saidi@ARM.com std::vector<AddrRange> originalRanges; 2769259SAli.Saidi@ARM.com 2779259SAli.Saidi@ARM.com /** 2789259SAli.Saidi@ARM.com * This contains a list of ranges that addresses should be 2799259SAli.Saidi@ARM.com * remapped to. See the description for originalRanges above 2809259SAli.Saidi@ARM.com */ 2819259SAli.Saidi@ARM.com std::vector<AddrRange> remappedRanges; 2829259SAli.Saidi@ARM.com 2839259SAli.Saidi@ARM.com Addr remapAddr(Addr addr) const; 2849259SAli.Saidi@ARM.com 2859259SAli.Saidi@ARM.com}; 2869259SAli.Saidi@ARM.com 2879259SAli.Saidi@ARM.com#endif //__MEM_ADDR_MAPPER_HH__ 288