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
|
/** @file
The common code of EDKII Redfish Configuration Handler driver.
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "RedfishConfigHandlerCommon.h"
REDFISH_CONFIG_DRIVER_DATA gRedfishConfigData; // Only one Redfish service supported
// on platform for the BIOS
// Redfish configuration.
EFI_EVENT gEndOfDxeEvent = NULL;
EFI_EVENT gExitBootServiceEvent = NULL;
EDKII_REDFISH_CREDENTIAL_PROTOCOL *gCredential = NULL;
/**
Callback function executed when the EndOfDxe event group is signaled.
@param[in] Event Event whose notification function is being invoked.
@param[out] Context Pointer to the Context buffer.
**/
VOID
EFIAPI
RedfishConfigOnEndOfDxe (
IN EFI_EVENT Event,
OUT VOID *Context
)
{
EFI_STATUS Status;
Status = gCredential->StopService (gCredential, ServiceStopTypeSecureBootDisabled);
if (EFI_ERROR (Status) && (Status != EFI_UNSUPPORTED)) {
DEBUG ((DEBUG_ERROR, "Redfish credential protocol failed to stop service on EndOfDxe: %r", Status));
}
//
// Close event, so it will not be invoked again.
//
gBS->CloseEvent (gEndOfDxeEvent);
gEndOfDxeEvent = NULL;
}
/**
Callback function executed when the ExitBootService event group is signaled.
@param[in] Event Event whose notification function is being invoked.
@param[out] Context Pointer to the Context buffer
**/
VOID
EFIAPI
RedfishConfigOnExitBootService (
IN EFI_EVENT Event,
OUT VOID *Context
)
{
EFI_STATUS Status;
Status = gCredential->StopService (gCredential, ServiceStopTypeExitBootService);
if (EFI_ERROR (Status) && (Status != EFI_UNSUPPORTED)) {
DEBUG ((DEBUG_ERROR, "Redfish credential protocol failed to stop service on ExitBootService: %r", Status));
}
}
/**
Unloads an image.
@param[in] ImageHandle Handle that identifies the image to be unloaded.
@retval EFI_SUCCESS The image has been unloaded.
**/
EFI_STATUS
RedfishConfigDriverCommonUnload (
IN EFI_HANDLE ImageHandle
)
{
if (gEndOfDxeEvent != NULL) {
gBS->CloseEvent (gEndOfDxeEvent);
gEndOfDxeEvent = NULL;
}
if (gExitBootServiceEvent != NULL) {
gBS->CloseEvent (gExitBootServiceEvent);
gExitBootServiceEvent = NULL;
}
if (gRedfishConfigData.Event != NULL) {
gBS->CloseEvent (gRedfishConfigData.Event);
gRedfishConfigData.Event = NULL;
}
return EFI_SUCCESS;
}
/**
This is the common code for Redfish configuration UEFI and DXE driver
initialization.
@param[in] ImageHandle The firmware allocated handle for the UEFI image.
@param[in] SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The operation completed successfully.
@retval Others An unexpected error occurred.
**/
EFI_STATUS
RedfishConfigCommonInit (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
//
// Locate Redfish Credential Protocol to get credential for
// accessing to Redfish service.
//
Status = gBS->LocateProtocol (&gEdkIIRedfishCredentialProtocolGuid, NULL, (VOID **)&gCredential);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "%a: No Redfish Credential Protocol is installed on system.", __func__));
return Status;
}
//
// Create EndOfDxe Event.
//
Status = gBS->CreateEventEx (
EVT_NOTIFY_SIGNAL,
TPL_CALLBACK,
RedfishConfigOnEndOfDxe,
NULL,
&gEfiEndOfDxeEventGroupGuid,
&gEndOfDxeEvent
);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "%a: Fail to register End Of DXE event.", __func__));
return Status;
}
//
// Create Exit Boot Service event.
//
Status = gBS->CreateEventEx (
EVT_NOTIFY_SIGNAL,
TPL_CALLBACK,
RedfishConfigOnExitBootService,
NULL,
&gEfiEventExitBootServicesGuid,
&gExitBootServiceEvent
);
if (EFI_ERROR (Status)) {
gBS->CloseEvent (gEndOfDxeEvent);
gEndOfDxeEvent = NULL;
DEBUG ((DEBUG_ERROR, "%a: Fail to register Exit Boot Service event.", __func__));
return Status;
}
return EFI_SUCCESS;
}
/**
This is the common code to stop EDK2 Redfish feature driver.
@retval EFI_SUCCESS All EDK2 Redfish feature drivers are
stopped.
@retval Others An unexpected error occurred.
**/
EFI_STATUS
RedfishConfigCommonStop (
VOID
)
{
EFI_STATUS Status;
EFI_HANDLE *HandleBuffer;
UINTN NumberOfHandles;
UINTN Index;
EDKII_REDFISH_CONFIG_HANDLER_PROTOCOL *ConfigHandler;
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEdkIIRedfishConfigHandlerProtocolGuid,
NULL,
&NumberOfHandles,
&HandleBuffer
);
if (EFI_ERROR (Status) && (Status != EFI_NOT_FOUND)) {
return Status;
}
Status = EFI_SUCCESS;
for (Index = 0; Index < NumberOfHandles; Index++) {
Status = gBS->HandleProtocol (
HandleBuffer[Index],
&gEdkIIRedfishConfigHandlerProtocolGuid,
(VOID **)&ConfigHandler
);
ASSERT_EFI_ERROR (Status);
Status = ConfigHandler->Stop (ConfigHandler);
if (EFI_ERROR (Status) && (Status != EFI_UNSUPPORTED)) {
DEBUG ((DEBUG_ERROR, "ERROR: Failed to stop Redfish config handler %p.\n", ConfigHandler));
break;
}
}
return Status;
}
/**
Callback function executed when a Redfish Config Handler Protocol is installed
by EDK2 Redfish Feature Drivers.
**/
VOID
RedfishConfigHandlerInitialization (
VOID
)
{
EFI_STATUS Status;
EFI_HANDLE *HandleBuffer;
UINTN NumberOfHandles;
EDKII_REDFISH_CONFIG_HANDLER_PROTOCOL *ConfigHandler;
UINTN Index;
UINT32 *Id;
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEdkIIRedfishConfigHandlerProtocolGuid,
NULL,
&NumberOfHandles,
&HandleBuffer
);
if (EFI_ERROR (Status)) {
return;
}
for (Index = 0; Index < NumberOfHandles; Index++) {
Status = gBS->HandleProtocol (
HandleBuffer[Index],
&gEfiCallerIdGuid,
(VOID **)&Id
);
if (!EFI_ERROR (Status)) {
continue;
}
Status = gBS->HandleProtocol (
HandleBuffer[Index],
&gEdkIIRedfishConfigHandlerProtocolGuid,
(VOID **)&ConfigHandler
);
ASSERT_EFI_ERROR (Status);
Status = ConfigHandler->Init (ConfigHandler, &gRedfishConfigData.RedfishServiceInfo);
if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {
DEBUG ((DEBUG_ERROR, "ERROR: Failed to init Redfish config handler %p.\n", ConfigHandler));
continue;
}
//
// Install caller ID to indicate Redfish Configure Handler is initialized.
//
Status = gBS->InstallProtocolInterface (
&HandleBuffer[Index],
&gEfiCallerIdGuid,
EFI_NATIVE_INTERFACE,
(VOID *)&gRedfishConfigData.CallerId
);
ASSERT_EFI_ERROR (Status);
}
}
|
