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