summaryrefslogtreecommitdiffstats
path: root/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h
blob: d90bff0e4c1b89f0592aa88ea5a6175ca1fb36f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/** @file
  Provides a library function that can be customized to set the platform to boot
  from USB on the next boot.  This allows the test framework to reboot back to
  USB.  Since boot managers are not all the same creating a lib to support
  platform customization will make porting to new code base/platform easier.

  Copyright (c) Microsoft Corporation.<BR>
  Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
  SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#ifndef __UNIT_TEST_BOOT_LIB_H__
#define __UNIT_TEST_BOOT_LIB_H__

/**
  Set the boot manager to boot from a specific device on the next boot. This
  should be set only for the next boot and shouldn't require any manual clean up

  @retval EFI_SUCCESS      Boot device for next boot was set.
  @retval EFI_UNSUPPORTED  Setting the boot device for the next boot is not
                           supportted.
  @retval Other            Boot device for next boot can not be set.
**/
EFI_STATUS
EFIAPI
SetBootNextDevice (
  VOID
  );

#endif