2 Provides a way for 3rd party applications to register themselves for launch by the
3 Boot Manager based on hot key
5 Copyright (c) 2007 - 2008, Intel Corporation. <BR>
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 LIST_ENTRY mHotkeyList
= INITIALIZE_LIST_HEAD_VARIABLE (mHotkeyList
);
20 BOOLEAN mHotkeyCallbackPending
= FALSE
;
21 EFI_EVENT mHotkeyEvent
;
22 VOID
*mHotkeyRegistration
;
26 Check if the Key Option is valid or not.
28 @param KeyOption The Hot Key Option to be checked.
30 @retval TRUE The Hot Key Option is valid.
31 @retval FALSE The Hot Key Option is invalid.
36 IN EFI_KEY_OPTION
*KeyOption
39 UINT16 BootOptionName
[10];
45 // Check whether corresponding Boot Option exist
47 UnicodeSPrint (BootOptionName
, sizeof (BootOptionName
), L
"Boot%04x", KeyOption
->BootOption
);
48 BootOptionVar
= BdsLibGetVariableAndSize (
50 &gEfiGlobalVariableGuid
,
54 if (BootOptionVar
== NULL
|| BootOptionSize
== 0) {
59 // Check CRC for Boot Option
61 gBS
->CalculateCrc32 (BootOptionVar
, BootOptionSize
, &Crc
);
62 FreePool (BootOptionVar
);
64 return (BOOLEAN
) ((KeyOption
->BootOptionCrc
== Crc
) ? TRUE
: FALSE
);
68 Create Key#### for the given hotkey.
70 @param KeyOption The Hot Key Option to be added.
71 @param KeyOptionNumber The key option number for Key#### (optional).
73 @retval EFI_SUCCESS Register hotkey successfully.
74 @retval EFI_INVALID_PARAMETER The hotkey option is invalid.
75 @retval EFI_OUT_OF_RESOURCES Fail to allocate memory resource.
80 IN EFI_KEY_OPTION
*KeyOption
,
81 OUT UINT16
*KeyOptionNumber
84 UINT16 KeyOptionName
[10];
89 UINT16 MaxOptionNumber
;
90 UINT16 RegisterOptionNumber
;
91 EFI_KEY_OPTION
*TempOption
;
95 BOOLEAN UpdateBootOption
;
98 // Validate the given key option
100 if (!IsKeyOptionValid (KeyOption
)) {
101 return EFI_INVALID_PARAMETER
;
104 KeyOptionSize
= sizeof (EFI_KEY_OPTION
) + KeyOption
->KeyData
.Options
.InputKeyCount
* sizeof (EFI_INPUT_KEY
);
105 UpdateBootOption
= FALSE
;
108 // Check whether HotKey conflict with keys used by Setup Browser
110 KeyOrder
= BdsLibGetVariableAndSize (
112 &gEfiGlobalVariableGuid
,
115 if (KeyOrder
== NULL
) {
120 // Find free key option number
124 for (Index
= 0; Index
< KeyOrderSize
/ sizeof (UINT16
); Index
++) {
125 if (MaxOptionNumber
< KeyOrder
[Index
]) {
126 MaxOptionNumber
= KeyOrder
[Index
];
129 UnicodeSPrint (KeyOptionName
, sizeof (KeyOptionName
), L
"Key%04x", KeyOrder
[Index
]);
130 TempOption
= BdsLibGetVariableAndSize (
132 &gEfiGlobalVariableGuid
,
136 if (CompareMem (TempOption
, KeyOption
, TempOptionSize
) == 0) {
138 // Got the option, so just return
140 FreePool (TempOption
);
145 if (KeyOption
->KeyData
.PackedValue
== TempOption
->KeyData
.PackedValue
) {
146 if (KeyOption
->KeyData
.Options
.InputKeyCount
== 0 ||
148 ((UINT8
*) TempOption
) + sizeof (EFI_KEY_OPTION
),
149 ((UINT8
*) KeyOption
) + sizeof (EFI_KEY_OPTION
),
150 KeyOptionSize
- sizeof (EFI_KEY_OPTION
)
153 // Hotkey is the same but BootOption changed, need update
155 UpdateBootOption
= TRUE
;
160 FreePool (TempOption
);
163 if (UpdateBootOption
) {
164 RegisterOptionNumber
= KeyOrder
[Index
];
165 FreePool (TempOption
);
167 RegisterOptionNumber
= (UINT16
) (MaxOptionNumber
+ 1);
170 if (KeyOptionNumber
!= NULL
) {
171 *KeyOptionNumber
= RegisterOptionNumber
;
175 // Create variable Key####
177 UnicodeSPrint (KeyOptionName
, sizeof (KeyOptionName
), L
"Key%04x", RegisterOptionNumber
);
178 Status
= gRT
->SetVariable (
180 &gEfiGlobalVariableGuid
,
181 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
185 if (EFI_ERROR (Status
)) {
191 // Update the key order variable - "KeyOrder"
193 if (!UpdateBootOption
) {
194 Index
= KeyOrderSize
/ sizeof (UINT16
);
195 KeyOrderSize
+= sizeof (UINT16
);
198 NewKeyOrder
= AllocatePool (KeyOrderSize
);
199 if (NewKeyOrder
== NULL
) {
201 return EFI_OUT_OF_RESOURCES
;
204 if (KeyOrder
!= NULL
) {
205 CopyMem (NewKeyOrder
, KeyOrder
, KeyOrderSize
);
208 NewKeyOrder
[Index
] = RegisterOptionNumber
;
210 Status
= gRT
->SetVariable (
212 &gEfiGlobalVariableGuid
,
213 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
219 FreePool (NewKeyOrder
);
226 Delete Key#### for the given Key Option number.
228 @param KeyOptionNumber Key option number for Key####
230 @retval EFI_SUCCESS Unregister hotkey successfully.
231 @retval EFI_NOT_FOUND No Key#### is found for the given Key Option number.
236 IN UINT16 KeyOptionNumber
239 UINT16 KeyOption
[10];
247 // Delete variable Key####
249 UnicodeSPrint (KeyOption
, sizeof (KeyOption
), L
"Key%04x", KeyOptionNumber
);
252 &gEfiGlobalVariableGuid
,
253 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
259 // Adjust key order array
261 KeyOrder
= BdsLibGetVariableAndSize (
263 &gEfiGlobalVariableGuid
,
266 if (KeyOrder
== NULL
) {
271 for (Index
= 0; Index
< KeyOrderSize
/ sizeof (UINT16
); Index
++) {
272 if (KeyOrder
[Index
] == KeyOptionNumber
) {
278 if (Index
!= KeyOrderSize
/ sizeof (UINT16
)) {
280 // KeyOptionNumber found in "KeyOrder", delete it
282 for (Index
= Index2Del
; Index
< KeyOrderSize
/ sizeof (UINT16
) - 1; Index
++) {
283 KeyOrder
[Index
] = KeyOrder
[Index
+ 1];
286 KeyOrderSize
-= sizeof (UINT16
);
289 Status
= gRT
->SetVariable (
291 &gEfiGlobalVariableGuid
,
292 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
304 This is the common notification function for HotKeys, it will be registered
305 with SimpleTextInEx protocol interface - RegisterKeyNotify() of ConIn handle.
307 @param KeyData A pointer to a buffer that is filled in with the keystroke
308 information for the key that was pressed.
310 @retval EFI_SUCCESS KeyData is successfully processed.
311 @return EFI_NOT_FOUND Fail to find boot option variable.
316 IN EFI_KEY_DATA
*KeyData
319 BOOLEAN HotkeyCatched
;
320 LIST_ENTRY BootLists
;
322 BDS_HOTKEY_OPTION
*Hotkey
;
324 BDS_COMMON_OPTION
*BootOption
;
328 EFI_KEY_DATA
*HotkeyData
;
330 if (mHotkeyCallbackPending
) {
332 // When responsing to a Hotkey, ignore sequential hotkey stroke until
333 // the current Boot#### load option returned
338 Status
= EFI_SUCCESS
;
339 Link
= GetFirstNode (&mHotkeyList
);
341 while (!IsNull (&mHotkeyList
, Link
)) {
342 HotkeyCatched
= FALSE
;
343 Hotkey
= BDS_HOTKEY_OPTION_FROM_LINK (Link
);
346 // Is this Key Stroke we are waiting for?
348 ASSERT (Hotkey
->WaitingKey
< (sizeof (Hotkey
->KeyData
) / sizeof (Hotkey
->KeyData
[0])));
349 HotkeyData
= &Hotkey
->KeyData
[Hotkey
->WaitingKey
];
350 if ((KeyData
->Key
.ScanCode
== HotkeyData
->Key
.ScanCode
) &&
351 (KeyData
->Key
.UnicodeChar
== HotkeyData
->Key
.UnicodeChar
) &&
352 ((HotkeyData
->KeyState
.KeyShiftState
& EFI_SHIFT_STATE_VALID
) ? (KeyData
->KeyState
.KeyShiftState
== HotkeyData
->KeyState
.KeyShiftState
) : TRUE
)) {
354 // Receive an expecting key stroke
356 if (Hotkey
->CodeCount
> 1) {
358 // For hotkey of key combination, transit to next waiting state
360 Hotkey
->WaitingKey
++;
362 if (Hotkey
->WaitingKey
== Hotkey
->CodeCount
) {
364 // Received the whole key stroke sequence
366 HotkeyCatched
= TRUE
;
370 // For hotkey of single key stroke
372 HotkeyCatched
= TRUE
;
376 // Receive an unexpected key stroke, reset to initial waiting state
378 Hotkey
->WaitingKey
= 0;
383 // Reset to initial waiting state
385 Hotkey
->WaitingKey
= 0;
388 // Launch its BootOption
390 InitializeListHead (&BootLists
);
392 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"Boot%04x", Hotkey
->BootOptionNumber
);
393 BootOption
= BdsLibVariableToOption (&BootLists
, Buffer
);
394 if (BootOption
== NULL
) {
395 return EFI_NOT_FOUND
;
397 BootOption
->BootCurrent
= Hotkey
->BootOptionNumber
;
398 BdsLibConnectDevicePath (BootOption
->DevicePath
);
401 // Clear the screen before launch this BootOption
403 gST
->ConOut
->Reset (gST
->ConOut
, FALSE
);
405 mHotkeyCallbackPending
= TRUE
;
406 Status
= BdsLibBootViaBootOption (BootOption
, BootOption
->DevicePath
, &ExitDataSize
, &ExitData
);
407 mHotkeyCallbackPending
= FALSE
;
409 if (EFI_ERROR (Status
)) {
411 // Call platform action to indicate the boot fail
413 BootOption
->StatusString
= GetStringById (STRING_TOKEN (STR_BOOT_FAILED
));
414 PlatformBdsBootFail (BootOption
, Status
, ExitData
, ExitDataSize
);
417 // Call platform action to indicate the boot success
419 BootOption
->StatusString
= GetStringById (STRING_TOKEN (STR_BOOT_SUCCEEDED
));
420 PlatformBdsBootSuccess (BootOption
);
424 Link
= GetNextNode (&mHotkeyList
, Link
);
431 Register the common HotKey notify function to given SimpleTextInEx protocol instance.
433 @param SimpleTextInEx Simple Text Input Ex protocol instance
435 @retval EFI_SUCCESS Register hotkey notification function successfully.
436 @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary data structures.
440 HotkeyRegisterNotify (
441 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleTextInEx
447 BDS_HOTKEY_OPTION
*Hotkey
;
450 // Register notification function for each hotkey
452 Link
= GetFirstNode (&mHotkeyList
);
454 while (!IsNull (&mHotkeyList
, Link
)) {
455 Hotkey
= BDS_HOTKEY_OPTION_FROM_LINK (Link
);
459 Status
= SimpleTextInEx
->RegisterKeyNotify (
461 &Hotkey
->KeyData
[Index
],
463 &Hotkey
->NotifyHandle
465 if (EFI_ERROR (Status
)) {
467 // some of the hotkey registry failed
472 } while (Index
< Hotkey
->CodeCount
);
474 Link
= GetNextNode (&mHotkeyList
, Link
);
481 Callback function for SimpleTextInEx protocol install events
483 @param Event the event that is signaled.
484 @param Context not used here.
497 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleTextInEx
;
500 BufferSize
= sizeof (EFI_HANDLE
);
501 Status
= gBS
->LocateHandle (
508 if (EFI_ERROR (Status
)) {
510 // If no more notification events exist
515 Status
= gBS
->HandleProtocol (
517 &gEfiSimpleTextInputExProtocolGuid
,
518 (VOID
**) &SimpleTextInEx
520 ASSERT_EFI_ERROR (Status
);
522 HotkeyRegisterNotify (SimpleTextInEx
);
527 Insert Key Option to hotkey list.
529 @param KeyOption The Hot Key Option to be added to hotkey list.
531 @retval EFI_SUCCESS Add to hotkey list success.
532 @retval EFI_OUT_OF_RESOURCES Fail to allocate memory resource.
536 IN EFI_KEY_OPTION
*KeyOption
539 BDS_HOTKEY_OPTION
*HotkeyLeft
;
540 BDS_HOTKEY_OPTION
*HotkeyRight
;
542 EFI_BOOT_KEY_DATA KeyOptions
;
543 UINT32 KeyShiftStateLeft
;
544 UINT32 KeyShiftStateRight
;
545 EFI_INPUT_KEY
*InputKey
;
546 EFI_KEY_DATA
*KeyData
;
548 HotkeyLeft
= AllocateZeroPool (sizeof (BDS_HOTKEY_OPTION
));
549 if (HotkeyLeft
== NULL
) {
550 return EFI_OUT_OF_RESOURCES
;
553 HotkeyLeft
->Signature
= BDS_HOTKEY_OPTION_SIGNATURE
;
554 HotkeyLeft
->BootOptionNumber
= KeyOption
->BootOption
;
556 KeyOptions
= KeyOption
->KeyData
;
558 HotkeyLeft
->CodeCount
= (UINT8
) KeyOptions
.Options
.InputKeyCount
;
561 // Map key shift state from KeyOptions to EFI_KEY_DATA.KeyState
563 KeyShiftStateRight
= EFI_SHIFT_STATE_VALID
;
564 if (KeyOptions
.Options
.ShiftPressed
) {
565 KeyShiftStateRight
|= EFI_RIGHT_SHIFT_PRESSED
;
567 if (KeyOptions
.Options
.ControlPressed
) {
568 KeyShiftStateRight
|= EFI_RIGHT_CONTROL_PRESSED
;
570 if (KeyOptions
.Options
.AltPressed
) {
571 KeyShiftStateRight
|= EFI_RIGHT_ALT_PRESSED
;
573 if (KeyOptions
.Options
.LogoPressed
) {
574 KeyShiftStateRight
|= EFI_RIGHT_LOGO_PRESSED
;
576 if (KeyOptions
.Options
.MenuPressed
) {
577 KeyShiftStateRight
|= EFI_MENU_KEY_PRESSED
;
579 if (KeyOptions
.Options
.SysReqPressed
) {
580 KeyShiftStateRight
|= EFI_SYS_REQ_PRESSED
;
584 KeyShiftStateLeft
= (KeyShiftStateRight
& 0xffffff00) | ((KeyShiftStateRight
& 0xff) << 1);
586 InputKey
= (EFI_INPUT_KEY
*) (((UINT8
*) KeyOption
) + sizeof (EFI_KEY_OPTION
));
589 KeyData
= &HotkeyLeft
->KeyData
[0];
592 // If Key CodeCount is 0, then only KeyData[0] is used;
593 // if Key CodeCount is n, then KeyData[0]~KeyData[n-1] are used
595 KeyData
->Key
.ScanCode
= InputKey
[Index
].ScanCode
;
596 KeyData
->Key
.UnicodeChar
= InputKey
[Index
].UnicodeChar
;
597 KeyData
->KeyState
.KeyShiftState
= KeyShiftStateLeft
;
601 } while (Index
< HotkeyLeft
->CodeCount
);
602 InsertTailList (&mHotkeyList
, &HotkeyLeft
->Link
);
604 if (KeyShiftStateLeft
!= KeyShiftStateRight
) {
606 // Need an extra hotkey for shift key on right
608 HotkeyRight
= AllocateCopyPool (sizeof (BDS_HOTKEY_OPTION
), HotkeyLeft
);
609 if (HotkeyRight
== NULL
) {
610 return EFI_OUT_OF_RESOURCES
;
614 KeyData
= &HotkeyRight
->KeyData
[0];
617 // Key.ScanCode and Key.UnicodeChar have already been initialized,
618 // only need to update KeyState.KeyShiftState
620 KeyData
->KeyState
.KeyShiftState
= KeyShiftStateRight
;
624 } while (Index
< HotkeyRight
->CodeCount
);
625 InsertTailList (&mHotkeyList
, &HotkeyRight
->Link
);
633 Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.
635 @retval EFI_SUCCESS Hotkey services successfully initialized.
636 @retval EFI_NOT_FOUND Can not find the "KeyOrder" variable
639 InitializeHotkeyService (
644 UINT32 BootOptionSupport
;
648 UINT16 KeyOptionName
[8];
650 EFI_KEY_OPTION
*KeyOption
;
653 // Export our capability - EFI_BOOT_OPTION_SUPPORT_KEY and EFI_BOOT_OPTION_SUPPORT_APP
654 // with maximum number of key presses of 3
656 BootOptionSupport
= EFI_BOOT_OPTION_SUPPORT_KEY
| EFI_BOOT_OPTION_SUPPORT_APP
;
657 SET_BOOT_OPTION_SUPPORT_KEY_COUNT (BootOptionSupport
, 3);
658 Status
= gRT
->SetVariable (
659 L
"BootOptionSupport",
660 &gEfiGlobalVariableGuid
,
661 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
667 // Get valid Key Option List from private EFI variable "KeyOrder"
669 KeyOrder
= BdsLibGetVariableAndSize (
671 &gEfiGlobalVariableGuid
,
675 if (KeyOrder
== NULL
) {
676 return EFI_NOT_FOUND
;
679 for (Index
= 0; Index
< KeyOrderSize
/ sizeof (UINT16
); Index
++) {
680 UnicodeSPrint (KeyOptionName
, sizeof (KeyOptionName
), L
"Key%04x", KeyOrder
[Index
]);
681 KeyOption
= BdsLibGetVariableAndSize (
683 &gEfiGlobalVariableGuid
,
687 if (KeyOption
== NULL
|| !IsKeyOptionValid (KeyOption
)) {
688 UnregisterHotkey (KeyOrder
[Index
]);
690 HotkeyInsertList (KeyOption
);
695 // Register Protocol notify for Hotkey service
697 Status
= gBS
->CreateEvent (
704 ASSERT_EFI_ERROR (Status
);
707 // Register for protocol notifications on this event
709 Status
= gBS
->RegisterProtocolNotify (
710 &gEfiSimpleTextInputExProtocolGuid
,
714 ASSERT_EFI_ERROR (Status
);