PcAtChipsetPkg/ResetSystemLib: Add new API ResetSystem

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

/** @file\r
  Reset System Library functions for PCAT platforms\r
\r
  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Base.h>\r
\r
#include <Uefi/UefiBaseType.h>\r
#include <Uefi/UefiMultiPhase.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/IoLib.h>\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) PcdGet64 (PcdResetControlRegister), PcdGet8 (PcdResetControlValueColdReset));\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) PcdGet64 (PcdResetControlRegister), PcdGet8 (PcdResetControlValueColdReset));\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
  ASSERT (FALSE);\r
}\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
  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
\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