[mirror_edk2.git] / SecurityPkg / Tcg / Opal / OpalPassword / OpalHii.c

/** @file\r
  Implementation of the HII for the Opal UEFI Driver.\r
\r
Copyright (c) 2016 - 2019, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "OpalHii.h"\r
//\r
// Character definitions\r
//\r
#define UPPER_LOWER_CASE_OFFSET  0x20\r
\r
//\r
// This is the generated IFR binary Data for each formset defined in VFR.\r
// This Data array is ready to be used as input of HiiAddPackages() to\r
// create a packagelist (which contains Form packages, String packages, etc).\r
//\r
extern UINT8  OpalPasswordFormBin[];\r
\r
//\r
// This is the generated String package Data for all .UNI files.\r
// This Data array is ready to be used as input of HiiAddPackages() to\r
// create a packagelist (which contains Form packages, String packages, etc).\r
//\r
extern UINT8  OpalPasswordDxeStrings[];\r
\r
CHAR16  OpalPasswordStorageName[] = L"OpalHiiConfig";\r
\r
EFI_HII_CONFIG_ACCESS_PROTOCOL  gHiiConfigAccessProtocol;\r
\r
//\r
// Handle to the list of HII packages (forms and strings) for this driver\r
//\r
EFI_HII_HANDLE  gHiiPackageListHandle = NULL;\r
\r
//\r
// Package List GUID containing all form and string packages\r
//\r
const EFI_GUID  gHiiPackageListGuid   = PACKAGE_LIST_GUID;\r
const EFI_GUID  gHiiSetupVariableGuid = SETUP_VARIABLE_GUID;\r
\r
//\r
// Structure that contains state of the HII\r
// This structure is updated by Hii.cpp and its contents\r
// is rendered in the HII.\r
//\r
OPAL_HII_CONFIGURATION  gHiiConfiguration;\r
\r
//\r
// The device path containing the VENDOR_DEVICE_PATH and EFI_DEVICE_PATH_PROTOCOL\r
//\r
HII_VENDOR_DEVICE_PATH  gHiiVendorDevicePath = {\r
  {\r
    {\r
      HARDWARE_DEVICE_PATH,\r
      HW_VENDOR_DP,\r
      {\r
        (UINT8)(sizeof (VENDOR_DEVICE_PATH)),\r
        (UINT8)((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
      }\r
    },\r
    OPAL_PASSWORD_CONFIG_GUID\r
  },\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    {\r
      (UINT8)(END_DEVICE_PATH_LENGTH),\r
      (UINT8)((END_DEVICE_PATH_LENGTH) >> 8)\r
    }\r
  }\r
};\r
\r
/**\r
  Get saved OPAL request.\r
\r
  @param[in]  OpalDisk      The disk needs to get the saved OPAL request.\r
  @param[out] OpalRequest   OPAL request got.\r
\r
**/\r
VOID\r
GetSavedOpalRequest (\r
  IN OPAL_DISK      *OpalDisk,\r
  OUT OPAL_REQUEST  *OpalRequest\r
  )\r
{\r
  EFI_STATUS                Status;\r
  OPAL_REQUEST_VARIABLE     *TempVariable;\r
  OPAL_REQUEST_VARIABLE     *Variable;\r
  UINTN                     VariableSize;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePathInVariable;\r
  UINTN                     DevicePathSizeInVariable;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  UINTN                     DevicePathSize;\r
\r
  DEBUG ((DEBUG_INFO, "%a() - enter\n", __FUNCTION__));\r
\r
  Variable     = NULL;\r
  VariableSize = 0;\r
\r
  Status = GetVariable2 (\r
             OPAL_REQUEST_VARIABLE_NAME,\r
             &gHiiSetupVariableGuid,\r
             (VOID **)&Variable,\r
             &VariableSize\r
             );\r
  if (EFI_ERROR (Status) || (Variable == NULL)) {\r
    return;\r
  }\r
\r
  TempVariable = Variable;\r
  while ((VariableSize > sizeof (OPAL_REQUEST_VARIABLE)) &&\r
         (VariableSize >= TempVariable->Length) &&\r
         (TempVariable->Length > sizeof (OPAL_REQUEST_VARIABLE)))\r
  {\r
    DevicePathInVariable     = (EFI_DEVICE_PATH_PROTOCOL *)((UINTN)TempVariable + sizeof (OPAL_REQUEST_VARIABLE));\r
    DevicePathSizeInVariable = GetDevicePathSize (DevicePathInVariable);\r
    DevicePath               = OpalDisk->OpalDevicePath;\r
    DevicePathSize           = GetDevicePathSize (DevicePath);\r
    if ((DevicePathSize == DevicePathSizeInVariable) &&\r
        (CompareMem (DevicePath, DevicePathInVariable, DevicePathSize) == 0))\r
    {\r
      //\r
      // Found the node for the OPAL device.\r
      // Get the OPAL request.\r
      //\r
      CopyMem (OpalRequest, &TempVariable->OpalRequest, sizeof (OPAL_REQUEST));\r
      DEBUG ((\r
        DEBUG_INFO,\r
        "OpalRequest got: 0x%x\n",\r
        *OpalRequest\r
        ));\r
      break;\r
    }\r
\r
    VariableSize -= TempVariable->Length;\r
    TempVariable  = (OPAL_REQUEST_VARIABLE *)((UINTN)TempVariable + TempVariable->Length);\r
  }\r
\r
  FreePool (Variable);\r
\r
  DEBUG ((DEBUG_INFO, "%a() - exit\n", __FUNCTION__));\r
}\r
\r
/**\r
  Save OPAL request.\r
\r
  @param[in] OpalDisk       The disk has OPAL request to save.\r
  @param[in] OpalRequest    OPAL request to save.\r
\r
**/\r
VOID\r
SaveOpalRequest (\r
  IN OPAL_DISK     *OpalDisk,\r
  IN OPAL_REQUEST  OpalRequest\r
  )\r
{\r
  EFI_STATUS                Status;\r
  OPAL_REQUEST_VARIABLE     *TempVariable;\r
  UINTN                     TempVariableSize;\r
  OPAL_REQUEST_VARIABLE     *Variable;\r
  UINTN                     VariableSize;\r
  OPAL_REQUEST_VARIABLE     *NewVariable;\r
  UINTN                     NewVariableSize;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePathInVariable;\r
  UINTN                     DevicePathSizeInVariable;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  UINTN                     DevicePathSize;\r
\r
  DEBUG ((DEBUG_INFO, "%a() - enter\n", __FUNCTION__));\r
\r
  DEBUG ((\r
    DEBUG_INFO,\r
    "OpalRequest to save: 0x%x\n",\r
    OpalRequest\r
    ));\r
\r
  Variable        = NULL;\r
  VariableSize    = 0;\r
  NewVariable     = NULL;\r
  NewVariableSize = 0;\r
\r
  Status = GetVariable2 (\r
             OPAL_REQUEST_VARIABLE_NAME,\r
             &gHiiSetupVariableGuid,\r
             (VOID **)&Variable,\r
             &VariableSize\r
             );\r
  if (!EFI_ERROR (Status) && (Variable != NULL)) {\r
    TempVariable     = Variable;\r
    TempVariableSize = VariableSize;\r
    while ((TempVariableSize > sizeof (OPAL_REQUEST_VARIABLE)) &&\r
           (TempVariableSize >= TempVariable->Length) &&\r
           (TempVariable->Length > sizeof (OPAL_REQUEST_VARIABLE)))\r
    {\r
      DevicePathInVariable     = (EFI_DEVICE_PATH_PROTOCOL *)((UINTN)TempVariable + sizeof (OPAL_REQUEST_VARIABLE));\r
      DevicePathSizeInVariable = GetDevicePathSize (DevicePathInVariable);\r
      DevicePath               = OpalDisk->OpalDevicePath;\r
      DevicePathSize           = GetDevicePathSize (DevicePath);\r
      if ((DevicePathSize == DevicePathSizeInVariable) &&\r
          (CompareMem (DevicePath, DevicePathInVariable, DevicePathSize) == 0))\r
      {\r
        //\r
        // Found the node for the OPAL device.\r
        // Update the OPAL request.\r
        //\r
        CopyMem (&TempVariable->OpalRequest, &OpalRequest, sizeof (OPAL_REQUEST));\r
        NewVariable     = Variable;\r
        NewVariableSize = VariableSize;\r
        break;\r
      }\r
\r
      TempVariableSize -= TempVariable->Length;\r
      TempVariable      = (OPAL_REQUEST_VARIABLE *)((UINTN)TempVariable + TempVariable->Length);\r
    }\r
\r
    if (NewVariable == NULL) {\r
      //\r
      // The node for the OPAL device is not found.\r
      // Create node for the OPAL device.\r
      //\r
      DevicePath      = OpalDisk->OpalDevicePath;\r
      DevicePathSize  = GetDevicePathSize (DevicePath);\r
      NewVariableSize = VariableSize + sizeof (OPAL_REQUEST_VARIABLE) + DevicePathSize;\r
      NewVariable     = AllocatePool (NewVariableSize);\r
      ASSERT (NewVariable != NULL);\r
      CopyMem (NewVariable, Variable, VariableSize);\r
      TempVariable         = (OPAL_REQUEST_VARIABLE *)((UINTN)NewVariable + VariableSize);\r
      TempVariable->Length = (UINT32)(sizeof (OPAL_REQUEST_VARIABLE) + DevicePathSize);\r
      CopyMem (&TempVariable->OpalRequest, &OpalRequest, sizeof (OPAL_REQUEST));\r
      DevicePathInVariable = (EFI_DEVICE_PATH_PROTOCOL *)((UINTN)TempVariable + sizeof (OPAL_REQUEST_VARIABLE));\r
      CopyMem (DevicePathInVariable, DevicePath, DevicePathSize);\r
    }\r
  } else {\r
    DevicePath      = OpalDisk->OpalDevicePath;\r
    DevicePathSize  = GetDevicePathSize (DevicePath);\r
    NewVariableSize = sizeof (OPAL_REQUEST_VARIABLE) + DevicePathSize;\r
    NewVariable     = AllocatePool (NewVariableSize);\r
    ASSERT (NewVariable != NULL);\r
    NewVariable->Length = (UINT32)(sizeof (OPAL_REQUEST_VARIABLE) + DevicePathSize);\r
    CopyMem (&NewVariable->OpalRequest, &OpalRequest, sizeof (OPAL_REQUEST));\r
    DevicePathInVariable = (EFI_DEVICE_PATH_PROTOCOL *)((UINTN)NewVariable + sizeof (OPAL_REQUEST_VARIABLE));\r
    CopyMem (DevicePathInVariable, DevicePath, DevicePathSize);\r
  }\r
\r
  Status = gRT->SetVariable (\r
                  OPAL_REQUEST_VARIABLE_NAME,\r
                  (EFI_GUID *)&gHiiSetupVariableGuid,\r
                  EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                  NewVariableSize,\r
                  NewVariable\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_INFO, "OpalRequest variable set failed (%r)\n", Status));\r
  }\r
