]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
Add comments for the return value of GenericBdsLib functions.
[mirror_edk2.git] / IntelFrameworkModulePkg / IntelFrameworkModulePkg.dec
CommitLineData
a9102619 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
217b9921 5# Copyright (c) 2007 - 2009, Intel Corporation.\r
a9102619 6#\r
f8cd287b 7# All rights reserved. This program and the accompanying materials\r
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
15#**/\r
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
21 PACKAGE_VERSION = 0.1\r
22\r
479922d7 23[Includes.common]\r
24 Include # Root include for the package\r
a9102619 25\r
34480eac 26[LibraryClasses.common]\r
f4671790 27 ## @libraryclass OEM status code libary is used to report status code to OEM device.\r
a9102619 28 OemHookStatusCodeLib|Include/Library/OemHookStatusCodeLib.h\r
a9102619 29\r
ddac74d1 30 ## @libraryclass Platform BDS library definition about platform specific behavior.\r
31 PlatformBdsLib|Include/Library/PlatformBdsLib.h\r
f4671790 32\r
ddac74d1 33 ## @libraryclass Generic BDS library definition, include the data structure and function.\r
34 GenericBdsLib|Include/Library/GenericBdsLib.h\r
35\r
a9102619 36[Guids.common]\r
f4671790
LG
37 ## IntelFrameworkModule package token space guid\r
38 ## Include/Guid/IntelFrameworkModulePkgTokenSpace.h\r
39 gEfiIntelFrameworkModulePkgTokenSpaceGuid = { 0xD3705011, 0xBC19, 0x4af7, { 0xBE, 0x16, 0xF6, 0x80, 0x30, 0x37, 0x8C, 0x15 }}\r
40 \r
41 ## GUID identifies status code records HOB that originate from the PEI status code \r
e8eecbf4 42 ## Include/Guid/MemoryStatusCodeRecord.h \r
29941df6 43 gMemoryStatusCodeRecordGuid = { 0x060CC026, 0x4C0D, 0x4DDA, { 0x8F, 0x41, 0x59, 0x5F, 0xEF, 0x00, 0xA5, 0x02 }}\r
e8eecbf4 44 \r
f4671790 45 ## GUID identifies Data Hub records logged by Status Code Runtime Protocol.\r
e8eecbf4 46 ## Include/Guid/DataHubStatusCodeRecord.h\r
351986ae 47 gEfiDataHubStatusCodeRecordGuid = { 0xD083E94C, 0x6560, 0x42E4, { 0xB6, 0xD4, 0x2D, 0xF7, 0x5A, 0xDF, 0x6A, 0x2A }}\r
e8eecbf4 48 \r
f4671790
LG
49 ## GUID indicates the tiano custom compress/decompress algorithm.\r
50 ## Include/Guid/TianoDecompress.h\r
d8c79a81 51 gTianoCustomDecompressGuid = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}\r
4bf32fbe 52 \r
f4671790 53 ## GUID indicates the LZMA custom compress/decompress algorithm.\r
306bf4e2 54 ## Include/Guid/LzmaDecompress.h\r
55 gLzmaCustomDecompressGuid = { 0xEE4E5898, 0x3914, 0x4259, { 0x9D, 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF }}\r
56\r
4bf32fbe 57 ## Guid specify the default BMP logo file.\r
58 ## Include/Guid/Logo.h\r
59 gEfiDefaultBmpLogoGuid = { 0x7BB28B99, 0x61BB, 0x11D5, { 0x9A, 0x5D, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}\r
60 \r
61 ## Guid specify the Shell application.\r
62 ## Include/Guid/ShellFile.h\r
63 gEfiShellFileGuid = { 0xC57AD6B7, 0x0515, 0x40A8, { 0x9D, 0x21, 0x55, 0x16, 0x52, 0x85, 0x4E, 0x37 }}\r
64\r
3a6064fa 65 ## GUID used to pass DEBUG() macro information through the Status Code Protocol and Status Code PPI\r
66 ## Include/Guid/StatusCodeDataTypeDebug.h\r
67 gEfiStatusCodeDataTypeDebugGuid = { 0x9A4E9246, 0xD553, 0x11D5, { 0x87, 0xE2, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xB9 }}\r
68\r
0a6f7170
LG
69 ## Guid for EFI_DISK_INFO_PROTOCOL.Interface to specify Usb interface.\r
70 ## Include/Protocol/DiskInfo.h\r
71 gEfiDiskInfoUsbInterfaceGuid = { 0xCB871572, 0xC11A, 0x47B5, { 0xB4, 0x92, 0x67, 0x5E, 0xAF, 0xA7, 0x77, 0x27 }}\r
72 \r
73 ## Guid for EFI_DISK_INFO_PROTOCOL.Interface to specify Scsi interface.\r
74 ## Include/Protocol/DiskInfo.h\r
75 gEfiDiskInfoScsiInterfaceGuid = { 0x08F74BAA, 0xEA36, 0x41D9, { 0x95, 0x21, 0x21, 0xA7, 0x0F, 0x87, 0x80, 0xBC }}\r
76 \r
77 ## Guid for EFI_DISK_INFO_PROTOCOL.Interface to specify Ide interface.\r
78 ## Include/Protocol/DiskInfo.h\r
79 gEfiDiskInfoIdeInterfaceGuid = { 0x5E948FE3, 0x26D3, 0x42B5, { 0xAF, 0x17, 0x61, 0x02, 0x87, 0x18, 0x8D, 0xEC }}\r
80 \r
81 ## Guid for EFI_DISK_INFO_PROTOCOL.Interface to specify Ahci interface.\r
82 ## Include/Protocol/DiskInfo.h\r
83 gEfiDiskInfoAhciInterfaceGuid = { 0x9e498932, 0x4abc, 0x45af, { 0xa3, 0x4d, 0x02, 0x47, 0x78, 0x7b, 0xe7, 0xc6 }}\r
84\r
a9102619 85[Protocols.common]\r
f4671790 86 ## This protocol is used to add or remove all PCI child devices on the PCI root bridge.\r
e8eecbf4 87 ## Include/Protocol/PciHotPlugRequest.h\r
a9102619 88 gEfiPciHotPlugRequestProtocolGuid = { 0x19CB87AB, 0x2CB9, 0x4665, { 0x83, 0x60, 0xDD, 0xCF, 0x60, 0x54, 0xF7, 0x9D }}\r
e8eecbf4 89\r
f4671790 90 ## Vga Mini port binding for a VGA controller\r
e8eecbf4 91 ## Include/Protocol/VgaMiniPort.h\r
351986ae 92 gEfiVgaMiniPortProtocolGuid = { 0xc7735a2f, 0x88f5, 0x4882, { 0xae, 0x63, 0xfa, 0xac, 0x8c, 0x8b, 0x86, 0xb3 }}\r
e8eecbf4 93\r
f4671790 94 ## ISA I/O Protocol is used to perform ISA device Io/Mem operations.\r
e8eecbf4 95 ## Include/Protocol/IsaIo.h\r
c3902377 96 gEfiIsaIoProtocolGuid = { 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d }}\r
e8eecbf4 97\r
f4671790 98 ## ISA Acpi Protocol is used to operate and communicate with ISA device.\r
e8eecbf4 99 ## Include/Protocol/IsaAcpi.h\r
351986ae 100 gEfiIsaAcpiProtocolGuid = { 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 }}\r
e8eecbf4 101\r
f4671790 102 ## PS/2 policy protocol abstracts the specific platform initialization and setting.\r
e8eecbf4 103 ## Include/Protocol/Ps2Policy.h\r
75d51bcc 104 gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE, 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 }}\r
a9102619 105\r
0a6f7170
LG
106 ## Disk Info protocol is used to export Inquiry Data for a drive.\r
107 ## Include/Protocol/DiskInfo.h\r
108 gEfiDiskInfoProtocolGuid = { 0xD432A67F, 0x14DC, 0x484B, { 0xB3, 0xBB, 0x3F, 0x02, 0x91, 0x84, 0x93, 0x27 }}\r
109\r
da4483cd 110 ## OEM Badging Protocol defines the interface to get the OEM badging image with the dispaly attribute.\r
111 ## Include/Protocol/OEMBadging.h\r
112 gEfiOEMBadgingProtocolGuid = { 0x170E13C0, 0xBF1B, 0x4218, { 0x87, 0x1D, 0x2A, 0xBD, 0xC6, 0xF8, 0x87, 0xBC }}\r
113\r
f4671790 114[PcdsFeatureFlag]\r
588e3299 115 ## This PCD specifies whether StatusCode is reported via Serial port.\r
1f6727d3 116 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseSerial|TRUE|BOOLEAN|0x00010022\r
d2c315e6
LG
117\r
118 ## This PCD specifies whether StatusCode is stored in memory.\r
588e3299 119 # The memory is boot time memory in PEI Phase and is runtime memory in DXE Phase.\r
b3af5df6 120 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseMemory|FALSE|BOOLEAN|0x00010023\r
d2c315e6 121\r
588e3299 122 ## This PCD specifies whether StatusCode is reported via OEM device.\r
b3af5df6 123 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseOEM|FALSE|BOOLEAN|0x00010024\r
d2c315e6
LG
124\r
125 ## This PCD specifies whether StatusCode is loged into DataHub.\r
b3af5df6 126 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseDataHub|FALSE|BOOLEAN|0x00010029\r
d2c315e6
LG
127\r
128 ## This PCD specifies whether Peiphase StatusCode is replayed in DxePhase.\r
129 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeReplayIn|FALSE|BOOLEAN|0x0001002d\r
f4671790 130 \r
d2c315e6 131 ## This PCD specifies whether PciBus supports the hot plug device.\r
b3af5df6 132 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPciBusHotplugDeviceSupport|TRUE|BOOLEAN|0x0001003d\r
f4671790 133 \r
e83c9064 134 ## ISA bus related PCDs to support DMA, SlaveDMA and Memory feature.\r
b3af5df6 135 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportDma|TRUE|BOOLEAN|0x00010040\r
136 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusOnlySupportSlaveDma|FALSE|BOOLEAN|0x00010041\r
137 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportIsaMemory|TRUE|BOOLEAN|0x00010042\r
d2c315e6 138\r
f4671790 139[PcdsFixedAtBuild,PcdsPatchableInModule,PcdsDynamic]\r
d2c315e6
LG
140 ## PcdStatusCodeMemorySize is used when PcdStatusCodeUseMemory is set to true\r
141 # (PcdStatusCodeMemorySize * KBytes) is the total taken memory size.\r
142 # The default value in PeiPhase is 1 KBytes.\r
143 # The default value in DxePhase is 128 KBytes.\r
b3af5df6 144 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeMemorySize|1|UINT16|0x00010025\r
a2b35995 145\r
fa70a2c4 146 ## This PCD specifies whether Serial device use half hand shake.\r
147 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSerialUseHalfHandshake|FALSE|BOOLEAN|0x00010043\r
148\r
f4671790 149[PcdsDynamic]\r
d2c315e6
LG
150 ## PCD is used to mark if the machine has complete one boot cycle before.\r
151 # After the complete boot, the variable BootState will be set to TRUE. \r
f4671790
LG
152 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootState|TRUE|BOOLEAN|0x0001002f\r
153 \r
154 ## Timeout value for displaying progressing bar in before boot OS.\r
d2c315e6 155 # According to UEFI 2.0 spec, the default TimeOut should be 0xffff.\r
f4671790
LG
156 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformBootTimeOut|0xffff|UINT16|0x40000001\r
157\r
158 ## Error level for hardware recorder. If value 0, platform does not support feature of hardware error record.\r
159 # This PCD should be set as HII type PCD by platform integrator mapped to variable L"HwErrRecSupport"\r
160 gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel|0|UINT16|0x40000002\r