RuntimeResetSystemLib.c File Reference

#include <PiDxe.h>
#include <Library/ResetSystemLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DebugLib.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)
VOID EFIAPI	RuntimeResetSystemLibVirtualAddressChange (IN EFI_EVENT Event, IN VOID *Context)
EFI_STATUS EFIAPI	RuntimeResetSystemLibConstruct (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI	RuntimeResetSystemLibDeconstruct (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_EVENT	mRuntimeResetSystemLibVirtualAddressChangeEvent

Detailed Description

DXE Reset System Library instance that calls gRT->ResetSystem().

Copyright (c) 2017 - 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file RuntimeResetSystemLib.c.

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.

Definition at line 28 of file RuntimeResetSystemLib.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.

Definition at line 78 of file RuntimeResetSystemLib.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 shut down reset.

Definition at line 58 of file RuntimeResetSystemLib.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 100 of file RuntimeResetSystemLib.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.

Definition at line 43 of file RuntimeResetSystemLib.c.

RuntimeResetSystemLibConstruct()

EFI_STATUS EFIAPI RuntimeResetSystemLibConstruct	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The constructor function of Runtime Reset System Lib.

This function allocates memory for extended status code data, caches the report status code service, and registers events.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS

The constructor always returns EFI_SUCCESS.

Definition at line 141 of file RuntimeResetSystemLib.c.

RuntimeResetSystemLibDeconstruct()

EFI_STATUS EFIAPI RuntimeResetSystemLibDeconstruct	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The Deconstructor function of Runtime Reset System Lib.

The destructor function frees memory allocated by constructor, and closes related events. It will ASSERT() if that related operation fails and it will always return EFI_SUCCESS.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS

The constructor always returns EFI_SUCCESS.

Definition at line 183 of file RuntimeResetSystemLib.c.

RuntimeResetSystemLibVirtualAddressChange()

VOID EFIAPI RuntimeResetSystemLibVirtualAddressChange	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.

Parameters

Event	Event whose notification function is being invoked.
Context	Pointer to the notification function's context

Definition at line 119 of file RuntimeResetSystemLib.c.

Variable Documentation

mRuntimeResetSystemLibVirtualAddressChangeEvent

EFI_EVENT mRuntimeResetSystemLibVirtualAddressChangeEvent

Definition at line 15 of file RuntimeResetSystemLib.c.