ResetSystem.h File Reference

#include <PiDxe.h>
#include <Protocol/Reset.h>
#include <Protocol/ResetNotification.h>
#include <Protocol/PlatformSpecificResetFilter.h>
#include <Protocol/PlatformSpecificResetHandler.h>
#include <Guid/CapsuleVendor.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/ResetSystemLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Library/MemoryAllocationLib.h>

Go to the source code of this file.

Data Structures
struct	RESET_NOTIFY_ENTRY
struct	RESET_NOTIFICATION_INSTANCE

Macros
#define	MAX_RESET_NOTIFY_DEPTH   10
#define	RESET_NOTIFY_ENTRY_SIGNATURE   SIGNATURE_32('r', 's', 't', 'n')
#define	RESET_NOTIFY_ENTRY_FROM_LINK(a)   CR (a, RESET_NOTIFY_ENTRY, Link, RESET_NOTIFY_ENTRY_SIGNATURE)
#define	RESET_NOTIFICATION_INSTANCE_SIGNATURE   SIGNATURE_32('r', 's', 't', 'i')
#define	RESET_NOTIFICATION_INSTANCE_FROM_THIS(a)    CR (a, RESET_NOTIFICATION_INSTANCE, ResetNotification, RESET_NOTIFICATION_INSTANCE_SIGNATURE)

Functions
EFI_STATUS EFIAPI	InitializeResetSystem (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
VOID EFIAPI	RuntimeServiceResetSystem (IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN VOID *ResetData OPTIONAL)

Detailed Description

Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ResetSystem.h.

Macro Definition Documentation

MAX_RESET_NOTIFY_DEPTH

#define MAX_RESET_NOTIFY_DEPTH   10

Definition at line 34 of file ResetSystem.h.

RESET_NOTIFICATION_INSTANCE_FROM_THIS

#define RESET_NOTIFICATION_INSTANCE_FROM_THIS

(

a

)

CR (a, RESET_NOTIFICATION_INSTANCE, ResetNotification, RESET_NOTIFICATION_INSTANCE_SIGNATURE)

Definition at line 50 of file ResetSystem.h.

RESET_NOTIFICATION_INSTANCE_SIGNATURE

#define RESET_NOTIFICATION_INSTANCE_SIGNATURE   SIGNATURE_32('r', 's', 't', 'i')

Definition at line 49 of file ResetSystem.h.

RESET_NOTIFY_ENTRY_FROM_LINK

#define RESET_NOTIFY_ENTRY_FROM_LINK

(

a

)

CR (a, RESET_NOTIFY_ENTRY, Link, RESET_NOTIFY_ENTRY_SIGNATURE)

Definition at line 42 of file ResetSystem.h.

RESET_NOTIFY_ENTRY_SIGNATURE

#define RESET_NOTIFY_ENTRY_SIGNATURE   SIGNATURE_32('r', 's', 't', 'n')

Definition at line 41 of file ResetSystem.h.

Function Documentation

InitializeResetSystem()

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

The driver's entry point.

It initializes the Reset Architectural Protocol.

Parameters

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

Return values

EFI_SUCCESS	The entry point is executed successfully.
other	Cannot install ResetArch protocol.

Definition at line 171 of file ResetSystem.c.

RuntimeServiceResetSystem()

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

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. For a ResetType of EfiResetPlatformSpecific the data buffer also starts with a Null-terminated string that is followed by an EFI_GUID that describes the specific type of reset to perform.

Definition at line 227 of file ResetSystem.c.