\r
  if (NewVariable != Variable) {\r
    FreePool (NewVariable);\r
  }\r
\r
  if (Variable != NULL) {\r
    FreePool (Variable);\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "%a() - exit\n", __FUNCTION__));\r
}\r
\r
/**\r
  Sets the current system state of global config variables.\r
\r
**/\r
VOID\r
HiiSetCurrentConfiguration (\r
  VOID\r
  )\r
{\r
  UINT32      PpStorageFlag;\r
  EFI_STRING  NewString;\r
\r
  gHiiConfiguration.NumDisks = GetDeviceCount ();\r
\r
  //\r
  // Update the BlockSID status string.\r
  //\r
  PpStorageFlag = Tcg2PhysicalPresenceLibGetManagementFlags ();\r
\r
  if ((PpStorageFlag & TCG2_BIOS_STORAGE_MANAGEMENT_FLAG_ENABLE_BLOCK_SID) != 0) {\r
    NewString = HiiGetString (gHiiPackageListHandle, STRING_TOKEN (STR_ENABLED), NULL);\r
    if (NewString == NULL) {\r
      DEBUG ((DEBUG_INFO, "HiiSetCurrentConfiguration: HiiGetString( ) failed\n"));\r
      return;\r
    }\r
  } else {\r
    NewString = HiiGetString (gHiiPackageListHandle, STRING_TOKEN (STR_DISABLED), NULL);\r
    if (NewString == NULL) {\r
      DEBUG ((DEBUG_INFO, "HiiSetCurrentConfiguration: HiiGetString( ) failed\n"));\r
      return;\r
    }\r
  }\r
\r
  HiiSetString (gHiiPackageListHandle, STRING_TOKEN (STR_BLOCKSID_STATUS1), NewString, NULL);\r
  FreePool (NewString);\r
\r
  if ((PpStorageFlag & TCG2_BIOS_STORAGE_MANAGEMENT_FLAG_PP_REQUIRED_FOR_ENABLE_BLOCK_SID) != 0) {\r
    NewString = HiiGetString (gHiiPackageListHandle, STRING_TOKEN (STR_DISK_INFO_ENABLE_BLOCKSID_TRUE), NULL);\r
    if (NewString == NULL) {\r
      DEBUG ((DEBUG_INFO, "HiiSetCurrentConfiguration: HiiGetString( ) failed\n"));\r
      return;\r
    }\r
  } else {\r
    NewString = HiiGetString (gHiiPackageListHandle, STRING_TOKEN (STR_DISK_INFO_ENABLE_BLOCKSID_FALSE), NULL);\r
    if (NewString == NULL) {\r
      DEBUG ((DEBUG_INFO, "HiiSetCurrentConfiguration: HiiGetString( ) failed\n"));\r
      return;\r
    }\r
  }\r
\r
  HiiSetString (gHiiPackageListHandle, STRING_TOKEN (STR_BLOCKSID_STATUS2), NewString, NULL);\r
  FreePool (NewString);\r
\r
  if ((PpStorageFlag & TCG2_BIOS_STORAGE_MANAGEMENT_FLAG_PP_REQUIRED_FOR_DISABLE_BLOCK_SID) != 0) {\r
    NewString = HiiGetString (gHiiPackageListHandle, STRING_TOKEN (STR_DISK_INFO_DISABLE_BLOCKSID_TRUE), NULL);\r
    if (NewString == NULL) {\r
      DEBUG ((DEBUG_INFO, "HiiSetCurrentConfiguration: HiiGetString( ) failed\n"));\r
      return;\r
    }\r
  } else {\r
    NewString = HiiGetString (gHiiPackageListHandle, STRING_TOKEN (STR_DISK_INFO_DISABLE_BLOCKSID_FALSE), NULL);\r
    if (NewString == NULL) {\r
      DEBUG ((DEBUG_INFO, "HiiSetCurrentConfiguration: HiiGetString( ) failed\n"));\r
      return;\r
    }\r
  }\r
\r
  HiiSetString (gHiiPackageListHandle, STRING_TOKEN (STR_BLOCKSID_STATUS3), NewString, NULL);\r
  FreePool (NewString);\r
}\r
\r
/**\r
  Install the HII related resources.\r
\r
  @retval  EFI_SUCCESS        Install all the resources success.\r
  @retval  other              Error occur when install the resources.\r
**/\r
EFI_STATUS\r
HiiInstall (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
  EFI_HANDLE  DriverHandle;\r
\r
  //\r
  // Clear the global configuration.\r
  //\r
  ZeroMem (&gHiiConfiguration, sizeof (gHiiConfiguration));\r
\r
  //\r
  // Obtain the driver handle that the BIOS assigned us\r
  //\r
  DriverHandle = HiiGetDriverImageHandleCB ();\r
\r
  //\r
  // Populate the config access protocol with the three functions we are publishing\r
  //\r
  gHiiConfigAccessProtocol.ExtractConfig = ExtractConfig;\r
  gHiiConfigAccessProtocol.RouteConfig   = RouteConfig;\r
  gHiiConfigAccessProtocol.Callback      = DriverCallback;\r
\r
  //\r
  // Associate the required protocols with our driver handle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &DriverHandle,\r
                  &gEfiHiiConfigAccessProtocolGuid,\r
                  &gHiiConfigAccessProtocol,   // HII callback\r
                  &gEfiDevicePathProtocolGuid,\r
                  &gHiiVendorDevicePath,     // required for HII callback allow all disks to be shown in same hii\r
                  NULL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return OpalHiiAddPackages ();\r
}\r
\r
/**\r
  Install the HII form and string packages.\r
\r
  @retval  EFI_SUCCESS           Install all the resources success.\r
  @retval  EFI_OUT_OF_RESOURCES  Out of resource error.\r
**/\r
EFI_STATUS\r
OpalHiiAddPackages (\r
  VOID\r
  )\r
{\r
  EFI_HANDLE  DriverHandle;\r
\r
  DriverHandle = HiiGetDriverImageHandleCB ();\r
\r
  //\r
  // Publish the HII form and HII string packages\r
  //\r
  gHiiPackageListHandle = HiiAddPackages (\r
                            &gHiiPackageListGuid,\r
                            DriverHandle,\r
                            OpalPasswordDxeStrings,\r
                            OpalPasswordFormBin,\r
                            (VOID *)NULL\r
                            );\r
\r
  //\r
  // Make sure the packages installed successfully\r
  //\r
  if (gHiiPackageListHandle == NULL) {\r
    DEBUG ((DEBUG_INFO, "OpalHiiAddPackages failed\n"));\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Uninstall the HII capability.\r
\r
  @retval  EFI_SUCCESS           Uninstall all the resources success.\r
  @retval  others                Other errors occur when unistall the hii resource.\r
**/\r
EFI_STATUS\r
HiiUninstall (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Remove the packages we've provided to the BIOS\r
  //\r
  HiiRemovePackages (gHiiPackageListHandle);\r
\r
  //\r
  // Remove the protocols from our driver handle\r
  //\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
                  HiiGetDriverImageHandleCB (),\r
                  &gEfiHiiConfigAccessProtocolGuid,\r
                  &gHiiConfigAccessProtocol,                // HII callback\r
                  &gEfiDevicePathProtocolGuid,\r
                  &gHiiVendorDevicePath,                    // required for HII callback\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_INFO, "Cannot uninstall Hii Protocols: %r\n", Status));\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Updates the main menu form.\r
\r
  @retval  EFI_SUCCESS           update the main form success.\r
**/\r
EFI_STATUS\r
HiiPopulateMainMenuForm (\r
  VOID\r
  )\r
{\r
  UINT8          Index;\r
  CHAR8          *DiskName;\r
  EFI_STRING_ID  DiskNameId;\r
  OPAL_DISK      *OpalDisk;\r
\r
  HiiSetCurrentConfiguration ();\r
\r
  gHiiConfiguration.SupportedDisks = 0;\r
\r
  for (Index = 0; Index < gHiiConfiguration.NumDisks; Index++) {\r
    OpalDisk = HiiGetOpalDiskCB (Index);\r
    if ((OpalDisk != NULL) && OpalFeatureSupported (&OpalDisk->SupportedAttributes)) {\r
      gHiiConfiguration.SupportedDisks |= (1 << Index);\r
      DiskNameId                        = GetDiskNameStringId (Index);\r
      DiskName                          = HiiDiskGetNameCB (Index);\r
      if ((DiskName == NULL) || (DiskNameId == 0)) {\r
        return EFI_UNSUPPORTED;\r
      }\r
\r
      HiiSetFormString (DiskNameId, DiskName);\r
    }\r
  }\r
\r
  OpalHiiSetBrowserData ();\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Get disk name string id.\r
\r
  @param   DiskIndex             The input disk index info.\r
\r
  @retval  The disk name string id.\r
\r
**/\r
EFI_STRING_ID\r
GetDiskNameStringId (\r
  UINT8  DiskIndex\r
  )\r
{\r
  switch (DiskIndex) {\r
    case 0: return STRING_TOKEN (STR_MAIN_GOTO_DISK_INFO_0);\r
    case 1: return STRING_TOKEN (STR_MAIN_GOTO_DISK_INFO_1);\r
    case 2: return STRING_TOKEN (STR_MAIN_GOTO_DISK_INFO_2);\r
    case 3: return STRING_TOKEN (STR_MAIN_GOTO_DISK_INFO_3);\r
    case 4: return STRING_TOKEN (STR_MAIN_GOTO_DISK_INFO_4);\r
    case 5: return STRING_TOKEN (STR_MAIN_GOTO_DISK_INFO_5);\r
  }\r
\r
  return 0;\r
}\r
\r
/**\r
  Confirm whether user truly want to do the revert action.\r
\r
  @param     OpalDisk            The device which need to perform data removal action.\r
  @param     ActionString        Specifies the action name shown on pop up menu.\r
\r
  @retval  EFI_SUCCESS           Confirmed user want to do the revert action.\r
**/\r
EFI_STATUS\r
HiiConfirmDataRemovalAction (\r
  IN OPAL_DISK  *OpalDisk,\r
  IN CHAR16     *ActionString\r
\r
  )\r
{\r
  CHAR16         Unicode[512];\r
  EFI_INPUT_KEY  Key;\r
  CHAR16         ApproveResponse;\r
  CHAR16         RejectResponse;\r
\r
  //\r
  // When the estimate cost time bigger than MAX_ACCEPTABLE_REVERTING_TIME, pop up dialog to let user confirm\r
  // the revert action.\r
  //\r
  if (OpalDisk->EstimateTimeCost < MAX_ACCEPTABLE_REVERTING_TIME) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  ApproveResponse = L'Y';\r
  RejectResponse  = L'N';\r
\r
  UnicodeSPrint (Unicode, StrSize (L"WARNING: ############# action needs about ####### seconds"), L"WARNING: %s action needs about %d seconds", ActionString, OpalDisk->EstimateTimeCost);\r
\r
  do {\r
    CreatePopUp (\r
      EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,\r
      &Key,\r
      Unicode,\r
      L" System should not be powered off until action completion ",\r
      L" ",\r
      L" Press 'Y/y' to continue, press 'N/n' to cancel ",\r
      NULL\r
      );\r
  } while (\r
           ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (ApproveResponse | UPPER_LOWER_CASE_OFFSET)) &&\r
           ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (RejectResponse | UPPER_LOWER_CASE_OFFSET))\r
           );\r
\r
  if ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) == (RejectResponse | UPPER_LOWER_CASE_OFFSET)) {\r
    return EFI_ABORTED;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
  @param  This                   Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param  Action                 Specifies the type of action taken by the browser.\r
  @param  QuestionId             A unique value which is sent to the original\r
                                 exporting driver so that it can identify the type\r
                                 of data to expect.\r
  @param  Type                   The type of value for the question.\r
  @param  Value                  A pointer to the data being sent to the original\r
                                 exporting driver.\r
  @param  ActionRequest          On return, points to the action requested by the\r
                                 callback function.\r
\r
  @retval EFI_SUCCESS            The callback successfully handled the action.\r
  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the\r
                                 variable and its data.\r
  @retval EFI_DEVICE_ERROR       The variable could not be saved.\r
  @retval EFI_UNSUPPORTED        The specified Action is not supported by the\r
                                 callback.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DriverCallback (\r
  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,\r
  EFI_BROWSER_ACTION                    Action,\r
  EFI_QUESTION_ID                       QuestionId,\r
  UINT8                                 Type,\r
  EFI_IFR_TYPE_VALUE                    *Value,\r
  EFI_BROWSER_ACTION_REQUEST            *ActionRequest\r
  )\r
{\r
  HII_KEY    HiiKey;\r
  UINT8      HiiKeyId;\r
  UINT32     PpRequest;\r
  OPAL_DISK  *OpalDisk;\r
\r
  if (ActionRequest != NULL) {\r
    *ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r
  } else {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // If QuestionId is an auto-generated key (label, empty line, etc.), ignore it.\r
  //\r
  if ((QuestionId & HII_KEY_FLAG) == 0) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  HiiKey.Raw = QuestionId;\r
  HiiKeyId   = (UINT8)HiiKey.KeyBits.Id;\r
\r
  if (Action == EFI_BROWSER_ACTION_FORM_OPEN) {\r
    switch (HiiKeyId) {\r
      case HII_KEY_ID_VAR_SUPPORTED_DISKS:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_VAR_SUPPORTED_DISKS\n"));\r
        return HiiPopulateMainMenuForm ();\r
\r
      case HII_KEY_ID_VAR_SELECTED_DISK_AVAILABLE_ACTIONS:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_VAR_SELECTED_DISK_AVAILABLE_ACTIONS\n"));\r
        return HiiPopulateDiskInfoForm ();\r
    }\r
  } else if (Action == EFI_BROWSER_ACTION_CHANGING) {\r
    switch (HiiKeyId) {\r
      case HII_KEY_ID_GOTO_DISK_INFO:\r
        return HiiSelectDisk ((UINT8)HiiKey.KeyBits.Index);\r
\r
      case HII_KEY_ID_REVERT:\r
      case HII_KEY_ID_PSID_REVERT:\r
        OpalDisk = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          return HiiConfirmDataRemovalAction (OpalDisk, L"Revert");\r
        } else {\r
          ASSERT (FALSE);\r
          return EFI_SUCCESS;\r
        }\r
\r
      case HII_KEY_ID_SECURE_ERASE:\r
        OpalDisk = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          return HiiConfirmDataRemovalAction (OpalDisk, L"Secure erase");\r
        } else {\r
          ASSERT (FALSE);\r
          return EFI_SUCCESS;\r
        }\r
    }\r
  } else if (Action == EFI_BROWSER_ACTION_CHANGED) {\r
    switch (HiiKeyId) {\r
      case HII_KEY_ID_BLOCKSID:\r
        switch (Value->u8) {\r
          case 0:\r
            PpRequest = TCG2_PHYSICAL_PRESENCE_NO_ACTION;\r
            break;\r
\r
          case 1:\r
            PpRequest = TCG2_PHYSICAL_PRESENCE_ENABLE_BLOCK_SID;\r
            break;\r
\r
          case 2:\r
            PpRequest = TCG2_PHYSICAL_PRESENCE_DISABLE_BLOCK_SID;\r
            break;\r
\r
          case 3:\r
            PpRequest = TCG2_PHYSICAL_PRESENCE_SET_PP_REQUIRED_FOR_ENABLE_BLOCK_SID_FUNC_TRUE;\r
            break;\r
\r
          case 4:\r
            PpRequest = TCG2_PHYSICAL_PRESENCE_SET_PP_REQUIRED_FOR_ENABLE_BLOCK_SID_FUNC_FALSE;\r
            break;\r
\r
          case 5:\r
            PpRequest = TCG2_PHYSICAL_PRESENCE_SET_PP_REQUIRED_FOR_DISABLE_BLOCK_SID_FUNC_TRUE;\r
            break;\r
\r
          case 6:\r
            PpRequest = TCG2_PHYSICAL_PRESENCE_SET_PP_REQUIRED_FOR_DISABLE_BLOCK_SID_FUNC_FALSE;\r
            break;\r
\r
          default:\r
            PpRequest = TCG2_PHYSICAL_PRESENCE_NO_ACTION;\r
            DEBUG ((DEBUG_ERROR, "Invalid value input!\n"));\r
            break;\r
        }\r
\r
        HiiSetBlockSidAction (PpRequest);\r
\r
        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
        return EFI_SUCCESS;\r
\r
      case HII_KEY_ID_SET_ADMIN_PWD:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_SET_ADMIN_PWD\n"));\r
        gHiiConfiguration.OpalRequest.SetAdminPwd = Value->b;\r
        OpalDisk                                  = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          SaveOpalRequest (OpalDisk, gHiiConfiguration.OpalRequest);\r
        }\r
\r
        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
        return EFI_SUCCESS;\r
\r
      case HII_KEY_ID_SET_USER_PWD:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_SET_USER_PWD\n"));\r
        gHiiConfiguration.OpalRequest.SetUserPwd = Value->b;\r
        OpalDisk                                 = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          SaveOpalRequest (OpalDisk, gHiiConfiguration.OpalRequest);\r
        }\r
\r
        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
        return EFI_SUCCESS;\r
\r
      case HII_KEY_ID_SECURE_ERASE:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_SECURE_ERASE\n"));\r
        gHiiConfiguration.OpalRequest.SecureErase = Value->b;\r
        OpalDisk                                  = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          SaveOpalRequest (OpalDisk, gHiiConfiguration.OpalRequest);\r
        }\r
\r
        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
        return EFI_SUCCESS;\r
\r
      case HII_KEY_ID_REVERT:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_REVERT\n"));\r
        gHiiConfiguration.OpalRequest.Revert = Value->b;\r
        OpalDisk                             = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          SaveOpalRequest (OpalDisk, gHiiConfiguration.OpalRequest);\r
        }\r
