MdeModulePkg/ResetSystemRuntimeDxe: Add platform filter and handler
[mirror_edk2.git] / MdeModulePkg / Universal / ResetSystemRuntimeDxe / ResetSystem.h
1 /** @file
2
3 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
4
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #ifndef _RESET_SYSTEM_H_
16 #define _RESET_SYSTEM_H_
17
18
19 #include <PiDxe.h>
20
21 #include <Protocol/Reset.h>
22 #include <Protocol/ResetNotification.h>
23 #include <Protocol/PlatformSpecificResetFilter.h>
24 #include <Protocol/PlatformSpecificResetHandler.h>
25 #include <Guid/CapsuleVendor.h>
26
27 #include <Library/BaseLib.h>
28 #include <Library/DebugLib.h>
29 #include <Library/UefiLib.h>
30 #include <Library/IoLib.h>
31 #include <Library/UefiDriverEntryPoint.h>
32 #include <Library/UefiBootServicesTableLib.h>
33 #include <Library/UefiRuntimeLib.h>
34 #include <Library/UefiRuntimeServicesTableLib.h>
35 #include <Library/ResetSystemLib.h>
36 #include <Library/ReportStatusCodeLib.h>
37 #include <Library/MemoryAllocationLib.h>
38
39 //
40 // The maximum recurstion depth to ResetSystem() by reset notification handlers
41 //
42 #define MAX_RESET_NOTIFY_DEPTH 10
43
44 typedef struct {
45 UINT32 Signature;
46 LIST_ENTRY Link;
47 EFI_RESET_SYSTEM ResetNotify;
48 } RESET_NOTIFY_ENTRY;
49 #define RESET_NOTIFY_ENTRY_SIGNATURE SIGNATURE_32('r', 's', 't', 'n')
50 #define RESET_NOTIFY_ENTRY_FROM_LINK(a) CR (a, RESET_NOTIFY_ENTRY, Link, RESET_NOTIFY_ENTRY_SIGNATURE)
51
52 typedef struct {
53 UINT32 Signature;
54 EFI_RESET_NOTIFICATION_PROTOCOL ResetNotification;
55 LIST_ENTRY ResetNotifies;
56 } RESET_NOTIFICATION_INSTANCE;
57 #define RESET_NOTIFICATION_INSTANCE_SIGNATURE SIGNATURE_32('r', 's', 't', 'i')
58 #define RESET_NOTIFICATION_INSTANCE_FROM_THIS(a) \
59 CR (a, RESET_NOTIFICATION_INSTANCE, ResetNotification, RESET_NOTIFICATION_INSTANCE_SIGNATURE)
60
61 /**
62 The driver's entry point.
63
64 It initializes the Reset Architectural Protocol.
65
66 @param[in] ImageHandle The firmware allocated handle for the EFI image.
67 @param[in] SystemTable A pointer to the EFI System Table.
68
69 @retval EFI_SUCCESS The entry point is executed successfully.
70 @retval other Cannot install ResetArch protocol.
71
72 **/
73 EFI_STATUS
74 EFIAPI
75 InitializeResetSystem (
76 IN EFI_HANDLE ImageHandle,
77 IN EFI_SYSTEM_TABLE *SystemTable
78 );
79
80 /**
81 Resets the entire platform.
82
83 @param[in] ResetType The type of reset to perform.
84 @param[in] ResetStatus The status code for the reset.
85 @param[in] DataSize The size, in bytes, of ResetData.
86 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
87 EfiResetShutdown the data buffer starts with a Null-terminated
88 string, optionally followed by additional binary data.
89 The string is a description that the caller may use to further
90 indicate the reason for the system reset. ResetData is only
91 valid if ResetStatus is something other than EFI_SUCCESS
92 unless the ResetType is EfiResetPlatformSpecific
93 where a minimum amount of ResetData is always required.
94 For a ResetType of EfiResetPlatformSpecific the data buffer
95 also starts with a Null-terminated string that is followed
96 by an EFI_GUID that describes the specific type of reset to perform.
97
98 **/
99 VOID
100 EFIAPI
101 ResetSystem (
102 IN EFI_RESET_TYPE ResetType,
103 IN EFI_STATUS ResetStatus,
104 IN UINTN DataSize,
105 IN VOID *ResetData OPTIONAL
106 );
107
108 #endif