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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/** @file
GBL EFI Boot Control Protocol.
Delegates boot target manipulation logic to firmware.
Related docs:
https://android.googlesource.com/platform/bootable/libbootloader/+/refs/heads/gbl-mainline/gbl/docs/gbl_efi_boot_control_protocol.md
Copyright (c) 2025, The Android Open Source Project.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#pragma once
#include <Uefi/UefiBaseType.h>
//
// {d382db1b-9ac2-11f0-84c7-047bcba96019}
//
#define GBL_EFI_BOOT_CONTROL_PROTOCOL_GUID \
{ 0xd382db1b, 0x9ac2, 0x11f0, { 0x84, 0xc7, 0x04, 0x7b, 0xcb, 0xa9, 0x60, 0x19 } }
#define GBL_EFI_BOOT_CONTROL_PROTOCOL_REVISION 0x00010000
typedef struct _GBL_EFI_BOOT_CONTROL_PROTOCOL GBL_EFI_BOOT_CONTROL_PROTOCOL;
typedef enum {
GblEfiUnbootableReasonUnknownReason,
GblEfiUnbootableReasonNoMoreTries,
GblEfiUnbootableReasonSystemUpdate,
GblEfiUnbootableReasonUserRequested,
GblEfiUnbootableReasonVerificationFailure
} GBL_EFI_UNBOOTABLE_REASON;
typedef enum {
GblEfiOneShotBootModeNone,
GblEfiOneShotBootModeBootloader,
GblEfiOneShotBootModeRecovery
} GBL_EFI_ONE_SHOT_BOOT_MODE;
typedef struct {
UINT32 Suffix; // One UTF-8 encoded single character.
UINT8 UnbootableReason; // GBL_EFI_UNBOOTABLE_REASON
UINT8 Priority;
UINT8 RemainingTries;
UINT8 Successful;
} GBL_EFI_SLOT_INFO;
typedef struct {
UINTN KernelSize;
EFI_PHYSICAL_ADDRESS Kernel;
UINTN RamdiskSize;
EFI_PHYSICAL_ADDRESS Ramdisk;
UINTN DeviceTreeSize;
EFI_PHYSICAL_ADDRESS DeviceTree;
UINT64 Reserved[8];
} GBL_EFI_LOADED_OS;
typedef
EFI_STATUS
(EFIAPI *GBL_EFI_BOOT_CONTROL_GET_SLOT_COUNT)(
IN GBL_EFI_BOOT_CONTROL_PROTOCOL *This,
OUT UINT8 *SlotCount
);
typedef
EFI_STATUS
(EFIAPI *GBL_EFI_BOOT_CONTROL_GET_SLOT_INFO)(
IN GBL_EFI_BOOT_CONTROL_PROTOCOL *This,
IN UINT8 Index,
OUT GBL_EFI_SLOT_INFO *Info
);
typedef
EFI_STATUS
(EFIAPI *GBL_EFI_BOOT_CONTROL_GET_CURRENT_SLOT)(
IN GBL_EFI_BOOT_CONTROL_PROTOCOL *This,
OUT GBL_EFI_SLOT_INFO *Info
);
typedef
EFI_STATUS
(EFIAPI *GBL_EFI_BOOT_CONTROL_SET_ACTIVE_SLOT)(
IN GBL_EFI_BOOT_CONTROL_PROTOCOL *This,
IN UINT8 Index
);
typedef
EFI_STATUS
(EFIAPI *GBL_EFI_BOOT_CONTROL_GET_ONE_SHOT_BOOT_MODE)(
IN GBL_EFI_BOOT_CONTROL_PROTOCOL *This,
OUT UINT32 *Mode // GBL_EFI_ONE_SHOT_BOOT_MODE
);
typedef
EFI_STATUS
(EFIAPI *GBL_EFI_BOOT_CONTROL_HANDLE_LOADED_OS)(
IN GBL_EFI_BOOT_CONTROL_PROTOCOL *This,
IN CONST GBL_EFI_LOADED_OS *Os
);
struct _GBL_EFI_BOOT_CONTROL_PROTOCOL {
UINT64 Revision;
GBL_EFI_BOOT_CONTROL_GET_SLOT_COUNT GetSlotCount;
GBL_EFI_BOOT_CONTROL_GET_SLOT_INFO GetSlotInfo;
GBL_EFI_BOOT_CONTROL_GET_CURRENT_SLOT GetCurrentSlot;
GBL_EFI_BOOT_CONTROL_SET_ACTIVE_SLOT SetActiveSlot;
GBL_EFI_BOOT_CONTROL_GET_ONE_SHOT_BOOT_MODE GetOneShotBootMode;
GBL_EFI_BOOT_CONTROL_HANDLE_LOADED_OS HandleLoadedOs;
};
extern EFI_GUID gGblEfiBootControlProtocolGuid;
|
