]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Universal/BdsDxe/Hotkey.c
The hotkey callback in BDS module should defer loading the boot option until the...
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / Hotkey.c
index bfad7ce7552b6ea94fe9a559c692ab8da1c86664..d0d9bb077bfb2b6e14d999abb35ca86a7576388a 100644 (file)
@@ -2,8 +2,8 @@
   Provides a way for 3rd party applications to register themselves for launch by the\r
   Boot Manager based on hot key\r
 \r
-Copyright (c) 2007 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -16,10 +16,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "Hotkey.h"\r
 \r
 \r
-LIST_ENTRY      mHotkeyList = INITIALIZE_LIST_HEAD_VARIABLE (mHotkeyList);\r
-BOOLEAN         mHotkeyCallbackPending = FALSE;\r
-EFI_EVENT       mHotkeyEvent;\r
-VOID            *mHotkeyRegistration;\r
+LIST_ENTRY        mHotkeyList = INITIALIZE_LIST_HEAD_VARIABLE (mHotkeyList);\r
+BDS_COMMON_OPTION *mHotkeyBootOption = NULL;\r
+EFI_EVENT         mHotkeyEvent;\r
+VOID              *mHotkeyRegistration;\r
 \r
 \r
 /**\r
@@ -101,11 +101,11 @@ RegisterHotkey (
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  KeyOptionSize = sizeof (EFI_KEY_OPTION) + GET_KEY_CODE_COUNT (KeyOption->KeyData.PackedValue) * sizeof (EFI_INPUT_KEY);\r
+  KeyOptionSize = sizeof (EFI_KEY_OPTION) + KeyOption->KeyData.Options.InputKeyCount * sizeof (EFI_INPUT_KEY);\r
   UpdateBootOption = FALSE;\r
 \r
   //\r
-  // check whether HotKey conflict with keys used by Setup Browser\r
+  // Check whether HotKey conflict with keys used by Setup Browser\r
   //\r
   KeyOrder = BdsLibGetVariableAndSize (\r
                VAR_KEY_ORDER,\r
@@ -132,6 +132,7 @@ RegisterHotkey (
                    &gEfiGlobalVariableGuid,\r
                    &TempOptionSize\r
                    );\r
+    ASSERT (TempOption != NULL);\r
 \r
     if (CompareMem (TempOption, KeyOption, TempOptionSize) == 0) {\r
       //\r
@@ -143,7 +144,7 @@ RegisterHotkey (
     }\r
 \r
     if (KeyOption->KeyData.PackedValue == TempOption->KeyData.PackedValue) {\r
-      if (GET_KEY_CODE_COUNT (KeyOption->KeyData.PackedValue) == 0 ||\r
+      if (KeyOption->KeyData.Options.InputKeyCount == 0 ||\r
           CompareMem (\r
             ((UINT8 *) TempOption) + sizeof (EFI_KEY_OPTION),\r
             ((UINT8 *) KeyOption) + sizeof (EFI_KEY_OPTION),\r
@@ -299,6 +300,50 @@ UnregisterHotkey (
   return Status;\r
 }\r
 \r
+/**\r
+  Try to boot the boot option triggered by hotkey.\r
+**/\r
+VOID\r
+HotkeyBoot (\r
+  VOID\r
+  )\r
+{\r
+  EFI_STATUS           Status;\r
+  UINTN                ExitDataSize;\r
+  CHAR16               *ExitData;\r
+  \r
+  if (mHotkeyBootOption != NULL) {\r
+    BdsLibConnectDevicePath (mHotkeyBootOption->DevicePath);\r
+\r
+    //\r
+    // Clear the screen before launch this BootOption\r
+    //\r
+    gST->ConOut->Reset (gST->ConOut, FALSE);\r
+\r
+    Status = BdsLibBootViaBootOption (mHotkeyBootOption, mHotkeyBootOption->DevicePath, &ExitDataSize, &ExitData);\r
+\r
+    if (EFI_ERROR (Status)) {\r
+      //\r
+      // Call platform action to indicate the boot fail\r
+      //\r
+      mHotkeyBootOption->StatusString = GetStringById (STRING_TOKEN (STR_BOOT_FAILED));\r
+      PlatformBdsBootFail (mHotkeyBootOption, Status, ExitData, ExitDataSize);\r
+    } else {\r
+      //\r
+      // Call platform action to indicate the boot success\r
+      //\r
+      mHotkeyBootOption->StatusString = GetStringById (STRING_TOKEN (STR_BOOT_SUCCEEDED));\r
+      PlatformBdsBootSuccess (mHotkeyBootOption);\r
+    }\r
+    FreePool (mHotkeyBootOption->Description);\r
+    FreePool (mHotkeyBootOption->DevicePath);\r
+    FreePool (mHotkeyBootOption->LoadOptions);\r
+    FreePool (mHotkeyBootOption);\r
+\r
+    mHotkeyBootOption = NULL;\r
+  }\r
+}\r
+\r
 /**\r
 \r
   This is the common notification function for HotKeys, it will be registered\r
@@ -311,6 +356,7 @@ UnregisterHotkey (
   @return  EFI_NOT_FOUND Fail to find boot option variable.\r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 HotkeyCallback (\r
   IN EFI_KEY_DATA     *KeyData\r
 )\r
@@ -320,24 +366,22 @@ HotkeyCallback (
   LIST_ENTRY         *Link;\r
   BDS_HOTKEY_OPTION  *Hotkey;\r
   UINT16             Buffer[10];\r
-  BDS_COMMON_OPTION  *BootOption;\r
-  UINTN              ExitDataSize;\r
-  CHAR16             *ExitData;\r
   EFI_STATUS         Status;\r
   EFI_KEY_DATA       *HotkeyData;\r
 \r
-  if (mHotkeyCallbackPending) {\r
+  if (mHotkeyBootOption != NULL) {\r
     //\r
-    // When responsing to a Hotkey, ignore sequential hotkey stroke until\r
-    // the current Boot#### load option returned\r
+    // Do not process sequential hotkey stroke until the current boot option returns\r
     //\r
     return EFI_SUCCESS;\r
   }\r
 \r
-  Status = EFI_SUCCESS;\r
-  Link = GetFirstNode (&mHotkeyList);\r
+  Status                 = EFI_SUCCESS;\r
 \r
-  while (!IsNull (&mHotkeyList, Link)) {\r
+  for ( Link = GetFirstNode (&mHotkeyList)\r
+      ; !IsNull (&mHotkeyList, Link)\r
+      ; Link = GetNextNode (&mHotkeyList, Link)\r
+      ) {\r
     HotkeyCatched = FALSE;\r
     Hotkey = BDS_HOTKEY_OPTION_FROM_LINK (Link);\r
 \r
@@ -347,26 +391,19 @@ HotkeyCallback (
     ASSERT (Hotkey->WaitingKey < (sizeof (Hotkey->KeyData) / sizeof (Hotkey->KeyData[0])));\r
     HotkeyData = &Hotkey->KeyData[Hotkey->WaitingKey];\r
     if ((KeyData->Key.ScanCode == HotkeyData->Key.ScanCode) &&\r
-       (KeyData->Key.UnicodeChar == HotkeyData->Key.UnicodeChar) &&\r
-       ((HotkeyData->KeyState.KeyShiftState & EFI_SHIFT_STATE_VALID) ? (KeyData->KeyState.KeyShiftState == HotkeyData->KeyState.KeyShiftState) : 1)) {\r
+        (KeyData->Key.UnicodeChar == HotkeyData->Key.UnicodeChar) &&\r
+        (((KeyData->KeyState.KeyShiftState & EFI_SHIFT_STATE_VALID) != 0) ? \r
+          (KeyData->KeyState.KeyShiftState == HotkeyData->KeyState.KeyShiftState) : TRUE\r
+        )\r
+       ) {\r
       //\r
-      // Receive an expecting key stroke\r
+      // For hotkey of key combination, transit to next waiting state\r
       //\r
-      if (Hotkey->CodeCount > 1) {\r
-        //\r
-        // For hotkey of key combination, transit to next waiting state\r
-        //\r
-        Hotkey->WaitingKey++;\r
+      Hotkey->WaitingKey++;\r
 \r
-        if (Hotkey->WaitingKey == Hotkey->CodeCount) {\r
-          //\r
-          // Received the whole key stroke sequence\r
-          //\r
-          HotkeyCatched = TRUE;\r
-        }\r
-      } else {\r
+      if (Hotkey->WaitingKey == Hotkey->CodeCount) {\r
         //\r
-        // For hotkey of single key stroke\r
+        // Received the whole key stroke sequence\r
         //\r
         HotkeyCatched = TRUE;\r
       }\r
@@ -389,38 +426,8 @@ HotkeyCallback (
       InitializeListHead (&BootLists);\r
 \r
       UnicodeSPrint (Buffer, sizeof (Buffer), L"Boot%04x", Hotkey->BootOptionNumber);\r
-      BootOption = BdsLibVariableToOption (&BootLists, Buffer);\r
-      if (BootOption == NULL) {\r
-        return EFI_NOT_FOUND;\r
-      }\r
-      BootOption->BootCurrent = Hotkey->BootOptionNumber;\r
-      BdsLibConnectDevicePath (BootOption->DevicePath);\r
-\r
-      //\r
-      // Clear the screen before launch this BootOption\r
-      //\r
-      gST->ConOut->Reset (gST->ConOut, FALSE);\r
-\r
-      mHotkeyCallbackPending = TRUE;\r
-      Status = BdsLibBootViaBootOption (BootOption, BootOption->DevicePath, &ExitDataSize, &ExitData);\r
-      mHotkeyCallbackPending = FALSE;\r
-\r
-      if (EFI_ERROR (Status)) {\r
-        //\r
-        // Call platform action to indicate the boot fail\r
-        //\r
-        BootOption->StatusString = GetStringById (STRING_TOKEN (STR_BOOT_FAILED));\r
-        PlatformBdsBootFail (BootOption, Status, ExitData, ExitDataSize);\r
-      } else {\r
-        //\r
-        // Call platform action to indicate the boot success\r
-        //\r
-        BootOption->StatusString = GetStringById (STRING_TOKEN (STR_BOOT_SUCCEEDED));\r
-        PlatformBdsBootSuccess (BootOption);\r
-      }\r
+      mHotkeyBootOption = BdsLibVariableToOption (&BootLists, Buffer);\r
     }\r
-\r
-    Link = GetNextNode (&mHotkeyList, Link);\r
   }\r
 \r
   return Status;\r
@@ -468,7 +475,7 @@ HotkeyRegisterNotify (
         return Status;\r
       }\r
       Index ++;\r
-    } while (Index < Hotkey->CodeCount);\r
+    } while ((Index < Hotkey->CodeCount) && (Index < (sizeof (Hotkey->KeyData) / sizeof (EFI_KEY_DATA))));\r
 \r
     Link = GetNextNode (&mHotkeyList, Link);\r
   }\r
@@ -538,7 +545,7 @@ HotkeyInsertList (
   BDS_HOTKEY_OPTION  *HotkeyLeft;\r
   BDS_HOTKEY_OPTION  *HotkeyRight;\r
   UINTN              Index;\r
-  UINT32             KeyOptions;\r
+  EFI_BOOT_KEY_DATA  KeyOptions;\r
   UINT32             KeyShiftStateLeft;\r
   UINT32             KeyShiftStateRight;\r
   EFI_INPUT_KEY      *InputKey;\r
@@ -552,19 +559,33 @@ HotkeyInsertList (
   HotkeyLeft->Signature = BDS_HOTKEY_OPTION_SIGNATURE;\r
   HotkeyLeft->BootOptionNumber = KeyOption->BootOption;\r
 \r
-  KeyOptions = KeyOption->KeyData.PackedValue;\r
+  KeyOptions = KeyOption->KeyData;\r
 \r
-  HotkeyLeft->CodeCount = (UINT8) GET_KEY_CODE_COUNT (KeyOptions);\r
+  HotkeyLeft->CodeCount = (UINT8) KeyOptions.Options.InputKeyCount;\r
 \r
   //\r
   // Map key shift state from KeyOptions to EFI_KEY_DATA.KeyState\r
   //\r
-  KeyShiftStateRight = (KeyOptions & EFI_KEY_OPTION_SHIFT) |\r
-                       ((KeyOptions & EFI_KEY_OPTION_CONTROL) << 1) |\r
-                       ((KeyOptions & EFI_KEY_OPTION_ALT) << 2) |\r
-                       ((KeyOptions & EFI_KEY_OPTION_LOGO) << 3) |\r
-                       ((KeyOptions & (EFI_KEY_OPTION_MENU | EFI_KEY_OPTION_SYSREQ)) << 4) |\r
-                       EFI_SHIFT_STATE_VALID;\r
+  KeyShiftStateRight = EFI_SHIFT_STATE_VALID;\r
+  if (KeyOptions.Options.ShiftPressed) {\r
+    KeyShiftStateRight |= EFI_RIGHT_SHIFT_PRESSED;\r
+  }\r
+  if (KeyOptions.Options.ControlPressed) {\r
+    KeyShiftStateRight |= EFI_RIGHT_CONTROL_PRESSED;\r
+  }\r
+  if (KeyOptions.Options.AltPressed) {\r
+    KeyShiftStateRight |= EFI_RIGHT_ALT_PRESSED;\r
+  }\r
+  if (KeyOptions.Options.LogoPressed) {\r
+    KeyShiftStateRight |= EFI_RIGHT_LOGO_PRESSED;\r
+  }\r
+  if (KeyOptions.Options.MenuPressed) {\r
+    KeyShiftStateRight |= EFI_MENU_KEY_PRESSED;\r
+  }\r
+  if (KeyOptions.Options.SysReqPressed) {\r
+    KeyShiftStateRight |= EFI_SYS_REQ_PRESSED;\r
+  }\r
+\r
 \r
   KeyShiftStateLeft = (KeyShiftStateRight & 0xffffff00) | ((KeyShiftStateRight & 0xff) << 1);\r
 \r
@@ -636,12 +657,14 @@ InitializeHotkeyService (
 \r
   //\r
   // Export our capability - EFI_BOOT_OPTION_SUPPORT_KEY and EFI_BOOT_OPTION_SUPPORT_APP\r
+  // with maximum number of key presses of 3\r
   //\r
   BootOptionSupport = EFI_BOOT_OPTION_SUPPORT_KEY | EFI_BOOT_OPTION_SUPPORT_APP;\r
+  SET_BOOT_OPTION_SUPPORT_KEY_COUNT (BootOptionSupport, 3);\r
   Status = gRT->SetVariable (\r
                   L"BootOptionSupport",\r
                   &gEfiGlobalVariableGuid,\r
-                  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
+                  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
                   sizeof (UINT32),\r
                   &BootOptionSupport\r
                   );\r