]> git.proxmox.com Git - mirror_edk2.git/blame - OvmfPkg/PlatformPei/Platform.c
OvmfPkg: make PcdPropertiesTableEnable dynamic
[mirror_edk2.git] / OvmfPkg / PlatformPei / Platform.c
CommitLineData
49ba9447 1/**@file\r
2 Platform PEI driver\r
3\r
869b17cc 4 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
eec7d420 5 Copyright (c) 2011, Andrei Warkentin <andreiw@motorola.com>\r
6\r
56d7640a 7 This program and the accompanying materials\r
49ba9447 8 are licensed and made available under the terms and conditions of the BSD License\r
9 which accompanies this distribution. The full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php\r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15**/\r
16\r
17//\r
18// The package level header files this module uses\r
19//\r
20#include <PiPei.h>\r
21\r
22//\r
23// The Library classes this module consumes\r
24//\r
25#include <Library/DebugLib.h>\r
26#include <Library/HobLib.h>\r
27#include <Library/IoLib.h>\r
77ba993c 28#include <Library/MemoryAllocationLib.h>\r
29#include <Library/PcdLib.h>\r
49ba9447 30#include <Library/PciLib.h>\r
31#include <Library/PeimEntryPoint.h>\r
9ed65b10 32#include <Library/PeiServicesLib.h>\r
7cdba634 33#include <Library/QemuFwCfgLib.h>\r
49ba9447 34#include <Library/ResourcePublicationLib.h>\r
35#include <Guid/MemoryTypeInformation.h>\r
9ed65b10 36#include <Ppi/MasterBootMode.h>\r
931a0c74 37#include <IndustryStandard/Pci22.h>\r
97380beb 38#include <OvmfPlatforms.h>\r
49ba9447 39\r
40#include "Platform.h"\r
3ca15914 41#include "Cmos.h"\r
49ba9447 42\r
43EFI_MEMORY_TYPE_INFORMATION mDefaultMemoryTypeInformation[] = {\r
44 { EfiACPIMemoryNVS, 0x004 },\r
991d9563 45 { EfiACPIReclaimMemory, 0x008 },\r
55cdb67a 46 { EfiReservedMemoryType, 0x004 },\r
991d9563 47 { EfiRuntimeServicesData, 0x024 },\r
48 { EfiRuntimeServicesCode, 0x030 },\r
49 { EfiBootServicesCode, 0x180 },\r
50 { EfiBootServicesData, 0xF00 },\r
49ba9447 51 { EfiMaxMemoryType, 0x000 }\r
52};\r
53\r
54\r
9ed65b10 55EFI_PEI_PPI_DESCRIPTOR mPpiBootMode[] = {\r
56 {\r
57 EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
58 &gEfiPeiMasterBootModePpiGuid,\r
59 NULL\r
60 }\r
61};\r
62\r
63\r
589756c7
PA
64UINT16 mHostBridgeDevId;\r
65\r
979420df
JJ
66EFI_BOOT_MODE mBootMode = BOOT_WITH_FULL_CONFIGURATION;\r
67\r
7cdba634
JJ
68BOOLEAN mS3Supported = FALSE;\r
69\r
979420df 70\r
49ba9447 71VOID\r
72AddIoMemoryBaseSizeHob (\r
73 EFI_PHYSICAL_ADDRESS MemoryBase,\r
74 UINT64 MemorySize\r
75 )\r
76{\r
991d9563 77 BuildResourceDescriptorHob (\r
78 EFI_RESOURCE_MEMORY_MAPPED_IO,\r
49ba9447 79 EFI_RESOURCE_ATTRIBUTE_PRESENT |\r
80 EFI_RESOURCE_ATTRIBUTE_INITIALIZED |\r
81 EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |\r
991d9563 82 EFI_RESOURCE_ATTRIBUTE_TESTED,\r
49ba9447 83 MemoryBase,\r
84 MemorySize\r
85 );\r
86}\r
87\r
eec7d420 88VOID\r
89AddReservedMemoryBaseSizeHob (\r
90 EFI_PHYSICAL_ADDRESS MemoryBase,\r
91 UINT64 MemorySize\r
92 )\r
93{\r
94 BuildResourceDescriptorHob (\r
95 EFI_RESOURCE_MEMORY_RESERVED,\r
96 EFI_RESOURCE_ATTRIBUTE_PRESENT |\r
97 EFI_RESOURCE_ATTRIBUTE_INITIALIZED |\r
98 EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |\r
99 EFI_RESOURCE_ATTRIBUTE_TESTED,\r
100 MemoryBase,\r
101 MemorySize\r
102 );\r
103}\r
49ba9447 104\r
105VOID\r
106AddIoMemoryRangeHob (\r
107 EFI_PHYSICAL_ADDRESS MemoryBase,\r
108 EFI_PHYSICAL_ADDRESS MemoryLimit\r
109 )\r
110{\r
111 AddIoMemoryBaseSizeHob (MemoryBase, (UINT64)(MemoryLimit - MemoryBase));\r
112}\r
113\r
114\r
115VOID\r
116AddMemoryBaseSizeHob (\r
117 EFI_PHYSICAL_ADDRESS MemoryBase,\r
118 UINT64 MemorySize\r
119 )\r
120{\r
991d9563 121 BuildResourceDescriptorHob (\r
122 EFI_RESOURCE_SYSTEM_MEMORY,\r
49ba9447 123 EFI_RESOURCE_ATTRIBUTE_PRESENT |\r
124 EFI_RESOURCE_ATTRIBUTE_INITIALIZED |\r
125 EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |\r
126 EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE |\r
127 EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE |\r
128 EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE |\r
991d9563 129 EFI_RESOURCE_ATTRIBUTE_TESTED,\r
49ba9447 130 MemoryBase,\r
131 MemorySize\r
132 );\r
133}\r
134\r
135\r
136VOID\r
137AddMemoryRangeHob (\r
138 EFI_PHYSICAL_ADDRESS MemoryBase,\r
139 EFI_PHYSICAL_ADDRESS MemoryLimit\r
140 )\r
141{\r
142 AddMemoryBaseSizeHob (MemoryBase, (UINT64)(MemoryLimit - MemoryBase));\r
143}\r
144\r
c0e10976 145\r
146VOID\r
147AddUntestedMemoryBaseSizeHob (\r
148 EFI_PHYSICAL_ADDRESS MemoryBase,\r
149 UINT64 MemorySize\r
150 )\r
151{\r
152 BuildResourceDescriptorHob (\r
153 EFI_RESOURCE_SYSTEM_MEMORY,\r
154 EFI_RESOURCE_ATTRIBUTE_PRESENT |\r
155 EFI_RESOURCE_ATTRIBUTE_INITIALIZED |\r
156 EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |\r
157 EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE |\r
158 EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE |\r
159 EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE,\r
160 MemoryBase,\r
161 MemorySize\r
162 );\r
163}\r
164\r
165\r
166VOID\r
167AddUntestedMemoryRangeHob (\r
168 EFI_PHYSICAL_ADDRESS MemoryBase,\r
169 EFI_PHYSICAL_ADDRESS MemoryLimit\r
170 )\r
171{\r
172 AddUntestedMemoryBaseSizeHob (MemoryBase, (UINT64)(MemoryLimit - MemoryBase));\r
173}\r
174\r
bb6a9a93 175VOID\r
4b455f7b 176MemMapInitialization (\r
bb6a9a93
WL
177 VOID\r
178 )\r
179{\r
bb6a9a93
WL
180 //\r
181 // Create Memory Type Information HOB\r
182 //\r
183 BuildGuidDataHob (\r
184 &gEfiMemoryTypeInformationGuid,\r
185 mDefaultMemoryTypeInformation,\r
186 sizeof(mDefaultMemoryTypeInformation)\r
187 );\r
188\r
189 //\r
190 // Add PCI IO Port space available for PCI resource allocations.\r
191 //\r
192 BuildResourceDescriptorHob (\r
193 EFI_RESOURCE_IO,\r
194 EFI_RESOURCE_ATTRIBUTE_PRESENT |\r
195 EFI_RESOURCE_ATTRIBUTE_INITIALIZED,\r
196 0xC000,\r
197 0x4000\r
198 );\r
199\r
200 //\r
201 // Video memory + Legacy BIOS region\r
202 //\r
203 AddIoMemoryRangeHob (0x0A0000, BASE_1MB);\r
204\r
4b455f7b
JJ
205 if (!mXen) {\r
206 UINT32 TopOfLowRam;\r
c68d3a69
LE
207 UINT32 PciBase;\r
208\r
4b455f7b 209 TopOfLowRam = GetSystemMemorySizeBelow4gb ();\r
c68d3a69
LE
210 if (mHostBridgeDevId == INTEL_Q35_MCH_DEVICE_ID) {\r
211 //\r
212 // A 3GB base will always fall into Q35's 32-bit PCI host aperture,\r
213 // regardless of the Q35 MMCONFIG BAR. Correspondingly, QEMU never lets\r
214 // the RAM below 4 GB exceed it.\r
215 //\r
216 PciBase = BASE_2GB + BASE_1GB;\r
217 ASSERT (TopOfLowRam <= PciBase);\r
218 } else {\r
219 PciBase = (TopOfLowRam < BASE_2GB) ? BASE_2GB : TopOfLowRam;\r
220 }\r
49ba9447 221\r
4b455f7b
JJ
222 //\r
223 // address purpose size\r
224 // ------------ -------- -------------------------\r
225 // max(top, 2g) PCI MMIO 0xFC000000 - max(top, 2g)\r
226 // 0xFC000000 gap 44 MB\r
227 // 0xFEC00000 IO-APIC 4 KB\r
228 // 0xFEC01000 gap 1020 KB\r
229 // 0xFED00000 HPET 1 KB\r
90721ba5
PA
230 // 0xFED00400 gap 111 KB\r
231 // 0xFED1C000 gap (PIIX4) / RCRB (ICH9) 16 KB\r
232 // 0xFED20000 gap 896 KB\r
4b455f7b
JJ
233 // 0xFEE00000 LAPIC 1 MB\r
234 //\r
c68d3a69 235 AddIoMemoryRangeHob (PciBase, 0xFC000000);\r
4b455f7b
JJ
236 AddIoMemoryBaseSizeHob (0xFEC00000, SIZE_4KB);\r
237 AddIoMemoryBaseSizeHob (0xFED00000, SIZE_1KB);\r
90721ba5
PA
238 if (mHostBridgeDevId == INTEL_Q35_MCH_DEVICE_ID) {\r
239 AddIoMemoryBaseSizeHob (ICH9_ROOT_COMPLEX_BASE, SIZE_16KB);\r
240 }\r
4b455f7b 241 AddIoMemoryBaseSizeHob (PcdGet32(PcdCpuLocalApicBaseAddress), SIZE_1MB);\r
4b455f7b 242 }\r
49ba9447 243}\r
244\r
245\r
246VOID\r
247MiscInitialization (\r
0e20a186 248 VOID\r
49ba9447 249 )\r
250{\r
97380beb
GS
251 UINTN PmCmd;\r
252 UINTN Pmba;\r
e2ab3f81
GS
253 UINTN AcpiCtlReg;\r
254 UINT8 AcpiEnBit;\r
97380beb 255\r
49ba9447 256 //\r
257 // Disable A20 Mask\r
258 //\r
55cdb67a 259 IoOr8 (0x92, BIT1);\r
49ba9447 260\r
261 //\r
86a14b0a
LE
262 // Build the CPU HOB with guest RAM size dependent address width and 16-bits\r
263 // of IO space. (Side note: unlike other HOBs, the CPU HOB is needed during\r
264 // S3 resume as well, so we build it unconditionally.)\r
49ba9447 265 //\r
86a14b0a 266 BuildCpuHob (mPhysMemAddressWidth, 16);\r
c756b2ab 267\r
97380beb 268 //\r
589756c7 269 // Determine platform type and save Host Bridge DID to PCD\r
97380beb 270 //\r
589756c7 271 switch (mHostBridgeDevId) {\r
97380beb 272 case INTEL_82441_DEVICE_ID:\r
e2ab3f81 273 PmCmd = POWER_MGMT_REGISTER_PIIX4 (PCI_COMMAND_OFFSET);\r
da372167
LE
274 Pmba = POWER_MGMT_REGISTER_PIIX4 (PIIX4_PMBA);\r
275 AcpiCtlReg = POWER_MGMT_REGISTER_PIIX4 (PIIX4_PMREGMISC);\r
276 AcpiEnBit = PIIX4_PMREGMISC_PMIOSE;\r
97380beb
GS
277 break;\r
278 case INTEL_Q35_MCH_DEVICE_ID:\r
e2ab3f81 279 PmCmd = POWER_MGMT_REGISTER_Q35 (PCI_COMMAND_OFFSET);\r
bc9d05d6
LE
280 Pmba = POWER_MGMT_REGISTER_Q35 (ICH9_PMBASE);\r
281 AcpiCtlReg = POWER_MGMT_REGISTER_Q35 (ICH9_ACPI_CNTL);\r
282 AcpiEnBit = ICH9_ACPI_CNTL_ACPI_EN;\r
97380beb
GS
283 break;\r
284 default:\r
285 DEBUG ((EFI_D_ERROR, "%a: Unknown Host Bridge Device ID: 0x%04x\n",\r
589756c7 286 __FUNCTION__, mHostBridgeDevId));\r
97380beb
GS
287 ASSERT (FALSE);\r
288 return;\r
289 }\r
589756c7 290 PcdSet16 (PcdOvmfHostBridgePciDevId, mHostBridgeDevId);\r
97380beb 291\r
0e20a186 292 //\r
e2ab3f81
GS
293 // If the appropriate IOspace enable bit is set, assume the ACPI PMBA\r
294 // has been configured (e.g., by Xen) and skip the setup here.\r
295 // This matches the logic in AcpiTimerLibConstructor ().\r
0e20a186 296 //\r
e2ab3f81 297 if ((PciRead8 (AcpiCtlReg) & AcpiEnBit) == 0) {\r
eec7d420 298 //\r
e2ab3f81 299 // The PEI phase should be exited with fully accessibe ACPI PM IO space:\r
931a0c74 300 // 1. set PMBA\r
eec7d420 301 //\r
97380beb 302 PciAndThenOr32 (Pmba, (UINT32) ~0xFFC0, PcdGet16 (PcdAcpiPmBaseAddress));\r
931a0c74 303\r
304 //\r
305 // 2. set PCICMD/IOSE\r
306 //\r
97380beb 307 PciOr8 (PmCmd, EFI_PCI_COMMAND_IO_SPACE);\r
931a0c74 308\r
309 //\r
e2ab3f81 310 // 3. set ACPI PM IO enable bit (PMREGMISC:PMIOSE or ACPI_CNTL:ACPI_EN)\r
931a0c74 311 //\r
e2ab3f81 312 PciOr8 (AcpiCtlReg, AcpiEnBit);\r
eec7d420 313 }\r
90721ba5
PA
314\r
315 if (mHostBridgeDevId == INTEL_Q35_MCH_DEVICE_ID) {\r
316 //\r
317 // Set Root Complex Register Block BAR\r
318 //\r
319 PciWrite32 (\r
320 POWER_MGMT_REGISTER_Q35 (ICH9_RCBA),\r
321 ICH9_ROOT_COMPLEX_BASE | ICH9_RCBA_EN\r
322 );\r
323 }\r
49ba9447 324}\r
325\r
326\r
9ed65b10 327VOID\r
328BootModeInitialization (\r
8f5ca05b 329 VOID\r
9ed65b10 330 )\r
331{\r
8f5ca05b
LE
332 EFI_STATUS Status;\r
333\r
334 if (CmosRead8 (0xF) == 0xFE) {\r
979420df 335 mBootMode = BOOT_ON_S3_RESUME;\r
8f5ca05b 336 }\r
9be75189 337 CmosWrite8 (0xF, 0x00);\r
667bf1e4 338\r
979420df 339 Status = PeiServicesSetBootMode (mBootMode);\r
667bf1e4 340 ASSERT_EFI_ERROR (Status);\r
341\r
342 Status = PeiServicesInstallPpi (mPpiBootMode);\r
343 ASSERT_EFI_ERROR (Status);\r
9ed65b10 344}\r
345\r
346\r
77ba993c 347VOID\r
348ReserveEmuVariableNvStore (\r
349 )\r
350{\r
351 EFI_PHYSICAL_ADDRESS VariableStore;\r
352\r
353 //\r
354 // Allocate storage for NV variables early on so it will be\r
355 // at a consistent address. Since VM memory is preserved\r
356 // across reboots, this allows the NV variable storage to survive\r
357 // a VM reboot.\r
358 //\r
359 VariableStore =\r
360 (EFI_PHYSICAL_ADDRESS)(UINTN)\r
9edb2933 361 AllocateAlignedRuntimePages (\r
cce992ac
WL
362 EFI_SIZE_TO_PAGES (2 * PcdGet32 (PcdFlashNvStorageFtwSpareSize)),\r
363 PcdGet32 (PcdFlashNvStorageFtwSpareSize)\r
27f58ea1 364 );\r
77ba993c 365 DEBUG ((EFI_D_INFO,\r
366 "Reserved variable store memory: 0x%lX; size: %dkb\n",\r
367 VariableStore,\r
29a3f139 368 (2 * PcdGet32 (PcdFlashNvStorageFtwSpareSize)) / 1024\r
77ba993c 369 ));\r
370 PcdSet64 (PcdEmuVariableNvStoreReserved, VariableStore);\r
371}\r
372\r
373\r
3ca15914 374VOID\r
375DebugDumpCmos (\r
376 VOID\r
377 )\r
378{\r
6394c35a 379 UINT32 Loop;\r
3ca15914 380\r
381 DEBUG ((EFI_D_INFO, "CMOS:\n"));\r
382\r
383 for (Loop = 0; Loop < 0x80; Loop++) {\r
384 if ((Loop % 0x10) == 0) {\r
385 DEBUG ((EFI_D_INFO, "%02x:", Loop));\r
386 }\r
387 DEBUG ((EFI_D_INFO, " %02x", CmosRead8 (Loop)));\r
388 if ((Loop % 0x10) == 0xf) {\r
389 DEBUG ((EFI_D_INFO, "\n"));\r
390 }\r
391 }\r
392}\r
393\r
394\r
49ba9447 395/**\r
396 Perform Platform PEI initialization.\r
397\r
398 @param FileHandle Handle of the file being invoked.\r
399 @param PeiServices Describes the list of possible PEI Services.\r
400\r
401 @return EFI_SUCCESS The PEIM initialized successfully.\r
402\r
403**/\r
404EFI_STATUS\r
405EFIAPI\r
406InitializePlatform (\r
407 IN EFI_PEI_FILE_HANDLE FileHandle,\r
408 IN CONST EFI_PEI_SERVICES **PeiServices\r
409 )\r
410{\r
411 DEBUG ((EFI_D_ERROR, "Platform PEIM Loaded\n"));\r
412\r
3ca15914 413 DebugDumpCmos ();\r
414\r
b98b4941 415 XenDetect ();\r
c7ea55b9 416\r
7cdba634
JJ
417 if (QemuFwCfgS3Enabled ()) {\r
418 DEBUG ((EFI_D_INFO, "S3 support was detected on QEMU\n"));\r
419 mS3Supported = TRUE;\r
420 }\r
421\r
869b17cc 422 BootModeInitialization ();\r
bc89fe48 423 AddressWidthInitialization ();\r
869b17cc 424\r
f76e9eba
JJ
425 PublishPeiMemory ();\r
426\r
2818c158 427 InitializeRamRegions ();\r
49ba9447 428\r
b621bb0a 429 if (mXen) {\r
c7ea55b9 430 DEBUG ((EFI_D_INFO, "Xen was detected\n"));\r
b98b4941 431 InitializeXen ();\r
c7ea55b9 432 }\r
eec7d420 433\r
589756c7
PA
434 //\r
435 // Query Host Bridge DID\r
436 //\r
437 mHostBridgeDevId = PciRead16 (OVMF_HOSTBRIDGE_DID);\r
438\r
bd386eaf
JJ
439 if (mBootMode != BOOT_ON_S3_RESUME) {\r
440 ReserveEmuVariableNvStore ();\r
77ba993c 441\r
bd386eaf 442 PeiFvInitialization ();\r
49ba9447 443\r
bd386eaf
JJ
444 MemMapInitialization ();\r
445 }\r
49ba9447 446\r
0e20a186 447 MiscInitialization ();\r
49ba9447 448\r
449 return EFI_SUCCESS;\r
450}\r