UEFI HII: Merge UEFI HII support changes from branch.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4599 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 624 insertions, 0 deletions

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
new file mode 100644
index 0000000000..0ec274d8ce
--- /dev/null
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
@@ -0,0 +1,434 @@
+/*++

+

+Copyright (c) 2004 - 2008, Intel Corporation

+All rights reserved. This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+Module Name:

+

+  DeviceManager.c

+

+Abstract:

+

+  The platform device manager reference implement

+

+--*/

+

+#include "DeviceManager.h"

+

+DEVICE_MANAGER_CALLBACK_DATA  gDeviceManagerPrivate = {

+  DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE,

+  NULL,

+  NULL,

+  {

+    FakeExtractConfig,

+    FakeRouteConfig,

+    DeviceManagerCallback

+  }

+};

+

+EFI_GUID mDeviceManagerGuid = DEVICE_MANAGER_FORMSET_GUID;

+

+DEVICE_MANAGER_MENU_ITEM  mDeviceManagerMenuItemTable[] = {

+  { STRING_TOKEN (STR_DISK_DEVICE),     EFI_DISK_DEVICE_CLASS },

+  { STRING_TOKEN (STR_VIDEO_DEVICE),    EFI_VIDEO_DEVICE_CLASS },

+  { STRING_TOKEN (STR_NETWORK_DEVICE),  EFI_NETWORK_DEVICE_CLASS },

+  { STRING_TOKEN (STR_INPUT_DEVICE),    EFI_INPUT_DEVICE_CLASS },

+  { STRING_TOKEN (STR_ON_BOARD_DEVICE), EFI_ON_BOARD_DEVICE_CLASS },

+  { STRING_TOKEN (STR_OTHER_DEVICE),    EFI_OTHER_DEVICE_CLASS }

+};

+

+#define MENU_ITEM_NUM  \

+  (sizeof (mDeviceManagerMenuItemTable) / sizeof (DEVICE_MANAGER_MENU_ITEM))

+

+EFI_STATUS

+EFIAPI

+DeviceManagerCallback (

+  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,

+  IN  EFI_BROWSER_ACTION                     Action,

+  IN  EFI_QUESTION_ID                        QuestionId,

+  IN  UINT8                                  Type,

+  IN  EFI_IFR_TYPE_VALUE                     *Value,

+  OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest

+  )

+/*++

+

+  Routine Description:

+    This function processes the results of changes in configuration.

+

+  Arguments:

+    This          - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.

+    Action        - Specifies the type of action taken by the browser.

+    QuestionId    - A unique value which is sent to the original exporting driver

+                    so that it can identify the type of data to expect.

+    Type          - The type of value for the question.

+    Value         - A pointer to the data being sent to the original exporting driver.

+    ActionRequest - On return, points to the action requested by the callback function.

+

+  Returns:

+    EFI_SUCCESS          - The callback successfully handled the action.

+    EFI_OUT_OF_RESOURCES - Not enough storage is available to hold the variable and its data.

+    EFI_DEVICE_ERROR     - The variable could not be saved.

+    EFI_UNSUPPORTED      - The specified Action is not supported by the callback.

+

+--*/

+{

+  DEVICE_MANAGER_CALLBACK_DATA *PrivateData;

+

+  if ((Value == NULL) || (ActionRequest == NULL)) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  PrivateData = DEVICE_MANAGER_CALLBACK_DATA_FROM_THIS (This);

+

+  switch (QuestionId) {

+  case DEVICE_MANAGER_KEY_VBIOS:

+    PrivateData->VideoBios = Value->u8;

+    gRT->SetVariable (

+           L"VBIOS",

+           &gEfiGenericPlatformVariableGuid,

+           EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

+           sizeof (UINT8),

+           &PrivateData->VideoBios

+           );

+

+    //

+    // Tell browser not to ask for confirmation of changes,

+    // since we have already applied.

+    //

+    *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;

+    break;

+

+  default:

+    //

+    // The key corresponds the Handle Index which was requested to be displayed

+    //

+    gCallbackKey = QuestionId;

+

+    //

+    // Request to exit SendForm(), so as to switch to selected form

+    //

+    *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;

+    break;

+  }

+

+  return EFI_SUCCESS;

+}

+

+EFI_STATUS