\r
        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
        return EFI_SUCCESS;\r
      case HII_KEY_ID_KEEP_USER_DATA:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_KEEP_USER_DATA\n"));\r
        gHiiConfiguration.OpalRequest.KeepUserData = Value->b;\r
        OpalDisk                                   = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          SaveOpalRequest (OpalDisk, gHiiConfiguration.OpalRequest);\r
        }\r
\r
        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
        return EFI_SUCCESS;\r
\r
      case HII_KEY_ID_PSID_REVERT:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_PSID_REVERT\n"));\r
        gHiiConfiguration.OpalRequest.PsidRevert = Value->b;\r
        OpalDisk                                 = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          SaveOpalRequest (OpalDisk, gHiiConfiguration.OpalRequest);\r
        }\r
\r
        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
        return EFI_SUCCESS;\r
\r
      case HII_KEY_ID_DISABLE_USER:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_DISABLE_USER\n"));\r
        gHiiConfiguration.OpalRequest.DisableUser = Value->b;\r
        OpalDisk                                  = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          SaveOpalRequest (OpalDisk, gHiiConfiguration.OpalRequest);\r
        }\r
\r
        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
        return EFI_SUCCESS;\r
\r
      case HII_KEY_ID_ENABLE_FEATURE:\r
        DEBUG ((DEBUG_INFO, "HII_KEY_ID_ENABLE_FEATURE\n"));\r
        gHiiConfiguration.OpalRequest.EnableFeature = Value->b;\r
        OpalDisk                                    = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
        if (OpalDisk != NULL) {\r
          SaveOpalRequest (OpalDisk, gHiiConfiguration.OpalRequest);\r
        }\r
