[mirror_edk2.git] / MdeModulePkg / Library / UefiBootManagerLib / InternalBm.h

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