]>
Commit | Line | Data |
---|---|---|
5c08e117 | 1 | /** @file\r |
2 | Head file for BDS Architectural Protocol implementation\r | |
3 | \r | |
46433d44 | 4 | Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r |
180a5a35 | 5 | This program and the accompanying materials\r |
5c08e117 | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _BDS_MODULE_H_\r | |
16 | #define _BDS_MODULE_H_\r | |
17 | \r | |
79bc7a89 | 18 | #include <FrameworkDxe.h>\r |
67d63227 | 19 | #include <IndustryStandard/PeImage.h>\r |
a2ded1d6 | 20 | #include <Guid/MdeModuleHii.h>\r |
5c08e117 | 21 | #include <Guid/FileSystemVolumeLabelInfo.h>\r |
ab4da126 | 22 | #include <Guid/HiiPlatformSetupFormset.h>\r |
69fc8f08 | 23 | #include <Guid/StatusCodeDataTypeVariable.h>\r |
5c08e117 | 24 | #include <Protocol/DevicePath.h>\r |
6cfbf7ad | 25 | #include <IndustryStandard/SmBios.h>\r |
5c08e117 | 26 | #include <Protocol/LoadFile.h>\r |
5c08e117 | 27 | #include <Guid/FileInfo.h>\r |
28 | #include <Protocol/HiiConfigRouting.h>\r | |
29 | #include <Protocol/Bds.h>\r | |
6cfbf7ad | 30 | #include <Protocol/Smbios.h>\r |
5c08e117 | 31 | #include <Protocol/UgaDraw.h>\r |
32 | #include <Protocol/BlockIo.h>\r | |
33 | #include <Guid/GlobalVariable.h>\r | |
5c08e117 | 34 | #include <Guid/CapsuleVendor.h>\r |
55e1864e | 35 | #include <Guid/StatusCodeDataTypeId.h>\r |
e24fc103 LG |
36 | #include <Guid/LegacyDevOrder.h>\r |
37 | #include <Guid/BdsHii.h>\r | |
5676ccca | 38 | #include <Guid/ConnectConInEvent.h>\r |
566771b0 | 39 | #include <Guid/FmpCapsule.h>\r |
5c08e117 | 40 | #include <Protocol/GenericMemoryTest.h>\r |
41 | #include <Protocol/FormBrowser2.h>\r | |
42 | #include <Protocol/HiiConfigAccess.h>\r | |
43 | #include <Protocol/GraphicsOutput.h>\r | |
44 | #include <Protocol/SimpleFileSystem.h>\r | |
45 | #include <Protocol/HiiDatabase.h>\r | |
46 | #include <Protocol/HiiString.h>\r | |
47 | #include <Protocol/SerialIo.h>\r | |
48 | #include <Protocol/LegacyBios.h>\r | |
49 | #include <Protocol/SimpleTextInEx.h>\r | |
ab4da126 | 50 | #include <Protocol/DriverHealth.h>\r |
a637802c | 51 | #include <Protocol/BootLogo.h>\r |
ff843847 | 52 | #include <Protocol/VariableLock.h>\r |
5c08e117 | 53 | \r |
54 | #include <Library/UefiDriverEntryPoint.h>\r | |
55 | #include <Library/PrintLib.h>\r | |
56 | #include <Library/DebugLib.h>\r | |
57 | #include <Library/BaseMemoryLib.h>\r | |
58 | #include <Library/UefiBootServicesTableLib.h>\r | |
59 | #include <Library/UefiLib.h>\r | |
60 | #include <Library/MemoryAllocationLib.h>\r | |
61 | #include <Library/PerformanceLib.h>\r | |
62 | #include <Library/ReportStatusCodeLib.h>\r | |
5c08e117 | 63 | #include <Library/UefiRuntimeServicesTableLib.h>\r |
64 | #include <Library/HobLib.h>\r | |
65 | #include <Library/BaseLib.h>\r | |
66 | #include <Library/DevicePathLib.h>\r | |
67 | #include <Library/PcdLib.h>\r | |
68 | #include <Library/CapsuleLib.h>\r | |
69 | #include <Library/HiiLib.h>\r | |
f6f910dd | 70 | #include <Library/DevicePathLib.h>\r |
33bb6326 | 71 | #include <Library/UefiHiiServicesLib.h>\r |
5c08e117 | 72 | \r |
73 | #include <Library/GenericBdsLib.h>\r | |
74 | #include <Library/PlatformBdsLib.h>\r | |
75 | \r | |
f6f910dd | 76 | #pragma pack(1)\r |
77 | \r | |
78 | ///\r | |
79 | /// HII specific Vendor Device Path definition.\r | |
80 | ///\r | |
81 | typedef struct {\r | |
82 | VENDOR_DEVICE_PATH VendorDevicePath;\r | |
83 | EFI_DEVICE_PATH_PROTOCOL End;\r | |
84 | } HII_VENDOR_DEVICE_PATH;\r | |
85 | \r | |
86 | #pragma pack()\r | |
87 | \r | |
5c08e117 | 88 | /**\r |
89 | \r | |
90 | Show progress bar with title above it. It only works in Graphics mode.\r | |
91 | \r | |
92 | @param TitleForeground Foreground color for Title.\r | |
93 | @param TitleBackground Background color for Title.\r | |
94 | @param Title Title above progress bar.\r | |
95 | @param ProgressColor Progress bar color.\r | |
96 | @param Progress Progress (0-100)\r | |
97 | @param PreviousValue The previous value of the progress.\r | |
98 | \r | |
99 | @retval EFI_STATUS Success update the progress bar\r | |
100 | \r | |
101 | **/\r | |
102 | EFI_STATUS\r | |
103 | PlatformBdsShowProgress (\r | |
104 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r | |
105 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,\r | |
106 | IN CHAR16 *Title,\r | |
107 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,\r | |
108 | IN UINTN Progress,\r | |
109 | IN UINTN PreviousValue\r | |
110 | );\r | |
111 | \r | |
112 | //\r | |
113 | // Prototypes\r | |
114 | //\r | |
115 | \r | |
116 | /**\r | |
117 | \r | |
118 | Install Boot Device Selection Protocol\r | |
119 | \r | |
120 | @param ImageHandle The image handle.\r | |
121 | @param SystemTable The system table.\r | |
122 | \r | |
123 | @retval EFI_SUCEESS BDS has finished initializing.\r | |
124 | Return the dispatcher and recall BDS.Entry\r | |
125 | @retval Other Return status from AllocatePool() or gBS->InstallProtocolInterface\r | |
126 | \r | |
127 | **/\r | |
128 | EFI_STATUS\r | |
129 | EFIAPI\r | |
130 | BdsInitialize (\r | |
131 | IN EFI_HANDLE ImageHandle,\r | |
132 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
133 | );\r | |
134 | \r | |
135 | /**\r | |
136 | \r | |
137 | Service routine for BdsInstance->Entry(). Devices are connected, the\r | |
138 | consoles are initialized, and the boot options are tried.\r | |
139 | \r | |
140 | @param This Protocol Instance structure.\r | |
141 | \r | |
142 | **/\r | |
143 | VOID\r | |
144 | EFIAPI\r | |
145 | BdsEntry (\r | |
146 | IN EFI_BDS_ARCH_PROTOCOL *This\r | |
147 | );\r | |
148 | \r | |
19bf20e1 LG |
149 | \r |
150 | /**\r | |
151 | Perform the memory test base on the memory test intensive level,\r | |
152 | and update the memory resource.\r | |
153 | \r | |
154 | @param Level The memory test intensive level.\r | |
155 | \r | |
156 | @retval EFI_STATUS Success test all the system memory and update\r | |
157 | the memory resource\r | |
158 | \r | |
159 | **/\r | |
160 | EFI_STATUS\r | |
8861fc79 | 161 | EFIAPI\r |
19bf20e1 LG |
162 | BdsMemoryTest (\r |
163 | IN EXTENDMEM_COVERAGE_LEVEL Level\r | |
164 | );\r | |
165 | \r | |
166 | /**\r | |
167 | \r | |
168 | This routine is called to see if there are any capsules we need to process.\r | |
169 | If the boot mode is not UPDATE, then we do nothing. Otherwise find the\r | |
170 | capsule HOBS and produce firmware volumes for them via the DXE service.\r | |
171 | Then call the dispatcher to dispatch drivers from them. Finally, check\r | |
172 | the status of the updates.\r | |
173 | \r | |
174 | This function should be called by BDS in case we need to do some\r | |
175 | sort of processing even if there is no capsule to process. We\r | |
176 | need to do this if an earlier update went away and we need to\r | |
177 | clear the capsule variable so on the next reset PEI does not see it and\r | |
178 | think there is a capsule available.\r | |
179 | \r | |
180 | @param BootMode the current boot mode\r | |
181 | \r | |
182 | @retval EFI_INVALID_PARAMETER boot mode is not correct for an update\r | |
183 | @retval EFI_SUCCESS There is no error when processing capsule\r | |
184 | \r | |
185 | **/\r | |
186 | EFI_STATUS\r | |
8861fc79 | 187 | EFIAPI\r |
19bf20e1 LG |
188 | BdsProcessCapsules (\r |
189 | EFI_BOOT_MODE BootMode\r | |
190 | );\r | |
191 | \r | |
69fc8f08 RN |
192 | /**\r |
193 | Set the variable and report the error through status code upon failure.\r | |
194 | \r | |
195 | @param VariableName A Null-terminated string that is the name of the vendor's variable.\r | |
196 | Each VariableName is unique for each VendorGuid. VariableName must\r | |
197 | contain 1 or more characters. If VariableName is an empty string,\r | |
198 | then EFI_INVALID_PARAMETER is returned.\r | |
199 | @param VendorGuid A unique identifier for the vendor.\r | |
200 | @param Attributes Attributes bitmask to set for the variable.\r | |
0a6f4824 LG |
201 | @param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,\r |
202 | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or\r | |
203 | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero\r | |
204 | causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is\r | |
205 | set, then a SetVariable() call with a DataSize of zero will not cause any change to\r | |
206 | the variable value (the timestamp associated with the variable may be updated however\r | |
207 | even if no new data value is provided,see the description of the\r | |
208 | EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not\r | |
209 | be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).\r | |
69fc8f08 RN |
210 | @param Data The contents for the variable.\r |
211 | \r | |
212 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r | |
213 | defined by the Attributes.\r | |
214 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the\r | |
215 | DataSize exceeds the maximum allowed.\r | |
216 | @retval EFI_INVALID_PARAMETER VariableName is an empty string.\r | |
217 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
218 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
219 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
220 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
0a6f4824 LG |
221 | @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r |
222 | or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo\r | |
69fc8f08 RN |
223 | does NOT pass the validation check carried out by the firmware.\r |
224 | \r | |
225 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
226 | **/\r | |
227 | EFI_STATUS\r | |
228 | BdsDxeSetVariableAndReportStatusCodeOnError (\r | |
229 | IN CHAR16 *VariableName,\r | |
230 | IN EFI_GUID *VendorGuid,\r | |
231 | IN UINT32 Attributes,\r | |
232 | IN UINTN DataSize,\r | |
233 | IN VOID *Data\r | |
234 | );\r | |
235 | \r | |
5c08e117 | 236 | #endif\r |