\r
        *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
        return EFI_SUCCESS;\r
\r
      default:\r
        break;\r
    }\r
  }\r
\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  Update the global Disk index info.\r
\r
  @param   Index             The input disk index info.\r
\r
  @retval  EFI_SUCCESS       Update the disk index info success.\r
\r
**/\r
EFI_STATUS\r
HiiSelectDisk (\r
  UINT8  Index\r
  )\r
{\r
  OpalHiiGetBrowserData ();\r
  gHiiConfiguration.SelectedDiskIndex = Index;\r
  OpalHiiSetBrowserData ();\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Draws the disk info form.\r
\r
  @retval  EFI_SUCCESS       Draw the disk info success.\r
\r
**/\r
EFI_STATUS\r
HiiPopulateDiskInfoForm (\r
  VOID\r
  )\r
{\r
  OPAL_DISK          *OpalDisk;\r
  OPAL_DISK_ACTIONS  AvailActions;\r
  TCG_RESULT         Ret;\r
  CHAR8              *DiskName;\r
\r
  OpalHiiGetBrowserData ();\r
\r
  DiskName = HiiDiskGetNameCB (gHiiConfiguration.SelectedDiskIndex);\r
  if (DiskName == NULL) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  HiiSetFormString (STRING_TOKEN (STR_DISK_INFO_SELECTED_DISK_NAME), DiskName);\r
\r
  gHiiConfiguration.SelectedDiskAvailableActions = HII_ACTION_NONE;\r
  ZeroMem (&gHiiConfiguration.OpalRequest, sizeof (OPAL_REQUEST));\r
  gHiiConfiguration.KeepUserDataForced = FALSE;\r
\r
  OpalDisk = HiiGetOpalDiskCB (gHiiConfiguration.SelectedDiskIndex);\r
\r
  if (OpalDisk != NULL) {\r
    OpalDiskUpdateStatus (OpalDisk);\r
    Ret = OpalSupportGetAvailableActions (&OpalDisk->SupportedAttributes, &OpalDisk->LockingFeature, OpalDisk->Owner, &AvailActions);\r
    if (Ret == TcgResultSuccess) {\r
      //\r
      // Update actions, always allow PSID Revert\r
      //\r
      gHiiConfiguration.SelectedDiskAvailableActions |= (AvailActions.PsidRevert == 1) ? HII_ACTION_PSID_REVERT : HII_ACTION_NONE;\r
\r
      //\r
      // Always allow unlock to handle device migration\r
      //\r
      gHiiConfiguration.SelectedDiskAvailableActions |= (AvailActions.Unlock == 1) ? HII_ACTION_UNLOCK : HII_ACTION_NONE;\r
\r
      if (!OpalFeatureEnabled (&OpalDisk->SupportedAttributes, &OpalDisk->LockingFeature)) {\r
        if (OpalDisk->Owner == OpalOwnershipNobody) {\r
          gHiiConfiguration.SelectedDiskAvailableActions |= HII_ACTION_ENABLE_FEATURE;\r
\r
          //\r
          // Update strings\r
          //\r
          HiiSetFormString (STRING_TOKEN (STR_DISK_INFO_PSID_REVERT), "PSID Revert to factory default");\r
        } else {\r
          DEBUG ((DEBUG_INFO, "Feature disabled but ownership != nobody\n"));\r
        }\r
      } else {\r
        gHiiConfiguration.SelectedDiskAvailableActions |= (AvailActions.Revert == 1) ? HII_ACTION_REVERT : HII_ACTION_NONE;\r
        gHiiConfiguration.SelectedDiskAvailableActions |= (AvailActions.AdminPass == 1) ? HII_ACTION_SET_ADMIN_PWD : HII_ACTION_NONE;\r
        gHiiConfiguration.SelectedDiskAvailableActions |= (AvailActions.UserPass == 1) ? HII_ACTION_SET_USER_PWD : HII_ACTION_NONE;\r
        gHiiConfiguration.SelectedDiskAvailableActions |= (AvailActions.SecureErase == 1) ? HII_ACTION_SECURE_ERASE : HII_ACTION_NONE;\r
        gHiiConfiguration.SelectedDiskAvailableActions |= (AvailActions.DisableUser == 1) ? HII_ACTION_DISABLE_USER : HII_ACTION_NONE;\r
\r
        HiiSetFormString (STRING_TOKEN (STR_DISK_INFO_PSID_REVERT), "PSID Revert to factory default and Disable");\r
\r
        //\r
        // Determine revert options for disk\r
        // Default initialize keep user Data to be true\r
        //\r
        gHiiConfiguration.OpalRequest.KeepUserData = 1;\r
        if (AvailActions.RevertKeepDataForced) {\r
          gHiiConfiguration.KeepUserDataForced = TRUE;\r
        }\r
      }\r
    }\r
\r
    GetSavedOpalRequest (OpalDisk, &gHiiConfiguration.OpalRequest);\r
  }\r
\r
  //\r
  // Pass the current configuration to the BIOS\r
  //\r
  OpalHiiSetBrowserData ();\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Send BlockSid request through TPM physical presence module.\r
\r
  @param   PpRequest         TPM physical presence operation request.\r
\r
  @retval  EFI_SUCCESS       Do the required action success.\r
  @retval  Others            Other error occur.\r
\r
**/\r
EFI_STATUS\r
HiiSetBlockSidAction (\r
  IN UINT32  PpRequest\r
  )\r
{\r
  UINT32      ReturnCode;\r
  EFI_STATUS  Status;\r
\r
  ReturnCode = Tcg2PhysicalPresenceLibSubmitRequestToPreOSFunction (PpRequest, 0);\r
  if (ReturnCode == TCG_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS) {\r
    Status = EFI_SUCCESS;\r
  } else if (ReturnCode == TCG_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
  } else if (ReturnCode == TCG_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED) {\r
    Status = EFI_UNSUPPORTED;\r
  } else {\r
    Status = EFI_DEVICE_ERROR;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
  @param  This                   Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param  Configuration          A null-terminated Unicode string in <ConfigResp>\r
                                 format.\r
  @param  Progress               A pointer to a string filled in with the offset of\r
                                 the most recent '&' before the first failing\r
                                 name/value pair (or the beginning of the string if\r
                                 the failure is in the first name/value pair) or\r
                                 the terminating NULL if all was successful.\r
\r
  @retval EFI_SUCCESS            The Results is processed successfully.\r
  @retval EFI_INVALID_PARAMETER  Configuration is NULL.\r
  @retval EFI_NOT_FOUND          Routing data doesn't match any storage in this\r
                                 driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RouteConfig (\r
  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,\r
  CONST EFI_STRING                      Configuration,\r
  EFI_STRING                            *Progress\r
  )\r
{\r
  if ((Configuration == NULL) || (Progress == NULL)) {\r
    return (EFI_INVALID_PARAMETER);\r
  }\r
\r
  *Progress = Configuration;\r
  if (!HiiIsConfigHdrMatch (Configuration, &gHiiSetupVariableGuid, OpalPasswordStorageName)) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  *Progress = Configuration + StrLen (Configuration);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function allows a caller to extract the current configuration for one\r
  or more named elements from the target driver.\r
\r
  @param  This                   Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param  Request                A null-terminated Unicode string in\r
                                 <ConfigRequest> format.\r
  @param  Progress               On return, points to a character in the Request\r
                                 string. Points to the string's null terminator if\r
                                 request was successful. Points to the most recent\r
                                 '&' before the first failing name/value pair (or\r
                                 the beginning of the string if the failure is in\r
                                 the first name/value pair) if the request was not\r
                                 successful.\r
  @param  Results                A null-terminated Unicode string in\r
                                 <ConfigAltResp> format which has all values filled\r
                                 in for the names in the Request string. String to\r
                                 be allocated by the called function.\r
\r
  @retval EFI_SUCCESS            The Results is filled with the requested values.\r
  @retval EFI_OUT_OF_RESOURCES   Not enough memory to store the results.\r
  @retval EFI_INVALID_PARAMETER  Request is illegal syntax, or unknown name.\r
  @retval EFI_NOT_FOUND          Routing data doesn't match any storage in this\r
                                 driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ExtractConfig (\r
  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,\r
  CONST EFI_STRING                      Request,\r
  EFI_STRING                            *Progress,\r
  EFI_STRING                            *Results\r
  )\r
{\r
  EFI_STATUS  Status;\r
  EFI_STRING  ConfigRequest;\r
  EFI_STRING  ConfigRequestHdr;\r
  UINTN       BufferSize;\r
  UINTN       Size;\r
  BOOLEAN     AllocatedRequest;\r
  EFI_HANDLE  DriverHandle;\r
\r
  //\r
  // Check for valid parameters\r
  //\r
  if ((Progress == NULL) || (Results == NULL)) {\r
    return (EFI_INVALID_PARAMETER);\r
  }\r
\r
  *Progress = Request;\r
  if ((Request != NULL) &&\r
      !HiiIsConfigHdrMatch (Request, &gHiiSetupVariableGuid, OpalPasswordStorageName))\r
  {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  AllocatedRequest = FALSE;\r
  BufferSize       = sizeof (OPAL_HII_CONFIGURATION);\r
  ConfigRequest    = Request;\r
  if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) {\r
    //\r
    // Request has no request element, construct full request string.\r
    // Allocate and fill a buffer large enough to hold the <ConfigHdr> template\r
    // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r
    //\r
    DriverHandle     = HiiGetDriverImageHandleCB ();\r
    ConfigRequestHdr = HiiConstructConfigHdr (&gHiiSetupVariableGuid, OpalPasswordStorageName, DriverHandle);\r
    Size             = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);\r
    ConfigRequest    = AllocateZeroPool (Size);\r
    if (ConfigRequest == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    AllocatedRequest = TRUE;\r
    UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);\r
    FreePool (ConfigRequestHdr);\r
  }\r
\r
  //\r
  // Convert Buffer Data to <ConfigResp> by helper function BlockToConfig( )\r
  //\r
  Status = gHiiConfigRouting->BlockToConfig (\r
                                gHiiConfigRouting,\r
                                ConfigRequest,\r
                                (UINT8 *)&gHiiConfiguration,\r
                                sizeof (OPAL_HII_CONFIGURATION),\r
                                Results,\r
                                Progress\r
                                );\r
\r
  //\r
  // Free the allocated config request string.\r
  //\r
  if (AllocatedRequest) {\r
    FreePool (ConfigRequest);\r
    ConfigRequest = NULL;\r
  }\r
\r
  //\r
  // Set Progress string to the original request string.\r
  //\r
  if (Request == NULL) {\r
    *Progress = NULL;\r
  } else if (StrStr (Request, L"OFFSET") == NULL) {\r
    *Progress = Request + StrLen (Request);\r
  }\r
\r
  return (Status);\r
}\r
\r
/**\r
\r
  Pass the current system state to the bios via the hii_G_Configuration.\r
\r
**/\r
VOID\r
OpalHiiSetBrowserData (\r
  VOID\r
  )\r
{\r
  HiiSetBrowserData (\r
    &gHiiSetupVariableGuid,\r
    (CHAR16 *)L"OpalHiiConfig",\r
    sizeof (gHiiConfiguration),\r
    (UINT8 *)&gHiiConfiguration,\r
    NULL\r
    );\r
}\r
\r
/**\r
\r
  Populate the hii_g_Configuration with the browser Data.\r
\r
**/\r
VOID\r
OpalHiiGetBrowserData (\r
  VOID\r
  )\r
{\r
  HiiGetBrowserData (\r
    &gHiiSetupVariableGuid,\r
    (CHAR16 *)L"OpalHiiConfig",\r
    sizeof (gHiiConfiguration),\r
    (UINT8 *)&gHiiConfiguration\r
    );\r
}\r
\r
/**\r
  Set a string Value in a form.\r
\r
  @param      DestStringId   The stringid which need to update.\r
  @param      SrcAsciiStr    The string need to update.\r
\r
  @retval  EFI_SUCCESS       Do the required action success.\r
  @retval  Others            Other error occur.\r
\r
**/\r
EFI_STATUS\r
HiiSetFormString (\r
  EFI_STRING_ID  DestStringId,\r
  CHAR8          *SrcAsciiStr\r
  )\r
{\r
  UINT32  Len;\r
  UINT32  UniSize;\r
  CHAR16  *UniStr;\r
\r
  //\r
  // Determine the Length of the sting\r
  //\r
  Len = (UINT32)AsciiStrLen (SrcAsciiStr);\r
\r
  //\r
  // Allocate space for the unicode string, including terminator\r
  //\r
  UniSize = (Len + 1) * sizeof (CHAR16);\r
  UniStr  = (CHAR16 *)AllocateZeroPool (UniSize);\r
\r
  //\r
  // Copy into unicode string, then copy into string id\r
  //\r
  AsciiStrToUnicodeStrS (SrcAsciiStr, UniStr, Len + 1);\r
\r
  //\r
  // Update the string in the form\r
  //\r
  if (HiiSetString (gHiiPackageListHandle, DestStringId, UniStr, NULL) == 0) {\r
    DEBUG ((DEBUG_INFO, "HiiSetFormString( ) failed\n"));\r
    FreePool (UniStr);\r
    return (EFI_OUT_OF_RESOURCES);\r
  }\r
\r
  //\r
  // Free the memory\r
  //\r
  FreePool (UniStr);\r
\r
  return (EFI_SUCCESS);\r
}\r
\r
/**\r
  Initialize the Opal disk base on the hardware info get from device.\r
\r
  @param Dev                  The Opal device.\r
\r
  @retval EFI_SUCCESS         Initialize the device success.\r
  @retval EFI_DEVICE_ERROR    Get info from device failed.\r
\r
**/\r
EFI_STATUS\r
OpalDiskInitialize (\r
  IN OPAL_DRIVER_DEVICE  *Dev\r
  )\r
{\r
  TCG_RESULT    TcgResult;\r
  OPAL_SESSION  Session;\r
  UINT8         ActiveDataRemovalMechanism;\r
  UINT32        RemovalMechanishLists[ResearvedMechanism];\r
\r
  ZeroMem (&Dev->OpalDisk, sizeof (OPAL_DISK));\r
  Dev->OpalDisk.Sscp           = Dev->Sscp;\r
  Dev->OpalDisk.MediaId        = Dev->MediaId;\r
  Dev->OpalDisk.OpalDevicePath = Dev->OpalDevicePath;\r
\r
  ZeroMem (&Session, sizeof (Session));\r
  Session.Sscp    = Dev->Sscp;\r
  Session.MediaId = Dev->MediaId;\r
\r
  TcgResult = OpalGetSupportedAttributesInfo (&Session, &Dev->OpalDisk.SupportedAttributes, &Dev->OpalDisk.OpalBaseComId);\r
  if (TcgResult != TcgResultSuccess) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Session.OpalBaseComId = Dev->OpalDisk.OpalBaseComId;\r
\r
  TcgResult = OpalUtilGetMsid (&Session, Dev->OpalDisk.Msid, OPAL_MSID_LENGTH, &Dev->OpalDisk.MsidLength);\r
  if (TcgResult != TcgResultSuccess) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (Dev->OpalDisk.SupportedAttributes.DataRemoval) {\r
    TcgResult = OpalUtilGetDataRemovalMechanismLists (&Session, RemovalMechanishLists);\r
    if (TcgResult != TcgResultSuccess) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    TcgResult = OpalUtilGetActiveDataRemovalMechanism (&Session, Dev->OpalDisk.Msid, Dev->OpalDisk.MsidLength, &ActiveDataRemovalMechanism);\r
    if (TcgResult != TcgResultSuccess) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    Dev->OpalDisk.EstimateTimeCost = RemovalMechanishLists[ActiveDataRemovalMechanism];\r
  }\r
\r
  return OpalDiskUpdateStatus (&Dev->OpalDisk);\r
}\r
\r
/**\r
  Update the device ownship\r
\r
  @param OpalDisk                The Opal device.\r
\r
  @retval EFI_SUCCESS            Get ownership success.\r
  @retval EFI_ACCESS_DENIED      Has send BlockSID command, can't change ownership.\r
  @retval EFI_INVALID_PARAMETER  Not get Msid info before get ownership info.\r
\r
**/\r
EFI_STATUS\r
OpalDiskUpdateOwnerShip (\r
  OPAL_DISK  *OpalDisk\r
  )\r
{\r
  OPAL_SESSION  Session;\r
\r
  if (OpalDisk->MsidLength == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (OpalDisk->SentBlockSID) {\r
    return EFI_ACCESS_DENIED;\r
  }\r
\r
  ZeroMem (&Session, sizeof (Session));\r
  Session.Sscp          = OpalDisk->Sscp;\r
  Session.MediaId       = OpalDisk->MediaId;\r
  Session.OpalBaseComId = OpalDisk->OpalBaseComId;\r
\r
  OpalDisk->Owner = OpalUtilDetermineOwnership (&Session, OpalDisk->Msid, OpalDisk->MsidLength);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Update the device info.\r
\r
  @param OpalDisk                The Opal device.\r
\r
  @retval EFI_SUCCESS            Initialize the device success.\r
  @retval EFI_DEVICE_ERROR       Get info from device failed.\r
  @retval EFI_INVALID_PARAMETER  Not get Msid info before get ownership info.\r
  @retval EFI_ACCESS_DENIED      Has send BlockSID command, can't change ownership.\r
\r
**/\r
EFI_STATUS\r
OpalDiskUpdateStatus (\r
  OPAL_DISK  *OpalDisk\r
  )\r
{\r
  TCG_RESULT    TcgResult;\r
  OPAL_SESSION  Session;\r
\r
  ZeroMem (&Session, sizeof (Session));\r
  Session.Sscp          = OpalDisk->Sscp;\r
  Session.MediaId       = OpalDisk->MediaId;\r
  Session.OpalBaseComId = OpalDisk->OpalBaseComId;\r
\r
  TcgResult = OpalGetLockingInfo (&Session, &OpalDisk->LockingFeature);\r
  if (TcgResult != TcgResultSuccess) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return OpalDiskUpdateOwnerShip (OpalDisk);\r
}\r