ArmPkg/ArmSmcPsciResetSystemLib: Add a new API ResetSystem

[mirror_edk2.git] / ArmPkg / Library / ArmSmcPsciResetSystemLib / ArmSmcPsciResetSystemLib.c

/** @file\r
  ResetSystemLib implementation using PSCI calls\r
\r
  Copyright (c) 2017 - 2018, Linaro Ltd. All rights reserved.<BR>\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiDxe.h>\r
\r
#include <Library/ArmMmuLib.h>\r
#include <Library/ArmSmcLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/ResetSystemLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
\r
#include <IndustryStandard/ArmStdSmc.h>\r
\r
/**\r
  This function causes a system-wide reset (cold reset), in which\r
  all circuitry within the system returns to its initial state. This type of reset\r
  is asynchronous to system operation and operates without regard to\r
  cycle boundaries.\r
\r
  If this function returns, it means that the system does not support cold reset.\r
**/\r
VOID\r
EFIAPI\r
ResetCold (\r
  VOID\r
  )\r
{\r
  ARM_SMC_ARGS ArmSmcArgs;\r
\r
  // Send a PSCI 0.2 SYSTEM_RESET command\r
  ArmSmcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_RESET;\r
  ArmCallSmc (&ArmSmcArgs);\r
}\r
\r
/**\r
  This function causes a system-wide initialization (warm reset), in which all processors\r
  are set to their initial state. Pending cycles are not corrupted.\r
\r
  If this function returns, it means that the system does not support warm reset.\r
**/\r
VOID\r
EFIAPI\r
ResetWarm (\r
  VOID\r
  )\r
{\r
  // Map a warm reset into a cold reset\r
  ResetCold ();\r
}\r
\r
/**\r
  This function causes the system to enter a power state equivalent\r
  to the ACPI G2/S5 or G3 states.\r
\r
  If this function returns, it means that the system does not support shutdown reset.\r
**/\r
VOID\r
EFIAPI\r
ResetShutdown (\r
  VOID\r
  )\r
{\r
  ARM_SMC_ARGS ArmSmcArgs;\r
\r
  // Send a PSCI 0.2 SYSTEM_OFF command\r
  ArmSmcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_OFF;\r
  ArmCallSmc (&ArmSmcArgs);\r
}\r
\r
VOID DisableMmuAndReenterPei (VOID);\r
\r
/**\r
  This function causes the system to enter S3 and then wake up immediately.\r
\r
  If this function returns, it means that the system does not support S3 feature.\r
**/\r
VOID\r
EFIAPI\r
EnterS3WithImmediateWake (\r
  VOID\r
  )\r
{\r
  EFI_PHYSICAL_ADDRESS        Alloc;\r
  EFI_MEMORY_DESCRIPTOR       *MemMap;\r
  UINTN                       MemMapSize;\r
  UINTN                       MapKey, DescriptorSize;\r
  UINT32                      DescriptorVersion;\r
  EFI_STATUS                  Status;\r
\r
  if (FeaturePcdGet (PcdArmReenterPeiForCapsuleWarmReboot) &&\r
      !EfiAtRuntime ()) {\r
    //\r
    // At boot time, we are the only core running, so we can implement the\r
    // immediate wake (which is used by capsule update) by disabling the MMU\r
    // and interrupts, and jumping to the PEI entry point.\r
    //\r
\r
    //\r
    // Obtain the size of the memory map\r
    //\r
    MemMapSize = 0;\r
    MemMap = NULL;\r
    Status = gBS->GetMemoryMap (&MemMapSize, MemMap, &MapKey, &DescriptorSize,\r
                    &DescriptorVersion);\r
    ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r
\r
    //\r
    // Add some slack to the allocation to cater for changes in the memory\r
    // map if ExitBootServices () fails the first time around.\r
    //\r
    MemMapSize += SIZE_4KB;\r
    Status = gBS->AllocatePages (AllocateAnyPages, EfiBootServicesData,\r
                    EFI_SIZE_TO_PAGES (MemMapSize), &Alloc);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    MemMap = (EFI_MEMORY_DESCRIPTOR *)(UINTN)Alloc;\r
\r
    Status = gBS->GetMemoryMap (&MemMapSize, MemMap, &MapKey, &DescriptorSize,\r
                    &DescriptorVersion);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Status = gBS->ExitBootServices (gImageHandle, MapKey);\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // ExitBootServices () may fail the first time around if an event fired\r
      // right after the call to GetMemoryMap() which allocated or freed memory.\r
      // Since that first call to ExitBootServices () will disarm the timer,\r
      // this is guaranteed not to happen again, so one additional attempt\r
      // should suffice.\r
      //\r
      Status = gBS->GetMemoryMap (&MemMapSize, MemMap, &MapKey, &DescriptorSize,\r
                      &DescriptorVersion);\r
      ASSERT_EFI_ERROR (Status);\r
\r
      Status = gBS->ExitBootServices (gImageHandle, MapKey);\r
      ASSERT_EFI_ERROR (Status);\r
    }\r
\r
    DisableMmuAndReenterPei ();\r
  }\r
}\r
\r
/**\r
  This function causes a systemwide reset. The exact type of the reset is\r
  defined by the EFI_GUID that follows the Null-terminated Unicode string passed\r
  into ResetData. If the platform does not recognize the EFI_GUID in ResetData\r
  the platform must pick a supported reset type to perform.The platform may\r
  optionally log the parameters from any non-normal reset that occurs.\r
\r
  @param[in]  DataSize   The size, in bytes, of ResetData.\r
  @param[in]  ResetData  The data buffer starts with a Null-terminated string,\r
                         followed by the EFI_GUID.\r
**/\r
VOID\r
EFIAPI\r
ResetPlatformSpecific (\r
  IN UINTN   DataSize,\r
  IN VOID    *ResetData\r
  )\r
{\r
  // Map the platform specific reset as reboot\r
  ResetCold ();\r
}\r
\r
/**\r
  The ResetSystem function resets the entire platform.\r
\r
  @param[in] ResetType      The type of reset to perform.\r
  @param[in] ResetStatus    The status code for the reset.\r
  @param[in] DataSize       The size, in bytes, of ResetData.\r
  @param[in] ResetData      For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown\r
                            the data buffer starts with a Null-terminated string, optionally\r
                            followed by additional binary data. The string is a description\r
                            that the caller may use to further indicate the reason for the\r
                            system reset.\r
**/\r
VOID\r
EFIAPI\r
ResetSystem (\r
  IN EFI_RESET_TYPE               ResetType,\r
  IN EFI_STATUS                   ResetStatus,\r
  IN UINTN                        DataSize,\r
  IN VOID                         *ResetData OPTIONAL\r
  )\r
{\r
  switch (ResetType) {\r
  case EfiResetWarm:\r
    ResetWarm ();\r
    break;\r
\r
  case EfiResetCold:\r
    ResetCold ();\r
    break;\r
\r
  case EfiResetShutdown:\r
    ResetShutdown ();\r
    return;\r
\r
  case EfiResetPlatformSpecific:\r
    ResetPlatformSpecific (DataSize, ResetData);\r
    return;\r
\r
  default:\r
    return;\r
  }\r
}\r