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