OvmfPkg/OvmfPkg.dec

   1 ## @file
   2 #  EFI/Framework Open Virtual Machine Firmware (OVMF) platform
   3 #
   4 #  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
   5 #
   6 #  SPDX-License-Identifier: BSD-2-Clause-Patent
   7 #
   8 ##
   9
  10 [Defines]
  11   DEC_SPECIFICATION              = 0x00010005
  12   PACKAGE_NAME                   = OvmfPkg
  13   PACKAGE_GUID                   = 2daf5f34-50e5-4b9d-b8e3-5562334d87e5
  14   PACKAGE_VERSION                = 0.1
  15
  16 [Includes]
  17   Include
  18   Csm/Include
  19
  20 [LibraryClasses]
  21   ##  @libraryclass  Loads and boots a Linux kernel image
  22   #
  23   LoadLinuxLib|Include/Library/LoadLinuxLib.h
  24
  25   ##  @libraryclass  Save and restore variables using a file
  26   #
  27   NvVarsFileLib|Include/Library/NvVarsFileLib.h
  28
  29   ##  @libraryclass  Provides services to work with PCI capabilities in PCI
  30   #                  config space.
  31   PciCapLib|Include/Library/PciCapLib.h
  32
  33   ##  @libraryclass  Layered on top of PciCapLib, allows clients to plug an
  34   #                  EFI_PCI_IO_PROTOCOL backend into PciCapLib, for config
  35   #                  space access.
  36   PciCapPciIoLib|Include/Library/PciCapPciIoLib.h
  37
  38   ##  @libraryclass  Layered on top of PciCapLib, allows clients to plug a
  39   #                  PciSegmentLib backend into PciCapLib, for config space
  40   #                  access.
  41   PciCapPciSegmentLib|Include/Library/PciCapPciSegmentLib.h
  42
  43   ##  @libraryclass  Register a status code handler for printing the Boot
  44   #                  Manager's LoadImage() and StartImage() preparations, and
  45   #                  return codes, to the UEFI console.
  46   PlatformBmPrintScLib|Include/Library/PlatformBmPrintScLib.h
  47
  48   ##  @libraryclass  Access QEMU's firmware configuration interface
  49   #
  50   QemuFwCfgLib|Include/Library/QemuFwCfgLib.h
  51
  52   ##  @libraryclass  S3 support for QEMU fw_cfg
  53   #
  54   QemuFwCfgS3Lib|Include/Library/QemuFwCfgS3Lib.h
  55
  56   ##  @libraryclass  Rewrite the BootOrder NvVar based on QEMU's "bootorder"
  57   #                  fw_cfg file.
  58   #
  59   QemuBootOrderLib|Include/Library/QemuBootOrderLib.h
  60
  61   ##  @libraryclass  Serialize (and deserialize) variables
  62   #
  63   SerializeVariablesLib|Include/Library/SerializeVariablesLib.h
  64
  65   ##  @libraryclass  Invoke Xen hypercalls
  66   #
  67   XenHypercallLib|Include/Library/XenHypercallLib.h
  68
  69   ##  @libraryclass  Manage XenBus device path and I/O handles
  70   #
  71   XenIoMmioLib|Include/Library/XenIoMmioLib.h
  72
  73   ##  @libraryclass  Get information about Xen
  74   #
  75   XenPlatformLib|Include/Library/XenPlatformLib.h
  76
  77 [Guids]
  78   gUefiOvmfPkgTokenSpaceGuid          = {0x93bb96af, 0xb9f2, 0x4eb8, {0x94, 0x62, 0xe0, 0xba, 0x74, 0x56, 0x42, 0x36}}
  79   gEfiXenInfoGuid                     = {0xd3b46f3b, 0xd441, 0x1244, {0x9a, 0x12, 0x0, 0x12, 0x27, 0x3f, 0xc1, 0x4d}}
  80   gOvmfPkKek1AppPrefixGuid            = {0x4e32566d, 0x8e9e, 0x4f52, {0x81, 0xd3, 0x5b, 0xb9, 0x71, 0x5f, 0x97, 0x27}}
  81   gOvmfPlatformConfigGuid             = {0x7235c51c, 0x0c80, 0x4cab, {0x87, 0xac, 0x3b, 0x08, 0x4a, 0x63, 0x04, 0xb1}}
  82   gVirtioMmioTransportGuid            = {0x837dca9e, 0xe874, 0x4d82, {0xb2, 0x9a, 0x23, 0xfe, 0x0e, 0x23, 0xd1, 0xe2}}
  83   gQemuRamfbGuid                      = {0x557423a1, 0x63ab, 0x406c, {0xbe, 0x7e, 0x91, 0xcd, 0xbc, 0x08, 0xc4, 0x57}}
  84   gXenBusRootDeviceGuid               = {0xa732241f, 0x383d, 0x4d9c, {0x8a, 0xe1, 0x8e, 0x09, 0x83, 0x75, 0x89, 0xd7}}
  85   gRootBridgesConnectedEventGroupGuid = {0x24a2d66f, 0xeedd, 0x4086, {0x90, 0x42, 0xf2, 0x6e, 0x47, 0x97, 0xee, 0x69}}
  86   gMicrosoftVendorGuid                = {0x77fa9abd, 0x0359, 0x4d32, {0xbd, 0x60, 0x28, 0xf4, 0xe7, 0x8f, 0x78, 0x4b}}
  87   gEfiLegacyBiosGuid                  = {0x2E3044AC, 0x879F, 0x490F, {0x97, 0x60, 0xBB, 0xDF, 0xAF, 0x69, 0x5F, 0x50}}
  88   gEfiLegacyDevOrderVariableGuid      = {0xa56074db, 0x65fe, 0x45f7, {0xbd, 0x21, 0x2d, 0x2b, 0xdd, 0x8e, 0x96, 0x52}}
  89
  90 [Ppis]
  91   # PPI whose presence in the PPI database signals that the TPM base address
  92   # has been discovered and recorded
  93   gOvmfTpmDiscoveredPpiGuid           = {0xb9a61ad0, 0x2802, 0x41f3, {0xb5, 0x13, 0x96, 0x51, 0xce, 0x6b, 0xd5, 0x75}}
  94
  95 [Protocols]
  96   gVirtioDeviceProtocolGuid           = {0xfa920010, 0x6785, 0x4941, {0xb6, 0xec, 0x49, 0x8c, 0x57, 0x9f, 0x16, 0x0a}}
  97   gXenBusProtocolGuid                 = {0x3d3ca290, 0xb9a5, 0x11e3, {0xb7, 0x5d, 0xb8, 0xac, 0x6f, 0x7d, 0x65, 0xe6}}
  98   gXenIoProtocolGuid                  = {0x6efac84f, 0x0ab0, 0x4747, {0x81, 0xbe, 0x85, 0x55, 0x62, 0x59, 0x04, 0x49}}
  99   gIoMmuAbsentProtocolGuid            = {0xf8775d50, 0x8abd, 0x4adf, {0x92, 0xac, 0x85, 0x3e, 0x51, 0xf6, 0xc8, 0xdc}}
 100   gEfiLegacy8259ProtocolGuid          = {0x38321dba, 0x4fe0, 0x4e17, {0x8a, 0xec, 0x41, 0x30, 0x55, 0xea, 0xed, 0xc1}}
 101   gEfiFirmwareVolumeProtocolGuid      = {0x389F751F, 0x1838, 0x4388, {0x83, 0x90, 0xcd, 0x81, 0x54, 0xbd, 0x27, 0xf8}}
 102   gEfiIsaAcpiProtocolGuid             = {0x64a892dc, 0x5561, 0x4536, {0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55}}
 103   gEfiIsaIoProtocolGuid               = {0x7ee2bd44, 0x3da0, 0x11d4, {0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d}}
 104   gEfiLegacyBiosProtocolGuid          = {0xdb9a1e3d, 0x45cb, 0x4abb, {0x85, 0x3b, 0xe5, 0x38, 0x7f, 0xdb, 0x2e, 0x2d}}
 105   gEfiLegacyBiosPlatformProtocolGuid  = {0x783658a3, 0x4172, 0x4421, {0xa2, 0x99, 0xe0, 0x09, 0x07, 0x9c, 0x0c, 0xb4}}
 106   gEfiLegacyInterruptProtocolGuid     = {0x31ce593d, 0x108a, 0x485d, {0xad, 0xb2, 0x78, 0xf2, 0x1f, 0x29, 0x66, 0xbe}}
 107   gEfiVgaMiniPortProtocolGuid         = {0xc7735a2f, 0x88f5, 0x4882, {0xae, 0x63, 0xfa, 0xac, 0x8c, 0x8b, 0x86, 0xb3}}
 108
 109 [PcdsFixedAtBuild]
 110   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfPeiMemFvBase|0x0|UINT32|0
 111   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfPeiMemFvSize|0x0|UINT32|1
 112   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfDxeMemFvBase|0x0|UINT32|0x15
 113   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfDxeMemFvSize|0x0|UINT32|0x16
 114
 115   ## This flag is used to control the destination port for PlatformDebugLibIoPort
 116   gUefiOvmfPkgTokenSpaceGuid.PcdDebugIoPort|0x402|UINT16|4
 117
 118   ## When VirtioScsiDxe is instantiated for a HBA, the numbers of targets and
 119   #  LUNs are retrieved from the host during virtio-scsi setup.
 120   #  MdeModulePkg/Bus/Scsi/ScsiBusDxe then scans all MaxTarget * MaxLun
 121   #  possible devices. This can take extremely long, for example with
 122   #  MaxTarget=255 and MaxLun=16383. The *inclusive* constants below limit
 123   #  MaxTarget and MaxLun, independently, should the host report higher values,
 124   #  so that scanning the number of devices given by their product is still
 125   #  acceptably fast.
 126   gUefiOvmfPkgTokenSpaceGuid.PcdVirtioScsiMaxTargetLimit|31|UINT16|6
 127   gUefiOvmfPkgTokenSpaceGuid.PcdVirtioScsiMaxLunLimit|7|UINT32|7
 128
 129   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageEventLogBase|0x0|UINT32|0x8
 130   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageEventLogSize|0x0|UINT32|0x9
 131   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFirmwareFdSize|0x0|UINT32|0xa
 132   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFirmwareBlockSize|0|UINT32|0xb
 133   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageVariableBase|0x0|UINT32|0xc
 134   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageFtwSpareBase|0x0|UINT32|0xd
 135   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageFtwWorkingBase|0x0|UINT32|0xe
 136   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFdBaseAddress|0x0|UINT32|0xf
 137   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesBase|0x0|UINT32|0x11
 138   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesSize|0x0|UINT32|0x12
 139   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamBase|0x0|UINT32|0x13
 140   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamSize|0x0|UINT32|0x14
 141   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageBase|0x0|UINT32|0x18
 142   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageSize|0x0|UINT32|0x19
 143   gUefiOvmfPkgTokenSpaceGuid.PcdGuidedExtractHandlerTableSize|0x0|UINT32|0x1a
 144   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfDecompressionScratchEnd|0x0|UINT32|0x1f
 145
 146   ## Pcd8259LegacyModeMask defines the default mask value for platform. This
 147   #  value is determined.
 148   #  1) If platform only support pure UEFI, value should be set to 0xFFFF or
 149   #     0xFFFE; Because only clock interrupt is allowed in legacy mode in pure
 150   #     UEFI platform.
 151   #  2) If platform install CSM and use thunk module:
 152   #     a) If thunk call provided by CSM binary requires some legacy interrupt
 153   #        support, the corresponding bit should be opened as 0.
 154   #        For example, if keyboard interfaces provided CSM binary use legacy
 155   #        keyboard interrupt in 8259 bit 1, then the value should be set to
 156   #        0xFFFC.
 157   #     b) If all thunk call provied by CSM binary do not require legacy
 158   #        interrupt support, value should be set to 0xFFFF or 0xFFFE.
 159   #
 160   #  The default value of legacy mode mask could be changed by
 161   #  EFI_LEGACY_8259_PROTOCOL->SetMask(). But it is rarely need change it
 162   #  except some special cases such as when initializing the CSM binary, it
 163   #  should be set to 0xFFFF to mask all legacy interrupt. Please restore the
 164   #  original legacy mask value if changing is made for these special case.
 165   gUefiOvmfPkgTokenSpaceGuid.Pcd8259LegacyModeMask|0xFFFF|UINT16|0x3
 166
 167   ## Pcd8259LegacyModeEdgeLevel defines the default edge level for legacy
 168   #  mode's interrrupt controller.
 169   #  For the corresponding bits, 0 = Edge triggered and 1 = Level triggered.
 170   gUefiOvmfPkgTokenSpaceGuid.Pcd8259LegacyModeEdgeLevel|0x0000|UINT16|0x5
 171
 172   ## Indicates if BiosVideo driver will switch to 80x25 Text VGA Mode when
 173   #  exiting boot service.
 174   #   TRUE  - Switch to Text VGA Mode.
 175   #   FALSE - Does not switch to Text VGA Mode.
 176   gUefiOvmfPkgTokenSpaceGuid.PcdBiosVideoSetTextVgaModeEnable|FALSE|BOOLEAN|0x28
 177
 178   ## Indicates if BiosVideo driver will check for VESA BIOS Extension service
 179   #  support.
 180   #   TRUE  - Check for VESA BIOS Extension service.
 181   #   FALSE - Does not check for VESA BIOS Extension service.
 182   gUefiOvmfPkgTokenSpaceGuid.PcdBiosVideoCheckVbeEnable|TRUE|BOOLEAN|0x29
 183
 184   ## Indicates if BiosVideo driver will check for VGA service support.
 185   #  NOTE: If both PcdBiosVideoCheckVbeEnable and PcdBiosVideoCheckVgaEnable
 186   #  are set to FALSE, that means Graphics Output protocol will not be
 187   #  installed, the VGA miniport protocol will be installed instead.
 188   #   TRUE  - Check for VGA service.<BR>
 189   #   FALSE - Does not check for VGA service.<BR>
 190   gUefiOvmfPkgTokenSpaceGuid.PcdBiosVideoCheckVgaEnable|TRUE|BOOLEAN|0x2a
 191
 192   ## Indicates if memory space for legacy region will be set as cacheable.
 193   #   TRUE  - Set cachebility for legacy region.
 194   #   FALSE - Does not set cachebility for legacy region.
 195   gUefiOvmfPkgTokenSpaceGuid.PcdLegacyBiosCacheLegacyRegion|TRUE|BOOLEAN|0x2b
 196
 197   ## Specify memory size with bytes to reserve EBDA below 640K for OPROM.
 198   #  The value should be a multiple of 4KB.
 199   gUefiOvmfPkgTokenSpaceGuid.PcdEbdaReservedMemorySize|0x8000|UINT32|0x2c
 200
 201   ## Specify memory base address for OPROM to find free memory.
 202   #  Some OPROMs do not use EBDA or PMM to allocate memory for its usage,
 203   #  instead they find the memory filled with zero from 0x20000.
 204   #  The value should be a multiple of 4KB.
 205   #  The range should be below the EBDA reserved range from
 206   #  (CONVENTIONAL_MEMORY_TOP - Reserved EBDA Memory Size) to
 207   #  CONVENTIONAL_MEMORY_TOP.
 208   gUefiOvmfPkgTokenSpaceGuid.PcdOpromReservedMemoryBase|0x60000|UINT32|0x2d
 209
 210   ## Specify memory size with bytes for OPROM to find free memory.
 211   #  The value should be a multiple of 4KB. And the range should be below the
 212   #  EBDA reserved range from
 213   #  (CONVENTIONAL_MEMORY_TOP - Reserved EBDA Memory Size) to
 214   #  CONVENTIONAL_MEMORY_TOP.
 215   gUefiOvmfPkgTokenSpaceGuid.PcdOpromReservedMemorySize|0x28000|UINT32|0x2e
 216
 217   ## Specify the end of address below 1MB for the OPROM.
 218   #  The last shadowed OpROM should not exceed this address.
 219   gUefiOvmfPkgTokenSpaceGuid.PcdEndOpromShadowAddress|0xdffff|UINT32|0x2f
 220
 221   ## Specify the low PMM (Post Memory Manager) size with bytes below 1MB.
 222   #  The value should be a multiple of 4KB.
 223   # @Prompt Low PMM (Post Memory Manager) Size
 224   gUefiOvmfPkgTokenSpaceGuid.PcdLowPmmMemorySize|0x10000|UINT32|0x30
 225
 226   ## Specify the high PMM (Post Memory Manager) size with bytes above 1MB.
 227   #  The value should be a multiple of 4KB.
 228   gUefiOvmfPkgTokenSpaceGuid.PcdHighPmmMemorySize|0x400000|UINT32|0x31
 229
 230   gUefiOvmfPkgTokenSpaceGuid.PcdXenPvhStartOfDayStructPtr|0x0|UINT32|0x17
 231   gUefiOvmfPkgTokenSpaceGuid.PcdXenPvhStartOfDayStructPtrSize|0x0|UINT32|0x32
 232
 233   ## Number of page frames to use for storing grant table entries.
 234   gUefiOvmfPkgTokenSpaceGuid.PcdXenGrantFrames|4|UINT32|0x33
 235
 236 [PcdsDynamic, PcdsDynamicEx]
 237   gUefiOvmfPkgTokenSpaceGuid.PcdEmuVariableEvent|0|UINT64|2
 238   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashVariablesEnable|FALSE|BOOLEAN|0x10
 239   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfHostBridgePciDevId|0|UINT16|0x1b
 240   gUefiOvmfPkgTokenSpaceGuid.PcdQemuSmbiosValidated|FALSE|BOOLEAN|0x21
 241
 242   ## The IO port aperture shared by all PCI root bridges.
 243   #
 244   gUefiOvmfPkgTokenSpaceGuid.PcdPciIoBase|0x0|UINT64|0x22
 245   gUefiOvmfPkgTokenSpaceGuid.PcdPciIoSize|0x0|UINT64|0x23
 246
 247   ## The 32-bit MMIO aperture shared by all PCI root bridges.
 248   #
 249   gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio32Base|0x0|UINT64|0x24
 250   gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio32Size|0x0|UINT64|0x25
 251
 252   ## The 64-bit MMIO aperture shared by all PCI root bridges.
 253   #
 254   gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio64Base|0x0|UINT64|0x26
 255   gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio64Size|0x0|UINT64|0x27
 256
 257   ## The following setting controls how many megabytes we configure as TSEG on
 258   #  Q35, for SMRAM purposes. Permitted defaults are: 1, 2, 8. Other defaults
 259   #  cause undefined behavior. During boot, the PCD is updated by PlatformPei
 260   #  to reflect the extended TSEG size, if one is advertized by QEMU.
 261   #
 262   #  This PCD is only accessed if PcdSmmSmramRequire is TRUE (see below).
 263   gUefiOvmfPkgTokenSpaceGuid.PcdQ35TsegMbytes|8|UINT16|0x20
 264
 265   ## Set to TRUE by PlatformPei if the Q35 board supports the "SMRAM at default
 266   #  SMBASE" feature.
 267   #
 268   #  This PCD is only accessed if PcdSmmSmramRequire is TRUE (see below).
 269   gUefiOvmfPkgTokenSpaceGuid.PcdQ35SmramAtDefaultSmbase|FALSE|BOOLEAN|0x34
 270
 271 [PcdsFeatureFlag]
 272   gUefiOvmfPkgTokenSpaceGuid.PcdQemuBootOrderPciTranslation|TRUE|BOOLEAN|0x1c
 273   gUefiOvmfPkgTokenSpaceGuid.PcdQemuBootOrderMmioTranslation|FALSE|BOOLEAN|0x1d
 274
 275   ## This feature flag enables SMM/SMRAM support. Note that it also requires
 276   #  such support from the underlying QEMU instance; if that support is not
 277   #  present, the firmware will reject continuing after a certain point.
 278   #
 279   #  The flag also acts as a general "security switch"; when TRUE, many
 280   #  components will change behavior, with the goal of preventing a malicious
 281   #  runtime OS from tampering with firmware structures (special memory ranges
 282   #  used by OVMF, the varstore pflash chip, LockBox etc).
 283   gUefiOvmfPkgTokenSpaceGuid.PcdSmmSmramRequire|FALSE|BOOLEAN|0x1e
 284
 285   ## Informs modules (including pre-DXE-phase modules) whether the platform
 286   #  firmware contains a CSM (Compatibility Support Module).
 287   #
 288   gUefiOvmfPkgTokenSpaceGuid.PcdCsmEnable|FALSE|BOOLEAN|0x35