4 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
5 Copyright (c) 2011, Andrei Warkentin <andreiw@motorola.com>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 // The package level header files this module uses
23 // The Library classes this module consumes
25 #include <Library/BaseLib.h>
26 #include <Library/DebugLib.h>
27 #include <Library/HobLib.h>
28 #include <Library/IoLib.h>
29 #include <Library/MemoryAllocationLib.h>
30 #include <Library/PcdLib.h>
31 #include <Library/PciLib.h>
32 #include <Library/PeimEntryPoint.h>
33 #include <Library/PeiServicesLib.h>
34 #include <Library/QemuFwCfgLib.h>
35 #include <Library/ResourcePublicationLib.h>
36 #include <Guid/MemoryTypeInformation.h>
37 #include <Ppi/MasterBootMode.h>
38 #include <IndustryStandard/Pci22.h>
39 #include <OvmfPlatforms.h>
44 EFI_MEMORY_TYPE_INFORMATION mDefaultMemoryTypeInformation
[] = {
45 { EfiACPIMemoryNVS
, 0x004 },
46 { EfiACPIReclaimMemory
, 0x008 },
47 { EfiReservedMemoryType
, 0x004 },
48 { EfiRuntimeServicesData
, 0x024 },
49 { EfiRuntimeServicesCode
, 0x030 },
50 { EfiBootServicesCode
, 0x180 },
51 { EfiBootServicesData
, 0xF00 },
52 { EfiMaxMemoryType
, 0x000 }
56 EFI_PEI_PPI_DESCRIPTOR mPpiBootMode
[] = {
58 EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
,
59 &gEfiPeiMasterBootModePpiGuid
,
65 UINT16 mHostBridgeDevId
;
67 EFI_BOOT_MODE mBootMode
= BOOT_WITH_FULL_CONFIGURATION
;
69 BOOLEAN mS3Supported
= FALSE
;
73 AddIoMemoryBaseSizeHob (
74 EFI_PHYSICAL_ADDRESS MemoryBase
,
78 BuildResourceDescriptorHob (
79 EFI_RESOURCE_MEMORY_MAPPED_IO
,
80 EFI_RESOURCE_ATTRIBUTE_PRESENT
|
81 EFI_RESOURCE_ATTRIBUTE_INITIALIZED
|
82 EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE
|
83 EFI_RESOURCE_ATTRIBUTE_TESTED
,
90 AddReservedMemoryBaseSizeHob (
91 EFI_PHYSICAL_ADDRESS MemoryBase
,
96 BuildResourceDescriptorHob (
97 EFI_RESOURCE_MEMORY_RESERVED
,
98 EFI_RESOURCE_ATTRIBUTE_PRESENT
|
99 EFI_RESOURCE_ATTRIBUTE_INITIALIZED
|
100 EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE
|
102 EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE
|
103 EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE
|
104 EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE
:
107 EFI_RESOURCE_ATTRIBUTE_TESTED
,
114 AddIoMemoryRangeHob (
115 EFI_PHYSICAL_ADDRESS MemoryBase
,
116 EFI_PHYSICAL_ADDRESS MemoryLimit
119 AddIoMemoryBaseSizeHob (MemoryBase
, (UINT64
)(MemoryLimit
- MemoryBase
));
124 AddMemoryBaseSizeHob (
125 EFI_PHYSICAL_ADDRESS MemoryBase
,
129 BuildResourceDescriptorHob (
130 EFI_RESOURCE_SYSTEM_MEMORY
,
131 EFI_RESOURCE_ATTRIBUTE_PRESENT
|
132 EFI_RESOURCE_ATTRIBUTE_INITIALIZED
|
133 EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE
|
134 EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE
|
135 EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE
|
136 EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE
|
137 EFI_RESOURCE_ATTRIBUTE_TESTED
,
146 EFI_PHYSICAL_ADDRESS MemoryBase
,
147 EFI_PHYSICAL_ADDRESS MemoryLimit
150 AddMemoryBaseSizeHob (MemoryBase
, (UINT64
)(MemoryLimit
- MemoryBase
));
155 MemMapInitialization (
161 RETURN_STATUS PcdStatus
;
167 // Create Memory Type Information HOB
170 &gEfiMemoryTypeInformationGuid
,
171 mDefaultMemoryTypeInformation
,
172 sizeof(mDefaultMemoryTypeInformation
)
176 // Video memory + Legacy BIOS region
178 AddIoMemoryRangeHob (0x0A0000, BASE_1MB
);
186 TopOfLowRam
= GetSystemMemorySizeBelow4gb ();
188 if (mHostBridgeDevId
== INTEL_Q35_MCH_DEVICE_ID
) {
190 // The MMCONFIG area is expected to fall between the top of low RAM and
191 // the base of the 32-bit PCI host aperture.
193 PciExBarBase
= FixedPcdGet64 (PcdPciExpressBaseAddress
);
194 ASSERT (TopOfLowRam
<= PciExBarBase
);
195 ASSERT (PciExBarBase
<= MAX_UINT32
- SIZE_256MB
);
196 PciBase
= (UINT32
)(PciExBarBase
+ SIZE_256MB
);
198 PciBase
= (TopOfLowRam
< BASE_2GB
) ? BASE_2GB
: TopOfLowRam
;
202 // address purpose size
203 // ------------ -------- -------------------------
204 // max(top, 2g) PCI MMIO 0xFC000000 - max(top, 2g)
205 // 0xFC000000 gap 44 MB
206 // 0xFEC00000 IO-APIC 4 KB
207 // 0xFEC01000 gap 1020 KB
208 // 0xFED00000 HPET 1 KB
209 // 0xFED00400 gap 111 KB
210 // 0xFED1C000 gap (PIIX4) / RCRB (ICH9) 16 KB
211 // 0xFED20000 gap 896 KB
212 // 0xFEE00000 LAPIC 1 MB
214 PciSize
= 0xFC000000 - PciBase
;
215 AddIoMemoryBaseSizeHob (PciBase
, PciSize
);
216 PcdStatus
= PcdSet64S (PcdPciMmio32Base
, PciBase
);
217 ASSERT_RETURN_ERROR (PcdStatus
);
218 PcdStatus
= PcdSet64S (PcdPciMmio32Size
, PciSize
);
219 ASSERT_RETURN_ERROR (PcdStatus
);
221 AddIoMemoryBaseSizeHob (0xFEC00000, SIZE_4KB
);
222 AddIoMemoryBaseSizeHob (0xFED00000, SIZE_1KB
);
223 if (mHostBridgeDevId
== INTEL_Q35_MCH_DEVICE_ID
) {
224 AddIoMemoryBaseSizeHob (ICH9_ROOT_COMPLEX_BASE
, SIZE_16KB
);
226 // Note: there should be an
228 // AddIoMemoryBaseSizeHob (PciExBarBase, SIZE_256MB);
230 // call below, just like the one above for RCBA. However, Linux insists
231 // that the MMCONFIG area be marked in the E820 or UEFI memory map as
232 // "reserved memory" -- Linux does not content itself with a simple gap
233 // in the memory map wherever the MCFG ACPI table points to.
235 // This appears to be a safety measure. The PCI Firmware Specification
236 // (rev 3.1) says in 4.1.2. "MCFG Table Description": "The resources can
237 // *optionally* be returned in [...] EFIGetMemoryMap as reserved memory
238 // [...]". (Emphasis added here.)
240 // Normally we add memory resource descriptor HOBs in
241 // QemuInitializeRam(), and pre-allocate from those with memory
242 // allocation HOBs in InitializeRamRegions(). However, the MMCONFIG area
243 // is most definitely not RAM; so, as an exception, cover it with
244 // uncacheable reserved memory right here.
246 AddReservedMemoryBaseSizeHob (PciExBarBase
, SIZE_256MB
, FALSE
);
247 BuildMemoryAllocationHob (PciExBarBase
, SIZE_256MB
,
248 EfiReservedMemoryType
);
250 AddIoMemoryBaseSizeHob (PcdGet32(PcdCpuLocalApicBaseAddress
), SIZE_1MB
);
253 // On Q35, the IO Port space is available for PCI resource allocations from
256 if (mHostBridgeDevId
== INTEL_Q35_MCH_DEVICE_ID
) {
259 ASSERT ((ICH9_PMBASE_VALUE
& 0xF000) < PciIoBase
);
264 // Add PCI IO Port space available for PCI resource allocations.
266 BuildResourceDescriptorHob (
268 EFI_RESOURCE_ATTRIBUTE_PRESENT
|
269 EFI_RESOURCE_ATTRIBUTE_INITIALIZED
,
273 PcdStatus
= PcdSet64S (PcdPciIoBase
, PciIoBase
);
274 ASSERT_RETURN_ERROR (PcdStatus
);
275 PcdStatus
= PcdSet64S (PcdPciIoSize
, PciIoSize
);
276 ASSERT_RETURN_ERROR (PcdStatus
);
280 GetNamedFwCfgBoolean (
281 IN CHAR8
*FwCfgFileName
,
286 FIRMWARE_CONFIG_ITEM FwCfgItem
;
290 Status
= QemuFwCfgFindFile (FwCfgFileName
, &FwCfgItem
, &FwCfgSize
);
291 if (EFI_ERROR (Status
)) {
294 if (FwCfgSize
> sizeof Value
) {
295 return EFI_BAD_BUFFER_SIZE
;
297 QemuFwCfgSelectItem (FwCfgItem
);
298 QemuFwCfgReadBytes (FwCfgSize
, Value
);
300 if ((FwCfgSize
== 1) ||
301 (FwCfgSize
== 2 && Value
[1] == '\n') ||
302 (FwCfgSize
== 3 && Value
[1] == '\r' && Value
[2] == '\n')) {
320 return EFI_PROTOCOL_ERROR
;
323 #define UPDATE_BOOLEAN_PCD_FROM_FW_CFG(TokenName) \
326 RETURN_STATUS PcdStatus; \
328 if (!EFI_ERROR (GetNamedFwCfgBoolean ( \
329 "opt/ovmf/" #TokenName, &Setting))) { \
330 PcdStatus = PcdSetBoolS (TokenName, Setting); \
331 ASSERT_RETURN_ERROR (PcdStatus); \
336 NoexecDxeInitialization (
340 UPDATE_BOOLEAN_PCD_FROM_FW_CFG (PcdPropertiesTableEnable
);
341 UPDATE_BOOLEAN_PCD_FROM_FW_CFG (PcdSetNxForStack
);
345 PciExBarInitialization (
355 // We only support the 256MB size for the MMCONFIG area:
356 // 256 buses * 32 devices * 8 functions * 4096 bytes config space.
358 // The masks used below enforce the Q35 requirements that the MMCONFIG area
359 // be (a) correctly aligned -- here at 256 MB --, (b) located under 64 GB.
361 // Note that (b) also ensures that the minimum address width we have
362 // determined in AddressWidthInitialization(), i.e., 36 bits, will suffice
363 // for DXE's page tables to cover the MMCONFIG area.
365 PciExBarBase
.Uint64
= FixedPcdGet64 (PcdPciExpressBaseAddress
);
366 ASSERT ((PciExBarBase
.Uint32
[1] & MCH_PCIEXBAR_HIGHMASK
) == 0);
367 ASSERT ((PciExBarBase
.Uint32
[0] & MCH_PCIEXBAR_LOWMASK
) == 0);
370 // Clear the PCIEXBAREN bit first, before programming the high register.
372 PciWrite32 (DRAMC_REGISTER_Q35 (MCH_PCIEXBAR_LOW
), 0);
375 // Program the high register. Then program the low register, setting the
376 // MMCONFIG area size and enabling decoding at once.
378 PciWrite32 (DRAMC_REGISTER_Q35 (MCH_PCIEXBAR_HIGH
), PciExBarBase
.Uint32
[1]);
380 DRAMC_REGISTER_Q35 (MCH_PCIEXBAR_LOW
),
381 PciExBarBase
.Uint32
[0] | MCH_PCIEXBAR_BUS_FF
| MCH_PCIEXBAR_EN
396 RETURN_STATUS PcdStatus
;
404 // Build the CPU HOB with guest RAM size dependent address width and 16-bits
405 // of IO space. (Side note: unlike other HOBs, the CPU HOB is needed during
406 // S3 resume as well, so we build it unconditionally.)
408 BuildCpuHob (mPhysMemAddressWidth
, 16);
411 // Determine platform type and save Host Bridge DID to PCD
413 switch (mHostBridgeDevId
) {
414 case INTEL_82441_DEVICE_ID
:
415 PmCmd
= POWER_MGMT_REGISTER_PIIX4 (PCI_COMMAND_OFFSET
);
416 Pmba
= POWER_MGMT_REGISTER_PIIX4 (PIIX4_PMBA
);
417 PmbaAndVal
= ~(UINT32
)PIIX4_PMBA_MASK
;
418 PmbaOrVal
= PIIX4_PMBA_VALUE
;
419 AcpiCtlReg
= POWER_MGMT_REGISTER_PIIX4 (PIIX4_PMREGMISC
);
420 AcpiEnBit
= PIIX4_PMREGMISC_PMIOSE
;
422 case INTEL_Q35_MCH_DEVICE_ID
:
423 PmCmd
= POWER_MGMT_REGISTER_Q35 (PCI_COMMAND_OFFSET
);
424 Pmba
= POWER_MGMT_REGISTER_Q35 (ICH9_PMBASE
);
425 PmbaAndVal
= ~(UINT32
)ICH9_PMBASE_MASK
;
426 PmbaOrVal
= ICH9_PMBASE_VALUE
;
427 AcpiCtlReg
= POWER_MGMT_REGISTER_Q35 (ICH9_ACPI_CNTL
);
428 AcpiEnBit
= ICH9_ACPI_CNTL_ACPI_EN
;
431 DEBUG ((EFI_D_ERROR
, "%a: Unknown Host Bridge Device ID: 0x%04x\n",
432 __FUNCTION__
, mHostBridgeDevId
));
436 PcdStatus
= PcdSet16S (PcdOvmfHostBridgePciDevId
, mHostBridgeDevId
);
437 ASSERT_RETURN_ERROR (PcdStatus
);
440 // If the appropriate IOspace enable bit is set, assume the ACPI PMBA
441 // has been configured (e.g., by Xen) and skip the setup here.
442 // This matches the logic in AcpiTimerLibConstructor ().
444 if ((PciRead8 (AcpiCtlReg
) & AcpiEnBit
) == 0) {
446 // The PEI phase should be exited with fully accessibe ACPI PM IO space:
449 PciAndThenOr32 (Pmba
, PmbaAndVal
, PmbaOrVal
);
452 // 2. set PCICMD/IOSE
454 PciOr8 (PmCmd
, EFI_PCI_COMMAND_IO_SPACE
);
457 // 3. set ACPI PM IO enable bit (PMREGMISC:PMIOSE or ACPI_CNTL:ACPI_EN)
459 PciOr8 (AcpiCtlReg
, AcpiEnBit
);
462 if (mHostBridgeDevId
== INTEL_Q35_MCH_DEVICE_ID
) {
464 // Set Root Complex Register Block BAR
467 POWER_MGMT_REGISTER_Q35 (ICH9_RCBA
),
468 ICH9_ROOT_COMPLEX_BASE
| ICH9_RCBA_EN
472 // Set PCI Express Register Range Base Address
474 PciExBarInitialization ();
480 BootModeInitialization (
486 if (CmosRead8 (0xF) == 0xFE) {
487 mBootMode
= BOOT_ON_S3_RESUME
;
489 CmosWrite8 (0xF, 0x00);
491 Status
= PeiServicesSetBootMode (mBootMode
);
492 ASSERT_EFI_ERROR (Status
);
494 Status
= PeiServicesInstallPpi (mPpiBootMode
);
495 ASSERT_EFI_ERROR (Status
);
500 ReserveEmuVariableNvStore (
503 EFI_PHYSICAL_ADDRESS VariableStore
;
504 RETURN_STATUS PcdStatus
;
507 // Allocate storage for NV variables early on so it will be
508 // at a consistent address. Since VM memory is preserved
509 // across reboots, this allows the NV variable storage to survive
513 (EFI_PHYSICAL_ADDRESS
)(UINTN
)
514 AllocateAlignedRuntimePages (
515 EFI_SIZE_TO_PAGES (2 * PcdGet32 (PcdFlashNvStorageFtwSpareSize
)),
516 PcdGet32 (PcdFlashNvStorageFtwSpareSize
)
519 "Reserved variable store memory: 0x%lX; size: %dkb\n",
521 (2 * PcdGet32 (PcdFlashNvStorageFtwSpareSize
)) / 1024
523 PcdStatus
= PcdSet64S (PcdEmuVariableNvStoreReserved
, VariableStore
);
524 ASSERT_RETURN_ERROR (PcdStatus
);
535 DEBUG ((EFI_D_INFO
, "CMOS:\n"));
537 for (Loop
= 0; Loop
< 0x80; Loop
++) {
538 if ((Loop
% 0x10) == 0) {
539 DEBUG ((EFI_D_INFO
, "%02x:", Loop
));
541 DEBUG ((EFI_D_INFO
, " %02x", CmosRead8 (Loop
)));
542 if ((Loop
% 0x10) == 0xf) {
543 DEBUG ((EFI_D_INFO
, "\n"));
554 #if defined (MDE_CPU_X64)
555 if (FeaturePcdGet (PcdSmmSmramRequire
) && mS3Supported
) {
557 "%a: S3Resume2Pei doesn't support X64 PEI + SMM yet.\n", __FUNCTION__
));
559 "%a: Please disable S3 on the QEMU command line (see the README),\n",
562 "%a: or build OVMF with \"OvmfPkgIa32X64.dsc\".\n", __FUNCTION__
));
571 Perform Platform PEI initialization.
573 @param FileHandle Handle of the file being invoked.
574 @param PeiServices Describes the list of possible PEI Services.
576 @return EFI_SUCCESS The PEIM initialized successfully.
582 IN EFI_PEI_FILE_HANDLE FileHandle
,
583 IN CONST EFI_PEI_SERVICES
**PeiServices
588 DEBUG ((EFI_D_ERROR
, "Platform PEIM Loaded\n"));
594 if (QemuFwCfgS3Enabled ()) {
595 DEBUG ((EFI_D_INFO
, "S3 support was detected on QEMU\n"));
597 Status
= PcdSetBoolS (PcdAcpiS3Enable
, TRUE
);
598 ASSERT_EFI_ERROR (Status
);
602 BootModeInitialization ();
603 AddressWidthInitialization ();
607 InitializeRamRegions ();
610 DEBUG ((EFI_D_INFO
, "Xen was detected\n"));
615 // Query Host Bridge DID
617 mHostBridgeDevId
= PciRead16 (OVMF_HOSTBRIDGE_DID
);
619 if (mBootMode
!= BOOT_ON_S3_RESUME
) {
620 ReserveEmuVariableNvStore ();
621 PeiFvInitialization ();
622 MemMapInitialization ();
623 NoexecDxeInitialization ();
626 MiscInitialization ();
627 InstallFeatureControlCallback ();