+InitializeDeviceManager (

+  VOID

+  )

+/*++

+

+Routine Description:

+

+  Initialize HII information for the FrontPage

+

+Arguments:

+  None

+

+Returns:

+

+--*/

+{

+  EFI_STATUS                  Status;

+  EFI_HII_PACKAGE_LIST_HEADER *PackageList;

+

+  //

+  // Create driver handle used by HII database

+  //

+  Status = HiiLibCreateHiiDriverHandle (&gDeviceManagerPrivate.DriverHandle);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Install Config Access protocol to driver handle

+  //

+  Status = gBS->InstallProtocolInterface (

+                  &gDeviceManagerPrivate.DriverHandle,

+                  &gEfiHiiConfigAccessProtocolGuid,

+                  EFI_NATIVE_INTERFACE,

+                  &gDeviceManagerPrivate.ConfigAccess

+                  );

+  ASSERT_EFI_ERROR (Status);

+

+  //

+  // Publish our HII data

+  //

+  PackageList = PreparePackageList (2, &mDeviceManagerGuid, DeviceManagerVfrBin, BdsStrings);

+  ASSERT (PackageList != NULL);

+

+  Status = gHiiDatabase->NewPackageList (

+                           gHiiDatabase,

+                           PackageList,

+                           gDeviceManagerPrivate.DriverHandle,

+                           &gDeviceManagerPrivate.HiiHandle

+                           );

+  FreePool (PackageList);

+

+  return Status;

+}

+

+EFI_STATUS

+CallDeviceManager (

+  VOID

+  )

+/*++

+

+Routine Description:

+

+  Call the browser and display the device manager

+

+Arguments:

+

+  None

+

+Returns:

+  EFI_SUCCESS            - Operation is successful.

+  EFI_INVALID_PARAMETER  - If the inputs to SendForm function is not valid.

+

+--*/

