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
|
/** @file
some definitions for PI MP services Protocol.
@copyright
Copyright (c) 2011 - 2012 Intel Corporation. All rights reserved
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
This file contains an 'Intel Peripheral Driver' and is
licensed for Intel CPUs and chipsets under the terms of your
license agreement with Intel or your vendor. This file may
be modified by the user, subject to additional terms of the
license agreement
**/
#ifndef _PI_MP_SERVICE_H_
#define _PI_MP_SERVICE_H_
#include "MpService.h"
///
/// Driver Produced Protocol.
///
#include EFI_PROTOCOL_PRODUCER (PiMpService)
/**
Implementation of GetNumberOfProcessors() service of MP Services Protocol.
This service retrieves the number of logical processor in the platform
and the number of those logical processors that are enabled on this boot.
This service may only be called from the BSP.
@param[in] This - A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
@param[in] NumberOfProcessors - Pointer to the total number of logical processors in the system,
including the BSP and disabled APs.
@param[in] NumberOfEnabledProcessors - Pointer to the number of enabled logical processors that exist
in system, including the BSP.
@retval EFI_SUCCESS - Number of logical processors and enabled logical processors retrieved..
@retval EFI_DEVICE_ERROR - Caller processor is AP.
@retval EFI_INVALID_PARAMETER - NumberOfProcessors is NULL.
@retval EFI_INVALID_PARAMETER - NumberOfEnabledProcessors is NULL.
**/
EFI_STATUS
EFIAPI
GetNumberOfProcessors (
IN EFI_PI_MP_SERVICES_PROTOCOL *This,
OUT UINTN *NumberOfProcessors,
OUT UINTN *NumberOfEnabledProcessors
);
/**
Implementation of GetNumberOfProcessors() service of MP Services Protocol.
Gets detailed MP-related information on the requested processor at the
instant this call is made. This service may only be called from the BSP.
@param[in] This - A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
@param[in] ProcessorNumber - The handle number of processor.
@param[in] ProcessorInfoBuffer - A pointer to the buffer where information for the requested processor is deposited.
@retval EFI_SUCCESS - Processor information successfully returned.
@retval EFI_DEVICE_ERROR - Caller processor is AP.
@retval EFI_INVALID_PARAMETER - ProcessorInfoBuffer is NULL
@retval EFI_NOT_FOUND - Processor with the handle specified by ProcessorNumber does not exist.
**/
EFI_STATUS
EFIAPI
GetProcessorInfo (
IN EFI_PI_MP_SERVICES_PROTOCOL *This,
IN UINTN ProcessorNumber,
OUT EFI_PROCESSOR_INFORMATION *ProcessorInfoBuffer
);
/**
Implementation of StartupThisAP() service of MP Services Protocol.
This service lets the caller get one enabled AP to execute a caller-provided function.
This service may only be called from the BSP.
@param[in] This - A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
@param[in] Procedure - A pointer to the function to be run on the designated AP.
@param[in] ProcessorNumber - The handle number of AP..
@param[in] WaitEvent - The event created by the caller.
If it is NULL, then execute in blocking mode.
If it is not NULL, then execute in non-blocking mode.
@param[in] TimeoutInMicroseconds - The time limit in microseconds for this AP to finish the function.
Zero means infinity.
@param[in] ProcedureArgument - Pointer to the optional parameter of the assigned function.
@param[in] Finished - Indicates whether AP has finished assigned function.
In blocking mode, it is ignored.
@retval EFI_SUCCESS - In blocking mode, specified AP has finished before the timeout expires.
@retval EFI_SUCCESS - In non-blocking mode, function has been dispatched to specified AP.
@retval EFI_DEVICE_ERROR - Caller processor is AP.
@retval EFI_TIMEOUT - In blocking mode, the timeout expires before specified AP has finished.
@retval EFI_NOT_READY - Specified AP is busy.
@retval EFI_NOT_FOUND - Processor with the handle specified by ProcessorNumber does not exist.
@retval EFI_INVALID_PARAMETER - ProcessorNumber specifies the BSP or disabled AP.
@retval EFI_INVALID_PARAMETER - Procedure is NULL.
**/
EFI_STATUS
EFIAPI
PiStartupThisAP (
IN EFI_PI_MP_SERVICES_PROTOCOL *This,
IN EFI_AP_PROCEDURE Procedure,
IN UINTN ProcessorNumber,
IN EFI_EVENT WaitEvent OPTIONAL,
IN UINTN TimeoutInMicroseconds,
IN VOID *ProcedureArgument OPTIONAL,
OUT BOOLEAN *Finished OPTIONAL
);
/**
Implementation of StartupAllAPs() service of MP Services Protocol.
This service lets the caller get all enabled APs to execute a caller-provided function.
This service may only be called from the BSP.
@param[in] This - A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
@param[in] Procedure - A pointer to the function to be run on enabled APs of the system.
@param[in] SingleThread - Indicates whether to execute the function simultaneously or one by one..
@param[in] WaitEvent - The event created by the caller.
If it is NULL, then execute in blocking mode.
If it is not NULL, then execute in non-blocking mode.
@param[in] TimeoutInMicroSeconds - The time limit in microseconds for this AP to finish the function.
Zero means infinity.
@param[in] ProcedureArgument - Pointer to the optional parameter of the assigned function.
@param[in] FailedCpuList - The list of processor numbers that fail to finish the function before
TimeoutInMicrosecsond expires.
@retval EFI_SUCCESS - In blocking mode, all APs have finished before the timeout expired.
@retval EFI_SUCCESS - In non-blocking mode, function has been dispatched to all enabled APs.
@retval EFI_DEVICE_ERROR - Caller processor is AP.
@retval EFI_NOT_STARTED - No enabled AP exists in the system.
@retval EFI_NOT_READY - Any enabled AP is busy.
@retval EFI_TIMEOUT - In blocking mode, The timeout expired before all enabled APs have finished.
@retval EFI_INVALID_PARAMETER - Procedure is NULL.
**/
EFI_STATUS
EFIAPI
PiStartupAllAPs (
IN EFI_PI_MP_SERVICES_PROTOCOL *This,
IN EFI_AP_PROCEDURE Procedure,
IN BOOLEAN SingleThread,
IN EFI_EVENT WaitEvent OPTIONAL,
IN UINTN TimeoutInMicroSeconds,
IN VOID *ProcedureArgument OPTIONAL,
OUT UINTN **FailedCpuList OPTIONAL
);
/**
Implementation of SwitchBSP() service of MP Services Protocol.
This service switches the requested AP to be the BSP from that point onward.
This service may only be called from the current BSP.
@param[in] This - A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
@param[in] ProcessorNumber - The handle number of processor.
@param[in] EnableOldBSP - Whether to enable or disable the original BSP.
@retval EFI_SUCCESS - BSP successfully switched.
@retval EFI_DEVICE_ERROR - Caller processor is AP.
@retval EFI_NOT_FOUND - Processor with the handle specified by ProcessorNumber does not exist.
@retval EFI_INVALID_PARAMETER - ProcessorNumber specifies the BSP or disabled AP.
@retval EFI_NOT_READY - Specified AP is busy.
**/
EFI_STATUS
EFIAPI
PiSwitchBSP (
IN EFI_PI_MP_SERVICES_PROTOCOL *This,
IN UINTN ProcessorNumber,
IN BOOLEAN EnableOldBSP
);
/**
Implementation of EnableDisableAP() service of MP Services Protocol.
This service lets the caller enable or disable an AP.
This service may only be called from the BSP.
@param[in] This - A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
@param[in] ProcessorNumber - The handle number of processor.
@param[in] EnableAP - Indicates whether the newstate of the AP is enabled or disabled.
@param[in] HealthFlag - Indicates new health state of the AP..
@retval EFI_SUCCESS - AP successfully enabled or disabled.
@retval EFI_DEVICE_ERROR - Caller processor is AP.
@retval EFI_NOT_FOUND - Processor with the handle specified by ProcessorNumber does not exist.
@retval EFI_INVALID_PARAMETERS - ProcessorNumber specifies the BSP.
**/
EFI_STATUS
EFIAPI
PiEnableDisableAP (
IN EFI_PI_MP_SERVICES_PROTOCOL *This,
IN UINTN ProcessorNumber,
IN BOOLEAN EnableAP,
IN UINT32 *HealthFlag OPTIONAL
);
/**
Implementation of WhoAmI() service of MP Services Protocol.
This service lets the caller processor get its handle number.
This service may be called from the BSP and APs.
@param[in] This - A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
@param[in] ProcessorNumber - Pointer to the handle number of AP.
@retval EFI_SUCCESS - Processor number successfully returned.
@retval EFI_INVALID_PARAMETER - ProcessorNumber is NULL
**/
EFI_STATUS
EFIAPI
PiWhoAmI (
IN EFI_PI_MP_SERVICES_PROTOCOL *This,
OUT UINTN *ProcessorNumber
);
/**
Checks APs' status periodically.
This function is triggerred by timer perodically to check the
state of APs for StartupAllAPs() and StartupThisAP() executed
in non-blocking mode.
@param[in] Event - Event triggered.
@param[in] Context - Parameter passed with the event.
**/
VOID
EFIAPI
CheckAPsStatus (
IN EFI_EVENT Event,
IN VOID *Context
);
#endif
|
