2 * Copyright (c) 2011-2013, 2018 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
42 * PortProxy Object Declaration.
44 * Port proxies are used when non-structural entities need access to
45 * the memory system (or structural entities that want to peak into
46 * the memory system without making a real memory access).
48 * Proxy objects replace the previous FunctionalPort, TranslatingPort
49 * and VirtualPort objects, which provided the same functionality as
50 * the proxies, but were instances of ports not corresponding to real
51 * structural ports of the simulated system. Via the port proxies all
52 * the accesses go through an actual port (either the system port,
53 * e.g. for processes or initialisation, or a the data port of the
54 * CPU, e.g. for threads) and thus are transparent to a potentially
55 * distributed memory and automatically adhere to the memory map of
59 #ifndef __MEM_PORT_PROXY_HH__
60 #define __MEM_PORT_PROXY_HH__
62 #include "config/the_isa.hh"
63 #if THE_ISA != NULL_ISA
64 #include "arch/isa_traits.hh"
67 #include "mem/port.hh"
68 #include "sim/byteswap.hh"
71 * This object is a proxy for a structural port, to be used for debug
74 * This proxy object is used when non structural entities
75 * (e.g. thread contexts, object file loaders) need access to the
76 * memory system. It calls the corresponding functions on the underlying
77 * structural port, and provides templatized convenience access functions.
79 * The addresses are interpreted as physical addresses.
81 * @sa SETranslatingProxy
82 * @sa FSTranslatingProxy
88 /** The actual physical port used by this proxy. */
91 /** Granularity of any transactions issued through this proxy. */
92 const unsigned int _cacheLineSize;
95 PortProxy(MasterPort &port, unsigned int cacheLineSize) :
96 _port(port), _cacheLineSize(cacheLineSize) { }
97 virtual ~PortProxy() { }
100 * Read size bytes memory at address and store in p.
102 virtual void readBlob(Addr addr, uint8_t* p, int size) const {
103 readBlobPhys(addr, 0, p, size);
107 * Write size bytes from p to address.
109 virtual void writeBlob(Addr addr, const uint8_t* p, int size) const {
110 writeBlobPhys(addr, 0, p, size);
114 * Fill size bytes starting at addr with byte value val.
116 virtual void memsetBlob(Addr addr, uint8_t v, int size) const {
117 memsetBlobPhys(addr, 0, v, size);
121 * Read size bytes memory at physical address and store in p.
123 void readBlobPhys(Addr addr, Request::Flags flags,
124 uint8_t* p, int size) const;
127 * Write size bytes from p to physical address.
129 void writeBlobPhys(Addr addr, Request::Flags flags,
130 const uint8_t* p, int size) const;
133 * Fill size bytes starting at physical addr with byte value val.
135 void memsetBlobPhys(Addr addr, Request::Flags flags,
136 uint8_t v, int size) const;
139 * Read sizeof(T) bytes from address and return as object T.
141 template <typename T>
142 T read(Addr address) const;
145 * Write object T to address. Writes sizeof(T) bytes.
147 template <typename T>
148 void write(Addr address, T data) const;
151 * Read sizeof(T) bytes from address and return as object T.
152 * Performs selected endianness transform.
154 template <typename T>
155 T readGtoH(Addr address, ByteOrder guest_byte_order) const;
158 * Write object T to address. Writes sizeof(T) bytes.
159 * Performs selected endianness transform.
161 template <typename T>
162 void writeHtoG(Addr address, T data, ByteOrder guest_byte_order) const;
164 #if THE_ISA != NULL_ISA
166 * Read sizeof(T) bytes from address and return as object T.
167 * Performs Guest to Host endianness transform.
169 template <typename T>
170 T readGtoH(Addr address) const;
173 * Write object T to address. Writes sizeof(T) bytes.
174 * Performs Host to Guest endianness transform.
176 template <typename T>
177 void writeHtoG(Addr address, T data) const;
183 * This object is a proxy for a structural port, to be used for debug
184 * accesses to secure memory.
186 * The addresses are interpreted as physical addresses to secure memory.
188 class SecurePortProxy : public PortProxy
191 SecurePortProxy(MasterPort &port, unsigned int cache_line_size)
192 : PortProxy(port, cache_line_size) {}
194 void readBlob(Addr addr, uint8_t *p, int size) const override;
195 void writeBlob(Addr addr, const uint8_t *p, int size) const override;
196 void memsetBlob(Addr addr, uint8_t val, int size) const override;
199 template <typename T>
201 PortProxy::read(Addr address) const
204 readBlob(address, (uint8_t*)&data, sizeof(T));
208 template <typename T>
210 PortProxy::write(Addr address, T data) const
212 writeBlob(address, (uint8_t*)&data, sizeof(T));
215 template <typename T>
217 PortProxy::readGtoH(Addr address, ByteOrder byte_order) const
220 readBlob(address, (uint8_t*)&data, sizeof(T));
221 return gtoh(data, byte_order);
224 template <typename T>
226 PortProxy::writeHtoG(Addr address, T data, ByteOrder byte_order) const
228 data = htog(data, byte_order);
229 writeBlob(address, (uint8_t*)&data, sizeof(T));
232 #if THE_ISA != NULL_ISA
233 template <typename T>
235 PortProxy::readGtoH(Addr address) const
238 readBlob(address, (uint8_t*)&data, sizeof(T));
239 return TheISA::gtoh(data);
242 template <typename T>
244 PortProxy::writeHtoG(Addr address, T data) const
246 data = TheISA::htog(data);
247 writeBlob(address, (uint8_t*)&data, sizeof(T));
251 #endif // __MEM_PORT_PROXY_HH__