]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenanceManagerCustomizedUiSupport.h
MdeModulePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdeModulePkg / Library / BootMaintenanceManagerUiLib / BootMaintenanceManagerCustomizedUiSupport.h
CommitLineData
a85be3ae
ED
1/** @file\r
2 This library class defines a set of interfaces to be used by customize Ui module\r
3\r
4Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
9d510e61 5SPDX-License-Identifier: BSD-2-Clause-Patent\r
a85be3ae
ED
6\r
7**/\r
8\r
9#ifndef __BOOT_MAINTENANCE_MANAGER_UI_LIB_H__\r
10#define __BOOT_MAINTENANCE_MANAGER_UI_LIB_H__\r
11\r
12/**\r
13 Create Time Out Menu in the page.\r
14\r
15 @param[in] HiiHandle The hii handle for the Uiapp driver.\r
16 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.\r
17\r
18**/\r
19VOID\r
20BmmCreateTimeOutMenu (\r
21 IN EFI_HII_HANDLE HiiHandle,\r
22 IN VOID *StartOpCodeHandle\r
23 );\r
24\r
25/**\r
26 Create the dynamic item to allow user to set the "BootNext" vaule.\r
27\r
8caa3caa
DB
28 @param[in] HiiHandle The hii handle for the Uiapp driver.\r
29 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.\r
a85be3ae
ED
30\r
31**/\r
32VOID\r
33BmmCreateBootNextMenu(\r
34 IN EFI_HII_HANDLE HiiHandle,\r
35 IN VOID *StartOpCodeHandle\r
36 );\r
37\r
38/**\r
39 Create Boot Option menu in the page.\r
40\r
41 @param[in] HiiHandle The hii handle for the Uiapp driver.\r
42 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.\r
43\r
44**/\r
45VOID\r
46BmmCreateBootOptionMenu (\r
47 IN EFI_HII_HANDLE HiiHandle,\r
48 IN VOID *StartOpCodeHandle\r
49 );\r
50\r
51/**\r
52 Create Driver Option menu in the page.\r
53\r
54 @param[in] HiiHandle The hii handle for the Uiapp driver.\r
55 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.\r
56\r
57**/\r
58VOID\r
59BmmCreateDriverOptionMenu (\r
60 IN EFI_HII_HANDLE HiiHandle,\r
61 IN VOID *StartOpCodeHandle\r
62 );\r
63\r
64/**\r
65 Create Com Option menu in the page.\r
66\r
67 @param[in] HiiHandle The hii handle for the Uiapp driver.\r
68 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.\r
69\r
70**/\r
71VOID\r
72BmmCreateComOptionMenu (\r
73 IN EFI_HII_HANDLE HiiHandle,\r
74 IN VOID *StartOpCodeHandle\r
75 );\r
76\r
77/**\r
78 Create Com Option menu in the page.\r
79\r
80 @param[in] HiiHandle The hii handle for the Uiapp driver.\r
81 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.\r
82\r
83**/\r
84VOID\r
85BmmCreateBootFromFileMenu (\r
86 IN EFI_HII_HANDLE HiiHandle,\r
87 IN VOID *StartOpCodeHandle\r
88 );\r
89\r
90/**\r
91 Create empty line menu in the front page.\r
92\r
93 @param HiiHandle The hii handle for the Uiapp driver.\r
94 @param StartOpCodeHandle The opcode handle to save the new opcode.\r
95\r
96**/\r
97VOID\r
98BmmCreateEmptyLine (\r
99 IN EFI_HII_HANDLE HiiHandle,\r
100 IN VOID *StartOpCodeHandle\r
101 );\r
102\r
103/**\r
104 Rename the driver name if necessary.\r
105\r
106 @param DriverName Input the driver name.\r
107 @param NewDriverName Return the new driver name.\r
108 @param EmptyLineAfter Whether need to insert empty line.\r
109\r
110 @retval New driver name if compared, else NULL.\r
111\r
112**/\r
113typedef\r
114EFI_STATUS\r
115(EFIAPI *DRIVER_SPECIAL_HANDLER)(\r
116 IN CHAR16 *DriverName,\r
117 OUT CHAR16 **NewName,\r
118 OUT BOOLEAN *EmptyLineAfter\r
119);\r
120\r
121/**\r
122 Search the drivers in the system which need to show in the front page\r
123 and insert the menu to the front page.\r
124\r
125 @param HiiHandle The hii handle for the Uiapp driver.\r
126 @param ClassGuid The class guid for the driver which is the target.\r
8caa3caa 127 @param SpecialHandlerFn The pointer to the specail handler function, if any.\r
a85be3ae 128 @param StartOpCodeHandle The opcode handle to save the new opcode.\r
a85be3ae
ED
129\r
130 @retval EFI_SUCCESS Search the driver success\r
131\r
132**/\r
133EFI_STATUS\r
134BmmListThirdPartyDrivers (\r
135 IN EFI_HII_HANDLE HiiHandle,\r
136 IN EFI_GUID *ClassGuid,\r
137 IN DRIVER_SPECIAL_HANDLER SpecialHandlerFn,\r
138 IN VOID *StartOpCodeHandle\r
139 );\r
140\r
141#endif\r