1/*
2 * Copyright (c) 2007 The Hewlett-Packard Development Company
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: Gabe Black
38 */
39
40#include "arch/x86/system.hh"
41
42#include "arch/vtophys.hh"
43#include "arch/x86/bios/intelmp.hh"
44#include "arch/x86/bios/smbios.hh"
42#include "arch/x86/regs/misc.hh"
45#include "arch/x86/isa_traits.hh"
44#include "arch/x86/system.hh"
45#include "arch/vtophys.hh"
46#include "arch/x86/regs/misc.hh"
47#include "base/intmath.hh"
48#include "base/loader/object_file.hh"
49#include "base/loader/symtab.hh"
48#include "base/intmath.hh"
50#include "base/trace.hh"
51#include "cpu/thread_context.hh"
52#include "mem/port_proxy.hh"
53#include "params/X86System.hh"
54#include "sim/byteswap.hh"
55
56using namespace LittleEndianGuest;
57using namespace X86ISA;
58
59X86System::X86System(Params *p) :
60 System(p), smbiosTable(p->smbios_table),
61 mpFloatingPointer(p->intel_mp_pointer),
62 mpConfigTable(p->intel_mp_table),
63 rsdp(p->acpi_description_table_pointer)
64{
65}
66
67void
68X86ISA::installSegDesc(ThreadContext *tc, SegmentRegIndex seg,
69 SegDescriptor desc, bool longmode)
70{
71 uint64_t base = desc.baseLow + (desc.baseHigh << 24);
72 bool honorBase = !longmode || seg == SEGMENT_REG_FS ||
73 seg == SEGMENT_REG_GS ||
74 seg == SEGMENT_REG_TSL ||
75 seg == SYS_SEGMENT_REG_TR;
76 uint64_t limit = desc.limitLow | (desc.limitHigh << 16);
77
78 SegAttr attr = 0;
79
80 attr.dpl = desc.dpl;
81 attr.unusable = 0;
82 attr.defaultSize = desc.d;
83 attr.longMode = desc.l;
84 attr.avl = desc.avl;
85 attr.granularity = desc.g;
86 attr.present = desc.p;
87 attr.system = desc.s;
88 attr.type = desc.type;
89 if (desc.s) {
90 if (desc.type.codeOrData) {
91 // Code segment
92 attr.expandDown = 0;
93 attr.readable = desc.type.r;
94 attr.writable = 0;
95 } else {
96 // Data segment
97 attr.expandDown = desc.type.e;
98 attr.readable = 1;
99 attr.writable = desc.type.w;
100 }
101 } else {
102 attr.readable = 1;
103 attr.writable = 1;
104 attr.expandDown = 0;
105 }
106
107 tc->setMiscReg(MISCREG_SEG_BASE(seg), base);
108 tc->setMiscReg(MISCREG_SEG_EFF_BASE(seg), honorBase ? base : 0);
109 tc->setMiscReg(MISCREG_SEG_LIMIT(seg), limit);
110 tc->setMiscReg(MISCREG_SEG_ATTR(seg), (MiscReg)attr);
111}
112
113void
114X86System::initState()
115{
116 System::initState();
117
118 if (!kernel)
119 fatal("No kernel to load.\n");
120
121 if (kernel->getArch() == ObjectFile::I386)
122 fatal("Loading a 32 bit x86 kernel is not supported.\n");
123
124 ThreadContext *tc = threadContexts[0];
125 // This is the boot strap processor (BSP). Initialize it to look like
126 // the boot loader has just turned control over to the 64 bit OS. We
127 // won't actually set up real mode or legacy protected mode descriptor
128 // tables because we aren't executing any code that would require
129 // them. We do, however toggle the control bits in the correct order
130 // while allowing consistency checks and the underlying mechansims
131 // just to be safe.
132
133 const int NumPDTs = 4;
134
135 const Addr PageMapLevel4 = 0x70000;
136 const Addr PageDirPtrTable = 0x71000;
137 const Addr PageDirTable[NumPDTs] =
138 {0x72000, 0x73000, 0x74000, 0x75000};
139 const Addr GDTBase = 0x76000;
140
141 const int PML4Bits = 9;
142 const int PDPTBits = 9;
143 const int PDTBits = 9;
144
145 /*
146 * Set up the gdt.
147 */
148 uint8_t numGDTEntries = 0;
149 // Place holder at selector 0
150 uint64_t nullDescriptor = 0;
151 physProxy.writeBlob(GDTBase + numGDTEntries * 8,
152 (uint8_t *)(&nullDescriptor), 8);
153 numGDTEntries++;
154
155 SegDescriptor initDesc = 0;
156 initDesc.type.codeOrData = 0; // code or data type
157 initDesc.type.c = 0; // conforming
158 initDesc.type.r = 1; // readable
159 initDesc.dpl = 0; // privilege
160 initDesc.p = 1; // present
161 initDesc.l = 1; // longmode - 64 bit
162 initDesc.d = 0; // operand size
163 initDesc.g = 1; // granularity
164 initDesc.s = 1; // system segment
165 initDesc.limitHigh = 0xFFFF;
166 initDesc.limitLow = 0xF;
167 initDesc.baseHigh = 0x0;
168 initDesc.baseLow = 0x0;
169
170 //64 bit code segment
171 SegDescriptor csDesc = initDesc;
172 csDesc.type.codeOrData = 1;
173 csDesc.dpl = 0;
174 //Because we're dealing with a pointer and I don't think it's
175 //guaranteed that there isn't anything in a nonvirtual class between
176 //it's beginning in memory and it's actual data, we'll use an
177 //intermediary.
178 uint64_t csDescVal = csDesc;
179 physProxy.writeBlob(GDTBase + numGDTEntries * 8,
180 (uint8_t *)(&csDescVal), 8);
181
182 numGDTEntries++;
183
184 SegSelector cs = 0;
185 cs.si = numGDTEntries - 1;
186
187 tc->setMiscReg(MISCREG_CS, (MiscReg)cs);
188
189 //32 bit data segment
190 SegDescriptor dsDesc = initDesc;
191 uint64_t dsDescVal = dsDesc;
192 physProxy.writeBlob(GDTBase + numGDTEntries * 8,
193 (uint8_t *)(&dsDescVal), 8);
194
195 numGDTEntries++;
196
197 SegSelector ds = 0;
198 ds.si = numGDTEntries - 1;
199
200 tc->setMiscReg(MISCREG_DS, (MiscReg)ds);
201 tc->setMiscReg(MISCREG_ES, (MiscReg)ds);
202 tc->setMiscReg(MISCREG_FS, (MiscReg)ds);
203 tc->setMiscReg(MISCREG_GS, (MiscReg)ds);
204 tc->setMiscReg(MISCREG_SS, (MiscReg)ds);
205
206 tc->setMiscReg(MISCREG_TSL, 0);
207 tc->setMiscReg(MISCREG_TSG_BASE, GDTBase);
208 tc->setMiscReg(MISCREG_TSG_LIMIT, 8 * numGDTEntries - 1);
209
210 SegDescriptor tssDesc = initDesc;
211 uint64_t tssDescVal = tssDesc;
212 physProxy.writeBlob(GDTBase + numGDTEntries * 8,
213 (uint8_t *)(&tssDescVal), 8);
214
215 numGDTEntries++;
216
217 SegSelector tss = 0;
218 tss.si = numGDTEntries - 1;
219
220 tc->setMiscReg(MISCREG_TR, (MiscReg)tss);
221 installSegDesc(tc, SYS_SEGMENT_REG_TR, tssDesc, true);
222
223 /*
224 * Identity map the first 4GB of memory. In order to map this region
225 * of memory in long mode, there needs to be one actual page map level
226 * 4 entry which points to one page directory pointer table which
227 * points to 4 different page directory tables which are full of two
228 * megabyte pages. All of the other entries in valid tables are set
229 * to indicate that they don't pertain to anything valid and will
230 * cause a fault if used.
231 */
232
233 // Put valid values in all of the various table entries which indicate
234 // that those entries don't point to further tables or pages. Then
235 // set the values of those entries which are needed.
236
237 // Page Map Level 4
238
239 // read/write, user, not present
240 uint64_t pml4e = X86ISA::htog(0x6);
241 for (int offset = 0; offset < (1 << PML4Bits) * 8; offset += 8) {
242 physProxy.writeBlob(PageMapLevel4 + offset, (uint8_t *)(&pml4e), 8);
243 }
244 // Point to the only PDPT
245 pml4e = X86ISA::htog(0x7 | PageDirPtrTable);
246 physProxy.writeBlob(PageMapLevel4, (uint8_t *)(&pml4e), 8);
247
248 // Page Directory Pointer Table
249
250 // read/write, user, not present
251 uint64_t pdpe = X86ISA::htog(0x6);
252 for (int offset = 0; offset < (1 << PDPTBits) * 8; offset += 8) {
253 physProxy.writeBlob(PageDirPtrTable + offset,
254 (uint8_t *)(&pdpe), 8);
255 }
256 // Point to the PDTs
257 for (int table = 0; table < NumPDTs; table++) {
258 pdpe = X86ISA::htog(0x7 | PageDirTable[table]);
259 physProxy.writeBlob(PageDirPtrTable + table * 8,
260 (uint8_t *)(&pdpe), 8);
261 }
262
263 // Page Directory Tables
264
265 Addr base = 0;
266 const Addr pageSize = 2 << 20;
267 for (int table = 0; table < NumPDTs; table++) {
268 for (int offset = 0; offset < (1 << PDTBits) * 8; offset += 8) {
269 // read/write, user, present, 4MB
270 uint64_t pdte = X86ISA::htog(0x87 | base);
271 physProxy.writeBlob(PageDirTable[table] + offset,
272 (uint8_t *)(&pdte), 8);
273 base += pageSize;
274 }
275 }
276
277 /*
278 * Transition from real mode all the way up to Long mode
279 */
280 CR0 cr0 = tc->readMiscRegNoEffect(MISCREG_CR0);
281 //Turn off paging.
282 cr0.pg = 0;
283 tc->setMiscReg(MISCREG_CR0, cr0);
284 //Turn on protected mode.
285 cr0.pe = 1;
286 tc->setMiscReg(MISCREG_CR0, cr0);
287
288 CR4 cr4 = tc->readMiscRegNoEffect(MISCREG_CR4);
289 //Turn on pae.
290 cr4.pae = 1;
291 tc->setMiscReg(MISCREG_CR4, cr4);
292
293 //Point to the page tables.
294 tc->setMiscReg(MISCREG_CR3, PageMapLevel4);
295
296 Efer efer = tc->readMiscRegNoEffect(MISCREG_EFER);
297 //Enable long mode.
298 efer.lme = 1;
299 tc->setMiscReg(MISCREG_EFER, efer);
300
301 //Start using longmode segments.
302 installSegDesc(tc, SEGMENT_REG_CS, csDesc, true);
303 installSegDesc(tc, SEGMENT_REG_DS, dsDesc, true);
304 installSegDesc(tc, SEGMENT_REG_ES, dsDesc, true);
305 installSegDesc(tc, SEGMENT_REG_FS, dsDesc, true);
306 installSegDesc(tc, SEGMENT_REG_GS, dsDesc, true);
307 installSegDesc(tc, SEGMENT_REG_SS, dsDesc, true);
308
309 //Activate long mode.
310 cr0.pg = 1;
311 tc->setMiscReg(MISCREG_CR0, cr0);
312
313 tc->pcState(tc->getSystemPtr()->kernelEntry);
314
315 // We should now be in long mode. Yay!
316
317 Addr ebdaPos = 0xF0000;
318 Addr fixed, table;
319
320 //Write out the SMBios/DMI table
321 writeOutSMBiosTable(ebdaPos, fixed, table);
322 ebdaPos += (fixed + table);
323 ebdaPos = roundUp(ebdaPos, 16);
324
325 //Write out the Intel MP Specification configuration table
326 writeOutMPTable(ebdaPos, fixed, table);
327 ebdaPos += (fixed + table);
328}
329
330void
331X86System::writeOutSMBiosTable(Addr header,
332 Addr &headerSize, Addr &structSize, Addr table)
333{
334 // If the table location isn't specified, just put it after the header.
335 // The header size as of the 2.5 SMBios specification is 0x1F bytes
336 if (!table)
337 table = header + 0x1F;
338 smbiosTable->setTableAddr(table);
339
340 smbiosTable->writeOut(physProxy, header, headerSize, structSize);
341
342 // Do some bounds checking to make sure we at least didn't step on
343 // ourselves.
344 assert(header > table || header + headerSize <= table);
345 assert(table > header || table + structSize <= header);
346}
347
348void
349X86System::writeOutMPTable(Addr fp,
350 Addr &fpSize, Addr &tableSize, Addr table)
351{
352 // If the table location isn't specified and it exists, just put
353 // it after the floating pointer. The fp size as of the 1.4 Intel MP
354 // specification is 0x10 bytes.
355 if (mpConfigTable) {
356 if (!table)
357 table = fp + 0x10;
358 mpFloatingPointer->setTableAddr(table);
359 }
360
361 fpSize = mpFloatingPointer->writeOut(physProxy, fp);
362 if (mpConfigTable)
363 tableSize = mpConfigTable->writeOut(physProxy, table);
364 else
365 tableSize = 0;
366
367 // Do some bounds checking to make sure we at least didn't step on
368 // ourselves and the fp structure was the size we thought it was.
369 assert(fp > table || fp + fpSize <= table);
370 assert(table > fp || table + tableSize <= fp);
371 assert(fpSize == 0x10);
372}
373
374
375X86System::~X86System()
376{
377 delete smbiosTable;
378}
379
380X86System *
381X86SystemParams::create()
382{
383 return new X86System(this);
384}