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