port_proxy.hh revision 13893
18706Sandreas.hansson@arm.com/* 212522Sandreas.sandberg@arm.com * Copyright (c) 2011-2013, 2018 ARM Limited 38706Sandreas.hansson@arm.com * All rights reserved 48706Sandreas.hansson@arm.com * 58706Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 68706Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 78706Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 88706Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 98706Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 108706Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 118706Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 128706Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 138706Sandreas.hansson@arm.com * 148706Sandreas.hansson@arm.com * Redistribution and use in source and binary forms, with or without 158706Sandreas.hansson@arm.com * modification, are permitted provided that the following conditions are 168706Sandreas.hansson@arm.com * met: redistributions of source code must retain the above copyright 178706Sandreas.hansson@arm.com * notice, this list of conditions and the following disclaimer; 188706Sandreas.hansson@arm.com * redistributions in binary form must reproduce the above copyright 198706Sandreas.hansson@arm.com * notice, this list of conditions and the following disclaimer in the 208706Sandreas.hansson@arm.com * documentation and/or other materials provided with the distribution; 218706Sandreas.hansson@arm.com * neither the name of the copyright holders nor the names of its 228706Sandreas.hansson@arm.com * contributors may be used to endorse or promote products derived from 238706Sandreas.hansson@arm.com * this software without specific prior written permission. 248706Sandreas.hansson@arm.com * 258706Sandreas.hansson@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 268706Sandreas.hansson@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 278706Sandreas.hansson@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 288706Sandreas.hansson@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 298706Sandreas.hansson@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 308706Sandreas.hansson@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 318706Sandreas.hansson@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 328706Sandreas.hansson@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 338706Sandreas.hansson@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 348706Sandreas.hansson@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 358706Sandreas.hansson@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 368706Sandreas.hansson@arm.com * 378706Sandreas.hansson@arm.com * Authors: Andreas Hansson 388706Sandreas.hansson@arm.com */ 398706Sandreas.hansson@arm.com 408706Sandreas.hansson@arm.com/** 418706Sandreas.hansson@arm.com * @file 428706Sandreas.hansson@arm.com * PortProxy Object Declaration. 438706Sandreas.hansson@arm.com * 448853Sandreas.hansson@arm.com * Port proxies are used when non-structural entities need access to 458853Sandreas.hansson@arm.com * the memory system (or structural entities that want to peak into 468853Sandreas.hansson@arm.com * the memory system without making a real memory access). 478853Sandreas.hansson@arm.com * 488853Sandreas.hansson@arm.com * Proxy objects replace the previous FunctionalPort, TranslatingPort 498853Sandreas.hansson@arm.com * and VirtualPort objects, which provided the same functionality as 508853Sandreas.hansson@arm.com * the proxies, but were instances of ports not corresponding to real 518853Sandreas.hansson@arm.com * structural ports of the simulated system. Via the port proxies all 528853Sandreas.hansson@arm.com * the accesses go through an actual port (either the system port, 538853Sandreas.hansson@arm.com * e.g. for processes or initialisation, or a the data port of the 548853Sandreas.hansson@arm.com * CPU, e.g. for threads) and thus are transparent to a potentially 558706Sandreas.hansson@arm.com * distributed memory and automatically adhere to the memory map of 568706Sandreas.hansson@arm.com * the system. 578706Sandreas.hansson@arm.com */ 588706Sandreas.hansson@arm.com 598706Sandreas.hansson@arm.com#ifndef __MEM_PORT_PROXY_HH__ 608706Sandreas.hansson@arm.com#define __MEM_PORT_PROXY_HH__ 618706Sandreas.hansson@arm.com 628706Sandreas.hansson@arm.com#include "mem/port.hh" 638706Sandreas.hansson@arm.com#include "sim/byteswap.hh" 648706Sandreas.hansson@arm.com 658706Sandreas.hansson@arm.com/** 668853Sandreas.hansson@arm.com * This object is a proxy for a structural port, to be used for debug 678853Sandreas.hansson@arm.com * accesses. 688706Sandreas.hansson@arm.com * 698706Sandreas.hansson@arm.com * This proxy object is used when non structural entities 708706Sandreas.hansson@arm.com * (e.g. thread contexts, object file loaders) need access to the 718706Sandreas.hansson@arm.com * memory system. It calls the corresponding functions on the underlying 728706Sandreas.hansson@arm.com * structural port, and provides templatized convenience access functions. 738706Sandreas.hansson@arm.com * 748706Sandreas.hansson@arm.com * The addresses are interpreted as physical addresses. 758706Sandreas.hansson@arm.com * 768706Sandreas.hansson@arm.com * @sa SETranslatingProxy 778706Sandreas.hansson@arm.com * @sa FSTranslatingProxy 788706Sandreas.hansson@arm.com */ 798706Sandreas.hansson@arm.comclass PortProxy 808706Sandreas.hansson@arm.com{ 818853Sandreas.hansson@arm.com private: 828853Sandreas.hansson@arm.com 838853Sandreas.hansson@arm.com /** The actual physical port used by this proxy. */ 848922Swilliam.wang@arm.com MasterPort &_port; 858706Sandreas.hansson@arm.com 869814Sandreas.hansson@arm.com /** Granularity of any transactions issued through this proxy. */ 879814Sandreas.hansson@arm.com const unsigned int _cacheLineSize; 889814Sandreas.hansson@arm.com 898706Sandreas.hansson@arm.com public: 909814Sandreas.hansson@arm.com PortProxy(MasterPort &port, unsigned int cacheLineSize) : 9113893Sgabeblack@google.com _port(port), _cacheLineSize(cacheLineSize) 9213893Sgabeblack@google.com {} 938706Sandreas.hansson@arm.com virtual ~PortProxy() { } 948706Sandreas.hansson@arm.com 958706Sandreas.hansson@arm.com /** 968706Sandreas.hansson@arm.com * Read size bytes memory at address and store in p. 978706Sandreas.hansson@arm.com */ 9813893Sgabeblack@google.com virtual void 9913893Sgabeblack@google.com readBlob(Addr addr, uint8_t* p, int size) const 10013893Sgabeblack@google.com { 10112532Sandreas.sandberg@arm.com readBlobPhys(addr, 0, p, size); 10212532Sandreas.sandberg@arm.com } 1038706Sandreas.hansson@arm.com 1048706Sandreas.hansson@arm.com /** 1058706Sandreas.hansson@arm.com * Write size bytes from p to address. 1068706Sandreas.hansson@arm.com */ 10713893Sgabeblack@google.com virtual void 10813893Sgabeblack@google.com writeBlob(Addr addr, const uint8_t* p, int size) const 10913893Sgabeblack@google.com { 11012532Sandreas.sandberg@arm.com writeBlobPhys(addr, 0, p, size); 11112532Sandreas.sandberg@arm.com } 1128706Sandreas.hansson@arm.com 1138706Sandreas.hansson@arm.com /** 1148706Sandreas.hansson@arm.com * Fill size bytes starting at addr with byte value val. 1158706Sandreas.hansson@arm.com */ 11613893Sgabeblack@google.com virtual void 11713893Sgabeblack@google.com memsetBlob(Addr addr, uint8_t v, int size) const 11813893Sgabeblack@google.com { 11912532Sandreas.sandberg@arm.com memsetBlobPhys(addr, 0, v, size); 12012532Sandreas.sandberg@arm.com } 12112532Sandreas.sandberg@arm.com 12212532Sandreas.sandberg@arm.com /** 12312532Sandreas.sandberg@arm.com * Read size bytes memory at physical address and store in p. 12412532Sandreas.sandberg@arm.com */ 12512532Sandreas.sandberg@arm.com void readBlobPhys(Addr addr, Request::Flags flags, 12612532Sandreas.sandberg@arm.com uint8_t* p, int size) const; 12712532Sandreas.sandberg@arm.com 12812532Sandreas.sandberg@arm.com /** 12912532Sandreas.sandberg@arm.com * Write size bytes from p to physical address. 13012532Sandreas.sandberg@arm.com */ 13112532Sandreas.sandberg@arm.com void writeBlobPhys(Addr addr, Request::Flags flags, 13212532Sandreas.sandberg@arm.com const uint8_t* p, int size) const; 13312532Sandreas.sandberg@arm.com 13412532Sandreas.sandberg@arm.com /** 13512532Sandreas.sandberg@arm.com * Fill size bytes starting at physical addr with byte value val. 13612532Sandreas.sandberg@arm.com */ 13712532Sandreas.sandberg@arm.com void memsetBlobPhys(Addr addr, Request::Flags flags, 13812532Sandreas.sandberg@arm.com uint8_t v, int size) const; 1398706Sandreas.hansson@arm.com 1408706Sandreas.hansson@arm.com /** 1418706Sandreas.hansson@arm.com * Read sizeof(T) bytes from address and return as object T. 1428706Sandreas.hansson@arm.com */ 1438706Sandreas.hansson@arm.com template <typename T> 1448861Sandreas.hansson@arm.com T read(Addr address) const; 1458706Sandreas.hansson@arm.com 1468706Sandreas.hansson@arm.com /** 1478706Sandreas.hansson@arm.com * Write object T to address. Writes sizeof(T) bytes. 1488706Sandreas.hansson@arm.com */ 1498706Sandreas.hansson@arm.com template <typename T> 1508861Sandreas.hansson@arm.com void write(Addr address, T data) const; 1518706Sandreas.hansson@arm.com 15212522Sandreas.sandberg@arm.com /** 15312522Sandreas.sandberg@arm.com * Read sizeof(T) bytes from address and return as object T. 15413893Sgabeblack@google.com * Performs endianness conversion from the selected guest to host order. 15512522Sandreas.sandberg@arm.com */ 15612522Sandreas.sandberg@arm.com template <typename T> 15713893Sgabeblack@google.com T read(Addr address, ByteOrder guest_byte_order) const; 15812522Sandreas.sandberg@arm.com 15912522Sandreas.sandberg@arm.com /** 16012522Sandreas.sandberg@arm.com * Write object T to address. Writes sizeof(T) bytes. 16113893Sgabeblack@google.com * Performs endianness conversion from host to the selected guest order. 16212522Sandreas.sandberg@arm.com */ 16312522Sandreas.sandberg@arm.com template <typename T> 16413893Sgabeblack@google.com void write(Addr address, T data, ByteOrder guest_byte_order) const; 1658706Sandreas.hansson@arm.com}; 1668706Sandreas.hansson@arm.com 1678706Sandreas.hansson@arm.com 16812532Sandreas.sandberg@arm.com/** 16912532Sandreas.sandberg@arm.com * This object is a proxy for a structural port, to be used for debug 17012532Sandreas.sandberg@arm.com * accesses to secure memory. 17112532Sandreas.sandberg@arm.com * 17212532Sandreas.sandberg@arm.com * The addresses are interpreted as physical addresses to secure memory. 17312532Sandreas.sandberg@arm.com */ 17412532Sandreas.sandberg@arm.comclass SecurePortProxy : public PortProxy 17512532Sandreas.sandberg@arm.com{ 17612532Sandreas.sandberg@arm.com public: 17712532Sandreas.sandberg@arm.com SecurePortProxy(MasterPort &port, unsigned int cache_line_size) 17812532Sandreas.sandberg@arm.com : PortProxy(port, cache_line_size) {} 17912532Sandreas.sandberg@arm.com 18012532Sandreas.sandberg@arm.com void readBlob(Addr addr, uint8_t *p, int size) const override; 18112532Sandreas.sandberg@arm.com void writeBlob(Addr addr, const uint8_t *p, int size) const override; 18212532Sandreas.sandberg@arm.com void memsetBlob(Addr addr, uint8_t val, int size) const override; 18312532Sandreas.sandberg@arm.com}; 18412532Sandreas.sandberg@arm.com 1858706Sandreas.hansson@arm.comtemplate <typename T> 1868706Sandreas.hansson@arm.comT 1878861Sandreas.hansson@arm.comPortProxy::read(Addr address) const 1888706Sandreas.hansson@arm.com{ 1898706Sandreas.hansson@arm.com T data; 1908706Sandreas.hansson@arm.com readBlob(address, (uint8_t*)&data, sizeof(T)); 1918706Sandreas.hansson@arm.com return data; 1928706Sandreas.hansson@arm.com} 1938706Sandreas.hansson@arm.com 1948706Sandreas.hansson@arm.comtemplate <typename T> 1958706Sandreas.hansson@arm.comvoid 1968861Sandreas.hansson@arm.comPortProxy::write(Addr address, T data) const 1978706Sandreas.hansson@arm.com{ 1988706Sandreas.hansson@arm.com writeBlob(address, (uint8_t*)&data, sizeof(T)); 1998706Sandreas.hansson@arm.com} 2008706Sandreas.hansson@arm.com 20112522Sandreas.sandberg@arm.comtemplate <typename T> 20212522Sandreas.sandberg@arm.comT 20313893Sgabeblack@google.comPortProxy::read(Addr address, ByteOrder byte_order) const 20412522Sandreas.sandberg@arm.com{ 20512522Sandreas.sandberg@arm.com T data; 20612522Sandreas.sandberg@arm.com readBlob(address, (uint8_t*)&data, sizeof(T)); 20712522Sandreas.sandberg@arm.com return gtoh(data, byte_order); 20812522Sandreas.sandberg@arm.com} 20912522Sandreas.sandberg@arm.com 21012522Sandreas.sandberg@arm.comtemplate <typename T> 21112522Sandreas.sandberg@arm.comvoid 21213893Sgabeblack@google.comPortProxy::write(Addr address, T data, ByteOrder byte_order) const 21312522Sandreas.sandberg@arm.com{ 21412522Sandreas.sandberg@arm.com data = htog(data, byte_order); 21512522Sandreas.sandberg@arm.com writeBlob(address, (uint8_t*)&data, sizeof(T)); 21612522Sandreas.sandberg@arm.com} 21712522Sandreas.sandberg@arm.com 2188706Sandreas.hansson@arm.com#endif // __MEM_PORT_PROXY_HH__ 219