2 BDS library definition, include the file and data structure
4 Copyright (c) 2004 - 2016, 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
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.
16 #ifndef _INTERNAL_BM_H_
17 #define _INTERNAL_BM_H_
21 #include <IndustryStandard/Pci.h>
22 #include <IndustryStandard/PeImage.h>
23 #include <IndustryStandard/Atapi.h>
24 #include <IndustryStandard/Scsi.h>
26 #include <Protocol/PciRootBridgeIo.h>
27 #include <Protocol/BlockIo.h>
28 #include <Protocol/LoadedImage.h>
29 #include <Protocol/SimpleFileSystem.h>
30 #include <Protocol/LoadFile.h>
31 #include <Protocol/DevicePath.h>
32 #include <Protocol/SimpleTextIn.h>
33 #include <Protocol/SimpleTextInEx.h>
34 #include <Protocol/SimpleTextOut.h>
35 #include <Protocol/SimpleNetwork.h>
36 #include <Protocol/FirmwareVolume2.h>
37 #include <Protocol/PciIo.h>
38 #include <Protocol/GraphicsOutput.h>
39 #include <Protocol/UsbIo.h>
40 #include <Protocol/DiskInfo.h>
41 #include <Protocol/IdeControllerInit.h>
42 #include <Protocol/BootLogo.h>
43 #include <Protocol/DriverHealth.h>
44 #include <Protocol/FormBrowser2.h>
45 #include <Protocol/VariableLock.h>
47 #include <Guid/ZeroGuid.h>
48 #include <Guid/MemoryTypeInformation.h>
49 #include <Guid/FileInfo.h>
50 #include <Guid/GlobalVariable.h>
51 #include <Guid/Performance.h>
52 #include <Guid/StatusCodeDataTypeVariable.h>
54 #include <Library/PrintLib.h>
55 #include <Library/DebugLib.h>
56 #include <Library/BaseMemoryLib.h>
57 #include <Library/UefiBootServicesTableLib.h>
58 #include <Library/UefiRuntimeServicesTableLib.h>
59 #include <Library/UefiLib.h>
60 #include <Library/MemoryAllocationLib.h>
61 #include <Library/DxeServicesTableLib.h>
62 #include <Library/HobLib.h>
63 #include <Library/BaseLib.h>
64 #include <Library/DevicePathLib.h>
65 #include <Library/PerformanceLib.h>
66 #include <Library/PcdLib.h>
67 #include <Library/PeCoffGetEntryPointLib.h>
68 #include <Library/UefiBootManagerLib.h>
69 #include <Library/TimerLib.h>
70 #include <Library/DxeServicesLib.h>
71 #include <Library/ReportStatusCodeLib.h>
72 #include <Library/CapsuleLib.h>
73 #include <Library/PerformanceLib.h>
74 #include <Library/HiiLib.h>
76 #if !defined (EFI_REMOVABLE_MEDIA_FILE_NAME)
77 #if defined (MDE_CPU_EBC)
79 // Uefi specification only defines the default boot file name for IA32, X64
80 // and IPF processor, so need define boot file name for EBC architecture here.
82 #define EFI_REMOVABLE_MEDIA_FILE_NAME L"\\EFI\\BOOT\\BOOTEBC.EFI"
84 #error "Can not determine the default boot file name for unknown processor type!"
100 (* BM_GET_BOOT_DESCRIPTION
) (
105 // PlatformRecovery#### is the load option with the longest name
107 #define BM_OPTION_NAME_LEN sizeof ("PlatformRecovery####")
108 extern CHAR16
*mBmLoadOptionName
[];
111 Visitor function to be called by BmForEachVariable for each variable
114 @param Name Variable name.
115 @param Guid Variable GUID.
116 @param Context The same context passed to BmForEachVariable.
120 (*BM_VARIABLE_VISITOR
) (
127 Call Visitor function for each variable in variable storage.
129 @param Visitor Visitor function.
130 @param Context The context passed to Visitor function.
134 BM_VARIABLE_VISITOR Visitor
,
138 #define BM_BOOT_DESCRIPTION_ENTRY_SIGNATURE SIGNATURE_32 ('b', 'm', 'd', 'h')
142 EFI_BOOT_MANAGER_BOOT_DESCRIPTION_HANDLER Handler
;
143 } BM_BOOT_DESCRIPTION_ENTRY
;
146 Repair all the controllers according to the Driver Health status queried.
149 BmRepairAllControllers (
153 #define BM_HOTKEY_SIGNATURE SIGNATURE_32 ('b', 'm', 'h', 'k')
162 EFI_KEY_DATA KeyData
[3];
165 #define BM_HOTKEY_FROM_LINK(a) CR (a, BM_HOTKEY, Link, BM_HOTKEY_SIGNATURE)
168 Get the Option Number that wasn't used.
170 @param LoadOptionType Load option type.
171 @param FreeOptionNumber To receive the minimal free option number.
173 @retval EFI_SUCCESS The option number is found
174 @retval EFI_OUT_OF_RESOURCES There is no free option number that can be used.
175 @retval EFI_INVALID_PARAMETER FreeOptionNumber is NULL
179 BmGetFreeOptionNumber (
180 IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType
,
181 OUT UINT16
*FreeOptionNumber
186 Writes performance data of booting into the allocated memory.
187 OS can process these records.
189 @param Event The triggered event.
190 @param Context Context for this event.
195 BmWriteBootToOsPerformanceData (
201 This routine adjust the memory information for different memory type and
202 save them into the variables for next boot. It resets the system when
203 memory information is updated and the current boot option belongs to
204 boot category instead of application category.
206 @param Boot TRUE if current boot option belongs to boot category instead of
207 application category.
210 BmSetMemoryTypeInformationVariable (
215 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
216 instances, has the same partition node with HardDriveDevicePath device path
218 @param BlockIoDevicePath Multi device path instances which need to check
219 @param HardDriveDevicePath A device path which starts with a hard drive media
222 @retval TRUE There is a matched device path instance.
223 @retval FALSE There is no matched device path instance.
227 BmMatchPartitionDevicePathNode (
228 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
229 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
233 Connect the specific Usb device which match the short form device path.
235 @param DevicePath A short-form device path that starts with the first
236 element being a USB WWID or a USB Class device
239 @return EFI_INVALID_PARAMETER DevicePath is NULL pointer.
240 DevicePath is not a USB device path.
242 @return EFI_SUCCESS Success to connect USB device
243 @return EFI_NOT_FOUND Fail to find handle for USB controller to connect.
247 BmConnectUsbShortFormDevicePath (
248 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
252 Stop the hotkey processing.
254 @param Event Event pointer related to hotkey service.
255 @param Context Context pass to this function.
259 BmStopHotkeyService (
265 Set the variable and report the error through status code upon failure.
267 @param VariableName A Null-terminated string that is the name of the vendor's variable.
268 Each VariableName is unique for each VendorGuid. VariableName must
269 contain 1 or more characters. If VariableName is an empty string,
270 then EFI_INVALID_PARAMETER is returned.
271 @param VendorGuid A unique identifier for the vendor.
272 @param Attributes Attributes bitmask to set for the variable.
273 @param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
274 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or
275 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
276 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
277 set, then a SetVariable() call with a DataSize of zero will not cause any change to
278 the variable value (the timestamp associated with the variable may be updated however
279 even if no new data value is provided,see the description of the
280 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
281 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
282 @param Data The contents for the variable.
284 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
285 defined by the Attributes.
286 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
287 DataSize exceeds the maximum allowed.
288 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
289 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
290 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
291 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
292 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
293 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
294 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo
295 does NOT pass the validation check carried out by the firmware.
297 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
300 BmSetVariableAndReportStatusCodeOnError (
301 IN CHAR16
*VariableName
,
302 IN EFI_GUID
*VendorGuid
,
303 IN UINT32 Attributes
,
309 Get the load option by its device path.
311 @param FilePath The device path pointing to a load option.
312 It could be a short-form device path.
313 @param FullPath Return the full device path of the load option after
314 short-form device path expanding.
315 Caller is responsible to free it.
316 @param FileSize Return the load option size.
318 @return The load option buffer. Caller is responsible to free the memory.
321 BmGetLoadOptionBuffer (
322 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
323 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
328 Return whether the PE header of the load option is valid or not.
330 @param[in] Type The load option type.
331 @param[in] FileBuffer The PE file buffer of the load option.
332 @param[in] FileSize The size of the load option file.
334 @retval TRUE The PE header of the load option is valid.
335 @retval FALSE The PE header of the load option is not valid.
338 BmIsLoadOptionPeHeaderValid (
339 IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE Type
,
345 Function compares a device path data structure to that of all the nodes of a
346 second device path instance.
348 @param Multi A pointer to a multi-instance device path data
350 @param Single A pointer to a single-instance device path data
353 @retval TRUE If the Single device path is contained within Multi device path.
354 @retval FALSE The Single device path is not match within Multi device path.
359 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
360 IN EFI_DEVICE_PATH_PROTOCOL
*Single
364 Delete the instance in Multi which matches partly with Single instance
366 @param Multi A pointer to a multi-instance device path data
368 @param Single A pointer to a single-instance device path data
371 @return This function will remove the device path instances in Multi which partly
372 match with the Single, and return the result device path. If there is no
373 remaining device path as a result, this function will return NULL.
376 EFI_DEVICE_PATH_PROTOCOL
*
377 BmDelPartMatchInstance (
378 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
379 IN EFI_DEVICE_PATH_PROTOCOL
*Single
383 Repair all the controllers according to the Driver Health status queried.
386 BmRepairAllControllers (
391 Print the device path info.
393 @param DevicePath The device path need to print.
397 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
401 Convert a single character to number.
402 It assumes the input Char is in the scope of L'0' ~ L'9' and L'A' ~ L'F'
404 @param Char The input char which need to convert to int.
406 @return The converted 8-bit number or (UINTN) -1 if conversion failed.
415 Get the file buffer from the file system produced by Load File instance.
417 @param LoadFileHandle The handle of LoadFile instance.
418 @param FullPath Return the full device path pointing to the load option.
419 @param FileSize Return the size of the load option.
421 @return The load option buffer.
424 BmGetFileBufferFromLoadFileFileSystem (
425 IN EFI_HANDLE LoadFileHandle
,
426 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
431 Return the boot description for the controller.
433 @param Handle Controller handle.
435 @return The description string.
438 BmGetBootDescription (
443 Enumerate all boot option descriptions and append " 2"/" 3"/... to make
446 @param BootOptions Array of boot options.
447 @param BootOptionCount Count of boot options.
450 BmMakeBootOptionDescriptionUnique (
451 EFI_BOOT_MANAGER_LOAD_OPTION
*BootOptions
,
452 UINTN BootOptionCount
454 #endif // _INTERNAL_BM_H_