+{

+  EFI_STATUS                  Status;

+  UINTN                       Count;

+  UINTN                       Index;

+  CHAR16                      *String;

+  UINTN                       StringLength;

+  EFI_HII_UPDATE_DATA         UpdateData[MENU_ITEM_NUM];

+  EFI_STRING_ID               Token;

+  EFI_STRING_ID               TokenHelp;

+  IFR_OPTION                  *IfrOptionList;

+  UINT8                       *VideoOption;

+  UINTN                       VideoOptionSize;

+  EFI_HII_HANDLE              *HiiHandles;

+  UINTN                       HandleBufferLength;

+  UINTN                       NumberOfHiiHandles;

+  EFI_HII_HANDLE              HiiHandle;

+  UINT16                      FormSetClass;

+  EFI_STRING_ID               FormSetTitle;

+  EFI_STRING_ID               FormSetHelp;

+  EFI_BROWSER_ACTION_REQUEST  ActionRequest;

+  EFI_HII_PACKAGE_LIST_HEADER *PackageList;

+

+  IfrOptionList       = NULL;

+  VideoOption         = NULL;

+  HiiHandles          = NULL;

+  HandleBufferLength  = 0;

+

+  Status        = EFI_SUCCESS;

+  gCallbackKey  = 0;

+

+  //

+  // Connect all prior to entering the platform setup menu.

+  //

+  if (!gConnectAllHappened) {

+    BdsLibConnectAllDriversToAllControllers ();

+    gConnectAllHappened = TRUE;

+  }

+

+  //

+  // Create Subtitle OpCodes

+  //

+  for (Index = 0; Index < MENU_ITEM_NUM; Index++) {

+    //

+    // Allocate space for creation of UpdateData Buffer

+    //

+    UpdateData[Index].BufferSize = 0x1000;

+    UpdateData[Index].Offset = 0;

+    UpdateData[Index].Data = AllocatePool (0x1000);

+    ASSERT (UpdateData[Index].Data != NULL);

+

+    CreateSubTitleOpCode (mDeviceManagerMenuItemTable[Index].StringId, 0, 0, 1,  &UpdateData[Index]);

+  }

+

+  //

+  // Get all the Hii handles

+  //

+  Status = GetHiiHandles (&HandleBufferLength, &HiiHandles);

+  ASSERT_EFI_ERROR (Status);

+

+  HiiHandle = gDeviceManagerPrivate.HiiHandle;

+

+  StringLength  = 0x1000;

+  String        = AllocateZeroPool (StringLength);

+  ASSERT (String != NULL);

+

+  //

+  // Search for formset of each class type

+  //

+  NumberOfHiiHandles = HandleBufferLength / sizeof (EFI_HII_HANDLE);

+  for (Index = 0; Index < NumberOfHiiHandles; Index++) {

+    HiiLibExtractClassFromHiiHandle (HiiHandles[Index], &FormSetClass, &FormSetTitle, &FormSetHelp);

+

+    if (FormSetClass == EFI_NON_DEVICE_CLASS) {

+      continue;

+    }

+

+    Token = 0;

+    *String = 0;

+    StringLength = 0x1000;

+    IfrLibGetString (HiiHandles[Index], FormSetTitle, String, &StringLength);

+    IfrLibNewString (HiiHandle, &Token, String);

+

+    TokenHelp = 0;

+    *String = 0;

+    StringLength = 0x1000;

+    IfrLibGetString (HiiHandles[Index], FormSetHelp, String, &StringLength);

+    IfrLibNewString (HiiHandle, &TokenHelp, String);

+

+    for (Count = 0; Count < MENU_ITEM_NUM; Count++) {

+      if (FormSetClass & mDeviceManagerMenuItemTable[Count].Class) {

+        CreateActionOpCode (

+          (EFI_QUESTION_ID) (Index + DEVICE_KEY_OFFSET),

+          Token,

+          TokenHelp,

+          EFI_IFR_FLAG_CALLBACK,

+          0,

+          &UpdateData[Count]

+          );

+      }

+    }

+  }

+  FreePool (String);

+

+  for (Index = 0; Index < MENU_ITEM_NUM; Index++) {

+    //

+    // Add End Opcode for Subtitle

+    //

+    CreateEndOpCode (&UpdateData[Index]);

+

+    IfrLibUpdateForm (

+      HiiHandle,

+      &mDeviceManagerGuid,

+      DEVICE_MANAGER_FORM_ID,

+      mDeviceManagerMenuItemTable[Index].Class,

+      FALSE,

+      &UpdateData[Index]

+      );

+  }

+

+  //

+  // Add oneof for video BIOS selection

+  //

+  VideoOption = BdsLibGetVariableAndSize (

+                  L"VBIOS",

+                  &gEfiGenericPlatformVariableGuid,

+                  &VideoOptionSize

+                  );

+  if (NULL == VideoOption) {

+    gDeviceManagerPrivate.VideoBios = 0;

+  } else {

+    gDeviceManagerPrivate.VideoBios = VideoOption[0];

+    FreePool (VideoOption);

+  }

+

+  ASSERT (gDeviceManagerPrivate.VideoBios <= 1);

+

+  IfrOptionList = AllocatePool (2 * sizeof (IFR_OPTION));

+  ASSERT (IfrOptionList != NULL);

+  IfrOptionList[0].Flags        = 0;

+  IfrOptionList[0].StringToken  = STRING_TOKEN (STR_ONE_OF_PCI);

+  IfrOptionList[0].Value.u8     = 0;

+  IfrOptionList[1].Flags        = 0;

+  IfrOptionList[1].StringToken  = STRING_TOKEN (STR_ONE_OF_AGP);

+  IfrOptionList[1].Value.u8     = 1;

+  IfrOptionList[gDeviceManagerPrivate.VideoBios].Flags |= EFI_IFR_OPTION_DEFAULT;

+

+  UpdateData[0].Offset = 0;

+  CreateOneOfOpCode (

+    DEVICE_MANAGER_KEY_VBIOS,

+    0,

+    0,

+    STRING_TOKEN (STR_ONE_OF_VBIOS),

+    STRING_TOKEN (STR_ONE_OF_VBIOS_HELP),

+    EFI_IFR_FLAG_CALLBACK,

+    EFI_IFR_NUMERIC_SIZE_1,

+    IfrOptionList,

+    2,

+    &UpdateData[0]

+    );

+

+  IfrLibUpdateForm (

+    HiiHandle,

+    &mDeviceManagerGuid,

+    DEVICE_MANAGER_FORM_ID,

+    LABEL_VBIOS,

+    FALSE,

+    &UpdateData[0]

+    );

+

+  //

+  // Drop the TPL level from TPL_APPLICATION to TPL_APPLICATION

+  //

+  gBS->RestoreTPL (TPL_APPLICATION);

+

+  ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;

+  Status = gFormBrowser2->SendForm (

+                           gFormBrowser2,

+                           &HiiHandle,

+                           1,

+                           NULL,

+                           0,

+                           NULL,

+                           &ActionRequest

+                           );

+  if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {

+    EnableResetRequired ();

+  }

+

+  //

+  // We will have returned from processing a callback - user either hit ESC to exit, or selected

+  // a target to display

+  //

+  if (gCallbackKey != 0) {

+    ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;

+    Status = gFormBrowser2->SendForm (

+                             gFormBrowser2,

+                             &HiiHandles[gCallbackKey - DEVICE_KEY_OFFSET],

+                             1,

+                             NULL,

+                             0,

+                             NULL,

+                             &ActionRequest

+                             );

+

+    if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {

+      EnableResetRequired ();

+    }

+

+    //

+    // Force return to Device Manager

+    //

+    gCallbackKey = FRONT_PAGE_KEY_DEVICE_MANAGER;

+  }

+

+  //

+  // Cleanup dynamic created strings in HII database by reinstall the packagelist

+  //

+  gHiiDatabase->RemovePackageList (gHiiDatabase, HiiHandle);

+  PackageList = PreparePackageList (2, &mDeviceManagerGuid, DeviceManagerVfrBin, BdsStrings);

+  ASSERT (PackageList != NULL);

+  Status = gHiiDatabase->NewPackageList (

+                           gHiiDatabase,

+                           PackageList,

+                           gDeviceManagerPrivate.DriverHandle,

+                           &gDeviceManagerPrivate.HiiHandle

+                           );

+  FreePool (PackageList);

+

+  for (Index = 0; Index < MENU_ITEM_NUM; Index++) {

+    FreePool (UpdateData[Index].Data);

+  }

+  FreePool (HiiHandles);

+

+  gBS->RaiseTPL (TPL_APPLICATION);

+

+  return Status;

+}

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
new file mode 100644
index 0000000000..046945612e
--- /dev/null
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h
@@ -0,0 +1,108 @@
+/*++

+

+Copyright (c) 2004 - 2008, Intel Corporation

+All rights reserved. This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+Module Name:

+

+  DeviceManager.c

+

+Abstract:

+

+  The platform device manager reference implement

+

+Revision History

+

+--*/

