MdeModulePkg/Library/UefiBootManagerLib/InternalBm.h

   1 /** @file
   2   BDS library definition, include the file and data structure
   3
   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
  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
  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>
  46 #include <Protocol/RamDisk.h>
  47
  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>
  53
  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>
  75
  76 #if !defined (EFI_REMOVABLE_MEDIA_FILE_NAME)
  77     #if defined (MDE_CPU_EBC)
  78         //
  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.
  81         //
  82         #define EFI_REMOVABLE_MEDIA_FILE_NAME L"\\EFI\\BOOT\\BOOTEBC.EFI"
  83     #else
  84         #error "Can not determine the default boot file name for unknown processor type!"
  85     #endif
  86 #endif
  87
  88 typedef enum {
  89   BmAcpiFloppyBoot,
  90   BmHardwareDeviceBoot,
  91   BmMessageAtapiBoot,
  92   BmMessageSataBoot,
  93   BmMessageUsbBoot,
  94   BmMessageScsiBoot,
  95   BmMiscBoot
  96 } BM_BOOT_TYPE;
  97
  98 typedef
  99 CHAR16 *
 100 (* BM_GET_BOOT_DESCRIPTION) (
 101   IN EFI_HANDLE          Handle
 102   );
 103
 104 //
 105 // PlatformRecovery#### is the load option with the longest name
 106 //
 107 #define BM_OPTION_NAME_LEN                          sizeof ("PlatformRecovery####")
 108 extern CHAR16  *mBmLoadOptionName[];
 109
 110 /**
 111   Visitor function to be called by BmForEachVariable for each variable
 112   in variable storage.
 113
 114   @param Name    Variable name.
 115   @param Guid    Variable GUID.
 116   @param Context The same context passed to BmForEachVariable.
 117 **/
 118 typedef
 119 VOID
 120 (*BM_VARIABLE_VISITOR) (
 121   CHAR16                *Name,
 122   EFI_GUID              *Guid,
 123   VOID                  *Context
 124   );
 125
 126 /**
 127   Call Visitor function for each variable in variable storage.
 128
 129   @param Visitor   Visitor function.
 130   @param Context   The context passed to Visitor function.
 131 **/
 132 VOID
 133 BmForEachVariable (
 134   BM_VARIABLE_VISITOR         Visitor,
 135   VOID                        *Context
 136   );
 137
 138 #define BM_BOOT_DESCRIPTION_ENTRY_SIGNATURE SIGNATURE_32 ('b', 'm', 'd', 'h')
 139 typedef struct {
 140   UINT32                                    Signature;
 141   LIST_ENTRY                                Link;
 142   EFI_BOOT_MANAGER_BOOT_DESCRIPTION_HANDLER Handler;
 143 } BM_BOOT_DESCRIPTION_ENTRY;
 144
 145 /**
 146   Repair all the controllers according to the Driver Health status queried.
 147 **/
 148 VOID
 149 BmRepairAllControllers (
 150   VOID
 151   );
 152
 153 #define BM_HOTKEY_SIGNATURE SIGNATURE_32 ('b', 'm', 'h', 'k')
 154 typedef struct {
 155   UINT32                    Signature;
 156   LIST_ENTRY                Link;
 157
 158   BOOLEAN                   IsContinue;
 159   UINT16                    BootOption;
 160   UINT8                     CodeCount;
 161   UINT8                     WaitingKey;
 162   EFI_KEY_DATA              KeyData[3];
 163 } BM_HOTKEY;
 164
 165 #define BM_HOTKEY_FROM_LINK(a) CR (a, BM_HOTKEY, Link, BM_HOTKEY_SIGNATURE)
 166
 167 /**
 168   Get the Option Number that wasn't used.
 169
 170   @param  LoadOptionType      Load option type.
 171   @param  FreeOptionNumber    To receive the minimal free option number.
 172
 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
 176
 177 **/
 178 EFI_STATUS
 179 BmGetFreeOptionNumber (
 180   IN  EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType,
 181   OUT UINT16                            *FreeOptionNumber
 182   );
 183
 184 /**
 185
 186   Writes performance data of booting into the allocated memory.
 187   OS can process these records.
 188
 189   @param  Event                 The triggered event.
 190   @param  Context               Context for this event.
 191
 192 **/
 193 VOID
 194 EFIAPI
 195 BmWriteBootToOsPerformanceData (
 196   IN EFI_EVENT  Event,
 197   IN VOID       *Context
 198   );
 199
 200 /**
 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. It doesn't count the
 205   reserved memory occupied by RAM Disk.
 206
 207   @param Boot               TRUE if current boot option belongs to boot
 208                             category instead of application category.
 209 **/
 210 VOID
 211 BmSetMemoryTypeInformationVariable (
 212   IN BOOLEAN                    Boot
 213   );
 214
 215 /**
 216   Check whether there is a instance in BlockIoDevicePath, which contain multi device path
 217   instances, has the same partition node with HardDriveDevicePath device path
 218
 219   @param  BlockIoDevicePath      Multi device path instances which need to check
 220   @param  HardDriveDevicePath    A device path which starts with a hard drive media
 221                                  device path.
 222
 223   @retval TRUE                   There is a matched device path instance.
 224   @retval FALSE                  There is no matched device path instance.
 225
 226 **/
 227 BOOLEAN
 228 BmMatchPartitionDevicePathNode (
 229   IN  EFI_DEVICE_PATH_PROTOCOL   *BlockIoDevicePath,
 230   IN  HARDDRIVE_DEVICE_PATH      *HardDriveDevicePath
 231   );
 232
 233 /**
 234   Connect the specific Usb device which match the short form device path.
 235
 236   @param  DevicePath             A short-form device path that starts with the first
 237                                  element being a USB WWID or a USB Class device
 238                                  path
 239
 240   @return EFI_INVALID_PARAMETER  DevicePath is NULL pointer.
 241                                  DevicePath is not a USB device path.
 242
 243   @return EFI_SUCCESS            Success to connect USB device
 244   @return EFI_NOT_FOUND          Fail to find handle for USB controller to connect.
 245
 246 **/
 247 EFI_STATUS
 248 BmConnectUsbShortFormDevicePath (
 249   IN EFI_DEVICE_PATH_PROTOCOL   *DevicePath
 250   );
 251
 252 /**
 253   Stop the hotkey processing.
 254
 255   @param    Event          Event pointer related to hotkey service.
 256   @param    Context        Context pass to this function.
 257 **/
 258 VOID
 259 EFIAPI
 260 BmStopHotkeyService (
 261   IN EFI_EVENT    Event,
 262   IN VOID         *Context
 263   );
 264
 265 /**
 266   Set the variable and report the error through status code upon failure.
 267
 268   @param  VariableName           A Null-terminated string that is the name of the vendor's variable.
 269                                  Each VariableName is unique for each VendorGuid. VariableName must
 270                                  contain 1 or more characters. If VariableName is an empty string,
 271                                  then EFI_INVALID_PARAMETER is returned.
 272   @param  VendorGuid             A unique identifier for the vendor.
 273   @param  Attributes             Attributes bitmask to set for the variable.
 274   @param  DataSize               The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
 275                                  EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or
 276                                  EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
 277                                  causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
 278                                  set, then a SetVariable() call with a DataSize of zero will not cause any change to
 279                                  the variable value (the timestamp associated with the variable may be updated however
 280                                  even if no new data value is provided,see the description of the
 281                                  EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
 282                                  be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
 283   @param  Data                   The contents for the variable.
 284
 285   @retval EFI_SUCCESS            The firmware has successfully stored the variable and its data as
 286                                  defined by the Attributes.
 287   @retval EFI_INVALID_PARAMETER  An invalid combination of attribute bits, name, and GUID was supplied, or the
 288                                  DataSize exceeds the maximum allowed.
 289   @retval EFI_INVALID_PARAMETER  VariableName is an empty string.
 290   @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the variable and its data.
 291   @retval EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.
 292   @retval EFI_WRITE_PROTECTED    The variable in question is read-only.
 293   @retval EFI_WRITE_PROTECTED    The variable in question cannot be deleted.
 294   @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
 295                                  or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo
 296                                  does NOT pass the validation check carried out by the firmware.
 297
 298   @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.
 299 **/
 300 EFI_STATUS
 301 BmSetVariableAndReportStatusCodeOnError (
 302   IN CHAR16     *VariableName,
 303   IN EFI_GUID   *VendorGuid,
 304   IN UINT32     Attributes,
 305   IN UINTN      DataSize,
 306   IN VOID       *Data
 307   );
 308
 309 /**
 310   Return whether the PE header of the load option is valid or not.
 311
 312   @param[in] Type       The load option type.
 313   @param[in] FileBuffer The PE file buffer of the load option.
 314   @param[in] FileSize   The size of the load option file.
 315
 316   @retval TRUE  The PE header of the load option is valid.
 317   @retval FALSE The PE header of the load option is not valid.
 318 **/
 319 BOOLEAN
 320 BmIsLoadOptionPeHeaderValid (
 321   IN EFI_BOOT_MANAGER_LOAD_OPTION_TYPE Type,
 322   IN VOID                              *FileBuffer,
 323   IN UINTN                             FileSize
 324   );
 325
 326 /**
 327   Function compares a device path data structure to that of all the nodes of a
 328   second device path instance.
 329
 330   @param  Multi                 A pointer to a multi-instance device path data
 331                                 structure.
 332   @param  Single                A pointer to a single-instance device path data
 333                                 structure.
 334
 335   @retval TRUE                  If the Single device path is contained within Multi device path.
 336   @retval FALSE                 The Single device path is not match within Multi device path.
 337
 338 **/
 339 BOOLEAN
 340 BmMatchDevicePaths (
 341   IN  EFI_DEVICE_PATH_PROTOCOL  *Multi,
 342   IN  EFI_DEVICE_PATH_PROTOCOL  *Single
 343   );
 344
 345 /**
 346   Delete the instance in Multi which matches partly with Single instance
 347
 348   @param  Multi                 A pointer to a multi-instance device path data
 349                                 structure.
 350   @param  Single                A pointer to a single-instance device path data
 351                                 structure.
 352
 353   @return This function will remove the device path instances in Multi which partly
 354           match with the Single, and return the result device path. If there is no
 355           remaining device path as a result, this function will return NULL.
 356
 357 **/
 358 EFI_DEVICE_PATH_PROTOCOL *
 359 BmDelPartMatchInstance (
 360   IN     EFI_DEVICE_PATH_PROTOCOL  *Multi,
 361   IN     EFI_DEVICE_PATH_PROTOCOL  *Single
 362   );
 363
 364 /**
 365   Repair all the controllers according to the Driver Health status queried.
 366 **/
 367 VOID
 368 BmRepairAllControllers (
 369   VOID
 370   );
 371
 372 /**
 373   Print the device path info.
 374
 375   @param DevicePath           The device path need to print.
 376 **/
 377 VOID
 378 BmPrintDp (
 379   EFI_DEVICE_PATH_PROTOCOL            *DevicePath
 380   );
 381
 382 /**
 383   Convert a single character to number.
 384   It assumes the input Char is in the scope of L'0' ~ L'9' and L'A' ~ L'F'
 385
 386   @param    Char   The input char which need to convert to int.
 387
 388   @return  The converted 8-bit number or (UINTN) -1 if conversion failed.
 389 **/
 390 UINTN
 391 BmCharToUint (
 392   IN CHAR16                           Char
 393   );
 394
 395 /**
 396   Return the boot description for the controller.
 397
 398   @param Handle                Controller handle.
 399
 400   @return  The description string.
 401 **/
 402 CHAR16 *
 403 BmGetBootDescription (
 404   IN EFI_HANDLE                  Handle
 405   );
 406
 407 /**
 408   Enumerate all boot option descriptions and append " 2"/" 3"/... to make
 409   unique description.
 410
 411   @param BootOptions            Array of boot options.
 412   @param BootOptionCount        Count of boot options.
 413 **/
 414 VOID
 415 BmMakeBootOptionDescriptionUnique (
 416   EFI_BOOT_MANAGER_LOAD_OPTION         *BootOptions,
 417   UINTN                                BootOptionCount
 418   );
 419
 420 /**
 421   Get the file buffer from the specified Load File instance.
 422
 423   @param LoadFileHandle The specified Load File instance.
 424   @param FilePath       The file path which will pass to LoadFile().
 425   @param FullPath       Return the full device path pointing to the load option.
 426   @param FileSize       Return the size of the load option.
 427
 428   @return  The load option buffer or NULL if fails.
 429 **/
 430 VOID *
 431 BmGetFileBufferFromLoadFile (
 432   EFI_HANDLE                          LoadFileHandle,
 433   IN  EFI_DEVICE_PATH_PROTOCOL        *FilePath,
 434   OUT EFI_DEVICE_PATH_PROTOCOL        **FullPath,
 435   OUT UINTN                           *FileSize
 436   );
 437 #endif // _INTERNAL_BM_H_