physical.hh revision 8931 
1/*
2 * Copyright (c) 2012 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 * 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.
24 *
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.
36 *
37 * Authors: Andreas Hansson
38 */
39
40#ifndef __PHYSICAL_MEMORY_HH__
41#define __PHYSICAL_MEMORY_HH__
42
43#include "base/range_map.hh"
44#include "mem/abstract_mem.hh"
45#include "mem/packet.hh"
46
47/**
48 * The physical memory encapsulates all memories in the system and
49 * provides basic functionality for accessing those memories without
50 * going through the memory system and interconnect.
51 */
52class PhysicalMemory
53{
54
55  private:
56
57    // Global address map
58    range_map<Addr, AbstractMemory* > addrMap;
59
60    // a mutable cache for the last range that matched an address
61    mutable Range<Addr> rangeCache;
62
63    // All address-mapped memories
64    std::vector<AbstractMemory*> memories;
65
66    // The total memory size
67    uint64_t size;
68
69    // Prevent copying
70    PhysicalMemory(const PhysicalMemory&);
71
72    // Prevent assignment
73    PhysicalMemory& operator=(const PhysicalMemory&);
74
75  public:
76
77    /**
78     * Create a physical memory object, wrapping a number of memories.
79     */
80    PhysicalMemory(const std::vector<AbstractMemory*>& _memories);
81
82    /**
83     * Nothing to destruct.
84     */
85    ~PhysicalMemory() { }
86
87    /**
88     * Check if a physical address is within a range of a memory that
89     * is part of the global address map.
90     *
91     * @param addr A physical address
92     * @return Whether the address corresponds to a memory
93     */
94    bool isMemAddr(Addr addr) const;
95
96    /**
97     * Get the memory ranges for all memories that are to be reported
98     * to the configuration table.
99     *
100     * @return All configuration table memory ranges
101     */
102    AddrRangeList getConfAddrRanges() const;
103
104    /**
105     * Get the total physical memory size.
106     *
107     * @return The sum of all memory sizes
108     */
109    uint64_t totalSize() const { return size; }
110
111    /**
112     *
113     */
114    void access(PacketPtr pkt);
115    void functionalAccess(PacketPtr pkt);
116};
117
118
119
120
121#endif //__PHYSICAL_MEMORY_HH__
122