projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 6bfbb5f0 | 1 | ## @file\r |
| 217b9921 | 2 | # Intel Framework Module Package contains the definitions and module implementation\r |
| 3 | # which follows Intel EFI Framework Specification.\r | |
| a9102619 | 4 | #\r |
| 5aab2d50 | 5 | # Copyright (c) 2007 - 2012, Intel Corporation. All rights reserved.<BR>\r |
| a9102619 | 6 | #\r |
| 180a5a35 | 7 | # This program and the accompanying materials\r |
| f8cd287b | 8 | # are licensed and made available under the terms and conditions of the BSD License\r |
| 9 | # which accompanies this distribution. The full text of the license may be found at\r | |
| 10 | # http://opensource.org/licenses/bsd-license.php\r | |
| 11 | #\r | |
| 12 | # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 13 | # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| a9102619 | 14 | #\r |
| 6bfbb5f0 | 15 | ##\r |
| a9102619 | 16 | \r |
| a9102619 | 17 | [Defines]\r |
| 18 | DEC_SPECIFICATION = 0x00010005\r | |
| 19 | PACKAGE_NAME = IntelFrameworkModulePkg\r | |
| 20 | PACKAGE_GUID = 88894582-7553-4822-B484-624E24B6DECF\r | |
| 660b39c7 | 21 | PACKAGE_VERSION = 0.92\r |
| a9102619 | 22 | \r |
| 19525fed | 23 | [Includes]\r |
| 479922d7 | 24 | Include # Root include for the package\r |
| a9102619 | 25 | \r |
| 19525fed | 26 | [LibraryClasses]\r |
| ddac74d1 | 27 | ## @libraryclass Platform BDS library definition about platform specific behavior.\r |
| 28 | PlatformBdsLib|Include/Library/PlatformBdsLib.h\r | |
| f4671790 | 29 | \r |
| ddac74d1 | 30 | ## @libraryclass Generic BDS library definition, include the data structure and function.\r |
| 31 | GenericBdsLib|Include/Library/GenericBdsLib.h\r | |
| 32 | \r | |
| 19525fed | 33 | [Guids]\r |
| f4671790 | 34 | ## IntelFrameworkModule package token space guid\r |
| a90ccab8 | 35 | # Include/Guid/IntelFrameworkModulePkgTokenSpace.h\r |
| f4671790 | 36 | gEfiIntelFrameworkModulePkgTokenSpaceGuid = { 0xD3705011, 0xBC19, 0x4af7, { 0xBE, 0x16, 0xF6, 0x80, 0x30, 0x37, 0x8C, 0x15 }}\r |
| 73850864 | 37 | \r |
| f4671790 | 38 | ## GUID identifies Data Hub records logged by Status Code Runtime Protocol.\r |
| a90ccab8 | 39 | # Include/Guid/DataHubStatusCodeRecord.h\r |
| 351986ae | 40 | gEfiDataHubStatusCodeRecordGuid = { 0xD083E94C, 0x6560, 0x42E4, { 0xB6, 0xD4, 0x2D, 0xF7, 0x5A, 0xDF, 0x6A, 0x2A }}\r |
| 73850864 | 41 | \r |
| f4671790 | 42 | ## GUID indicates the tiano custom compress/decompress algorithm.\r |
| a90ccab8 | 43 | # Include/Guid/TianoDecompress.h\r |
| d8c79a81 | 44 | gTianoCustomDecompressGuid = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}\r |
| 73850864 | 45 | \r |
| f4671790 | 46 | ## GUID indicates the LZMA custom compress/decompress algorithm.\r |
| a90ccab8 | 47 | # Include/Guid/LzmaDecompress.h\r |
| 306bf4e2 | 48 | gLzmaCustomDecompressGuid = { 0xEE4E5898, 0x3914, 0x4259, { 0x9D, 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF }}\r |
| 5aab2d50 | 49 | gLzmaF86CustomDecompressGuid = { 0xD42AE6BD, 0x1352, 0x4bfb, { 0x90, 0x9A, 0xCA, 0x72, 0xA6, 0xEA, 0xE8, 0x89 }}\r |
| 306bf4e2 | 50 | \r |
| 070fba65 | 51 | ## Include/Guid/AcpiVariable.h\r |
| 52 | gEfiAcpiVariableCompatiblityGuid = { 0xc020489e, 0x6db2, 0x4ef2, { 0x9a, 0xa5, 0xca, 0x6, 0xfc, 0x11, 0xd3, 0x6a }}\r | |
| 53 | \r | |
| bcecde14 | 54 | ## Include/Guid/LegacyBios.h\r |
| 55 | gEfiLegacyBiosGuid = { 0x2E3044AC, 0x879F, 0x490F, { 0x97, 0x60, 0xBB, 0xDF, 0xAF, 0x69, 0x5F, 0x50 }}\r | |
| e24fc103 LG |
56 | \r |
| 57 | ## Include/Guid/LegacyDevOrder.h\r | |
| 58 | gEfiLegacyDevOrderVariableGuid = { 0xa56074db, 0x65fe, 0x45f7, {0xbd, 0x21, 0x2d, 0x2b, 0xdd, 0x8e, 0x96, 0x52 }}\r | |
| 59 | \r | |
| 60 | ## Include/Guid/CapsuleDataFile.h\r | |
| 61 | gEfiUpdateDataFileGuid = { 0x283fa2ee, 0x532c, 0x484d, { 0x93, 0x83, 0x9f, 0x93, 0xb3, 0x6f, 0xb, 0x7e }}\r | |
| 62 | \r | |
| 63 | ## Include/Guid/BlockIoVendor.h\r | |
| 64 | gBlockIoVendorGuid = { 0xcf31fac5, 0xc24e, 0x11d2, {0x85, 0xf3, 0x0, 0xa0, 0xc9, 0x3e, 0xc9, 0x3b }}\r | |
| 65 | \r | |
| 66 | ## Include/Guid/BdsHii.h\r | |
| 67 | gFrontPageFormSetGuid = { 0x9e0c30bc, 0x3f06, 0x4ba6, {0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe }}\r | |
| 68 | gBootManagerFormSetGuid = { 0x847bc3fe, 0xb974, 0x446d, {0x94, 0x49, 0x5a, 0xd5, 0x41, 0x2e, 0x99, 0x3b }}\r | |
| 69 | gDeviceManagerFormSetGuid = { 0x3ebfa8e6, 0x511d, 0x4b5b, {0xa9, 0x5f, 0xfb, 0x38, 0x26, 0xf, 0x1c, 0x27 }}\r | |
| 70 | gDriverHealthFormSetGuid = { 0xf76e0a70, 0xb5ed, 0x4c38, {0xac, 0x9a, 0xe5, 0xf5, 0x4b, 0xf1, 0x6e, 0x34 }}\r | |
| 71 | gBootMaintFormSetGuid = { 0x642237c7, 0x35d4, 0x472d, {0x83, 0x65, 0x12, 0xe0, 0xcc, 0xf2, 0x7a, 0x22 }}\r | |
| 72 | gFileExploreFormSetGuid = { 0x1f2d63e1, 0xfebd, 0x4dc7, {0x9c, 0xc5, 0xba, 0x2b, 0x1c, 0xef, 0x9c, 0x5b }}\r | |
| 73 | \r | |
| 74 | ## Include/Guid/BdsLibHii.h\r | |
| 75 | gBdsLibStringPackageGuid = { 0x3b4d9b23, 0x95ac, 0x44f6, {0x9f, 0xcd, 0xe, 0x95, 0x94, 0x58, 0x6c, 0x72 }}\r | |
| 76 | \r | |
| 77 | ## Include/Guid/LastEnumLang.h\r | |
| 78 | gLastEnumLangGuid = { 0xe8c545b, 0xa2ee, 0x470d, {0x8e, 0x26, 0xbd, 0xa1, 0xa1, 0x3c, 0xa, 0xa3 }}\r | |
| 79 | \r | |
| 80 | ## Include/Guid/HdBootVariable.h\r | |
| 81 | gHdBootDevicePathVariablGuid = { 0xfab7e9e1, 0x39dd, 0x4f2b, {0x84, 0x8, 0xe2, 0xe, 0x90, 0x6c, 0xb6, 0xde }}\r | |
| bcecde14 | 82 | \r |
| 19525fed | 83 | [Protocols]\r |
| f4671790 | 84 | ## Vga Mini port binding for a VGA controller\r |
| a90ccab8 | 85 | # Include/Protocol/VgaMiniPort.h\r |
| 351986ae | 86 | gEfiVgaMiniPortProtocolGuid = { 0xc7735a2f, 0x88f5, 0x4882, { 0xae, 0x63, 0xfa, 0xac, 0x8c, 0x8b, 0x86, 0xb3 }}\r |
| e8eecbf4 | 87 | \r |
| f4671790 | 88 | ## ISA I/O Protocol is used to perform ISA device Io/Mem operations.\r |
| a90ccab8 | 89 | # Include/Protocol/IsaIo.h\r |
| c3902377 | 90 | gEfiIsaIoProtocolGuid = { 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d }}\r |
| e8eecbf4 | 91 | \r |
| f4671790 | 92 | ## ISA Acpi Protocol is used to operate and communicate with ISA device.\r |
| a90ccab8 | 93 | # Include/Protocol/IsaAcpi.h\r |
| 351986ae | 94 | gEfiIsaAcpiProtocolGuid = { 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 }}\r |
| e8eecbf4 | 95 | \r |
| f4671790 | 96 | ## PS/2 policy protocol abstracts the specific platform initialization and setting.\r |
| a90ccab8 | 97 | # Include/Protocol/Ps2Policy.h\r |
| 75d51bcc | 98 | gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE, 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 }}\r |
| a9102619 | 99 | \r |
| da4483cd | 100 | ## OEM Badging Protocol defines the interface to get the OEM badging image with the dispaly attribute.\r |
| a90ccab8 | 101 | # Include/Protocol/OEMBadging.h\r |
| da4483cd | 102 | gEfiOEMBadgingProtocolGuid = { 0x170E13C0, 0xBF1B, 0x4218, { 0x87, 0x1D, 0x2A, 0xBD, 0xC6, 0xF8, 0x87, 0xBC }}\r |
| 103 | \r | |
| 664e368f | 104 | ## Include/Protocol/ExitPmAuth.h\r |
| 105 | gExitPmAuthProtocolGuid = { 0xd088a413, 0xa70, 0x4217, { 0xba, 0x55, 0x9a, 0x3c, 0xb6, 0x5c, 0x41, 0xb3 }}\r | |
| 106 | \r | |
| f4671790 | 107 | [PcdsFeatureFlag]\r |
| 588e3299 | 108 | ## This PCD specifies whether StatusCode is reported via OEM device.\r |
| b3af5df6 | 109 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseOEM|FALSE|BOOLEAN|0x00010024\r |
| d2c315e6 LG |
110 | \r |
| 111 | ## This PCD specifies whether StatusCode is loged into DataHub.\r | |
| b3af5df6 | 112 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseDataHub|FALSE|BOOLEAN|0x00010029\r |
| d2c315e6 | 113 | \r |
| 77b91d89 | 114 | ## This PCD specifies whether Serial device use half hand shake.\r |
| 115 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSerialUseHalfHandshake|FALSE|BOOLEAN|0x00010043\r | |
| 116 | \r | |
| bcecde14 | 117 | ## Indicates if CSM support is needed for ACPI S3 Save.\r |
| 118 | # If TRUE, CSM support is enclosed for ACPI S3 Save.\r | |
| 119 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformCsmSupport|TRUE|BOOLEAN|0x00010044\r | |
| 120 | \r | |
| f6c014fb | 121 | ## This PCD specifies whether PS2 keyboard does a extended verification during start.\r |
| 122 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2KbdExtendedVerification|TRUE|BOOLEAN|0x00010045\r | |
| 123 | \r | |
| 8a96515e | 124 | ## If TRUE, ACPI Support Protocol will be installed.\r |
| 125 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdInstallAcpiSupportProtocol|TRUE|BOOLEAN|0x00010046\r | |
| 126 | \r | |
| ace74c67 | 127 | ## This PCD specifies whether PS2 mouse does a extended verification during start.\r |
| 128 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2MouseExtendedVerification|TRUE|BOOLEAN|0x00010047\r | |
| 129 | \r | |
| 2df686c6 | 130 | ## This PCD specifies whether only Boot logo is showed and all message output is disabled in BDS \r |
| 131 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootlogoOnlyEnable|FALSE|BOOLEAN|0x00010048\r | |
| 132 | \r | |
| d46f3632 LG |
133 | [PcdsFixedAtBuild]\r |
| 134 | ## FFS filename to find the default BMP Logo file.\r | |
| f9ec2f0f | 135 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLogoFile |{ 0x99, 0x8b, 0xB2, 0x7B, 0xBB, 0x61, 0xD5, 0x11, 0x9A, 0x5D, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }|VOID*|0x40000003\r |
| d46f3632 LG |
136 | \r |
| 137 | ## FFS filename to find the shell application.\r | |
| f9ec2f0f | 138 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0xB7, 0xD6, 0x7A, 0xC5, 0x15, 0x05, 0xA8, 0x40, 0x9D, 0x21, 0x55, 0x16, 0x52, 0x85, 0x4E, 0x37 }|VOID*|0x40000004\r |
| d46f3632 | 139 | \r |
| 10c1a4ca | 140 | ## ISA bus related PCD to support DMA, SlaveDMA and ISA Memory features.\r |
| 141 | # BIT0 indicates if DMA is supported\r | |
| 142 | # BIT1 indicates if only slave DMA is supported\r | |
| 143 | # BIT2 indicates if ISA memory is supported\r | |
| 144 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportedFeatures|0x05|UINT8|0x00010040\r | |
| 145 | \r | |
| 4784d660 | 146 | [PcdsDynamic, PcdsDynamicEx]\r |
| fe8a16e5 ED |
147 | ## The PCD is used to mark whether the machine is in first boot cycle.\r |
| 148 | # TRUE means the machine is in first boot cycle. After completing the first boot,\r | |
| 149 | # the PCD's value will be updated to FALSE.\r | |
| f4671790 | 150 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootState|TRUE|BOOLEAN|0x0001002f\r |
| 73850864 | 151 | \r |
| f4671790 | 152 | ## Timeout value for displaying progressing bar in before boot OS.\r |
| d2c315e6 | 153 | # According to UEFI 2.0 spec, the default TimeOut should be 0xffff.\r |
| f4671790 LG |
154 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformBootTimeOut|0xffff|UINT16|0x40000001\r |
| 155 | \r | |
| 156 | ## Error level for hardware recorder. If value 0, platform does not support feature of hardware error record.\r | |
| 157 | # This PCD should be set as HII type PCD by platform integrator mapped to variable L"HwErrRecSupport"\r | |
| 158 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel|0|UINT16|0x40000002\r | |
| d8387fa4 | 159 | \r |
| 32bc1227 | 160 | [PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]\r |
| 161 | ## The 4 PCDs below are used to specify the video resolution and text mode of text setup.\r | |
| 162 | # To make text setup work in this resolution, PcdVideoHorizontalResolution, PcdVideoVerticalResolution,\r | |
| 163 | # PcdConOutColumn and PcdConOutRow in MdeModulePkg.dec should be created as PcdsDynamic or PcdsDynamicEx\r | |
| 164 | # in platform DSC file. Then BDS setup will update these PCDs defined in MdeModulePkg.dec and reconnect\r | |
| 165 | # console drivers (GraphicsConsole, Terminal, Consplitter) to make the video resolution and text mode work\r | |
| 166 | # for text setup.\r | |
| 167 | \r | |
| 168 | ## The PCD is used to specify the video horizontal resolution of text setup. \r | |
| 169 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdSetupVideoHorizontalResolution|800|UINT32|0x50000001\r | |
| 170 | \r | |
| 171 | ## The PCD is used to specify the video vertical resolution of text setup.\r | |
| 172 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdSetupVideoVerticalResolution|600|UINT32|0x50000002\r | |
| 173 | \r | |
| 174 | ## The PCD is used to specify the console output column of text setup.\r | |
| 175 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdSetupConOutColumn|80|UINT32|0x50000003\r | |
| 176 | \r | |
| 177 | ## The PCD is used to specify the console output column of text setup.\r | |
| 178 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdSetupConOutRow|25|UINT32|0x50000004\r | |
| 179 | \r | |
| d8387fa4 | 180 | [PcdsFixedAtBuild, PcdsDynamic, PcdsDynamicEx, PcdsPatchableInModule]\r |
| 181 | ## I/O Base address of floppy device controller.\r | |
| 182 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFdcBaseAddress|0x3f0|UINT16|0x30000000\r | |
| 183 | \r | |
| bcecde14 | 184 | ## If TRUE, BiosVideo will switch to 80x25 Text VGA Mode when exiting boot service.\r |
| 185 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoSetTextVgaModeEnable|FALSE|BOOLEAN|0x30000001\r | |
| 186 | \r | |
| 187 | ## If TRUE, BiosVideo will check for VESA BIOS Extension service support.\r | |
| 188 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVbeEnable|TRUE|BOOLEAN|0x30000002\r | |
| 189 | \r | |
| 190 | ## If TRUE, BiosVideo will check for VGA service support.\r | |
| 191 | # NOTE: If both PcdBiosVideoCheckVbeEnable and PcdBiosVideoCheckVgaEnable are set to FALSE,\r | |
| 192 | # that means Graphics Output protocol will not be installed, the VGA miniport protocol will be installed instead.\r | |
| 193 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVgaEnable|TRUE|BOOLEAN|0x30000003\r | |
| 194 | \r | |
| 195 | ## If TRUE, memory space for legacy region will be set as cacheable.\r | |
| 196 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLegacyBiosCacheLegacyRegion|TRUE|BOOLEAN|0x00000004\r | |
| 197 | \r | |
| 198 | ## The PCD is used to specify memory size with bytes to reserve EBDA for OPROM.\r | |
| 199 | ## The value should be a multiple of 4KB.\r | |
| 200 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEbdaReservedMemorySize|0x8000|UINT32|0x30000005\r | |
| 201 | \r | |
| 091249f4 | 202 | ## The PCD is used to specify memory size with page number for a pre-allocated reserved memory to be used\r |
| 88d20adc | 203 | # by PEI in S3 phase. The default size 32K. When changing the value of this PCD, the platform\r |
| 204 | # developer should make sure the memory size is large enough to meet PEI requiremnt in S3 phase.\r | |
| 205 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdS3AcpiReservedMemorySize|0x8000|UINT32|0x30000006\r | |
| 206 | \r | |
| 207 | ## The PCD is used to specify memory size for boot script executor stack usage in S3 phase.\r | |
| 208 | # The default size 32K. When changing the value of this PCD, the platform developer should\r | |
| 209 | # make sure the memory size is large enough to meet boot script executor requiremnt in S3 phase.\r | |
| 210 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdS3BootScriptStackSize|0x8000|UINT32|0x30000007\r | |
| 211 | \r | |
| befbc4f3 | 212 | ## The PCD is used to specify the end of address below 1MB for the OPROM.\r |
| 213 | # The last shadowed OpROM should not exceed this address.\r | |
| 214 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEndOpromShadowAddress|0xdffff|UINT32|0x30000008\r | |
| 215 | \r | |
| 216 | ## The PCD is used to specify the low PMM (Post Memory Manager) size with bytes below 1MB.\r | |
| 217 | # The value should be a multiple of 4KB.\r | |
| 218 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLowPmmMemorySize|0x10000|UINT32|0x30000009\r | |
| 219 | \r | |
| 220 | ## The PCD is used to specify the high PMM (Post Memory Manager) size with bytes above 1MB.\r | |
| 221 | # The value should be a multiple of 4KB.\r | |
| 222 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHighPmmMemorySize|0x400000|UINT32|0x3000000a\r | |
| 4ccfd305 | 223 | \r |
| 224 | ## This PCD specifies whether to use the optimized timing for best PS2 detection performance.\r | |
| 225 | # Note this PCD could be set to TRUE for best boot performance and set to FALSE for best device compatibility.\r | |
| 226 | gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFastPS2Detection|FALSE|BOOLEAN|0x3000000b |