| 1 | /** @file\r |
| 2 | CPU DXE MP support\r |
| 3 | \r |
| 4 | Copyright (c) 2006 - 2016, 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 |
| 18 | /**\r |
| 19 | Initialize Multi-processor support.\r |
| 20 | \r |
| 21 | **/\r |
| 22 | VOID\r |
| 23 | InitializeMpSupport (\r |
| 24 | VOID\r |
| 25 | );\r |
| 26 | \r |
| 27 | /**\r |
| 28 | This service retrieves the number of logical processor in the platform\r |
| 29 | and the number of those logical processors that are enabled on this boot.\r |
| 30 | This service may only be called from the BSP.\r |
| 31 | \r |
| 32 | This function is used to retrieve the following information:\r |
| 33 | - The number of logical processors that are present in the system.\r |
| 34 | - The number of enabled logical processors in the system at the instant\r |
| 35 | this call is made.\r |
| 36 | \r |
| 37 | Because MP Service Protocol provides services to enable and disable processors\r |
| 38 | dynamically, the number of enabled logical processors may vary during the\r |
| 39 | course of a boot session.\r |
| 40 | \r |
| 41 | If this service is called from an AP, then EFI_DEVICE_ERROR is returned.\r |
| 42 | If NumberOfProcessors or NumberOfEnabledProcessors is NULL, then\r |
| 43 | EFI_INVALID_PARAMETER is returned. Otherwise, the total number of processors\r |
| 44 | is returned in NumberOfProcessors, the number of currently enabled processor\r |
| 45 | is returned in NumberOfEnabledProcessors, and EFI_SUCCESS is returned.\r |
| 46 | \r |
| 47 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL\r |
| 48 | instance.\r |
| 49 | @param[out] NumberOfProcessors Pointer to the total number of logical\r |
| 50 | processors in the system, including the BSP\r |
| 51 | and disabled APs.\r |
| 52 | @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical\r |
| 53 | processors that exist in system, including\r |
| 54 | the BSP.\r |
| 55 | \r |
| 56 | @retval EFI_SUCCESS The number of logical processors and enabled\r |
| 57 | logical processors was retrieved.\r |
| 58 | @retval EFI_DEVICE_ERROR The calling processor is an AP.\r |
| 59 | @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL.\r |
| 60 | @retval EFI_INVALID_PARAMETER NumberOfEnabledProcessors is NULL.\r |
| 61 | \r |
| 62 | **/\r |
| 63 | EFI_STATUS\r |
| 64 | EFIAPI\r |
| 65 | GetNumberOfProcessors (\r |
| 66 | IN EFI_MP_SERVICES_PROTOCOL *This,\r |
| 67 | OUT UINTN *NumberOfProcessors,\r |
| 68 | OUT UINTN *NumberOfEnabledProcessors\r |
| 69 | );\r |
| 70 | \r |
| 71 | /**\r |
| 72 | Gets detailed MP-related information on the requested processor at the\r |
| 73 | instant this call is made. This service may only be called from the BSP.\r |
| 74 | \r |
| 75 | This service retrieves detailed MP-related information about any processor\r |
| 76 | on the platform. Note the following:\r |
| 77 | - The processor information may change during the course of a boot session.\r |
| 78 | - The information presented here is entirely MP related.\r |
| 79 | \r |
| 80 | Information regarding the number of caches and their sizes, frequency of operation,\r |
| 81 | slot numbers is all considered platform-related information and is not provided\r |
| 82 | by this service.\r |
| 83 | \r |
| 84 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL\r |
| 85 | instance.\r |
| 86 | @param[in] ProcessorNumber The handle number of processor.\r |
| 87 | @param[out] ProcessorInfoBuffer A pointer to the buffer where information for\r |
| 88 | the requested processor is deposited.\r |
| 89 | \r |
| 90 | @retval EFI_SUCCESS Processor information was returned.\r |
| 91 | @retval EFI_DEVICE_ERROR The calling processor is an AP.\r |
| 92 | @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.\r |
| 93 | @retval EFI_NOT_FOUND The processor with the handle specified by\r |
| 94 | ProcessorNumber does not exist in the platform.\r |
| 95 | \r |
| 96 | **/\r |
| 97 | EFI_STATUS\r |
| 98 | EFIAPI\r |
| 99 | GetProcessorInfo (\r |
| 100 | IN EFI_MP_SERVICES_PROTOCOL *This,\r |
| 101 | IN UINTN ProcessorNumber,\r |
| 102 | OUT EFI_PROCESSOR_INFORMATION *ProcessorInfoBuffer\r |
| 103 | );\r |
| 104 | \r |
| 105 | /**\r |
| 106 | This service executes a caller provided function on all enabled APs. APs can\r |
| 107 | run either simultaneously or one at a time in sequence. This service supports\r |
| 108 | both blocking and non-blocking requests. The non-blocking requests use EFI\r |
| 109 | events so the BSP can detect when the APs have finished. This service may only\r |
| 110 | be called from the BSP.\r |
| 111 | \r |
| 112 | This function is used to dispatch all the enabled APs to the function specified\r |
| 113 | by Procedure. If any enabled AP is busy, then EFI_NOT_READY is returned\r |
| 114 | immediately and Procedure is not started on any AP.\r |
| 115 | \r |
| 116 | If SingleThread is TRUE, all the enabled APs execute the function specified by\r |
| 117 | Procedure one by one, in ascending order of processor handle number. Otherwise,\r |
| 118 | all the enabled APs execute the function specified by Procedure simultaneously.\r |
| 119 | \r |
| 120 | If WaitEvent is NULL, execution is in blocking mode. The BSP waits until all\r |
| 121 | APs finish or TimeoutInMicroseconds expires. Otherwise, execution is in non-blocking\r |
| 122 | mode, and the BSP returns from this service without waiting for APs. If a\r |
| 123 | non-blocking mode is requested after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT\r |
| 124 | is signaled, then EFI_UNSUPPORTED must be returned.\r |
| 125 | \r |
| 126 | If the timeout specified by TimeoutInMicroseconds expires before all APs return\r |
| 127 | from Procedure, then Procedure on the failed APs is terminated. All enabled APs\r |
| 128 | are always available for further calls to EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r |
| 129 | and EFI_MP_SERVICES_PROTOCOL.StartupThisAP(). If FailedCpuList is not NULL, its\r |
| 130 | content points to the list of processor handle numbers in which Procedure was\r |
| 131 | terminated.\r |
| 132 | \r |
| 133 | Note: It is the responsibility of the consumer of the EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r |
| 134 | to make sure that the nature of the code that is executed on the BSP and the\r |
| 135 | dispatched APs is well controlled. The MP Services Protocol does not guarantee\r |
| 136 | that the Procedure function is MP-safe. Hence, the tasks that can be run in\r |
| 137 | parallel are limited to certain independent tasks and well-controlled exclusive\r |
| 138 | code. EFI services and protocols may not be called by APs unless otherwise\r |
| 139 | specified.\r |
| 140 | \r |
| 141 | In blocking execution mode, BSP waits until all APs finish or\r |
| 142 | TimeoutInMicroseconds expires.\r |
| 143 | \r |
| 144 | In non-blocking execution mode, BSP is freed to return to the caller and then\r |
| 145 | proceed to the next task without having to wait for APs. The following\r |
| 146 | sequence needs to occur in a non-blocking execution mode:\r |
| 147 | \r |
| 148 | -# The caller that intends to use this MP Services Protocol in non-blocking\r |
| 149 | mode creates WaitEvent by calling the EFI CreateEvent() service. The caller\r |
| 150 | invokes EFI_MP_SERVICES_PROTOCOL.StartupAllAPs(). If the parameter WaitEvent\r |
| 151 | is not NULL, then StartupAllAPs() executes in non-blocking mode. It requests\r |
| 152 | the function specified by Procedure to be started on all the enabled APs,\r |
| 153 | and releases the BSP to continue with other tasks.\r |
| 154 | -# The caller can use the CheckEvent() and WaitForEvent() services to check\r |
| 155 | the state of the WaitEvent created in step 1.\r |
| 156 | -# When the APs complete their task or TimeoutInMicroSecondss expires, the MP\r |
| 157 | Service signals WaitEvent by calling the EFI SignalEvent() function. If\r |
| 158 | FailedCpuList is not NULL, its content is available when WaitEvent is\r |
| 159 | signaled. If all APs returned from Procedure prior to the timeout, then\r |
| 160 | FailedCpuList is set to NULL. If not all APs return from Procedure before\r |
| 161 | the timeout, then FailedCpuList is filled in with the list of the failed\r |
| 162 | APs. The buffer is allocated by MP Service Protocol using AllocatePool().\r |
| 163 | It is the caller's responsibility to free the buffer with FreePool() service.\r |
| 164 | -# This invocation of SignalEvent() function informs the caller that invoked\r |
| 165 | EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() that either all the APs completed\r |
| 166 | the specified task or a timeout occurred. The contents of FailedCpuList\r |
| 167 | can be examined to determine which APs did not complete the specified task\r |
| 168 | prior to the timeout.\r |
| 169 | \r |
| 170 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL\r |
| 171 | instance.\r |
| 172 | @param[in] Procedure A pointer to the function to be run on\r |
| 173 | enabled APs of the system. See type\r |
| 174 | EFI_AP_PROCEDURE.\r |
| 175 | @param[in] SingleThread If TRUE, then all the enabled APs execute\r |
| 176 | the function specified by Procedure one by\r |
| 177 | one, in ascending order of processor handle\r |
| 178 | number. If FALSE, then all the enabled APs\r |
| 179 | execute the function specified by Procedure\r |
| 180 | simultaneously.\r |
| 181 | @param[in] WaitEvent The event created by the caller with CreateEvent()\r |
| 182 | service. If it is NULL, then execute in\r |
| 183 | blocking mode. BSP waits until all APs finish\r |
| 184 | or TimeoutInMicroseconds expires. If it's\r |
| 185 | not NULL, then execute in non-blocking mode.\r |
| 186 | BSP requests the function specified by\r |
| 187 | Procedure to be started on all the enabled\r |
| 188 | APs, and go on executing immediately. If\r |
| 189 | all return from Procedure, or TimeoutInMicroseconds\r |
| 190 | expires, this event is signaled. The BSP\r |
| 191 | can use the CheckEvent() or WaitForEvent()\r |
| 192 | services to check the state of event. Type\r |
| 193 | EFI_EVENT is defined in CreateEvent() in\r |
| 194 | the Unified Extensible Firmware Interface\r |
| 195 | Specification.\r |
| 196 | @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for\r |
| 197 | APs to return from Procedure, either for\r |
| 198 | blocking or non-blocking mode. Zero means\r |
| 199 | infinity. If the timeout expires before\r |
| 200 | all APs return from Procedure, then Procedure\r |
| 201 | on the failed APs is terminated. All enabled\r |
| 202 | APs are available for next function assigned\r |
| 203 | by EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r |
| 204 | or EFI_MP_SERVICES_PROTOCOL.StartupThisAP().\r |
| 205 | If the timeout expires in blocking mode,\r |
| 206 | BSP returns EFI_TIMEOUT. If the timeout\r |
| 207 | expires in non-blocking mode, WaitEvent\r |
| 208 | is signaled with SignalEvent().\r |
| 209 | @param[in] ProcedureArgument The parameter passed into Procedure for\r |
| 210 | all APs.\r |
| 211 | @param[out] FailedCpuList If NULL, this parameter is ignored. Otherwise,\r |
| 212 | if all APs finish successfully, then its\r |
| 213 | content is set to NULL. If not all APs\r |
| 214 | finish before timeout expires, then its\r |
| 215 | content is set to address of the buffer\r |
| 216 | holding handle numbers of the failed APs.\r |
| 217 | The buffer is allocated by MP Service Protocol,\r |
| 218 | and it's the caller's responsibility to\r |
| 219 | free the buffer with FreePool() service.\r |
| 220 | In blocking mode, it is ready for consumption\r |
| 221 | when the call returns. In non-blocking mode,\r |
| 222 | it is ready when WaitEvent is signaled. The\r |
| 223 | list of failed CPU is terminated by\r |
| 224 | END_OF_CPU_LIST.\r |
| 225 | \r |
| 226 | @retval EFI_SUCCESS In blocking mode, all APs have finished before\r |
| 227 | the timeout expired.\r |
| 228 | @retval EFI_SUCCESS In non-blocking mode, function has been dispatched\r |
| 229 | to all enabled APs.\r |
| 230 | @retval EFI_UNSUPPORTED A non-blocking mode request was made after the\r |
| 231 | UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was\r |
| 232 | signaled.\r |
| 233 | @retval EFI_DEVICE_ERROR Caller processor is AP.\r |
| 234 | @retval EFI_NOT_STARTED No enabled APs exist in the system.\r |
| 235 | @retval EFI_NOT_READY Any enabled APs are busy.\r |
| 236 | @retval EFI_TIMEOUT In blocking mode, the timeout expired before\r |
| 237 | all enabled APs have finished.\r |
| 238 | @retval EFI_INVALID_PARAMETER Procedure is NULL.\r |
| 239 | \r |
| 240 | **/\r |
| 241 | EFI_STATUS\r |
| 242 | EFIAPI\r |
| 243 | StartupAllAPs (\r |
| 244 | IN EFI_MP_SERVICES_PROTOCOL *This,\r |
| 245 | IN EFI_AP_PROCEDURE Procedure,\r |
| 246 | IN BOOLEAN SingleThread,\r |
| 247 | IN EFI_EVENT WaitEvent OPTIONAL,\r |
| 248 | IN UINTN TimeoutInMicroseconds,\r |
| 249 | IN VOID *ProcedureArgument OPTIONAL,\r |
| 250 | OUT UINTN **FailedCpuList OPTIONAL\r |
| 251 | );\r |
| 252 | \r |
| 253 | /**\r |
| 254 | This service lets the caller get one enabled AP to execute a caller-provided\r |
| 255 | function. The caller can request the BSP to either wait for the completion\r |
| 256 | of the AP or just proceed with the next task by using the EFI event mechanism.\r |
| 257 | See EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() for more details on non-blocking\r |
| 258 | execution support. This service may only be called from the BSP.\r |
| 259 | \r |
| 260 | This function is used to dispatch one enabled AP to the function specified by\r |
| 261 | Procedure passing in the argument specified by ProcedureArgument. If WaitEvent\r |
| 262 | is NULL, execution is in blocking mode. The BSP waits until the AP finishes or\r |
| 263 | TimeoutInMicroSecondss expires. Otherwise, execution is in non-blocking mode.\r |
| 264 | BSP proceeds to the next task without waiting for the AP. If a non-blocking mode\r |
| 265 | is requested after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled,\r |
| 266 | then EFI_UNSUPPORTED must be returned.\r |
| 267 | \r |
| 268 | If the timeout specified by TimeoutInMicroseconds expires before the AP returns\r |
| 269 | from Procedure, then execution of Procedure by the AP is terminated. The AP is\r |
| 270 | available for subsequent calls to EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() and\r |
| 271 | EFI_MP_SERVICES_PROTOCOL.StartupThisAP().\r |
| 272 | \r |
| 273 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL\r |
| 274 | instance.\r |
| 275 | @param[in] Procedure A pointer to the function to be run on\r |
| 276 | enabled APs of the system. See type\r |
| 277 | EFI_AP_PROCEDURE.\r |
| 278 | @param[in] ProcessorNumber The handle number of the AP. The range is\r |
| 279 | from 0 to the total number of logical\r |
| 280 | processors minus 1. The total number of\r |
| 281 | logical processors can be retrieved by\r |
| 282 | EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r |
| 283 | @param[in] WaitEvent The event created by the caller with CreateEvent()\r |
| 284 | service. If it is NULL, then execute in\r |
| 285 | blocking mode. BSP waits until all APs finish\r |
| 286 | or TimeoutInMicroseconds expires. If it's\r |
| 287 | not NULL, then execute in non-blocking mode.\r |
| 288 | BSP requests the function specified by\r |
| 289 | Procedure to be started on all the enabled\r |
| 290 | APs, and go on executing immediately. If\r |
| 291 | all return from Procedure or TimeoutInMicroseconds\r |
| 292 | expires, this event is signaled. The BSP\r |
| 293 | can use the CheckEvent() or WaitForEvent()\r |
| 294 | services to check the state of event. Type\r |
| 295 | EFI_EVENT is defined in CreateEvent() in\r |
| 296 | the Unified Extensible Firmware Interface\r |
| 297 | Specification.\r |
| 298 | @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for\r |
| 299 | APs to return from Procedure, either for\r |
| 300 | blocking or non-blocking mode. Zero means\r |
| 301 | infinity. If the timeout expires before\r |
| 302 | all APs return from Procedure, then Procedure\r |
| 303 | on the failed APs is terminated. All enabled\r |
| 304 | APs are available for next function assigned\r |
| 305 | by EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()\r |
| 306 | or EFI_MP_SERVICES_PROTOCOL.StartupThisAP().\r |
| 307 | If the timeout expires in blocking mode,\r |
| 308 | BSP returns EFI_TIMEOUT. If the timeout\r |
| 309 | expires in non-blocking mode, WaitEvent\r |
| 310 | is signaled with SignalEvent().\r |
| 311 | @param[in] ProcedureArgument The parameter passed into Procedure for\r |
| 312 | all APs.\r |
| 313 | @param[out] Finished If NULL, this parameter is ignored. In\r |
| 314 | blocking mode, this parameter is ignored.\r |
| 315 | In non-blocking mode, if AP returns from\r |
| 316 | Procedure before the timeout expires, its\r |
| 317 | content is set to TRUE. Otherwise, the\r |
| 318 | value is set to FALSE. The caller can\r |
| 319 | determine if the AP returned from Procedure\r |
| 320 | by evaluating this value.\r |
| 321 | \r |
| 322 | @retval EFI_SUCCESS In blocking mode, specified AP finished before\r |
| 323 | the timeout expires.\r |
| 324 | @retval EFI_SUCCESS In non-blocking mode, the function has been\r |
| 325 | dispatched to specified AP.\r |
| 326 | @retval EFI_UNSUPPORTED A non-blocking mode request was made after the\r |
| 327 | UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was\r |
| 328 | signaled.\r |
| 329 | @retval EFI_DEVICE_ERROR The calling processor is an AP.\r |
| 330 | @retval EFI_TIMEOUT In blocking mode, the timeout expired before\r |
| 331 | the specified AP has finished.\r |
| 332 | @retval EFI_NOT_READY The specified AP is busy.\r |
| 333 | @retval EFI_NOT_FOUND The processor with the handle specified by\r |
| 334 | ProcessorNumber does not exist.\r |
| 335 | @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP or disabled AP.\r |
| 336 | @retval EFI_INVALID_PARAMETER Procedure is NULL.\r |
| 337 | \r |
| 338 | **/\r |
| 339 | EFI_STATUS\r |
| 340 | EFIAPI\r |
| 341 | StartupThisAP (\r |
| 342 | IN EFI_MP_SERVICES_PROTOCOL *This,\r |
| 343 | IN EFI_AP_PROCEDURE Procedure,\r |
| 344 | IN UINTN ProcessorNumber,\r |
| 345 | IN EFI_EVENT WaitEvent OPTIONAL,\r |
| 346 | IN UINTN TimeoutInMicroseconds,\r |
| 347 | IN VOID *ProcedureArgument OPTIONAL,\r |
| 348 | OUT BOOLEAN *Finished OPTIONAL\r |
| 349 | );\r |
| 350 | \r |
| 351 | /**\r |
| 352 | This service switches the requested AP to be the BSP from that point onward.\r |
| 353 | This service changes the BSP for all purposes. This call can only be performed\r |
| 354 | by the current BSP.\r |
| 355 | \r |
| 356 | This service switches the requested AP to be the BSP from that point onward.\r |
| 357 | This service changes the BSP for all purposes. The new BSP can take over the\r |
| 358 | execution of the old BSP and continue seamlessly from where the old one left\r |
| 359 | off. This service may not be supported after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT\r |
| 360 | is signaled.\r |
| 361 | \r |
| 362 | If the BSP cannot be switched prior to the return from this service, then\r |
| 363 | EFI_UNSUPPORTED must be returned.\r |
| 364 | \r |
| 365 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r |
| 366 | @param[in] ProcessorNumber The handle number of AP that is to become the new\r |
| 367 | BSP. The range is from 0 to the total number of\r |
| 368 | logical processors minus 1. The total number of\r |
| 369 | logical processors can be retrieved by\r |
| 370 | EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r |
| 371 | @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an\r |
| 372 | enabled AP. Otherwise, it will be disabled.\r |
| 373 | \r |
| 374 | @retval EFI_SUCCESS BSP successfully switched.\r |
| 375 | @retval EFI_UNSUPPORTED Switching the BSP cannot be completed prior to\r |
| 376 | this service returning.\r |
| 377 | @retval EFI_UNSUPPORTED Switching the BSP is not supported.\r |
| 378 | @retval EFI_DEVICE_ERROR The calling processor is an AP.\r |
| 379 | @retval EFI_NOT_FOUND The processor with the handle specified by\r |
| 380 | ProcessorNumber does not exist.\r |
| 381 | @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the current BSP or\r |
| 382 | a disabled AP.\r |
| 383 | @retval EFI_NOT_READY The specified AP is busy.\r |
| 384 | \r |
| 385 | **/\r |
| 386 | EFI_STATUS\r |
| 387 | EFIAPI\r |
| 388 | SwitchBSP (\r |
| 389 | IN EFI_MP_SERVICES_PROTOCOL *This,\r |
| 390 | IN UINTN ProcessorNumber,\r |
| 391 | IN BOOLEAN EnableOldBSP\r |
| 392 | );\r |
| 393 | \r |
| 394 | /**\r |
| 395 | This service lets the caller enable or disable an AP from this point onward.\r |
| 396 | This service may only be called from the BSP.\r |
| 397 | \r |
| 398 | This service allows the caller enable or disable an AP from this point onward.\r |
| 399 | The caller can optionally specify the health status of the AP by Health. If\r |
| 400 | an AP is being disabled, then the state of the disabled AP is implementation\r |
| 401 | dependent. If an AP is enabled, then the implementation must guarantee that a\r |
| 402 | complete initialization sequence is performed on the AP, so the AP is in a state\r |
| 403 | that is compatible with an MP operating system. This service may not be supported\r |
| 404 | after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled.\r |
| 405 | \r |
| 406 | If the enable or disable AP operation cannot be completed prior to the return\r |
| 407 | from this service, then EFI_UNSUPPORTED must be returned.\r |
| 408 | \r |
| 409 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r |
| 410 | @param[in] ProcessorNumber The handle number of AP that is to become the new\r |
| 411 | BSP. The range is from 0 to the total number of\r |
| 412 | logical processors minus 1. The total number of\r |
| 413 | logical processors can be retrieved by\r |
| 414 | EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r |
| 415 | @param[in] EnableAP Specifies the new state for the processor for\r |
| 416 | enabled, FALSE for disabled.\r |
| 417 | @param[in] HealthFlag If not NULL, a pointer to a value that specifies\r |
| 418 | the new health status of the AP. This flag\r |
| 419 | corresponds to StatusFlag defined in\r |
| 420 | EFI_MP_SERVICES_PROTOCOL.GetProcessorInfo(). Only\r |
| 421 | the PROCESSOR_HEALTH_STATUS_BIT is used. All other\r |
| 422 | bits are ignored. If it is NULL, this parameter\r |
| 423 | is ignored.\r |
| 424 | \r |
| 425 | @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.\r |
| 426 | @retval EFI_UNSUPPORTED Enabling or disabling an AP cannot be completed\r |
| 427 | prior to this service returning.\r |
| 428 | @retval EFI_UNSUPPORTED Enabling or disabling an AP is not supported.\r |
| 429 | @retval EFI_DEVICE_ERROR The calling processor is an AP.\r |
| 430 | @retval EFI_NOT_FOUND Processor with the handle specified by ProcessorNumber\r |
| 431 | does not exist.\r |
| 432 | @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP.\r |
| 433 | \r |
| 434 | **/\r |
| 435 | EFI_STATUS\r |
| 436 | EFIAPI\r |
| 437 | EnableDisableAP (\r |
| 438 | IN EFI_MP_SERVICES_PROTOCOL *This,\r |
| 439 | IN UINTN ProcessorNumber,\r |
| 440 | IN BOOLEAN EnableAP,\r |
| 441 | IN UINT32 *HealthFlag OPTIONAL\r |
| 442 | );\r |
| 443 | \r |
| 444 | /**\r |
| 445 | This return the handle number for the calling processor. This service may be\r |
| 446 | called from the BSP and APs.\r |
| 447 | \r |
| 448 | This service returns the processor handle number for the calling processor.\r |
| 449 | The returned value is in the range from 0 to the total number of logical\r |
| 450 | processors minus 1. The total number of logical processors can be retrieved\r |
| 451 | with EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors(). This service may be\r |
| 452 | called from the BSP and APs. If ProcessorNumber is NULL, then EFI_INVALID_PARAMETER\r |
| 453 | is returned. Otherwise, the current processors handle number is returned in\r |
| 454 | ProcessorNumber, and EFI_SUCCESS is returned.\r |
| 455 | \r |
| 456 | @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r |
| 457 | @param[out] ProcessorNumber The handle number of AP that is to become the new\r |
| 458 | BSP. The range is from 0 to the total number of\r |
| 459 | logical processors minus 1. The total number of\r |
| 460 | logical processors can be retrieved by\r |
| 461 | EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r |
| 462 | \r |
| 463 | @retval EFI_SUCCESS The current processor handle number was returned\r |
| 464 | in ProcessorNumber.\r |
| 465 | @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.\r |
| 466 | \r |
| 467 | **/\r |
| 468 | EFI_STATUS\r |
| 469 | EFIAPI\r |
| 470 | WhoAmI (\r |
| 471 | IN EFI_MP_SERVICES_PROTOCOL *This,\r |
| 472 | OUT UINTN *ProcessorNumber\r |
| 473 | );\r |
| 474 | \r |
| 475 | #endif // _CPU_MP_H_\r |
| 476 | \r |