MdeModulePkg[all]  0.98
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ResetSystemLib.h File Reference

Functions

VOID EFIAPI ResetCold (VOID)
 
VOID EFIAPI ResetWarm (VOID)
 
VOID EFIAPI ResetShutdown (VOID)
 
VOID EFIAPI ResetPlatformSpecific (IN UINTN DataSize, IN VOID *ResetData)
 
VOID EFIAPI ResetSystem (IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN VOID *ResetData)
 

Detailed Description

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.
SPDX-License-Identifier: BSD-2-Clause-Patent

Function Documentation

VOID EFIAPI ResetCold ( VOID  )

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 ResetPlatformSpecific ( IN UINTN  DataSize,
IN VOID ResetData 
)

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.

Parameters
[in]DataSizeThe size, in bytes, of ResetData.
[in]ResetDataThe data buffer starts with a Null-terminated string, followed by the EFI_GUID.
VOID EFIAPI ResetShutdown ( 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 ResetSystem ( IN EFI_RESET_TYPE  ResetType,
IN EFI_STATUS  ResetStatus,
IN UINTN  DataSize,
IN VOID ResetData 
)

The ResetSystem function resets the entire platform.

Parameters
[in]ResetTypeThe type of reset to perform.
[in]ResetStatusThe status code for the reset.
[in]DataSizeThe size, in bytes, of ResetData.
[in]ResetDataFor 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 ResetWarm ( 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.