ResetSystemLib.h File Reference

#include <Uefi/UefiBaseType.h>
#include <Uefi/UefiMultiPhase.h>

Go to the source code of this file.

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 OPTIONAL)

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

Definition in file ResetSystemLib.h.

Function Documentation

ResetCold()

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.

Calling this function causes a system-wide reset. This sets all circuitry within the system to its initial state. This type of reset is asynchronous to system operation and operates without regard to cycle boundaries.

System reset should not return, if it returns, it means the system does not support cold reset.

Definition at line 48 of file ArmPsciResetSystemLib.c.

ResetPlatformSpecific()

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]	DataSize	The size, in bytes, of ResetData.
[in]	ResetData	The data buffer starts with a Null-terminated string, followed by the EFI_GUID.

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]	DataSize	The size, in bytes, of ResetData.
[in]	ResetData	The data buffer starts with a Null-terminated string, followed by the EFI_GUID.

Definition at line 126 of file ArmPsciResetSystemLib.c.

ResetShutdown()

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.

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.

Calling this function causes the system to enter a power state equivalent to the ACPI G2/S5 or G3 states.

System shutdown should not return, if it returns, it means the system does not support shut down reset.

Definition at line 101 of file ArmPsciResetSystemLib.c.

ResetSystem()

VOID EFIAPI ResetSystem	(	IN EFI_RESET_TYPE	ResetType,
		IN EFI_STATUS	ResetStatus,
		IN UINTN	DataSize,
		IN VOID *ResetData	OPTIONAL
	)

The ResetSystem function resets the entire platform.

Parameters

[in]	ResetType	The type of reset to perform.
[in]	ResetStatus	The status code for the reset.
[in]	DataSize	The size, in bytes, of ResetData.
[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.

Definition at line 149 of file ArmPsciResetSystemLib.c.

ResetWarm()

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.

Calling this function causes a system-wide initialization. The processors are set to their initial state, and pending cycles are not corrupted.

System reset should not return, if it returns, it means the system does not support warm reset.

Definition at line 68 of file ArmPsciResetSystemLib.c.