MdeModulePkg/Library/UefiBootManagerLib/InternalBm.h

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