+

+#ifndef _DEVICE_MANAGER_H

+#define _DEVICE_MANAGER_H

+

+#include "Bds.h"

+#include "FrontPage.h"

+

+//

+// These are defined as the same with vfr file

+//

+#define DEVICE_MANAGER_FORMSET_GUID  \

+  { \

+  0x3ebfa8e6, 0x511d, 0x4b5b, {0xa9, 0x5f, 0xfb, 0x38, 0x26, 0xf, 0x1c, 0x27} \

+  }

+

+#define LABEL_VBIOS                          0x0040

+

+#define DEVICE_MANAGER_FORM_ID               0x1000

+

+#define DEVICE_KEY_OFFSET                    0x1000

+#define DEVICE_MANAGER_KEY_VBIOS             0x2000

+

+//

+// These are the VFR compiler generated data representing our VFR data.

+//

+extern UINT8  DeviceManagerVfrBin[];

+

+#define DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE  EFI_SIGNATURE_32 ('D', 'M', 'C', 'B')

+

+typedef struct {

+  UINTN                           Signature;

+

+  //

+  // HII relative handles

+  //

+  EFI_HII_HANDLE                  HiiHandle;

+  EFI_HANDLE                      DriverHandle;

+

+  //

+  // Produced protocols

+  //

+  EFI_HII_CONFIG_ACCESS_PROTOCOL  ConfigAccess;

+

+  //

+  // Configuration data

+  //

+  UINT8                           VideoBios;

+} DEVICE_MANAGER_CALLBACK_DATA;

+

+#define DEVICE_MANAGER_CALLBACK_DATA_FROM_THIS(a) \

+  CR (a, \

+      DEVICE_MANAGER_CALLBACK_DATA, \

+      ConfigAccess, \

+      DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE \

+      )

