OvmfPkg/OvmfPkg.dec: Add definitions for CSM-related Guid & Protocol
[mirror_edk2.git] / OvmfPkg / OvmfPkg.dec
1 ## @file\r
2 #  EFI/Framework Open Virtual Machine Firmware (OVMF) platform\r
3 #\r
4 #  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
5 #\r
6 #  SPDX-License-Identifier: BSD-2-Clause-Patent\r
7 #\r
8 ##\r
9 \r
10 [Defines]\r
11   DEC_SPECIFICATION              = 0x00010005\r
12   PACKAGE_NAME                   = OvmfPkg\r
13   PACKAGE_GUID                   = 2daf5f34-50e5-4b9d-b8e3-5562334d87e5\r
14   PACKAGE_VERSION                = 0.1\r
15 \r
16 [Includes]\r
17   Include\r
18 \r
19 [LibraryClasses]\r
20   ##  @libraryclass  Loads and boots a Linux kernel image\r
21   #\r
22   LoadLinuxLib|Include/Library/LoadLinuxLib.h\r
23 \r
24   ##  @libraryclass  Save and restore variables using a file\r
25   #\r
26   NvVarsFileLib|Include/Library/NvVarsFileLib.h\r
27 \r
28   ##  @libraryclass  Provides services to work with PCI capabilities in PCI\r
29   #                  config space.\r
30   PciCapLib|Include/Library/PciCapLib.h\r
31 \r
32   ##  @libraryclass  Layered on top of PciCapLib, allows clients to plug an\r
33   #                  EFI_PCI_IO_PROTOCOL backend into PciCapLib, for config\r
34   #                  space access.\r
35   PciCapPciIoLib|Include/Library/PciCapPciIoLib.h\r
36 \r
37   ##  @libraryclass  Layered on top of PciCapLib, allows clients to plug a\r
38   #                  PciSegmentLib backend into PciCapLib, for config space\r
39   #                  access.\r
40   PciCapPciSegmentLib|Include/Library/PciCapPciSegmentLib.h\r
41 \r
42   ##  @libraryclass  Register a status code handler for printing the Boot\r
43   #                  Manager's LoadImage() and StartImage() preparations, and\r
44   #                  return codes, to the UEFI console.\r
45   PlatformBmPrintScLib|Include/Library/PlatformBmPrintScLib.h\r
46 \r
47   ##  @libraryclass  Access QEMU's firmware configuration interface\r
48   #\r
49   QemuFwCfgLib|Include/Library/QemuFwCfgLib.h\r
50 \r
51   ##  @libraryclass  S3 support for QEMU fw_cfg\r
52   #\r
53   QemuFwCfgS3Lib|Include/Library/QemuFwCfgS3Lib.h\r
54 \r
55   ##  @libraryclass  Rewrite the BootOrder NvVar based on QEMU's "bootorder"\r
56   #                  fw_cfg file.\r
57   #\r
58   QemuBootOrderLib|Include/Library/QemuBootOrderLib.h\r
59 \r
60   ##  @libraryclass  Serialize (and deserialize) variables\r
61   #\r
62   SerializeVariablesLib|Include/Library/SerializeVariablesLib.h\r
63 \r
64   ##  @libraryclass  Invoke Xen hypercalls\r
65   #\r
66   XenHypercallLib|Include/Library/XenHypercallLib.h\r
67 \r
68   ##  @libraryclass  Manage XenBus device path and I/O handles\r
69   #\r
70   XenIoMmioLib|Include/Library/XenIoMmioLib.h\r
71 \r
72 [Guids]\r
73   gUefiOvmfPkgTokenSpaceGuid          = {0x93bb96af, 0xb9f2, 0x4eb8, {0x94, 0x62, 0xe0, 0xba, 0x74, 0x56, 0x42, 0x36}}\r
74   gEfiXenInfoGuid                     = {0xd3b46f3b, 0xd441, 0x1244, {0x9a, 0x12, 0x0, 0x12, 0x27, 0x3f, 0xc1, 0x4d}}\r
75   gOvmfPkKek1AppPrefixGuid            = {0x4e32566d, 0x8e9e, 0x4f52, {0x81, 0xd3, 0x5b, 0xb9, 0x71, 0x5f, 0x97, 0x27}}\r
76   gOvmfPlatformConfigGuid             = {0x7235c51c, 0x0c80, 0x4cab, {0x87, 0xac, 0x3b, 0x08, 0x4a, 0x63, 0x04, 0xb1}}\r
77   gVirtioMmioTransportGuid            = {0x837dca9e, 0xe874, 0x4d82, {0xb2, 0x9a, 0x23, 0xfe, 0x0e, 0x23, 0xd1, 0xe2}}\r
78   gQemuRamfbGuid                      = {0x557423a1, 0x63ab, 0x406c, {0xbe, 0x7e, 0x91, 0xcd, 0xbc, 0x08, 0xc4, 0x57}}\r
79   gXenBusRootDeviceGuid               = {0xa732241f, 0x383d, 0x4d9c, {0x8a, 0xe1, 0x8e, 0x09, 0x83, 0x75, 0x89, 0xd7}}\r
80   gRootBridgesConnectedEventGroupGuid = {0x24a2d66f, 0xeedd, 0x4086, {0x90, 0x42, 0xf2, 0x6e, 0x47, 0x97, 0xee, 0x69}}\r
81   gMicrosoftVendorGuid                = {0x77fa9abd, 0x0359, 0x4d32, {0xbd, 0x60, 0x28, 0xf4, 0xe7, 0x8f, 0x78, 0x4b}}\r
82   gEfiLegacyBiosGuid                  = {0x2E3044AC, 0x879F, 0x490F, {0x97, 0x60, 0xBB, 0xDF, 0xAF, 0x69, 0x5F, 0x50}}\r
83   gEfiLegacyDevOrderVariableGuid      = {0xa56074db, 0x65fe, 0x45f7, {0xbd, 0x21, 0x2d, 0x2b, 0xdd, 0x8e, 0x96, 0x52}}\r
84 \r
85 [Protocols]\r
86   gVirtioDeviceProtocolGuid           = {0xfa920010, 0x6785, 0x4941, {0xb6, 0xec, 0x49, 0x8c, 0x57, 0x9f, 0x16, 0x0a}}\r
87   gXenBusProtocolGuid                 = {0x3d3ca290, 0xb9a5, 0x11e3, {0xb7, 0x5d, 0xb8, 0xac, 0x6f, 0x7d, 0x65, 0xe6}}\r
88   gXenIoProtocolGuid                  = {0x6efac84f, 0x0ab0, 0x4747, {0x81, 0xbe, 0x85, 0x55, 0x62, 0x59, 0x04, 0x49}}\r
89   gIoMmuAbsentProtocolGuid            = {0xf8775d50, 0x8abd, 0x4adf, {0x92, 0xac, 0x85, 0x3e, 0x51, 0xf6, 0xc8, 0xdc}}\r
90   gEfiLegacy8259ProtocolGuid          = {0x38321dba, 0x4fe0, 0x4e17, {0x8a, 0xec, 0x41, 0x30, 0x55, 0xea, 0xed, 0xc1}}\r
91   gEfiFirmwareVolumeProtocolGuid      = {0x389F751F, 0x1838, 0x4388, {0x83, 0x90, 0xcd, 0x81, 0x54, 0xbd, 0x27, 0xf8}}\r
92   gEfiIsaAcpiProtocolGuid             = {0x64a892dc, 0x5561, 0x4536, {0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55}}\r
93   gEfiIsaIoProtocolGuid               = {0x7ee2bd44, 0x3da0, 0x11d4, {0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d}}\r
94   gEfiLegacyBiosProtocolGuid          = {0xdb9a1e3d, 0x45cb, 0x4abb, {0x85, 0x3b, 0xe5, 0x38, 0x7f, 0xdb, 0x2e, 0x2d}}\r
95   gEfiLegacyBiosPlatformProtocolGuid  = {0x783658a3, 0x4172, 0x4421, {0xa2, 0x99, 0xe0, 0x09, 0x07, 0x9c, 0x0c, 0xb4}}\r
96   gEfiLegacyInterruptProtocolGuid     = {0x31ce593d, 0x108a, 0x485d, {0xad, 0xb2, 0x78, 0xf2, 0x1f, 0x29, 0x66, 0xbe}}\r
97   gEfiVgaMiniPortProtocolGuid         = {0xc7735a2f, 0x88f5, 0x4882, {0xae, 0x63, 0xfa, 0xac, 0x8c, 0x8b, 0x86, 0xb3}}\r
98 \r
99 [PcdsFixedAtBuild]\r
100   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfPeiMemFvBase|0x0|UINT32|0\r
101   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfPeiMemFvSize|0x0|UINT32|1\r
102   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfDxeMemFvBase|0x0|UINT32|0x15\r
103   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfDxeMemFvSize|0x0|UINT32|0x16\r
104 \r
105   ## This flag is used to control the destination port for PlatformDebugLibIoPort\r
106   gUefiOvmfPkgTokenSpaceGuid.PcdDebugIoPort|0x402|UINT16|4\r
107 \r
108   ## When VirtioScsiDxe is instantiated for a HBA, the numbers of targets and\r
109   #  LUNs are retrieved from the host during virtio-scsi setup.\r
110   #  MdeModulePkg/Bus/Scsi/ScsiBusDxe then scans all MaxTarget * MaxLun\r
111   #  possible devices. This can take extremely long, for example with\r
112   #  MaxTarget=255 and MaxLun=16383. The *inclusive* constants below limit\r
113   #  MaxTarget and MaxLun, independently, should the host report higher values,\r
114   #  so that scanning the number of devices given by their product is still\r
115   #  acceptably fast.\r
116   gUefiOvmfPkgTokenSpaceGuid.PcdVirtioScsiMaxTargetLimit|31|UINT16|6\r
117   gUefiOvmfPkgTokenSpaceGuid.PcdVirtioScsiMaxLunLimit|7|UINT32|7\r
118 \r
119   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageEventLogBase|0x0|UINT32|0x8\r
120   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageEventLogSize|0x0|UINT32|0x9\r
121   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFirmwareFdSize|0x0|UINT32|0xa\r
122   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFirmwareBlockSize|0|UINT32|0xb\r
123   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageVariableBase|0x0|UINT32|0xc\r
124   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageFtwSpareBase|0x0|UINT32|0xd\r
125   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashNvStorageFtwWorkingBase|0x0|UINT32|0xe\r
126   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFdBaseAddress|0x0|UINT32|0xf\r
127   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesBase|0x0|UINT32|0x11\r
128   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesSize|0x0|UINT32|0x12\r
129   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamBase|0x0|UINT32|0x13\r
130   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamSize|0x0|UINT32|0x14\r
131   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageBase|0x0|UINT32|0x18\r
132   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageSize|0x0|UINT32|0x19\r
133   gUefiOvmfPkgTokenSpaceGuid.PcdGuidedExtractHandlerTableSize|0x0|UINT32|0x1a\r
134   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfDecompressionScratchEnd|0x0|UINT32|0x1f\r
135 \r
136   ## Pcd8259LegacyModeMask defines the default mask value for platform. This\r
137   #  value is determined.\r
138   #  1) If platform only support pure UEFI, value should be set to 0xFFFF or\r
139   #     0xFFFE; Because only clock interrupt is allowed in legacy mode in pure\r
140   #     UEFI platform.\r
141   #  2) If platform install CSM and use thunk module:\r
142   #     a) If thunk call provided by CSM binary requires some legacy interrupt\r
143   #        support, the corresponding bit should be opened as 0.\r
144   #        For example, if keyboard interfaces provided CSM binary use legacy\r
145   #        keyboard interrupt in 8259 bit 1, then the value should be set to\r
146   #        0xFFFC.\r
147   #     b) If all thunk call provied by CSM binary do not require legacy\r
148   #        interrupt support, value should be set to 0xFFFF or 0xFFFE.\r
149   #\r
150   #  The default value of legacy mode mask could be changed by\r
151   #  EFI_LEGACY_8259_PROTOCOL->SetMask(). But it is rarely need change it\r
152   #  except some special cases such as when initializing the CSM binary, it\r
153   #  should be set to 0xFFFF to mask all legacy interrupt. Please restore the\r
154   #  original legacy mask value if changing is made for these special case.\r
155   gUefiOvmfPkgTokenSpaceGuid.Pcd8259LegacyModeMask|0xFFFF|UINT16|0x3\r
156 \r
157   ## Pcd8259LegacyModeEdgeLevel defines the default edge level for legacy\r
158   #  mode's interrrupt controller.\r
159   #  For the corresponding bits, 0 = Edge triggered and 1 = Level triggered.\r
160   gUefiOvmfPkgTokenSpaceGuid.Pcd8259LegacyModeEdgeLevel|0x0000|UINT16|0x5\r
161 \r
162 [PcdsDynamic, PcdsDynamicEx]\r
163   gUefiOvmfPkgTokenSpaceGuid.PcdEmuVariableEvent|0|UINT64|2\r
164   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashVariablesEnable|FALSE|BOOLEAN|0x10\r
165   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfHostBridgePciDevId|0|UINT16|0x1b\r
166   gUefiOvmfPkgTokenSpaceGuid.PcdQemuSmbiosValidated|FALSE|BOOLEAN|0x21\r
167 \r
168   ## The IO port aperture shared by all PCI root bridges.\r
169   #\r
170   gUefiOvmfPkgTokenSpaceGuid.PcdPciIoBase|0x0|UINT64|0x22\r
171   gUefiOvmfPkgTokenSpaceGuid.PcdPciIoSize|0x0|UINT64|0x23\r
172 \r
173   ## The 32-bit MMIO aperture shared by all PCI root bridges.\r
174   #\r
175   gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio32Base|0x0|UINT64|0x24\r
176   gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio32Size|0x0|UINT64|0x25\r
177 \r
178   ## The 64-bit MMIO aperture shared by all PCI root bridges.\r
179   #\r
180   gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio64Base|0x0|UINT64|0x26\r
181   gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio64Size|0x0|UINT64|0x27\r
182 \r
183   ## The following setting controls how many megabytes we configure as TSEG on\r
184   #  Q35, for SMRAM purposes. Permitted defaults are: 1, 2, 8. Other defaults\r
185   #  cause undefined behavior. During boot, the PCD is updated by PlatformPei\r
186   #  to reflect the extended TSEG size, if one is advertized by QEMU.\r
187   #\r
188   #  This PCD is only accessed if PcdSmmSmramRequire is TRUE (see below).\r
189   gUefiOvmfPkgTokenSpaceGuid.PcdQ35TsegMbytes|8|UINT16|0x20\r
190 \r
191 [PcdsFeatureFlag]\r
192   gUefiOvmfPkgTokenSpaceGuid.PcdQemuBootOrderPciTranslation|TRUE|BOOLEAN|0x1c\r
193   gUefiOvmfPkgTokenSpaceGuid.PcdQemuBootOrderMmioTranslation|FALSE|BOOLEAN|0x1d\r
194 \r
195   ## This feature flag enables SMM/SMRAM support. Note that it also requires\r
196   #  such support from the underlying QEMU instance; if that support is not\r
197   #  present, the firmware will reject continuing after a certain point.\r
198   #\r
199   #  The flag also acts as a general "security switch"; when TRUE, many\r
200   #  components will change behavior, with the goal of preventing a malicious\r
201   #  runtime OS from tampering with firmware structures (special memory ranges\r
202   #  used by OVMF, the varstore pflash chip, LockBox etc).\r
203   gUefiOvmfPkgTokenSpaceGuid.PcdSmmSmramRequire|FALSE|BOOLEAN|0x1e\r