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
|
/** @file
PEI Module to test EfiMpServiceProtocol.
Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <PiDxe.h>
#include <Library/UefiBootServicesTableLib.h>
#include "EfiMpServicesUnitTestCommom.h"
#define UNIT_TEST_NAME "EfiMpServiceProtocol Unit Test"
#define UNIT_TEST_VERSION "0.1"
/**
Get EFI_MP_SERVICES_PROTOCOL pointer.
@param[out] MpServices Pointer to the buffer where EFI_MP_SERVICES_PROTOCOL is stored
@retval EFI_SUCCESS EFI_MP_SERVICES_PROTOCOL interface is returned
@retval EFI_NOT_FOUND EFI_MP_SERVICES_PROTOCOL interface is not found
**/
EFI_STATUS
MpServicesUnitTestGetMpServices (
OUT MP_SERVICES *MpServices
)
{
return gBS->LocateProtocol (&gEfiMpServiceProtocolGuid, NULL, (VOID **)&MpServices->Protocol);
}
/**
Retrieve the number of logical processor in the platform and the number of those logical processors that
are enabled on this boot.
@param[in] MpServices MP_SERVICES structure.
@param[out] NumberOfProcessors Pointer to the total number of logical processors in the system, including
the BSP and disabled APs.
@param[out] NumberOfEnabledProcessors Pointer to the number of processors in the system that are enabled.
@retval EFI_SUCCESS Retrieve the number of logical processor successfully
@retval Others Retrieve the number of logical processor unsuccessfully
**/
EFI_STATUS
MpServicesUnitTestGetNumberOfProcessors (
IN MP_SERVICES MpServices,
OUT UINTN *NumberOfProcessors,
OUT UINTN *NumberOfEnabledProcessors
)
{
return MpServices.Protocol->GetNumberOfProcessors (MpServices.Protocol, NumberOfProcessors, NumberOfEnabledProcessors);
}
/**
Get detailed information on the requested logical processor.
@param[in] MpServices MP_SERVICES structure.
@param[in] ProcessorNumber The handle number of the processor.
@param[out] ProcessorInfoBuffer Pointer to the buffer where the processor information is stored.
@retval EFI_SUCCESS Get information on the requested logical processor successfully
@retval Others Get information on the requested logical processor unsuccessfully
**/
EFI_STATUS
MpServicesUnitTestGetProcessorInfo (
IN MP_SERVICES MpServices,
IN UINTN ProcessorNumber,
OUT EFI_PROCESSOR_INFORMATION *ProcessorInfoBuffer
)
{
return MpServices.Protocol->GetProcessorInfo (MpServices.Protocol, ProcessorNumber, ProcessorInfoBuffer);
}
/**
Execute a caller provided function on all enabled APs.
@param[in] MpServices MP_SERVICES structure.
@param[in] Procedure Pointer to the function to be run on enabled APs of the system.
@param[in] SingleThread If TRUE, then all the enabled APs execute the function specified by Procedure
one by one, in ascending order of processor handle number.
If FALSE, then all the enabled APs execute the function specified by Procedure
simultaneously.
@param[in] TimeoutInMicroSeconds Indicates the time limit in microseconds for APs to return from Procedure,
for blocking mode only. Zero means infinity.
@param[in] ProcedureArgument The parameter passed into Procedure for all APs.
@retval EFI_SUCCESS Execute a caller provided function on all enabled APs successfully
@retval Others Execute a caller provided function on all enabled APs unsuccessfully
**/
EFI_STATUS
MpServicesUnitTestStartupAllAPs (
IN MP_SERVICES MpServices,
IN EFI_AP_PROCEDURE Procedure,
IN BOOLEAN SingleThread,
IN UINTN TimeoutInMicroSeconds,
IN VOID *ProcedureArgument
)
{
return MpServices.Protocol->StartupAllAPs (MpServices.Protocol, Procedure, SingleThread, NULL, TimeoutInMicroSeconds, ProcedureArgument, NULL);
}
/**
Caller gets one enabled AP to execute a caller-provided function.
@param[in] MpServices MP_SERVICES structure.
@param[in] Procedure Pointer to the function to be run on enabled APs of the system.
@param[in] ProcessorNumber The handle number of the AP.
@param[in] TimeoutInMicroSeconds Indicates the time limit in microseconds for APs to return from Procedure,
for blocking mode only. Zero means infinity.
@param[in] ProcedureArgument The parameter passed into Procedure for all APs.
@retval EFI_SUCCESS Caller gets one enabled AP to execute a caller-provided function successfully
@retval Others Caller gets one enabled AP to execute a caller-provided function unsuccessfully
**/
EFI_STATUS
MpServicesUnitTestStartupThisAP (
IN MP_SERVICES MpServices,
IN EFI_AP_PROCEDURE Procedure,
IN UINTN ProcessorNumber,
IN UINTN TimeoutInMicroSeconds,
IN VOID *ProcedureArgument
)
{
return MpServices.Protocol->StartupThisAP (MpServices.Protocol, Procedure, ProcessorNumber, NULL, TimeoutInMicroSeconds, ProcedureArgument, NULL);
}
/**
Switch the requested AP to be the BSP from that point onward.
@param[in] MpServices MP_SERVICES structure.
@param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
@param[in] EnableOldBSP If TRUE, the old BSP will be listed as an enabled AP. Otherwise, it will be disabled.
@retval EFI_SUCCESS Switch the requested AP to be the BSP successfully
@retval Others Switch the requested AP to be the BSP unsuccessfully
**/
EFI_STATUS
MpServicesUnitTestSwitchBSP (
IN MP_SERVICES MpServices,
IN UINTN ProcessorNumber,
IN BOOLEAN EnableOldBSP
)
{
return MpServices.Protocol->SwitchBSP (MpServices.Protocol, ProcessorNumber, EnableOldBSP);
}
/**
Caller enables or disables an AP from this point onward.
@param[in] MpServices MP_SERVICES structure.
@param[in] ProcessorNumber The handle number of the AP.
@param[in] EnableAP Specifies the new state for the processor for enabled, FALSE for disabled.
@param[in] HealthFlag If not NULL, a pointer to a value that specifies the new health status of the AP.
@retval EFI_SUCCESS Caller enables or disables an AP successfully.
@retval Others Caller enables or disables an AP unsuccessfully.
**/
EFI_STATUS
MpServicesUnitTestEnableDisableAP (
IN MP_SERVICES MpServices,
IN UINTN ProcessorNumber,
IN BOOLEAN EnableAP,
IN UINT32 *HealthFlag
)
{
return MpServices.Protocol->EnableDisableAP (MpServices.Protocol, ProcessorNumber, EnableAP, HealthFlag);
}
/**
Get the handle number for the calling processor.
@param[in] MpServices MP_SERVICES structure.
@param[out] ProcessorNumber The handle number for the calling processor.
@retval EFI_SUCCESS Get the handle number for the calling processor successfully.
@retval Others Get the handle number for the calling processor unsuccessfully.
**/
EFI_STATUS
MpServicesUnitTestWhoAmI (
IN MP_SERVICES MpServices,
OUT UINTN *ProcessorNumber
)
{
return MpServices.Protocol->WhoAmI (MpServices.Protocol, ProcessorNumber);
}
/**
Standard DXE driver or UEFI application entry point for unit test execution from DXE or UEFI Shell.
Initialize the unit test framework, suite, and unit tests for the EfiMpServiceProtocol and run the unit test.
@param[in] ImageHandle The firmware allocated handle for the EFI image.
@param[in] SystemTable A pointer to the EFI System Table.
**/
EFI_STATUS
EFIAPI
DxeEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
UNIT_TEST_FRAMEWORK_HANDLE Framework;
MP_SERVICE_UT_CONTEXT Context;
Framework = NULL;
Context.MpServices.Ppi = NULL;
Context.CommonBuffer = NULL;
Context.DisabledApNumber = NULL;
DEBUG ((DEBUG_INFO, "%a v%a\n", UNIT_TEST_NAME, UNIT_TEST_VERSION));
//
// Start setting up the test framework for running the tests.
//
Status = InitUnitTestFramework (&Framework, UNIT_TEST_NAME, gEfiCallerBaseName, UNIT_TEST_VERSION);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "Failed in InitUnitTestFramework. Status = %r\n", Status));
goto EXIT;
}
//
// Create test suite and unit tests for both EdkiiPeiMpServices2Ppi and EfiMpServiceProtocol.
//
Status = AddCommonTestCase (Framework, &Context);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "Failed in AddCommonTestCase. Status = %r\n", Status));
goto EXIT;
}
//
// Execute the tests.
//
Status = RunAllTestSuites (Framework);
EXIT:
if (Framework != NULL) {
FreeUnitTestFramework (Framework);
}
return Status;
}
|
