]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/MdeModulePkg.dec
update MdePkg version to 1.01
[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.90
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 Provides HII related functions.
54 HiiLib|Include/Library/HiiLib.h
55
56 ## @libraryclass Defines a set of interfaces on how to process capusle image update.
57 CapsuleLib|Include/Library/CapsuleLib.h
58
59 ## @libraryclass Library for Deferred Procedure Calls.
60 DpcLib|Include/Library/DpcLib.h
61
62 ## @libraryclass Provides global variables that are pointers
63 ## to the UEFI HII related protocols.
64 ##
65 UefiHiiServicesLib|Include/Library/UefiHiiServicesLib.h
66
67 [Guids.common]
68 ## MdeModule package token space guid
69 ## Include/Guid/MdeModulePkgTokenSpace.h
70 gEfiMdeModulePkgTokenSpaceGuid = { 0xA1AFF049, 0xFDEB, 0x442a, { 0xB3, 0x20, 0x13, 0xAB, 0x4C, 0xB7, 0x2B, 0xBC }}
71
72 ## Hob guid for Pcd DataBase
73 ## Include/Guid/PcdDataBaseHobGuid.h
74 gPcdDataBaseHobGuid = { 0xEA296D92, 0x0B69, 0x423C, { 0x8C, 0x28, 0x33, 0xB4, 0xE0, 0xA9, 0x12, 0x68 }}
75
76 ## Guid for EDKII implementation GUIDed opcodes
77 # Include/Guid/MdeModuleHii.h
78 gEfiIfrTianoGuid = { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce }}
79
80 ## Guid for Framework vfr GUIDed opcodes.
81 # Include/Guid/MdeModuleHii.h
82 gEfiIfrFrameworkGuid = { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 }}
83
84 ## Guid to specify the System Non Volatile FV
85 ## Include/Guid/SystemNvDataGuid.h
86 gEfiSystemNvDataFvGuid = { 0xFFF12B8D, 0x7696, 0x4C8B, { 0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50 }}
87
88 ## Guid specify the device is the console out device.
89 ## Include/Guid/ConsoleOutDevice.h
90 gEfiConsoleOutDeviceGuid = { 0xD3B36F2C, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
91
92 ## Guid specify the device is the console in device.
93 ## Include/Guid/ConsoleInDevice.h
94 gEfiConsoleInDeviceGuid = { 0xD3B36F2B, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
95
96 ## Hob and Variable guid specify the platform memory type information.
97 ## Include/Guid/MemoryTypeInformation.h
98 gEfiMemoryTypeInformationGuid = { 0x4C19049F, 0x4137, 0x4DD3, { 0x9C, 0x10, 0x8B, 0x97, 0xA8, 0x3F, 0xFD, 0xFA }}
99
100 ## Capsule update hob and variable guid
101 ## Include/Guid/CapsuleVendor.h
102 gEfiCapsuleVendorGuid = { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 }}
103
104 ## Guid specifiy the device is the StdErr device.
105 ## Include/Guid/StandardErrorDevice.h
106 gEfiStandardErrorDeviceGuid = { 0xD3B36F2D, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
107
108 ## Guid acted as variable store header's signature and to specify the variable list entries put in the EFI system table.
109 ## Include/Guid/VariableFormat.h
110 gEfiVariableGuid = { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}
111
112 ## Performance protocol guid that also acts as the performance HOB guid and performance variable GUID
113 ## Include/Guid/Performance.h
114 gPerformanceProtocolGuid = { 0x76B6BDFA, 0x2ACD, 0x4462, { 0x9E, 0x3F, 0xCB, 0x58, 0xC9, 0x69, 0xD9, 0x37 }}
115
116 ## Guid is defined for CRC32 encapsulation scheme.
117 ## Include/Guid/Crc32GuidedSectionExtraction.h
118 gEfiCrc32GuidedSectionExtractionGuid = { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }
119
120 ## Include/Guid/NicIp4ConfigNvData.h
121 gEfiNicIp4ConfigVariableGuid = {0xd8944553, 0xc4dd, 0x41f4, { 0x9b, 0x30, 0xe1, 0x39, 0x7c, 0xfb, 0x26, 0x7b }}
122
123 [Protocols.common]
124 ## Load File protocol provides capability to load and unload EFI image into memory and execute it.
125 ## Include/Protocol/LoadPe32Image.h
126 ## This protocol is deprecated. Native EDKII module should NOT use this protocol to load/unload image.
127 ## If developer need implement such functionality, they should use BasePeCoffLib.
128 gEfiLoadPeImageProtocolGuid = { 0x5CB5C776, 0x60D5, 0x45EE, { 0x88, 0x3C, 0x45, 0x27, 0x08, 0xCD, 0x74, 0x3F }}
129
130 ## Print protocol defines basic print functions to print the format unicode and ascii string.
131 ## Include/Protocol/Print2.h
132 gEfiPrint2ProtocolGuid = { 0xf05976ef, 0x83f1, 0x4f3d, { 0x86, 0x19, 0xf7, 0x59, 0x5d, 0x41, 0xe5, 0x38 } }
133
134 ## This protocol defines the generic memory test interfaces in Dxe phase.
135 ## Include/Protocol/GenericMemoryTest.h
136 gEfiGenericMemTestProtocolGuid = { 0x309DE7F1, 0x7F5E, 0x4ACE, { 0xB4, 0x9C, 0x53, 0x1B, 0xE5, 0xAA, 0x95, 0xEF }}
137
138 ## Include/Protocol/Dpc.h
139 gEfiDpcProtocolGuid = {0x480f8ae9, 0xc46, 0x4aa9, { 0xbc, 0x89, 0xdb, 0x9f, 0xba, 0x61, 0x98, 0x6 }}
140
141 ## Fault Tolerant Write protocol provides boot-time service to do fault tolerant write capability for block devices.
142 # Include/Protocol/FaultTolerantWrite.h
143 gEfiFaultTolerantWriteProtocolGuid = { 0x3EBD9E82, 0x2C78, 0x4DE6, { 0x97, 0x86, 0x8D, 0x4B, 0xFC, 0xB7, 0xC8, 0x81 }}
144
145 ## This protocol is used to abstract the swap operation of boot block and backup block of boot FV.
146 # Include/Protocol/SwapAddressRange.h
147 gEfiSwapAddressRangeProtocolGuid = { 0x1259F60D, 0xB754, 0x468E, { 0xA7, 0x89, 0x4D, 0xB8, 0x5D, 0x55, 0xE8, 0x7E }}
148
149 [PcdsFeatureFlag]
150 ## Indicate whether platform can support update capsule across a system reset
151 gEfiMdeModulePkgTokenSpaceGuid.PcdSupportUpdateCapsuleReset|FALSE|BOOLEAN|0x0001001d
152
153 ## This feature flag can be used to enable or disable all PCD PEIM services.
154 # If TRUE, all PCD PPI services will be produced.
155 ## If FALSE, the minimal PCD PEIM services (only GetService) will be produced.
156 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiFullPcdDatabaseEnable|TRUE|BOOLEAN|0x00010020
157
158 ## If TRUE, then the Device Path To Text Protocol should be produced by the platform.
159 # It can be disabled to save size.
160 gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathToText|TRUE|BOOLEAN|0x00010037
161
162 ## If TRUE, then the Device Path From Text Protocol should be produced by the platform.
163 # It can be disabled to save size.
164 gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathFromText|TRUE|BOOLEAN|0x00010038
165
166 ## If TRUE, enable the statistic functionality about variable usage. Such information is
167 # stored as a vendor configuration table into the EFI system table.
168 # If user wants to use VariableInfo application in MdeModulePkg\Application directory to get
169 # variable usage info, this pcd should be set as TRUE. Otherwise VariableInfo application can
170 # not output useful info.
171 gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics|FALSE|BOOLEAN|0x0001003f
172
173 ## If TRUE, Unicode Collation Protocol will be installed.
174 gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollationSupport|TRUE|BOOLEAN|0x00010040
175
176 ## If TRUE, Unicode Collation 2 Protocol will be installed.
177 gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollation2Support|TRUE|BOOLEAN|0x00010041
178
179 ## If TRUE, Graphics Output Protocol will be installed on virtual handle created by ConsplitterDxe.
180 # It could be set FALSE to save size.
181 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutGopSupport|TRUE|BOOLEAN|0x00010042
182
183 ## If TRUE, UGA Draw Protocol will be installed on virtual handle created by ConsplitterDxe.
184 # It could be set FALSE to save size.
185 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutUgaSupport|TRUE|BOOLEAN|0x00010043
186
187 ## If TRUE, when PeiCore dispatches a PEI module, PeiCore will first search TE section from this PEIM to load the image.
188 # If TE section is not found, then PeiCore will search PE section.
189 # If FALSE, PeiCore will first search PE section from PEIM to load the image.
190 # This PCD is used to tune Pei phase performance to reduce the search image time.
191 # It can be set according to the generated image section type.
192 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreImageLoaderSearchTeSectionFirst|TRUE|BOOLEAN|0x00010044
193
194 ## If TRUE, force to switch off the support of legacy usb. So legacy usb device driver can not make use of SMI
195 # interrupt to access usb device in the case of absence of usb stack.
196 ##
197 gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport|FALSE|BOOLEAN|0x00010047
198
199 ## If TRUE, HiiImageProtocol will be installed.
200 # FALSE is for size reduction.
201 gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHiiImageProtocol|TRUE|BOOLEAN|0x00010100
202
203 ## If TRUE, USB KeyBoard Driver disables the default keyboard layout.
204 # The default keyboard layout serves as the backup when no keyboard layout can be retrieved
205 # from HII database.
206 gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver|FALSE|BOOLEAN|0x00010200
207
208 ## If TRUE, Setup Browser supports GUID opcodes generated from Framework HII VFR file by VFR compiler.
209 # If TRUE, the PeiCore will handle the framework FvHob and install FvInfo PPI for it.
210 ## This is used to provide backward compatibility support to Framework HII and Framework FvHob.
211 gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkCompatibilitySupport|FALSE|BOOLEAN|0x00012009
212
213 ##
214 # If TRUE, HelloWorld Application will print the verbose information.
215 # This PCD is a sample to explain FeatureFlag PCD usage.
216 ##
217 gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintEnable|TRUE|BOOLEAN|0x0001200a
218
219 ##
220 # If TRUE, FULL FTW protocol services (total six APIs) will be produced.
221 # If FASLE, only FTW Write service is available.
222 gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable|TRUE|BOOLEAN|0x0001200b
223
224 ##
225 # If TRUE, DXE IPL must support the UEFI decompression algorithm.
226 # If FALSE, DXE IPL will not support UEFI decompression to save space.
227 gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSupportUefiDecompress|TRUE|BOOLEAN|0x0001200c
228
229 [PcdsFeatureFlag.IA32]
230 ##
231 # This feature flag specifies whether DxeIpl switches to long mode to enter DXE phase.
232 # If it is TRUE, DxeIpl will load a 64-bit DxeCore and switch to long mode to hand over to DxeCore;
233 # otherwise, DxeIpl will load a 32-bit DxeCore and perform stack switch to hand over to DxeCore.
234 # It is assumed that 64-bit DxeCore is built in firmware if it is true; otherwise 32-bit DxeCore
235 # is built in firmware.
236 #
237 gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode|TRUE|BOOLEAN|0x0001003b
238
239 [PcdsFixedAtBuild]
240 ## Dynamic type PCD can be registered callback function for Pcd setting action.
241 # PcdMaxPeiPcdCallBackNumberPerPcdEntry indicate maximum number of callback function
242 # for a dynamic PCD used in PEI phase.
243 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPcdCallBackNumberPerPcdEntry|0x08|UINT32|0x0001000f
244
245 ## VPD type PCD allow developer point an absoluted physical address PcdVpdBaseAddress
246 # to store PCD value.
247 #
248 gEfiMdeModulePkgTokenSpaceGuid.PcdVpdBaseAddress|0x0|UINT32|0x00010010
249
250 ## Maximum number of FV is supported by PeiCore's dispatching.
251 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxFvSupported|6|UINT32|0x00010030
252
253 ## Maximum PEIM count in every FV is supported by PeiCore's dispatching.
254 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeimPerFv|32|UINT32|0x00010031
255
256 ## Maximum stack size for PeiCore.
257 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeiStackSize|0x20000|UINT32|0x00010032
258
259 ## Maximum PPI count is supported by PeiCore's PPI database.
260 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPpiSupported|64|UINT32|0x00010033
261
262 ## Size of the NV variable range. Note that this value should less than or equal to PcdFlashNvStorageFtwSpareSize
263 # The root cause is that variable driver will use FTW protocol to reclaim variable region.
264 # If the length of variable region is larger than FTW spare size, it means the whole variable region can not
265 # be reflushed through the manner of fault tolerant write.
266 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize|0x0|UINT32|0x30000002
267
268 ## The maximum size of single common variable, that is non-HwErr type varible.
269 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize|0x400|UINT32|0x30000003
270
271 ## The maximum size of single hardware error record variable.
272 # In IA32/X64 platforms, this value should be larger than 1KB.
273 # In IA64 platforms, this value should be larger than 128KB.
274 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize|0x8000|UINT32|0x30000004
275
276 ## The size of reserved HwErr variable space. This space is located at NV variable range.
277 # HwErr type variable is stored with common non-volatile variables in NV region.
278 # this value is used to guarantee the space of HwErr type variable and not populated by common variable.
279 gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize|0x8000|UINT32|0x30000006
280
281 ## The size of volatile buffer. This buffer is used to store VOLATILE attribute variable.
282 gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize|0x10000|UINT32|0x30000005
283
284 ## Size of the FTW spare block range. Note that this value should larger than PcdFlashNvStorageVariableSize
285 # The root cause is that variable driver will use FTW protocol to reclaim variable region.
286 # If the length of variable region is larger than FTW spare size, it means the whole variable region can not
287 # be reflushed through the manner of fault tolerant write.
288 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize|0x0|UINT32|0x30000014
289
290 ## Size of the FTW working block range.
291 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize|0x0|UINT32|0x30000011
292
293 ## FFS filename to find the ACPI tables
294 gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiTableStorageFile|{ 0x25, 0x4e, 0x37, 0x7e, 0x01, 0x8e, 0xee, 0x4f, 0x87, 0xf2, 0x39, 0xc, 0x23, 0xc6, 0x6, 0xcd }|VOID*|16
295
296 [PcdsFixedAtBuild,PcdsPatchableInModule]
297 ## Maximun number of performance log entries during PEI phase.
298 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPerformanceLogEntries|40|UINT8|0x0001002f
299
300 ## RTC Update Timeout Value
301 gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout|100000|UINT32|0x00010034
302
303 [PcdsPatchableInModule,PcdsDynamic]
304 ##
305 # This PCD defines the Console output column and the default value is 25 according to UEFI spec
306 ##
307 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutRow|25|UINT32|0x40000006
308
309 ##
310 # This PCD defines the Console output row and the default value is 80 according to UEFI spec
311 ##
312 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutColumn|80|UINT32|0x40000007
313
314 [PcdsFixedAtBuild,PcdsDynamic]
315 ## Base address of the NV variable range in flash device
316 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase|0x0|UINT32|0x30000001
317
318 ## Base address of the FTW spare block range in flash device.
319 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase|0x0|UINT32|0x30000013
320
321 ## Base address of the FTW working block range in flash device.
322 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase|0x0|UINT32|0x30000010
323
324 ##
325 # This PCD defines the print string.
326 # This PCD is a sample to explain String typed PCD usage.
327 ##
328 gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintString|L"UEFI Hello World!\n"|VOID*|0x40000004
329
330 [PcdsFixedAtBuild,PcdsPatchableInModule,PcdsDynamic]
331 ##
332 # This PCD defines the times to print hello world string.
333 # This PCD is a sample to explain FixedAtBuild UINT32 PCD usage.
334 ##
335 gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintTimes|1|UINT32|0x40000005
336
337 ## Indicate the max size of the populated capsule image that the platform can support.
338 # The default max size is 100MB (0x6400000) for more than one large capsule images.
339 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizePopulateCapsule|0x6400000|UINT32|0x0001001e
340
341 ## Indicate the max size of the non-populated capsule image that the platform can support.
342 # The default max size is 10MB (0xa00000) for the casule image without populated flag setting.
343 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizeNonPopulateCapsule|0xa00000|UINT32|0x0001001f
344
345 ## Null-terminated Unicode string of the firmware vendor name that is default name filled into the EFI System Table
346 gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwareVendor|L"EDK II"|VOID*|0xx00010050
347
348 ## Firmware revision that is default value filled into the EFI System Table
349 gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwareRevision|0x00010000|UINT32|0x00010051
350
351 ## Null-terminated Unicode string that described the firmware version
352 gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwareVersionString|L""|VOID*|0x00010052
353
354 ## Null-terminated Unicode string that contains the date the formware was released
355 gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwareReleaseDateString|L""|VOID*|0x00010053
356