+

+typedef struct {

+  EFI_STRING_ID  StringId;

+  UINT16         Class;

+} DEVICE_MANAGER_MENU_ITEM;

+

+EFI_STATUS

+EFIAPI

+DeviceManagerCallback (

+  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,

+  IN  EFI_BROWSER_ACTION                     Action,

+  IN  EFI_QUESTION_ID                        QuestionId,

+  IN  UINT8                                  Type,

+  IN  EFI_IFR_TYPE_VALUE                     *Value,

+  OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest

+  )

+;

+

+EFI_STATUS

+InitializeDeviceManager (

+  VOID

+  )

+;

+

+EFI_STATUS

+CallDeviceManager (

+  VOID

+  )

+;

+

+#endif

diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManagerStrings.uni b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManagerStrings.uni
new file mode 100644
index 0000000000..99beee4c65
--- /dev/null
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManagerStrings.uni
diff --git a/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManagerVfr.Vfr b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManagerVfr.Vfr
new file mode 100644
index 0000000000..78fff23f5d
--- /dev/null
+++ b/MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManagerVfr.Vfr
@@ -0,0 +1,82 @@
+// *++

+//

+// Copyright (c) 2004 - 2007, Intel Corporation

+// All rights reserved. This program and the accompanying materials

+// are licensed and made available under the terms and conditions of the BSD License

+// which accompanies this distribution.  The full text of the license may be found at

+// http://opensource.org/licenses/bsd-license.php

+//

+// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+//

+// Module Name:

+//

+//   DeviceManagerVfr.vfr

+//

+// Abstract:

+//

+//   Device Manager formset.

+//

+// Revision History:

+//

+// --*/

+

+#define FORMSET_GUID  { 0x3ebfa8e6, 0x511d, 0x4b5b, 0xa9, 0x5f, 0xfb, 0x38, 0x26, 0xf, 0x1c, 0x27 }

+

+#define EFI_DISK_DEVICE_CLASS              0x0001

+#define EFI_VIDEO_DEVICE_CLASS             0x0002

+#define EFI_NETWORK_DEVICE_CLASS           0x0004

+#define EFI_INPUT_DEVICE_CLASS             0x0008

+#define EFI_ON_BOARD_DEVICE_CLASS          0x0010

+#define EFI_OTHER_DEVICE_CLASS             0x0020

+#define LABEL_VBIOS                        0x0040

+

+#define LABEL_END                          0xffff

+

+#define DEVICE_MANAGER_CLASS               0x0000

+#define FRONT_PAGE_SUBCLASS		           0x0003

+

+#define DEVICE_MANAGER_FORM_ID             0x1000

+

+formset

+  guid     = FORMSET_GUID,

+  title    = STRING_TOKEN(STR_DEVICE_MANAGER_TITLE),

+  help     = STRING_TOKEN(STR_EMPTY_STRING),

+  class    = DEVICE_MANAGER_CLASS,

+  subclass = FRONT_PAGE_SUBCLASS,

+

+  form formid = DEVICE_MANAGER_FORM_ID,

+       title  = STRING_TOKEN(STR_DEVICE_MANAGER_TITLE);

+

+    //

+    // This is where devices get added to the device manager hierarchy

+    //

+    label EFI_DISK_DEVICE_CLASS;

+//    label LABEL_END;  // Since next opcode is a label, so this one could be omitted to save code size

+

+    label EFI_VIDEO_DEVICE_CLASS;

+//    label LABEL_END;

+

+    label EFI_NETWORK_DEVICE_CLASS;

+//    label LABEL_END;

+

+    label EFI_INPUT_DEVICE_CLASS;

+//    label LABEL_END;

+

+    label EFI_ON_BOARD_DEVICE_CLASS;

+//    label LABEL_END;

+

+    label EFI_OTHER_DEVICE_CLASS;

+    label LABEL_END;

+

+    subtitle text = STRING_TOKEN(STR_EMPTY_STRING);

+

+    label LABEL_VBIOS;

+    label LABEL_END;

+

+    subtitle text = STRING_TOKEN(STR_EMPTY_STRING);

+    subtitle text = STRING_TOKEN(STR_EXIT_STRING);

+

+  endform;

+endformset;

+