]>
Commit | Line | Data |
---|---|---|
5c08e117 | 1 | /** @file\r |
2 | The platform device manager reference implementation\r | |
3 | \r | |
4 | Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r | |
5 | All rights reserved. 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 | #include "DeviceManager.h"\r | |
16 | \r | |
17 | DEVICE_MANAGER_CALLBACK_DATA gDeviceManagerPrivate = {\r | |
18 | DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE,\r | |
19 | NULL,\r | |
20 | NULL,\r | |
21 | {\r | |
22 | FakeExtractConfig,\r | |
23 | FakeRouteConfig,\r | |
24 | DeviceManagerCallback\r | |
25 | }\r | |
26 | };\r | |
27 | \r | |
28 | EFI_GUID mDeviceManagerGuid = DEVICE_MANAGER_FORMSET_GUID;\r | |
29 | \r | |
30 | DEVICE_MANAGER_MENU_ITEM mDeviceManagerMenuItemTable[] = {\r | |
31 | { STRING_TOKEN (STR_DISK_DEVICE), EFI_DISK_DEVICE_CLASS },\r | |
32 | { STRING_TOKEN (STR_VIDEO_DEVICE), EFI_VIDEO_DEVICE_CLASS },\r | |
33 | { STRING_TOKEN (STR_NETWORK_DEVICE), EFI_NETWORK_DEVICE_CLASS },\r | |
34 | { STRING_TOKEN (STR_INPUT_DEVICE), EFI_INPUT_DEVICE_CLASS },\r | |
35 | { STRING_TOKEN (STR_ON_BOARD_DEVICE), EFI_ON_BOARD_DEVICE_CLASS },\r | |
36 | { STRING_TOKEN (STR_OTHER_DEVICE), EFI_OTHER_DEVICE_CLASS }\r | |
37 | };\r | |
38 | \r | |
39 | #define MENU_ITEM_NUM \\r | |
40 | (sizeof (mDeviceManagerMenuItemTable) / sizeof (DEVICE_MANAGER_MENU_ITEM))\r | |
41 | \r | |
42 | /**\r | |
43 | This function is invoked if user selected a iteractive opcode from Device Manager's\r | |
44 | Formset. The decision by user is saved to gCallbackKey for later processing. If\r | |
45 | user set VBIOS, the new value is saved to EFI variable.\r | |
46 | \r | |
47 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
48 | @param Action Specifies the type of action taken by the browser.\r | |
49 | @param QuestionId A unique value which is sent to the original exporting driver\r | |
50 | so that it can identify the type of data to expect.\r | |
51 | @param Type The type of value for the question.\r | |
52 | @param Value A pointer to the data being sent to the original exporting driver.\r | |
53 | @param ActionRequest On return, points to the action requested by the callback function.\r | |
54 | \r | |
55 | @retval EFI_SUCCESS The callback successfully handled the action.\r | |
56 | @retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.\r | |
57 | \r | |
58 | **/\r | |
59 | EFI_STATUS\r | |
60 | EFIAPI\r | |
61 | DeviceManagerCallback (\r | |
62 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
63 | IN EFI_BROWSER_ACTION Action,\r | |
64 | IN EFI_QUESTION_ID QuestionId,\r | |
65 | IN UINT8 Type,\r | |
66 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
67 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
68 | )\r | |
69 | {\r | |
5c08e117 | 70 | if ((Value == NULL) || (ActionRequest == NULL)) {\r |
71 | return EFI_INVALID_PARAMETER;\r | |
72 | }\r | |
73 | \r | |
5c08e117 | 74 | \r |
6aa22a17 | 75 | gCallbackKey = QuestionId;\r |
5c08e117 | 76 | \r |
6aa22a17 | 77 | //\r |
78 | // Request to exit SendForm(), so as to switch to selected form\r | |
79 | //\r | |
80 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r | |
5c08e117 | 81 | \r |
5c08e117 | 82 | \r |
83 | return EFI_SUCCESS;\r | |
84 | }\r | |
85 | \r | |
86 | /**\r | |
87 | \r | |
88 | This function registers HII packages to HII database.\r | |
89 | \r | |
90 | @retval EFI_SUCCESS This function complete successfully.\r | |
91 | @return Other value if failed to register HII packages.\r | |
92 | \r | |
93 | **/\r | |
94 | EFI_STATUS\r | |
95 | InitializeDeviceManager (\r | |
96 | VOID\r | |
97 | )\r | |
98 | {\r | |
99 | EFI_STATUS Status;\r | |
100 | EFI_HII_PACKAGE_LIST_HEADER *PackageList;\r | |
101 | \r | |
102 | //\r | |
103 | // Create driver handle used by HII database\r | |
104 | //\r | |
105 | Status = HiiLibCreateHiiDriverHandle (&gDeviceManagerPrivate.DriverHandle);\r | |
106 | if (EFI_ERROR (Status)) {\r | |
107 | return Status;\r | |
108 | }\r | |
109 | \r | |
110 | //\r | |
111 | // Install Config Access protocol to driver handle\r | |
112 | //\r | |
113 | Status = gBS->InstallProtocolInterface (\r | |
114 | &gDeviceManagerPrivate.DriverHandle,\r | |
115 | &gEfiHiiConfigAccessProtocolGuid,\r | |
116 | EFI_NATIVE_INTERFACE,\r | |
117 | &gDeviceManagerPrivate.ConfigAccess\r | |
118 | );\r | |
119 | ASSERT_EFI_ERROR (Status);\r | |
120 | \r | |
121 | //\r | |
122 | // Publish our HII data\r | |
123 | //\r | |
124 | PackageList = HiiLibPreparePackageList (2, &mDeviceManagerGuid, DeviceManagerVfrBin, BdsDxeStrings);\r | |
125 | ASSERT (PackageList != NULL);\r | |
126 | \r | |
127 | Status = gHiiDatabase->NewPackageList (\r | |
128 | gHiiDatabase,\r | |
129 | PackageList,\r | |
130 | gDeviceManagerPrivate.DriverHandle,\r | |
131 | &gDeviceManagerPrivate.HiiHandle\r | |
132 | );\r | |
133 | FreePool (PackageList);\r | |
134 | \r | |
135 | return Status;\r | |
136 | }\r | |
137 | \r | |
138 | /**\r | |
139 | Call the browser and display the device manager to allow user\r | |
140 | to configure the platform.\r | |
141 | \r | |
142 | This function create the dynamic content for device manager. It includes\r | |
143 | section header for all class of devices, one-of opcode to set VBIOS.\r | |
144 | \r | |
145 | @retval EFI_SUCCESS Operation is successful.\r | |
146 | @return Other values if failed to clean up the dynamic content from HII\r | |
147 | database.\r | |
148 | \r | |
149 | **/\r | |
150 | EFI_STATUS\r | |
151 | CallDeviceManager (\r | |
152 | VOID\r | |
153 | )\r | |
154 | {\r | |
155 | EFI_STATUS Status;\r | |
156 | UINTN Count;\r | |
157 | UINTN Index;\r | |
158 | CHAR16 *String;\r | |
159 | UINTN StringLength;\r | |
160 | EFI_HII_UPDATE_DATA UpdateData[MENU_ITEM_NUM];\r | |
161 | EFI_STRING_ID Token;\r | |
162 | EFI_STRING_ID TokenHelp;\r | |
5c08e117 | 163 | EFI_HII_HANDLE *HiiHandles;\r |
164 | UINTN HandleBufferLength;\r | |
165 | UINTN NumberOfHiiHandles;\r | |
166 | EFI_HII_HANDLE HiiHandle;\r | |
167 | UINT16 FormSetClass;\r | |
168 | EFI_STRING_ID FormSetTitle;\r | |
169 | EFI_STRING_ID FormSetHelp;\r | |
170 | EFI_BROWSER_ACTION_REQUEST ActionRequest;\r | |
171 | EFI_HII_PACKAGE_LIST_HEADER *PackageList;\r | |
172 | \r | |
5c08e117 | 173 | HiiHandles = NULL;\r |
174 | HandleBufferLength = 0;\r | |
175 | \r | |
176 | Status = EFI_SUCCESS;\r | |
177 | gCallbackKey = 0;\r | |
178 | \r | |
179 | //\r | |
180 | // Connect all prior to entering the platform setup menu.\r | |
181 | //\r | |
182 | if (!gConnectAllHappened) {\r | |
183 | BdsLibConnectAllDriversToAllControllers ();\r | |
184 | gConnectAllHappened = TRUE;\r | |
185 | }\r | |
186 | \r | |
187 | //\r | |
188 | // Create Subtitle OpCodes\r | |
189 | //\r | |
190 | for (Index = 0; Index < MENU_ITEM_NUM; Index++) {\r | |
191 | //\r | |
192 | // Allocate space for creation of UpdateData Buffer\r | |
193 | //\r | |
194 | UpdateData[Index].BufferSize = 0x1000;\r | |
195 | UpdateData[Index].Offset = 0;\r | |
196 | UpdateData[Index].Data = AllocatePool (0x1000);\r | |
197 | ASSERT (UpdateData[Index].Data != NULL);\r | |
198 | \r | |
199 | CreateSubTitleOpCode (mDeviceManagerMenuItemTable[Index].StringId, 0, 0, 1, &UpdateData[Index]);\r | |
200 | }\r | |
201 | \r | |
202 | //\r | |
203 | // Get all the Hii handles\r | |
204 | //\r | |
205 | Status = HiiLibGetHiiHandles (&HandleBufferLength, &HiiHandles);\r | |
206 | ASSERT_EFI_ERROR (Status && (HiiHandles != NULL));\r | |
207 | \r | |
208 | HiiHandle = gDeviceManagerPrivate.HiiHandle;\r | |
209 | \r | |
210 | StringLength = 0x1000;\r | |
211 | String = AllocateZeroPool (StringLength);\r | |
212 | ASSERT (String != NULL);\r | |
213 | \r | |
214 | //\r | |
215 | // Search for formset of each class type\r | |
216 | //\r | |
217 | NumberOfHiiHandles = HandleBufferLength / sizeof (EFI_HII_HANDLE);\r | |
218 | for (Index = 0; Index < NumberOfHiiHandles; Index++) {\r | |
219 | IfrLibExtractClassFromHiiHandle (HiiHandles[Index], &FormSetClass, &FormSetTitle, &FormSetHelp);\r | |
220 | \r | |
221 | if (FormSetClass == EFI_NON_DEVICE_CLASS) {\r | |
222 | continue;\r | |
223 | }\r | |
224 | \r | |
225 | Token = 0;\r | |
226 | *String = 0;\r | |
227 | StringLength = 0x1000;\r | |
228 | HiiLibGetString (HiiHandles[Index], FormSetTitle, String, &StringLength);\r | |
229 | HiiLibNewString (HiiHandle, &Token, String);\r | |
230 | \r | |
231 | TokenHelp = 0;\r | |
232 | *String = 0;\r | |
233 | StringLength = 0x1000;\r | |
234 | HiiLibGetString (HiiHandles[Index], FormSetHelp, String, &StringLength);\r | |
235 | HiiLibNewString (HiiHandle, &TokenHelp, String);\r | |
236 | \r | |
237 | for (Count = 0; Count < MENU_ITEM_NUM; Count++) {\r | |
238 | if (FormSetClass & mDeviceManagerMenuItemTable[Count].Class) {\r | |
239 | CreateActionOpCode (\r | |
240 | (EFI_QUESTION_ID) (Index + DEVICE_KEY_OFFSET),\r | |
241 | Token,\r | |
242 | TokenHelp,\r | |
243 | EFI_IFR_FLAG_CALLBACK,\r | |
244 | 0,\r | |
245 | &UpdateData[Count]\r | |
246 | );\r | |
247 | }\r | |
248 | }\r | |
249 | }\r | |
250 | FreePool (String);\r | |
251 | \r | |
252 | for (Index = 0; Index < MENU_ITEM_NUM; Index++) {\r | |
253 | //\r | |
254 | // Add End Opcode for Subtitle\r | |
255 | //\r | |
256 | CreateEndOpCode (&UpdateData[Index]);\r | |
257 | \r | |
258 | IfrLibUpdateForm (\r | |
259 | HiiHandle,\r | |
260 | &mDeviceManagerGuid,\r | |
261 | DEVICE_MANAGER_FORM_ID,\r | |
262 | mDeviceManagerMenuItemTable[Index].Class,\r | |
263 | FALSE,\r | |
264 | &UpdateData[Index]\r | |
265 | );\r | |
266 | }\r | |
267 | \r | |
5c08e117 | 268 | ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r |
269 | Status = gFormBrowser2->SendForm (\r | |
270 | gFormBrowser2,\r | |
271 | &HiiHandle,\r | |
272 | 1,\r | |
273 | NULL,\r | |
274 | 0,\r | |
275 | NULL,\r | |
276 | &ActionRequest\r | |
277 | );\r | |
278 | if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {\r | |
279 | EnableResetRequired ();\r | |
280 | }\r | |
281 | \r | |
282 | //\r | |
283 | // We will have returned from processing a callback - user either hit ESC to exit, or selected\r | |
284 | // a target to display\r | |
285 | //\r | |
286 | if (gCallbackKey != 0) {\r | |
287 | ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r | |
288 | Status = gFormBrowser2->SendForm (\r | |
289 | gFormBrowser2,\r | |
290 | &HiiHandles[gCallbackKey - DEVICE_KEY_OFFSET],\r | |
291 | 1,\r | |
292 | NULL,\r | |
293 | 0,\r | |
294 | NULL,\r | |
295 | &ActionRequest\r | |
296 | );\r | |
297 | \r | |
298 | if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {\r | |
299 | EnableResetRequired ();\r | |
300 | }\r | |
301 | \r | |
302 | //\r | |
303 | // Force return to Device Manager\r | |
304 | //\r | |
305 | gCallbackKey = FRONT_PAGE_KEY_DEVICE_MANAGER;\r | |
306 | }\r | |
307 | \r | |
308 | //\r | |
309 | // Cleanup dynamic created strings in HII database by reinstall the packagelist\r | |
310 | //\r | |
311 | gHiiDatabase->RemovePackageList (gHiiDatabase, HiiHandle);\r | |
312 | PackageList = HiiLibPreparePackageList (2, &mDeviceManagerGuid, DeviceManagerVfrBin, BdsDxeStrings);\r | |
313 | ASSERT (PackageList != NULL);\r | |
314 | Status = gHiiDatabase->NewPackageList (\r | |
315 | gHiiDatabase,\r | |
316 | PackageList,\r | |
317 | gDeviceManagerPrivate.DriverHandle,\r | |
318 | &gDeviceManagerPrivate.HiiHandle\r | |
319 | );\r | |
320 | FreePool (PackageList);\r | |
321 | \r | |
322 | for (Index = 0; Index < MENU_ITEM_NUM; Index++) {\r | |
323 | FreePool (UpdateData[Index].Data);\r | |
324 | }\r | |
325 | FreePool (HiiHandles);\r | |
326 | \r | |
327 | return Status;\r | |
328 | }\r |