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
) + GET_KEY_CODE_COUNT (KeyOption
->KeyData
.PackedValue
) * 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 (GET_KEY_CODE_COUNT (KeyOption
->KeyData
.PackedValue
) == 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.
315 IN EFI_KEY_DATA
*KeyData
318 BOOLEAN HotkeyCatched
;
319 LIST_ENTRY BootLists
;
321 BDS_HOTKEY_OPTION
*Hotkey
;
323 BDS_COMMON_OPTION
*BootOption
;
327 EFI_KEY_DATA
*HotkeyData
;
329 if (mHotkeyCallbackPending
) {
331 // When responsing to a Hotkey, ignore sequential hotkey stroke until
332 // the current Boot#### load option returned
337 Status
= EFI_SUCCESS
;
338 Link
= GetFirstNode (&mHotkeyList
);
340 while (!IsNull (&mHotkeyList
, Link
)) {
341 HotkeyCatched
= FALSE
;
342 Hotkey
= BDS_HOTKEY_OPTION_FROM_LINK (Link
);
345 // Is this Key Stroke we are waiting for?
347 ASSERT (Hotkey
->WaitingKey
< (sizeof (Hotkey
->KeyData
) / sizeof (Hotkey
->KeyData
[0])));
348 HotkeyData
= &Hotkey
->KeyData
[Hotkey
->WaitingKey
];
349 if ((KeyData
->Key
.ScanCode
== HotkeyData
->Key
.ScanCode
) &&
350 (KeyData
->Key
.UnicodeChar
== HotkeyData
->Key
.UnicodeChar
) &&
351 ((HotkeyData
->KeyState
.KeyShiftState
& EFI_SHIFT_STATE_VALID
) ? (KeyData
->KeyState
.KeyShiftState
== HotkeyData
->KeyState
.KeyShiftState
) : 1)) {
353 // Receive an expecting key stroke
355 if (Hotkey
->CodeCount
> 1) {
357 // For hotkey of key combination, transit to next waiting state
359 Hotkey
->WaitingKey
++;
361 if (Hotkey
->WaitingKey
== Hotkey
->CodeCount
) {
363 // Received the whole key stroke sequence
365 HotkeyCatched
= TRUE
;
369 // For hotkey of single key stroke
371 HotkeyCatched
= TRUE
;
375 // Receive an unexpected key stroke, reset to initial waiting state
377 Hotkey
->WaitingKey
= 0;
382 // Reset to initial waiting state
384 Hotkey
->WaitingKey
= 0;
387 // Launch its BootOption
389 InitializeListHead (&BootLists
);
391 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"Boot%04x", Hotkey
->BootOptionNumber
);
392 BootOption
= BdsLibVariableToOption (&BootLists
, Buffer
);
393 if (BootOption
== NULL
) {
394 return EFI_NOT_FOUND
;
396 BootOption
->BootCurrent
= Hotkey
->BootOptionNumber
;
397 BdsLibConnectDevicePath (BootOption
->DevicePath
);
400 // Clear the screen before launch this BootOption
402 gST
->ConOut
->Reset (gST
->ConOut
, FALSE
);
404 mHotkeyCallbackPending
= TRUE
;
405 Status
= BdsLibBootViaBootOption (BootOption
, BootOption
->DevicePath
, &ExitDataSize
, &ExitData
);
406 mHotkeyCallbackPending
= FALSE
;
408 if (EFI_ERROR (Status
)) {
410 // Call platform action to indicate the boot fail
412 BootOption
->StatusString
= GetStringById (STRING_TOKEN (STR_BOOT_FAILED
));
413 PlatformBdsBootFail (BootOption
, Status
, ExitData
, ExitDataSize
);
416 // Call platform action to indicate the boot success
418 BootOption
->StatusString
= GetStringById (STRING_TOKEN (STR_BOOT_SUCCEEDED
));
419 PlatformBdsBootSuccess (BootOption
);
423 Link
= GetNextNode (&mHotkeyList
, Link
);
430 Register the common HotKey notify function to given SimpleTextInEx protocol instance.
432 @param SimpleTextInEx Simple Text Input Ex protocol instance
434 @retval EFI_SUCCESS Register hotkey notification function successfully.
435 @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary data structures.
439 HotkeyRegisterNotify (
440 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleTextInEx
446 BDS_HOTKEY_OPTION
*Hotkey
;
449 // Register notification function for each hotkey
451 Link
= GetFirstNode (&mHotkeyList
);
453 while (!IsNull (&mHotkeyList
, Link
)) {
454 Hotkey
= BDS_HOTKEY_OPTION_FROM_LINK (Link
);
458 Status
= SimpleTextInEx
->RegisterKeyNotify (
460 &Hotkey
->KeyData
[Index
],
462 &Hotkey
->NotifyHandle
464 if (EFI_ERROR (Status
)) {
466 // some of the hotkey registry failed
471 } while (Index
< Hotkey
->CodeCount
);
473 Link
= GetNextNode (&mHotkeyList
, Link
);
480 Callback function for SimpleTextInEx protocol install events
482 @param Event the event that is signaled.
483 @param Context not used here.
496 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleTextInEx
;
499 BufferSize
= sizeof (EFI_HANDLE
);
500 Status
= gBS
->LocateHandle (
507 if (EFI_ERROR (Status
)) {
509 // If no more notification events exist
514 Status
= gBS
->HandleProtocol (
516 &gEfiSimpleTextInputExProtocolGuid
,
517 (VOID
**) &SimpleTextInEx
519 ASSERT_EFI_ERROR (Status
);
521 HotkeyRegisterNotify (SimpleTextInEx
);
526 Insert Key Option to hotkey list.
528 @param KeyOption The Hot Key Option to be added to hotkey list.
530 @retval EFI_SUCCESS Add to hotkey list success.
531 @retval EFI_OUT_OF_RESOURCES Fail to allocate memory resource.
535 IN EFI_KEY_OPTION
*KeyOption
538 BDS_HOTKEY_OPTION
*HotkeyLeft
;
539 BDS_HOTKEY_OPTION
*HotkeyRight
;
542 UINT32 KeyShiftStateLeft
;
543 UINT32 KeyShiftStateRight
;
544 EFI_INPUT_KEY
*InputKey
;
545 EFI_KEY_DATA
*KeyData
;
547 HotkeyLeft
= AllocateZeroPool (sizeof (BDS_HOTKEY_OPTION
));
548 if (HotkeyLeft
== NULL
) {
549 return EFI_OUT_OF_RESOURCES
;
552 HotkeyLeft
->Signature
= BDS_HOTKEY_OPTION_SIGNATURE
;
553 HotkeyLeft
->BootOptionNumber
= KeyOption
->BootOption
;
555 KeyOptions
= KeyOption
->KeyData
.PackedValue
;
557 HotkeyLeft
->CodeCount
= (UINT8
) GET_KEY_CODE_COUNT (KeyOptions
);
560 // Map key shift state from KeyOptions to EFI_KEY_DATA.KeyState
562 KeyShiftStateRight
= (KeyOptions
& EFI_KEY_OPTION_SHIFT
) |
563 ((KeyOptions
& EFI_KEY_OPTION_CONTROL
) << 1) |
564 ((KeyOptions
& EFI_KEY_OPTION_ALT
) << 2) |
565 ((KeyOptions
& EFI_KEY_OPTION_LOGO
) << 3) |
566 ((KeyOptions
& (EFI_KEY_OPTION_MENU
| EFI_KEY_OPTION_SYSREQ
)) << 4) |
567 EFI_SHIFT_STATE_VALID
;
569 KeyShiftStateLeft
= (KeyShiftStateRight
& 0xffffff00) | ((KeyShiftStateRight
& 0xff) << 1);
571 InputKey
= (EFI_INPUT_KEY
*) (((UINT8
*) KeyOption
) + sizeof (EFI_KEY_OPTION
));
574 KeyData
= &HotkeyLeft
->KeyData
[0];
577 // If Key CodeCount is 0, then only KeyData[0] is used;
578 // if Key CodeCount is n, then KeyData[0]~KeyData[n-1] are used
580 KeyData
->Key
.ScanCode
= InputKey
[Index
].ScanCode
;
581 KeyData
->Key
.UnicodeChar
= InputKey
[Index
].UnicodeChar
;
582 KeyData
->KeyState
.KeyShiftState
= KeyShiftStateLeft
;
586 } while (Index
< HotkeyLeft
->CodeCount
);
587 InsertTailList (&mHotkeyList
, &HotkeyLeft
->Link
);
589 if (KeyShiftStateLeft
!= KeyShiftStateRight
) {
591 // Need an extra hotkey for shift key on right
593 HotkeyRight
= AllocateCopyPool (sizeof (BDS_HOTKEY_OPTION
), HotkeyLeft
);
594 if (HotkeyRight
== NULL
) {
595 return EFI_OUT_OF_RESOURCES
;
599 KeyData
= &HotkeyRight
->KeyData
[0];
602 // Key.ScanCode and Key.UnicodeChar have already been initialized,
603 // only need to update KeyState.KeyShiftState
605 KeyData
->KeyState
.KeyShiftState
= KeyShiftStateRight
;
609 } while (Index
< HotkeyRight
->CodeCount
);
610 InsertTailList (&mHotkeyList
, &HotkeyRight
->Link
);
618 Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.
620 @retval EFI_SUCCESS Hotkey services successfully initialized.
621 @retval EFI_NOT_FOUND Can not find the "KeyOrder" variable
624 InitializeHotkeyService (
629 UINT32 BootOptionSupport
;
633 UINT16 KeyOptionName
[8];
635 EFI_KEY_OPTION
*KeyOption
;
638 // Export our capability - EFI_BOOT_OPTION_SUPPORT_KEY and EFI_BOOT_OPTION_SUPPORT_APP
640 BootOptionSupport
= EFI_BOOT_OPTION_SUPPORT_KEY
| EFI_BOOT_OPTION_SUPPORT_APP
;
641 Status
= gRT
->SetVariable (
642 L
"BootOptionSupport",
643 &gEfiGlobalVariableGuid
,
644 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
650 // Get valid Key Option List from private EFI variable "KeyOrder"
652 KeyOrder
= BdsLibGetVariableAndSize (
654 &gEfiGlobalVariableGuid
,
658 if (KeyOrder
== NULL
) {
659 return EFI_NOT_FOUND
;
662 for (Index
= 0; Index
< KeyOrderSize
/ sizeof (UINT16
); Index
++) {
663 UnicodeSPrint (KeyOptionName
, sizeof (KeyOptionName
), L
"Key%04x", KeyOrder
[Index
]);
664 KeyOption
= BdsLibGetVariableAndSize (
666 &gEfiGlobalVariableGuid
,
670 if (KeyOption
== NULL
|| !IsKeyOptionValid (KeyOption
)) {
671 UnregisterHotkey (KeyOrder
[Index
]);
673 HotkeyInsertList (KeyOption
);
678 // Register Protocol notify for Hotkey service
680 Status
= gBS
->CreateEvent (
687 ASSERT_EFI_ERROR (Status
);
690 // Register for protocol notifications on this event
692 Status
= gBS
->RegisterProtocolNotify (
693 &gEfiSimpleTextInputExProtocolGuid
,
697 ASSERT_EFI_ERROR (Status
);