IntelFrameworkModulePkg: INF/DEC file updates to EDK II packages
[mirror_edk2.git] / IntelFrameworkModulePkg / IntelFrameworkModulePkg.dec
1 ## @file
2 # Intel Framework Module Package.
3 #
4 # This package contains the definitions and module implementation
5 # which follows Intel EFI Framework Specification.
6 #
7 # Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>
8 #
9 # This program and the accompanying materials
10 # are licensed and made available under the terms and conditions of the BSD License
11 # which accompanies this distribution. The full text of the license may be found at
12 # http://opensource.org/licenses/bsd-license.php
13 #
14 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #
17 ##
18
19 [Defines]
20 DEC_SPECIFICATION = 0x00010005
21 PACKAGE_NAME = IntelFrameworkModulePkg
22 PACKAGE_UNI_FILE = IntelFrameworkModulePkg.uni
23 PACKAGE_GUID = 88894582-7553-4822-B484-624E24B6DECF
24 PACKAGE_VERSION = 0.93
25
26 [Includes]
27 Include # Root include for the package
28
29 [LibraryClasses]
30 ## @libraryclass Platform BDS library definition about platform specific behavior.
31 PlatformBdsLib|Include/Library/PlatformBdsLib.h
32
33 ## @libraryclass Generic BDS library definition, include the data structure and function.
34 GenericBdsLib|Include/Library/GenericBdsLib.h
35
36 [Guids]
37 ## IntelFrameworkModule package token space guid
38 # Include/Guid/IntelFrameworkModulePkgTokenSpace.h
39 gEfiIntelFrameworkModulePkgTokenSpaceGuid = { 0xD3705011, 0xBC19, 0x4af7, { 0xBE, 0x16, 0xF6, 0x80, 0x30, 0x37, 0x8C, 0x15 }}
40
41 ## GUID identifies Data Hub records logged by Status Code Runtime Protocol.
42 # Include/Guid/DataHubStatusCodeRecord.h
43 gEfiDataHubStatusCodeRecordGuid = { 0xD083E94C, 0x6560, 0x42E4, { 0xB6, 0xD4, 0x2D, 0xF7, 0x5A, 0xDF, 0x6A, 0x2A }}
44
45 ## GUID indicates the tiano custom compress/decompress algorithm.
46 # Include/Guid/TianoDecompress.h
47 gTianoCustomDecompressGuid = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}
48
49 ## GUID indicates the LZMA custom compress/decompress algorithm.
50 # Include/Guid/LzmaDecompress.h
51 gLzmaCustomDecompressGuid = { 0xEE4E5898, 0x3914, 0x4259, { 0x9D, 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF }}
52 gLzmaF86CustomDecompressGuid = { 0xD42AE6BD, 0x1352, 0x4bfb, { 0x90, 0x9A, 0xCA, 0x72, 0xA6, 0xEA, 0xE8, 0x89 }}
53
54 ## Include/Guid/AcpiVariable.h
55 gEfiAcpiVariableCompatiblityGuid = { 0xc020489e, 0x6db2, 0x4ef2, { 0x9a, 0xa5, 0xca, 0x6, 0xfc, 0x11, 0xd3, 0x6a }}
56
57 ## Include/Guid/LegacyBios.h
58 gEfiLegacyBiosGuid = { 0x2E3044AC, 0x879F, 0x490F, { 0x97, 0x60, 0xBB, 0xDF, 0xAF, 0x69, 0x5F, 0x50 }}
59
60 ## Include/Guid/LegacyDevOrder.h
61 gEfiLegacyDevOrderVariableGuid = { 0xa56074db, 0x65fe, 0x45f7, {0xbd, 0x21, 0x2d, 0x2b, 0xdd, 0x8e, 0x96, 0x52 }}
62
63 ## Include/Guid/CapsuleDataFile.h
64 gEfiUpdateDataFileGuid = { 0x283fa2ee, 0x532c, 0x484d, { 0x93, 0x83, 0x9f, 0x93, 0xb3, 0x6f, 0xb, 0x7e }}
65
66 ## Include/Guid/BlockIoVendor.h
67 gBlockIoVendorGuid = { 0xcf31fac5, 0xc24e, 0x11d2, {0x85, 0xf3, 0x0, 0xa0, 0xc9, 0x3e, 0xc9, 0x3b }}
68
69 ## Include/Guid/BdsHii.h
70 gFrontPageFormSetGuid = { 0x9e0c30bc, 0x3f06, 0x4ba6, {0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe }}
71 gBootManagerFormSetGuid = { 0x847bc3fe, 0xb974, 0x446d, {0x94, 0x49, 0x5a, 0xd5, 0x41, 0x2e, 0x99, 0x3b }}
72 gDeviceManagerFormSetGuid = { 0x3ebfa8e6, 0x511d, 0x4b5b, {0xa9, 0x5f, 0xfb, 0x38, 0x26, 0xf, 0x1c, 0x27 }}
73 gDriverHealthFormSetGuid = { 0xf76e0a70, 0xb5ed, 0x4c38, {0xac, 0x9a, 0xe5, 0xf5, 0x4b, 0xf1, 0x6e, 0x34 }}
74 gBootMaintFormSetGuid = { 0x642237c7, 0x35d4, 0x472d, {0x83, 0x65, 0x12, 0xe0, 0xcc, 0xf2, 0x7a, 0x22 }}
75 gFileExploreFormSetGuid = { 0x1f2d63e1, 0xfebd, 0x4dc7, {0x9c, 0xc5, 0xba, 0x2b, 0x1c, 0xef, 0x9c, 0x5b }}
76
77 ## Include/Guid/BdsLibHii.h
78 gBdsLibStringPackageGuid = { 0x3b4d9b23, 0x95ac, 0x44f6, {0x9f, 0xcd, 0xe, 0x95, 0x94, 0x58, 0x6c, 0x72 }}
79
80 ## Include/Guid/LastEnumLang.h
81 gLastEnumLangGuid = { 0xe8c545b, 0xa2ee, 0x470d, {0x8e, 0x26, 0xbd, 0xa1, 0xa1, 0x3c, 0xa, 0xa3 }}
82
83 ## Include/Guid/HdBootVariable.h
84 gHdBootDevicePathVariablGuid = { 0xfab7e9e1, 0x39dd, 0x4f2b, {0x84, 0x8, 0xe2, 0xe, 0x90, 0x6c, 0xb6, 0xde }}
85
86 [Protocols]
87 ## Vga Mini port binding for a VGA controller
88 # Include/Protocol/VgaMiniPort.h
89 gEfiVgaMiniPortProtocolGuid = { 0xc7735a2f, 0x88f5, 0x4882, { 0xae, 0x63, 0xfa, 0xac, 0x8c, 0x8b, 0x86, 0xb3 }}
90
91 ## ISA I/O Protocol is used to perform ISA device Io/Mem operations.
92 # Include/Protocol/IsaIo.h
93 gEfiIsaIoProtocolGuid = { 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d }}
94
95 ## ISA Acpi Protocol is used to operate and communicate with ISA device.
96 # Include/Protocol/IsaAcpi.h
97 gEfiIsaAcpiProtocolGuid = { 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 }}
98
99 ## PS/2 policy protocol abstracts the specific platform initialization and setting.
100 # Include/Protocol/Ps2Policy.h
101 gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE, 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 }}
102
103 ## OEM Badging Protocol defines the interface to get the OEM badging image with the dispaly attribute.
104 # Include/Protocol/OEMBadging.h
105 gEfiOEMBadgingProtocolGuid = { 0x170E13C0, 0xBF1B, 0x4218, { 0x87, 0x1D, 0x2A, 0xBD, 0xC6, 0xF8, 0x87, 0xBC }}
106
107 ## Include/Protocol/ExitPmAuth.h
108 gExitPmAuthProtocolGuid = { 0xd088a413, 0xa70, 0x4217, { 0xba, 0x55, 0x9a, 0x3c, 0xb6, 0x5c, 0x41, 0xb3 }}
109
110 #
111 # [Error.gEfiIntelFrameworkModulePkgTokenSpaceGuid]
112 # 0x80000001 | Invalid value provided.
113 # 0x80000002 | Reserved bits must be set to zero.
114 #
115
116 [PcdsFeatureFlag]
117 ## Indicates if OEM device is enabled as StatusCode report device.
118 # It is only used in Framework StatusCode implementation. <BR><BR>
119 # TRUE - Enable OEM device.<BR>
120 # FALSE - Disable OEM device.<BR>
121 # @Prompt Report StatusCode via OEM Device
122 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseOEM|FALSE|BOOLEAN|0x00010024
123
124 ## Indicates if StatusCode report is loged into DataHub.<BR><BR>
125 # TRUE - Log StatusCode report into DataHub.<BR>
126 # FALSE - Does not log StatusCode report into DataHub.<BR>
127 # @Prompt Log StatusCode into DataHub
128 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseDataHub|FALSE|BOOLEAN|0x00010029
129
130 ## Indicates if Serial device uses half hand shake.<BR><BR>
131 # TRUE - Serial device uses half hand shake.<BR>
132 # FALSE - Serial device doesn't use half hand shake.<BR>
133 # @Prompt Enable Serial device Half Hand Shake
134 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSerialUseHalfHandshake|FALSE|BOOLEAN|0x00010043
135
136 ## Indicates if Legacy support is needed for ACPI S3 Save.<BR><BR>
137 # TRUE - Support Legacy OS with S3 boot.<BR>
138 # FALSE - Does not support Legacy OS with S3 boot.<BR>
139 # @Prompt Turn on Legacy Support in S3 Boot
140 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformCsmSupport|TRUE|BOOLEAN|0x00010044
141
142 ## Indicates if PS2 keyboard does a extended verification during start.
143 # Extended verification will take some performance. It can be set to FALSE for boot performance.<BR><BR>
144 # TRUE - Turn on PS2 keyboard extended verification.<BR>
145 # FALSE - Turn off PS2 keyboard extended verification.<BR>
146 # @Prompt Turn on PS2 Keyboard Extended Verification
147 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2KbdExtendedVerification|TRUE|BOOLEAN|0x00010045
148
149 ## Indicates if Framework Acpi Support protocol is installed.<BR><BR>
150 # TRUE - Install Framework Acpi Support protocol.<BR>
151 # FALSE - Doesn't install Framework Acpi Support protocol.<BR>
152 # @Prompt Enable Framework Acpi Support
153 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdInstallAcpiSupportProtocol|TRUE|BOOLEAN|0x00010046
154
155
156 ## Indicates if PS2 mouse does a extended verification during start.
157 # Extended verification will take some performance. It can be set to FALSE for boot performance.<BR><BR>
158 # TRUE - Turn on PS2 mouse extended verification. <BR>
159 # FALSE - Turn off PS2 mouse extended verification. <BR>
160 # @Prompt Turn on PS2 Mouse Extended Verification
161 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2MouseExtendedVerification|TRUE|BOOLEAN|0x00010047
162
163 ## Indicates if only Boot logo is showed and all message output is disabled in BDS.<BR><BR>
164 # TRUE - Only Boot Logo is showed in boot.<BR>
165 # FALSE - All messages and Boot Logo are showed in boot.<BR>
166 # @Prompt Enable Boot Logo only
167 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootlogoOnlyEnable|FALSE|BOOLEAN|0x00010048
168
169 [PcdsFixedAtBuild, PcdsPatchableInModule]
170 ## FFS filename to find the default BMP Logo file.
171 # @Prompt FFS Name of Boot Logo File
172 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLogoFile |{ 0x99, 0x8b, 0xB2, 0x7B, 0xBB, 0x61, 0xD5, 0x11, 0x9A, 0x5D, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }|VOID*|0x40000003
173
174 ## FFS filename to find the shell application.
175 # @Prompt FFS Name of Shell Application
176 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0xB7, 0xD6, 0x7A, 0xC5, 0x15, 0x05, 0xA8, 0x40, 0x9D, 0x21, 0x55, 0x16, 0x52, 0x85, 0x4E, 0x37 }|VOID*|0x40000004
177
178 ## ISA Bus features to support DMA, SlaveDMA and ISA Memory. <BR><BR>
179 # BIT0 indicates if DMA is supported<BR>
180 # BIT1 indicates if only slave DMA is supported<BR>
181 # BIT2 indicates if ISA memory is supported<BR>
182 # Other BITs are reseved and must be zero.
183 # If more than one features are supported, the different BIT will be enabled at the same time.
184 # @Prompt ISA Bus Features
185 # @Expression 0x80000002 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportedFeatures & 0xF8) == 0
186 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportedFeatures|0x05|UINT8|0x00010040
187
188 [PcdsDynamic, PcdsDynamicEx]
189 ## Indicates if the machine has completed one boot cycle before.
190 # After the complete boot, BootState will be set to FALSE.<BR><BR>
191 # TRUE - The complete boot cycle has not happened before.<BR>
192 # FALSE - The complete boot cycle has happened before.<BR>
193 # @Prompt Boot State Flag
194 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootState|TRUE|BOOLEAN|0x0001002f
195
196 ## The number of seconds that the firmware will wait before initiating the original default boot selection.
197 # A value of 0 indicates that the default boot selection is to be initiated immediately on boot.
198 # The value of 0xFFFF then firmware will wait for user input before booting.
199 # @Prompt Boot Timeout (s)
200 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformBootTimeOut|0xffff|UINT16|0x40000001
201
202 ## Error level for hardware recorder.
203 # If value 0, platform does not support feature of hardware error record.
204 # @Prompt Error Level For Hardware Recorder
205 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel|0|UINT16|0x40000002
206
207 [PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
208 # The 4 PCDs below are used to specify the video resolution and text mode of text setup.
209 # To make text setup work in this resolution, PcdVideoHorizontalResolution, PcdVideoVerticalResolution,
210 # PcdConOutColumn and PcdConOutRow in MdeModulePkg.dec should be created as PcdsDynamic or PcdsDynamicEx
211 # in platform DSC file. Then BDS setup will update these PCDs defined in MdeModulePkg.dec and reconnect
212 # console drivers (GraphicsConsole, Terminal, Consplitter) to make the video resolution and text mode work
213 # for text setup.
214
215 ## Specify the video horizontal resolution of text setup.
216 # @Prompt Video Horizontal Resolution of Text Setup
217 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdSetupVideoHorizontalResolution|800|UINT32|0x50000001
218
219 ## Specify the video vertical resolution of text setup.
220 # @Prompt Video Vertical Resolution of Text Setup
221 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdSetupVideoVerticalResolution|600|UINT32|0x50000002
222
223 ## Specify the console output column of text setup.
224 # @Prompt Console Output Column of Text Setup
225 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdSetupConOutColumn|80|UINT32|0x50000003
226
227 ## Specify the console output row of text setup.
228 # @Prompt Console Output Row of Text Setup
229 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdSetupConOutRow|25|UINT32|0x50000004
230
231 [PcdsFixedAtBuild, PcdsDynamic, PcdsDynamicEx, PcdsPatchableInModule]
232 ## I/O Base address of floppy device controller.
233 # @Prompt I/O Base Address of Floppy Device Controller
234 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFdcBaseAddress|0x3f0|UINT16|0x30000000
235
236 ## Indicates if BiosVideo driver will switch to 80x25 Text VGA Mode when exiting boot service.<BR><BR>
237 # TRUE - Switch to Text VGA Mode.<BR>
238 # FALSE - Does not switch to Text VGA Mode.<BR>
239 # @Prompt Switch to Text VGA Mode on UEFI Boot
240 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoSetTextVgaModeEnable|FALSE|BOOLEAN|0x30000001
241
242 ## Indicates if BiosVideo driver will check for VESA BIOS Extension service support.<BR><BR>
243 # TRUE - Check for VESA BIOS Extension service.<BR>
244 # FALSE - Does not check for VESA BIOS Extension service.<BR>
245 # @Prompt Enable Check for VESA BIOS Extension Service
246 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVbeEnable|TRUE|BOOLEAN|0x30000002
247
248 ## Indicates if BiosVideo driver will check for VGA service support.
249 # NOTE: If both PcdBiosVideoCheckVbeEnable and PcdBiosVideoCheckVgaEnable are set to FALSE,
250 # that means Graphics Output protocol will not be installed, the VGA miniport protocol will be installed instead.<BR><BR>
251 # TRUE - Check for VGA service.<BR>
252 # FALSE - Does not check for VGA service.<BR>
253 # @Prompt Enable Check for VGA Service
254 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVgaEnable|TRUE|BOOLEAN|0x30000003
255
256 ## Indicates if memory space for legacy region will be set as cacheable.<BR><BR>
257 # TRUE - Set cachebility for legacy region.<BR>
258 # FALSE - Does not set cachebility for legacy region.<BR>
259 # @Prompt Enable Cachebility for Legacy Region
260 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLegacyBiosCacheLegacyRegion|TRUE|BOOLEAN|0x00000004
261
262 ## Specify memory size with bytes to reserve EBDA below 640K for OPROM.
263 # The value should be a multiple of 4KB.
264 # @Prompt Reserved EBDA Memory Size
265 # @Expression 0x80000001 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEbdaReservedMemorySize < 0xA0000) AND ((gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEbdaReservedMemorySize & 0x1000) == 0)
266 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEbdaReservedMemorySize|0x8000|UINT32|0x30000005
267
268 ## Specify memory base address for OPROM to find free memory.
269 # Some OPROMs do not use EBDA or PMM to allocate memory for its usage,
270 # instead they find the memory filled with zero from 0x20000.
271 # The value should be a multiple of 4KB.
272 # The range should be below the EBDA reserved range from
273 # (CONVENTIONAL_MEMORY_TOP - Reserved EBDA Memory Size) to CONVENTIONAL_MEMORY_TOP.
274 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemoryBase|0x60000|UINT32|0x3000000c
275
276 ## Specify memory size with bytes for OPROM to find free memory.
277 # The value should be a multiple of 4KB. And the range should be below the EBDA reserved range from
278 # (CONVENTIONAL_MEMORY_TOP - Reserved EBDA Memory Size) to CONVENTIONAL_MEMORY_TOP.
279 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemorySize|0x28000|UINT32|0x3000000d
280
281 ## Specify memory size with page number for a pre-allocated reserved memory to be used
282 # by PEI in S3 phase. The default size 32K. When changing the value make sure the memory size
283 # is large enough to meet PEI requirement in the S3 phase.
284 # @Prompt Reserved S3 Boot ACPI Memory Size
285 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdS3AcpiReservedMemorySize|0x8000|UINT32|0x30000006
286
287 ## Specify memory size for boot script executor stack usage in S3 phase.
288 # The default size 32K. When changing the value make sure the memory size is large enough
289 # to meet boot script executor requirement in the S3 phase.
290 # @Prompt Reserved S3 Boot Script Stack ACPI Memory Size
291 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdS3BootScriptStackSize|0x8000|UINT32|0x30000007
292
293 ## Specify the end of address below 1MB for the OPROM.
294 # The last shadowed OpROM should not exceed this address.
295 # @Prompt Top Address of Shadowed Legacy OpROM
296 # @Expression 0x80000001 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEndOpromShadowAddress < 0x100000
297 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEndOpromShadowAddress|0xdffff|UINT32|0x30000008
298
299 ## Specify the low PMM (Post Memory Manager) size with bytes below 1MB.
300 # The value should be a multiple of 4KB.
301 # @Prompt Low PMM (Post Memory Manager) Size
302 # @Expression 0x80000001 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLowPmmMemorySize < 0x100000) AND ((gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLowPmmMemorySize & 0x1000) == 0)
303 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLowPmmMemorySize|0x10000|UINT32|0x30000009
304
305 ## Specify the high PMM (Post Memory Manager) size with bytes above 1MB.
306 # The value should be a multiple of 4KB.
307 # @Prompt High PMM (Post Memory Manager) Size
308 # @Expression 0x80000001 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHighPmmMemorySize & 0x1000) == 0
309 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHighPmmMemorySize|0x400000|UINT32|0x3000000a
310
311 ## Indicates if to use the optimized timing for best PS2 detection performance.
312 # Note this PCD could be set to TRUE for best boot performance and set to FALSE for best device compatibility.<BR><BR>
313 # TRUE - Use the optimized timing for best PS2 detection performance.<BR>
314 # FALSE - Use the normal timing to detect PS2.<BR>
315 # @Prompt Enable fast PS2 detection
316 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFastPS2Detection|FALSE|BOOLEAN|0x3000000b
317
318 [UserExtensions.TianoCore."ExtraFiles"]
319 IntelFrameworkModulePkgExtra.uni