049974bd6c
BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=1460 Add a new API ResetSystem for PEI ResetSystemLib to be in accord with DXE instance. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Zhichao Gao <zhichao.gao@intel.com> Cc: Ray Ni <ray.ni@intel.com> Cc: Liming Gao <liming.gao@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com>
125 lines
4.0 KiB
C
125 lines
4.0 KiB
C
/** @file
|
|
PEI Reset System Library instance that calls the ResetSystem2() PEI Service.
|
|
|
|
Copyright (c) 2017 - 2019, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#include <PiPei.h>
|
|
#include <Library/ResetSystemLib.h>
|
|
#include <Library/PeiServicesLib.h>
|
|
|
|
/**
|
|
This function causes a system-wide reset (cold reset), in which
|
|
all circuitry within the system returns to its initial state. This type of reset
|
|
is asynchronous to system operation and operates without regard to
|
|
cycle boundaries.
|
|
|
|
If this function returns, it means that the system does not support cold reset.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
ResetCold (
|
|
VOID
|
|
)
|
|
{
|
|
PeiServicesResetSystem2 (EfiResetCold, EFI_SUCCESS, 0, NULL);
|
|
}
|
|
|
|
/**
|
|
This function causes a system-wide initialization (warm reset), in which all processors
|
|
are set to their initial state. Pending cycles are not corrupted.
|
|
|
|
If this function returns, it means that the system does not support warm reset.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
ResetWarm (
|
|
VOID
|
|
)
|
|
{
|
|
PeiServicesResetSystem2 (EfiResetWarm, EFI_SUCCESS, 0, NULL);
|
|
}
|
|
|
|
/**
|
|
This function causes the system to enter a power state equivalent
|
|
to the ACPI G2/S5 or G3 states.
|
|
|
|
If this function returns, it means that the system does not support shut down reset.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
ResetShutdown (
|
|
VOID
|
|
)
|
|
{
|
|
PeiServicesResetSystem2 (EfiResetShutdown, EFI_SUCCESS, 0, NULL);
|
|
}
|
|
|
|
/**
|
|
This function causes the system to enter S3 and then wake up immediately.
|
|
|
|
If this function returns, it means that the system does not support S3 feature.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
EnterS3WithImmediateWake (
|
|
VOID
|
|
)
|
|
{
|
|
}
|
|
|
|
/**
|
|
This function causes a systemwide reset. The exact type of the reset is
|
|
defined by the EFI_GUID that follows the Null-terminated Unicode string passed
|
|
into ResetData. If the platform does not recognize the EFI_GUID in ResetData
|
|
the platform must pick a supported reset type to perform.The platform may
|
|
optionally log the parameters from any non-normal reset that occurs.
|
|
|
|
@param[in] DataSize The size, in bytes, of ResetData.
|
|
@param[in] ResetData The data buffer starts with a Null-terminated string,
|
|
followed by the EFI_GUID.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
ResetPlatformSpecific (
|
|
IN UINTN DataSize,
|
|
IN VOID *ResetData
|
|
)
|
|
{
|
|
PeiServicesResetSystem2 (EfiResetPlatformSpecific, EFI_SUCCESS, DataSize, ResetData);
|
|
}
|
|
|
|
/**
|
|
The ResetSystem function resets the entire platform.
|
|
|
|
@param[in] ResetType The type of reset to perform.
|
|
@param[in] ResetStatus The status code for the reset.
|
|
@param[in] DataSize The size, in bytes, of ResetData.
|
|
@param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown
|
|
the data buffer starts with a Null-terminated string, optionally
|
|
followed by additional binary data. The string is a description
|
|
that the caller may use to further indicate the reason for the
|
|
system reset. ResetData is only valid if ResetStatus is something
|
|
other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific
|
|
where a minimum amount of ResetData is always required.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
ResetSystem (
|
|
IN EFI_RESET_TYPE ResetType,
|
|
IN EFI_STATUS ResetStatus,
|
|
IN UINTN DataSize,
|
|
IN VOID *ResetData OPTIONAL
|
|
)
|
|
{
|
|
PeiServicesResetSystem2 (ResetType, ResetStatus, DataSize, ResetData);
|
|
}
|