mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-12-18 15:27:48 +01:00
105 lines
3.1 KiB
C
105 lines
3.1 KiB
C
/** @file
|
|
System reset Library Services. This library class defines a set of
|
|
methods that reset the whole system.
|
|
|
|
Copyright (c) 2005 - 2019, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef __RESET_SYSTEM_LIB_H__
|
|
#define __RESET_SYSTEM_LIB_H__
|
|
|
|
#include <Uefi/UefiBaseType.h>
|
|
#include <Uefi/UefiMultiPhase.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
|
|
);
|
|
|
|
/**
|
|
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
|
|
);
|
|
|
|
/**
|
|
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 shutdown reset.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
ResetShutdown (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
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
|
|
);
|
|
|
|
/**
|
|
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.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
ResetSystem (
|
|
IN EFI_RESET_TYPE ResetType,
|
|
IN EFI_STATUS ResetStatus,
|
|
IN UINTN DataSize,
|
|
IN VOID *ResetData OPTIONAL
|
|
);
|
|
|
|
#endif
|