]>
Commit | Line | Data |
---|---|---|
6022e28c JJ |
1 | /** @file\r |
2 | CPU DXE MP support\r | |
3 | \r | |
4 | Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r | |
5 | This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _CPU_MP_H_\r | |
16 | #define _CPU_MP_H_\r | |
17 | \r | |
003973d9 | 18 | #include <Protocol/MpService.h>\r |
03673ae1 | 19 | #include <Library/SynchronizationLib.h>\r |
003973d9 | 20 | \r |
6022e28c JJ |
21 | /**\r |
22 | Initialize Multi-processor support.\r | |
23 | \r | |
24 | **/\r | |
25 | VOID\r | |
26 | InitializeMpSupport (\r | |
27 | VOID\r | |
28 | );\r | |
29 | \r | |
533263ee JJ |
30 | typedef\r |
31 | VOID\r | |
32 | (EFIAPI *STACKLESS_AP_ENTRY_POINT)(\r | |
33 | VOID\r | |
34 | );\r | |
35 | \r | |
36 | /**\r | |
37 | Starts the Application Processors and directs them to jump to the\r | |
38 | specified routine.\r | |
39 | \r | |
40 | The processor jumps to this code in flat mode, but the processor's\r | |
41 | stack is not initialized.\r | |
42 | \r | |
533263ee | 43 | @retval EFI_SUCCESS The APs were started\r |
533263ee JJ |
44 | \r |
45 | **/\r | |
46 | EFI_STATUS\r | |
47 | StartApsStackless (\r | |
fe078dd5 | 48 | VOID\r |
533263ee JJ |
49 | );\r |
50 | \r | |
fab82c18 JJ |
51 | /**\r |
52 | The AP entry point that the Startup-IPI target code will jump to.\r | |
53 | \r | |
54 | The processor jumps to this code in flat mode, but the processor's\r | |
55 | stack is not initialized.\r | |
56 | \r | |
57 | **/\r | |
58 | VOID\r | |
59 | EFIAPI\r | |
60 | AsmApEntryPoint (\r | |
61 | VOID\r | |
62 | );\r | |
63 | \r | |
64 | /**\r | |
65 | Releases the lock preventing other APs from using the shared AP\r | |
66 | stack.\r | |
67 | \r | |
68 | Once the AP has transitioned to using a new stack, it can call this\r | |
69 | function to allow another AP to proceed with using the shared stack.\r | |
70 | \r | |
71 | **/\r | |
72 | VOID\r | |
73 | EFIAPI\r | |
74 | AsmApDoneWithCommonStack (\r | |
75 | VOID\r | |
76 | );\r | |
77 | \r | |
03673ae1 CF |
78 | typedef enum {\r |
79 | CpuStateIdle,\r | |
80 | CpuStateBlocked,\r | |
81 | CpuStateReady,\r | |
82 | CpuStateBuzy,\r | |
83 | CpuStateFinished\r | |
84 | } CPU_STATE;\r | |
85 | \r | |
86 | /**\r | |
87 | Define Individual Processor Data block.\r | |
88 | \r | |
89 | **/\r | |
90 | typedef struct {\r | |
91 | EFI_PROCESSOR_INFORMATION Info;\r | |
92 | SPIN_LOCK CpuDataLock;\r | |
0e724fc1 | 93 | INTN LockSelf;\r |
03673ae1 CF |
94 | volatile CPU_STATE State;\r |
95 | \r | |
96 | EFI_AP_PROCEDURE Procedure;\r | |
97 | VOID *Parameter;\r | |
3f4f0af8 CF |
98 | BOOLEAN *Finished;\r |
99 | INTN Timeout;\r | |
100 | EFI_EVENT WaitEvent;\r | |
101 | BOOLEAN TimeoutActive;\r | |
102 | EFI_EVENT CheckThisAPEvent;\r | |
ac9dbb3b | 103 | VOID *TopOfStack;\r |
03673ae1 CF |
104 | } CPU_DATA_BLOCK;\r |
105 | \r | |
106 | /**\r | |
107 | Define MP data block which consumes individual processor block.\r | |
108 | \r | |
109 | **/\r | |
110 | typedef struct {\r | |
111 | CPU_DATA_BLOCK *CpuDatas;\r | |
112 | UINTN NumberOfProcessors;\r | |
113 | UINTN NumberOfEnabledProcessors;\r | |
5fee172f CF |
114 | \r |
115 | EFI_AP_PROCEDURE Procedure;\r | |
116 | VOID *ProcedureArgument;\r | |
117 | UINTN StartCount;\r | |
118 | UINTN FinishCount;\r | |
119 | BOOLEAN SingleThread;\r | |
120 | UINTN **FailedList;\r | |
121 | UINTN FailedListIndex;\r | |
122 | INTN Timeout;\r | |
123 | EFI_EVENT WaitEvent;\r | |
124 | BOOLEAN TimeoutActive;\r | |
125 | EFI_EVENT CheckAllAPsEvent;\r | |
03673ae1 CF |
126 | } MP_SYSTEM_DATA;\r |
127 | \r | |
128 | /**\r | |
129 | This function is called by all processors (both BSP and AP) once and collects MP related data.\r | |
130 | \r | |
131 | @param Bsp TRUE if the CPU is BSP\r | |
132 | @param ProcessorNumber The specific processor number\r | |
133 | \r | |
134 | @retval EFI_SUCCESS Data for the processor collected and filled in\r | |
135 | \r | |
136 | **/\r | |
137 | EFI_STATUS\r | |
138 | FillInProcessorInformation (\r | |
139 | IN BOOLEAN Bsp,\r | |
140 | IN UINTN ProcessorNumber\r | |
141 | );\r | |
142 | \r | |
d894d8b7 CF |
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 | |
149 | - The number of logical processors that are present in the system.\r | |
150 | - The number of enabled logical processors in the system at the instant\r | |
151 | this call is made.\r | |
152 | \r | |
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 | |
155 | course of a boot session.\r | |
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 | |
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 | |
172 | @retval EFI_SUCCESS The number of logical processors and enabled\r | |
173 | logical processors was retrieved.\r | |
174 | @retval EFI_DEVICE_ERROR The calling processor is an AP.\r | |
175 | @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL.\r | |
176 | @retval EFI_INVALID_PARAMETER NumberOfEnabledProcessors is NULL.\r | |
177 | \r | |
178 | **/\r | |
179 | EFI_STATUS\r | |
180 | EFIAPI\r | |
181 | GetNumberOfProcessors (\r | |
182 | IN EFI_MP_SERVICES_PROTOCOL *This,\r | |
183 | OUT UINTN *NumberOfProcessors,\r | |
184 | OUT UINTN *NumberOfEnabledProcessors\r | |
185 | );\r | |
186 | \r | |
e7938b5a CF |
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 | |
191 | This service retrieves detailed MP-related information about any processor\r | |
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 | |
195 | \r | |
196 | Information regarding the number of caches and their sizes, frequency of operation,\r | |
197 | slot numbers is all considered platform-related information and is not provided\r | |
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 | |
213 | EFI_STATUS\r | |
214 | EFIAPI\r | |
215 | GetProcessorInfo (\r | |
216 | IN EFI_MP_SERVICES_PROTOCOL *This,\r | |
217 | IN UINTN ProcessorNumber,\r | |
218 | OUT EFI_PROCESSOR_INFORMATION *ProcessorInfoBuffer\r | |
219 | );\r | |
220 | \r | |
5fee172f CF |
221 | /**\r |
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 | |
226 | be called from the BSP.\r | |
227 | \r | |
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 | |
230 | immediately and Procedure is not started on any AP.\r | |
231 | \r | |
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 | |
234 | all the enabled APs execute the function specified by Procedure simultaneously.\r | |
235 | \r | |
236 | If WaitEvent is NULL, execution is in blocking mode. The BSP waits until all\r | |
237 | APs finish or TimeoutInMicroseconds 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 | |
240 | is signaled, then EFI_UNSUPPORTED must be returned.\r | |
241 | \r | |
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 | |
244 | are always available for further calls to EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r | |
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 | |
247 | terminated.\r | |
248 | \r | |
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 | |
255 | specified.\r | |
256 | \r | |
257 | In blocking execution mode, BSP waits until all APs finish or\r | |
258 | TimeoutInMicroseconds expires.\r | |
259 | \r | |
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 | |
262 | sequence needs to occur in a non-blocking execution mode:\r | |
263 | \r | |
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 | |
269 | and releases the BSP to continue with other tasks.\r | |
270 | -# The caller can use the CheckEvent() and WaitForEvent() services to check\r | |
271 | the state of the WaitEvent created in step 1.\r | |
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 | |
279 | It is the caller's responsibility to free the buffer with FreePool() service.\r | |
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 | |
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 | |
284 | prior to the timeout.\r | |
285 | \r | |
286 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL\r | |
287 | instance.\r | |
288 | @param[in] Procedure A pointer to the function to be run on\r | |
289 | enabled APs of the system. See type\r | |
290 | EFI_AP_PROCEDURE.\r | |
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 | |
295 | execute the function specified by Procedure\r | |
296 | simultaneously.\r | |
297 | @param[in] WaitEvent The event created by the caller with CreateEvent()\r | |
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 | |
305 | all return from Procedure, or TimeoutInMicroseconds\r | |
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] TimeoutInMicroseconds 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 | |
316 | all APs return from Procedure, then Procedure\r | |
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 | |
320 | or EFI_MP_SERVICES_PROTOCOL.StartupThisAP().\r | |
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 | |
324 | is signaled with SignalEvent().\r | |
325 | @param[in] ProcedureArgument The parameter passed into Procedure for\r | |
326 | all APs.\r | |
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 | |
335 | free the buffer with FreePool() service.\r | |
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 | |
340 | END_OF_CPU_LIST.\r | |
341 | \r | |
342 | @retval EFI_SUCCESS In blocking mode, all APs have finished before\r | |
343 | the timeout expired.\r | |
344 | @retval EFI_SUCCESS In non-blocking mode, function has been dispatched\r | |
345 | to all enabled APs.\r | |
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 | |
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 | |
352 | @retval EFI_TIMEOUT In blocking mode, the timeout expired before\r | |
353 | all enabled APs have finished.\r | |
354 | @retval EFI_INVALID_PARAMETER Procedure is NULL.\r | |
355 | \r | |
356 | **/\r | |
357 | EFI_STATUS\r | |
358 | EFIAPI\r | |
359 | StartupAllAPs (\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 | |
3f4f0af8 CF |
369 | /**\r |
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 | |
374 | execution support. This service may only be called from the BSP.\r | |
375 | \r | |
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 | |
382 | then EFI_UNSUPPORTED must be returned.\r | |
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 | |
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 | |
391 | @param[in] Procedure A pointer to the function to be run on\r | |
392 | enabled APs of the system. See type\r | |
393 | EFI_AP_PROCEDURE.\r | |
394 | @param[in] ProcessorNumber The handle number of the AP. The range is\r | |
395 | from 0 to the total number of logical\r | |
396 | processors minus 1. The total number of\r | |
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 | |
400 | service. If it is NULL, then execute in\r | |
401 | blocking mode. BSP waits until all APs 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 all the enabled\r | |
406 | APs, and go on executing immediately. If\r | |
407 | all return from Procedure or TimeoutInMicroseconds\r | |
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] TimeoutInMicroseconds Indicates the time limit in microseconds for\r | |
415 | APs to return from Procedure, either for\r | |
416 | blocking or non-blocking mode. Zero means\r | |
417 | infinity. If the timeout expires before\r | |
418 | all APs return from Procedure, then Procedure\r | |
419 | on the failed APs is terminated. All enabled\r | |
420 | APs are available for next function assigned\r | |
421 | by EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r | |
422 | or EFI_MP_SERVICES_PROTOCOL.StartupThisAP().\r | |
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 | |
426 | is signaled with SignalEvent().\r | |
427 | @param[in] ProcedureArgument The parameter passed into Procedure for\r | |
428 | all APs.\r | |
429 | @param[out] Finished If NULL, this parameter is ignored. In\r | |
430 | blocking mode, this parameter is ignored.\r | |
431 | In non-blocking mode, if AP returns from\r | |
432 | Procedure before the timeout expires, its\r | |
433 | content is set to TRUE. Otherwise, the\r | |
434 | value is set to FALSE. The caller can\r | |
435 | determine if the AP returned from Procedure\r | |
436 | by evaluating this value.\r | |
437 | \r | |
438 | @retval EFI_SUCCESS In blocking mode, specified AP finished before\r | |
439 | the timeout expires.\r | |
440 | @retval EFI_SUCCESS In non-blocking mode, the function has been\r | |
441 | dispatched to specified AP.\r | |
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 | |
444 | signaled.\r | |
445 | @retval EFI_DEVICE_ERROR The calling processor is an AP.\r | |
446 | @retval EFI_TIMEOUT In blocking mode, the timeout expired before\r | |
447 | the specified AP has finished.\r | |
448 | @retval EFI_NOT_READY The specified AP is busy.\r | |
449 | @retval EFI_NOT_FOUND The processor with the handle specified by\r | |
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 | |
455 | EFI_STATUS\r | |
456 | EFIAPI\r | |
457 | StartupThisAP (\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 | |
b7c05ba5 CF |
467 | /**\r |
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 | |
470 | by the current BSP.\r | |
471 | \r | |
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 | |
476 | is signaled.\r | |
477 | \r | |
478 | If the BSP cannot be switched prior to the return from this service, then\r | |
479 | EFI_UNSUPPORTED must be returned.\r | |
480 | \r | |
481 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r | |
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 | |
485 | logical processors can be retrieved by\r | |
486 | EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r | |
487 | @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an\r | |
488 | enabled AP. Otherwise, it will be disabled.\r | |
489 | \r | |
490 | @retval EFI_SUCCESS BSP successfully switched.\r | |
491 | @retval EFI_UNSUPPORTED Switching the BSP cannot be completed prior to\r | |
492 | this service returning.\r | |
493 | @retval EFI_UNSUPPORTED Switching the BSP is not supported.\r | |
494 | @retval EFI_SUCCESS The calling processor is an AP.\r | |
495 | @retval EFI_NOT_FOUND The processor with the handle specified by\r | |
496 | ProcessorNumber does not exist.\r | |
497 | @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the current BSP or\r | |
498 | a disabled AP.\r | |
499 | @retval EFI_NOT_READY The specified AP is busy.\r | |
500 | \r | |
501 | **/\r | |
502 | EFI_STATUS\r | |
503 | EFIAPI\r | |
504 | SwitchBSP (\r | |
505 | IN EFI_MP_SERVICES_PROTOCOL *This,\r | |
506 | IN UINTN ProcessorNumber,\r | |
507 | IN BOOLEAN EnableOldBSP\r | |
508 | );\r | |
509 | \r | |
fa7ce675 CF |
510 | /**\r |
511 | This service lets the caller enable or disable an AP from this point onward.\r | |
512 | This service may only be called from the BSP.\r | |
513 | \r | |
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 | |
520 | after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled.\r | |
521 | \r | |
522 | If the enable or disable AP operation cannot be completed prior to the return\r | |
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 | |
526 | @param[in] ProcessorNumber The handle number of AP that is to become the new\r | |
527 | BSP. The range is from 0 to the total number of\r | |
528 | logical processors minus 1. The total number of\r | |
529 | logical processors can be retrieved by\r | |
530 | EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r | |
531 | @param[in] EnableAP Specifies the new state for the processor for\r | |
532 | enabled, FALSE for disabled.\r | |
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 | |
539 | is ignored.\r | |
540 | \r | |
541 | @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.\r | |
542 | @retval EFI_UNSUPPORTED Enabling or disabling an AP cannot be completed\r | |
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 | |
551 | EFI_STATUS\r | |
552 | EFIAPI\r | |
553 | EnableDisableAP (\r | |
554 | IN EFI_MP_SERVICES_PROTOCOL *This,\r | |
555 | IN UINTN ProcessorNumber,\r | |
556 | IN BOOLEAN EnableAP,\r | |
557 | IN UINT32 *HealthFlag OPTIONAL\r | |
558 | );\r | |
559 | \r | |
cfa2fac1 CF |
560 | /**\r |
561 | This return the handle number for the calling processor. This service may be\r | |
562 | called from the BSP and APs.\r | |
563 | \r | |
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 | |
570 | ProcessorNumber, and EFI_SUCCESS is returned.\r | |
571 | \r | |
572 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r | |
573 | @param[out] ProcessorNumber The handle number of AP that is to become the new\r | |
574 | BSP. The range is from 0 to the total number of\r | |
575 | logical processors minus 1. The total number of\r | |
576 | logical processors can be retrieved by\r | |
577 | EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r | |
578 | \r | |
579 | @retval EFI_SUCCESS The current processor handle number was returned\r | |
580 | in ProcessorNumber.\r | |
581 | @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.\r | |
582 | \r | |
583 | **/\r | |
584 | EFI_STATUS\r | |
585 | EFIAPI\r | |
586 | WhoAmI (\r | |
587 | IN EFI_MP_SERVICES_PROTOCOL *This,\r | |
588 | OUT UINTN *ProcessorNumber\r | |
589 | );\r | |
590 | \r | |
3f4f0af8 CF |
591 | /**\r |
592 | Terminate AP's task and set it to idle state.\r | |
593 | \r | |
594 | This function terminates AP's task due to timeout by sending INIT-SIPI,\r | |
595 | and sends it to idle state.\r | |
596 | \r | |
597 | @param CpuData the pointer to CPU_DATA_BLOCK of specified AP\r | |
598 | \r | |
599 | **/\r | |
600 | VOID\r | |
601 | ResetProcessorToIdleState (\r | |
602 | IN CPU_DATA_BLOCK *CpuData\r | |
603 | );\r | |
604 | \r | |
fe078dd5 CF |
605 | /**\r |
606 | Prepares Startup Code for APs.\r | |
607 | This function prepares Startup Code for APs.\r | |
608 | \r | |
609 | @retval EFI_SUCCESS The APs were started\r | |
610 | @retval EFI_OUT_OF_RESOURCES Cannot allocate memory to start APs\r | |
611 | \r | |
612 | **/\r | |
613 | EFI_STATUS\r | |
614 | PrepareAPStartupCode (\r | |
615 | VOID\r | |
616 | );\r | |
617 | \r | |
618 | /**\r | |
619 | Free the code buffer of startup AP.\r | |
620 | \r | |
621 | **/\r | |
622 | VOID\r | |
623 | FreeApStartupCode (\r | |
624 | VOID\r | |
625 | );\r | |
626 | \r | |
ac9dbb3b CF |
627 | /**\r |
628 | Resets the Application Processor and directs it to jump to the\r | |
629 | specified routine.\r | |
630 | \r | |
631 | The processor jumps to this code in flat mode, but the processor's\r | |
632 | stack is not initialized.\r | |
633 | \r | |
634 | @param ProcessorId the AP of ProcessorId was reset\r | |
635 | **/\r | |
636 | VOID\r | |
637 | ResetApStackless (\r | |
638 | IN UINT32 ProcessorId\r | |
639 | );\r | |
640 | \r | |
6022e28c JJ |
641 | #endif // _CPU_MP_H_\r |
642 | \r |