UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h

   1 /** @file
   2   Provides a library function that can be customized to set the platform to boot
   3   from USB on the next boot.  This allows the test framework to reboot back to
   4   USB.  Since boot managers are not all the same creating a lib to support
   5   platform customization will make porting to new code base/platform easier.
   6
   7   Copyright (c) Microsoft Corporation.<BR>
   8   Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
   9   SPDX-License-Identifier: BSD-2-Clause-Patent
  10
  11 **/
  12
  13 #ifndef __UNIT_TEST_BOOT_LIB_H__
  14 #define __UNIT_TEST_BOOT_LIB_H__
  15
  16 /**
  17   Set the boot manager to boot from a specific device on the next boot. This
  18   should be set only for the next boot and shouldn't require any manual clean up
  19
  20   @retval EFI_SUCCESS      Boot device for next boot was set.
  21   @retval EFI_UNSUPPORTED  Setting the boot device for the next boot is not
  22                            supportted.
  23   @retval Other            Boot device for next boot can not be set.
  24 **/
  25 EFI_STATUS
  26 EFIAPI
  27 SetBootNextDevice (
  28   VOID
  29   );
  30
  31 #endif