]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/MdeModulePkg.dec
retire gEfiAlternateFvBlockGuid. All platform FvbRuntimeDxe drivers will not produce...
[mirror_edk2.git] / MdeModulePkg / MdeModulePkg.dec
1 ## @file MdeModulePkg.dec
2 #
3 # This package provides the modules that conform to EFI/PI Industry standards.
4 # It also provides the defintions(including PPIs/PROTOCOLs/GUIDs and library classes)
5 # and libraries instances, which are used for those modules.
6 #
7 # Copyright (c) 2007 - 2009, Intel Corporation.
8 #
9 # All rights reserved.
10 # This program and the accompanying materials are licensed and made available under
11 # the terms and conditions of the BSD License which accompanies this distribution.
12 # The full text of the license may be found at
13 # http://opensource.org/licenses/bsd-license.php
14 #
15 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #
18 ##
19
20
21 [Defines]
22 DEC_SPECIFICATION = 0x00010005
23 PACKAGE_NAME = MdeModulePkg
24 PACKAGE_GUID = BA0D78D6-2CAF-414b-BD4D-B6762A894288
25 PACKAGE_VERSION = 0.1
26
27 [Includes.common]
28 Include
29
30
31 [LibraryClasses.common]
32 ## @libraryclass IpIo layer upon EFI IP4 Protocol.
33 # This library is only intended to be used by UEFI network stack modules.
34 IpIoLib|Include/Library/IpIoLib.h
35
36 ## @libraryclass Basic function for UEFI network stack.
37 # This library is only intended to be used by UEFI network stack modules.
38 NetLib|Include/Library/NetLib.h
39
40 ## @libraryclass The helper routines to access UDP service.
41 # This library is only intended to be used by UEFI network stack modules.
42 UdpIoLib|Include/Library/UdpIoLib.h
43
44 ## @libraryclass Defines a set of methods to reset whole system.
45 ResetSystemLib|Include/Library/ResetSystemLib.h
46
47 ## @libraryclass Defines a set of methods related do S3 mode.
48 S3Lib|Include/Library/S3Lib.h
49
50 ## @libraryclass Defines a set of methods related recovery mode.
51 RecoveryLib|Include/Library/RecoveryLib.h
52
53 ## @libraryclass Basic platform driver override functions.
54 # This library is only intended to be used by Platform Driver Override Dxe Driver and Application.
55 PlatformDriverOverrideLib|Include/Library/PlatformDriverOverrideLib.h
56
57 ## @libraryclass Provides HII related functions.
58 HiiLib|Include/Library/HiiLib.h
59
60 ## @libraryclass Provides a set of interfaces to do IFR opcode creation and interact with a UEFI Form Browser.
61 IfrSupportLib|Include/Library/IfrSupportLib.h
62
63 ## @libraryclass Includes two extended HII functions to create and destory Hii Package
64 # by create the virtual Driver Handle.
65 ##
66 ExtendedHiiLib|Include/Library/ExtendedHiiLib.h
67
68 ## @libraryclass Defines APIs that is related to IFR operations but specific to EDK II
69 # implementation.
70 ##
71 ExtendedIfrSupportLib|Include/Library/ExtendedIfrSupportLib.h
72
73 ## @libraryclass Defines a set of interfaces on how to process capusle image update.
74 CapsuleLib|Include/Library/CapsuleLib.h
75
76 ## @libraryclass Library for Deferred Procedure Calls.
77 DpcLib|Include/Library/DpcLib.h
78
79 ## @libraryclass Provides APIs for system memory test.
80 ##
81 BaseMemoryTestLib|Include/Library/BaseMemoryTestLib.h
82
83 [Guids.common]
84 ## MdeModule package token space guid
85 ## Include/Guid/MdeModulePkgTokenSpace.h
86 gEfiMdeModulePkgTokenSpaceGuid = { 0xA1AFF049, 0xFDEB, 0x442a, { 0xB3, 0x20, 0x13, 0xAB, 0x4C, 0xB7, 0x2B, 0xBC }}
87
88 ## Hob guid for Pcd DataBase
89 ## Include/Guid/PcdDataBaseHobGuid.h
90 gPcdDataBaseHobGuid = { 0xEA296D92, 0x0B69, 0x423C, { 0x8C, 0x28, 0x33, 0xB4, 0xE0, 0xA9, 0x12, 0x68 }}
91
92 ## Guid for EDKII implementation GUIDed opcodes
93 # Include/Guid/MdeModuleHii.h
94 gEfiIfrTianoGuid = { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce }}
95
96 ## Guid for Framework vfr GUIDed opcodes.
97 # Include/Guid/MdeModuleHii.h
98 gEfiIfrFrameworkGuid = { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 }}
99
100 ## Guid to specify the System Non Volatile FV
101 ## Include/Guid/SystemNvDataGuid.h
102 gEfiSystemNvDataFvGuid = { 0xFFF12B8D, 0x7696, 0x4C8B, { 0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50 }}
103
104 ## Guid specify the device is the console out device.
105 ## Include/Guid/ConsoleOutDevice.h
106 gEfiConsoleOutDeviceGuid = { 0xD3B36F2C, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
107
108 ## Guid specify the device is the console in device.
109 ## Include/Guid/ConsoleInDevice.h
110 gEfiConsoleInDeviceGuid = { 0xD3B36F2B, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
111
112 ## Hob and Variable guid specify the platform memory type information.
113 ## Include/Guid/MemoryTypeInformation.h
114 gEfiMemoryTypeInformationGuid = { 0x4C19049F, 0x4137, 0x4DD3, { 0x9C, 0x10, 0x8B, 0x97, 0xA8, 0x3F, 0xFD, 0xFA }}
115
116 ## Capsule update hob and variable guid
117 ## Include/Guid/CapsuleVendor.h
118 gEfiCapsuleVendorGuid = { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 }}
119
120 ## Guid specifiy the device is the StdErr device.
121 ## Include/Guid/StandardErrorDevice.h
122 gEfiStandardErrorDeviceGuid = { 0xD3B36F2D, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
123
124 ## Guid acted as variable store header's signature and to specify the variable list entries put in the EFI system table.
125 ## Include/Guid/VariableFormat.h
126 gEfiVariableGuid = { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}
127
128 ## Platform Override Variable guid
129 ## Include/Guid/OverrideVariable.h
130 gEfiOverrideVariableGuid = { 0x8e3d4ad5, 0xf762, 0x438a, { 0xa1, 0xc1, 0x5b, 0x9f, 0xe6, 0x8c, 0x6b, 0x15 }}
131
132 ## Performance protocol guid that also acts as the performance HOB guid and performance variable GUID
133 ## Include/Guid/Performance.h
134 gPerformanceProtocolGuid = { 0x76B6BDFA, 0x2ACD, 0x4462, { 0x9E, 0x3F, 0xCB, 0x58, 0xC9, 0x69, 0xD9, 0x37 }}
135
136 ## Guid is defined for CRC32 encapsulation scheme.
137 ## Include/Guid/Crc32GuidedSectionExtraction.h
138 gEfiCrc32GuidedSectionExtractionGuid = { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }
139
140 [Protocols.common]
141 ## Load File protocol provides capability to load and unload EFI image into memory and execute it.
142 ## Include/Protocol/LoadPe32Image.h
143 gEfiLoadPeImageProtocolGuid = { 0x5CB5C776, 0x60D5, 0x45EE, { 0x88, 0x3C, 0x45, 0x27, 0x08, 0xCD, 0x74, 0x3F }}
144
145 ## Print protocol defines six basic print functions to print the format unicode and ascii string.
146 ## Include/Protocol/Print2.h
147 gEfiPrint2ProtocolGuid = { 0x5bcc3dbc, 0x8c57, 0x450a, { 0xbb, 0x0c, 0xa1, 0xc0, 0xbd, 0xde, 0x48, 0x0c }}
148
149 ## This protocol defines the generic memory test interfaces in Dxe phase.
150 ## Include/Protocol/GenericMemoryTest.h
151 gEfiGenericMemTestProtocolGuid = { 0x309DE7F1, 0x7F5E, 0x4ACE, { 0xB4, 0x9C, 0x53, 0x1B, 0xE5, 0xAA, 0x95, 0xEF }}
152
153 ## This protocol provides the interfaces to Get/Set the current video mode for GOP/UGA screen
154 ## Include/Protocol/ConsoleControl.h
155 gEfiConsoleControlProtocolGuid = { 0xF42F7782, 0x012E, 0x4C12, { 0x99, 0x56, 0x49, 0xF9, 0x43, 0x04, 0xF7, 0x21 }}
156
157 ## Include/Protocol/NicIp4Config.h
158 gEfiNicIp4ConfigProtocolGuid = {0xdca3d4d, 0x12da, 0x4728, { 0xbf, 0x7e, 0x86, 0xce, 0xb9, 0x28, 0xd0, 0x67 }}
159
160 ## Include/Protocol/NicIp4Config.h
161 gEfiNicIp4ConfigVariableGuid = {0xd8944553, 0xc4dd, 0x41f4, { 0x9b, 0x30, 0xe1, 0x39, 0x7c, 0xfb, 0x26, 0x7b }}
162
163 ## Include/Protocol/Tcp.h
164 gEfiTcpProtocolGuid = {0x02b3d5f2, 0xac28, 0x11d3, { 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d }}
165
166 ## Include/Protocol/PxeDhcp4CallBack.h
167 gEfiPxeDhcp4CallbackProtocolGuid = {0xc1544c01, 0x92a4, 0x4198, {0x8a, 0x84, 0x77, 0x85, 0x83, 0xc2, 0x36, 0x21 }}
168
169 ## Include/Protocol/PxeDhcp4.h
170 gEfiPxeDhcp4ProtocolGuid = {0x03c4e624, 0xac28, 0x11d3, { 0x9a, 0x2d, 0x00, 0x90, 0x29, 0x3f, 0xc1, 0x4d }}
171
172 ## Include/Protocol/Dpc.h
173 gEfiDpcProtocolGuid = {0x480f8ae9, 0xc46, 0x4aa9, { 0xbc, 0x89, 0xdb, 0x9f, 0xba, 0x61, 0x98, 0x6 }}
174
175 ## Fault Tolerant Write protocol provides boot-time service to do fault tolerant write capability for block devices.
176 # Include/Protocol/FaultTolerantWrite.h
177 gEfiFaultTolerantWriteProtocolGuid = { 0x3EBD9E82, 0x2C78, 0x4DE6, { 0x97, 0x86, 0x8D, 0x4B, 0xFC, 0xB7, 0xC8, 0x81 }}
178
179 ## This protocol is used to abstract the swap operation of boot block and backup block of boot FV.
180 # Include/Protocol/SwapAddressRange.h
181 gEfiSwapAddressRangeProtocolGuid = { 0x1259F60D, 0xB754, 0x468E, { 0xA7, 0x89, 0x4D, 0xB8, 0x5D, 0x55, 0xE8, 0x7E }}
182
183 [PcdsFeatureFlag]
184 ## Indicate whether platform can support update capsule across a system reset
185 gEfiMdeModulePkgTokenSpaceGuid.PcdSupportUpdateCapsuleReset|FALSE|BOOLEAN|0x0001001d
186
187 ## This feature flag can be used to enable or disable all PCD PEIM services.
188 # If TRUE, all PCD PPI services will be produced.
189 ## If FALSE, the minimal PCD PEIM services (only GetService) will be produced.
190 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiFullPcdDatabaseEnable|TRUE|BOOLEAN|0x00010020
191
192 ## If TRUE, then the Device Path To Text Protocol should be produced by the platform.
193 # It can be disabled to save size.
194 gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathToText|TRUE|BOOLEAN|0x00010037
195
196 ## If TRUE, then the Device Path From Text Protocol should be produced by the platform.
197 # It can be disabled to save size.
198 gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathFromText|TRUE|BOOLEAN|0x00010038
199
200 ## If TRUE, enable the statistic functionality about variable usage. Such information is
201 # stored as a vendor configuration table into the EFI system table.
202 # If user wants to get variable usage info, this pcd should be set as TRUE.
203 gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics|FALSE|BOOLEAN|0x0001003f
204
205 ## If TRUE, Unicode Collation Protocol will be installed.
206 gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollationSupport|TRUE|BOOLEAN|0x00010040
207
208 ## If TRUE, Unicode Collation 2 Protocol will be installed.
209 gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollation2Support|TRUE|BOOLEAN|0x00010041
210
211 ## If TRUE, Graphics Output Protocol will be installed on virtual handle created by ConsplitterDxe.
212 # It could be set FALSE to save size.
213 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutGopSupport|TRUE|BOOLEAN|0x00010042
214
215 ## If TRUE, UGA Draw Protocol will be installed on virtual handle created by ConsplitterDxe.
216 # It could be set FALSE to save size.
217 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutUgaSupport|TRUE|BOOLEAN|0x00010043
218
219 ## If TRUE, when PeiCore dispatches a PEI module, PeiCore will first search TE section from this PEIM to load the image.
220 # If TE section is not found, then PeiCore will search PE section.
221 # If FALSE, PeiCore will first search PE section from PEIM to load the image.
222 # This PCD is used to tune Pei phase performance to reduce the search image time.
223 # It can be set according to the generated image section type.
224 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreImageLoaderSearchTeSectionFirst|TRUE|BOOLEAN|0x00010044
225
226 ## If TRUE, force to switch off the support of legacy usb. So legacy usb device driver can not make use of SMI
227 # interrupt to access usb device in the case of absence of usb stack.
228 ##
229 gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport|FALSE|BOOLEAN|0x00010047
230
231 ## If TRUE, HiiImageProtocol will be installed.
232 # FALSE is for size reduction.
233 gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHiiImageProtocol|TRUE|BOOLEAN|0x00010100
234
235 ## If TRUE, these interface in EFI_HII_CONFIG_ROUTING_PROTOCOL will be supported: ExtractConfig, ExportConfig, RouteConfig
236 # and GetAltCfg will be supported. Otherwise, these interfaces will return EFI_UNSUPPORTED.
237 # FALSE is for size reduction.
238 gEfiMdeModulePkgTokenSpaceGuid.PcdSupportFullConfigRoutingProtocol|TRUE|BOOLEAN|0x00010101
239
240 ## If TRUE, USB KeyBoard Driver disables the default keyboard layout.
241 # The default keyboard layout serves as the backup when no keyboard layout can be retrieved
242 # from HII database.
243 gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver|FALSE|BOOLEAN|0x00010200
244
245 ## If TRUE, Setup Browser supports GUID opcodes generated from Framework HII VFR file by VFR compiler.
246 # If TRUE, the PeiCore will handle the framework FvHob and install FvInfo PPI for it.
247 ## This is used to provide backward compatibility support to Framework HII and Framework FvHob.
248 gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkCompatibilitySupport|FALSE|BOOLEAN|0x00012009
249
250 ##
251 # If TRUE, HelloWorld Application will print the verbose information.
252 # This PCD is a sample to explain FeatureFlag PCD usage.
253 ##
254 gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintEnable|TRUE|BOOLEAN|0x0001200a
255
256 ##
257 # If TRUE, FULL FTW protocol services (total six APIs) will be produced.
258 # If FASLE, only FTW Write service is available.
259 gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable|TRUE|BOOLEAN|0x0001200a
260
261 [PcdsFeatureFlag.IA32]
262 ##
263 # This feature flag specifies whether DxeIpl switches to long mode to enter DXE phase.
264 # If it is TRUE, DxeIpl will load a 64-bit DxeCore and switch to long mode to hand over to DxeCore;
265 # otherwise, DxeIpl will load a 32-bit DxeCore and perform stack switch to hand over to DxeCore.
266 # It is assumed that 64-bit DxeCore is built in firmware if it is true; otherwise 32-bit DxeCore
267 # is built in firmware.
268 #
269 gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode|TRUE|BOOLEAN|0x0001003b
270
271 [PcdsFixedAtBuild]
272 ## Dynamic type PCD can be registered callback function for Pcd setting action.
273 # PcdMaxPeiPcdCallBackNumberPerPcdEntry indicate maximum number of callback function
274 # for a dynamic PCD used in PEI phase.
275 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPcdCallBackNumberPerPcdEntry|0x08|UINT32|0x0001000f
276
277 ## VPD type PCD allow developer point an absoluted physical address PcdVpdBaseAddress
278 # to store PCD value.
279 #
280 gEfiMdeModulePkgTokenSpaceGuid.PcdVpdBaseAddress|0x0|UINT32|0x00010010
281
282 ## Maximum number of FV is supported by PeiCore's dispatching.
283 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxFvSupported|6|UINT32|0x00010030
284
285 ## Maximum PEIM count in every FV is supported by PeiCore's dispatching.
286 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeimPerFv|32|UINT32|0x00010031
287
288 ## Maximum stack size for PeiCore.
289 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeiStackSize|0x20000|UINT32|0x00010032
290
291 ## Maximum PPI count is supported by PeiCore's PPI database.
292 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPpiSupported|64|UINT32|0x00010033
293
294 ## Size of the NV variable range.
295 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize|0x0|UINT32|0x30000002
296
297 ## Maximum allowable size of a common type variable, that is, non-hardware error type variable.
298 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize|0x400|UINT32|0x30000003
299
300 ## Maximum allowable size of a single hardware error record variable.
301 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize|0x8000|UINT32|0x30000004
302
303 ## Size of allocated memory for volatile variable store. Variables are stored in such region and
304 # total length of all variables should not larger than this value.
305 ##
306 gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize|0x10000|UINT32|0x30000005
307
308 ## Size of the FTW spare block range.
309 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize|0x0|UINT32|0x30000014
310
311 ## Size of the FTW working block range.
312 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize|0x0|UINT32|0x30000011
313
314 [PcdsFixedAtBuild,PcdsPatchableInModule]
315 ## Maximun number of performance log entries during PEI phase.
316 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPerformanceLogEntries|40|UINT8|0x0001002f
317
318 ## RTC Update Timeout Value
319 gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout|100000|UINT32|0x00010034
320
321 [PcdsPatchableInModule,PcdsDynamic]
322 ##
323 # This PCD defines the Console output column and the default value is 25 according to UEFI spec
324 ##
325 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutRow|25|UINT32|0x40000006
326
327 ##
328 # This PCD defines the Console output row and the default value is 80 according to UEFI spec
329 ##
330 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutColumn|80|UINT32|0x40000007
331
332 [PcdsFixedAtBuild,PcdsDynamic]
333 ## Base address of the NV variable range in flash device
334 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase|0x0|UINT32|0x30000001
335
336 ## Base address of the FTW spare block range in flash device.
337 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase|0x0|UINT32|0x30000013
338
339 ## Base address of the FTW working block range in flash device.
340 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase|0x0|UINT32|0x30000010
341
342 ##
343 # This PCD defines the print string.
344 # This PCD is a sample to explain String typed PCD usage.
345 ##
346 gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintString|L"UEFI Hello World!\n"|VOID*|0x40000004
347
348 [PcdsFixedAtBuild,PcdsPatchableInModule,PcdsDynamic]
349 ##
350 # This PCD defines the times to print hello world string.
351 # This PCD is a sample to explain FixedAtBuild UINT32 PCD usage.
352 ##
353 gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintTimes|1|UINT32|0x40000005
354
355 ## Indicate the max size of the populated capsule image that the platform can support.
356 # The default max size is 100MB (0x6400000) for more than one large capsule images.
357 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizePopulateCapsule|0x6400000|UINT32|0x0001001e
358
359 ## Indicate the max size of the non-populated capsule image that the platform can support.
360 # The default max size is 10MB (0xa00000) for the casule image without populated flag setting.
361 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizeNonPopulateCapsule|0xa00000|UINT32|0x0001001f