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