MdePkg MpServices: Update return status to follow spec.
[mirror_edk2.git] / MdePkg / Include / Protocol / MpService.h
CommitLineData
82336c28 1/** @file\r
8f3446d8 2 When installed, the MP Services Protocol produces a collection of services\r
82336c28 3 that are needed for MP management.\r
4\r
5 The MP Services Protocol provides a generalized way of performing following tasks:\r
6 - Retrieving information of multi-processor environment and MP-related status of\r
7 specific processors.\r
8 - Dispatching user-provided function to APs.\r
9 - Maintain MP-related processor status.\r
10\r
11 The MP Services Protocol must be produced on any system with more than one logical\r
12 processor.\r
13\r
14 The Protocol is available only during boot time.\r
15\r
16 MP Services Protocol is hardware-independent. Most of the logic of this protocol\r
8f3446d8
JF
17 is architecturally neutral. It abstracts the multi-processor environment and\r
18 status of processors, and provides interfaces to retrieve information, maintain,\r
82336c28 19 and dispatch.\r
20\r
8f3446d8 21 MP Services Protocol may be consumed by ACPI module. The ACPI module may use this\r
82336c28 22 protocol to retrieve data that are needed for an MP platform and report them to OS.\r
8f3446d8 23 MP Services Protocol may also be used to program and configure processors, such\r
82336c28 24 as MTRR synchronization for memory space attributes setting in DXE Services.\r
8f3446d8
JF
25 MP Services Protocol may be used by non-CPU DXE drivers to speed up platform boot\r
26 by taking advantage of the processing capabilities of the APs, for example, using\r
82336c28 27 APs to help test system memory in parallel with other device initialization.\r
28 Diagnostics applications may also use this protocol for multi-processor.\r
29\r
da71a637 30Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
8f3446d8
JF
31This program and the accompanying materials are licensed and made available under\r
32the terms and conditions of the BSD License that accompanies this distribution.\r
af2dc6a7 33The full text of the license may be found at\r
8f3446d8
JF
34http://opensource.org/licenses/bsd-license.php.\r
35\r
36THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
af2dc6a7 37WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
82336c28 38\r
39 @par Revision Reference:\r
8f3446d8 40 This Protocol is defined in the UEFI Platform Initialization Specification 1.2,\r
82336c28 41 Volume 2:Driver Execution Environment Core Interface.\r
8f3446d8 42\r
82336c28 43**/\r
44\r
45#ifndef _MP_SERVICE_PROTOCOL_H_\r
46#define _MP_SERVICE_PROTOCOL_H_\r
47\r
48///\r
af2dc6a7 49/// Global ID for the EFI_MP_SERVICES_PROTOCOL.\r
82336c28 50///\r
51#define EFI_MP_SERVICES_PROTOCOL_GUID \\r
52 { \\r
53 0x3fdda605, 0xa76e, 0x4f46, {0xad, 0x29, 0x12, 0xf4, 0x53, 0x1b, 0x3d, 0x08} \\r
54 }\r
55\r
56///\r
af2dc6a7 57/// Forward declaration for the EFI_MP_SERVICES_PROTOCOL.\r
82336c28 58///\r
59typedef struct _EFI_MP_SERVICES_PROTOCOL EFI_MP_SERVICES_PROTOCOL;\r
60\r
61///\r
62/// Terminator for a list of failed CPUs returned by StartAllAPs().\r
63///\r
64#define END_OF_CPU_LIST 0xffffffff\r
65\r
66///\r
8f3446d8 67/// This bit is used in the StatusFlag field of EFI_PROCESSOR_INFORMATION and\r
82336c28 68/// indicates whether the processor is playing the role of BSP. If the bit is 1,\r
69/// then the processor is BSP. Otherwise, it is AP.\r
70///\r
71#define PROCESSOR_AS_BSP_BIT 0x00000001\r
72\r
73///\r
8f3446d8
JF
74/// This bit is used in the StatusFlag field of EFI_PROCESSOR_INFORMATION and\r
75/// indicates whether the processor is enabled. If the bit is 1, then the\r
82336c28 76/// processor is enabled. Otherwise, it is disabled.\r
77///\r
78#define PROCESSOR_ENABLED_BIT 0x00000002\r
79\r
80///\r
8f3446d8
JF
81/// This bit is used in the StatusFlag field of EFI_PROCESSOR_INFORMATION and\r
82/// indicates whether the processor is healthy. If the bit is 1, then the\r
82336c28 83/// processor is healthy. Otherwise, some fault has been detected for the processor.\r
84///\r
85#define PROCESSOR_HEALTH_STATUS_BIT 0x00000004\r
86\r
87///\r
88/// Structure that describes the pyhiscal location of a logical CPU.\r
89///\r
90typedef struct {\r
91 ///\r
92 /// Zero-based physical package number that identifies the cartridge of the processor.\r
93 ///\r
94 UINT32 Package;\r
95 ///\r
96 /// Zero-based physical core number within package of the processor.\r
97 ///\r
98 UINT32 Core;\r
99 ///\r
100 /// Zero-based logical thread number within core of the processor.\r
101 ///\r
102 UINT32 Thread;\r
103} EFI_CPU_PHYSICAL_LOCATION;\r
104\r
105///\r
106/// Structure that describes information about a logical CPU.\r
107///\r
108typedef struct {\r
109 ///\r
8f3446d8
JF
110 /// The unique processor ID determined by system hardware. For IA32 and X64,\r
111 /// the processor ID is the same as the Local APIC ID. Only the lower 8 bits\r
82336c28 112 /// are used, and higher bits are reserved. For IPF, the lower 16 bits contains\r
113 /// id/eid, and higher bits are reserved.\r
114 ///\r
8f3446d8
JF
115 UINT64 ProcessorId;\r
116 ///\r
117 /// Flags indicating if the processor is BSP or AP, if the processor is enabled\r
118 /// or disabled, and if the processor is healthy. Bits 3..31 are reserved and\r
119 /// must be 0.\r
82336c28 120 ///\r
82336c28 121 /// <pre>\r
122 /// BSP ENABLED HEALTH Description\r
123 /// === ======= ====== ===================================================\r
124 /// 0 0 0 Unhealthy Disabled AP.\r
125 /// 0 0 1 Healthy Disabled AP.\r
126 /// 0 1 0 Unhealthy Enabled AP.\r
127 /// 0 1 1 Healthy Enabled AP.\r
128 /// 1 0 0 Invalid. The BSP can never be in the disabled state.\r
129 /// 1 0 1 Invalid. The BSP can never be in the disabled state.\r
130 /// 1 1 0 Unhealthy Enabled BSP.\r
af2dc6a7 131 /// 1 1 1 Healthy Enabled BSP.\r
82336c28 132 /// </pre>\r
133 ///\r
134 UINT32 StatusFlag;\r
135 ///\r
136 /// The physical location of the processor, including the physical package number\r
8f3446d8 137 /// that identifies the cartridge, the physical core number within package, and\r
af2dc6a7 138 /// logical thread number within core.\r
82336c28 139 ///\r
140 EFI_CPU_PHYSICAL_LOCATION Location;\r
141} EFI_PROCESSOR_INFORMATION;\r
142\r
82336c28 143/**\r
144 This service retrieves the number of logical processor in the platform\r
145 and the number of those logical processors that are enabled on this boot.\r
146 This service may only be called from the BSP.\r
147\r
148 This function is used to retrieve the following information:\r
af2dc6a7 149 - The number of logical processors that are present in the system.\r
8f3446d8 150 - The number of enabled logical processors in the system at the instant\r
82336c28 151 this call is made.\r
152\r
8f3446d8
JF
153 Because MP Service Protocol provides services to enable and disable processors\r
154 dynamically, the number of enabled logical processors may vary during the\r
82336c28 155 course of a boot session.\r
8f3446d8
JF
156\r
157 If this service is called from an AP, then EFI_DEVICE_ERROR is returned.\r
158 If NumberOfProcessors or NumberOfEnabledProcessors is NULL, then\r
159 EFI_INVALID_PARAMETER is returned. Otherwise, the total number of processors\r
160 is returned in NumberOfProcessors, the number of currently enabled processor\r
82336c28 161 is returned in NumberOfEnabledProcessors, and EFI_SUCCESS is returned.\r
162\r
163 @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL\r
164 instance.\r
165 @param[out] NumberOfProcessors Pointer to the total number of logical\r
166 processors in the system, including the BSP\r
167 and disabled APs.\r
168 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical\r
169 processors that exist in system, including\r
170 the BSP.\r
171\r
8f3446d8 172 @retval EFI_SUCCESS The number of logical processors and enabled\r
82336c28 173 logical processors was retrieved.\r
174 @retval EFI_DEVICE_ERROR The calling processor is an AP.\r
af2dc6a7 175 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL.\r
176 @retval EFI_INVALID_PARAMETER NumberOfEnabledProcessors is NULL.\r
82336c28 177\r
178**/\r
179typedef\r
180EFI_STATUS\r
181(EFIAPI *EFI_MP_SERVICES_GET_NUMBER_OF_PROCESSORS)(\r
182 IN EFI_MP_SERVICES_PROTOCOL *This,\r
183 OUT UINTN *NumberOfProcessors,\r
184 OUT UINTN *NumberOfEnabledProcessors\r
185 );\r
186\r
187/**\r
188 Gets detailed MP-related information on the requested processor at the\r
189 instant this call is made. This service may only be called from the BSP.\r
190\r
8f3446d8 191 This service retrieves detailed MP-related information about any processor\r
82336c28 192 on the platform. Note the following:\r
193 - The processor information may change during the course of a boot session.\r
194 - The information presented here is entirely MP related.\r
8f3446d8 195\r
82336c28 196 Information regarding the number of caches and their sizes, frequency of operation,\r
8f3446d8 197 slot numbers is all considered platform-related information and is not provided\r
82336c28 198 by this service.\r
199\r
200 @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL\r
201 instance.\r
202 @param[in] ProcessorNumber The handle number of processor.\r
203 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for\r
204 the requested processor is deposited.\r
205\r
206 @retval EFI_SUCCESS Processor information was returned.\r
207 @retval EFI_DEVICE_ERROR The calling processor is an AP.\r
208 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.\r
209 @retval EFI_NOT_FOUND The processor with the handle specified by\r
210 ProcessorNumber does not exist in the platform.\r
211\r
212**/\r
213typedef\r
214EFI_STATUS\r
215(EFIAPI *EFI_MP_SERVICES_GET_PROCESSOR_INFO)(\r
216 IN EFI_MP_SERVICES_PROTOCOL *This,\r
217 IN UINTN ProcessorNumber,\r
b635c768 218 OUT EFI_PROCESSOR_INFORMATION *ProcessorInfoBuffer\r
82336c28 219 );\r
220\r
221/**\r
8f3446d8
JF
222 This service executes a caller provided function on all enabled APs. APs can\r
223 run either simultaneously or one at a time in sequence. This service supports\r
224 both blocking and non-blocking requests. The non-blocking requests use EFI\r
225 events so the BSP can detect when the APs have finished. This service may only\r
82336c28 226 be called from the BSP.\r
227\r
8f3446d8
JF
228 This function is used to dispatch all the enabled APs to the function specified\r
229 by Procedure. If any enabled AP is busy, then EFI_NOT_READY is returned\r
82336c28 230 immediately and Procedure is not started on any AP.\r
231\r
8f3446d8
JF
232 If SingleThread is TRUE, all the enabled APs execute the function specified by\r
233 Procedure one by one, in ascending order of processor handle number. Otherwise,\r
82336c28 234 all the enabled APs execute the function specified by Procedure simultaneously.\r
235\r
8f3446d8
JF
236 If WaitEvent is NULL, execution is in blocking mode. The BSP waits until all\r
237 APs finish or TimeoutInMicroSecs expires. Otherwise, execution is in non-blocking\r
238 mode, and the BSP returns from this service without waiting for APs. If a\r
239 non-blocking mode is requested after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT\r
82336c28 240 is signaled, then EFI_UNSUPPORTED must be returned.\r
241\r
8f3446d8
JF
242 If the timeout specified by TimeoutInMicroseconds expires before all APs return\r
243 from Procedure, then Procedure on the failed APs is terminated. All enabled APs\r
82336c28 244 are always available for further calls to EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r
8f3446d8
JF
245 and EFI_MP_SERVICES_PROTOCOL.StartupThisAP(). If FailedCpuList is not NULL, its\r
246 content points to the list of processor handle numbers in which Procedure was\r
82336c28 247 terminated.\r
248\r
8f3446d8
JF
249 Note: It is the responsibility of the consumer of the EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r
250 to make sure that the nature of the code that is executed on the BSP and the\r
251 dispatched APs is well controlled. The MP Services Protocol does not guarantee\r
252 that the Procedure function is MP-safe. Hence, the tasks that can be run in\r
253 parallel are limited to certain independent tasks and well-controlled exclusive\r
254 code. EFI services and protocols may not be called by APs unless otherwise\r
82336c28 255 specified.\r
256\r
8f3446d8 257 In blocking execution mode, BSP waits until all APs finish or\r
82336c28 258 TimeoutInMicroSeconds expires.\r
259\r
8f3446d8
JF
260 In non-blocking execution mode, BSP is freed to return to the caller and then\r
261 proceed to the next task without having to wait for APs. The following\r
82336c28 262 sequence needs to occur in a non-blocking execution mode:\r
263\r
8f3446d8
JF
264 -# The caller that intends to use this MP Services Protocol in non-blocking\r
265 mode creates WaitEvent by calling the EFI CreateEvent() service. The caller\r
266 invokes EFI_MP_SERVICES_PROTOCOL.StartupAllAPs(). If the parameter WaitEvent\r
267 is not NULL, then StartupAllAPs() executes in non-blocking mode. It requests\r
268 the function specified by Procedure to be started on all the enabled APs,\r
82336c28 269 and releases the BSP to continue with other tasks.\r
8f3446d8 270 -# The caller can use the CheckEvent() and WaitForEvent() services to check\r
82336c28 271 the state of the WaitEvent created in step 1.\r
8f3446d8
JF
272 -# When the APs complete their task or TimeoutInMicroSecondss expires, the MP\r
273 Service signals WaitEvent by calling the EFI SignalEvent() function. If\r
274 FailedCpuList is not NULL, its content is available when WaitEvent is\r
275 signaled. If all APs returned from Procedure prior to the timeout, then\r
276 FailedCpuList is set to NULL. If not all APs return from Procedure before\r
277 the timeout, then FailedCpuList is filled in with the list of the failed\r
278 APs. The buffer is allocated by MP Service Protocol using AllocatePool().\r
e8b9799c 279 It is the caller's responsibility to free the buffer with FreePool() service.\r
82336c28 280 -# This invocation of SignalEvent() function informs the caller that invoked\r
281 EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() that either all the APs completed\r
8f3446d8
JF
282 the specified task or a timeout occurred. The contents of FailedCpuList\r
283 can be examined to determine which APs did not complete the specified task\r
82336c28 284 prior to the timeout.\r
285\r
286 @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL\r
287 instance.\r
8f3446d8 288 @param[in] Procedure A pointer to the function to be run on\r
82336c28 289 enabled APs of the system. See type\r
290 EFI_AP_PROCEDURE.\r
8f3446d8
JF
291 @param[in] SingleThread If TRUE, then all the enabled APs execute\r
292 the function specified by Procedure one by\r
293 one, in ascending order of processor handle\r
294 number. If FALSE, then all the enabled APs\r
82336c28 295 execute the function specified by Procedure\r
296 simultaneously.\r
297 @param[in] WaitEvent The event created by the caller with CreateEvent()\r
8f3446d8
JF
298 service. If it is NULL, then execute in\r
299 blocking mode. BSP waits until all APs finish\r
300 or TimeoutInMicroSeconds expires. If it's\r
301 not NULL, then execute in non-blocking mode.\r
302 BSP requests the function specified by\r
303 Procedure to be started on all the enabled\r
304 APs, and go on executing immediately. If\r
af2dc6a7 305 all return from Procedure, or TimeoutInMicroSeconds\r
8f3446d8
JF
306 expires, this event is signaled. The BSP\r
307 can use the CheckEvent() or WaitForEvent()\r
308 services to check the state of event. Type\r
309 EFI_EVENT is defined in CreateEvent() in\r
310 the Unified Extensible Firmware Interface\r
311 Specification.\r
312 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for\r
313 APs to return from Procedure, either for\r
314 blocking or non-blocking mode. Zero means\r
315 infinity. If the timeout expires before\r
82336c28 316 all APs return from Procedure, then Procedure\r
8f3446d8
JF
317 on the failed APs is terminated. All enabled\r
318 APs are available for next function assigned\r
319 by EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r
82336c28 320 or EFI_MP_SERVICES_PROTOCOL.StartupThisAP().\r
8f3446d8
JF
321 If the timeout expires in blocking mode,\r
322 BSP returns EFI_TIMEOUT. If the timeout\r
323 expires in non-blocking mode, WaitEvent\r
82336c28 324 is signaled with SignalEvent().\r
8f3446d8 325 @param[in] ProcedureArgument The parameter passed into Procedure for\r
82336c28 326 all APs.\r
8f3446d8
JF
327 @param[out] FailedCpuList If NULL, this parameter is ignored. Otherwise,\r
328 if all APs finish successfully, then its\r
329 content is set to NULL. If not all APs\r
330 finish before timeout expires, then its\r
331 content is set to address of the buffer\r
332 holding handle numbers of the failed APs.\r
333 The buffer is allocated by MP Service Protocol,\r
334 and it's the caller's responsibility to\r
82336c28 335 free the buffer with FreePool() service.\r
8f3446d8
JF
336 In blocking mode, it is ready for consumption\r
337 when the call returns. In non-blocking mode,\r
338 it is ready when WaitEvent is signaled. The\r
339 list of failed CPU is terminated by\r
82336c28 340 END_OF_CPU_LIST.\r
341\r
8f3446d8 342 @retval EFI_SUCCESS In blocking mode, all APs have finished before\r
82336c28 343 the timeout expired.\r
8f3446d8 344 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched\r
82336c28 345 to all enabled APs.\r
8f3446d8
JF
346 @retval EFI_UNSUPPORTED A non-blocking mode request was made after the\r
347 UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was\r
82336c28 348 signaled.\r
349 @retval EFI_DEVICE_ERROR Caller processor is AP.\r
350 @retval EFI_NOT_STARTED No enabled APs exist in the system.\r
351 @retval EFI_NOT_READY Any enabled APs are busy.\r
8f3446d8 352 @retval EFI_TIMEOUT In blocking mode, the timeout expired before\r
82336c28 353 all enabled APs have finished.\r
354 @retval EFI_INVALID_PARAMETER Procedure is NULL.\r
355\r
356**/\r
357typedef\r
358EFI_STATUS\r
359(EFIAPI *EFI_MP_SERVICES_STARTUP_ALL_APS)(\r
360 IN EFI_MP_SERVICES_PROTOCOL *This,\r
361 IN EFI_AP_PROCEDURE Procedure,\r
362 IN BOOLEAN SingleThread,\r
363 IN EFI_EVENT WaitEvent OPTIONAL,\r
364 IN UINTN TimeoutInMicroSeconds,\r
365 IN VOID *ProcedureArgument OPTIONAL,\r
366 OUT UINTN **FailedCpuList OPTIONAL\r
367 );\r
368\r
369/**\r
8f3446d8
JF
370 This service lets the caller get one enabled AP to execute a caller-provided\r
371 function. The caller can request the BSP to either wait for the completion\r
372 of the AP or just proceed with the next task by using the EFI event mechanism.\r
373 See EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() for more details on non-blocking\r
82336c28 374 execution support. This service may only be called from the BSP.\r
375\r
8f3446d8
JF
376 This function is used to dispatch one enabled AP to the function specified by\r
377 Procedure passing in the argument specified by ProcedureArgument. If WaitEvent\r
378 is NULL, execution is in blocking mode. The BSP waits until the AP finishes or\r
379 TimeoutInMicroSecondss expires. Otherwise, execution is in non-blocking mode.\r
380 BSP proceeds to the next task without waiting for the AP. If a non-blocking mode\r
381 is requested after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled,\r
82336c28 382 then EFI_UNSUPPORTED must be returned.\r
8f3446d8
JF
383\r
384 If the timeout specified by TimeoutInMicroseconds expires before the AP returns\r
385 from Procedure, then execution of Procedure by the AP is terminated. The AP is\r
386 available for subsequent calls to EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() and\r
82336c28 387 EFI_MP_SERVICES_PROTOCOL.StartupThisAP().\r
388\r
389 @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL\r
390 instance.\r
51d4779d
JF
391 @param[in] Procedure A pointer to the function to be run on the\r
392 designated AP of the system. See type\r
82336c28 393 EFI_AP_PROCEDURE.\r
8f3446d8 394 @param[in] ProcessorNumber The handle number of the AP. The range is\r
82336c28 395 from 0 to the total number of logical\r
8f3446d8 396 processors minus 1. The total number of\r
82336c28 397 logical processors can be retrieved by\r
398 EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r
399 @param[in] WaitEvent The event created by the caller with CreateEvent()\r
8f3446d8
JF
400 service. If it is NULL, then execute in\r
401 blocking mode. BSP waits until this AP finish\r
402 or TimeoutInMicroSeconds expires. If it's\r
403 not NULL, then execute in non-blocking mode.\r
404 BSP requests the function specified by\r
405 Procedure to be started on this AP,\r
51d4779d
JF
406 and go on executing immediately. If this AP\r
407 return from Procedure or TimeoutInMicroSeconds\r
8f3446d8
JF
408 expires, this event is signaled. The BSP\r
409 can use the CheckEvent() or WaitForEvent()\r
410 services to check the state of event. Type\r
411 EFI_EVENT is defined in CreateEvent() in\r
412 the Unified Extensible Firmware Interface\r
413 Specification.\r
414 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for\r
415 this AP to finish this Procedure, either for\r
416 blocking or non-blocking mode. Zero means\r
417 infinity. If the timeout expires before\r
51d4779d 418 this AP returns from Procedure, then Procedure\r
8f3446d8
JF
419 on the AP is terminated. The\r
420 AP is available for next function assigned\r
421 by EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r
82336c28 422 or EFI_MP_SERVICES_PROTOCOL.StartupThisAP().\r
8f3446d8
JF
423 If the timeout expires in blocking mode,\r
424 BSP returns EFI_TIMEOUT. If the timeout\r
425 expires in non-blocking mode, WaitEvent\r
82336c28 426 is signaled with SignalEvent().\r
51d4779d
JF
427 @param[in] ProcedureArgument The parameter passed into Procedure on the\r
428 specified AP.\r
8f3446d8 429 @param[out] Finished If NULL, this parameter is ignored. In\r
82336c28 430 blocking mode, this parameter is ignored.\r
8f3446d8 431 In non-blocking mode, if AP returns from\r
82336c28 432 Procedure before the timeout expires, its\r
8f3446d8 433 content is set to TRUE. Otherwise, the\r
82336c28 434 value is set to FALSE. The caller can\r
8f3446d8 435 determine if the AP returned from Procedure\r
82336c28 436 by evaluating this value.\r
437\r
8f3446d8 438 @retval EFI_SUCCESS In blocking mode, specified AP finished before\r
82336c28 439 the timeout expires.\r
8f3446d8 440 @retval EFI_SUCCESS In non-blocking mode, the function has been\r
82336c28 441 dispatched to specified AP.\r
8f3446d8
JF
442 @retval EFI_UNSUPPORTED A non-blocking mode request was made after the\r
443 UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was\r
82336c28 444 signaled.\r
445 @retval EFI_DEVICE_ERROR The calling processor is an AP.\r
8f3446d8 446 @retval EFI_TIMEOUT In blocking mode, the timeout expired before\r
82336c28 447 the specified AP has finished.\r
448 @retval EFI_NOT_READY The specified AP is busy.\r
8f3446d8 449 @retval EFI_NOT_FOUND The processor with the handle specified by\r
82336c28 450 ProcessorNumber does not exist.\r
451 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP or disabled AP.\r
452 @retval EFI_INVALID_PARAMETER Procedure is NULL.\r
453\r
454**/\r
455typedef\r
456EFI_STATUS\r
457(EFIAPI *EFI_MP_SERVICES_STARTUP_THIS_AP)(\r
458 IN EFI_MP_SERVICES_PROTOCOL *This,\r
459 IN EFI_AP_PROCEDURE Procedure,\r
460 IN UINTN ProcessorNumber,\r
461 IN EFI_EVENT WaitEvent OPTIONAL,\r
462 IN UINTN TimeoutInMicroseconds,\r
463 IN VOID *ProcedureArgument OPTIONAL,\r
464 OUT BOOLEAN *Finished OPTIONAL\r
465 );\r
466\r
467/**\r
8f3446d8
JF
468 This service switches the requested AP to be the BSP from that point onward.\r
469 This service changes the BSP for all purposes. This call can only be performed\r
82336c28 470 by the current BSP.\r
471\r
8f3446d8
JF
472 This service switches the requested AP to be the BSP from that point onward.\r
473 This service changes the BSP for all purposes. The new BSP can take over the\r
474 execution of the old BSP and continue seamlessly from where the old one left\r
475 off. This service may not be supported after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT\r
82336c28 476 is signaled.\r
477\r
8f3446d8 478 If the BSP cannot be switched prior to the return from this service, then\r
82336c28 479 EFI_UNSUPPORTED must be returned.\r
480\r
481 @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r
8f3446d8
JF
482 @param[in] ProcessorNumber The handle number of AP that is to become the new\r
483 BSP. The range is from 0 to the total number of\r
484 logical processors minus 1. The total number of\r
82336c28 485 logical processors can be retrieved by\r
486 EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r
8f3446d8 487 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an\r
82336c28 488 enabled AP. Otherwise, it will be disabled.\r
489\r
490 @retval EFI_SUCCESS BSP successfully switched.\r
8f3446d8 491 @retval EFI_UNSUPPORTED Switching the BSP cannot be completed prior to\r
82336c28 492 this service returning.\r
493 @retval EFI_UNSUPPORTED Switching the BSP is not supported.\r
da71a637 494 @retval EFI_DEVICE_ERROR The calling processor is an AP.\r
82336c28 495 @retval EFI_NOT_FOUND The processor with the handle specified by\r
496 ProcessorNumber does not exist.\r
8f3446d8 497 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the current BSP or\r
82336c28 498 a disabled AP.\r
499 @retval EFI_NOT_READY The specified AP is busy.\r
500\r
501**/\r
502typedef\r
503EFI_STATUS\r
504(EFIAPI *EFI_MP_SERVICES_SWITCH_BSP)(\r
505 IN EFI_MP_SERVICES_PROTOCOL *This,\r
506 IN UINTN ProcessorNumber,\r
507 IN BOOLEAN EnableOldBSP\r
508 );\r
509\r
510/**\r
8f3446d8 511 This service lets the caller enable or disable an AP from this point onward.\r
82336c28 512 This service may only be called from the BSP.\r
513\r
8f3446d8
JF
514 This service allows the caller enable or disable an AP from this point onward.\r
515 The caller can optionally specify the health status of the AP by Health. If\r
516 an AP is being disabled, then the state of the disabled AP is implementation\r
517 dependent. If an AP is enabled, then the implementation must guarantee that a\r
518 complete initialization sequence is performed on the AP, so the AP is in a state\r
519 that is compatible with an MP operating system. This service may not be supported\r
82336c28 520 after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled.\r
521\r
8f3446d8 522 If the enable or disable AP operation cannot be completed prior to the return\r
82336c28 523 from this service, then EFI_UNSUPPORTED must be returned.\r
524\r
525 @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r
51d4779d 526 @param[in] ProcessorNumber The handle number of AP.\r
8f3446d8
JF
527 The range is from 0 to the total number of\r
528 logical processors minus 1. The total number of\r
82336c28 529 logical processors can be retrieved by\r
530 EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r
8f3446d8 531 @param[in] EnableAP Specifies the new state for the processor for\r
82336c28 532 enabled, FALSE for disabled.\r
8f3446d8
JF
533 @param[in] HealthFlag If not NULL, a pointer to a value that specifies\r
534 the new health status of the AP. This flag\r
535 corresponds to StatusFlag defined in\r
536 EFI_MP_SERVICES_PROTOCOL.GetProcessorInfo(). Only\r
537 the PROCESSOR_HEALTH_STATUS_BIT is used. All other\r
538 bits are ignored. If it is NULL, this parameter\r
82336c28 539 is ignored.\r
540\r
af2dc6a7 541 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.\r
8f3446d8 542 @retval EFI_UNSUPPORTED Enabling or disabling an AP cannot be completed\r
82336c28 543 prior to this service returning.\r
544 @retval EFI_UNSUPPORTED Enabling or disabling an AP is not supported.\r
545 @retval EFI_DEVICE_ERROR The calling processor is an AP.\r
546 @retval EFI_NOT_FOUND Processor with the handle specified by ProcessorNumber\r
547 does not exist.\r
548 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP.\r
549\r
550**/\r
551typedef\r
552EFI_STATUS\r
553(EFIAPI *EFI_MP_SERVICES_ENABLEDISABLEAP)(\r
554 IN EFI_MP_SERVICES_PROTOCOL *This,\r
555 IN UINTN ProcessorNumber,\r
b635c768 556 IN BOOLEAN EnableAP,\r
82336c28 557 IN UINT32 *HealthFlag OPTIONAL\r
558 );\r
559\r
560/**\r
8f3446d8 561 This return the handle number for the calling processor. This service may be\r
82336c28 562 called from the BSP and APs.\r
563\r
8f3446d8
JF
564 This service returns the processor handle number for the calling processor.\r
565 The returned value is in the range from 0 to the total number of logical\r
566 processors minus 1. The total number of logical processors can be retrieved\r
567 with EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors(). This service may be\r
568 called from the BSP and APs. If ProcessorNumber is NULL, then EFI_INVALID_PARAMETER\r
569 is returned. Otherwise, the current processors handle number is returned in\r
82336c28 570 ProcessorNumber, and EFI_SUCCESS is returned.\r
571\r
572 @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r
51d4779d 573 @param[in] ProcessorNumber Pointer to the handle number of AP.\r
8f3446d8
JF
574 The range is from 0 to the total number of\r
575 logical processors minus 1. The total number of\r
82336c28 576 logical processors can be retrieved by\r
577 EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r
578\r
8f3446d8 579 @retval EFI_SUCCESS The current processor handle number was returned\r
82336c28 580 in ProcessorNumber.\r
af2dc6a7 581 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.\r
82336c28 582\r
583**/\r
584typedef\r
585EFI_STATUS\r
586(EFIAPI *EFI_MP_SERVICES_WHOAMI)(\r
587 IN EFI_MP_SERVICES_PROTOCOL *This,\r
588 OUT UINTN *ProcessorNumber\r
589 );\r
590\r
591///\r
8f3446d8 592/// When installed, the MP Services Protocol produces a collection of services\r
82336c28 593/// that are needed for MP management.\r
594///\r
8f3446d8
JF
595/// Before the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled, the module\r
596/// that produces this protocol is required to place all APs into an idle state\r
597/// whenever the APs are disabled or the APs are not executing code as requested\r
598/// through the StartupAllAPs() or StartupThisAP() services. The idle state of\r
599/// an AP before the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled is\r
82336c28 600/// implementation dependent.\r
601///\r
8f3446d8
JF
602/// After the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled, all the APs\r
603/// must be placed in the OS compatible CPU state as defined by the UEFI\r
604/// Specification. Implementations of this protocol may use the UEFI event\r
605/// EFI_EVENT_GROUP_READY_TO_BOOT to force APs into the OS compatible state as\r
606/// defined by the UEFI Specification. Modules that use this protocol must\r
607/// guarantee that all non-blocking mode requests on all APs have been completed\r
608/// before the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled. Since the\r
609/// order that event notification functions in the same event group are executed\r
610/// is not deterministic, an event of type EFI_EVENT_GROUP_READY_TO_BOOT cannot\r
82336c28 611/// be used to guarantee that APs have completed their non-blocking mode requests.\r
612///\r
8f3446d8
JF
613/// When the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled, the StartAllAPs()\r
614/// and StartupThisAp() services must no longer support non-blocking mode requests.\r
615/// The support for SwitchBSP() and EnableDisableAP() may no longer be supported\r
616/// after this event is signaled. Since UEFI Applications and UEFI OS Loaders\r
617/// execute after the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled, these\r
82336c28 618/// UEFI images must be aware that the functionality of this protocol may be reduced.\r
8f3446d8 619///\r
82336c28 620struct _EFI_MP_SERVICES_PROTOCOL {\r
621 EFI_MP_SERVICES_GET_NUMBER_OF_PROCESSORS GetNumberOfProcessors;\r
622 EFI_MP_SERVICES_GET_PROCESSOR_INFO GetProcessorInfo;\r
623 EFI_MP_SERVICES_STARTUP_ALL_APS StartupAllAPs;\r
624 EFI_MP_SERVICES_STARTUP_THIS_AP StartupThisAP;\r
625 EFI_MP_SERVICES_SWITCH_BSP SwitchBSP;\r
626 EFI_MP_SERVICES_ENABLEDISABLEAP EnableDisableAP;\r
627 EFI_MP_SERVICES_WHOAMI WhoAmI;\r
628};\r
629\r
630extern EFI_GUID gEfiMpServiceProtocolGuid;\r
631\r
632#endif\r