]>
Commit | Line | Data |
---|---|---|
4f2494cf GP |
1 | /** @file\r |
2 | \r | |
462f95ec | 3 | Copyright (c) 2017-2021, Arm Limited. All rights reserved.<BR>\r |
4f2494cf | 4 | \r |
4059386c | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
4f2494cf GP |
6 | \r |
7 | System Control and Management Interface V1.0\r | |
8 | http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/\r | |
9 | DEN0056A_System_Control_and_Management_Interface.pdf\r | |
10 | **/\r | |
11 | \r | |
12 | #include <Library/BaseMemoryLib.h>\r | |
13 | #include <Library/UefiBootServicesTableLib.h>\r | |
14 | #include <Protocol/ArmScmiPerformanceProtocol.h>\r | |
15 | \r | |
16 | #include "ArmScmiPerformanceProtocolPrivate.h"\r | |
17 | #include "ScmiPrivate.h"\r | |
18 | \r | |
19 | /** Return version of the performance management protocol supported by SCP.\r | |
20 | firmware.\r | |
21 | \r | |
22 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
23 | \r | |
24 | @param[out] Version Version of the supported SCMI performance management\r | |
25 | protocol.\r | |
26 | \r | |
27 | @retval EFI_SUCCESS The version is returned.\r | |
28 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
29 | @retval !(EFI_SUCCESS) Other errors.\r | |
30 | **/\r | |
31 | STATIC\r | |
32 | EFI_STATUS\r | |
33 | PerformanceGetVersion (\r | |
34 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
35 | OUT UINT32 *Version\r | |
36 | )\r | |
37 | {\r | |
462f95ec | 38 | return ScmiGetProtocolVersion (ScmiProtocolIdPerformance, Version);\r |
4f2494cf GP |
39 | }\r |
40 | \r | |
41 | /** Return protocol attributes of the performance management protocol.\r | |
42 | \r | |
43 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
44 | \r | |
45 | @param[out] Attributes Protocol attributes.\r | |
46 | \r | |
47 | @retval EFI_SUCCESS Protocol attributes are returned.\r | |
48 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
49 | @retval !(EFI_SUCCESS) Other errors.\r | |
50 | **/\r | |
51 | STATIC\r | |
52 | EFI_STATUS\r | |
53 | PerformanceGetAttributes (\r | |
429309e0 MK |
54 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r |
55 | OUT SCMI_PERFORMANCE_PROTOCOL_ATTRIBUTES *Attributes\r | |
4f2494cf GP |
56 | )\r |
57 | {\r | |
58 | EFI_STATUS Status;\r | |
429309e0 | 59 | UINT32 *ReturnValues;\r |
4f2494cf GP |
60 | \r |
61 | Status = ScmiGetProtocolAttributes (\r | |
462f95ec | 62 | ScmiProtocolIdPerformance,\r |
4f2494cf GP |
63 | &ReturnValues\r |
64 | );\r | |
65 | if (EFI_ERROR (Status)) {\r | |
66 | return Status;\r | |
67 | }\r | |
68 | \r | |
69 | CopyMem (\r | |
70 | Attributes,\r | |
71 | ReturnValues,\r | |
72 | sizeof (SCMI_PERFORMANCE_PROTOCOL_ATTRIBUTES)\r | |
73 | );\r | |
74 | \r | |
75 | return EFI_SUCCESS;\r | |
76 | }\r | |
77 | \r | |
78 | /** Return performance domain attributes.\r | |
79 | \r | |
80 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
81 | @param[in] DomainId Identifier for the performance domain.\r | |
82 | \r | |
83 | @param[out] Attributes Performance domain attributes.\r | |
84 | \r | |
85 | @retval EFI_SUCCESS Domain attributes are returned.\r | |
86 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
87 | @retval !(EFI_SUCCESS) Other errors.\r | |
88 | **/\r | |
89 | STATIC\r | |
90 | EFI_STATUS\r | |
91 | PerformanceDomainAttributes (\r | |
92 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
429309e0 | 93 | IN UINT32 DomainId,\r |
4f2494cf GP |
94 | OUT SCMI_PERFORMANCE_DOMAIN_ATTRIBUTES *DomainAttributes\r |
95 | )\r | |
96 | {\r | |
97 | EFI_STATUS Status;\r | |
98 | UINT32 *MessageParams;\r | |
99 | UINT32 *ReturnValues;\r | |
100 | UINT32 PayloadLength;\r | |
101 | SCMI_COMMAND Cmd;\r | |
102 | \r | |
103 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
104 | if (EFI_ERROR (Status)) {\r | |
105 | return Status;\r | |
106 | }\r | |
107 | \r | |
108 | *MessageParams = DomainId;\r | |
109 | \r | |
462f95ec | 110 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 111 | Cmd.MessageId = ScmiMessageIdPerformanceDomainAttributes;\r |
4f2494cf GP |
112 | \r |
113 | PayloadLength = sizeof (DomainId);\r | |
114 | \r | |
115 | Status = ScmiCommandExecute (\r | |
116 | &Cmd,\r | |
117 | &PayloadLength,\r | |
118 | &ReturnValues\r | |
119 | );\r | |
120 | if (EFI_ERROR (Status)) {\r | |
121 | return Status;\r | |
122 | }\r | |
123 | \r | |
124 | CopyMem (\r | |
125 | DomainAttributes,\r | |
126 | ReturnValues,\r | |
127 | sizeof (SCMI_PERFORMANCE_DOMAIN_ATTRIBUTES)\r | |
128 | );\r | |
129 | \r | |
130 | return EFI_SUCCESS;\r | |
131 | }\r | |
132 | \r | |
133 | /** Return list of performance domain levels of a given domain.\r | |
134 | \r | |
135 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
136 | @param[in] DomainId Identifier for the performance domain.\r | |
137 | \r | |
138 | @param[out] NumLevels Total number of levels a domain can support.\r | |
139 | \r | |
140 | @param[in,out] LevelArraySize Size of the performance level array.\r | |
141 | \r | |
142 | @param[out] LevelArray Array of the performance levels.\r | |
143 | \r | |
144 | @retval EFI_SUCCESS Domain levels are returned.\r | |
145 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
146 | @retval EFI_BUFFER_TOO_SMALL LevelArraySize is too small for the result.\r | |
147 | It has been updated to the size needed.\r | |
148 | @retval !(EFI_SUCCESS) Other errors.\r | |
149 | **/\r | |
150 | STATIC\r | |
151 | EFI_STATUS\r | |
152 | PerformanceDescribeLevels (\r | |
153 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
154 | IN UINT32 DomainId,\r | |
155 | OUT UINT32 *NumLevels,\r | |
156 | IN OUT UINT32 *LevelArraySize,\r | |
157 | OUT SCMI_PERFORMANCE_LEVEL *LevelArray\r | |
158 | )\r | |
159 | {\r | |
160 | EFI_STATUS Status;\r | |
161 | UINT32 PayloadLength;\r | |
162 | SCMI_COMMAND Cmd;\r | |
429309e0 | 163 | UINT32 *MessageParams;\r |
4f2494cf GP |
164 | UINT32 LevelIndex;\r |
165 | UINT32 RequiredSize;\r | |
166 | UINT32 LevelNo;\r | |
167 | UINT32 ReturnNumLevels;\r | |
168 | UINT32 ReturnRemainNumLevels;\r | |
169 | \r | |
429309e0 | 170 | PERF_DESCRIBE_LEVELS *Levels;\r |
4f2494cf GP |
171 | \r |
172 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
173 | if (EFI_ERROR (Status)) {\r | |
174 | return Status;\r | |
175 | }\r | |
176 | \r | |
429309e0 | 177 | LevelIndex = 0;\r |
4f2494cf GP |
178 | RequiredSize = 0;\r |
179 | \r | |
180 | *MessageParams++ = DomainId;\r | |
181 | \r | |
462f95ec | 182 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 183 | Cmd.MessageId = ScmiMessageIdPerformanceDescribeLevels;\r |
4f2494cf GP |
184 | \r |
185 | do {\r | |
4f2494cf GP |
186 | *MessageParams = LevelIndex;\r |
187 | \r | |
188 | // Note, PayloadLength is an IN/OUT parameter.\r | |
189 | PayloadLength = sizeof (DomainId) + sizeof (LevelIndex);\r | |
190 | \r | |
191 | Status = ScmiCommandExecute (\r | |
192 | &Cmd,\r | |
193 | &PayloadLength,\r | |
429309e0 | 194 | (UINT32 **)&Levels\r |
4f2494cf GP |
195 | );\r |
196 | if (EFI_ERROR (Status)) {\r | |
197 | return Status;\r | |
198 | }\r | |
199 | \r | |
429309e0 | 200 | ReturnNumLevels = NUM_PERF_LEVELS (Levels->NumLevels);\r |
4f2494cf GP |
201 | ReturnRemainNumLevels = NUM_REMAIN_PERF_LEVELS (Levels->NumLevels);\r |
202 | \r | |
203 | if (RequiredSize == 0) {\r | |
204 | *NumLevels = ReturnNumLevels + ReturnRemainNumLevels;\r | |
205 | \r | |
206 | RequiredSize = (*NumLevels) * sizeof (SCMI_PERFORMANCE_LEVEL);\r | |
207 | if (RequiredSize > (*LevelArraySize)) {\r | |
208 | // Update LevelArraySize with required size.\r | |
209 | *LevelArraySize = RequiredSize;\r | |
210 | return EFI_BUFFER_TOO_SMALL;\r | |
211 | }\r | |
212 | }\r | |
213 | \r | |
214 | for (LevelNo = 0; LevelNo < ReturnNumLevels; LevelNo++) {\r | |
429309e0 MK |
215 | CopyMem (\r |
216 | &LevelArray[LevelIndex++],\r | |
217 | &Levels->PerfLevel[LevelNo],\r | |
218 | sizeof (SCMI_PERFORMANCE_LEVEL)\r | |
219 | );\r | |
4f2494cf | 220 | }\r |
4f2494cf GP |
221 | } while (ReturnRemainNumLevels != 0);\r |
222 | \r | |
223 | *LevelArraySize = RequiredSize;\r | |
224 | \r | |
225 | return EFI_SUCCESS;\r | |
226 | }\r | |
227 | \r | |
228 | /** Set performance limits of a domain.\r | |
229 | \r | |
230 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
231 | @param[in] DomainId Identifier for the performance domain.\r | |
232 | @param[in] Limit Performance limit to set.\r | |
233 | \r | |
234 | @retval EFI_SUCCESS Performance limits set successfully.\r | |
235 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
236 | @retval !(EFI_SUCCESS) Other errors.\r | |
237 | **/\r | |
238 | EFI_STATUS\r | |
239 | PerformanceLimitsSet (\r | |
429309e0 MK |
240 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r |
241 | IN UINT32 DomainId,\r | |
242 | IN SCMI_PERFORMANCE_LIMITS *Limits\r | |
4f2494cf GP |
243 | )\r |
244 | {\r | |
245 | EFI_STATUS Status;\r | |
246 | UINT32 PayloadLength;\r | |
247 | SCMI_COMMAND Cmd;\r | |
248 | UINT32 *MessageParams;\r | |
249 | \r | |
250 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
251 | if (EFI_ERROR (Status)) {\r | |
252 | return Status;\r | |
253 | }\r | |
254 | \r | |
255 | *MessageParams++ = DomainId;\r | |
256 | *MessageParams++ = Limits->RangeMax;\r | |
257 | *MessageParams = Limits->RangeMin;\r | |
258 | \r | |
462f95ec | 259 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 260 | Cmd.MessageId = ScmiMessageIdPerformanceLimitsSet;\r |
4f2494cf GP |
261 | \r |
262 | PayloadLength = sizeof (DomainId) + sizeof (SCMI_PERFORMANCE_LIMITS);\r | |
263 | \r | |
264 | Status = ScmiCommandExecute (\r | |
265 | &Cmd,\r | |
266 | &PayloadLength,\r | |
267 | NULL\r | |
268 | );\r | |
269 | \r | |
270 | return Status;\r | |
271 | }\r | |
272 | \r | |
273 | /** Get performance limits of a domain.\r | |
274 | \r | |
275 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
276 | @param[in] DomainId Identifier for the performance domain.\r | |
277 | \r | |
278 | @param[out] Limit Performance Limits of the domain.\r | |
279 | \r | |
280 | @retval EFI_SUCCESS Performance limits are returned.\r | |
281 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
282 | @retval !(EFI_SUCCESS) Other errors.\r | |
283 | **/\r | |
284 | EFI_STATUS\r | |
285 | PerformanceLimitsGet (\r | |
429309e0 MK |
286 | SCMI_PERFORMANCE_PROTOCOL *This,\r |
287 | UINT32 DomainId,\r | |
288 | SCMI_PERFORMANCE_LIMITS *Limits\r | |
4f2494cf GP |
289 | )\r |
290 | {\r | |
291 | EFI_STATUS Status;\r | |
292 | UINT32 PayloadLength;\r | |
293 | SCMI_COMMAND Cmd;\r | |
294 | UINT32 *MessageParams;\r | |
295 | \r | |
296 | SCMI_PERFORMANCE_LIMITS *ReturnValues;\r | |
297 | \r | |
298 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
299 | if (EFI_ERROR (Status)) {\r | |
300 | return Status;\r | |
301 | }\r | |
302 | \r | |
303 | *MessageParams = DomainId;\r | |
304 | \r | |
462f95ec | 305 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 306 | Cmd.MessageId = ScmiMessageIdPerformanceLimitsGet;\r |
4f2494cf GP |
307 | \r |
308 | PayloadLength = sizeof (DomainId);\r | |
309 | \r | |
310 | Status = ScmiCommandExecute (\r | |
311 | &Cmd,\r | |
312 | &PayloadLength,\r | |
429309e0 | 313 | (UINT32 **)&ReturnValues\r |
4f2494cf GP |
314 | );\r |
315 | if (EFI_ERROR (Status)) {\r | |
316 | return Status;\r | |
317 | }\r | |
318 | \r | |
319 | Limits->RangeMax = ReturnValues->RangeMax;\r | |
320 | Limits->RangeMin = ReturnValues->RangeMin;\r | |
321 | \r | |
322 | return EFI_SUCCESS;\r | |
323 | }\r | |
324 | \r | |
325 | /** Set performance level of a domain.\r | |
326 | \r | |
327 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
328 | @param[in] DomainId Identifier for the performance domain.\r | |
329 | @param[in] Level Performance level of the domain.\r | |
330 | \r | |
331 | @retval EFI_SUCCESS Performance level set successfully.\r | |
332 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
333 | @retval !(EFI_SUCCESS) Other errors.\r | |
334 | **/\r | |
335 | EFI_STATUS\r | |
336 | PerformanceLevelSet (\r | |
429309e0 MK |
337 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r |
338 | IN UINT32 DomainId,\r | |
339 | IN UINT32 Level\r | |
4f2494cf GP |
340 | )\r |
341 | {\r | |
342 | EFI_STATUS Status;\r | |
343 | UINT32 PayloadLength;\r | |
344 | SCMI_COMMAND Cmd;\r | |
345 | UINT32 *MessageParams;\r | |
346 | \r | |
347 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
348 | if (EFI_ERROR (Status)) {\r | |
349 | return Status;\r | |
350 | }\r | |
351 | \r | |
352 | *MessageParams++ = DomainId;\r | |
353 | *MessageParams = Level;\r | |
354 | \r | |
462f95ec | 355 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 356 | Cmd.MessageId = ScmiMessageIdPerformanceLevelSet;\r |
4f2494cf GP |
357 | \r |
358 | PayloadLength = sizeof (DomainId) + sizeof (Level);\r | |
359 | \r | |
360 | Status = ScmiCommandExecute (\r | |
361 | &Cmd,\r | |
362 | &PayloadLength,\r | |
363 | NULL\r | |
364 | );\r | |
365 | \r | |
366 | return Status;\r | |
367 | }\r | |
368 | \r | |
369 | /** Get performance level of a domain.\r | |
370 | \r | |
371 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
372 | @param[in] DomainId Identifier for the performance domain.\r | |
373 | \r | |
374 | @param[out] Level Performance level of the domain.\r | |
375 | \r | |
376 | @retval EFI_SUCCESS Performance level got successfully.\r | |
377 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
378 | @retval !(EFI_SUCCESS) Other errors.\r | |
379 | **/\r | |
380 | EFI_STATUS\r | |
381 | PerformanceLevelGet (\r | |
429309e0 MK |
382 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r |
383 | IN UINT32 DomainId,\r | |
384 | OUT UINT32 *Level\r | |
4f2494cf GP |
385 | )\r |
386 | {\r | |
387 | EFI_STATUS Status;\r | |
388 | UINT32 PayloadLength;\r | |
389 | SCMI_COMMAND Cmd;\r | |
390 | UINT32 *ReturnValues;\r | |
391 | UINT32 *MessageParams;\r | |
392 | \r | |
393 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
394 | if (EFI_ERROR (Status)) {\r | |
395 | return Status;\r | |
396 | }\r | |
397 | \r | |
398 | *MessageParams = DomainId;\r | |
399 | \r | |
462f95ec | 400 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 401 | Cmd.MessageId = ScmiMessageIdPerformanceLevelGet;\r |
4f2494cf GP |
402 | \r |
403 | PayloadLength = sizeof (DomainId);\r | |
404 | \r | |
405 | Status = ScmiCommandExecute (\r | |
406 | &Cmd,\r | |
407 | &PayloadLength,\r | |
408 | &ReturnValues\r | |
409 | );\r | |
410 | if (EFI_ERROR (Status)) {\r | |
411 | return Status;\r | |
412 | }\r | |
413 | \r | |
414 | *Level = *ReturnValues;\r | |
415 | \r | |
416 | return EFI_SUCCESS;\r | |
417 | }\r | |
418 | \r | |
419 | // Instance of the SCMI performance management protocol.\r | |
429309e0 | 420 | STATIC CONST SCMI_PERFORMANCE_PROTOCOL PerformanceProtocol = {\r |
4f2494cf GP |
421 | PerformanceGetVersion,\r |
422 | PerformanceGetAttributes,\r | |
423 | PerformanceDomainAttributes,\r | |
424 | PerformanceDescribeLevels,\r | |
425 | PerformanceLimitsSet,\r | |
426 | PerformanceLimitsGet,\r | |
427 | PerformanceLevelSet,\r | |
428 | PerformanceLevelGet\r | |
429 | };\r | |
430 | \r | |
431 | /** Initialize performance management protocol and install on a given Handle.\r | |
432 | \r | |
433 | @param[in] Handle Handle to install performance management\r | |
434 | protocol.\r | |
435 | \r | |
436 | @retval EFI_SUCCESS Performance protocol installed successfully.\r | |
437 | **/\r | |
438 | EFI_STATUS\r | |
439 | ScmiPerformanceProtocolInit (\r | |
429309e0 | 440 | IN EFI_HANDLE *Handle\r |
4f2494cf GP |
441 | )\r |
442 | {\r | |
443 | return gBS->InstallMultipleProtocolInterfaces (\r | |
444 | Handle,\r | |
445 | &gArmScmiPerformanceProtocolGuid,\r | |
446 | &PerformanceProtocol,\r | |
447 | NULL\r | |
448 | );\r | |
449 | }\r |