UefiPayloadPkg: Enhance UEFI payload for coreboot and Slim Bootloader

[mirror_edk2.git] / UefiPayloadPkg / Library / ResetSystemLib / ResetSystemLib.c

/** @file\r
  Reset System Library functions for bootloader\r
\r
  Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiDxe.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Guid/AcpiBoardInfoGuid.h>\r
\r
ACPI_BOARD_INFO    mAcpiBoardInfo;\r
\r
/**\r
  The constructor function to initialize mAcpiBoardInfo.\r
\r
  @retval EFI_SUCCESS   The constructor always returns RETURN_SUCCESS.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
ResetSystemLibConstructor (\r
  VOID\r
  )\r
{\r
  EFI_HOB_GUID_TYPE  *GuidHob;\r
  ACPI_BOARD_INFO    *AcpiBoardInfoPtr;\r
\r
  //\r
  // Find the acpi board information guid hob\r
  //\r
  GuidHob = GetFirstGuidHob (&gUefiAcpiBoardInfoGuid);\r
  ASSERT (GuidHob != NULL);\r
\r
  AcpiBoardInfoPtr = (ACPI_BOARD_INFO *)GET_GUID_HOB_DATA (GuidHob);\r
  CopyMem (&mAcpiBoardInfo, AcpiBoardInfoPtr, sizeof (ACPI_BOARD_INFO));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
VOID\r
AcpiPmControl (\r
  UINTN   SuspendType\r
  )\r
{\r
  UINTN              PmCtrlReg;\r
\r
  ASSERT (SuspendType <= 7);\r
\r
  PmCtrlReg = (UINTN)mAcpiBoardInfo.PmCtrlRegBase;\r
  IoAndThenOr16 (PmCtrlReg, (UINT16) ~0x3c00, (UINT16) (SuspendType << 10));\r
  IoOr16 (PmCtrlReg, BIT13);\r
  CpuDeadLoop ();\r
}\r
\r
/**\r
  Calling this function causes a system-wide reset. This sets\r
  all circuitry within the system to its initial state. This type of reset\r
  is asynchronous to system operation and operates without regard to\r
  cycle boundaries.\r
\r
  System reset should not return, if it returns, it means the system does\r
  not support cold reset.\r
**/\r
VOID\r
EFIAPI\r
ResetCold (\r
  VOID\r
  )\r
{\r
  IoWrite8 ((UINTN)mAcpiBoardInfo.ResetRegAddress, mAcpiBoardInfo.ResetValue);\r
  CpuDeadLoop ();\r
}\r
\r
/**\r
  Calling this function causes a system-wide initialization. The processors\r
  are set to their initial state, and pending cycles are not corrupted.\r
\r
  System reset should not return, if it returns, it means the system does\r
  not support warm reset.\r
**/\r
VOID\r
EFIAPI\r
ResetWarm (\r
  VOID\r
  )\r
{\r
  IoWrite8 ((UINTN)mAcpiBoardInfo.ResetRegAddress, mAcpiBoardInfo.ResetValue);\r
  CpuDeadLoop ();\r
}\r
\r
/**\r
  Calling this function causes the system to enter a power state equivalent\r
  to the ACPI G2/S5 or G3 states.\r
\r
  System shutdown should not return, if it returns, it means the system does\r
  not support shut down reset.\r
**/\r
VOID\r
EFIAPI\r
ResetShutdown (\r
  VOID\r
  )\r
{\r
  UINTN              PmCtrlReg;\r
\r
  //\r
  // GPE0_EN should be disabled to avoid any GPI waking up the system from S5\r
  //\r
  IoWrite16 ((UINTN)mAcpiBoardInfo.PmGpeEnBase,  0);\r
\r
  //\r
  // Clear Power Button Status\r
  //\r
  IoWrite16((UINTN) mAcpiBoardInfo.PmEvtBase, BIT8);\r
\r
  //\r
  // Transform system into S5 sleep state\r
  //\r
  PmCtrlReg = (UINTN)mAcpiBoardInfo.PmCtrlRegBase;\r
  IoAndThenOr16 (PmCtrlReg, (UINT16) ~0x3c00, (UINT16) (7 << 10));\r
  IoOr16 (PmCtrlReg, BIT13);\r
  CpuDeadLoop ();\r
\r
  ASSERT (FALSE);\r
}\r
\r
/**\r
  Calling this function causes the system to enter a power state for capsule\r
  update.\r
\r
  Reset update should not return, if it returns, it means the system does\r
  not support capsule update.\r
\r
**/\r
VOID\r
EFIAPI\r
EnterS3WithImmediateWake (\r
  VOID\r
  )\r
{\r
  AcpiPmControl (5);\r
  ASSERT (FALSE);\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
  ResetCold ();\r
}\r