]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Universal/BdsDxe/BootMngr/BootManager.c
Update for IntelFrameworkModulePkg.
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / BootMngr / BootManager.c
index 615c189d8daf1bd644b20c1075aec4028aa447df..f86d55594b90437f63cd85304fb03aea9f776c27 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
   The platform boot manager reference implementation\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 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
@@ -15,9 +15,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "BootManager.h"\r
 \r
 UINT16             mKeyInput;\r
-EFI_GUID           mBootManagerGuid = BOOT_MANAGER_FORMSET_GUID;\r
-LIST_ENTRY         *mBootOptionsList;\r
+LIST_ENTRY         mBootOptionsList;\r
 BDS_COMMON_OPTION  *gOption;\r
+CHAR16             *mDeviceTypeStr[] = {\r
+  L"Legacy BEV",\r
+  L"Legacy Floppy",\r
+  L"Legacy Hard Drive",\r
+  L"Legacy CD ROM",\r
+  L"Legacy PCMCIA",\r
+  L"Legacy USB",\r
+  L"Legacy Embedded Network",\r
+  L"Legacy Unknown Device"\r
+};\r
+\r
 \r
 HII_VENDOR_DEVICE_PATH  mBootManagerHiiVendorDevicePath = {\r
   {\r
@@ -29,10 +39,7 @@ HII_VENDOR_DEVICE_PATH  mBootManagerHiiVendorDevicePath = {
         (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
       }\r
     },\r
-    //\r
-    // {1DDDBE15-481D-4d2b-8277-B191EAF66525}\r
-    //\r
-    { 0x1dddbe15, 0x481d, 0x4d2b, { 0x82, 0x77, 0xb1, 0x91, 0xea, 0xf6, 0x65, 0x25 } }\r
+    BOOT_MANAGER_FORMSET_GUID\r
   },\r
   {\r
     END_DEVICE_PATH_TYPE,\r
@@ -56,7 +63,7 @@ BOOT_MANAGER_CALLBACK_DATA  gBootManagerPrivate = {
 };\r
 \r
 /**\r
-  This call back funtion is registered with Boot Manager formset.\r
+  This call back function is registered with Boot Manager formset.\r
   When user selects a boot option, this call back function will\r
   be triggered. The boot option is saved for later processing.\r
 \r
@@ -88,40 +95,47 @@ BootManagerCallback (
   LIST_ENTRY              *Link;\r
   UINT16                  KeyCount;\r
 \r
-  if ((Value == NULL) || (ActionRequest == NULL)) {\r
-    return EFI_INVALID_PARAMETER;\r
-  }\r
+  if (Action == EFI_BROWSER_ACTION_CHANGED) {\r
+    if ((Value == NULL) || (ActionRequest == NULL)) {\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
 \r
-  //\r
-  // Initialize the key count\r
-  //\r
-  KeyCount = 0;\r
+    //\r
+    // Initialize the key count\r
+    //\r
+    KeyCount = 0;\r
 \r
-  for (Link = mBootOptionsList->ForwardLink; Link != mBootOptionsList; Link = Link->ForwardLink) {\r
-    Option = CR (Link, BDS_COMMON_OPTION, Link, BDS_LOAD_OPTION_SIGNATURE);\r
+    for (Link = GetFirstNode (&mBootOptionsList); !IsNull (&mBootOptionsList, Link); Link = GetNextNode (&mBootOptionsList, Link)) {\r
+      Option = CR (Link, BDS_COMMON_OPTION, Link, BDS_LOAD_OPTION_SIGNATURE);\r
 \r
-    KeyCount++;\r
+      KeyCount++;\r
 \r
-    gOption = Option;\r
-\r
-    //\r
-    // Is this device the one chosen?\r
-    //\r
-    if (KeyCount == QuestionId) {\r
-      //\r
-      // Assigning the returned Key to a global allows the original routine to know what was chosen\r
-      //\r
-      mKeyInput = QuestionId;\r
+      gOption = Option;\r
 \r
       //\r
-      // Request to exit SendForm(), so that we could boot the selected option\r
+      // Is this device the one chosen?\r
       //\r
-      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
-      break;\r
+      if (KeyCount == QuestionId) {\r
+        //\r
+        // Assigning the returned Key to a global allows the original routine to know what was chosen\r
+        //\r
+        mKeyInput = QuestionId;\r
+\r
+        //\r
+        // Request to exit SendForm(), so that we could boot the selected option\r
+        //\r
+        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
+        break;\r
+      }\r
     }\r
+\r
+    return EFI_SUCCESS;\r
   }\r
 \r
-  return EFI_SUCCESS;\r
+  //\r
+  // All other action return unsupported.\r
+  //\r
+  return EFI_UNSUPPORTED;\r
 }\r
 \r
 /**\r
@@ -129,7 +143,8 @@ BootManagerCallback (
   Registers HII packages for the Boot Manger to HII Database.\r
   It also registers the browser call back function.\r
 \r
-  @return Status of gBS->InstallMultipleProtocolInterfaces() and gHiiDatabase->NewPackageList()\r
+  @retval  EFI_SUCCESS           HII packages for the Boot Manager were registered successfully.\r
+  @retval  EFI_OUT_OF_RESOURCES  HII packages for the Boot Manager failed to be registered.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -138,7 +153,6 @@ InitializeBootManager (
   )\r
 {\r
   EFI_STATUS                  Status;\r
-  EFI_HII_PACKAGE_LIST_HEADER *PackageList;\r
 \r
   //\r
   // Install Device Path Protocol and Config Access protocol to driver handle\r
@@ -156,22 +170,23 @@ InitializeBootManager (
   //\r
   // Publish our HII data\r
   //\r
-  PackageList = HiiLibPreparePackageList (2, &mBootManagerGuid, BootManagerVfrBin, BdsDxeStrings);\r
-  ASSERT (PackageList != NULL);\r
-\r
-  Status = gHiiDatabase->NewPackageList (\r
-                           gHiiDatabase,\r
-                           PackageList,\r
-                           gBootManagerPrivate.DriverHandle,\r
-                           &gBootManagerPrivate.HiiHandle\r
-                           );\r
-  FreePool (PackageList);\r
-\r
+  gBootManagerPrivate.HiiHandle = HiiAddPackages (\r
+                                    &gBootManagerFormSetGuid,\r
+                                    gBootManagerPrivate.DriverHandle,\r
+                                    BootManagerVfrBin,\r
+                                    BdsDxeStrings,\r
+                                    NULL\r
+                                    );\r
+  if (gBootManagerPrivate.HiiHandle == NULL) {\r
+    Status = EFI_OUT_OF_RESOURCES;\r
+  } else {\r
+    Status = EFI_SUCCESS;\r
+  }\r
   return Status;\r
 }\r
 \r
 /**\r
-  This funtion invokees Boot Manager. If all devices have not a chance to be connected,\r
+  This function invokes Boot Manager. If all devices have not a chance to be connected,\r
   the connect all will be triggered. It then enumerate all boot options. If \r
   a boot option from the Boot Manager page is selected, Boot Manager will boot\r
   from this boot option.\r
@@ -185,21 +200,27 @@ CallBootManager (
   EFI_STATUS                  Status;\r
   BDS_COMMON_OPTION           *Option;\r
   LIST_ENTRY                  *Link;\r
-  EFI_HII_UPDATE_DATA         UpdateData;\r
   CHAR16                      *ExitData;\r
   UINTN                       ExitDataSize;\r
   EFI_STRING_ID               Token;\r
   EFI_INPUT_KEY               Key;\r
-  LIST_ENTRY                  BdsBootOptionList;\r
   CHAR16                      *HelpString;\r
   EFI_STRING_ID               HelpToken;\r
   UINT16                      *TempStr;\r
   EFI_HII_HANDLE              HiiHandle;\r
   EFI_BROWSER_ACTION_REQUEST  ActionRequest;\r
   UINTN                       TempSize;\r
-\r
-  gOption = NULL;\r
-  InitializeListHead (&BdsBootOptionList);\r
+  VOID                        *StartOpCodeHandle;\r
+  VOID                        *EndOpCodeHandle;\r
+  EFI_IFR_GUID_LABEL          *StartLabel;\r
+  EFI_IFR_GUID_LABEL          *EndLabel;\r
+  UINT16                      DeviceType;\r
+  BOOLEAN                     IsLegacyOption;\r
+  BOOLEAN                     NeedEndOp;\r
+\r
+  DeviceType = (UINT16) -1;\r
+  gOption    = NULL;\r
+  InitializeListHead (&mBootOptionsList);\r
 \r
   //\r
   // Connect all prior to entering the platform setup menu.\r
@@ -208,28 +229,37 @@ CallBootManager (
     BdsLibConnectAllDriversToAllControllers ();\r
     gConnectAllHappened = TRUE;\r
   }\r
-  //\r
-  // BugBug: Here we can not remove the legacy refresh macro, so we need\r
-  // get the boot order every time from "BootOrder" variable.\r
-  // Recreate the boot option list base on the BootOrder variable\r
-  //\r
-  BdsLibEnumerateAllBootOption (&BdsBootOptionList);\r
 \r
-  mBootOptionsList  = &BdsBootOptionList;\r
+  BdsLibEnumerateAllBootOption (&mBootOptionsList);\r
 \r
   HiiHandle = gBootManagerPrivate.HiiHandle;\r
 \r
   //\r
   // Allocate space for creation of UpdateData Buffer\r
   //\r
-  UpdateData.BufferSize = 0x1000;\r
-  UpdateData.Offset = 0;\r
-  UpdateData.Data = AllocateZeroPool (0x1000);\r
-  ASSERT (UpdateData.Data != NULL);\r
+  StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
+  ASSERT (StartOpCodeHandle != NULL);\r
 \r
-  mKeyInput = 0;\r
+  EndOpCodeHandle = HiiAllocateOpCodeHandle ();\r
+  ASSERT (EndOpCodeHandle != NULL);\r
+\r
+  //\r
+  // Create Hii Extend Label OpCode as the start opcode\r
+  //\r
+  StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
+  StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
+  StartLabel->Number       = LABEL_BOOT_OPTION;\r
+\r
+  //\r
+  // Create Hii Extend Label OpCode as the end opcode\r
+  //\r
+  EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
+  EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
+  EndLabel->Number       = LABEL_BOOT_OPTION_END;\r
 \r
-  for (Link = BdsBootOptionList.ForwardLink; Link != &BdsBootOptionList; Link = Link->ForwardLink) {\r
+  mKeyInput = 0;\r
+  NeedEndOp = FALSE;\r
+  for (Link = GetFirstNode (&mBootOptionsList); !IsNull (&mBootOptionsList, Link); Link = GetNextNode (&mBootOptionsList, Link)) {\r
     Option = CR (Link, BDS_COMMON_OPTION, Link, BDS_LOAD_OPTION_SIGNATURE);\r
 \r
     //\r
@@ -240,11 +270,44 @@ CallBootManager (
     //\r
     // Don't display the boot option marked as LOAD_OPTION_HIDDEN\r
     //\r
-    if (Option->Attribute & LOAD_OPTION_HIDDEN) {\r
+    if ((Option->Attribute & LOAD_OPTION_HIDDEN) != 0) {\r
       continue;\r
     }\r
 \r
-    HiiLibNewString (HiiHandle, &Token, Option->Description);\r
+    //\r
+    // Group the legacy boot option in the sub title created dynamically\r
+    //\r
+    IsLegacyOption = (BOOLEAN) (\r
+                       (DevicePathType (Option->DevicePath) == BBS_DEVICE_PATH) &&\r
+                       (DevicePathSubType (Option->DevicePath) == BBS_BBS_DP)\r
+                       );\r
+\r
+    if (!IsLegacyOption && NeedEndOp) {\r
+      NeedEndOp = FALSE;\r
+      HiiCreateEndOpCode (StartOpCodeHandle);\r
+    }\r
+    \r
+    if (IsLegacyOption && DeviceType != ((BBS_BBS_DEVICE_PATH *) Option->DevicePath)->DeviceType) {\r
+      if (NeedEndOp) {\r
+        HiiCreateEndOpCode (StartOpCodeHandle);\r
+      }\r
+\r
+      DeviceType = ((BBS_BBS_DEVICE_PATH *) Option->DevicePath)->DeviceType;\r
+      Token      = HiiSetString (\r
+                     HiiHandle,\r
+                     0,\r
+                     mDeviceTypeStr[\r
+                       MIN (DeviceType & 0xF, sizeof (mDeviceTypeStr) / sizeof (mDeviceTypeStr[0]) - 1)\r
+                       ],\r
+                     NULL\r
+                     );\r
+      HiiCreateSubTitleOpCode (StartOpCodeHandle, Token, 0, 0, 1);\r
+      NeedEndOp = TRUE;\r
+    }\r
+\r
+    ASSERT (Option->Description != NULL);\r
+    \r
+    Token = HiiSetString (HiiHandle, 0, Option->Description, NULL);\r
 \r
     TempStr = DevicePathToStr (Option->DevicePath);\r
     TempSize = StrSize (TempStr);\r
@@ -253,34 +316,39 @@ CallBootManager (
     StrCat (HelpString, L"Device Path : ");\r
     StrCat (HelpString, TempStr);\r
 \r
-    HiiLibNewString (HiiHandle, &HelpToken, HelpString);\r
+    HelpToken = HiiSetString (HiiHandle, 0, HelpString, NULL);\r
 \r
-    CreateActionOpCode (\r
+    HiiCreateActionOpCode (\r
+      StartOpCodeHandle,\r
       mKeyInput,\r
       Token,\r
       HelpToken,\r
       EFI_IFR_FLAG_CALLBACK,\r
-      0,\r
-      &UpdateData\r
+      0\r
       );\r
   }\r
 \r
-  IfrLibUpdateForm (\r
+  if (NeedEndOp) {\r
+    HiiCreateEndOpCode (StartOpCodeHandle);\r
+  }\r
+\r
+  HiiUpdateForm (\r
     HiiHandle,\r
-    &mBootManagerGuid,\r
+    &gBootManagerFormSetGuid,\r
     BOOT_MANAGER_FORM_ID,\r
-    LABEL_BOOT_OPTION,\r
-    FALSE,\r
-    &UpdateData\r
+    StartOpCodeHandle,\r
+    EndOpCodeHandle\r
     );\r
-  FreePool (UpdateData.Data);\r
+\r
+  HiiFreeOpCodeHandle (StartOpCodeHandle);\r
+  HiiFreeOpCodeHandle (EndOpCodeHandle);\r
 \r
   ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r
   Status = gFormBrowser2->SendForm (\r
                            gFormBrowser2,\r
                            &HiiHandle,\r
                            1,\r
-                           NULL,\r
+                           &gBootManagerFormSetGuid,\r
                            0,\r
                            NULL,\r
                            &ActionRequest\r
@@ -294,7 +362,7 @@ CallBootManager (
   }\r
 \r
   //\r
-  //Will leave browser, check any reset required change is applied? if yes, reset system\r
+  // Will leave browser, check any reset required change is applied? if yes, reset system\r
   //\r
   SetupResetReminder ();\r
 \r