2 * Copyright (c) 2011-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
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"
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 void blobHelper(Addr addr, uint8_t *p, int size, MemCmd cmd) const;
94 PortProxy(MasterPort &port) : _port(port) { }
95 virtual ~PortProxy() { }
98 * Read size bytes memory at address and store in p.
100 virtual void readBlob(Addr addr, uint8_t* p, int size) const
101 { blobHelper(addr, p, size, MemCmd::ReadReq); }
104 * Write size bytes from p to address.
106 virtual void writeBlob(Addr addr, uint8_t* p, int size) const
107 { blobHelper(addr, p, size, MemCmd::WriteReq); }
110 * Fill size bytes starting at addr with byte value val.
112 virtual void memsetBlob(Addr addr, uint8_t v, int size) const;
115 * Read sizeof(T) bytes from address and return as object T.
117 template <typename T>
118 T read(Addr address) const;
121 * Write object T to address. Writes sizeof(T) bytes.
123 template <typename T>
124 void write(Addr address, T data) const;
126 #if THE_ISA != NO_ISA
128 * Read sizeof(T) bytes from address and return as object T.
129 * Performs Guest to Host endianness transform.
131 template <typename T>
132 T readGtoH(Addr address) const;
135 * Write object T to address. Writes sizeof(T) bytes.
136 * Performs Host to Guest endianness transform.
138 template <typename T>
139 void writeHtoG(Addr address, T data) const;
144 template <typename T>
146 PortProxy::read(Addr address) const
149 readBlob(address, (uint8_t*)&data, sizeof(T));
153 template <typename T>
155 PortProxy::write(Addr address, T data) const
157 writeBlob(address, (uint8_t*)&data, sizeof(T));
160 #if THE_ISA != NO_ISA
161 template <typename T>
163 PortProxy::readGtoH(Addr address) const
166 readBlob(address, (uint8_t*)&data, sizeof(T));
167 return TheISA::gtoh(data);
170 template <typename T>
172 PortProxy::writeHtoG(Addr address, T data) const
174 data = TheISA::htog(data);
175 writeBlob(address, (uint8_t*)&data, sizeof(T));
179 #endif // __MEM_PORT_PROXY_HH__