]>
Commit | Line | Data |
---|---|---|
887810c8 JF |
1 | /** @file |
2 | Functions prototype of Multiple Processor PPI services. | |
3 | ||
4 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR> | |
5 | This program and the accompanying materials | |
6 | are licensed and made available under the terms and conditions of the BSD License | |
7 | which accompanies this distribution. The full text of the license may be found at | |
8 | http://opensource.org/licenses/bsd-license.php | |
9 | ||
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
12 | ||
13 | **/ | |
14 | ||
15 | #ifndef _PEI_MP_SERVICES_H_ | |
16 | #define _PEI_MP_SERVICES_H_ | |
17 | ||
18 | #include "CpuMpPei.h" | |
19 | ||
20 | ||
21 | /** | |
22 | This return the handle number for the calling processor. This service may be | |
23 | called from the BSP and APs. | |
24 | ||
25 | This service returns the processor handle number for the calling processor. | |
26 | The returned value is in the range from 0 to the total number of logical | |
27 | processors minus 1. The total number of logical processors can be retrieved | |
28 | with EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors(). This service may be | |
29 | called from the BSP and APs. If ProcessorNumber is NULL, then EFI_INVALID_PARAMETER | |
30 | is returned. Otherwise, the current processors handle number is returned in | |
31 | ProcessorNumber, and EFI_SUCCESS is returned. | |
32 | ||
33 | @param[in] PeiServices An indirect pointer to the PEI Services Table | |
34 | published by the PEI Foundation. | |
35 | @param[in] This A pointer to the EFI_PEI_MP_SERVICES_PPI instance. | |
36 | @param[out] ProcessorNumber The handle number of the AP. The range is from 0 to the | |
37 | total number of logical processors minus 1. The total | |
38 | number of logical processors can be retrieved by | |
39 | EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors(). | |
40 | ||
41 | @retval EFI_SUCCESS The current processor handle number was returned in | |
42 | ProcessorNumber. | |
43 | @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL. | |
44 | **/ | |
45 | EFI_STATUS | |
46 | EFIAPI | |
47 | PeiWhoAmI ( | |
48 | IN CONST EFI_PEI_SERVICES **PeiServices, | |
49 | IN EFI_PEI_MP_SERVICES_PPI *This, | |
50 | OUT UINTN *ProcessorNumber | |
51 | ); | |
52 | ||
53 | #endif |