1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
/** @file
Reset Architectural and Reset Notification protocols implementation.
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "ResetSystem.h"
GLOBAL_REMOVE_IF_UNREFERENCED CHAR16 *mResetTypeStr[] = {
L"Cold", L"Warm", L"Shutdown", L"PlatformSpecific"
};
//
// The current ResetSystem() notification recursion depth
//
UINTN mResetNotifyDepth = 0;
/**
Register a notification function to be called when ResetSystem() is called.
The RegisterResetNotify() function registers a notification function that is called when
ResetSystem()is called and prior to completing the reset of the platform.
The registered functions must not perform a platform reset themselves. These
notifications are intended only for the notification of components which may need some
special-purpose maintenance prior to the platform resetting.
The list of registered reset notification functions are processed if ResetSystem()is called
before ExitBootServices(). The list of registered reset notification functions is ignored if
ResetSystem()is called after ExitBootServices().
@param[in] This A pointer to the EFI_RESET_NOTIFICATION_PROTOCOL instance.
@param[in] ResetFunction Points to the function to be called when a ResetSystem() is executed.
@retval EFI_SUCCESS The reset notification function was successfully registered.
@retval EFI_INVALID_PARAMETER ResetFunction is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to register the reset notification function.
@retval EFI_ALREADY_STARTED The reset notification function specified by ResetFunction has already been registered.
**/
EFI_STATUS
EFIAPI
RegisterResetNotify (
IN EFI_RESET_NOTIFICATION_PROTOCOL *This,
IN EFI_RESET_SYSTEM ResetFunction
)
{
RESET_NOTIFICATION_INSTANCE *Instance;
LIST_ENTRY *Link;
RESET_NOTIFY_ENTRY *Entry;
if (ResetFunction == NULL) {
return EFI_INVALID_PARAMETER;
}
Instance = RESET_NOTIFICATION_INSTANCE_FROM_THIS (This);
for ( Link = GetFirstNode (&Instance->ResetNotifies)
; !IsNull (&Instance->ResetNotifies, Link)
; Link = GetNextNode (&Instance->ResetNotifies, Link)
) {
Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);
if (Entry->ResetNotify == ResetFunction) {
return EFI_ALREADY_STARTED;
}
}
ASSERT (IsNull (&Instance->ResetNotifies, Link));
Entry = AllocatePool (sizeof (*Entry));
if (Entry == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Entry->Signature = RESET_NOTIFY_ENTRY_SIGNATURE;
Entry->ResetNotify = ResetFunction;
InsertTailList (&Instance->ResetNotifies, &Entry->Link);
return EFI_SUCCESS;
}
/**
Unregister a notification function.
The UnregisterResetNotify() function removes the previously registered
notification using RegisterResetNotify().
@param[in] This A pointer to the EFI_RESET_NOTIFICATION_PROTOCOL instance.
@param[in] ResetFunction The pointer to the ResetFunction being unregistered.
@retval EFI_SUCCESS The reset notification function was unregistered.
@retval EFI_INVALID_PARAMETER ResetFunction is NULL.
@retval EFI_INVALID_PARAMETER The reset notification function specified by ResetFunction was not previously
registered using RegisterResetNotify().
**/
EFI_STATUS
EFIAPI
UnregisterResetNotify (
IN EFI_RESET_NOTIFICATION_PROTOCOL *This,
IN EFI_RESET_SYSTEM ResetFunction
)
{
RESET_NOTIFICATION_INSTANCE *Instance;
LIST_ENTRY *Link;
RESET_NOTIFY_ENTRY *Entry;
if (ResetFunction == NULL) {
return EFI_INVALID_PARAMETER;
}
Instance = RESET_NOTIFICATION_INSTANCE_FROM_THIS (This);
for ( Link = GetFirstNode (&Instance->ResetNotifies)
; !IsNull (&Instance->ResetNotifies, Link)
; Link = GetNextNode (&Instance->ResetNotifies, Link)
) {
Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);
if (Entry->ResetNotify == ResetFunction) {
RemoveEntryList (&Entry->Link);
FreePool (Entry);
return EFI_SUCCESS;
}
}
return EFI_INVALID_PARAMETER;
}
RESET_NOTIFICATION_INSTANCE mResetNotification = {
RESET_NOTIFICATION_INSTANCE_SIGNATURE,
{
RegisterResetNotify,
UnregisterResetNotify
},
INITIALIZE_LIST_HEAD_VARIABLE (mResetNotification.ResetNotifies)
};
RESET_NOTIFICATION_INSTANCE mPlatformSpecificResetFilter = {
RESET_NOTIFICATION_INSTANCE_SIGNATURE,
{
RegisterResetNotify,
UnregisterResetNotify
},
INITIALIZE_LIST_HEAD_VARIABLE (mPlatformSpecificResetFilter.ResetNotifies)
};
RESET_NOTIFICATION_INSTANCE mPlatformSpecificResetHandler = {
RESET_NOTIFICATION_INSTANCE_SIGNATURE,
{
RegisterResetNotify,
UnregisterResetNotify
},
INITIALIZE_LIST_HEAD_VARIABLE (mPlatformSpecificResetHandler.ResetNotifies)
};
/**
The driver's entry point.
It initializes the Reset Architectural Protocol.
@param[in] ImageHandle The firmware allocated handle for the EFI image.
@param[in] SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The entry point is executed successfully.
@retval other Cannot install ResetArch protocol.
**/
EFI_STATUS
EFIAPI
InitializeResetSystem (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
EFI_HANDLE Handle;
//
// Make sure the Reset Architectural Protocol is not already installed in the system
//
ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiResetArchProtocolGuid);
//
// Hook the runtime service table
//
gRT->ResetSystem = RuntimeServiceResetSystem;
//
// Now install the Reset RT AP on a new handle
//
Handle = NULL;
Status = gBS->InstallMultipleProtocolInterfaces (
&Handle,
&gEfiResetArchProtocolGuid, NULL,
&gEfiResetNotificationProtocolGuid, &mResetNotification.ResetNotification,
&gEdkiiPlatformSpecificResetFilterProtocolGuid, &mPlatformSpecificResetFilter.ResetNotification,
&gEdkiiPlatformSpecificResetHandlerProtocolGuid, &mPlatformSpecificResetHandler.ResetNotification,
NULL
);
ASSERT_EFI_ERROR (Status);
return Status;
}
/**
Resets the entire platform.
@param[in] ResetType The type of reset to perform.
@param[in] ResetStatus The status code for the reset.
@param[in] DataSize The size, in bytes, of ResetData.
@param[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. ResetData is only
valid if ResetStatus is something other than EFI_SUCCESS
unless the ResetType is EfiResetPlatformSpecific
where a minimum amount of ResetData is always required.
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.
**/
VOID
EFIAPI
RuntimeServiceResetSystem (
IN EFI_RESET_TYPE ResetType,
IN EFI_STATUS ResetStatus,
IN UINTN DataSize,
IN VOID *ResetData OPTIONAL
)
{
LIST_ENTRY *Link;
RESET_NOTIFY_ENTRY *Entry;
//
// Only do REPORT_STATUS_CODE() on first call to RuntimeServiceResetSystem()
//
if (mResetNotifyDepth == 0) {
//
// Indicate reset system runtime service is called.
//
REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_EFI_RUNTIME_SERVICE | EFI_SW_RS_PC_RESET_SYSTEM));
}
mResetNotifyDepth++;
DEBUG ((
DEBUG_INFO, "DXE ResetSystem2: ResetType %s, Call Depth = %d.\n",
mResetTypeStr[ResetType], mResetNotifyDepth
));
if (mResetNotifyDepth <= MAX_RESET_NOTIFY_DEPTH) {
if (!EfiAtRuntime ()) {
//
// Call reset notification functions registered through the
// EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PROTOCOL.
//
for ( Link = GetFirstNode (&mPlatformSpecificResetFilter.ResetNotifies)
; !IsNull (&mPlatformSpecificResetFilter.ResetNotifies, Link)
; Link = GetNextNode (&mPlatformSpecificResetFilter.ResetNotifies, Link)
) {
Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);
Entry->ResetNotify (ResetType, ResetStatus, DataSize, ResetData);
}
//
// Call reset notification functions registered through the
// EFI_RESET_NOTIFICATION_PROTOCOL.
//
for ( Link = GetFirstNode (&mResetNotification.ResetNotifies)
; !IsNull (&mResetNotification.ResetNotifies, Link)
; Link = GetNextNode (&mResetNotification.ResetNotifies, Link)
) {
Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);
Entry->ResetNotify (ResetType, ResetStatus, DataSize, ResetData);
}
//
// call reset notification functions registered through the
// EDKII_PLATFORM_SPECIFIC_RESET_HANDLER_PROTOCOL.
//
for ( Link = GetFirstNode (&mPlatformSpecificResetHandler.ResetNotifies)
; !IsNull (&mPlatformSpecificResetHandler.ResetNotifies, Link)
; Link = GetNextNode (&mPlatformSpecificResetHandler.ResetNotifies, Link)
) {
Entry = RESET_NOTIFY_ENTRY_FROM_LINK (Link);
Entry->ResetNotify (ResetType, ResetStatus, DataSize, ResetData);
}
}
} else {
ASSERT (ResetType < ARRAY_SIZE (mResetTypeStr));
DEBUG ((DEBUG_ERROR, "DXE ResetSystem2: Maximum reset call depth is met. Use the current reset type: %s!\n", mResetTypeStr[ResetType]));
}
switch (ResetType) {
case EfiResetWarm:
ResetWarm ();
break;
case EfiResetCold:
ResetCold ();
break;
case EfiResetShutdown:
ResetShutdown ();
return ;
case EfiResetPlatformSpecific:
ResetPlatformSpecific (DataSize, ResetData);
return;
default:
return ;
}
//
// Given we should have reset getting here would be bad
//
ASSERT (FALSE);
}
|