MdeModulePkg/DxeResetSystemLib.c: Change comments of ResetSystem

[mirror_edk2.git] / MdeModulePkg / Library / DxeResetSystemLib / DxeResetSystemLib.c

/** @file\r
  DXE Reset System Library instance that calls gRT->ResetSystem().\r
\r
  Copyright (c) 2017 - 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/ResetSystemLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.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
  gRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);\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
  gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\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 shut down reset.\r
**/\r
VOID\r
EFIAPI\r
ResetShutdown (\r
  VOID\r
  )\r
{\r
  gRT->ResetSystem (EfiResetShutdown, EFI_SUCCESS, 0, NULL);\r
}\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
}\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
  gRT->ResetSystem (EfiResetPlatformSpecific, EFI_SUCCESS, DataSize, ResetData);\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
  gRT->ResetSystem (ResetType, ResetStatus, DataSize, ResetData);\r
}\r