1/*
2 * Copyright (c) 2011 ARM Limited
3 * All rights reserved
4 *
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.
13 *
14 * Copyright (c) 2001-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Ron Dreslinski
41 *          Ali Saidi
42 *          Andreas Hansson
43 */
44
45#ifndef __MEM_SE_TRANSLATING_PORT_PROXY_HH__
46#define __MEM_SE_TRANSLATING_PORT_PROXY_HH__
47
48#include "mem/port_proxy.hh"
49
50class EmulationPageTable;
51class Process;
52
53/**
54 * @file
55 * TranslatingPortProxy Object Declaration for SE.
56 *
57 * Port proxies are used when non structural entities need access to
58 * the memory system. Proxy objects replace the previous
59 * FunctionalPort, TranslatingPort and VirtualPort objects, which
60 * provided the same functionality as the proxies, but were instances
61 * of ports not corresponding to real structural ports of the
62 * simulated system. Via the port proxies all the accesses go through
63 * an actual port and thus are transparent to a potentially
64 * distributed memory and automatically adhere to the memory map of
65 * the system.
66 */
67class SETranslatingPortProxy : public PortProxy
68{
69
70  public:
71    enum AllocType {
72        Always,
73        Never,
74        NextPage
75    };
76
77  private:
78    EmulationPageTable *pTable;
79    Process *process;
80    AllocType allocating;
81
82  public:
83    SETranslatingPortProxy(SendFunctionalFunc func,
84                           Process* p, AllocType alloc);
85    SETranslatingPortProxy(MasterPort &port, Process* p, AllocType alloc);
86    ~SETranslatingPortProxy() {}
87
88    void setPageTable(EmulationPageTable *p) { pTable = p; }
89    void setProcess(Process *p) { process = p; }
90    bool tryReadBlob(Addr addr, void *p, int size) const override;
91    bool tryWriteBlob(Addr addr, const void *p, int size) const override;
92    bool tryMemsetBlob(Addr addr, uint8_t val, int size) const override;
93};
94
95#endif // __MEM_SE_TRANSLATING_PORT_PROXY_HH__
96