]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / IntelFrameworkModulePkg / IntelFrameworkModulePkg.dec
CommitLineData
6bfbb5f0 1## @file\r
48695d70
SZ
2# Intel Framework Module Package.\r
3#\r
4# This package contains the definitions and module implementation\r
217b9921 5# which follows Intel EFI Framework Specification.\r
a9102619 6#\r
0a6f4824 7# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
a9102619 8#\r
c0a00b14 9# SPDX-License-Identifier: BSD-2-Clause-Patent\r
a9102619 10#\r
6bfbb5f0 11##\r
a9102619 12\r
a9102619 13[Defines]\r
14 DEC_SPECIFICATION = 0x00010005\r
15 PACKAGE_NAME = IntelFrameworkModulePkg\r
48695d70 16 PACKAGE_UNI_FILE = IntelFrameworkModulePkg.uni\r
a9102619 17 PACKAGE_GUID = 88894582-7553-4822-B484-624E24B6DECF\r
f4d7904b 18 PACKAGE_VERSION = 0.96\r
a9102619 19\r
19525fed 20[Includes]\r
479922d7 21 Include # Root include for the package\r
a9102619 22\r
19525fed 23[LibraryClasses]\r
ddac74d1 24 ## @libraryclass Platform BDS library definition about platform specific behavior.\r
25 PlatformBdsLib|Include/Library/PlatformBdsLib.h\r
f4671790 26\r
ddac74d1 27 ## @libraryclass Generic BDS library definition, include the data structure and function.\r
28 GenericBdsLib|Include/Library/GenericBdsLib.h\r
29\r
19525fed 30[Guids]\r
f4671790 31 ## IntelFrameworkModule package token space guid\r
a90ccab8 32 # Include/Guid/IntelFrameworkModulePkgTokenSpace.h\r
f4671790 33 gEfiIntelFrameworkModulePkgTokenSpaceGuid = { 0xD3705011, 0xBC19, 0x4af7, { 0xBE, 0x16, 0xF6, 0x80, 0x30, 0x37, 0x8C, 0x15 }}\r
73850864 34\r
f4671790 35 ## GUID identifies Data Hub records logged by Status Code Runtime Protocol.\r
a90ccab8 36 # Include/Guid/DataHubStatusCodeRecord.h\r
351986ae 37 gEfiDataHubStatusCodeRecordGuid = { 0xD083E94C, 0x6560, 0x42E4, { 0xB6, 0xD4, 0x2D, 0xF7, 0x5A, 0xDF, 0x6A, 0x2A }}\r
73850864 38\r
f4671790 39 ## GUID indicates the tiano custom compress/decompress algorithm.\r
a90ccab8 40 # Include/Guid/TianoDecompress.h\r
d8c79a81 41 gTianoCustomDecompressGuid = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}\r
73850864 42\r
070fba65 43 ## Include/Guid/AcpiVariable.h\r
44 gEfiAcpiVariableCompatiblityGuid = { 0xc020489e, 0x6db2, 0x4ef2, { 0x9a, 0xa5, 0xca, 0x6, 0xfc, 0x11, 0xd3, 0x6a }}\r
45\r
bcecde14 46 ## Include/Guid/LegacyBios.h\r
47 gEfiLegacyBiosGuid = { 0x2E3044AC, 0x879F, 0x490F, { 0x97, 0x60, 0xBB, 0xDF, 0xAF, 0x69, 0x5F, 0x50 }}\r
0a6f4824 48\r
e24fc103
LG
49 ## Include/Guid/LegacyDevOrder.h\r
50 gEfiLegacyDevOrderVariableGuid = { 0xa56074db, 0x65fe, 0x45f7, {0xbd, 0x21, 0x2d, 0x2b, 0xdd, 0x8e, 0x96, 0x52 }}\r
51\r
52 ## Include/Guid/CapsuleDataFile.h\r
53 gEfiUpdateDataFileGuid = { 0x283fa2ee, 0x532c, 0x484d, { 0x93, 0x83, 0x9f, 0x93, 0xb3, 0x6f, 0xb, 0x7e }}\r
0a6f4824 54\r
e24fc103
LG
55 ## Include/Guid/BlockIoVendor.h\r
56 gBlockIoVendorGuid = { 0xcf31fac5, 0xc24e, 0x11d2, {0x85, 0xf3, 0x0, 0xa0, 0xc9, 0x3e, 0xc9, 0x3b }}\r
0a6f4824 57\r
e24fc103
LG
58 ## Include/Guid/BdsHii.h\r
59 gFrontPageFormSetGuid = { 0x9e0c30bc, 0x3f06, 0x4ba6, {0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe }}\r
60 gBootManagerFormSetGuid = { 0x847bc3fe, 0xb974, 0x446d, {0x94, 0x49, 0x5a, 0xd5, 0x41, 0x2e, 0x99, 0x3b }}\r
61 gDeviceManagerFormSetGuid = { 0x3ebfa8e6, 0x511d, 0x4b5b, {0xa9, 0x5f, 0xfb, 0x38, 0x26, 0xf, 0x1c, 0x27 }}\r
62 gDriverHealthFormSetGuid = { 0xf76e0a70, 0xb5ed, 0x4c38, {0xac, 0x9a, 0xe5, 0xf5, 0x4b, 0xf1, 0x6e, 0x34 }}\r
63 gBootMaintFormSetGuid = { 0x642237c7, 0x35d4, 0x472d, {0x83, 0x65, 0x12, 0xe0, 0xcc, 0xf2, 0x7a, 0x22 }}\r
64 gFileExploreFormSetGuid = { 0x1f2d63e1, 0xfebd, 0x4dc7, {0x9c, 0xc5, 0xba, 0x2b, 0x1c, 0xef, 0x9c, 0x5b }}\r
0a6f4824 65\r
e24fc103
LG
66 ## Include/Guid/BdsLibHii.h\r
67 gBdsLibStringPackageGuid = { 0x3b4d9b23, 0x95ac, 0x44f6, {0x9f, 0xcd, 0xe, 0x95, 0x94, 0x58, 0x6c, 0x72 }}\r
0a6f4824 68\r
e24fc103
LG
69 ## Include/Guid/LastEnumLang.h\r
70 gLastEnumLangGuid = { 0xe8c545b, 0xa2ee, 0x470d, {0x8e, 0x26, 0xbd, 0xa1, 0xa1, 0x3c, 0xa, 0xa3 }}\r
71\r
72 ## Include/Guid/HdBootVariable.h\r
73 gHdBootDevicePathVariablGuid = { 0xfab7e9e1, 0x39dd, 0x4f2b, {0x84, 0x8, 0xe2, 0xe, 0x90, 0x6c, 0xb6, 0xde }}\r
bcecde14 74\r
19525fed 75[Protocols]\r
f4671790 76 ## Vga Mini port binding for a VGA controller\r
a90ccab8 77 # Include/Protocol/VgaMiniPort.h\r
351986ae 78 gEfiVgaMiniPortProtocolGuid = { 0xc7735a2f, 0x88f5, 0x4882, { 0xae, 0x63, 0xfa, 0xac, 0x8c, 0x8b, 0x86, 0xb3 }}\r
e8eecbf4 79\r
f4671790 80 ## ISA I/O Protocol is used to perform ISA device Io/Mem operations.\r
a90ccab8 81 # Include/Protocol/IsaIo.h\r
c3902377 82 gEfiIsaIoProtocolGuid = { 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d }}\r
e8eecbf4 83\r
f4671790 84 ## ISA Acpi Protocol is used to operate and communicate with ISA device.\r
a90ccab8 85 # Include/Protocol/IsaAcpi.h\r
351986ae 86 gEfiIsaAcpiProtocolGuid = { 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 }}\r
e8eecbf4 87\r
da4483cd 88 ## OEM Badging Protocol defines the interface to get the OEM badging image with the dispaly attribute.\r
a90ccab8 89 # Include/Protocol/OEMBadging.h\r
da4483cd 90 gEfiOEMBadgingProtocolGuid = { 0x170E13C0, 0xBF1B, 0x4218, { 0x87, 0x1D, 0x2A, 0xBD, 0xC6, 0xF8, 0x87, 0xBC }}\r
91\r
664e368f 92 ## Include/Protocol/ExitPmAuth.h\r
93 gExitPmAuthProtocolGuid = { 0xd088a413, 0xa70, 0x4217, { 0xba, 0x55, 0x9a, 0x3c, 0xb6, 0x5c, 0x41, 0xb3 }}\r
94\r
48695d70
SZ
95#\r
96# [Error.gEfiIntelFrameworkModulePkgTokenSpaceGuid]\r
97# 0x80000001 | Invalid value provided.\r
98# 0x80000002 | Reserved bits must be set to zero.\r
99#\r
100\r
f4671790 101[PcdsFeatureFlag]\r
48695d70
SZ
102 ## Indicates if OEM device is enabled as StatusCode report device.\r
103 # It is only used in Framework StatusCode implementation. <BR><BR>\r
104 # TRUE - Enable OEM device.<BR>\r
105 # FALSE - Disable OEM device.<BR>\r
106 # @Prompt Report StatusCode via OEM Device\r
b3af5df6 107 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseOEM|FALSE|BOOLEAN|0x00010024\r
d2c315e6 108\r
48695d70
SZ
109 ## Indicates if StatusCode report is loged into DataHub.<BR><BR>\r
110 # TRUE - Log StatusCode report into DataHub.<BR>\r
111 # FALSE - Does not log StatusCode report into DataHub.<BR>\r
112 # @Prompt Log StatusCode into DataHub\r
b3af5df6 113 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseDataHub|FALSE|BOOLEAN|0x00010029\r
d2c315e6 114\r
48695d70
SZ
115 ## Indicates if Serial device uses half hand shake.<BR><BR>\r
116 # TRUE - Serial device uses half hand shake.<BR>\r
117 # FALSE - Serial device doesn't use half hand shake.<BR>\r
118 # @Prompt Enable Serial device Half Hand Shake\r
77b91d89 119 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSerialUseHalfHandshake|FALSE|BOOLEAN|0x00010043\r
120\r
48695d70
SZ
121 ## Indicates if Legacy support is needed for ACPI S3 Save.<BR><BR>\r
122 # TRUE - Support Legacy OS with S3 boot.<BR>\r
123 # FALSE - Does not support Legacy OS with S3 boot.<BR>\r
124 # @Prompt Turn on Legacy Support in S3 Boot\r
bcecde14 125 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformCsmSupport|TRUE|BOOLEAN|0x00010044\r
126\r
0a6f4824 127 ## Indicates if Framework Acpi Support protocol is installed.<BR><BR>\r
48695d70
SZ
128 # TRUE - Install Framework Acpi Support protocol.<BR>\r
129 # FALSE - Doesn't install Framework Acpi Support protocol.<BR>\r
130 # @Prompt Enable Framework Acpi Support\r
8a96515e 131 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdInstallAcpiSupportProtocol|TRUE|BOOLEAN|0x00010046\r
132\r
48695d70
SZ
133 ## Indicates if only Boot logo is showed and all message output is disabled in BDS.<BR><BR>\r
134 # TRUE - Only Boot Logo is showed in boot.<BR>\r
135 # FALSE - All messages and Boot Logo are showed in boot.<BR>\r
136 # @Prompt Enable Boot Logo only\r
2df686c6 137 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootlogoOnlyEnable|FALSE|BOOLEAN|0x00010048\r
138\r
48695d70 139[PcdsFixedAtBuild, PcdsPatchableInModule]\r
d46f3632 140 ## FFS filename to find the default BMP Logo file.\r
48695d70 141 # @Prompt FFS Name of Boot Logo File\r
f9ec2f0f 142 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLogoFile |{ 0x99, 0x8b, 0xB2, 0x7B, 0xBB, 0x61, 0xD5, 0x11, 0x9A, 0x5D, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }|VOID*|0x40000003\r
d46f3632
LG
143\r
144 ## FFS filename to find the shell application.\r
48695d70 145 # @Prompt FFS Name of Shell Application\r
f9ec2f0f 146 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0xB7, 0xD6, 0x7A, 0xC5, 0x15, 0x05, 0xA8, 0x40, 0x9D, 0x21, 0x55, 0x16, 0x52, 0x85, 0x4E, 0x37 }|VOID*|0x40000004\r
d46f3632 147\r
48695d70
SZ
148 ## ISA Bus features to support DMA, SlaveDMA and ISA Memory. <BR><BR>\r
149 # BIT0 indicates if DMA is supported<BR>\r
150 # BIT1 indicates if only slave DMA is supported<BR>\r
151 # BIT2 indicates if ISA memory is supported<BR>\r
152 # Other BITs are reseved and must be zero.\r
153 # If more than one features are supported, the different BIT will be enabled at the same time.\r
154 # @Prompt ISA Bus Features\r
155 # @Expression 0x80000002 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportedFeatures & 0xF8) == 0\r
10c1a4ca 156 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportedFeatures|0x05|UINT8|0x00010040\r
157\r
4784d660 158[PcdsDynamic, PcdsDynamicEx]\r
48695d70
SZ
159 ## Indicates if the machine has completed one boot cycle before.\r
160 # After the complete boot, BootState will be set to FALSE.<BR><BR>\r
161 # TRUE - The complete boot cycle has not happened before.<BR>\r
162 # FALSE - The complete boot cycle has happened before.<BR>\r
163 # @Prompt Boot State Flag\r
f4671790 164 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootState|TRUE|BOOLEAN|0x0001002f\r
73850864 165\r
d8387fa4 166[PcdsFixedAtBuild, PcdsDynamic, PcdsDynamicEx, PcdsPatchableInModule]\r
167 ## I/O Base address of floppy device controller.\r
48695d70 168 # @Prompt I/O Base Address of Floppy Device Controller\r
d8387fa4 169 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFdcBaseAddress|0x3f0|UINT16|0x30000000\r
170\r
48695d70
SZ
171 ## Indicates if BiosVideo driver will switch to 80x25 Text VGA Mode when exiting boot service.<BR><BR>\r
172 # TRUE - Switch to Text VGA Mode.<BR>\r
173 # FALSE - Does not switch to Text VGA Mode.<BR>\r
174 # @Prompt Switch to Text VGA Mode on UEFI Boot\r
bcecde14 175 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoSetTextVgaModeEnable|FALSE|BOOLEAN|0x30000001\r
176\r
48695d70
SZ
177 ## Indicates if BiosVideo driver will check for VESA BIOS Extension service support.<BR><BR>\r
178 # TRUE - Check for VESA BIOS Extension service.<BR>\r
179 # FALSE - Does not check for VESA BIOS Extension service.<BR>\r
180 # @Prompt Enable Check for VESA BIOS Extension Service\r
bcecde14 181 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVbeEnable|TRUE|BOOLEAN|0x30000002\r
182\r
48695d70 183 ## Indicates if BiosVideo driver will check for VGA service support.\r
bcecde14 184 # NOTE: If both PcdBiosVideoCheckVbeEnable and PcdBiosVideoCheckVgaEnable are set to FALSE,\r
48695d70
SZ
185 # that means Graphics Output protocol will not be installed, the VGA miniport protocol will be installed instead.<BR><BR>\r
186 # TRUE - Check for VGA service.<BR>\r
187 # FALSE - Does not check for VGA service.<BR>\r
188 # @Prompt Enable Check for VGA Service\r
bcecde14 189 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVgaEnable|TRUE|BOOLEAN|0x30000003\r
190\r
48695d70
SZ
191 ## Indicates if memory space for legacy region will be set as cacheable.<BR><BR>\r
192 # TRUE - Set cachebility for legacy region.<BR>\r
193 # FALSE - Does not set cachebility for legacy region.<BR>\r
194 # @Prompt Enable Cachebility for Legacy Region\r
bcecde14 195 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLegacyBiosCacheLegacyRegion|TRUE|BOOLEAN|0x00000004\r
196\r
48695d70 197 ## Specify memory size with bytes to reserve EBDA below 640K for OPROM.\r
0a6f4824 198 # The value should be a multiple of 4KB.\r
48695d70
SZ
199 # @Prompt Reserved EBDA Memory Size\r
200 # @Expression 0x80000001 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEbdaReservedMemorySize < 0xA0000) AND ((gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEbdaReservedMemorySize & 0x1000) == 0)\r
bcecde14 201 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEbdaReservedMemorySize|0x8000|UINT32|0x30000005\r
202\r
48695d70 203 ## Specify memory base address for OPROM to find free memory.\r
0a6f4824 204 # Some OPROMs do not use EBDA or PMM to allocate memory for its usage,\r
3e5eb447 205 # instead they find the memory filled with zero from 0x20000.\r
d0ad204c 206 # The value should be a multiple of 4KB.\r
0a6f4824 207 # The range should be below the EBDA reserved range from\r
48695d70 208 # (CONVENTIONAL_MEMORY_TOP - Reserved EBDA Memory Size) to CONVENTIONAL_MEMORY_TOP.\r
c00fd724
QS
209 # @Prompt Reserved Memory Base Address for OPROM\r
210 # @Expression 0x80000001 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemoryBase >= 0x20000) AND ((gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemoryBase & 0x1000) == 0)\r
3e5eb447 211 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemoryBase|0x60000|UINT32|0x3000000c\r
0a6f4824 212\r
48695d70 213 ## Specify memory size with bytes for OPROM to find free memory.\r
0a6f4824 214 # The value should be a multiple of 4KB. And the range should be below the EBDA reserved range from\r
48695d70 215 # (CONVENTIONAL_MEMORY_TOP - Reserved EBDA Memory Size) to CONVENTIONAL_MEMORY_TOP.\r
c00fd724
QS
216 # @Prompt Reserved Memory Size for OPROM\r
217 # @Expression 0x80000001 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemorySize < 0x80000) AND ((gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemorySize & 0x1000) == 0)\r
3e5eb447 218 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemorySize|0x28000|UINT32|0x3000000d\r
219\r
48695d70 220 ## Specify memory size with page number for a pre-allocated reserved memory to be used\r
0a6f4824 221 # by PEI in S3 phase. The default size 32K. When changing the value make sure the memory size\r
48695d70
SZ
222 # is large enough to meet PEI requirement in the S3 phase.\r
223 # @Prompt Reserved S3 Boot ACPI Memory Size\r
88d20adc 224 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdS3AcpiReservedMemorySize|0x8000|UINT32|0x30000006\r
225\r
48695d70 226 ## Specify the end of address below 1MB for the OPROM.\r
befbc4f3 227 # The last shadowed OpROM should not exceed this address.\r
48695d70
SZ
228 # @Prompt Top Address of Shadowed Legacy OpROM\r
229 # @Expression 0x80000001 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEndOpromShadowAddress < 0x100000\r
befbc4f3 230 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEndOpromShadowAddress|0xdffff|UINT32|0x30000008\r
0a6f4824 231\r
48695d70 232 ## Specify the low PMM (Post Memory Manager) size with bytes below 1MB.\r
befbc4f3 233 # The value should be a multiple of 4KB.\r
48695d70
SZ
234 # @Prompt Low PMM (Post Memory Manager) Size\r
235 # @Expression 0x80000001 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLowPmmMemorySize < 0x100000) AND ((gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLowPmmMemorySize & 0x1000) == 0)\r
befbc4f3 236 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLowPmmMemorySize|0x10000|UINT32|0x30000009\r
0a6f4824 237\r
48695d70 238 ## Specify the high PMM (Post Memory Manager) size with bytes above 1MB.\r
befbc4f3 239 # The value should be a multiple of 4KB.\r
48695d70
SZ
240 # @Prompt High PMM (Post Memory Manager) Size\r
241 # @Expression 0x80000001 | (gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHighPmmMemorySize & 0x1000) == 0\r
befbc4f3 242 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHighPmmMemorySize|0x400000|UINT32|0x3000000a\r
4ccfd305 243\r
48695d70
SZ
244[UserExtensions.TianoCore."ExtraFiles"]\r
245 IntelFrameworkModulePkgExtra.uni\r