1. Bug fix for "EDK GenericBds WriteBootToOsPerformanceData() uses AcpiReclaimMemory";
[mirror_edk2.git] / EdkModulePkg / Universal / UserInterface / SetupBrowser / Dxe / Ui.c
1 /*++
2
3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 Module Name:
13
14 Ui.c
15
16 Abstract:
17
18 Implementation for UI.
19
20 Revision History
21
22 --*/
23
24 #include "Setup.h"
25 #include "Ui.h"
26 #include "Colors.h"
27
28 //
29 // Implementation
30 //
31 VOID
32 SetUnicodeMem (
33 IN VOID *Buffer,
34 IN UINTN Size,
35 IN CHAR16 Value
36 )
37 /*++
38
39 Routine Description:
40
41 Set Buffer to Value for Size bytes.
42
43 Arguments:
44
45 Buffer - Memory to set.
46
47 Size - Number of bytes to set
48
49 Value - Value of the set operation.
50
51 Returns:
52
53 None
54
55 --*/
56 {
57 CHAR16 *Ptr;
58
59 Ptr = Buffer;
60 while (Size--) {
61 *(Ptr++) = Value;
62 }
63 }
64
65 VOID
66 UiInitMenu (
67 VOID
68 )
69 /*++
70
71 Routine Description:
72 Initialize Menu option list.
73
74 Arguments:
75
76 Returns:
77
78 --*/
79 {
80 InitializeListHead (&Menu);
81 }
82
83 VOID
84 UiInitMenuList (
85 VOID
86 )
87 /*++
88
89 Routine Description:
90 Initialize Menu option list.
91
92 Arguments:
93
94 Returns:
95
96 --*/
97 {
98 InitializeListHead (&gMenuList);
99 }
100
101 VOID
102 UiRemoveMenuListEntry (
103 IN UI_MENU_OPTION *Selection,
104 OUT UI_MENU_OPTION **PreviousSelection
105 )
106 /*++
107
108 Routine Description:
109 Remove Menu option list.
110
111 Arguments:
112
113 Returns:
114
115 --*/
116 {
117 UI_MENU_LIST *UiMenuList;
118
119 *PreviousSelection = AllocateZeroPool (sizeof (UI_MENU_OPTION));
120 ASSERT (*PreviousSelection != NULL);
121
122 if (!IsListEmpty (&gMenuList)) {
123 UiMenuList = CR (gMenuList.ForwardLink, UI_MENU_LIST, MenuLink, UI_MENU_LIST_SIGNATURE);
124 (*PreviousSelection)->IfrNumber = UiMenuList->Selection.IfrNumber;
125 (*PreviousSelection)->FormId = UiMenuList->Selection.FormId;
126 (*PreviousSelection)->Tags = UiMenuList->Selection.Tags;
127 (*PreviousSelection)->ThisTag = UiMenuList->Selection.ThisTag;
128 (*PreviousSelection)->Handle = UiMenuList->Selection.Handle;
129 gEntryNumber = UiMenuList->FormerEntryNumber;
130 RemoveEntryList (&UiMenuList->MenuLink);
131 gBS->FreePool (UiMenuList);
132 }
133 }
134
135 VOID
136 UiFreeMenuList (
137 VOID
138 )
139 /*++
140
141 Routine Description:
142 Free Menu option linked list.
143
144 Arguments:
145
146 Returns:
147
148 --*/
149 {
150 UI_MENU_LIST *UiMenuList;
151
152 while (!IsListEmpty (&gMenuList)) {
153 UiMenuList = CR (gMenuList.ForwardLink, UI_MENU_LIST, MenuLink, UI_MENU_LIST_SIGNATURE);
154 RemoveEntryList (&UiMenuList->MenuLink);
155 gBS->FreePool (UiMenuList);
156 }
157 }
158
159 VOID
160 UiAddMenuListEntry (
161 IN UI_MENU_OPTION *Selection
162 )
163 /*++
164
165 Routine Description:
166 Add one menu entry to the linked lst
167
168 Arguments:
169
170 Returns:
171
172 --*/
173 {
174 UI_MENU_LIST *UiMenuList;
175
176 UiMenuList = AllocateZeroPool (sizeof (UI_MENU_LIST));
177 ASSERT (UiMenuList != NULL);
178
179 UiMenuList->Signature = UI_MENU_LIST_SIGNATURE;
180 CopyMem (&UiMenuList->Selection, Selection, sizeof (UI_MENU_OPTION));
181
182 InsertHeadList (&gMenuList, &UiMenuList->MenuLink);
183 }
184
185 VOID
186 UiFreeMenu (
187 VOID
188 )
189 /*++
190
191 Routine Description:
192 Free Menu option linked list.
193
194 Arguments:
195
196 Returns:
197
198 --*/
199 {
200 UI_MENU_OPTION *MenuOption;
201
202 while (!IsListEmpty (&Menu)) {
203 MenuOption = CR (Menu.ForwardLink, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
204 RemoveEntryList (&MenuOption->Link);
205
206 //
207 // We allocated space for this description when we did a GetToken, free it here
208 //
209 gBS->FreePool (MenuOption->Description);
210 gBS->FreePool (MenuOption);
211 }
212 }
213
214 VOID
215 UpdateDateAndTime (
216 VOID
217 )
218 /*++
219
220 Routine Description:
221 Refresh screen with current date and/or time based on screen context
222
223 Arguments:
224
225 Returns:
226
227 --*/
228 {
229 CHAR16 *OptionString;
230 MENU_REFRESH_ENTRY *MenuRefreshEntry;
231 UINTN Index;
232 UINTN Loop;
233
234 OptionString = NULL;
235
236 if (gMenuRefreshHead != NULL) {
237
238 MenuRefreshEntry = gMenuRefreshHead;
239
240 do {
241 gST->ConOut->SetAttribute (gST->ConOut, MenuRefreshEntry->CurrentAttribute);
242 ProcessOptions (MenuRefreshEntry->MenuOption, FALSE, MenuRefreshEntry->FileFormTagsHead, NULL, &OptionString);
243
244 if (OptionString != NULL) {
245 //
246 // If leading spaces on OptionString - remove the spaces
247 //
248 for (Index = 0; OptionString[Index] == L' '; Index++)
249 ;
250
251 for (Loop = 0; OptionString[Index] != CHAR_NULL; Index++) {
252 OptionString[Loop] = OptionString[Index];
253 Loop++;
254 }
255
256 OptionString[Loop] = CHAR_NULL;
257
258 PrintStringAt (MenuRefreshEntry->CurrentColumn, MenuRefreshEntry->CurrentRow, OptionString);
259 }
260
261 MenuRefreshEntry = MenuRefreshEntry->Next;
262
263 } while (MenuRefreshEntry != NULL);
264 }
265
266 if (OptionString != NULL) {
267 gBS->FreePool (OptionString);
268 }
269 }
270
271 EFI_STATUS
272 UiWaitForSingleEvent (
273 IN EFI_EVENT Event,
274 IN UINT64 Timeout OPTIONAL
275 )
276 /*++
277
278 Routine Description:
279 Wait for a given event to fire, or for an optional timeout to expire.
280
281 Arguments:
282 Event - The event to wait for
283
284 Timeout - An optional timeout value in 100 ns units.
285
286 Returns:
287
288 EFI_SUCCESS - Event fired before Timeout expired.
289 EFI_TIME_OUT - Timout expired before Event fired.
290
291 --*/
292 {
293 EFI_STATUS Status;
294 UINTN Index;
295 EFI_EVENT TimerEvent;
296 EFI_EVENT WaitList[2];
297
298 if (Timeout) {
299 //
300 // Create a timer event
301 //
302 Status = gBS->CreateEvent (EFI_EVENT_TIMER, 0, NULL, NULL, &TimerEvent);
303 if (!EFI_ERROR (Status)) {
304 //
305 // Set the timer event
306 //
307 gBS->SetTimer (
308 TimerEvent,
309 TimerRelative,
310 Timeout
311 );
312
313 //
314 // Wait for the original event or the timer
315 //
316 WaitList[0] = Event;
317 WaitList[1] = TimerEvent;
318 Status = gBS->WaitForEvent (2, WaitList, &Index);
319 gBS->CloseEvent (TimerEvent);
320
321 //
322 // If the timer expired, change the return to timed out
323 //
324 if (!EFI_ERROR (Status) && Index == 1) {
325 Status = EFI_TIMEOUT;
326 }
327 }
328 } else {
329 //
330 // Update screen every second
331 //
332 Timeout = ONE_SECOND;
333
334 do {
335 Status = gBS->CreateEvent (EFI_EVENT_TIMER, 0, NULL, NULL, &TimerEvent);
336
337 //
338 // Set the timer event
339 //
340 gBS->SetTimer (
341 TimerEvent,
342 TimerRelative,
343 Timeout
344 );
345
346 //
347 // Wait for the original event or the timer
348 //
349 WaitList[0] = Event;
350 WaitList[1] = TimerEvent;
351 Status = gBS->WaitForEvent (2, WaitList, &Index);
352
353 //
354 // If the timer expired, update anything that needs a refresh and keep waiting
355 //
356 if (!EFI_ERROR (Status) && Index == 1) {
357 Status = EFI_TIMEOUT;
358 UpdateDateAndTime ();
359 }
360
361 gBS->CloseEvent (TimerEvent);
362 } while (Status == EFI_TIMEOUT);
363 }
364
365 return Status;
366 }
367
368 VOID
369 UiAddMenuOption (
370 IN CHAR16 *String,
371 IN EFI_HII_HANDLE Handle,
372 IN EFI_TAG *Tags,
373 IN VOID *FormBinary,
374 IN UINTN IfrNumber
375 )
376 /*++
377
378 Routine Description:
379 Add one menu option by specified description and context.
380
381 Arguments:
382 String - String description for this option.
383 Context - Context data for entry.
384
385 Returns:
386
387 --*/
388 {
389 UI_MENU_OPTION *MenuOption;
390
391 MenuOption = AllocateZeroPool (sizeof (UI_MENU_OPTION));
392 ASSERT (MenuOption);
393
394 MenuOption->Signature = UI_MENU_OPTION_SIGNATURE;
395 MenuOption->Description = String;
396 MenuOption->Handle = Handle;
397 MenuOption->FormBinary = FormBinary;
398 MenuOption->IfrNumber = IfrNumber;
399 MenuOption->Skip = 1;
400 MenuOption->Tags = Tags;
401 MenuOption->TagIndex = 0;
402 MenuOption->ThisTag = &(MenuOption->Tags[MenuOption->TagIndex]);
403 MenuOption->EntryNumber = (UINT16) IfrNumber;
404
405 InsertTailList (&Menu, &MenuOption->Link);
406 }
407
408 VOID
409 UiAddSubMenuOption (
410 IN CHAR16 *String,
411 IN EFI_HII_HANDLE Handle,
412 IN EFI_TAG *Tags,
413 IN UINTN TagIndex,
414 IN UINT16 FormId,
415 IN UINT16 MenuItemCount
416 )
417 /*++
418
419 Routine Description:
420 Add one menu option by specified description and context.
421
422 Arguments:
423 String - String description for this option.
424 Context - Context data for entry.
425
426 Returns:
427
428 --*/
429 {
430 UI_MENU_OPTION *MenuOption;
431
432 MenuOption = AllocateZeroPool (sizeof (UI_MENU_OPTION));
433 ASSERT (MenuOption);
434
435 MenuOption->Signature = UI_MENU_OPTION_SIGNATURE;
436 MenuOption->Description = String;
437 MenuOption->Handle = Handle;
438 MenuOption->Skip = Tags[TagIndex].NumberOfLines;
439 MenuOption->IfrNumber = gActiveIfr;
440 MenuOption->Tags = Tags;
441 MenuOption->TagIndex = TagIndex;
442 MenuOption->ThisTag = &(MenuOption->Tags[MenuOption->TagIndex]);
443 MenuOption->Consistency = Tags[TagIndex].Consistency;
444 MenuOption->FormId = FormId;
445 MenuOption->GrayOut = Tags[TagIndex].GrayOut;
446 MenuOption->EntryNumber = MenuItemCount;
447
448 InsertTailList (&Menu, &MenuOption->Link);
449 }
450
451 EFI_STATUS
452 CreateDialog (
453 IN UINTN NumberOfLines,
454 IN BOOLEAN HotKey,
455 IN UINTN MaximumStringSize,
456 OUT CHAR16 *StringBuffer,
457 OUT EFI_INPUT_KEY *KeyValue,
458 IN CHAR16 *String,
459 ...
460 )
461 /*++
462
463 Routine Description:
464 Routine used to abstract a generic dialog interface and return the selected key or string
465
466 Arguments:
467 NumberOfLines - The number of lines for the dialog box
468 HotKey - Defines whether a single character is parsed (TRUE) and returned in KeyValue
469 or a string is returned in StringBuffer. Two special characters are considered when entering a string, a SCAN_ESC and
470 an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates string input and returns
471 MaximumStringSize - The maximum size in bytes of a typed in string (each character is a CHAR16) and the minimum string returned is two bytes
472 StringBuffer - The passed in pointer to the buffer which will hold the typed in string if HotKey is FALSE
473 KeyValue - The EFI_KEY value returned if HotKey is TRUE..
474 String - Pointer to the first string in the list
475 ... - A series of (quantity == NumberOfLines) text strings which will be used to construct the dialog box
476
477 Returns:
478 EFI_SUCCESS - Displayed dialog and received user interaction
479 EFI_INVALID_PARAMETER - One of the parameters was invalid (e.g. (StringBuffer == NULL) && (HotKey == FALSE))
480 EFI_DEVICE_ERROR - User typed in an ESC character to exit the routine
481
482 --*/
483 {
484 VA_LIST Marker;
485 UINTN Count;
486 EFI_INPUT_KEY Key;
487 UINTN LargestString;
488 CHAR16 *TempString;
489 CHAR16 *BufferedString;
490 CHAR16 *StackString;
491 CHAR16 KeyPad[2];
492 UINTN Start;
493 UINTN Top;
494 UINTN Index;
495 EFI_STATUS Status;
496 BOOLEAN SelectionComplete;
497 UINTN InputOffset;
498 UINTN CurrentAttribute;
499 UINTN DimensionsWidth;
500 UINTN DimensionsHeight;
501
502 DimensionsWidth = gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn;
503 DimensionsHeight = gScreenDimensions.BottomRow - gScreenDimensions.TopRow;
504
505 SelectionComplete = FALSE;
506 InputOffset = 0;
507 TempString = AllocateZeroPool (MaximumStringSize * 2);
508 BufferedString = AllocateZeroPool (MaximumStringSize * 2);
509 CurrentAttribute = gST->ConOut->Mode->Attribute;
510
511 ASSERT (TempString);
512 ASSERT (BufferedString);
513
514 VA_START (Marker, String);
515
516 //
517 // Zero the outgoing buffer
518 //
519 ZeroMem (StringBuffer, MaximumStringSize);
520
521 if (HotKey) {
522 if (KeyValue == NULL) {
523 return EFI_INVALID_PARAMETER;
524 }
525 } else {
526 if (StringBuffer == NULL) {
527 return EFI_INVALID_PARAMETER;
528 }
529 }
530 //
531 // Disable cursor
532 //
533 gST->ConOut->EnableCursor (gST->ConOut, FALSE);
534
535 LargestString = (GetStringWidth (String) / 2);
536
537 if (LargestString == L' ') {
538 InputOffset = 1;
539 }
540 //
541 // Determine the largest string in the dialog box
542 // Notice we are starting with 1 since String is the first string
543 //
544 for (Count = 1; Count < NumberOfLines; Count++) {
545 StackString = VA_ARG (Marker, CHAR16 *);
546
547 if (StackString[0] == L' ') {
548 InputOffset = Count + 1;
549 }
550
551 if ((GetStringWidth (StackString) / 2) > LargestString) {
552 //
553 // Size of the string visually and subtract the width by one for the null-terminator
554 //
555 LargestString = (GetStringWidth (StackString) / 2);
556 }
557 }
558
559 Start = (DimensionsWidth - LargestString - 2) / 2 + gScreenDimensions.LeftColumn + 1;
560 Top = ((DimensionsHeight - NumberOfLines - 2) / 2) + gScreenDimensions.TopRow - 1;
561
562 Count = 0;
563
564 //
565 // Display the Popup
566 //
567 CreateSharedPopUp (LargestString, NumberOfLines, &String);
568
569 //
570 // Take the first key typed and report it back?
571 //
572 if (HotKey) {
573 Status = WaitForKeyStroke (&Key);
574 CopyMem (KeyValue, &Key, sizeof (EFI_INPUT_KEY));
575
576 } else {
577 do {
578 Status = WaitForKeyStroke (&Key);
579
580 switch (Key.UnicodeChar) {
581 case CHAR_NULL:
582 switch (Key.ScanCode) {
583 case SCAN_ESC:
584 gBS->FreePool (TempString);
585 gBS->FreePool (BufferedString);
586 gST->ConOut->SetAttribute (gST->ConOut, CurrentAttribute);
587 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
588 return EFI_DEVICE_ERROR;
589
590 default:
591 break;
592 }
593
594 break;
595
596 case CHAR_CARRIAGE_RETURN:
597 SelectionComplete = TRUE;
598 gBS->FreePool (TempString);
599 gBS->FreePool (BufferedString);
600 gST->ConOut->SetAttribute (gST->ConOut, CurrentAttribute);
601 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
602 return EFI_SUCCESS;
603 break;
604
605 case CHAR_BACKSPACE:
606 if (StringBuffer[0] != CHAR_NULL) {
607 for (Index = 0; StringBuffer[Index] != CHAR_NULL; Index++) {
608 TempString[Index] = StringBuffer[Index];
609 }
610 //
611 // Effectively truncate string by 1 character
612 //
613 TempString[Index - 1] = CHAR_NULL;
614 StrCpy (StringBuffer, TempString);
615 }
616
617 default:
618 //
619 // If it is the beginning of the string, don't worry about checking maximum limits
620 //
621 if ((StringBuffer[0] == CHAR_NULL) && (Key.UnicodeChar != CHAR_BACKSPACE)) {
622 StrnCpy (StringBuffer, &Key.UnicodeChar, 1);
623 StrnCpy (TempString, &Key.UnicodeChar, 1);
624 } else if ((GetStringWidth (StringBuffer) < MaximumStringSize) && (Key.UnicodeChar != CHAR_BACKSPACE)) {
625 KeyPad[0] = Key.UnicodeChar;
626 KeyPad[1] = CHAR_NULL;
627 StrCat (StringBuffer, KeyPad);
628 StrCat (TempString, KeyPad);
629 }
630 //
631 // If the width of the input string is now larger than the screen, we nee to
632 // adjust the index to start printing portions of the string
633 //
634 SetUnicodeMem (BufferedString, LargestString, L' ');
635
636 PrintStringAt (Start + 1, Top + InputOffset, BufferedString);
637
638 if ((GetStringWidth (StringBuffer) / 2) > (DimensionsWidth - 2)) {
639 Index = (GetStringWidth (StringBuffer) / 2) - DimensionsWidth + 2;
640 } else {
641 Index = 0;
642 }
643
644 for (Count = 0; Index + 1 < GetStringWidth (StringBuffer) / 2; Index++, Count++) {
645 BufferedString[Count] = StringBuffer[Index];
646 }
647
648 PrintStringAt (Start + 1, Top + InputOffset, BufferedString);
649 break;
650 }
651 } while (!SelectionComplete);
652 }
653
654 gST->ConOut->SetAttribute (gST->ConOut, CurrentAttribute);
655 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
656 return EFI_SUCCESS;
657 }
658
659 VOID
660 CreateSharedPopUp (
661 IN UINTN RequestedWidth,
662 IN UINTN NumberOfLines,
663 IN CHAR16 **ArrayOfStrings
664 )
665 {
666 UINTN Index;
667 UINTN Count;
668 CHAR16 Character;
669 UINTN Start;
670 UINTN End;
671 UINTN Top;
672 UINTN Bottom;
673 CHAR16 *String;
674
675 UINTN DimensionsWidth;
676 UINTN DimensionsHeight;
677
678 DimensionsWidth = gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn;
679 DimensionsHeight = gScreenDimensions.BottomRow - gScreenDimensions.TopRow;
680
681 Count = 0;
682
683 gST->ConOut->SetAttribute (gST->ConOut, POPUP_TEXT | POPUP_BACKGROUND);
684
685 if ((RequestedWidth + 2) > DimensionsWidth) {
686 RequestedWidth = DimensionsWidth - 2;
687 }
688 //
689 // Subtract the PopUp width from total Columns, allow for one space extra on
690 // each end plus a border.
691 //
692 Start = (DimensionsWidth - RequestedWidth - 2) / 2 + gScreenDimensions.LeftColumn + 1;
693 End = Start + RequestedWidth + 1;
694
695 Top = ((DimensionsHeight - NumberOfLines - 2) / 2) + gScreenDimensions.TopRow - 1;
696 Bottom = Top + NumberOfLines + 2;
697
698 Character = (CHAR16) BOXDRAW_DOWN_RIGHT;
699 PrintCharAt (Start, Top, Character);
700 Character = (CHAR16) BOXDRAW_HORIZONTAL;
701 for (Index = Start; Index + 2 < End; Index++) {
702 PrintChar (Character);
703 }
704
705 Character = (CHAR16) BOXDRAW_DOWN_LEFT;
706 PrintChar (Character);
707 Character = (CHAR16) BOXDRAW_VERTICAL;
708 for (Index = Top; Index + 2 < Bottom; Index++) {
709 String = ArrayOfStrings[Count];
710 Count++;
711
712 //
713 // This will clear the background of the line - we never know who might have been
714 // here before us. This differs from the next clear in that it used the non-reverse
715 // video for normal printing.
716 //
717 if (GetStringWidth (String) / 2 > 1) {
718 ClearLines (Start, End, Index + 1, Index + 1, POPUP_TEXT | POPUP_BACKGROUND);
719 }
720 //
721 // Passing in a space results in the assumption that this is where typing will occur
722 //
723 if (String[0] == L' ') {
724 ClearLines (Start + 1, End - 1, Index + 1, Index + 1, POPUP_INVERSE_TEXT | POPUP_INVERSE_BACKGROUND);
725 }
726 //
727 // Passing in a NULL results in a blank space
728 //
729 if (String[0] == CHAR_NULL) {
730 ClearLines (Start, End, Index + 1, Index + 1, POPUP_TEXT | POPUP_BACKGROUND);
731 }
732
733 PrintStringAt (
734 ((DimensionsWidth - GetStringWidth (String) / 2) / 2) + gScreenDimensions.LeftColumn + 1,
735 Index + 1,
736 String
737 );
738 gST->ConOut->SetAttribute (gST->ConOut, POPUP_TEXT | POPUP_BACKGROUND);
739 PrintCharAt (Start, Index + 1, Character);
740 PrintCharAt (End - 1, Index + 1, Character);
741 }
742
743 Character = (CHAR16) BOXDRAW_UP_RIGHT;
744 PrintCharAt (Start, Bottom - 1, Character);
745 Character = (CHAR16) BOXDRAW_HORIZONTAL;
746 for (Index = Start; Index + 2 < End; Index++) {
747 PrintChar (Character);
748 }
749
750 Character = (CHAR16) BOXDRAW_UP_LEFT;
751 PrintChar (Character);
752 }
753
754 VOID
755 CreatePopUp (
756 IN UINTN RequestedWidth,
757 IN UINTN NumberOfLines,
758 IN CHAR16 *ArrayOfStrings,
759 ...
760 )
761 {
762 CreateSharedPopUp (RequestedWidth, NumberOfLines, &ArrayOfStrings);
763 }
764
765 VOID
766 UpdateStatusBar (
767 IN UINTN MessageType,
768 IN UINT8 Flags,
769 IN BOOLEAN State
770 )
771 {
772 UINTN Index;
773 STATIC BOOLEAN InputError;
774 CHAR16 *NvUpdateMessage;
775 CHAR16 *InputErrorMessage;
776
777 NvUpdateMessage = GetToken (STRING_TOKEN (NV_UPDATE_MESSAGE), gHiiHandle);
778 InputErrorMessage = GetToken (STRING_TOKEN (INPUT_ERROR_MESSAGE), gHiiHandle);
779
780 switch (MessageType) {
781 case INPUT_ERROR:
782 if (State) {
783 gST->ConOut->SetAttribute (gST->ConOut, ERROR_TEXT);
784 PrintStringAt (
785 gScreenDimensions.LeftColumn + gPromptBlockWidth,
786 gScreenDimensions.BottomRow - 1,
787 InputErrorMessage
788 );
789 InputError = TRUE;
790 } else {
791 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT_HIGHLIGHT);
792 for (Index = 0; Index < (GetStringWidth (InputErrorMessage) - 2) / 2; Index++) {
793 PrintAt (gScreenDimensions.LeftColumn + gPromptBlockWidth + Index, gScreenDimensions.BottomRow - 1, (CHAR16 *) L" ");
794 }
795
796 InputError = FALSE;
797 }
798 break;
799
800 case NV_UPDATE_REQUIRED:
801 if (gClassOfVfr != EFI_FRONT_PAGE_SUBCLASS) {
802 if (State) {
803 gST->ConOut->SetAttribute (gST->ConOut, INFO_TEXT);
804 PrintStringAt (
805 gScreenDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth,
806 gScreenDimensions.BottomRow - 1,
807 NvUpdateMessage
808 );
809 gResetRequired = (BOOLEAN) (gResetRequired | ((Flags & EFI_IFR_FLAG_RESET_REQUIRED) == EFI_IFR_FLAG_RESET_REQUIRED));
810
811 gNvUpdateRequired = TRUE;
812 } else {
813 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT_HIGHLIGHT);
814 for (Index = 0; Index < (GetStringWidth (NvUpdateMessage) - 2) / 2; Index++) {
815 PrintAt (
816 (gScreenDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + Index),
817 gScreenDimensions.BottomRow - 1,
818 (CHAR16 *) L" "
819 );
820 }
821
822 gNvUpdateRequired = FALSE;
823 }
824 }
825 break;
826
827 case REFRESH_STATUS_BAR:
828 if (InputError) {
829 UpdateStatusBar (INPUT_ERROR, Flags, TRUE);
830 }
831
832 if (gNvUpdateRequired) {
833 UpdateStatusBar (NV_UPDATE_REQUIRED, Flags, TRUE);
834 }
835 break;
836
837 default:
838 break;
839 }
840
841 gBS->FreePool (InputErrorMessage);
842 gBS->FreePool (NvUpdateMessage);
843 return ;
844 }
845
846 VOID
847 FreeData (
848 IN EFI_FILE_FORM_TAGS *FileFormTagsHead,
849 IN CHAR16 *FormattedString,
850 IN CHAR16 *OptionString
851 )
852 /*++
853
854 Routine Description:
855
856 Used to remove the allocated data instances
857
858 Arguments:
859
860 Returns:
861
862 --*/
863 {
864 EFI_FILE_FORM_TAGS *FileForm;
865 EFI_FILE_FORM_TAGS *PreviousFileForm;
866 EFI_FORM_TAGS *FormTags;
867 EFI_FORM_TAGS *PreviousFormTags;
868 EFI_IFR_BINARY *IfrBinary;
869 EFI_IFR_BINARY *PreviousIfrBinary;
870 EFI_INCONSISTENCY_DATA *Inconsistent;
871 EFI_VARIABLE_DEFINITION *VariableDefinition;
872 EFI_VARIABLE_DEFINITION *PreviousVariableDefinition;
873 VOID *Buffer;
874 UINTN Index;
875
876 FileForm = FileFormTagsHead;
877
878 if (FormattedString != NULL) {
879 gBS->FreePool (FormattedString);
880 }
881
882 if (OptionString != NULL) {
883 gBS->FreePool (OptionString);
884 }
885
886 for (; FileForm != NULL;) {
887 PreviousFileForm = NULL;
888
889 //
890 // Advance FileForm to the last entry
891 //
892 for (; FileForm->NextFile != NULL; FileForm = FileForm->NextFile) {
893 PreviousFileForm = FileForm;
894 }
895
896 FormTags = &FileForm->FormTags;
897
898 for (; FormTags != NULL;) {
899 FormTags = &FileForm->FormTags;
900 PreviousFormTags = NULL;
901
902 //
903 // Advance FormTags to the last entry
904 //
905 for (; FormTags->Next != NULL; FormTags = FormTags->Next) {
906 PreviousFormTags = FormTags;
907 }
908 //
909 // Walk through each of the tags and free the IntList allocation
910 //
911 for (Index = 0; FormTags->Tags[Index].Operand != EFI_IFR_END_FORM_OP; Index++) {
912 //
913 // It is more than likely that the very last page will contain an end formset
914 //
915 if (FormTags->Tags[Index].Operand == EFI_IFR_END_FORM_SET_OP) {
916 break;
917 }
918
919 if (FormTags->Tags[Index].IntList != NULL) {
920 gBS->FreePool (FormTags->Tags[Index].IntList);
921 }
922 }
923
924 if (PreviousFormTags != NULL) {
925 gBS->FreePool (FormTags->Tags);
926 FormTags = PreviousFormTags;
927 gBS->FreePool (FormTags->Next);
928 FormTags->Next = NULL;
929 } else {
930 gBS->FreePool (FormTags->Tags);
931 FormTags = NULL;
932 }
933 }
934 //
935 // Last FileForm entry's Inconsistent database
936 //
937 Inconsistent = FileForm->InconsistentTags;
938
939 //
940 // Advance Inconsistent to the last entry
941 //
942 for (; Inconsistent->Next != NULL; Inconsistent = Inconsistent->Next)
943 ;
944
945 for (; Inconsistent != NULL;) {
946 //
947 // Preserve the Previous pointer
948 //
949 Buffer = (VOID *) Inconsistent->Previous;
950
951 //
952 // Free the current entry
953 //
954 gBS->FreePool (Inconsistent);
955
956 //
957 // Restore the Previous pointer
958 //
959 Inconsistent = (EFI_INCONSISTENCY_DATA *) Buffer;
960 }
961
962 VariableDefinition = FileForm->VariableDefinitions;
963
964 for (; VariableDefinition != NULL;) {
965 VariableDefinition = FileForm->VariableDefinitions;
966 PreviousVariableDefinition = NULL;
967
968 //
969 // Advance VariableDefinitions to the last entry
970 //
971 for (; VariableDefinition->Next != NULL; VariableDefinition = VariableDefinition->Next) {
972 PreviousVariableDefinition = VariableDefinition;
973 }
974
975 gBS->FreePool (VariableDefinition->VariableName);
976 gBS->FreePool (VariableDefinition->NvRamMap);
977 gBS->FreePool (VariableDefinition->FakeNvRamMap);
978
979 if (PreviousVariableDefinition != NULL) {
980 VariableDefinition = PreviousVariableDefinition;
981 gBS->FreePool (VariableDefinition->Next);
982 VariableDefinition->Next = NULL;
983 } else {
984 gBS->FreePool (VariableDefinition);
985 VariableDefinition = NULL;
986 }
987 }
988
989 if (PreviousFileForm != NULL) {
990 FileForm = PreviousFileForm;
991 gBS->FreePool (FileForm->NextFile);
992 FileForm->NextFile = NULL;
993 } else {
994 gBS->FreePool (FileForm);
995 FileForm = NULL;
996 }
997 }
998
999 IfrBinary = gBinaryDataHead;
1000
1001 for (; IfrBinary != NULL;) {
1002 IfrBinary = gBinaryDataHead;
1003 PreviousIfrBinary = NULL;
1004
1005 //
1006 // Advance IfrBinary to the last entry
1007 //
1008 for (; IfrBinary->Next != NULL; IfrBinary = IfrBinary->Next) {
1009 PreviousIfrBinary = IfrBinary;
1010 }
1011
1012 gBS->FreePool (IfrBinary->IfrPackage);
1013
1014 if (PreviousIfrBinary != NULL) {
1015 IfrBinary = PreviousIfrBinary;
1016 gBS->FreePool (IfrBinary->Next);
1017 IfrBinary->Next = NULL;
1018 } else {
1019 gBS->FreePool (IfrBinary);
1020 IfrBinary = NULL;
1021 }
1022 }
1023
1024 gBS->FreePool (gPreviousValue);
1025 gPreviousValue = NULL;
1026
1027 //
1028 // Free Browser Strings
1029 //
1030 gBS->FreePool (gPressEnter);
1031 gBS->FreePool (gConfirmError);
1032 gBS->FreePool (gConfirmPassword);
1033 gBS->FreePool (gPromptForNewPassword);
1034 gBS->FreePool (gPromptForPassword);
1035 gBS->FreePool (gToggleCheckBox);
1036 gBS->FreePool (gNumericInput);
1037 gBS->FreePool (gMakeSelection);
1038 gBS->FreePool (gMoveHighlight);
1039 gBS->FreePool (gEscapeString);
1040 gBS->FreePool (gEnterCommitString);
1041 gBS->FreePool (gEnterString);
1042 gBS->FreePool (gFunctionOneString);
1043 gBS->FreePool (gFunctionTwoString);
1044 gBS->FreePool (gFunctionNineString);
1045 gBS->FreePool (gFunctionTenString);
1046 return ;
1047 }
1048
1049 BOOLEAN
1050 SelectionsAreValid (
1051 IN UI_MENU_OPTION *MenuOption,
1052 IN EFI_FILE_FORM_TAGS *FileFormTagsHead
1053 )
1054 /*++
1055
1056 Routine Description:
1057 Initiate late consistency checks against the current page.
1058
1059 Arguments:
1060 None
1061
1062 Returns:
1063
1064 --*/
1065 {
1066 LIST_ENTRY *Link;
1067 EFI_TAG *Tag;
1068 EFI_FILE_FORM_TAGS *FileFormTags;
1069 CHAR16 *StringPtr;
1070 CHAR16 NullCharacter;
1071 EFI_STATUS Status;
1072 UINTN Index;
1073 UINT16 *NvRamMap;
1074 STRING_REF PopUp;
1075 EFI_INPUT_KEY Key;
1076 EFI_VARIABLE_DEFINITION *VariableDefinition;
1077
1078 StringPtr = (CHAR16 *) L"\0";
1079 NullCharacter = CHAR_NULL;
1080
1081 FileFormTags = FileFormTagsHead;
1082
1083 for (Index = 0; Index < MenuOption->IfrNumber; Index++) {
1084 FileFormTags = FileFormTags->NextFile;
1085 }
1086
1087 for (Link = Menu.ForwardLink; Link != &Menu; Link = Link->ForwardLink) {
1088 MenuOption = CR (Link, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
1089
1090 Tag = MenuOption->ThisTag;
1091
1092 ExtractRequestedNvMap (FileFormTags, Tag->VariableNumber, &VariableDefinition);
1093 NvRamMap = (UINT16 *) &VariableDefinition->NvRamMap[Tag->StorageStart];
1094
1095 //
1096 // If the op-code has a late check, ensure consistency checks are now applied
1097 //
1098 if (Tag->Flags & EFI_IFR_FLAG_LATE_CHECK) {
1099 if (ValueIsNotValid (TRUE, 0, Tag, FileFormTags, &PopUp)) {
1100 if (PopUp != 0x0000) {
1101 StringPtr = GetToken (PopUp, MenuOption->Handle);
1102
1103 CreatePopUp (GetStringWidth (StringPtr) / 2, 3, &NullCharacter, StringPtr, &NullCharacter);
1104
1105 do {
1106 Status = WaitForKeyStroke (&Key);
1107
1108 switch (Key.UnicodeChar) {
1109
1110 case CHAR_CARRIAGE_RETURN:
1111 //
1112 // Since the value can be one byte long or two bytes long, do a CopyMem based on StorageWidth
1113 //
1114 CopyMem (NvRamMap, &Tag->OldValue, Tag->StorageWidth);
1115 gBS->FreePool (StringPtr);
1116 break;
1117
1118 default:
1119 break;
1120 }
1121 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
1122 }
1123
1124 return FALSE;
1125 }
1126 }
1127 }
1128
1129 return TRUE;
1130 }
1131
1132 UINT16
1133 GetWidth (
1134 IN EFI_TAG *Tag,
1135 IN EFI_HII_HANDLE Handle
1136 )
1137 /*++
1138
1139 Routine Description:
1140 Get the supported width for a particular op-code
1141
1142 Arguments:
1143 Tag - The Tag structure passed in.
1144 Handle - The handle in the HII database being used
1145
1146 Returns:
1147 Returns the number of CHAR16 characters that is support.
1148
1149
1150 --*/
1151 {
1152 CHAR16 *String;
1153 UINTN Size;
1154
1155 Size = 0x00;
1156
1157 //
1158 // See if the second text parameter is really NULL
1159 //
1160 if ((Tag->Operand == EFI_IFR_TEXT_OP) && (Tag->TextTwo != 0)) {
1161 String = GetToken (Tag->TextTwo, Handle);
1162 Size = StrLen (String);
1163 gBS->FreePool (String);
1164 }
1165
1166 if ((Tag->Operand == EFI_IFR_SUBTITLE_OP) ||
1167 (Tag->Operand == EFI_IFR_REF_OP) ||
1168 (Tag->Operand == EFI_IFR_PASSWORD_OP) ||
1169 (Tag->Operand == EFI_IFR_STRING_OP) ||
1170 (Tag->Operand == EFI_IFR_INVENTORY_OP) ||
1171 //
1172 // Allow a wide display if text op-code and no secondary text op-code
1173 //
1174 ((Tag->Operand == EFI_IFR_TEXT_OP) && (Size == 0x0000))
1175 ) {
1176 return (UINT16) (gPromptBlockWidth + gOptionBlockWidth);
1177 } else {
1178 return (UINT16) gPromptBlockWidth;
1179 }
1180 }
1181
1182 UINT16
1183 GetLineByWidth (
1184 IN CHAR16 *InputString,
1185 IN UINT16 LineWidth,
1186 IN OUT UINTN *Index,
1187 OUT CHAR16 **OutputString
1188 )
1189 /*++
1190
1191 Routine Description:
1192 Will copy LineWidth amount of a string in the OutputString buffer and return the
1193 number of CHAR16 characters that were copied into the OutputString buffer.
1194
1195 Arguments:
1196 InputString - String description for this option.
1197 LineWidth - Width of the desired string to extract in CHAR16 characters
1198 Index - Where in InputString to start the copy process
1199 OutputString - Buffer to copy the string into
1200
1201 Returns:
1202 Returns the number of CHAR16 characters that were copied into the OutputString buffer.
1203
1204
1205 --*/
1206 {
1207 static BOOLEAN Finished;
1208 UINT16 Count;
1209 UINT16 Count2;
1210
1211 if (Finished) {
1212 Finished = FALSE;
1213 return (UINT16) 0;
1214 }
1215
1216 Count = LineWidth;
1217 Count2 = 0;
1218
1219 *OutputString = AllocateZeroPool (((UINTN) (LineWidth + 1) * 2));
1220
1221 //
1222 // Ensure we have got a valid buffer
1223 //
1224 if (*OutputString != NULL) {
1225
1226 //
1227 //NARROW_CHAR can not be printed in screen, so if a line only contain the two CHARs: 'NARROW_CHAR + CHAR_CARRIAGE_RETURN' , it is a empty line in Screen.
1228 //To avoid displaying this empty line in screen, just skip the two CHARs here.
1229 //
1230 if ((InputString[*Index] == NARROW_CHAR) && (InputString[*Index + 1] == CHAR_CARRIAGE_RETURN)) {
1231 *Index = *Index + 2;
1232 }
1233
1234 //
1235 // Fast-forward the string and see if there is a carriage-return in the string
1236 //
1237 for (; (InputString[*Index + Count2] != CHAR_CARRIAGE_RETURN) && (Count2 != LineWidth); Count2++)
1238 ;
1239
1240 //
1241 // Copy the desired LineWidth of data to the output buffer.
1242 // Also make sure that we don't copy more than the string.
1243 // Also make sure that if there are linefeeds, we account for them.
1244 //
1245 if ((StrSize (&InputString[*Index]) <= ((UINTN) (LineWidth + 1) * 2)) &&
1246 (StrSize (&InputString[*Index]) <= ((UINTN) (Count2 + 1) * 2))
1247 ) {
1248 //
1249 // Convert to CHAR16 value and show that we are done with this operation
1250 //
1251 LineWidth = (UINT16) ((StrSize (&InputString[*Index]) - 2) / 2);
1252 if (LineWidth != 0) {
1253 Finished = TRUE;
1254 }
1255 } else {
1256 if (Count2 == LineWidth) {
1257 //
1258 // Rewind the string from the maximum size until we see a space to break the line
1259 //
1260 for (; (InputString[*Index + LineWidth] != CHAR_SPACE) && (LineWidth != 0); LineWidth--)
1261 ;
1262 if (LineWidth == 0) {
1263 LineWidth = Count;
1264 }
1265 } else {
1266 LineWidth = Count2;
1267 }
1268 }
1269
1270 CopyMem (*OutputString, &InputString[*Index], LineWidth * 2);
1271
1272 //
1273 // If currently pointing to a space, increment the index to the first non-space character
1274 //
1275 for (;
1276 (InputString[*Index + LineWidth] == CHAR_SPACE) || (InputString[*Index + LineWidth] == CHAR_CARRIAGE_RETURN);
1277 (*Index)++
1278 )
1279 ;
1280 *Index = (UINT16) (*Index + LineWidth);
1281 return LineWidth;
1282 } else {
1283 return (UINT16) 0;
1284 }
1285 }
1286
1287 VOID
1288 UpdateOptionSkipLines (
1289 IN EFI_IFR_DATA_ARRAY *PageData,
1290 IN UI_MENU_OPTION *MenuOption,
1291 IN EFI_FILE_FORM_TAGS *FileFormTagsHead,
1292 IN CHAR16 **OptionalString,
1293 IN UINTN SkipValue
1294 )
1295 {
1296 UINTN Index;
1297 UINTN Loop;
1298 UINT16 Width;
1299 UINTN Row;
1300 UINTN OriginalRow;
1301 CHAR16 *OutputString;
1302 CHAR16 *OptionString;
1303
1304 Row = 0;
1305 OptionString = *OptionalString;
1306 OutputString = NULL;
1307
1308 ProcessOptions (MenuOption, FALSE, FileFormTagsHead, PageData, &OptionString);
1309
1310 if (OptionString != NULL) {
1311 //
1312 // If leading spaces on OptionString - remove the spaces
1313 //
1314 for (Index = 0; OptionString[Index] == L' '; Index++)
1315 ;
1316
1317 for (Loop = 0; OptionString[Index] != CHAR_NULL; Index++) {
1318 OptionString[Loop] = OptionString[Index];
1319 Loop++;
1320 }
1321
1322 OptionString[Loop] = CHAR_NULL;
1323
1324 Width = (UINT16) gOptionBlockWidth;
1325
1326 OriginalRow = Row;
1327
1328 for (Index = 0; GetLineByWidth (OptionString, Width, &Index, &OutputString) != 0x0000;) {
1329 //
1330 // If there is more string to process print on the next row and increment the Skip value
1331 //
1332 if (StrLen (&OptionString[Index])) {
1333 if (SkipValue == 0) {
1334 Row++;
1335 //
1336 // Since the Number of lines for this menu entry may or may not be reflected accurately
1337 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do
1338 // some testing to ensure we are keeping this in-sync.
1339 //
1340 // If the difference in rows is greater than or equal to the skip value, increase the skip value
1341 //
1342 if ((Row - OriginalRow) >= MenuOption->Skip) {
1343 MenuOption->Skip++;
1344 }
1345 }
1346 }
1347
1348 gBS->FreePool (OutputString);
1349 if (SkipValue != 0) {
1350 SkipValue--;
1351 }
1352 }
1353
1354 Row = OriginalRow;
1355 }
1356
1357 *OptionalString = OptionString;
1358 }
1359 //
1360 // Search table for UiDisplayMenu()
1361 //
1362 SCAN_CODE_TO_SCREEN_OPERATION gScanCodeToOperation[] = {
1363 { SCAN_UP, UiUp },
1364 { SCAN_DOWN, UiDown },
1365 { SCAN_PAGE_UP, UiPageUp },
1366 { SCAN_PAGE_DOWN, UiPageDown},
1367 { SCAN_ESC, UiReset},
1368 { SCAN_F2, UiPrevious},
1369 { SCAN_LEFT, UiLeft },
1370 { SCAN_RIGHT, UiRight },
1371 { SCAN_F9, UiDefault},
1372 { SCAN_F10, UiSave }
1373 };
1374
1375 SCREEN_OPERATION_T0_CONTROL_FLAG gScreenOperationToControlFlag[] = {
1376 { UiNoOperation, CfUiNoOperation },
1377 { UiDefault, CfUiDefault },
1378 { UiSelect, CfUiSelect },
1379 { UiUp, CfUiUp},
1380 { UiDown, CfUiDown },
1381 { UiLeft, CfUiLeft },
1382 { UiRight, CfUiRight },
1383 { UiReset, CfUiReset },
1384 { UiSave, CfUiSave },
1385 { UiPrevious, CfUiPrevious },
1386 { UiPageUp, CfUiPageUp },
1387 { UiPageDown, CfUiPageDown }
1388 };
1389
1390 UI_MENU_OPTION *
1391 UiDisplayMenu (
1392 IN BOOLEAN SubMenu,
1393 IN EFI_FILE_FORM_TAGS *FileFormTagsHead,
1394 OUT EFI_IFR_DATA_ARRAY *PageData
1395 )
1396 /*++
1397
1398 Routine Description:
1399 Display menu and wait for user to select one menu option, then return it.
1400 If AutoBoot is enabled, then if user doesn't select any option,
1401 after period of time, it will automatically return the first menu option.
1402
1403 Arguments:
1404 SubMenu - Indicate is sub menu.
1405 FileFormTagsHead - A pointer to the EFI_FILE_FORM_TAGS structure.
1406 PageData - A pointer to the EFI_IFR_DATA_ARRAY.
1407
1408 Returns:
1409 Return the pointer of the menu which selected,
1410 otherwise return NULL.
1411
1412 --*/
1413 {
1414 INTN SkipValue;
1415 INTN Difference;
1416 INTN OldSkipValue;
1417 UINTN Row;
1418 UINTN Col;
1419 UINTN Temp;
1420 UINTN Temp2;
1421 UINTN TopRow;
1422 UINTN BottomRow;
1423 UINTN OriginalRow;
1424 UINTN Index;
1425 UINTN DataAndTimeLineNumberPad;
1426 UINT32 Count;
1427 INT16 OriginalTimeOut;
1428 UINT8 *Location;
1429 UINT16 Width;
1430 CHAR16 *StringPtr;
1431 CHAR16 *OptionString;
1432 CHAR16 *OutputString;
1433 CHAR16 *FormattedString;
1434 CHAR16 YesResponse;
1435 CHAR16 NoResponse;
1436 BOOLEAN NewLine;
1437 BOOLEAN Repaint;
1438 BOOLEAN SavedValue;
1439 EFI_STATUS Status;
1440 UI_MENU_LIST *UiMenuList;
1441 EFI_INPUT_KEY Key;
1442 LIST_ENTRY *Link;
1443 LIST_ENTRY *NewPos;
1444 LIST_ENTRY *TopOfScreen;
1445 LIST_ENTRY *SavedListEntry;
1446 UI_MENU_OPTION *Selection;
1447 UI_MENU_OPTION *MenuOption;
1448 UI_MENU_OPTION *NextMenuOption;
1449 UI_MENU_OPTION *SavedMenuOption;
1450 UI_MENU_OPTION *PreviousMenuOption;
1451 EFI_IFR_BINARY *IfrBinary;
1452 UI_CONTROL_FLAG ControlFlag;
1453 EFI_SCREEN_DESCRIPTOR LocalScreen;
1454 EFI_FILE_FORM_TAGS *FileFormTags;
1455 MENU_REFRESH_ENTRY *MenuRefreshEntry;
1456 MENU_REFRESH_ENTRY *OldMenuRefreshEntry;
1457 UI_SCREEN_OPERATION ScreenOperation;
1458 EFI_VARIABLE_DEFINITION *VariableDefinition;
1459 EFI_FORM_CALLBACK_PROTOCOL *FormCallback;
1460 EFI_HII_VARIABLE_PACK_LIST *NvMapListHead;
1461 EFI_HII_VARIABLE_PACK_LIST *NvMapListNode;
1462 VOID *NvMap;
1463 UINTN NvMapSize;
1464
1465 CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));
1466
1467 VariableDefinition = NULL;
1468 Status = EFI_SUCCESS;
1469 FormattedString = NULL;
1470 OptionString = NULL;
1471 ScreenOperation = UiNoOperation;
1472 NewLine = TRUE;
1473 FormCallback = NULL;
1474 FileFormTags = NULL;
1475 OutputString = NULL;
1476 gUpArrow = FALSE;
1477 gDownArrow = FALSE;
1478 SkipValue = 0;
1479 OldSkipValue = 0;
1480 MenuRefreshEntry = gMenuRefreshHead;
1481 OldMenuRefreshEntry = gMenuRefreshHead;
1482 NextMenuOption = NULL;
1483 PreviousMenuOption = NULL;
1484 SavedMenuOption = NULL;
1485 IfrBinary = NULL;
1486 NvMap = NULL;
1487 NvMapSize = 0;
1488
1489 ZeroMem (&Key, sizeof (EFI_INPUT_KEY));
1490
1491 if (gClassOfVfr == EFI_FRONT_PAGE_SUBCLASS) {
1492 TopRow = LocalScreen.TopRow + FRONT_PAGE_HEADER_HEIGHT + SCROLL_ARROW_HEIGHT;
1493 Row = LocalScreen.TopRow + FRONT_PAGE_HEADER_HEIGHT + SCROLL_ARROW_HEIGHT;
1494 } else {
1495 TopRow = LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT + SCROLL_ARROW_HEIGHT;
1496 Row = LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT + SCROLL_ARROW_HEIGHT;
1497 }
1498
1499 if (SubMenu) {
1500 Col = LocalScreen.LeftColumn;
1501 } else {
1502 Col = LocalScreen.LeftColumn + LEFT_SKIPPED_COLUMNS;
1503 }
1504
1505 BottomRow = LocalScreen.BottomRow - STATUS_BAR_HEIGHT - FOOTER_HEIGHT - SCROLL_ARROW_HEIGHT - 1;
1506
1507 TopOfScreen = Menu.ForwardLink;
1508 Repaint = TRUE;
1509 MenuOption = NULL;
1510
1511 //
1512 // Get user's selection
1513 //
1514 Selection = NULL;
1515 NewPos = Menu.ForwardLink;
1516 gST->ConOut->EnableCursor (gST->ConOut, FALSE);
1517
1518 UpdateStatusBar (REFRESH_STATUS_BAR, (UINT8) 0, TRUE);
1519
1520 ControlFlag = CfInitialization;
1521
1522 while (TRUE) {
1523 switch (ControlFlag) {
1524 case CfInitialization:
1525 ControlFlag = CfCheckSelection;
1526 if (gExitRequired) {
1527 ScreenOperation = UiReset;
1528 ControlFlag = CfScreenOperation;
1529 } else if (gSaveRequired) {
1530 ScreenOperation = UiSave;
1531 ControlFlag = CfScreenOperation;
1532 } else if (IsListEmpty (&Menu)) {
1533 ControlFlag = CfReadKey;
1534 }
1535 break;
1536
1537 case CfCheckSelection:
1538 if (Selection != NULL) {
1539 ControlFlag = CfExit;
1540 } else {
1541 ControlFlag = CfRepaint;
1542 }
1543
1544 FileFormTags = FileFormTagsHead;
1545 break;
1546
1547 case CfRepaint:
1548 ControlFlag = CfRefreshHighLight;
1549
1550 if (Repaint) {
1551 //
1552 // Display menu
1553 //
1554 SavedMenuOption = MenuOption;
1555 gDownArrow = FALSE;
1556 gUpArrow = FALSE;
1557 Row = TopRow;
1558
1559 Temp = SkipValue;
1560 Temp2 = SkipValue;
1561
1562 ClearLines (
1563 LocalScreen.LeftColumn,
1564 LocalScreen.RightColumn,
1565 TopRow - SCROLL_ARROW_HEIGHT,
1566 BottomRow + SCROLL_ARROW_HEIGHT,
1567 FIELD_TEXT | FIELD_BACKGROUND
1568 );
1569
1570 while (gMenuRefreshHead != NULL) {
1571 OldMenuRefreshEntry = gMenuRefreshHead->Next;
1572
1573 gBS->FreePool (gMenuRefreshHead);
1574
1575 gMenuRefreshHead = OldMenuRefreshEntry;
1576 }
1577
1578 for (Link = TopOfScreen; Link != &Menu; Link = Link->ForwardLink) {
1579 MenuOption = CR (Link, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
1580 MenuOption->Row = Row;
1581 OriginalRow = Row;
1582 MenuOption->Col = Col;
1583 MenuOption->OptCol = gPromptBlockWidth + 1 + LocalScreen.LeftColumn;
1584
1585 if (SubMenu) {
1586 if (MenuOption->ThisTag->GrayOut) {
1587 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT_GRAYED | FIELD_BACKGROUND);
1588 } else {
1589 if (MenuOption->ThisTag->Operand == EFI_IFR_SUBTITLE_OP) {
1590 gST->ConOut->SetAttribute (gST->ConOut, SUBTITLE_TEXT | FIELD_BACKGROUND);
1591 }
1592 }
1593
1594 Width = GetWidth (MenuOption->ThisTag, MenuOption->Handle);
1595
1596 OriginalRow = Row;
1597
1598 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &Index, &OutputString) != 0x0000;) {
1599 if ((Temp == 0) && (Row <= BottomRow)) {
1600 PrintStringAt (Col, Row, OutputString);
1601 }
1602 //
1603 // If there is more string to process print on the next row and increment the Skip value
1604 //
1605 if (StrLen (&MenuOption->Description[Index])) {
1606 if (Temp == 0) {
1607 Row++;
1608 }
1609 }
1610
1611 gBS->FreePool (OutputString);
1612 if (Temp != 0) {
1613 Temp--;
1614 }
1615 }
1616
1617 Temp = 0;
1618
1619 Row = OriginalRow;
1620
1621 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT | FIELD_BACKGROUND);
1622 ProcessOptions (MenuOption, FALSE, FileFormTagsHead, PageData, &OptionString);
1623
1624 if (OptionString != NULL) {
1625 //
1626 // If leading spaces on OptionString - remove the spaces
1627 //
1628 for (Index = 0; OptionString[Index] == L' '; Index++) {
1629 MenuOption->OptCol++;
1630 }
1631
1632 for (Count = 0; OptionString[Index] != CHAR_NULL; Index++) {
1633 OptionString[Count] = OptionString[Index];
1634 Count++;
1635 }
1636
1637 OptionString[Count] = CHAR_NULL;
1638
1639 //
1640 // If this is a date or time op-code and is used to reflect an RTC, register the op-code
1641 //
1642 if ((MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP ||
1643 MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP) &&
1644 (MenuOption->ThisTag->StorageStart >= FileFormTags->FormTags.Tags[0].NvDataSize)) {
1645
1646 if (gMenuRefreshHead == NULL) {
1647 MenuRefreshEntry = AllocateZeroPool (sizeof (MENU_REFRESH_ENTRY));
1648 ASSERT (MenuRefreshEntry != NULL);
1649 MenuRefreshEntry->MenuOption = MenuOption;
1650 MenuRefreshEntry->FileFormTagsHead = FileFormTagsHead;
1651 MenuRefreshEntry->CurrentColumn = MenuOption->OptCol;
1652 MenuRefreshEntry->CurrentRow = MenuOption->Row;
1653 MenuRefreshEntry->CurrentAttribute = FIELD_TEXT | FIELD_BACKGROUND;
1654 gMenuRefreshHead = MenuRefreshEntry;
1655 } else {
1656 //
1657 // Advance to the last entry
1658 //
1659 for (MenuRefreshEntry = gMenuRefreshHead;
1660 MenuRefreshEntry->Next != NULL;
1661 MenuRefreshEntry = MenuRefreshEntry->Next
1662 )
1663 ;
1664 MenuRefreshEntry->Next = AllocateZeroPool (sizeof (MENU_REFRESH_ENTRY));
1665 ASSERT (MenuRefreshEntry->Next != NULL);
1666 MenuRefreshEntry = MenuRefreshEntry->Next;
1667 MenuRefreshEntry->MenuOption = MenuOption;
1668 MenuRefreshEntry->FileFormTagsHead = FileFormTagsHead;
1669 MenuRefreshEntry->CurrentColumn = MenuOption->OptCol;
1670 MenuRefreshEntry->CurrentRow = MenuOption->Row;
1671 MenuRefreshEntry->CurrentAttribute = FIELD_TEXT | FIELD_BACKGROUND;
1672 }
1673 }
1674
1675 Width = (UINT16) gOptionBlockWidth;
1676
1677 OriginalRow = Row;
1678
1679 for (Index = 0; GetLineByWidth (OptionString, Width, &Index, &OutputString) != 0x0000;) {
1680 if ((Temp2 == 0) && (Row <= BottomRow)) {
1681 PrintStringAt (MenuOption->OptCol, Row, OutputString);
1682 }
1683 //
1684 // If there is more string to process print on the next row and increment the Skip value
1685 //
1686 if (StrLen (&OptionString[Index])) {
1687 if (Temp2 == 0) {
1688 Row++;
1689 //
1690 // Since the Number of lines for this menu entry may or may not be reflected accurately
1691 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do
1692 // some testing to ensure we are keeping this in-sync.
1693 //
1694 // If the difference in rows is greater than or equal to the skip value, increase the skip value
1695 //
1696 if ((Row - OriginalRow) >= MenuOption->Skip) {
1697 MenuOption->Skip++;
1698 }
1699 }
1700 }
1701
1702 gBS->FreePool (OutputString);
1703 if (Temp2 != 0) {
1704 Temp2--;
1705 }
1706 }
1707
1708 Temp2 = 0;
1709 Row = OriginalRow;
1710 }
1711 //
1712 // If this is a text op with secondary text information
1713 //
1714 if ((MenuOption->ThisTag->Operand == EFI_IFR_TEXT_OP) && (MenuOption->ThisTag->TextTwo != 0)) {
1715 StringPtr = GetToken (MenuOption->ThisTag->TextTwo, MenuOption->Handle);
1716
1717 Width = (UINT16) gOptionBlockWidth;
1718
1719 OriginalRow = Row;
1720
1721 for (Index = 0; GetLineByWidth (StringPtr, Width, &Index, &OutputString) != 0x0000;) {
1722 if ((Temp == 0) && (Row <= BottomRow)) {
1723 PrintStringAt (MenuOption->OptCol, Row, OutputString);
1724 }
1725 //
1726 // If there is more string to process print on the next row and increment the Skip value
1727 //
1728 if (StrLen (&StringPtr[Index])) {
1729 if (Temp2 == 0) {
1730 Row++;
1731 //
1732 // Since the Number of lines for this menu entry may or may not be reflected accurately
1733 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do
1734 // some testing to ensure we are keeping this in-sync.
1735 //
1736 // If the difference in rows is greater than or equal to the skip value, increase the skip value
1737 //
1738 if ((Row - OriginalRow) >= MenuOption->Skip) {
1739 MenuOption->Skip++;
1740 }
1741 }
1742 }
1743
1744 gBS->FreePool (OutputString);
1745 if (Temp2 != 0) {
1746 Temp2--;
1747 }
1748 }
1749
1750 Row = OriginalRow;
1751 gBS->FreePool (StringPtr);
1752 }
1753 } else {
1754 //
1755 // For now, assume left-justified 72 width max setup entries
1756 //
1757 PrintStringAt (Col, Row, MenuOption->Description);
1758 }
1759 //
1760 // Tracker 6210 - need to handle the bottom of the display
1761 //
1762 if (MenuOption->Skip > 1) {
1763 Row += MenuOption->Skip - SkipValue;
1764 SkipValue = 0;
1765 } else {
1766 Row += MenuOption->Skip;
1767 }
1768
1769 if (Row > BottomRow) {
1770 if (!ValueIsScroll (FALSE, Link)) {
1771 gDownArrow = TRUE;
1772 }
1773
1774 Row = BottomRow + 1;
1775 break;
1776 }
1777 }
1778
1779 if (!ValueIsScroll (TRUE, TopOfScreen)) {
1780 gUpArrow = TRUE;
1781 }
1782
1783 if (gUpArrow) {
1784 gST->ConOut->SetAttribute (gST->ConOut, ARROW_TEXT | ARROW_BACKGROUND);
1785 PrintAt (
1786 LocalScreen.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,
1787 TopRow - SCROLL_ARROW_HEIGHT,
1788 (CHAR16 *) L"%c",
1789 ARROW_UP
1790 );
1791 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT | FIELD_BACKGROUND);
1792 }
1793
1794 if (gDownArrow) {
1795 gST->ConOut->SetAttribute (gST->ConOut, ARROW_TEXT | ARROW_BACKGROUND);
1796 PrintAt (
1797 LocalScreen.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,
1798 BottomRow + SCROLL_ARROW_HEIGHT,
1799 (CHAR16 *) L"%c",
1800 ARROW_DOWN
1801 );
1802 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT | FIELD_BACKGROUND);
1803 }
1804
1805 if (SavedMenuOption != NULL) {
1806 MenuOption = SavedMenuOption;
1807 }
1808 }
1809 break;
1810
1811 case CfRefreshHighLight:
1812 ControlFlag = CfUpdateHelpString;
1813 //
1814 // Repaint flag is normally reset when finish processing CfUpdateHelpString. Temporarily
1815 // reset Repaint flag because we may break halfway and skip CfUpdateHelpString processing.
1816 //
1817 SavedValue = Repaint;
1818 Repaint = FALSE;
1819
1820 if (NewPos != NULL) {
1821 gST->ConOut->SetCursorPosition (gST->ConOut, MenuOption->Col, MenuOption->Row);
1822 if (SubMenu) {
1823 if (gLastOpr && (gEntryNumber != -1)) {
1824 MenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
1825 if (gEntryNumber != MenuOption->EntryNumber) {
1826 ScreenOperation = UiDown;
1827 ControlFlag = CfScreenOperation;
1828 break;
1829 } else {
1830 gLastOpr = FALSE;
1831 }
1832 }
1833
1834 ProcessOptions (MenuOption, FALSE, FileFormTagsHead, PageData, &OptionString);
1835 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT | FIELD_BACKGROUND);
1836 if (OptionString != NULL) {
1837 //
1838 // If leading spaces on OptionString - remove the spaces
1839 //
1840 for (Index = 0; OptionString[Index] == L' '; Index++)
1841 ;
1842
1843 for (Count = 0; OptionString[Index] != CHAR_NULL; Index++) {
1844 OptionString[Count] = OptionString[Index];
1845 Count++;
1846 }
1847
1848 OptionString[Count] = CHAR_NULL;
1849
1850 Width = (UINT16) gOptionBlockWidth;
1851
1852 OriginalRow = MenuOption->Row;
1853
1854 for (Index = 0; GetLineByWidth (OptionString, Width, &Index, &OutputString) != 0x0000;) {
1855 if (MenuOption->Row >= TopRow && MenuOption->Row <= BottomRow) {
1856 PrintStringAt (MenuOption->OptCol, MenuOption->Row, OutputString);
1857 }
1858 //
1859 // If there is more string to process print on the next row and increment the Skip value
1860 //
1861 if (StrLen (&OptionString[Index])) {
1862 MenuOption->Row++;
1863 }
1864
1865 gBS->FreePool (OutputString);
1866 }
1867
1868 MenuOption->Row = OriginalRow;
1869 } else {
1870 if (NewLine) {
1871 if (MenuOption->ThisTag->GrayOut) {
1872 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT_GRAYED | FIELD_BACKGROUND);
1873 } else {
1874 if (MenuOption->ThisTag->Operand == EFI_IFR_SUBTITLE_OP) {
1875 gST->ConOut->SetAttribute (gST->ConOut, SUBTITLE_TEXT | FIELD_BACKGROUND);
1876 }
1877 }
1878
1879 OriginalRow = MenuOption->Row;
1880 Width = GetWidth (MenuOption->ThisTag, MenuOption->Handle);
1881
1882 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &Index, &OutputString) != 0x0000;) {
1883 if (MenuOption->Row >= TopRow && MenuOption->Row <= BottomRow) {
1884 PrintStringAt (Col, MenuOption->Row, OutputString);
1885 }
1886 //
1887 // If there is more string to process print on the next row and increment the Skip value
1888 //
1889 if (StrLen (&MenuOption->Description[Index])) {
1890 MenuOption->Row++;
1891 }
1892
1893 gBS->FreePool (OutputString);
1894 }
1895
1896 MenuOption->Row = OriginalRow;
1897 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT | FIELD_BACKGROUND);
1898 }
1899 }
1900 } else {
1901 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT | FIELD_BACKGROUND);
1902 gST->ConOut->OutputString (gST->ConOut, MenuOption->Description);
1903 }
1904
1905 MenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
1906
1907 if ((gPriorMenuEntry != 0) && (MenuOption->EntryNumber != gPriorMenuEntry) && (NewPos->ForwardLink != &Menu)) {
1908 ScreenOperation = UiDown;
1909 ControlFlag = CfScreenOperation;
1910 break;
1911 } else {
1912 gPriorMenuEntry = 0;
1913 }
1914 //
1915 // This is only possible if we entered this page and the first menu option is
1916 // a "non-menu" item. In that case, force it UiDown
1917 //
1918 if (MenuOption->ThisTag->Operand == EFI_IFR_SUBTITLE_OP || MenuOption->ThisTag->GrayOut) {
1919 //
1920 // If we previously hit an UP command and we are still sitting on a text operation
1921 // we must continue going up
1922 //
1923 if (ScreenOperation == UiUp) {
1924 ControlFlag = CfScreenOperation;
1925 break;
1926 } else {
1927 ScreenOperation = UiDown;
1928 ControlFlag = CfScreenOperation;
1929 break;
1930 }
1931 }
1932 //
1933 // Set reverse attribute
1934 //
1935 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT_HIGHLIGHT | FIELD_BACKGROUND_HIGHLIGHT);
1936 gST->ConOut->SetCursorPosition (gST->ConOut, MenuOption->Col, MenuOption->Row);
1937
1938 //
1939 // Assuming that we have a refresh linked-list created, lets annotate the
1940 // appropriate entry that we are highlighting with its new attribute. Just prior to this
1941 // lets reset all of the entries' attribute so we do not get multiple highlights in he refresh
1942 //
1943 if (gMenuRefreshHead != NULL) {
1944 for (MenuRefreshEntry = gMenuRefreshHead; MenuRefreshEntry != NULL; MenuRefreshEntry = MenuRefreshEntry->Next) {
1945 MenuRefreshEntry->CurrentAttribute = FIELD_TEXT | FIELD_BACKGROUND;
1946 if (MenuRefreshEntry->MenuOption == MenuOption) {
1947 MenuRefreshEntry->CurrentAttribute = FIELD_TEXT_HIGHLIGHT | FIELD_BACKGROUND_HIGHLIGHT;
1948 }
1949 }
1950 }
1951
1952 if (SubMenu) {
1953 ProcessOptions (MenuOption, FALSE, FileFormTagsHead, PageData, &OptionString);
1954 if (OptionString != NULL) {
1955 //
1956 // If leading spaces on OptionString - remove the spaces
1957 //
1958 for (Index = 0; OptionString[Index] == L' '; Index++)
1959 ;
1960
1961 for (Count = 0; OptionString[Index] != CHAR_NULL; Index++) {
1962 OptionString[Count] = OptionString[Index];
1963 Count++;
1964 }
1965
1966 OptionString[Count] = CHAR_NULL;
1967
1968 Width = (UINT16) gOptionBlockWidth;
1969
1970 OriginalRow = MenuOption->Row;
1971
1972 for (Index = 0; GetLineByWidth (OptionString, Width, &Index, &OutputString) != 0x0000;) {
1973 if (MenuOption->Row >= TopRow && MenuOption->Row <= BottomRow) {
1974 PrintStringAt (MenuOption->OptCol, MenuOption->Row, OutputString);
1975 }
1976 //
1977 // If there is more string to process print on the next row and increment the Skip value
1978 //
1979 if (StrLen (&OptionString[Index])) {
1980 MenuOption->Row++;
1981 }
1982
1983 gBS->FreePool (OutputString);
1984 }
1985
1986 MenuOption->Row = OriginalRow;
1987 } else {
1988 if (NewLine) {
1989 OriginalRow = MenuOption->Row;
1990
1991 Width = GetWidth (MenuOption->ThisTag, MenuOption->Handle);
1992
1993 for (Index = 0; GetLineByWidth (MenuOption->Description, Width, &Index, &OutputString) != 0x0000;) {
1994 if (MenuOption->Row >= TopRow && MenuOption->Row <= BottomRow) {
1995 PrintStringAt (Col, MenuOption->Row, OutputString);
1996 }
1997 //
1998 // If there is more string to process print on the next row and increment the Skip value
1999 //
2000 if (StrLen (&MenuOption->Description[Index])) {
2001 MenuOption->Row++;
2002 }
2003
2004 gBS->FreePool (OutputString);
2005 }
2006
2007 MenuOption->Row = OriginalRow;
2008
2009 }
2010 }
2011
2012 if (((NewPos->ForwardLink != &Menu) && (ScreenOperation == UiDown)) ||
2013 ((NewPos->BackLink != &Menu) && (ScreenOperation == UiUp)) ||
2014 (ScreenOperation == UiNoOperation)
2015 ) {
2016 UpdateKeyHelp (MenuOption, FALSE);
2017 }
2018 } else {
2019 gST->ConOut->OutputString (gST->ConOut, MenuOption->Description);
2020 }
2021 //
2022 // Clear reverse attribute
2023 //
2024 gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT | FIELD_BACKGROUND);
2025 }
2026 //
2027 // Repaint flag will be used when process CfUpdateHelpString, so restore its value
2028 // if we didn't break halfway when process CfRefreshHighLight.
2029 //
2030 Repaint = SavedValue;
2031 break;
2032
2033 case CfUpdateHelpString:
2034 ControlFlag = CfPrepareToReadKey;
2035
2036 if (SubMenu &&
2037 (Repaint || NewLine ||
2038 (MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP) ||
2039 (MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP)) &&
2040 !(gClassOfVfr == EFI_GENERAL_APPLICATION_SUBCLASS)) {
2041 //
2042 // Don't print anything if it is a NULL help token
2043 //
2044 if (MenuOption->ThisTag->Help == 0x00000000) {
2045 StringPtr = (CHAR16 *) L"\0";
2046 } else {
2047 StringPtr = GetToken (MenuOption->ThisTag->Help, MenuOption->Handle);
2048 }
2049
2050 ProcessHelpString (StringPtr, &FormattedString, BottomRow - TopRow);
2051
2052 gST->ConOut->SetAttribute (gST->ConOut, HELP_TEXT | FIELD_BACKGROUND);
2053
2054 for (Index = 0; Index < BottomRow - TopRow; Index++) {
2055 //
2056 // Pad String with spaces to simulate a clearing of the previous line
2057 //
2058 for (; GetStringWidth (&FormattedString[Index * gHelpBlockWidth]) / 2 < gHelpBlockWidth;) {
2059 StrCat (&FormattedString[Index * gHelpBlockWidth], (CHAR16 *) L" ");
2060 }
2061
2062 PrintStringAt (
2063 LocalScreen.RightColumn - gHelpBlockWidth,
2064 Index + TopRow,
2065 &FormattedString[Index * gHelpBlockWidth]
2066 );
2067 }
2068 }
2069 //
2070 // Reset this flag every time we finish using it.
2071 //
2072 Repaint = FALSE;
2073 NewLine = FALSE;
2074 break;
2075
2076 case CfPrepareToReadKey:
2077 ControlFlag = CfReadKey;
2078
2079 for (Index = 0; Index < MenuOption->IfrNumber; Index++) {
2080 FileFormTags = FileFormTags->NextFile;
2081 }
2082
2083 ScreenOperation = UiNoOperation;
2084
2085 Status = gBS->HandleProtocol (
2086 (VOID *) (UINTN) FileFormTags->FormTags.Tags[0].CallbackHandle,
2087 &gEfiFormCallbackProtocolGuid,
2088 (VOID **) &FormCallback
2089 );
2090
2091 break;
2092
2093 case CfReadKey:
2094 ControlFlag = CfScreenOperation;
2095
2096 OriginalTimeOut = FrontPageTimeOutValue;
2097 do {
2098 if (FrontPageTimeOutValue >= 0 && (gClassOfVfr == EFI_FRONT_PAGE_SUBCLASS) && FrontPageTimeOutValue != (INT16) -1) {
2099 //
2100 // Remember that if set to 0, must immediately boot an option
2101 //
2102 if (FrontPageTimeOutValue == 0) {
2103 FrontPageTimeOutValue = 0xFFFF;
2104 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
2105 if (EFI_ERROR (Status)) {
2106 Status = EFI_TIMEOUT;
2107 }
2108 break;
2109 }
2110
2111 Status = UiWaitForSingleEvent (gST->ConIn->WaitForKey, ONE_SECOND);
2112 if (Status == EFI_TIMEOUT) {
2113 EFI_IFR_DATA_ENTRY *DataEntry;
2114
2115 DataEntry = (EFI_IFR_DATA_ENTRY *) (PageData + 1);
2116
2117 PageData->EntryCount = 1;
2118 Count = (UINT32) ((OriginalTimeOut - FrontPageTimeOutValue) * 100 / OriginalTimeOut);
2119 CopyMem (&DataEntry->Data, &Count, sizeof (UINT32));
2120
2121 if ((FormCallback != NULL) && (FormCallback->Callback != NULL)) {
2122 FormCallback->Callback (
2123 FormCallback,
2124 0xFFFF,
2125 (EFI_IFR_DATA_ARRAY *) PageData,
2126 NULL
2127 );
2128 }
2129 //
2130 // Count down 1 second
2131 //
2132 FrontPageTimeOutValue--;
2133
2134 } else {
2135 ASSERT (!EFI_ERROR (Status));
2136 PageData->EntryCount = 0;
2137 if ((FormCallback != NULL) && (FormCallback->Callback != NULL)) {
2138 FormCallback->Callback (
2139 FormCallback,
2140 0xFFFE,
2141 (EFI_IFR_DATA_ARRAY *) PageData,
2142 NULL
2143 );
2144 }
2145
2146 FrontPageTimeOutValue = 0xFFFF;
2147 }
2148 } else {
2149 //
2150 // Wait for user's selection, no auto boot
2151 //
2152 Status = UiWaitForSingleEvent (gST->ConIn->WaitForKey, 0);
2153 }
2154 } while (Status == EFI_TIMEOUT);
2155
2156 if (gFirstIn) {
2157 gFirstIn = FALSE;
2158 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
2159 DisableQuietBoot ();
2160 }
2161
2162 if (Status == EFI_TIMEOUT) {
2163 Key.UnicodeChar = CHAR_CARRIAGE_RETURN;
2164 } else {
2165 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
2166 //
2167 // if we encounter error, continue to read another key in.
2168 //
2169 if (EFI_ERROR (Status)) {
2170 ControlFlag = CfReadKey;
2171 continue;
2172 }
2173 }
2174
2175 switch (Key.UnicodeChar) {
2176 case CHAR_CARRIAGE_RETURN:
2177 Selection = MenuOption;
2178 ScreenOperation = UiSelect;
2179 gDirection = 0;
2180 break;
2181
2182 //
2183 // We will push the adjustment of these numeric values directly to the input handler
2184 //
2185 case '+':
2186 case '-':
2187 if ((MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP)) {
2188
2189 if (Key.UnicodeChar == '+') {
2190 gDirection = SCAN_RIGHT;
2191 } else {
2192 gDirection = SCAN_LEFT;
2193 }
2194
2195 Status = ProcessOptions (MenuOption, TRUE, FileFormTagsHead, NULL, &OptionString);
2196 }
2197 break;
2198
2199 case '^':
2200 ScreenOperation = UiUp;
2201 break;
2202
2203 case 'V':
2204 case 'v':
2205 ScreenOperation = UiDown;
2206 break;
2207
2208 case ' ':
2209 if (gClassOfVfr != EFI_FRONT_PAGE_SUBCLASS) {
2210 if (SubMenu) {
2211 if (MenuOption->ThisTag->Operand == EFI_IFR_CHECKBOX_OP && !(MenuOption->ThisTag->GrayOut)) {
2212 gST->ConOut->SetCursorPosition (gST->ConOut, MenuOption->Col, MenuOption->Row);
2213 gST->ConOut->OutputString (gST->ConOut, MenuOption->Description);
2214 Selection = MenuOption;
2215 ScreenOperation = UiSelect;
2216 }
2217 }
2218 }
2219 break;
2220
2221 case CHAR_NULL:
2222 if (((Key.ScanCode == SCAN_F1) && ((gFunctionKeySetting & FUNCTION_ONE) != FUNCTION_ONE)) ||
2223 ((Key.ScanCode == SCAN_F2) && ((gFunctionKeySetting & FUNCTION_TWO) != FUNCTION_TWO)) ||
2224 ((Key.ScanCode == SCAN_F9) && ((gFunctionKeySetting & FUNCTION_NINE) != FUNCTION_NINE)) ||
2225 ((Key.ScanCode == SCAN_F10) && ((gFunctionKeySetting & FUNCTION_TEN) != FUNCTION_TEN))
2226 ) {
2227 //
2228 // If the function key has been disabled, just ignore the key.
2229 //
2230 } else {
2231 for (Index = 0; Index < sizeof (gScanCodeToOperation) / sizeof (gScanCodeToOperation[0]); Index++) {
2232 if (Key.ScanCode == gScanCodeToOperation[Index].ScanCode) {
2233 if ((Key.ScanCode == SCAN_F9) || (Key.ScanCode == SCAN_F10)) {
2234 if (SubMenu) {
2235 ScreenOperation = gScanCodeToOperation[Index].ScreenOperation;
2236 }
2237 } else {
2238 ScreenOperation = gScanCodeToOperation[Index].ScreenOperation;
2239 }
2240 }
2241 }
2242 }
2243 break;
2244 }
2245 break;
2246
2247 case CfScreenOperation:
2248 IfrBinary = gBinaryDataHead;
2249
2250 //
2251 // Advance to the Ifr we are using
2252 //
2253 for (Index = 0; Index < gActiveIfr; Index++) {
2254 IfrBinary = IfrBinary->Next;
2255 }
2256
2257 if (ScreenOperation != UiPrevious && ScreenOperation != UiReset) {
2258 //
2259 // If the screen has no menu items, and the user didn't select UiPrevious, or UiReset
2260 // ignore the selection and go back to reading keys.
2261 //
2262 if (IsListEmpty (&Menu)) {
2263 ControlFlag = CfReadKey;
2264 break;
2265 }
2266 //
2267 // if there is nothing logical to place a cursor on, just move on to wait for a key.
2268 //
2269 for (Link = Menu.ForwardLink; Link != &Menu; Link = Link->ForwardLink) {
2270 NextMenuOption = CR (Link, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2271 if (!(NextMenuOption->ThisTag->GrayOut) && (NextMenuOption->ThisTag->Operand != EFI_IFR_SUBTITLE_OP)) {
2272 break;
2273 }
2274 }
2275
2276 if (Link == &Menu) {
2277 ControlFlag = CfPrepareToReadKey;
2278 break;
2279 }
2280 }
2281
2282 for (Index = 0;
2283 Index < sizeof (gScreenOperationToControlFlag) / sizeof (gScreenOperationToControlFlag[0]);
2284 Index++
2285 ) {
2286 if (ScreenOperation == gScreenOperationToControlFlag[Index].ScreenOperation) {
2287 ControlFlag = gScreenOperationToControlFlag[Index].ControlFlag;
2288 }
2289 }
2290
2291 break;
2292
2293 case CfUiPrevious:
2294 ControlFlag = CfCheckSelection;
2295 //
2296 // Check for tags that might have LATE_CHECK enabled. If they do, we can't switch pages or save NV data.
2297 //
2298 if (MenuOption != NULL) {
2299 if (!SelectionsAreValid (MenuOption, FileFormTagsHead)) {
2300 Selection = NULL;
2301 Repaint = TRUE;
2302 break;
2303 }
2304 }
2305
2306 if (IsListEmpty (&gMenuList)) {
2307 Selection = NULL;
2308 if (IsListEmpty (&Menu)) {
2309 ControlFlag = CfReadKey;
2310 }
2311 break;
2312 }
2313
2314 gLastOpr = TRUE;
2315
2316 while (gMenuRefreshHead != NULL) {
2317 OldMenuRefreshEntry = gMenuRefreshHead->Next;
2318
2319 gBS->FreePool (gMenuRefreshHead);
2320
2321 gMenuRefreshHead = OldMenuRefreshEntry;
2322 }
2323 //
2324 // Remove the Cached page entry, free and init the menus, flag Selection as jumping to previous page and a valid Tag
2325 //
2326 if (SubMenu) {
2327 UiRemoveMenuListEntry (MenuOption, &Selection);
2328 Selection->Previous = TRUE;
2329 UiFreeMenu ();
2330 UiInitMenu ();
2331 }
2332
2333 gActiveIfr = Selection->IfrNumber;
2334 return Selection;
2335
2336 case CfUiSelect:
2337 ControlFlag = CfCheckSelection;
2338
2339 ExtractRequestedNvMap (FileFormTags, MenuOption->ThisTag->VariableNumber, &VariableDefinition);
2340
2341 if (SubMenu) {
2342 if ((MenuOption->ThisTag->Operand == EFI_IFR_TEXT_OP &&
2343 !(MenuOption->ThisTag->Flags & EFI_IFR_FLAG_INTERACTIVE)) ||
2344 (MenuOption->ThisTag->GrayOut) ||
2345 (MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP) ||
2346 (MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP)) {
2347 Selection = NULL;
2348 break;
2349 }
2350
2351 NewLine = TRUE;
2352 UpdateKeyHelp (MenuOption, TRUE);
2353 Status = ProcessOptions (MenuOption, TRUE, FileFormTagsHead, PageData, &OptionString);
2354
2355 if (EFI_ERROR (Status)) {
2356 Selection = NULL;
2357 Repaint = TRUE;
2358 break;
2359 }
2360
2361 if (OptionString != NULL) {
2362 PrintStringAt (LocalScreen.LeftColumn + gPromptBlockWidth + 1, MenuOption->Row, OptionString);
2363 }
2364
2365 if (MenuOption->ThisTag->Flags & EFI_IFR_FLAG_INTERACTIVE) {
2366 Selection = MenuOption;
2367 }
2368
2369 if (Selection == NULL) {
2370 break;
2371 }
2372
2373 Location = (UINT8 *) &PageData->EntryCount;
2374
2375 //
2376 // If not a goto, dump single piece of data, otherwise dump everything
2377 //
2378 if (Selection->ThisTag->Operand == EFI_IFR_REF_OP) {
2379 //
2380 // Check for tags that might have LATE_CHECK enabled. If they do, we can't switch pages or save NV data.
2381 //
2382 if (!SelectionsAreValid (MenuOption, FileFormTagsHead)) {
2383 Selection = NULL;
2384 Repaint = TRUE;
2385 break;
2386 }
2387
2388 UiAddMenuListEntry (Selection);
2389 gPriorMenuEntry = 0;
2390
2391 //
2392 // Now that we added a menu entry specific to a goto, we can always go back when someone hits the UiPrevious
2393 //
2394 UiMenuList = CR (gMenuList.ForwardLink, UI_MENU_LIST, MenuLink, UI_MENU_LIST_SIGNATURE);
2395 UiMenuList->FormerEntryNumber = MenuOption->EntryNumber;
2396
2397 gLastOpr = FALSE;
2398
2399 //
2400 // Rewind to the beginning of the menu
2401 //
2402 for (; NewPos->BackLink != &Menu; NewPos = NewPos->BackLink)
2403 ;
2404
2405 //
2406 // Get Total Count of Menu entries
2407 //
2408 for (Count = 1; NewPos->ForwardLink != &Menu; NewPos = NewPos->ForwardLink) {
2409 Count++;
2410 }
2411 //
2412 // Rewind to the beginning of the menu
2413 //
2414 for (; NewPos->BackLink != &Menu; NewPos = NewPos->BackLink)
2415 ;
2416
2417 //
2418 // Copy the number of entries being described to the PageData location
2419 //
2420 CopyMem (&Location[0], &Count, sizeof (UINT32));
2421
2422 for (Index = 4; NewPos->ForwardLink != &Menu; Index = Index + MenuOption->ThisTag->StorageWidth + 2) {
2423
2424 MenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2425 Location[Index] = MenuOption->ThisTag->Operand;
2426 Location[Index + 1] = (UINT8) (MenuOption->ThisTag->StorageWidth + 4);
2427 CopyMem (
2428 &Location[Index + 4],
2429 &VariableDefinition->NvRamMap[MenuOption->ThisTag->StorageStart],
2430 MenuOption->ThisTag->StorageWidth
2431 );
2432 NewPos = NewPos->ForwardLink;
2433 }
2434 } else {
2435
2436 gPriorMenuEntry = MenuOption->EntryNumber;
2437
2438 Count = 1;
2439
2440 //
2441 // Copy the number of entries being described to the PageData location
2442 //
2443 CopyMem (&Location[0], &Count, sizeof (UINT32));
2444
2445 //
2446 // Start at PageData[4] since the EntryCount is a UINT32
2447 //
2448 Index = 4;
2449
2450 //
2451 // Copy data to destination
2452 //
2453 Location[Index] = MenuOption->ThisTag->Operand;
2454 Location[Index + 1] = (UINT8) (MenuOption->ThisTag->StorageWidth + 4);
2455 CopyMem (
2456 &Location[Index + 4],
2457 &VariableDefinition->NvRamMap[MenuOption->ThisTag->StorageStart],
2458 MenuOption->ThisTag->StorageWidth
2459 );
2460 }
2461 }
2462 break;
2463
2464 case CfUiReset:
2465 ControlFlag = CfCheckSelection;
2466 gLastOpr = FALSE;
2467 if (gClassOfVfr == EFI_FRONT_PAGE_SUBCLASS) {
2468 break;
2469 }
2470 //
2471 // If NV flag is up, prompt user
2472 //
2473 if (gNvUpdateRequired) {
2474 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
2475
2476 YesResponse = gYesResponse[0];
2477 NoResponse = gNoResponse[0];
2478
2479 do {
2480 CreateDialog (3, TRUE, 0, NULL, &Key, gEmptyString, gAreYouSure, gEmptyString);
2481 } while
2482 (
2483 (Key.ScanCode != SCAN_ESC) &&
2484 ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (NoResponse | UPPER_LOWER_CASE_OFFSET)) &&
2485 ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (YesResponse | UPPER_LOWER_CASE_OFFSET))
2486 );
2487
2488 //
2489 // If the user hits the YesResponse key
2490 //
2491 if ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) == (YesResponse | UPPER_LOWER_CASE_OFFSET)) {
2492 } else {
2493 Repaint = TRUE;
2494 NewLine = TRUE;
2495 break;
2496 }
2497 }
2498 //
2499 // Check for tags that might have LATE_CHECK enabled. If they do, we can't switch pages or save NV data.
2500 //
2501 if (MenuOption != NULL) {
2502 if (!SelectionsAreValid (MenuOption, FileFormTagsHead)) {
2503 Selection = NULL;
2504 Repaint = TRUE;
2505 NewLine = TRUE;
2506 break;
2507 }
2508 }
2509
2510 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
2511 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
2512
2513 if (SubMenu) {
2514 UiFreeMenuList ();
2515 gST->ConOut->ClearScreen (gST->ConOut);
2516 return NULL;
2517 }
2518
2519 UpdateStatusBar (INPUT_ERROR, MenuOption->ThisTag->Flags, FALSE);
2520 UpdateStatusBar (NV_UPDATE_REQUIRED, MenuOption->ThisTag->Flags, FALSE);
2521
2522 if (IfrBinary->UnRegisterOnExit) {
2523 Hii->RemovePack (Hii, MenuOption->Handle);
2524 }
2525
2526 UiFreeMenu ();
2527
2528 //
2529 // Clean up the allocated data buffers
2530 //
2531 FreeData (FileFormTagsHead, FormattedString, OptionString);
2532
2533 gST->ConOut->ClearScreen (gST->ConOut);
2534 return NULL;
2535
2536 case CfUiLeft:
2537 ControlFlag = CfCheckSelection;
2538 if ((MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP)) {
2539 if (MenuOption->Skip == 1) {
2540 //
2541 // In the tail of the Date/Time op-code set, go left.
2542 //
2543 NewPos = NewPos->BackLink;
2544 } else {
2545 //
2546 // In the middle of the Data/Time op-code set, go left.
2547 //
2548 NextMenuOption = CR (NewPos->ForwardLink, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2549 if (NextMenuOption->Skip == 1) {
2550 NewPos = NewPos->BackLink;
2551 }
2552 }
2553 }
2554 break;
2555
2556 case CfUiRight:
2557 ControlFlag = CfCheckSelection;
2558 if ((MenuOption->Skip == 0) &&
2559 ((MenuOption->ThisTag->Operand == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->Operand == EFI_IFR_TIME_OP))
2560 ) {
2561 //
2562 // We are in the head or middle of the Date/Time op-code set, advance right.
2563 //
2564 NewPos = NewPos->ForwardLink;
2565 }
2566 break;
2567
2568 case CfUiUp:
2569 ControlFlag = CfCheckSelection;
2570
2571 if (NewPos->BackLink != &Menu) {
2572 NewLine = TRUE;
2573 //
2574 // Adjust Date/Time position before we advance forward.
2575 //
2576 AdjustDateAndTimePosition (TRUE, &NewPos);
2577
2578 //
2579 // Caution that we have already rewind to the top, don't go backward in this situation.
2580 //
2581 if (NewPos->BackLink != &Menu) {
2582 NewPos = NewPos->BackLink;
2583 }
2584
2585 PreviousMenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2586
2587 //
2588 // Since the behavior of hitting the up arrow on a Date/Time op-code is intended
2589 // to be one that back to the previous set of op-codes, we need to advance to the sencond
2590 // Date/Time op-code and leave the remaining logic in UiDown intact so the appropriate
2591 // checking can be done.
2592 //
2593 DataAndTimeLineNumberPad = AdjustDateAndTimePosition (TRUE, &NewPos);
2594
2595 if (SubMenu) {
2596 //
2597 // If the previous MenuOption contains a display-only op-code, skip to the next one
2598 //
2599 if (PreviousMenuOption->ThisTag->Operand == EFI_IFR_SUBTITLE_OP || PreviousMenuOption->ThisTag->GrayOut) {
2600 //
2601 // This is ok as long as not at the end of the list
2602 //
2603 if (NewPos->BackLink == &Menu) {
2604 //
2605 // If we are at the start of the list, then this list must start with a display only
2606 // piece of data, so do not allow the backward motion
2607 //
2608 ScreenOperation = UiDown;
2609
2610 if (PreviousMenuOption->Row <= TopRow) {
2611 if (TopOfScreen->BackLink != &Menu) {
2612 TopOfScreen = TopOfScreen->BackLink;
2613 Repaint = TRUE;
2614 }
2615 }
2616
2617 UpdateStatusBar (INPUT_ERROR, PreviousMenuOption->ThisTag->Flags, FALSE);
2618 break;
2619 }
2620 }
2621 }
2622 //
2623 // Check the previous menu entry to see if it was a zero-length advance. If it was,
2624 // don't worry about a redraw.
2625 //
2626 if ((MenuOption->Row - PreviousMenuOption->Skip - DataAndTimeLineNumberPad < TopRow) ||
2627 (PreviousMenuOption->Skip > MenuOption->Row)
2628 ) {
2629 do {
2630 if (TopOfScreen->BackLink == &Menu) {
2631 break;
2632 }
2633
2634 Repaint = TRUE;
2635
2636 //
2637 // Is the current top of screen a zero-advance op-code?
2638 // If so, keep moving forward till we hit a >0 advance op-code
2639 //
2640 SavedMenuOption = CR (TopOfScreen->BackLink, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2641 TopOfScreen = TopOfScreen->BackLink;
2642 } while (SavedMenuOption->Skip == 0);
2643 //
2644 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
2645 //
2646 AdjustDateAndTimePosition (TRUE, &TopOfScreen);
2647 }
2648
2649 UpdateStatusBar (INPUT_ERROR, MenuOption->ThisTag->Flags, FALSE);
2650 } else {
2651 if (SubMenu) {
2652 SavedMenuOption = MenuOption;
2653 MenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2654 if (MenuOption->ThisTag->Operand == EFI_IFR_SUBTITLE_OP || MenuOption->ThisTag->GrayOut) {
2655 //
2656 // If we are at the end of the list and sitting on a text op, we need to more forward
2657 //
2658 ScreenOperation = UiDown;
2659 ControlFlag = CfScreenOperation;
2660 break;
2661 }
2662
2663 MenuOption = SavedMenuOption;
2664 }
2665 }
2666 break;
2667
2668 case CfUiPageUp:
2669 ControlFlag = CfCheckSelection;
2670
2671 SavedListEntry = NewPos;
2672 Link = TopOfScreen;
2673 for (Index = BottomRow; Index >= TopRow + 1; Index -= MenuOption->Skip) {
2674 if (Link->BackLink == &Menu) {
2675 TopOfScreen = Link;
2676 Link = SavedListEntry;
2677 MenuOption = CR (Link, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2678 break;
2679 }
2680
2681 NewLine = TRUE;
2682 Repaint = TRUE;
2683 Link = Link->BackLink;
2684 MenuOption = CR (Link, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2685 TopOfScreen = Link;
2686 SavedListEntry = Link;
2687 }
2688
2689 NewPos = Link;
2690
2691 //
2692 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
2693 // Don't do this when we are already in the first page.
2694 //
2695 if (Repaint) {
2696 AdjustDateAndTimePosition (TRUE, &TopOfScreen);
2697 AdjustDateAndTimePosition (TRUE, &NewPos);
2698 MenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2699 }
2700 break;
2701
2702 case CfUiPageDown:
2703 ControlFlag = CfCheckSelection;
2704
2705 SavedListEntry = NewPos;
2706 Link = TopOfScreen;
2707 NewPos = TopOfScreen;
2708 for (Index = TopRow; Index <= BottomRow - 1; Index += MenuOption->Skip) {
2709 if (NewPos->ForwardLink == &Menu) {
2710 NewPos = SavedListEntry;
2711 MenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2712 Link = TopOfScreen;
2713 NewLine = FALSE;
2714 Repaint = FALSE;
2715 break;
2716 }
2717
2718 NewLine = TRUE;
2719 Repaint = TRUE;
2720 MenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2721 NewPos = NewPos->ForwardLink;
2722 Link = NewPos;
2723 }
2724
2725 TopOfScreen = Link;
2726
2727 //
2728 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.
2729 // Don't do this when we are already in the last page.
2730 //
2731 if (Repaint) {
2732 AdjustDateAndTimePosition (TRUE, &TopOfScreen);
2733 AdjustDateAndTimePosition (TRUE, &NewPos);
2734 MenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2735 }
2736 break;
2737
2738 case CfUiDown:
2739 ControlFlag = CfCheckSelection;
2740 //
2741 // Since the behavior of hitting the down arrow on a Date/Time op-code is intended
2742 // to be one that progresses to the next set of op-codes, we need to advance to the last
2743 // Date/Time op-code and leave the remaining logic in UiDown intact so the appropriate
2744 // checking can be done. The only other logic we need to introduce is that if a Date/Time
2745 // op-code is the last entry in the menu, we need to rewind back to the first op-code of
2746 // the Date/Time op-code.
2747 //
2748 DataAndTimeLineNumberPad = AdjustDateAndTimePosition (FALSE, &NewPos);
2749
2750 if (NewPos->ForwardLink != &Menu) {
2751 NewLine = TRUE;
2752 NewPos = NewPos->ForwardLink;
2753 NextMenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2754
2755 if (SubMenu) {
2756 //
2757 // If the next MenuOption contains a display-only op-code, skip to the next one
2758 // Also if the next MenuOption is date or time,
2759 //
2760 if (NextMenuOption->ThisTag->Operand == EFI_IFR_SUBTITLE_OP || NextMenuOption->ThisTag->GrayOut) {
2761 //
2762 // This is ok as long as not at the end of the list
2763 //
2764 if (NewPos == &Menu) {
2765 //
2766 // If we are at the end of the list, then this list must end with a display only
2767 // piece of data, so do not allow the forward motion
2768 //
2769 UpdateStatusBar (INPUT_ERROR, NextMenuOption->ThisTag->Flags, FALSE);
2770 NewPos = NewPos->BackLink;
2771 ScreenOperation = UiUp;
2772 break;
2773 }
2774 }
2775 }
2776 //
2777 // An option might be multi-line, so we need to reflect that data in the overall skip value
2778 //
2779 UpdateOptionSkipLines (PageData, NextMenuOption, FileFormTagsHead, &OptionString, SkipValue);
2780
2781 if (NextMenuOption->Skip > 1) {
2782 Temp = MenuOption->Row + MenuOption->Skip + NextMenuOption->Skip - 1;
2783 } else {
2784 Temp = MenuOption->Row + MenuOption->Skip + DataAndTimeLineNumberPad;
2785 }
2786 //
2787 // If we are going to scroll
2788 //
2789 if (Temp > BottomRow) {
2790 do {
2791 //
2792 // Is the current top of screen a zero-advance op-code?
2793 // If so, keep moving forward till we hit a >0 advance op-code
2794 //
2795 SavedMenuOption = CR (TopOfScreen, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2796
2797 //
2798 // If bottom op-code is more than one line or top op-code is more than one line
2799 //
2800 if ((NextMenuOption->Skip > 1) || (MenuOption->Skip > 1)) {
2801 //
2802 // Is the bottom op-code greater than or equal in size to the top op-code?
2803 //
2804 if ((Temp - BottomRow) >= (SavedMenuOption->Skip - OldSkipValue)) {
2805 //
2806 // Skip the top op-code
2807 //
2808 TopOfScreen = TopOfScreen->ForwardLink;
2809 Difference = (Temp - BottomRow) - (SavedMenuOption->Skip - OldSkipValue);
2810
2811 OldSkipValue = Difference;
2812
2813 SavedMenuOption = CR (TopOfScreen, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2814
2815 //
2816 // If we have a remainder, skip that many more op-codes until we drain the remainder
2817 //
2818 for (;
2819 Difference >= (INTN) SavedMenuOption->Skip;
2820 Difference = Difference - (INTN) SavedMenuOption->Skip
2821 ) {
2822 //
2823 // Since the Difference is greater than or equal to this op-code's skip value, skip it
2824 //
2825 TopOfScreen = TopOfScreen->ForwardLink;
2826 SavedMenuOption = CR (TopOfScreen, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2827 if (Difference < (INTN) SavedMenuOption->Skip) {
2828 Difference = SavedMenuOption->Skip - Difference - 1;
2829 break;
2830 } else {
2831 if (Difference == (INTN) SavedMenuOption->Skip) {
2832 TopOfScreen = TopOfScreen->ForwardLink;
2833 SavedMenuOption = CR (TopOfScreen, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2834 Difference = SavedMenuOption->Skip - Difference;
2835 break;
2836 }
2837 }
2838 }
2839 //
2840 // Since we will act on this op-code in the next routine, and increment the
2841 // SkipValue, set the skips to one less than what is required.
2842 //
2843 SkipValue = Difference - 1;
2844
2845 } else {
2846 //
2847 // Since we will act on this op-code in the next routine, and increment the
2848 // SkipValue, set the skips to one less than what is required.
2849 //
2850 SkipValue = OldSkipValue + (Temp - BottomRow) - 1;
2851 }
2852 } else {
2853 if ((OldSkipValue + 1) == (INTN) SavedMenuOption->Skip) {
2854 TopOfScreen = TopOfScreen->ForwardLink;
2855 break;
2856 } else {
2857 SkipValue = OldSkipValue;
2858 }
2859 }
2860 //
2861 // If the op-code at the top of the screen is more than one line, let's not skip it yet
2862 // Let's set a skip flag to smoothly scroll the top of the screen.
2863 //
2864 if (SavedMenuOption->Skip > 1) {
2865 if (SavedMenuOption == NextMenuOption) {
2866 SkipValue = 0;
2867 } else {
2868 SkipValue++;
2869 }
2870 } else {
2871 SkipValue = 0;
2872 TopOfScreen = TopOfScreen->ForwardLink;
2873 }
2874 } while (SavedMenuOption->Skip == 0);
2875
2876 Repaint = TRUE;
2877 OldSkipValue = SkipValue;
2878 }
2879
2880 UpdateStatusBar (INPUT_ERROR, MenuOption->ThisTag->Flags, FALSE);
2881
2882 } else {
2883 if (SubMenu) {
2884 SavedMenuOption = MenuOption;
2885 MenuOption = CR (NewPos, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE);
2886 if (MenuOption->ThisTag->Operand == EFI_IFR_SUBTITLE_OP || MenuOption->ThisTag->GrayOut) {
2887 //
2888 // If we are at the end of the list and sitting on a text op, we need to more forward
2889 //
2890 ScreenOperation = UiUp;
2891 ControlFlag = CfScreenOperation;
2892 break;
2893 }
2894
2895 MenuOption = SavedMenuOption;
2896 //
2897 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.
2898 //
2899 AdjustDateAndTimePosition (TRUE, &NewPos);
2900 }
2901 }
2902 break;
2903
2904 case CfUiSave:
2905 ControlFlag = CfCheckSelection;
2906 //
2907 // Check for tags that might have LATE_CHECK enabled. If they do, we can't switch pages or save NV data.
2908 //
2909 if (MenuOption != NULL) {
2910 if (!SelectionsAreValid (MenuOption, FileFormTagsHead)) {
2911 Selection = NULL;
2912 Repaint = TRUE;
2913 break;
2914 }
2915 }
2916 //
2917 // If callbacks are active, and the callback has a Write method, try to use it
2918 //
2919 if (FileFormTags->VariableDefinitions->VariableName == NULL) {
2920 if ((FormCallback != NULL) && (FormCallback->NvWrite != NULL)) {
2921 Status = FormCallback->NvWrite (
2922 FormCallback,
2923 (CHAR16 *) L"Setup",
2924 &FileFormTags->FormTags.Tags[0].GuidValue,
2925 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
2926 VariableDefinition->VariableSize,
2927 (VOID *) VariableDefinition->NvRamMap,
2928 &gResetRequired
2929 );
2930
2931 } else {
2932 Status = gRT->SetVariable (
2933 (CHAR16 *) L"Setup",
2934 &FileFormTags->FormTags.Tags[0].GuidValue,
2935 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
2936 VariableDefinition->VariableSize,
2937 (VOID *) VariableDefinition->NvRamMap
2938 );
2939 }
2940 } else {
2941 VariableDefinition = FileFormTags->VariableDefinitions;
2942
2943 for (; VariableDefinition != NULL; VariableDefinition = VariableDefinition->Next) {
2944 if ((FormCallback != NULL) && (FormCallback->NvWrite != NULL)) {
2945 Status = FormCallback->NvWrite (
2946 FormCallback,
2947 VariableDefinition->VariableName,
2948 &VariableDefinition->Guid,
2949 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
2950 VariableDefinition->VariableSize,
2951 (VOID *) VariableDefinition->NvRamMap,
2952 &gResetRequired
2953 );
2954
2955 } else {
2956 Status = gRT->SetVariable (
2957 VariableDefinition->VariableName,
2958 &VariableDefinition->Guid,
2959 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
2960 VariableDefinition->VariableSize,
2961 (VOID *) VariableDefinition->NvRamMap
2962 );
2963 }
2964 }
2965 }
2966
2967 UpdateStatusBar (INPUT_ERROR, MenuOption->ThisTag->Flags, FALSE);
2968 UpdateStatusBar (NV_UPDATE_REQUIRED, MenuOption->ThisTag->Flags, FALSE);
2969 break;
2970
2971 case CfUiDefault:
2972 ControlFlag = CfCheckSelection;
2973
2974 NvMapListHead = NULL;
2975
2976 Status = Hii->GetDefaultImage (Hii, MenuOption->Handle, EFI_IFR_FLAG_DEFAULT, &NvMapListHead);
2977
2978 if (!EFI_ERROR (Status)) {
2979 ASSERT_EFI_ERROR (NULL != NvMapListHead);
2980
2981 NvMapListNode = NvMapListHead;
2982
2983 while (NULL != NvMapListNode) {
2984 if (FileFormTags->VariableDefinitions->VariableId == NvMapListNode->VariablePack->VariableId) {
2985 NvMap = (VOID *) ((CHAR8 *) NvMapListNode->VariablePack + sizeof (EFI_HII_VARIABLE_PACK) + NvMapListNode->VariablePack->VariableNameLength);
2986 NvMapSize = NvMapListNode->VariablePack->Header.Length - sizeof (EFI_HII_VARIABLE_PACK) - NvMapListNode->VariablePack->VariableNameLength;
2987 break;
2988 }
2989 NvMapListNode = NvMapListNode->NextVariablePack;
2990 }
2991
2992 //
2993 // Free the buffer that was allocated.
2994 //
2995 gBS->FreePool (FileFormTags->VariableDefinitions->NvRamMap);
2996 gBS->FreePool (FileFormTags->VariableDefinitions->FakeNvRamMap);
2997
2998 //
2999 // Allocate, copy the NvRamMap.
3000 //
3001 FileFormTags->VariableDefinitions->VariableFakeSize = (UINT16) (FileFormTags->VariableDefinitions->VariableFakeSize - FileFormTags->VariableDefinitions->VariableSize);
3002 FileFormTags->VariableDefinitions->VariableSize = (UINT16) NvMapSize;
3003 FileFormTags->VariableDefinitions->VariableFakeSize = (UINT16) (FileFormTags->VariableDefinitions->VariableFakeSize + FileFormTags->VariableDefinitions->VariableSize);
3004
3005 FileFormTags->VariableDefinitions->NvRamMap = AllocateZeroPool (FileFormTags->VariableDefinitions->VariableSize);
3006 FileFormTags->VariableDefinitions->FakeNvRamMap = AllocateZeroPool (NvMapSize + FileFormTags->VariableDefinitions->VariableFakeSize);
3007
3008 CopyMem (FileFormTags-><