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