]>
Commit | Line | Data |
---|---|---|
fd6a62f3 | 1 | /** @file\r |
2 | FrontPage routines to handle the callbacks and browser calls\r | |
93e3992d | 3 | \r |
fd6a62f3 | 4 | Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r |
93e3992d | 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 | |
fd6a62f3 | 13 | **/\r |
93e3992d | 14 | \r |
15 | #include "Bds.h"\r | |
16 | #include "FrontPage.h"\r | |
17 | \r | |
18 | EFI_GUID mFrontPageGuid = FRONT_PAGE_FORMSET_GUID;\r | |
19 | \r | |
20 | BOOLEAN gConnectAllHappened = FALSE;\r | |
21 | UINTN gCallbackKey;\r | |
22 | \r | |
23 | EFI_HII_DATABASE_PROTOCOL *gHiiDatabase;\r | |
24 | EFI_HII_STRING_PROTOCOL *gHiiString;\r | |
25 | EFI_FORM_BROWSER2_PROTOCOL *gFormBrowser2;\r | |
26 | EFI_HII_CONFIG_ROUTING_PROTOCOL *gHiiConfigRouting;\r | |
27 | \r | |
28 | FRONT_PAGE_CALLBACK_DATA gFrontPagePrivate = {\r | |
29 | FRONT_PAGE_CALLBACK_DATA_SIGNATURE,\r | |
30 | NULL,\r | |
31 | NULL,\r | |
32 | NULL,\r | |
33 | {\r | |
34 | FakeExtractConfig,\r | |
35 | FakeRouteConfig,\r | |
36 | FrontPageCallback\r | |
37 | }\r | |
38 | };\r | |
39 | \r | |
b30312ba | 40 | /**\r |
41 | This function allows a caller to extract the current configuration for one\r | |
42 | or more named elements from the target driver.\r | |
43 | \r | |
44 | \r | |
45 | @param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
46 | @param Request - A null-terminated Unicode string in <ConfigRequest> format.\r | |
47 | @param Progress - On return, points to a character in the Request string.\r | |
48 | Points to the string's null terminator if request was successful.\r | |
49 | Points to the most recent '&' before the first failing name/value\r | |
50 | pair (or the beginning of the string if the failure is in the\r | |
51 | first name/value pair) if the request was not successful.\r | |
52 | @param Results - A null-terminated Unicode string in <ConfigAltResp> format which\r | |
53 | has all values filled in for the names in the Request string.\r | |
54 | String to be allocated by the called function.\r | |
55 | \r | |
56 | @retval EFI_SUCCESS The Results is filled with the requested values.\r | |
57 | @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r | |
58 | @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r | |
59 | @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r | |
60 | \r | |
61 | **/\r | |
93e3992d | 62 | EFI_STATUS\r |
63 | EFIAPI\r | |
64 | FakeExtractConfig (\r | |
65 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
66 | IN CONST EFI_STRING Request,\r | |
67 | OUT EFI_STRING *Progress,\r | |
68 | OUT EFI_STRING *Results\r | |
69 | )\r | |
93e3992d | 70 | {\r |
71 | return EFI_NOT_FOUND;\r | |
72 | }\r | |
73 | \r | |
b30312ba | 74 | /**\r |
75 | This function processes the results of changes in configuration.\r | |
76 | \r | |
77 | \r | |
78 | @param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
79 | @param Configuration - A null-terminated Unicode string in <ConfigResp> format.\r | |
80 | @param Progress - A pointer to a string filled in with the offset of the most\r | |
81 | recent '&' before the first failing name/value pair (or the\r | |
82 | beginning of the string if the failure is in the first\r | |
83 | name/value pair) or the terminating NULL if all was successful.\r | |
84 | \r | |
85 | @retval EFI_SUCCESS The Results is processed successfully.\r | |
86 | @retval EFI_INVALID_PARAMETER Configuration is NULL.\r | |
87 | @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r | |
88 | \r | |
89 | **/\r | |
93e3992d | 90 | EFI_STATUS\r |
91 | EFIAPI\r | |
92 | FakeRouteConfig (\r | |
93 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
94 | IN CONST EFI_STRING Configuration,\r | |
95 | OUT EFI_STRING *Progress\r | |
96 | )\r | |
b30312ba | 97 | {\r |
98 | return EFI_SUCCESS;\r | |
99 | }\r | |
93e3992d | 100 | \r |
b30312ba | 101 | /**\r |
102 | This function processes the results of changes in configuration.\r | |
93e3992d | 103 | \r |
93e3992d | 104 | \r |
b30312ba | 105 | @param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r |
106 | @param Action - Specifies the type of action taken by the browser.\r | |
107 | @param QuestionId - A unique value which is sent to the original exporting driver\r | |
108 | so that it can identify the type of data to expect.\r | |
109 | @param Type - The type of value for the question.\r | |
110 | @param Value - A pointer to the data being sent to the original exporting driver.\r | |
111 | @param ActionRequest - On return, points to the action requested by the callback function.\r | |
93e3992d | 112 | \r |
b30312ba | 113 | @retval EFI_SUCCESS The callback successfully handled the action.\r |
114 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
115 | @retval EFI_DEVICE_ERROR The variable could not be saved.\r | |
116 | @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.\r | |
93e3992d | 117 | \r |
b30312ba | 118 | **/\r |
93e3992d | 119 | EFI_STATUS\r |
120 | EFIAPI\r | |
121 | FrontPageCallback (\r | |
122 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
123 | IN EFI_BROWSER_ACTION Action,\r | |
124 | IN EFI_QUESTION_ID QuestionId,\r | |
125 | IN UINT8 Type,\r | |
126 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
127 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
128 | )\r | |
93e3992d | 129 | {\r |
130 | CHAR8 *LanguageString;\r | |
131 | CHAR8 *LangCode;\r | |
132 | CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r | |
93e3992d | 133 | CHAR8 OldLang[ISO_639_2_ENTRY_SIZE];\r |
93e3992d | 134 | UINTN Index;\r |
135 | EFI_STATUS Status;\r | |
136 | \r | |
137 | if ((Value == NULL) || (ActionRequest == NULL)) {\r | |
138 | return EFI_INVALID_PARAMETER;\r | |
139 | }\r | |
140 | \r | |
141 | gCallbackKey = QuestionId;\r | |
142 | \r | |
143 | //\r | |
144 | // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can\r | |
145 | // describe to their customers in documentation how to find their setup information (namely\r | |
146 | // under the device manager and specific buckets)\r | |
147 | //\r | |
148 | switch (QuestionId) {\r | |
149 | case FRONT_PAGE_KEY_CONTINUE:\r | |
150 | //\r | |
151 | // This is the continue - clear the screen and return an error to get out of FrontPage loop\r | |
152 | //\r | |
153 | break;\r | |
154 | \r | |
155 | case FRONT_PAGE_KEY_LANGUAGE:\r | |
156 | //\r | |
157 | // Collect the languages from what our current Language support is based on our VFR\r | |
158 | //\r | |
9226efe5 | 159 | LanguageString = HiiLibGetSupportedLanguages (gFrontPagePrivate.HiiHandle);\r |
93e3992d | 160 | ASSERT (LanguageString != NULL);\r |
161 | \r | |
162 | Index = 0;\r | |
163 | LangCode = LanguageString;\r | |
164 | while (*LangCode != 0) {\r | |
9226efe5 | 165 | HiiLibGetNextLanguage (&LangCode, Lang);\r |
93e3992d | 166 | \r |
167 | if (Index == Value->u8) {\r | |
168 | break;\r | |
169 | }\r | |
170 | \r | |
171 | Index++;\r | |
172 | }\r | |
173 | \r | |
174 | Status = gRT->SetVariable (\r | |
175 | L"PlatformLang",\r | |
176 | &gEfiGlobalVariableGuid,\r | |
177 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
178 | AsciiStrSize (Lang),\r | |
179 | Lang\r | |
180 | );\r | |
181 | \r | |
ca65d105 | 182 | if (!FeaturePcdGet (PcdUefiVariableDefaultLangDeprecate)) {\r |
d6c0ec55 | 183 | //\r |
184 | // Set UEFI deprecated variable "Lang" for backwards compatibility\r | |
185 | //\r | |
186 | Status = ConvertRfc3066LanguageToIso639Language (Lang, OldLang);\r | |
187 | if (!EFI_ERROR (Status)) {\r | |
188 | Status = gRT->SetVariable (\r | |
189 | L"Lang",\r | |
190 | &gEfiGlobalVariableGuid,\r | |
191 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
192 | ISO_639_2_ENTRY_SIZE,\r | |
193 | OldLang\r | |
194 | );\r | |
195 | }\r | |
93e3992d | 196 | }\r |
93e3992d | 197 | \r |
198 | FreePool (LanguageString);\r | |
199 | break;\r | |
200 | \r | |
201 | case FRONT_PAGE_KEY_BOOT_MANAGER:\r | |
202 | //\r | |
203 | // Boot Manager\r | |
204 | //\r | |
205 | break;\r | |
206 | \r | |
207 | case FRONT_PAGE_KEY_DEVICE_MANAGER:\r | |
208 | //\r | |
209 | // Device Manager\r | |
210 | //\r | |
211 | break;\r | |
212 | \r | |
213 | case FRONT_PAGE_KEY_BOOT_MAINTAIN:\r | |
214 | //\r | |
215 | // Boot Maintenance Manager\r | |
216 | //\r | |
217 | break;\r | |
218 | \r | |
219 | default:\r | |
220 | gCallbackKey = 0;\r | |
221 | break;\r | |
222 | }\r | |
223 | \r | |
224 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r | |
225 | \r | |
226 | return EFI_SUCCESS;\r | |
227 | }\r | |
228 | \r | |
b30312ba | 229 | /**\r |
93e3992d | 230 | Initialize HII information for the FrontPage\r |
231 | \r | |
93e3992d | 232 | \r |
b30312ba | 233 | @param InitializeHiiData TRUE if HII elements need to be initialized.\r |
234 | \r | |
235 | @retval EFI_SUCCESS The operation is successful.\r | |
236 | @retval EFI_DEVICE_ERROR If the dynamic opcode creation failed.\r | |
93e3992d | 237 | \r |
b30312ba | 238 | **/\r |
239 | EFI_STATUS\r | |
240 | InitializeFrontPage (\r | |
b4489769 | 241 | IN BOOLEAN InitializeHiiData\r |
b30312ba | 242 | )\r |
93e3992d | 243 | {\r |
244 | EFI_STATUS Status;\r | |
245 | EFI_HII_PACKAGE_LIST_HEADER *PackageList;\r | |
246 | EFI_HII_UPDATE_DATA UpdateData;\r | |
247 | IFR_OPTION *OptionList;\r | |
248 | CHAR8 *LanguageString;\r | |
249 | CHAR8 *LangCode;\r | |
250 | CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r | |
251 | CHAR8 CurrentLang[RFC_3066_ENTRY_SIZE];\r | |
252 | UINTN OptionCount;\r | |
253 | EFI_STRING_ID Token;\r | |
254 | CHAR16 *StringBuffer;\r | |
255 | UINTN BufferSize;\r | |
256 | UINTN Index;\r | |
257 | EFI_HII_HANDLE HiiHandle;\r | |
258 | \r | |
b30312ba | 259 | if (InitializeHiiData) {\r |
93e3992d | 260 | //\r |
261 | // Initialize the Device Manager\r | |
262 | //\r | |
263 | InitializeDeviceManager ();\r | |
264 | \r | |
265 | //\r | |
266 | // Initialize the Device Manager\r | |
267 | //\r | |
268 | InitializeBootManager ();\r | |
269 | \r | |
270 | gCallbackKey = 0;\r | |
271 | \r | |
272 | //\r | |
273 | // Locate Hii relative protocols\r | |
274 | //\r | |
275 | Status = gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &gHiiDatabase);\r | |
276 | if (EFI_ERROR (Status)) {\r | |
277 | return Status;\r | |
278 | }\r | |
279 | \r | |
280 | Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &gHiiString);\r | |
281 | if (EFI_ERROR (Status)) {\r | |
282 | return Status;\r | |
283 | }\r | |
284 | \r | |
285 | Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &gFormBrowser2);\r | |
286 | if (EFI_ERROR (Status)) {\r | |
287 | return Status;\r | |
288 | }\r | |
289 | \r | |
290 | Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &gHiiConfigRouting);\r | |
291 | if (EFI_ERROR (Status)) {\r | |
292 | return Status;\r | |
293 | }\r | |
294 | \r | |
295 | //\r | |
296 | // Create driver handle used by HII database\r | |
297 | //\r | |
298 | Status = HiiLibCreateHiiDriverHandle (&gFrontPagePrivate.DriverHandle);\r | |
299 | if (EFI_ERROR (Status)) {\r | |
300 | return Status;\r | |
301 | }\r | |
302 | \r | |
303 | //\r | |
304 | // Install Config Access protocol to driver handle\r | |
305 | //\r | |
306 | Status = gBS->InstallProtocolInterface (\r | |
307 | &gFrontPagePrivate.DriverHandle,\r | |
308 | &gEfiHiiConfigAccessProtocolGuid,\r | |
309 | EFI_NATIVE_INTERFACE,\r | |
310 | &gFrontPagePrivate.ConfigAccess\r | |
311 | );\r | |
312 | ASSERT_EFI_ERROR (Status);\r | |
313 | \r | |
314 | //\r | |
315 | // Publish our HII data\r | |
316 | //\r | |
062539cf | 317 | PackageList = HiiLibPreparePackageList (2, &mFrontPageGuid, FrontPageVfrBin, BdsDxeStrings);\r |
93e3992d | 318 | ASSERT (PackageList != NULL);\r |
319 | \r | |
320 | Status = gHiiDatabase->NewPackageList (\r | |
321 | gHiiDatabase,\r | |
322 | PackageList,\r | |
323 | gFrontPagePrivate.DriverHandle,\r | |
324 | &gFrontPagePrivate.HiiHandle\r | |
325 | );\r | |
326 | FreePool (PackageList);\r | |
327 | if (EFI_ERROR (Status)) {\r | |
328 | return Status;\r | |
329 | }\r | |
330 | }\r | |
331 | \r | |
332 | //\r | |
333 | // Get current language setting\r | |
334 | //\r | |
c27eb358 | 335 | GetCurrentLanguage (CurrentLang);\r |
93e3992d | 336 | \r |
337 | //\r | |
338 | // Allocate space for creation of UpdateData Buffer\r | |
339 | //\r | |
340 | UpdateData.BufferSize = 0x1000;\r | |
341 | UpdateData.Data = AllocateZeroPool (0x1000);\r | |
342 | ASSERT (UpdateData.Data != NULL);\r | |
343 | \r | |
344 | OptionList = AllocateZeroPool (0x1000);\r | |
345 | ASSERT (OptionList != NULL);\r | |
346 | \r | |
347 | //\r | |
348 | // Collect the languages from what our current Language support is based on our VFR\r | |
349 | //\r | |
350 | HiiHandle = gFrontPagePrivate.HiiHandle;\r | |
9226efe5 | 351 | LanguageString = HiiLibGetSupportedLanguages (HiiHandle);\r |
93e3992d | 352 | ASSERT (LanguageString != NULL);\r |
353 | \r | |
354 | OptionCount = 0;\r | |
355 | LangCode = LanguageString;\r | |
356 | while (*LangCode != 0) {\r | |
9226efe5 | 357 | HiiLibGetNextLanguage (&LangCode, Lang);\r |
93e3992d | 358 | \r |
359 | if (gFrontPagePrivate.LanguageToken == NULL) {\r | |
360 | //\r | |
361 | // Get Language Name from String Package. The StringId of Printable Language\r | |
362 | // Name is always 1 which is generated by StringGather Tool.\r | |
363 | //\r | |
364 | BufferSize = 0x100;\r | |
365 | StringBuffer = AllocatePool (BufferSize);\r | |
366 | Status = gHiiString->GetString (\r | |
367 | gHiiString,\r | |
368 | Lang,\r | |
369 | HiiHandle,\r | |
370 | PRINTABLE_LANGUAGE_NAME_STRING_ID,\r | |
371 | StringBuffer,\r | |
372 | &BufferSize,\r | |
373 | NULL\r | |
374 | );\r | |
375 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
376 | FreePool (StringBuffer);\r | |
377 | StringBuffer = AllocatePool (BufferSize);\r | |
378 | Status = gHiiString->GetString (\r | |
379 | gHiiString,\r | |
380 | Lang,\r | |
381 | HiiHandle,\r | |
382 | PRINTABLE_LANGUAGE_NAME_STRING_ID,\r | |
383 | StringBuffer,\r | |
384 | &BufferSize,\r | |
385 | NULL\r | |
386 | );\r | |
387 | }\r | |
388 | ASSERT_EFI_ERROR (Status);\r | |
389 | \r | |
390 | Token = 0;\r | |
9226efe5 | 391 | Status = HiiLibNewString (HiiHandle, &Token, StringBuffer);\r |
93e3992d | 392 | FreePool (StringBuffer);\r |
393 | } else {\r | |
394 | Token = gFrontPagePrivate.LanguageToken[OptionCount];\r | |
395 | }\r | |
396 | \r | |
397 | if (AsciiStrCmp (Lang, CurrentLang) == 0) {\r | |
398 | OptionList[OptionCount].Flags = EFI_IFR_OPTION_DEFAULT;\r | |
399 | } else {\r | |
400 | OptionList[OptionCount].Flags = 0;\r | |
401 | }\r | |
402 | OptionList[OptionCount].StringToken = Token;\r | |
403 | OptionList[OptionCount].Value.u8 = (UINT8) OptionCount;\r | |
404 | \r | |
405 | OptionCount++;\r | |
406 | }\r | |
407 | \r | |
408 | FreePool (LanguageString);\r | |
409 | \r | |
410 | UpdateData.Offset = 0;\r | |
411 | CreateOneOfOpCode (\r | |
412 | FRONT_PAGE_KEY_LANGUAGE,\r | |
413 | 0,\r | |
414 | 0,\r | |
415 | STRING_TOKEN (STR_LANGUAGE_SELECT),\r | |
416 | STRING_TOKEN (STR_LANGUAGE_SELECT_HELP),\r | |
417 | EFI_IFR_FLAG_CALLBACK,\r | |
418 | EFI_IFR_NUMERIC_SIZE_1,\r | |
419 | OptionList,\r | |
420 | OptionCount,\r | |
421 | &UpdateData\r | |
422 | );\r | |
423 | \r | |
424 | Status = IfrLibUpdateForm (\r | |
425 | HiiHandle,\r | |
426 | &mFrontPageGuid,\r | |
427 | FRONT_PAGE_FORM_ID,\r | |
428 | LABEL_SELECT_LANGUAGE,\r | |
429 | FALSE,\r | |
430 | &UpdateData\r | |
431 | );\r | |
432 | \r | |
433 | //\r | |
434 | // Save the string Id for each language\r | |
435 | //\r | |
436 | gFrontPagePrivate.LanguageToken = AllocatePool (OptionCount * sizeof (EFI_STRING_ID));\r | |
437 | ASSERT (gFrontPagePrivate.LanguageToken != NULL);\r | |
438 | for (Index = 0; Index < OptionCount; Index++) {\r | |
439 | gFrontPagePrivate.LanguageToken[Index] = OptionList[Index].StringToken;\r | |
440 | }\r | |
441 | \r | |
442 | FreePool (UpdateData.Data);\r | |
443 | FreePool (OptionList);\r | |
444 | return Status;\r | |
445 | }\r | |
446 | \r | |
b30312ba | 447 | /**\r |
93e3992d | 448 | Call the browser and display the front page\r |
449 | \r | |
b30312ba | 450 | @return Status code that will be returned by\r |
451 | EFI_FORM_BROWSER2_PROTOCOL.SendForm ().\r | |
93e3992d | 452 | \r |
b30312ba | 453 | **/\r |
454 | EFI_STATUS\r | |
455 | CallFrontPage (\r | |
456 | VOID\r | |
457 | )\r | |
93e3992d | 458 | {\r |
459 | EFI_STATUS Status;\r | |
460 | EFI_BROWSER_ACTION_REQUEST ActionRequest;\r | |
461 | \r | |
462 | //\r | |
463 | // Begin waiting for USER INPUT\r | |
464 | //\r | |
465 | REPORT_STATUS_CODE (\r | |
466 | EFI_PROGRESS_CODE,\r | |
467 | (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_PC_INPUT_WAIT)\r | |
468 | );\r | |
469 | \r | |
93e3992d | 470 | ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r |
471 | Status = gFormBrowser2->SendForm (\r | |
472 | gFormBrowser2,\r | |
473 | &gFrontPagePrivate.HiiHandle,\r | |
474 | 1,\r | |
475 | NULL,\r | |
476 | 0,\r | |
477 | NULL,\r | |
478 | &ActionRequest\r | |
479 | );\r | |
480 | //\r | |
481 | // Check whether user change any option setting which needs a reset to be effective\r | |
482 | //\r | |
483 | if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {\r | |
484 | EnableResetRequired ();\r | |
485 | }\r | |
486 | \r | |
93e3992d | 487 | return Status;\r |
488 | }\r | |
489 | \r | |
b30312ba | 490 | /**\r |
491 | Acquire the string associated with the ProducerGuid and return it.\r | |
492 | \r | |
493 | \r | |
494 | @param ProducerGuid - The Guid to search the HII database for\r | |
495 | @param Token - The token value of the string to extract\r | |
496 | @param String - The string that is extracted\r | |
497 | \r | |
498 | @retval EFI_SUCCESS The function returns EFI_SUCCESS always.\r | |
499 | \r | |
500 | **/\r | |
93e3992d | 501 | EFI_STATUS\r |
502 | GetProducerString (\r | |
503 | IN EFI_GUID *ProducerGuid,\r | |
504 | IN EFI_STRING_ID Token,\r | |
505 | OUT CHAR16 **String\r | |
506 | )\r | |
93e3992d | 507 | {\r |
508 | EFI_STATUS Status;\r | |
509 | \r | |
9226efe5 | 510 | Status = HiiLibGetStringFromToken (ProducerGuid, Token, String);\r |
93e3992d | 511 | if (EFI_ERROR (Status)) {\r |
512 | *String = GetStringById (STRING_TOKEN (STR_MISSING_STRING));\r | |
513 | }\r | |
514 | \r | |
515 | return EFI_SUCCESS;\r | |
516 | }\r | |
517 | \r | |
b30312ba | 518 | /**\r |
519 | Convert Processor Frequency Data to a string\r | |
520 | \r | |
521 | \r | |
522 | @param ProcessorFrequency - The frequency data to process\r | |
523 | @param String - The string that is created\r | |
524 | \r | |
525 | @return VOID.\r | |
526 | \r | |
527 | **/\r | |
93e3992d | 528 | VOID\r |
529 | ConvertProcessorToString (\r | |
530 | IN EFI_PROCESSOR_CORE_FREQUENCY_DATA *ProcessorFrequency,\r | |
531 | OUT CHAR16 **String\r | |
532 | )\r | |
93e3992d | 533 | {\r |
534 | CHAR16 *StringBuffer;\r | |
535 | UINTN Index;\r | |
536 | UINT32 FreqMhz;\r | |
537 | \r | |
538 | if (ProcessorFrequency->Exponent >= 6) {\r | |
539 | FreqMhz = ProcessorFrequency->Value;\r | |
540 | for (Index = 0; Index < (UINTN) (ProcessorFrequency->Exponent - 6); Index++) {\r | |
541 | FreqMhz *= 10;\r | |
542 | }\r | |
543 | } else {\r | |
544 | FreqMhz = 0;\r | |
545 | }\r | |
546 | \r | |
547 | StringBuffer = AllocateZeroPool (0x20);\r | |
548 | ASSERT (StringBuffer != NULL);\r | |
549 | Index = UnicodeValueToString (StringBuffer, LEFT_JUSTIFY, FreqMhz / 1000, 3);\r | |
550 | StrCat (StringBuffer, L".");\r | |
551 | UnicodeValueToString (StringBuffer + Index + 1, PREFIX_ZERO, (FreqMhz % 1000) / 10, 2);\r | |
552 | StrCat (StringBuffer, L" GHz");\r | |
553 | \r | |
554 | *String = (CHAR16 *) StringBuffer;\r | |
555 | \r | |
556 | return ;\r | |
557 | }\r | |
558 | \r | |
b30312ba | 559 | /**\r |
43b86bee | 560 | Convert Memory Size to a string.\r |
b30312ba | 561 | \r |
562 | \r | |
563 | @param MemorySize - The size of the memory to process\r | |
564 | @param String - The string that is created\r | |
565 | \r | |
b30312ba | 566 | **/\r |
93e3992d | 567 | VOID\r |
568 | ConvertMemorySizeToString (\r | |
569 | IN UINT32 MemorySize,\r | |
570 | OUT CHAR16 **String\r | |
571 | )\r | |
93e3992d | 572 | {\r |
573 | CHAR16 *StringBuffer;\r | |
574 | \r | |
575 | StringBuffer = AllocateZeroPool (0x20);\r | |
576 | ASSERT (StringBuffer != NULL);\r | |
577 | UnicodeValueToString (StringBuffer, LEFT_JUSTIFY, MemorySize, 6);\r | |
578 | StrCat (StringBuffer, L" MB RAM");\r | |
579 | \r | |
580 | *String = (CHAR16 *) StringBuffer;\r | |
581 | \r | |
582 | return ;\r | |
583 | }\r | |
584 | \r | |
b30312ba | 585 | /**\r |
b4489769 | 586 | Update the banner information for the Front Page based on DataHub information.\r |
93e3992d | 587 | \r |
b30312ba | 588 | **/\r |
589 | VOID\r | |
590 | UpdateFrontPageStrings (\r | |
591 | VOID\r | |
592 | )\r | |
93e3992d | 593 | {\r |
594 | EFI_STATUS Status;\r | |
595 | EFI_STRING_ID TokenToUpdate;\r | |
596 | CHAR16 *NewString;\r | |
597 | UINT64 MonotonicCount;\r | |
598 | EFI_DATA_HUB_PROTOCOL *DataHub;\r | |
599 | EFI_DATA_RECORD_HEADER *Record;\r | |
600 | EFI_SUBCLASS_TYPE1_HEADER *DataHeader;\r | |
601 | EFI_MISC_BIOS_VENDOR_DATA *BiosVendor;\r | |
602 | EFI_MISC_SYSTEM_MANUFACTURER_DATA *SystemManufacturer;\r | |
603 | EFI_PROCESSOR_VERSION_DATA *ProcessorVersion;\r | |
604 | EFI_PROCESSOR_CORE_FREQUENCY_DATA *ProcessorFrequency;\r | |
605 | EFI_MEMORY_ARRAY_START_ADDRESS_DATA *MemoryArray;\r | |
606 | BOOLEAN Find[5];\r | |
607 | \r | |
608 | ZeroMem (Find, sizeof (Find));\r | |
609 | \r | |
610 | //\r | |
611 | // Update Front Page strings\r | |
612 | //\r | |
613 | Status = gBS->LocateProtocol (\r | |
614 | &gEfiDataHubProtocolGuid,\r | |
615 | NULL,\r | |
616 | (VOID **) &DataHub\r | |
617 | );\r | |
618 | ASSERT_EFI_ERROR (Status);\r | |
619 | \r | |
620 | MonotonicCount = 0;\r | |
621 | Record = NULL;\r | |
622 | do {\r | |
623 | Status = DataHub->GetNextRecord (DataHub, &MonotonicCount, NULL, &Record);\r | |
624 | if (Record->DataRecordClass == EFI_DATA_RECORD_CLASS_DATA) {\r | |
625 | DataHeader = (EFI_SUBCLASS_TYPE1_HEADER *) (Record + 1);\r | |
626 | if (CompareGuid (&Record->DataRecordGuid, &gEfiMiscSubClassGuid) &&\r | |
627 | (DataHeader->RecordType == EFI_MISC_BIOS_VENDOR_RECORD_NUMBER)\r | |
628 | ) {\r | |
629 | BiosVendor = (EFI_MISC_BIOS_VENDOR_DATA *) (DataHeader + 1);\r | |
630 | GetProducerString (&Record->ProducerName, BiosVendor->BiosVersion, &NewString);\r | |
631 | TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION);\r | |
9226efe5 | 632 | HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);\r |
93e3992d | 633 | FreePool (NewString);\r |
634 | Find[0] = TRUE;\r | |
635 | }\r | |
636 | \r | |
637 | if (CompareGuid (&Record->DataRecordGuid, &gEfiMiscSubClassGuid) &&\r | |
638 | (DataHeader->RecordType == EFI_MISC_SYSTEM_MANUFACTURER_RECORD_NUMBER)\r | |
639 | ) {\r | |
640 | SystemManufacturer = (EFI_MISC_SYSTEM_MANUFACTURER_DATA *) (DataHeader + 1);\r | |
641 | GetProducerString (&Record->ProducerName, SystemManufacturer->SystemProductName, &NewString);\r | |
642 | TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL);\r | |
9226efe5 | 643 | HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);\r |
93e3992d | 644 | FreePool (NewString);\r |
645 | Find[1] = TRUE;\r | |
646 | }\r | |
647 | \r | |
648 | if (CompareGuid (&Record->DataRecordGuid, &gEfiProcessorSubClassGuid) &&\r | |
649 | (DataHeader->RecordType == ProcessorVersionRecordType)\r | |
650 | ) {\r | |
651 | ProcessorVersion = (EFI_PROCESSOR_VERSION_DATA *) (DataHeader + 1);\r | |
652 | GetProducerString (&Record->ProducerName, *ProcessorVersion, &NewString);\r | |
653 | TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL);\r | |
9226efe5 | 654 | HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);\r |
93e3992d | 655 | FreePool (NewString);\r |
656 | Find[2] = TRUE;\r | |
657 | }\r | |
658 | \r | |
659 | if (CompareGuid (&Record->DataRecordGuid, &gEfiProcessorSubClassGuid) &&\r | |
660 | (DataHeader->RecordType == ProcessorCoreFrequencyRecordType)\r | |
661 | ) {\r | |
662 | ProcessorFrequency = (EFI_PROCESSOR_CORE_FREQUENCY_DATA *) (DataHeader + 1);\r | |
663 | ConvertProcessorToString (ProcessorFrequency, &NewString);\r | |
664 | TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED);\r | |
9226efe5 | 665 | HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);\r |
93e3992d | 666 | FreePool (NewString);\r |
667 | Find[3] = TRUE;\r | |
668 | }\r | |
669 | \r | |
670 | if (CompareGuid (&Record->DataRecordGuid, &gEfiMemorySubClassGuid) &&\r | |
671 | (DataHeader->RecordType == EFI_MEMORY_ARRAY_START_ADDRESS_RECORD_NUMBER)\r | |
672 | ) {\r | |
673 | MemoryArray = (EFI_MEMORY_ARRAY_START_ADDRESS_DATA *) (DataHeader + 1);\r | |
674 | ConvertMemorySizeToString (\r | |
675 | (UINT32)(RShiftU64((MemoryArray->MemoryArrayEndAddress - MemoryArray->MemoryArrayStartAddress + 1), 20)),\r | |
676 | &NewString\r | |
677 | );\r | |
678 | TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE);\r | |
9226efe5 | 679 | HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);\r |
93e3992d | 680 | FreePool (NewString);\r |
681 | Find[4] = TRUE;\r | |
682 | }\r | |
683 | }\r | |
684 | } while (!EFI_ERROR (Status) && (MonotonicCount != 0) && !(Find[0] && Find[1] && Find[2] && Find[3] && Find[4]));\r | |
685 | \r | |
686 | return ;\r | |
687 | }\r | |
688 | \r | |
b30312ba | 689 | /**\r |
690 | Function waits for a given event to fire, or for an optional timeout to expire.\r | |
691 | \r | |
692 | \r | |
693 | @param Event The event to wait for\r | |
694 | \r | |
695 | @param Timeout An optional timeout value in 100 ns units.\r | |
696 | \r | |
697 | @retval EFI_SUCCESS Event fired before Timeout expired.\r | |
698 | @retval EFI_TIME_OUT Timout expired before Event fired..\r | |
699 | \r | |
700 | **/\r | |
93e3992d | 701 | EFI_STATUS\r |
702 | WaitForSingleEvent (\r | |
703 | IN EFI_EVENT Event,\r | |
704 | IN UINT64 Timeout OPTIONAL\r | |
705 | )\r | |
93e3992d | 706 | {\r |
707 | EFI_STATUS Status;\r | |
708 | UINTN Index;\r | |
709 | EFI_EVENT TimerEvent;\r | |
710 | EFI_EVENT WaitList[2];\r | |
711 | \r | |
f8d70995 | 712 | if (Timeout != 0) {\r |
93e3992d | 713 | //\r |
714 | // Create a timer event\r | |
715 | //\r | |
716 | Status = gBS->CreateEvent (EVT_TIMER, 0, NULL, NULL, &TimerEvent);\r | |
717 | if (!EFI_ERROR (Status)) {\r | |
718 | //\r | |
719 | // Set the timer event\r | |
720 | //\r | |
721 | gBS->SetTimer (\r | |
722 | TimerEvent,\r | |
723 | TimerRelative,\r | |
724 | Timeout\r | |
725 | );\r | |
726 | \r | |
727 | //\r | |
728 | // Wait for the original event or the timer\r | |
729 | //\r | |
730 | WaitList[0] = Event;\r | |
731 | WaitList[1] = TimerEvent;\r | |
732 | Status = gBS->WaitForEvent (2, WaitList, &Index);\r | |
733 | gBS->CloseEvent (TimerEvent);\r | |
734 | \r | |
735 | //\r | |
736 | // If the timer expired, change the return to timed out\r | |
737 | //\r | |
738 | if (!EFI_ERROR (Status) && Index == 1) {\r | |
739 | Status = EFI_TIMEOUT;\r | |
740 | }\r | |
741 | }\r | |
742 | } else {\r | |
743 | //\r | |
744 | // No timeout... just wait on the event\r | |
745 | //\r | |
746 | Status = gBS->WaitForEvent (1, &Event, &Index);\r | |
747 | ASSERT (!EFI_ERROR (Status));\r | |
748 | ASSERT (Index == 0);\r | |
749 | }\r | |
750 | \r | |
751 | return Status;\r | |
752 | }\r | |
753 | \r | |
b30312ba | 754 | /**\r |
93e3992d | 755 | Function show progress bar to wait for user input.\r |
756 | \r | |
93e3992d | 757 | \r |
b30312ba | 758 | @param TimeoutDefault - The fault time out value before the system\r |
759 | continue to boot.\r | |
93e3992d | 760 | \r |
b30312ba | 761 | @retval EFI_SUCCESS User pressed some key except "Enter"\r |
762 | @retval EFI_TIME_OUT Timout expired or user press "Enter"\r | |
763 | \r | |
764 | **/\r | |
765 | EFI_STATUS\r | |
766 | ShowProgress (\r | |
767 | IN UINT16 TimeoutDefault\r | |
768 | )\r | |
93e3992d | 769 | {\r |
770 | EFI_STATUS Status;\r | |
771 | CHAR16 *TmpStr;\r | |
772 | EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground;\r | |
773 | EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background;\r | |
774 | EFI_GRAPHICS_OUTPUT_BLT_PIXEL Color;\r | |
775 | EFI_INPUT_KEY Key;\r | |
776 | UINT16 TimeoutRemain;\r | |
777 | \r | |
778 | if (TimeoutDefault == 0) {\r | |
779 | return EFI_TIMEOUT;\r | |
780 | }\r | |
781 | \r | |
0fc82496 | 782 | DEBUG ((EFI_D_INFO, "\n\nStart showing progress bar... Press any key to stop it! ...Zzz....\n"));\r |
783 | \r | |
93e3992d | 784 | SetMem (&Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0xff);\r |
785 | SetMem (&Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0x0);\r | |
786 | SetMem (&Color, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0xff);\r | |
787 | \r | |
788 | //\r | |
789 | // Clear the progress status bar first\r | |
790 | //\r | |
791 | TmpStr = GetStringById (STRING_TOKEN (STR_START_BOOT_OPTION));\r | |
792 | if (TmpStr != NULL) {\r | |
793 | PlatformBdsShowProgress (Foreground, Background, TmpStr, Color, 0, 0);\r | |
794 | }\r | |
795 | \r | |
796 | TimeoutRemain = TimeoutDefault;\r | |
797 | while (TimeoutRemain != 0) {\r | |
0fc82496 | 798 | DEBUG ((EFI_D_INFO, "Showing progress bar...Remaining %d second!\n", TimeoutRemain));\r |
799 | \r | |
93e3992d | 800 | Status = WaitForSingleEvent (gST->ConIn->WaitForKey, ONE_SECOND);\r |
801 | if (Status != EFI_TIMEOUT) {\r | |
802 | break;\r | |
803 | }\r | |
804 | TimeoutRemain--;\r | |
805 | \r | |
806 | //\r | |
807 | // Show progress\r | |
808 | //\r | |
809 | if (TmpStr != NULL) {\r | |
810 | PlatformBdsShowProgress (\r | |
811 | Foreground,\r | |
812 | Background,\r | |
813 | TmpStr,\r | |
814 | Color,\r | |
815 | ((TimeoutDefault - TimeoutRemain) * 100 / TimeoutDefault),\r | |
816 | 0\r | |
817 | );\r | |
818 | }\r | |
819 | }\r | |
820 | gBS->FreePool (TmpStr);\r | |
821 | \r | |
822 | //\r | |
823 | // Timeout expired\r | |
824 | //\r | |
825 | if (TimeoutRemain == 0) {\r | |
826 | return EFI_TIMEOUT;\r | |
827 | }\r | |
828 | \r | |
829 | //\r | |
830 | // User pressed some key\r | |
831 | //\r | |
832 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
833 | if (EFI_ERROR (Status)) {\r | |
834 | return Status;\r | |
835 | }\r | |
836 | \r | |
837 | if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r | |
838 | //\r | |
839 | // User pressed enter, equivalent to select "continue"\r | |
840 | //\r | |
841 | return EFI_TIMEOUT;\r | |
842 | }\r | |
843 | \r | |
844 | return EFI_SUCCESS;\r | |
845 | }\r | |
846 | \r | |
b30312ba | 847 | /**\r |
93e3992d | 848 | This function is the main entry of the platform setup entry.\r |
849 | The function will present the main menu of the system setup,\r | |
850 | this is the platform reference part and can be customize.\r | |
851 | \r | |
93e3992d | 852 | \r |
b30312ba | 853 | @param TimeoutDefault - The fault time out value before the system\r |
854 | continue to boot.\r | |
855 | @param ConnectAllHappened - The indicater to check if the connect all have\r | |
856 | already happended.\r | |
93e3992d | 857 | \r |
b30312ba | 858 | @return VOID.\r |
859 | \r | |
860 | **/\r | |
861 | VOID\r | |
862 | PlatformBdsEnterFrontPage (\r | |
863 | IN UINT16 TimeoutDefault,\r | |
864 | IN BOOLEAN ConnectAllHappened\r | |
865 | )\r | |
93e3992d | 866 | {\r |
867 | EFI_STATUS Status;\r | |
868 | EFI_CONSOLE_CONTROL_PROTOCOL *ConsoleControl;\r | |
869 | \r | |
b3bac2c9 | 870 | PERF_START (0, "BdsTimeOut", "BDS", 0);\r |
93e3992d | 871 | //\r |
872 | // Indicate if we need connect all in the platform setup\r | |
873 | //\r | |
874 | if (ConnectAllHappened) {\r | |
875 | gConnectAllHappened = TRUE;\r | |
876 | }\r | |
877 | \r | |
878 | if (TimeoutDefault != 0xffff) {\r | |
93e3992d | 879 | Status = ShowProgress (TimeoutDefault);\r |
93e3992d | 880 | \r |
7bc5ca17 | 881 | //\r |
882 | // Ensure screen is clear when switch Console from Graphics mode to Text mode\r | |
883 | //\r | |
884 | gST->ConOut->EnableCursor (gST->ConOut, TRUE);\r | |
885 | gST->ConOut->ClearScreen (gST->ConOut);\r | |
886 | \r | |
93e3992d | 887 | if (EFI_ERROR (Status)) {\r |
888 | //\r | |
889 | // Timeout or user press enter to continue\r | |
890 | //\r | |
891 | goto Exit;\r | |
892 | }\r | |
893 | }\r | |
894 | \r | |
895 | do {\r | |
896 | \r | |
b30312ba | 897 | InitializeFrontPage (FALSE);\r |
93e3992d | 898 | \r |
899 | //\r | |
900 | // Update Front Page strings\r | |
901 | //\r | |
902 | UpdateFrontPageStrings ();\r | |
903 | \r | |
904 | gCallbackKey = 0;\r | |
93e3992d | 905 | Status = CallFrontPage ();\r |
93e3992d | 906 | \r |
907 | //\r | |
908 | // If gCallbackKey is greater than 1 and less or equal to 5,\r | |
909 | // it will lauch configuration utilities.\r | |
910 | // 2 = set language\r | |
911 | // 3 = boot manager\r | |
912 | // 4 = device manager\r | |
913 | // 5 = boot maintainenance manager\r | |
914 | //\r | |
915 | if (gCallbackKey != 0) {\r | |
916 | REPORT_STATUS_CODE (\r | |
917 | EFI_PROGRESS_CODE,\r | |
918 | (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_PC_USER_SETUP)\r | |
919 | );\r | |
920 | }\r | |
921 | //\r | |
922 | // Based on the key that was set, we can determine what to do\r | |
923 | //\r | |
924 | switch (gCallbackKey) {\r | |
925 | //\r | |
926 | // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can\r | |
927 | // describe to their customers in documentation how to find their setup information (namely\r | |
928 | // under the device manager and specific buckets)\r | |
929 | //\r | |
930 | // These entries consist of the Continue, Select language, Boot Manager, and Device Manager\r | |
931 | //\r | |
932 | case FRONT_PAGE_KEY_CONTINUE:\r | |
933 | //\r | |
934 | // User hit continue\r | |
935 | //\r | |
936 | break;\r | |
937 | \r | |
938 | case FRONT_PAGE_KEY_LANGUAGE:\r | |
939 | //\r | |
940 | // User made a language setting change - display front page again\r | |
941 | //\r | |
942 | break;\r | |
943 | \r | |
944 | case FRONT_PAGE_KEY_BOOT_MANAGER:\r | |
945 | //\r | |
946 | // User chose to run the Boot Manager\r | |
947 | //\r | |
948 | CallBootManager ();\r | |
949 | break;\r | |
950 | \r | |
951 | case FRONT_PAGE_KEY_DEVICE_MANAGER:\r | |
952 | //\r | |
953 | // Display the Device Manager\r | |
954 | //\r | |
955 | do {\r | |
956 | CallDeviceManager();\r | |
957 | } while (gCallbackKey == FRONT_PAGE_KEY_DEVICE_MANAGER);\r | |
958 | break;\r | |
959 | \r | |
960 | case FRONT_PAGE_KEY_BOOT_MAINTAIN:\r | |
961 | //\r | |
962 | // Display the Boot Maintenance Manager\r | |
963 | //\r | |
964 | BdsStartBootMaint ();\r | |
965 | break;\r | |
966 | }\r | |
967 | \r | |
968 | } while ((Status == EFI_SUCCESS) && (gCallbackKey != FRONT_PAGE_KEY_CONTINUE));\r | |
969 | \r | |
970 | //\r | |
971 | //Will leave browser, check any reset required change is applied? if yes, reset system\r | |
972 | //\r | |
93e3992d | 973 | SetupResetReminder ();\r |
93e3992d | 974 | \r |
975 | Exit:\r | |
976 | //\r | |
977 | // Automatically load current entry\r | |
978 | // Note: The following lines of code only execute when Auto boot\r | |
979 | // takes affect\r | |
980 | //\r | |
b3bac2c9 | 981 | PERF_END (0, "BdsTimeOut", "BDS", 0);\r |
93e3992d | 982 | Status = gBS->LocateProtocol (&gEfiConsoleControlProtocolGuid, NULL, (VOID **) &ConsoleControl);\r |
983 | ConsoleControl->SetMode (ConsoleControl, EfiConsoleControlScreenText);\r | |
984 | \r | |
985 | }\r |