1/*
2 * Copyright (c) 2010 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) 2002-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: Ali Saidi
41 */
42
43#ifndef __ARCH_ARM_PAGETABLE_H__
44#define __ARCH_ARM_PAGETABLE_H__
45
46#include "arch/arm/isa_traits.hh"
47#include "arch/arm/utility.hh"
48#include "arch/arm/vtophys.hh"
49#include "sim/serialize.hh"
50
51namespace ArmISA {
52
53struct VAddr
54{
55 VAddr(Addr a) { panic("not implemented yet."); }
56};
57
58
59// ITB/DTB page table entry
60struct PTE
61{
62 void serialize(std::ostream &os)
63 {
64 panic("Need to implement PTE serialization\n");
65 }
66
67 void unserialize(Checkpoint *cp, const std::string &section)
68 {
69 panic("Need to implement PTE serialization\n");
70 }
71
72};
73
74// ITB/DTB table entry
75struct TlbEntry
76{
77 public:
78 enum MemoryType {
79 StronglyOrdered,
80 Device,
81 Normal
82 };
83 enum DomainType {
84 DomainNoAccess = 0,
85 DomainClient,
86 DomainReserved,
87 DomainManager
88 };
89
90 // Matching variables
91 Addr pfn;
92 Addr size; // Size of this entry, == Type of TLB Rec
93 Addr vpn; // Virtual Page Number
94 uint32_t asid; // Address Space Identifier
95 uint8_t N; // Number of bits in pagesize
96 bool global;
97 bool valid;
98
99 // Type of memory
100 bool nonCacheable; // Can we wrap this in mtype?
101 bool sNp; // Section descriptor
102
103 // Memory Attributes
104 MemoryType mtype;
105 uint8_t innerAttrs;
106 uint8_t outerAttrs;
107 bool shareable;
108 uint32_t attributes; // Memory attributes formatted for PAR
109
110
111 // Access permissions
112 bool xn; // Execute Never
113 uint8_t ap; // Access permissions bits
114 uint8_t domain; // Access Domain
115
116 //Construct an entry that maps to physical address addr for SE mode
117 TlbEntry(Addr _asn, Addr _vaddr, Addr _paddr)
118 {
119 pfn = _paddr >> PageShift;
120 size = PageBytes - 1;
121 asid = _asn;
122 global = false;
123 valid = true;
124
125 vpn = _vaddr >> PageShift;
126
127 nonCacheable = sNp = false;
128
129 xn = 0;
130 ap = 0; // ???
131 domain = DomainClient; //???
132 }
133
134 TlbEntry()
135 {}
136
137 void
138 updateVaddr(Addr new_vaddr)
139 {
140 vpn = new_vaddr >> PageShift;
141 }
142
143 Addr
144 pageStart()
145 {
146 return pfn << PageShift;
147 }
148
149 bool
150 match(Addr va, uint8_t cid)
151 {
152 Addr v = vpn << N;
153 if (valid && va >= v && va <= v + size && (global || cid == asid))
154 return true;
155 return false;
156 }
157
158 Addr
159 pAddr(Addr va)
160 {
161 return (pfn << N) | (va & size);
162 }
163
164 void
165 serialize(std::ostream &os)
166 {
167 SERIALIZE_SCALAR(pfn);
168 SERIALIZE_SCALAR(size);
169 SERIALIZE_SCALAR(vpn);
170 SERIALIZE_SCALAR(asid);
171 SERIALIZE_SCALAR(N);
172 SERIALIZE_SCALAR(global);
173 SERIALIZE_SCALAR(valid);
174 SERIALIZE_SCALAR(nonCacheable);
175 SERIALIZE_SCALAR(sNp);
176 SERIALIZE_ENUM(mtype);
177 SERIALIZE_SCALAR(innerAttrs);
178 SERIALIZE_SCALAR(outerAttrs);
179 SERIALIZE_SCALAR(shareable);
180 SERIALIZE_SCALAR(attributes);
181 SERIALIZE_SCALAR(xn);
182 SERIALIZE_SCALAR(ap);
183 SERIALIZE_SCALAR(domain);
184 }
185 void
186 unserialize(Checkpoint *cp, const std::string &section)
187 {
188 UNSERIALIZE_SCALAR(pfn);
189 UNSERIALIZE_SCALAR(size);
190 UNSERIALIZE_SCALAR(vpn);
191 UNSERIALIZE_SCALAR(asid);
192 UNSERIALIZE_SCALAR(N);
193 UNSERIALIZE_SCALAR(global);
194 UNSERIALIZE_SCALAR(valid);
195 UNSERIALIZE_SCALAR(nonCacheable);
196 UNSERIALIZE_SCALAR(sNp);
197 UNSERIALIZE_ENUM(mtype);
198 UNSERIALIZE_SCALAR(innerAttrs);
199 UNSERIALIZE_SCALAR(outerAttrs);
200 UNSERIALIZE_SCALAR(shareable);
201 UNSERIALIZE_SCALAR(attributes);
202 UNSERIALIZE_SCALAR(xn);
203 UNSERIALIZE_SCALAR(ap);
204 UNSERIALIZE_SCALAR(domain);
205 }
206
207};
208
209
210
211}
212#endif // __ARCH_ARM_PAGETABLE_H__
213