1 ## @file MdeModulePkg.dec
\r
3 # This package provides the modules that conform to EFI/PI Industry standards.
\r
4 # It also provides the defintions(including PPIs/PROTOCOLs/GUIDs and library classes)
\r
5 # and libraries instances, which are used for those modules.
\r
7 # Copyright (c) 2007 - 2009, Intel Corporation.
\r
9 # All rights reserved.
\r
10 # This program and the accompanying materials are licensed and made available under
\r
11 # the terms and conditions of the BSD License which accompanies this distribution.
\r
12 # The full text of the license may be found at
\r
13 # http://opensource.org/licenses/bsd-license.php
\r
15 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
\r
16 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
\r
22 DEC_SPECIFICATION = 0x00010005
\r
23 PACKAGE_NAME = MdeModulePkg
\r
24 PACKAGE_GUID = BA0D78D6-2CAF-414b-BD4D-B6762A894288
\r
25 PACKAGE_VERSION = 0.1
\r
31 [LibraryClasses.common]
\r
32 ## @libraryclass IpIo layer upon EFI IP4 Protocol.
\r
33 # This library is only intended to be used by UEFI network stack modules.
\r
34 IpIoLib|Include/Library/IpIoLib.h
\r
36 ## @libraryclass Basic function for UEFI network stack.
\r
37 # This library is only intended to be used by UEFI network stack modules.
\r
38 NetLib|Include/Library/NetLib.h
\r
40 ## @libraryclass The helper routines to access UDP service.
\r
41 # This library is only intended to be used by UEFI network stack modules.
\r
42 UdpIoLib|Include/Library/UdpIoLib.h
\r
44 ## @libraryclass Defines a set of methods to reset whole system.
\r
45 ResetSystemLib|Include/Library/ResetSystemLib.h
\r
47 ## @libraryclass Defines a set of methods related do S3 mode.
\r
48 S3Lib|Include/Library/S3Lib.h
\r
50 ## @libraryclass Defines a set of methods related recovery mode.
\r
51 RecoveryLib|Include/Library/RecoveryLib.h
\r
53 ## @libraryclass Provides HII related functions.
\r
54 HiiLib|Include/Library/HiiLib.h
\r
56 ## @libraryclass Defines a set of interfaces on how to process capusle image update.
\r
57 CapsuleLib|Include/Library/CapsuleLib.h
\r
59 ## @libraryclass Library for Deferred Procedure Calls.
\r
60 DpcLib|Include/Library/DpcLib.h
\r
62 ## @libraryclass Provides APIs for system memory test.
\r
64 MemoryTestLib|Include/Library/MemoryTestLib.h
\r
66 ## @libraryclass Provides global variables that are pointers
\r
67 ## to the UEFI HII related protocols.
\r
69 UefiHiiServicesLib|Include/Library/UefiHiiServicesLib.h
\r
72 ## MdeModule package token space guid
\r
73 ## Include/Guid/MdeModulePkgTokenSpace.h
\r
74 gEfiMdeModulePkgTokenSpaceGuid = { 0xA1AFF049, 0xFDEB, 0x442a, { 0xB3, 0x20, 0x13, 0xAB, 0x4C, 0xB7, 0x2B, 0xBC }}
\r
76 ## Hob guid for Pcd DataBase
\r
77 ## Include/Guid/PcdDataBaseHobGuid.h
\r
78 gPcdDataBaseHobGuid = { 0xEA296D92, 0x0B69, 0x423C, { 0x8C, 0x28, 0x33, 0xB4, 0xE0, 0xA9, 0x12, 0x68 }}
\r
80 ## Guid for EDKII implementation GUIDed opcodes
\r
81 # Include/Guid/MdeModuleHii.h
\r
82 gEfiIfrTianoGuid = { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce }}
\r
84 ## Guid for Framework vfr GUIDed opcodes.
\r
85 # Include/Guid/MdeModuleHii.h
\r
86 gEfiIfrFrameworkGuid = { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 }}
\r
88 ## Guid to specify the System Non Volatile FV
\r
89 ## Include/Guid/SystemNvDataGuid.h
\r
90 gEfiSystemNvDataFvGuid = { 0xFFF12B8D, 0x7696, 0x4C8B, { 0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50 }}
\r
92 ## Guid specify the device is the console out device.
\r
93 ## Include/Guid/ConsoleOutDevice.h
\r
94 gEfiConsoleOutDeviceGuid = { 0xD3B36F2C, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
\r
96 ## Guid specify the device is the console in device.
\r
97 ## Include/Guid/ConsoleInDevice.h
\r
98 gEfiConsoleInDeviceGuid = { 0xD3B36F2B, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
\r
100 ## Hob and Variable guid specify the platform memory type information.
\r
101 ## Include/Guid/MemoryTypeInformation.h
\r
102 gEfiMemoryTypeInformationGuid = { 0x4C19049F, 0x4137, 0x4DD3, { 0x9C, 0x10, 0x8B, 0x97, 0xA8, 0x3F, 0xFD, 0xFA }}
\r
104 ## Capsule update hob and variable guid
\r
105 ## Include/Guid/CapsuleVendor.h
\r
106 gEfiCapsuleVendorGuid = { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 }}
\r
108 ## Guid specifiy the device is the StdErr device.
\r
109 ## Include/Guid/StandardErrorDevice.h
\r
110 gEfiStandardErrorDeviceGuid = { 0xD3B36F2D, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
\r
112 ## Guid acted as variable store header's signature and to specify the variable list entries put in the EFI system table.
\r
113 ## Include/Guid/VariableFormat.h
\r
114 gEfiVariableGuid = { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}
\r
116 ## Performance protocol guid that also acts as the performance HOB guid and performance variable GUID
\r
117 ## Include/Guid/Performance.h
\r
118 gPerformanceProtocolGuid = { 0x76B6BDFA, 0x2ACD, 0x4462, { 0x9E, 0x3F, 0xCB, 0x58, 0xC9, 0x69, 0xD9, 0x37 }}
\r
120 ## Guid is defined for CRC32 encapsulation scheme.
\r
121 ## Include/Guid/Crc32GuidedSectionExtraction.h
\r
122 gEfiCrc32GuidedSectionExtractionGuid = { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }
\r
124 ## Include/Guid/NicIp4ConfigNvData.h
\r
125 gEfiNicIp4ConfigVariableGuid = {0xd8944553, 0xc4dd, 0x41f4, { 0x9b, 0x30, 0xe1, 0x39, 0x7c, 0xfb, 0x26, 0x7b }}
\r
127 [Protocols.common]
\r
128 ## Load File protocol provides capability to load and unload EFI image into memory and execute it.
\r
129 ## Include/Protocol/LoadPe32Image.h
\r
130 ## This protocol is deprecated. Native EDKII module should NOT use this protocol to load/unload image.
\r
131 ## If developer need implement such functionality, they should use BasePeCoffLib.
\r
132 gEfiLoadPeImageProtocolGuid = { 0x5CB5C776, 0x60D5, 0x45EE, { 0x88, 0x3C, 0x45, 0x27, 0x08, 0xCD, 0x74, 0x3F }}
\r
134 ## Print protocol defines basic print functions to print the format unicode and ascii string.
\r
135 ## Include/Protocol/Print2.h
\r
136 gEfiPrint2ProtocolGuid = { 0xf05976ef, 0x83f1, 0x4f3d, { 0x86, 0x19, 0xf7, 0x59, 0x5d, 0x41, 0xe5, 0x38 } }
\r
138 ## This protocol defines the generic memory test interfaces in Dxe phase.
\r
139 ## Include/Protocol/GenericMemoryTest.h
\r
140 gEfiGenericMemTestProtocolGuid = { 0x309DE7F1, 0x7F5E, 0x4ACE, { 0xB4, 0x9C, 0x53, 0x1B, 0xE5, 0xAA, 0x95, 0xEF }}
\r
142 ## Include/Protocol/Dpc.h
\r
143 gEfiDpcProtocolGuid = {0x480f8ae9, 0xc46, 0x4aa9, { 0xbc, 0x89, 0xdb, 0x9f, 0xba, 0x61, 0x98, 0x6 }}
\r
145 ## Fault Tolerant Write protocol provides boot-time service to do fault tolerant write capability for block devices.
\r
146 # Include/Protocol/FaultTolerantWrite.h
\r
147 gEfiFaultTolerantWriteProtocolGuid = { 0x3EBD9E82, 0x2C78, 0x4DE6, { 0x97, 0x86, 0x8D, 0x4B, 0xFC, 0xB7, 0xC8, 0x81 }}
\r
149 ## This protocol is used to abstract the swap operation of boot block and backup block of boot FV.
\r
150 # Include/Protocol/SwapAddressRange.h
\r
151 gEfiSwapAddressRangeProtocolGuid = { 0x1259F60D, 0xB754, 0x468E, { 0xA7, 0x89, 0x4D, 0xB8, 0x5D, 0x55, 0xE8, 0x7E }}
\r
154 ## Indicate whether platform can support update capsule across a system reset
\r
155 gEfiMdeModulePkgTokenSpaceGuid.PcdSupportUpdateCapsuleReset|FALSE|BOOLEAN|0x0001001d
\r
157 ## This feature flag can be used to enable or disable all PCD PEIM services.
\r
158 # If TRUE, all PCD PPI services will be produced.
\r
159 ## If FALSE, the minimal PCD PEIM services (only GetService) will be produced.
\r
160 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiFullPcdDatabaseEnable|TRUE|BOOLEAN|0x00010020
\r
162 ## If TRUE, then the Device Path To Text Protocol should be produced by the platform.
\r
163 # It can be disabled to save size.
\r
164 gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathToText|TRUE|BOOLEAN|0x00010037
\r
166 ## If TRUE, then the Device Path From Text Protocol should be produced by the platform.
\r
167 # It can be disabled to save size.
\r
168 gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathFromText|TRUE|BOOLEAN|0x00010038
\r
170 ## If TRUE, enable the statistic functionality about variable usage. Such information is
\r
171 # stored as a vendor configuration table into the EFI system table.
\r
172 # If user wants to use VariableInfo application in MdeModulePkg\Application directory to get
\r
173 # variable usage info, this pcd should be set as TRUE. Otherwise VariableInfo application can
\r
174 # not output useful info.
\r
175 gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics|FALSE|BOOLEAN|0x0001003f
\r
177 ## If TRUE, Unicode Collation Protocol will be installed.
\r
178 gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollationSupport|TRUE|BOOLEAN|0x00010040
\r
180 ## If TRUE, Unicode Collation 2 Protocol will be installed.
\r
181 gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollation2Support|TRUE|BOOLEAN|0x00010041
\r
183 ## If TRUE, Graphics Output Protocol will be installed on virtual handle created by ConsplitterDxe.
\r
184 # It could be set FALSE to save size.
\r
185 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutGopSupport|TRUE|BOOLEAN|0x00010042
\r
187 ## If TRUE, UGA Draw Protocol will be installed on virtual handle created by ConsplitterDxe.
\r
188 # It could be set FALSE to save size.
\r
189 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutUgaSupport|TRUE|BOOLEAN|0x00010043
\r
191 ## If TRUE, when PeiCore dispatches a PEI module, PeiCore will first search TE section from this PEIM to load the image.
\r
192 # If TE section is not found, then PeiCore will search PE section.
\r
193 # If FALSE, PeiCore will first search PE section from PEIM to load the image.
\r
194 # This PCD is used to tune Pei phase performance to reduce the search image time.
\r
195 # It can be set according to the generated image section type.
\r
196 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreImageLoaderSearchTeSectionFirst|TRUE|BOOLEAN|0x00010044
\r
198 ## If TRUE, force to switch off the support of legacy usb. So legacy usb device driver can not make use of SMI
\r
199 # interrupt to access usb device in the case of absence of usb stack.
\r
201 gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport|FALSE|BOOLEAN|0x00010047
\r
203 ## If TRUE, HiiImageProtocol will be installed.
\r
204 # FALSE is for size reduction.
\r
205 gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHiiImageProtocol|TRUE|BOOLEAN|0x00010100
\r
207 ## If TRUE, USB KeyBoard Driver disables the default keyboard layout.
\r
208 # The default keyboard layout serves as the backup when no keyboard layout can be retrieved
\r
209 # from HII database.
\r
210 gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver|FALSE|BOOLEAN|0x00010200
\r
212 ## If TRUE, Setup Browser supports GUID opcodes generated from Framework HII VFR file by VFR compiler.
\r
213 # If TRUE, the PeiCore will handle the framework FvHob and install FvInfo PPI for it.
\r
214 ## This is used to provide backward compatibility support to Framework HII and Framework FvHob.
\r
215 gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkCompatibilitySupport|FALSE|BOOLEAN|0x00012009
\r
218 # If TRUE, HelloWorld Application will print the verbose information.
\r
219 # This PCD is a sample to explain FeatureFlag PCD usage.
\r
221 gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintEnable|TRUE|BOOLEAN|0x0001200a
\r
224 # If TRUE, FULL FTW protocol services (total six APIs) will be produced.
\r
225 # If FASLE, only FTW Write service is available.
\r
226 gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable|TRUE|BOOLEAN|0x0001200b
\r
229 # If TRUE, DXE IPL must support the UEFI decompression algorithm.
\r
230 # If FALSE, DXE IPL will not support UEFI decompression to save space.
\r
231 gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSupportUefiDecompress|TRUE|BOOLEAN|0x0001200c
\r
233 [PcdsFeatureFlag.IA32]
\r
235 # This feature flag specifies whether DxeIpl switches to long mode to enter DXE phase.
\r
236 # If it is TRUE, DxeIpl will load a 64-bit DxeCore and switch to long mode to hand over to DxeCore;
\r
237 # otherwise, DxeIpl will load a 32-bit DxeCore and perform stack switch to hand over to DxeCore.
\r
238 # It is assumed that 64-bit DxeCore is built in firmware if it is true; otherwise 32-bit DxeCore
\r
239 # is built in firmware.
\r
241 gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode|TRUE|BOOLEAN|0x0001003b
\r
244 ## Dynamic type PCD can be registered callback function for Pcd setting action.
\r
245 # PcdMaxPeiPcdCallBackNumberPerPcdEntry indicate maximum number of callback function
\r
246 # for a dynamic PCD used in PEI phase.
\r
247 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPcdCallBackNumberPerPcdEntry|0x08|UINT32|0x0001000f
\r
249 ## VPD type PCD allow developer point an absoluted physical address PcdVpdBaseAddress
\r
250 # to store PCD value.
\r
252 gEfiMdeModulePkgTokenSpaceGuid.PcdVpdBaseAddress|0x0|UINT32|0x00010010
\r
254 ## Maximum number of FV is supported by PeiCore's dispatching.
\r
255 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxFvSupported|6|UINT32|0x00010030
\r
257 ## Maximum PEIM count in every FV is supported by PeiCore's dispatching.
\r
258 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeimPerFv|32|UINT32|0x00010031
\r
260 ## Maximum stack size for PeiCore.
\r
261 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeiStackSize|0x20000|UINT32|0x00010032
\r
263 ## Maximum PPI count is supported by PeiCore's PPI database.
\r
264 gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPpiSupported|64|UINT32|0x00010033
\r
266 ## Size of the NV variable range. Note that this value should less than or equal to PcdFlashNvStorageFtwSpareSize
\r
267 # The root cause is that variable driver will use FTW protocol to reclaim variable region.
\r
268 # If the length of variable region is larger than FTW spare size, it means the whole variable region can not
\r
269 # be reflushed through the manner of fault tolerant write.
\r
270 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize|0x0|UINT32|0x30000002
\r
272 ## The maximum size of single common variable, that is non-HwErr type varible.
\r
273 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize|0x400|UINT32|0x30000003
\r
275 ## The maximum size of single hardware error record variable.
\r
276 # In IA32/X64 platforms, this value should be larger than 1KB.
\r
277 # In IA64 platforms, this value should be larger than 128KB.
\r
278 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize|0x8000|UINT32|0x30000004
\r
280 ## The size of reserved HwErr variable space. This space is located at NV variable range.
\r
281 # HwErr type variable is stored with common non-volatile variables in NV region.
\r
282 # this value is used to guarantee the space of HwErr type variable and not populated by common variable.
\r
283 gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize|0x8000|UINT32|0x30000006
\r
285 ## The size of volatile buffer. This buffer is used to store VOLATILE attribute variable.
\r
286 gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize|0x10000|UINT32|0x30000005
\r
288 ## Size of the FTW spare block range. Note that this value should larger than PcdFlashNvStorageVariableSize
\r
289 # The root cause is that variable driver will use FTW protocol to reclaim variable region.
\r
290 # If the length of variable region is larger than FTW spare size, it means the whole variable region can not
\r
291 # be reflushed through the manner of fault tolerant write.
\r
292 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize|0x0|UINT32|0x30000014
\r
294 ## Size of the FTW working block range.
\r
295 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize|0x0|UINT32|0x30000011
\r
297 ## FFS filename to find the ACPI tables
\r
298 gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiTableStorageFile|{ 0x25, 0x4e, 0x37, 0x7e, 0x01, 0x8e, 0xee, 0x4f, 0x87, 0xf2, 0x39, 0xc, 0x23, 0xc6, 0x6, 0xcd }|VOID*|16
\r
300 [PcdsFixedAtBuild,PcdsPatchableInModule]
\r
301 ## Maximun number of performance log entries during PEI phase.
\r
302 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPerformanceLogEntries|40|UINT8|0x0001002f
\r
304 ## RTC Update Timeout Value
\r
305 gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout|100000|UINT32|0x00010034
\r
307 [PcdsPatchableInModule,PcdsDynamic]
\r
309 # This PCD defines the Console output column and the default value is 25 according to UEFI spec
\r
311 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutRow|25|UINT32|0x40000006
\r
314 # This PCD defines the Console output row and the default value is 80 according to UEFI spec
\r
316 gEfiMdeModulePkgTokenSpaceGuid.PcdConOutColumn|80|UINT32|0x40000007
\r
318 [PcdsFixedAtBuild,PcdsDynamic]
\r
319 ## Base address of the NV variable range in flash device
\r
320 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase|0x0|UINT32|0x30000001
\r
322 ## Base address of the FTW spare block range in flash device.
\r
323 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase|0x0|UINT32|0x30000013
\r
325 ## Base address of the FTW working block range in flash device.
\r
326 gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase|0x0|UINT32|0x30000010
\r
329 # This PCD defines the print string.
\r
330 # This PCD is a sample to explain String typed PCD usage.
\r
332 gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintString|L"UEFI Hello World!\n"|VOID*|0x40000004
\r
334 [PcdsFixedAtBuild,PcdsPatchableInModule,PcdsDynamic]
\r
336 # This PCD defines the times to print hello world string.
\r
337 # This PCD is a sample to explain FixedAtBuild UINT32 PCD usage.
\r
339 gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintTimes|1|UINT32|0x40000005
\r
341 ## Indicate the max size of the populated capsule image that the platform can support.
\r
342 # The default max size is 100MB (0x6400000) for more than one large capsule images.
\r
343 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizePopulateCapsule|0x6400000|UINT32|0x0001001e
\r
345 ## Indicate the max size of the non-populated capsule image that the platform can support.
\r
346 # The default max size is 10MB (0xa00000) for the casule image without populated flag setting.
\r
347 gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizeNonPopulateCapsule|0xa00000|UINT32|0x0001001f
\r