ArmPkg: implement ResetSystemLib using PSCI 0.2 calls

[mirror_edk2.git] / ArmVirtPkg / Library / ArmVirtPsciResetSystemLib / ArmVirtPsciResetSystemLib.c

/** @file\r
  Support ResetSystem Runtime call using PSCI calls\r
\r
  Note: A similar library is implemented in\r
  ArmPkg/Library/ArmPsciResetSystemLib. Similar issues might\r
  exist in this implementation too.\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
  Copyright (c) 2013, ARM Ltd. All rights reserved.<BR>\r
  Copyright (c) 2014, Linaro Ltd. All rights reserved.<BR>\r
\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
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <PiDxe.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/EfiResetSystemLib.h>\r
#include <Library/ArmSmcLib.h>\r
#include <Library/ArmHvcLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#include <IndustryStandard/ArmStdSmc.h>\r
\r
#include <Protocol/FdtClient.h>\r
\r
STATIC UINT32 mArmPsciMethod;\r
\r
RETURN_STATUS\r
EFIAPI\r
ArmPsciResetSystemLibConstructor (\r
  VOID\r
  )\r
{\r
  EFI_STATUS            Status;\r
  FDT_CLIENT_PROTOCOL   *FdtClient;\r
  CONST VOID            *Prop;\r
\r
  Status = gBS->LocateProtocol (&gFdtClientProtocolGuid, NULL,\r
                  (VOID **)&FdtClient);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = FdtClient->FindCompatibleNodeProperty (FdtClient, "arm,psci-0.2",\r
                        "method", &Prop, NULL);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (AsciiStrnCmp (Prop, "hvc", 3) == 0) {\r
    mArmPsciMethod = 1;\r
  } else if (AsciiStrnCmp (Prop, "smc", 3) == 0) {\r
    mArmPsciMethod = 2;\r
  } else {\r
    DEBUG ((EFI_D_ERROR, "%a: Unknown PSCI method \"%a\"\n", __FUNCTION__,\r
      Prop));\r
    return EFI_NOT_FOUND;\r
  }\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Resets the entire platform.\r
\r
  @param  ResetType             The type of reset to perform.\r
  @param  ResetStatus           The status code for the reset.\r
  @param  DataSize              The size, in bytes, of WatchdogData.\r
  @param  ResetData             For a ResetType of EfiResetCold, EfiResetWarm, or\r
                                EfiResetShutdown the data buffer starts with a Null-terminated\r
                                Unicode string, optionally followed by additional binary data.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibResetSystem (\r
  IN EFI_RESET_TYPE   ResetType,\r
  IN EFI_STATUS       ResetStatus,\r
  IN UINTN            DataSize,\r
  IN CHAR16           *ResetData OPTIONAL\r
  )\r
{\r
  ARM_SMC_ARGS ArmSmcArgs;\r
  ARM_HVC_ARGS ArmHvcArgs;\r
\r
  switch (ResetType) {\r
\r
  case EfiResetPlatformSpecific:\r
    // Map the platform specific reset as reboot\r
  case EfiResetWarm:\r
    // Map a warm reset into a cold reset\r
  case EfiResetCold:\r
    // Send a PSCI 0.2 SYSTEM_RESET command\r
    ArmSmcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_RESET;\r
    ArmHvcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_RESET;\r
    break;\r
  case EfiResetShutdown:\r
    // Send a PSCI 0.2 SYSTEM_OFF command\r
    ArmSmcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_OFF;\r
    ArmHvcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_OFF;\r
    break;\r
  default:\r
    ASSERT (FALSE);\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  switch (mArmPsciMethod) {\r
  case 1:\r
    ArmCallHvc (&ArmHvcArgs);\r
    break;\r
\r
  case 2:\r
    ArmCallSmc (&ArmSmcArgs);\r
    break;\r
\r
  default:\r
    DEBUG ((EFI_D_ERROR, "%a: no PSCI method defined\n", __FUNCTION__));\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  // We should never be here\r
  DEBUG ((EFI_D_ERROR, "%a: PSCI Reset failed\n", __FUNCTION__));\r
  CpuDeadLoop ();\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  Initialize any infrastructure required for LibResetSystem () to function.\r
\r
  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param  SystemTable   A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibInitializeResetSystem (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r