]>
Commit | Line | Data |
---|---|---|
143f0b1d ED |
1 | /** @file\r |
2 | The platform boot manager reference implement\r | |
3 | \r | |
afc244a5 | 4 | Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>\r |
143f0b1d ED |
5 | This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _EFI_BOOT_MANAGER_H_\r | |
16 | #define _EFI_BOOT_MANAGER_H_\r | |
17 | \r | |
18 | #include "Ui.h"\r | |
19 | #include "FrontPage.h"\r | |
20 | \r | |
21 | //\r | |
22 | // These are defined as the same with vfr file\r | |
23 | //\r | |
24 | #define BOOT_MANAGER_FORMSET_GUID \\r | |
25 | { \\r | |
26 | 0x847bc3fe, 0xb974, 0x446d, {0x94, 0x49, 0x5a, 0xd5, 0x41, 0x2e, 0x99, 0x3b} \\r | |
27 | }\r | |
28 | \r | |
29 | #define BOOT_MANAGER_FORM_ID 0x1000\r | |
30 | \r | |
31 | #define LABEL_BOOT_OPTION 0x00\r | |
32 | #define LABEL_BOOT_OPTION_END 0x01\r | |
33 | \r | |
34 | //\r | |
35 | // These are the VFR compiler generated data representing our VFR data.\r | |
36 | //\r | |
37 | extern UINT8 BootManagerVfrBin[];\r | |
38 | \r | |
39 | #define BOOT_MANAGER_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('B', 'M', 'C', 'B')\r | |
40 | \r | |
41 | typedef struct {\r | |
42 | UINTN Signature;\r | |
43 | \r | |
44 | //\r | |
45 | // HII relative handles\r | |
46 | //\r | |
47 | EFI_HII_HANDLE HiiHandle;\r | |
48 | EFI_HANDLE DriverHandle;\r | |
49 | \r | |
50 | //\r | |
51 | // Produced protocols\r | |
52 | //\r | |
53 | EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess;\r | |
54 | } BOOT_MANAGER_CALLBACK_DATA;\r | |
55 | \r | |
56 | /**\r | |
57 | This call back function is registered with Boot Manager formset.\r | |
58 | When user selects a boot option, this call back function will\r | |
59 | be triggered. The boot option is saved for later processing.\r | |
60 | \r | |
61 | \r | |
62 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
63 | @param Action Specifies the type of action taken by the browser.\r | |
64 | @param QuestionId A unique value which is sent to the original exporting driver\r | |
65 | so that it can identify the type of data to expect.\r | |
66 | @param Type The type of value for the question.\r | |
67 | @param Value A pointer to the data being sent to the original exporting driver.\r | |
68 | @param ActionRequest On return, points to the action requested by the callback function.\r | |
69 | \r | |
70 | @retval EFI_SUCCESS The callback successfully handled the action.\r | |
71 | @retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.\r | |
72 | \r | |
73 | **/\r | |
74 | EFI_STATUS\r | |
75 | EFIAPI\r | |
76 | BootManagerCallback (\r | |
77 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
78 | IN EFI_BROWSER_ACTION Action,\r | |
79 | IN EFI_QUESTION_ID QuestionId,\r | |
80 | IN UINT8 Type,\r | |
81 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
82 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
83 | );\r | |
84 | \r | |
85 | /**\r | |
86 | Register HII packages to HII database.\r | |
87 | \r | |
88 | **/\r | |
89 | VOID\r | |
90 | InitializeBootManager (\r | |
91 | VOID\r | |
92 | );\r | |
93 | \r | |
94 | /**\r | |
95 | Enumerate possible boot options.\r | |
96 | \r | |
97 | **/\r | |
98 | VOID\r | |
99 | EnumerateBootOptions (\r | |
100 | VOID\r | |
101 | );\r | |
102 | \r | |
103 | /**\r | |
104 | Remove the installed packages from the HII Database. \r | |
105 | \r | |
106 | **/\r | |
107 | VOID\r | |
108 | FreeBootManager (\r | |
109 | VOID\r | |
110 | );\r | |
111 | \r | |
112 | #endif\r |