MdeModulePkg: Deprecate EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
[mirror_edk2.git] / MdeModulePkg / Library / UefiBootManagerLib / InternalBm.h
1 /** @file
2 BDS library definition, include the file and data structure
3
4 Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #ifndef _INTERNAL_BM_H_
17 #define _INTERNAL_BM_H_
18
19 #include <PiDxe.h>
20
21 #include <IndustryStandard/Pci.h>
22 #include <IndustryStandard/PeImage.h>
23 #include <IndustryStandard/Atapi.h>
24 #include <IndustryStandard/Scsi.h>
25 #include <IndustryStandard/Nvme.h>
26
27 #include <Protocol/PciRootBridgeIo.h>
28 #include <Protocol/BlockIo.h>
29 #include <Protocol/LoadedImage.h>
30 #include <Protocol/SimpleFileSystem.h>
31 #include <Protocol/LoadFile.h>
32 #include <Protocol/DevicePath.h>
33 #include <Protocol/SimpleTextIn.h>
34 #include <Protocol/SimpleTextInEx.h>
35 #include <Protocol/SimpleTextOut.h>
36 #include <Protocol/SimpleNetwork.h>
37 #include <Protocol/FirmwareVolume2.h>
38 #include <Protocol/PciIo.h>
39 #include <Protocol/GraphicsOutput.h>
40 #include <Protocol/UsbIo.h>
41 #include <Protocol/DiskInfo.h>
42 #include <Protocol/NvmExpressPassthru.h>
43 #include <Protocol/IdeControllerInit.h>
44 #include <Protocol/BootLogo.h>
45 #include <Protocol/DriverHealth.h>
46 #include <Protocol/FormBrowser2.h>
47 #include <Protocol/VariableLock.h>
48 #include <Protocol/RamDisk.h>
49 #include <Protocol/DeferredImageLoad.h>
50
51 #include <Guid/MemoryTypeInformation.h>
52 #include <Guid/FileInfo.h>
53 #include <Guid/GlobalVariable.h>
54 #include <Guid/Performance.h>
55 #include <Guid/StatusCodeDataTypeVariable.h>
56
57 #include <Library/PrintLib.h>
58 #include <Library/DebugLib.h>
59 #include <Library/BaseMemoryLib.h>
60 #include <Library/UefiBootServicesTableLib.h>
61 #include <Library/UefiRuntimeServicesTableLib.h>
62 #include <Library/UefiLib.h>
63 #include <Library/MemoryAllocationLib.h>
64 #include <Library/DxeServicesTableLib.h>
65 #include <Library/HobLib.h>
66 #include <Library/BaseLib.h>
67 #include <Library/DevicePathLib.h>
68 #include <Library/PerformanceLib.h>
69 #include <Library/PcdLib.h>
70 #include <Library/PeCoffGetEntryPointLib.h>
71 #include <Library/UefiBootManagerLib.h>
72 #include <Library/TimerLib.h>
73 #include <Library/DxeServicesLib.h>
74 #include <Library/ReportStatusCodeLib.h>
75 #include <Library/CapsuleLib.h>
76 #include <Library/PerformanceLib.h>
77 #include <Library/HiiLib.h>
78
79 #if !defined (EFI_REMOVABLE_MEDIA_FILE_NAME)
80 #if defined (MDE_CPU_EBC)
81 //
82 // Uefi specification only defines the default boot file name for IA32, X64
83 // and IPF processor, so need define boot file name for EBC architecture here.
84 //
85 #define EFI_REMOVABLE_MEDIA_FILE_NAME L"\\EFI\\BOOT\\BOOTEBC.EFI"
86 #else
87 #error "Can not determine the default boot file name for unknown processor type!"
88 #endif
89 #endif
90
91 typedef enum {
92 BmAcpiFloppyBoot,
93 BmHardwareDeviceBoot,
94 BmMessageAtapiBoot,
95 BmMessageSataBoot,
96 BmMessageUsbBoot,
97 BmMessageScsiBoot,
98 BmMiscBoot
99 } BM_BOOT_TYPE;
100
101 typedef
102 CHAR16 *
103 (* BM_GET_BOOT_DESCRIPTION) (
104 IN EFI_HANDLE Handle
105 );
106
107 //
108 // PlatformRecovery#### is the load option with the longest name
109 //
110 #define BM_OPTION_NAME_LEN sizeof ("PlatformRecovery####")
111 extern CHAR16 *mBmLoadOptionName[];
112
113 /**
114 Visitor function to be called by BmForEachVariable for each variable
115 in variable storage.
116
117 @param Name Variable name.
118 @param Guid Variable GUID.
119 @param Context The same context passed to BmForEachVariable.
120 **/
121 typedef
122 VOID
123 (*BM_VARIABLE_VISITOR) (
124 CHAR16 *Name,
125 EFI_GUID *Guid,
126 VOID *Context
127 );
128
129 /**
130 Call Visitor function for each variable in variable storage.
131
132 @param Visitor Visitor function.
133 @param Context The context passed to Visitor function.
134 **/
135 VOID
136 BmForEachVariable (
137 BM_VARIABLE_VISITOR Visitor,
138 VOID *Context
139 );
140
141 #define BM_BOOT_DESCRIPTION_ENTRY_SIGNATURE SIGNATURE_32 ('b', 'm', 'd', 'h')
142 typedef struct {
143 UINT32 Signature;
144 LIST_ENTRY Link;
145 EFI_BOOT_MANAGER_BOOT_DESCRIPTION_HANDLER Handler;
146 } BM_BOOT_DESCRIPTION_ENTRY;
147
148 /**
149 Repair all the controllers according to the Driver Health status queried.
150 **/
151 VOID
152 BmRepairAllControllers (
153 VOID
154 );
155
156 #define BM_HOTKEY_SIGNATURE SIGNATURE_32 ('b', 'm', 'h', 'k')
157 typedef struct {
158 UINT32 Signature;
159 LIST_ENTRY Link;
160
161 BOOLEAN IsContinue;
162 UINT16 BootOption;
163 UINT8 CodeCount;
164 UINT8 WaitingKey;
165 EFI_KEY_DATA KeyData[3];
166 } BM_HOTKEY;
167
168 #define BM_HOTKEY_FROM_LINK(a) CR (a, BM_HOTKEY, Link, BM_HOTKEY_SIGNATURE)
169
170 /**
171 Get the Option Number that wasn't used.
172
173 @param LoadOptionType Load option type.
174 @param FreeOptionNumber To receive the minimal free option number.
175
176 @retval EFI_SUCCESS The option number is found
177 @retval EFI_OUT_OF_RESOURCES There is no free option number that can be used.
178 @retval EFI_INVALID_PARAMETER FreeOptionNumber is NULL
179
180 **/
181 EFI_STATUS
182 BmGetFreeOptionNumber (
183 IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType,
184 OUT UINT16 *FreeOptionNumber
185 );
186
187 /**
188
189 Writes performance data of booting into the allocated memory.
190 OS can process these records.
191
192 @param Event The triggered event.
193 @param Context Context for this event.
194
195 **/
196 VOID
197 EFIAPI
198 BmWriteBootToOsPerformanceData (
199 IN EFI_EVENT Event,
200 IN VOID *Context
201 );
202
203 /**
204 This routine adjust the memory information for different memory type and
205 save them into the variables for next boot. It resets the system when
206 memory information is updated and the current boot option belongs to
207 boot category instead of application category. It doesn't count the
208 reserved memory occupied by RAM Disk.
209
210 @param Boot TRUE if current boot option belongs to boot
211 category instead of application category.
212 **/
213 VOID
214 BmSetMemoryTypeInformationVariable (
215 IN BOOLEAN Boot
216 );
217
218 /**
219 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
220 instances, has the same partition node with HardDriveDevicePath device path
221
222 @param BlockIoDevicePath Multi device path instances which need to check
223 @param HardDriveDevicePath A device path which starts with a hard drive media
224 device path.
225
226 @retval TRUE There is a matched device path instance.
227 @retval FALSE There is no matched device path instance.
228
229 **/
230 BOOLEAN
231 BmMatchPartitionDevicePathNode (
232 IN EFI_DEVICE_PATH_PROTOCOL *BlockIoDevicePath,
233 IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath
234 );
235
236 /**
237 Connect the specific Usb device which match the short form device path.
238
239 @param DevicePath A short-form device path that starts with the first
240 element being a USB WWID or a USB Class device
241 path
242
243 @return EFI_INVALID_PARAMETER DevicePath is NULL pointer.
244 DevicePath is not a USB device path.
245
246 @return EFI_SUCCESS Success to connect USB device
247 @return EFI_NOT_FOUND Fail to find handle for USB controller to connect.
248
249 **/
250 EFI_STATUS
251 BmConnectUsbShortFormDevicePath (
252 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath
253 );
254
255 /**
256 Stop the hotkey processing.
257
258 @param Event Event pointer related to hotkey service.
259 @param Context Context pass to this function.
260 **/
261 VOID
262 EFIAPI
263 BmStopHotkeyService (
264 IN EFI_EVENT Event,
265 IN VOID *Context
266 );
267
268 /**
269 Set the variable and report the error through status code upon failure.
270
271 @param VariableName A Null-terminated string that is the name of the vendor's variable.
272 Each VariableName is unique for each VendorGuid. VariableName must
273 contain 1 or more characters. If VariableName is an empty string,
274 then EFI_INVALID_PARAMETER is returned.
275 @param VendorGuid A unique identifier for the vendor.
276 @param Attributes Attributes bitmask to set for the variable.
277 @param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
278 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
279 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
280 set, then a SetVariable() call with a DataSize of zero will not cause any change to
281 the variable value (the timestamp associated with the variable may be updated however
282 even if no new data value is provided,see the description of the
283 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
284 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
285 @param Data The contents for the variable.
286
287 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
288 defined by the Attributes.
289 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
290 DataSize exceeds the maximum allowed.
291 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
292 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
293 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
294 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
295 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
296 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS
297 being set, but the AuthInfo does NOT pass the validation check carried out by the firmware.
298
299 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
300 **/
301 EFI_STATUS
302 BmSetVariableAndReportStatusCodeOnError (
303 IN CHAR16 *VariableName,
304 IN EFI_GUID *VendorGuid,
305 IN UINT32 Attributes,
306 IN UINTN DataSize,
307 IN VOID *Data
308 );
309
310 /**
311 Function compares a device path data structure to that of all the nodes of a
312 second device path instance.
313
314 @param Multi A pointer to a multi-instance device path data
315 structure.
316 @param Single A pointer to a single-instance device path data
317 structure.
318
319 @retval TRUE If the Single device path is contained within Multi device path.
320 @retval FALSE The Single device path is not match within Multi device path.
321
322 **/
323 BOOLEAN
324 BmMatchDevicePaths (
325 IN EFI_DEVICE_PATH_PROTOCOL *Multi,
326 IN EFI_DEVICE_PATH_PROTOCOL *Single
327 );
328
329 /**
330 Delete the instance in Multi which matches partly with Single instance
331
332 @param Multi A pointer to a multi-instance device path data
333 structure.
334 @param Single A pointer to a single-instance device path data
335 structure.
336
337 @return This function will remove the device path instances in Multi which partly
338 match with the Single, and return the result device path. If there is no
339 remaining device path as a result, this function will return NULL.
340
341 **/
342 EFI_DEVICE_PATH_PROTOCOL *
343 BmDelPartMatchInstance (
344 IN EFI_DEVICE_PATH_PROTOCOL *Multi,
345 IN EFI_DEVICE_PATH_PROTOCOL *Single
346 );
347
348 /**
349 Repair all the controllers according to the Driver Health status queried.
350 **/
351 VOID
352 BmRepairAllControllers (
353 VOID
354 );
355
356 /**
357 Print the device path info.
358
359 @param DevicePath The device path need to print.
360 **/
361 VOID
362 BmPrintDp (
363 EFI_DEVICE_PATH_PROTOCOL *DevicePath
364 );
365
366 /**
367 Convert a single character to number.
368 It assumes the input Char is in the scope of L'0' ~ L'9' and L'A' ~ L'F'
369
370 @param Char The input char which need to convert to int.
371
372 @return The converted 8-bit number or (UINTN) -1 if conversion failed.
373 **/
374 UINTN
375 BmCharToUint (
376 IN CHAR16 Char
377 );
378
379 /**
380 Return the boot description for the controller.
381
382 @param Handle Controller handle.
383
384 @return The description string.
385 **/
386 CHAR16 *
387 BmGetBootDescription (
388 IN EFI_HANDLE Handle
389 );
390
391 /**
392 Enumerate all boot option descriptions and append " 2"/" 3"/... to make
393 unique description.
394
395 @param BootOptions Array of boot options.
396 @param BootOptionCount Count of boot options.
397 **/
398 VOID
399 BmMakeBootOptionDescriptionUnique (
400 EFI_BOOT_MANAGER_LOAD_OPTION *BootOptions,
401 UINTN BootOptionCount
402 );
403
404 /**
405 Get the file buffer from the specified Load File instance.
406
407 @param LoadFileHandle The specified Load File instance.
408 @param FilePath The file path which will pass to LoadFile().
409
410 @return The full device path pointing to the load option buffer.
411 **/
412 EFI_DEVICE_PATH_PROTOCOL *
413 BmExpandLoadFile (
414 IN EFI_HANDLE LoadFileHandle,
415 IN EFI_DEVICE_PATH_PROTOCOL *FilePath
416 );
417
418 /**
419 Return the RAM Disk device path created by LoadFile.
420
421 @param FilePath The source file path.
422
423 @return Callee-to-free RAM Disk device path
424 **/
425 EFI_DEVICE_PATH_PROTOCOL *
426 BmGetRamDiskDevicePath (
427 IN EFI_DEVICE_PATH_PROTOCOL *FilePath
428 );
429
430 /**
431 Destroy the RAM Disk.
432
433 The destroy operation includes to call RamDisk.Unregister to
434 unregister the RAM DISK from RAM DISK driver, free the memory
435 allocated for the RAM Disk.
436
437 @param RamDiskDevicePath RAM Disk device path.
438 **/
439 VOID
440 BmDestroyRamDisk (
441 IN EFI_DEVICE_PATH_PROTOCOL *RamDiskDevicePath
442 );
443
444 /**
445 Get the next possible full path pointing to the load option.
446
447 @param FilePath The device path pointing to a load option.
448 It could be a short-form device path.
449 @param FullPath The full path returned by the routine in last call.
450 Set to NULL in first call.
451
452 @return The next possible full path pointing to the load option.
453 Caller is responsible to free the memory.
454 **/
455 EFI_DEVICE_PATH_PROTOCOL *
456 BmGetNextLoadOptionDevicePath (
457 IN EFI_DEVICE_PATH_PROTOCOL *FilePath,
458 IN EFI_DEVICE_PATH_PROTOCOL *FullPath
459 );
460
461 /**
462 Return the next matched load option buffer.
463 The routine keeps calling BmGetNextLoadOptionDevicePath() until a valid
464 load option is read.
465
466 @param Type The load option type.
467 It's used to check whether the load option is valid.
468 When it's LoadOptionTypeMax, the routine only guarantees
469 the load option is a valid PE image but doesn't guarantee
470 the PE's subsystem type is valid.
471 @param FilePath The device path pointing to a load option.
472 It could be a short-form device path.
473 @param FullPath Return the next full device path of the load option after
474 short-form device path expanding.
475 Caller is responsible to free it.
476 NULL to return the first matched full device path.
477 @param FileSize Return the load option size.
478
479 @return The load option buffer. Caller is responsible to free the memory.
480 **/
481 VOID *
482 BmGetNextLoadOptionBuffer (
483 IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE Type,
484 IN EFI_DEVICE_PATH_PROTOCOL *FilePath,
485 OUT EFI_DEVICE_PATH_PROTOCOL **FullPath,
486 OUT UINTN *FileSize
487 );
488 #endif // _INTERNAL_BM_H_