]>
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 | |
54 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
55 | OUT SCMI_PERFORMANCE_PROTOCOL_ATTRIBUTES *Attributes\r | |
56 | )\r | |
57 | {\r | |
58 | EFI_STATUS Status;\r | |
59 | UINT32* ReturnValues;\r | |
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 | |
93 | IN UINT32 DomainId,\r | |
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 | |
163 | UINT32* MessageParams;\r | |
164 | UINT32 LevelIndex;\r | |
165 | UINT32 RequiredSize;\r | |
166 | UINT32 LevelNo;\r | |
167 | UINT32 ReturnNumLevels;\r | |
168 | UINT32 ReturnRemainNumLevels;\r | |
169 | \r | |
170 | PERF_DESCRIBE_LEVELS *Levels;\r | |
171 | \r | |
172 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
173 | if (EFI_ERROR (Status)) {\r | |
174 | return Status;\r | |
175 | }\r | |
176 | \r | |
177 | LevelIndex = 0;\r | |
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 | |
186 | \r | |
187 | *MessageParams = LevelIndex;\r | |
188 | \r | |
189 | // Note, PayloadLength is an IN/OUT parameter.\r | |
190 | PayloadLength = sizeof (DomainId) + sizeof (LevelIndex);\r | |
191 | \r | |
192 | Status = ScmiCommandExecute (\r | |
193 | &Cmd,\r | |
194 | &PayloadLength,\r | |
195 | (UINT32**)&Levels\r | |
196 | );\r | |
197 | if (EFI_ERROR (Status)) {\r | |
198 | return Status;\r | |
199 | }\r | |
200 | \r | |
201 | ReturnNumLevels = NUM_PERF_LEVELS (Levels->NumLevels);\r | |
202 | ReturnRemainNumLevels = NUM_REMAIN_PERF_LEVELS (Levels->NumLevels);\r | |
203 | \r | |
204 | if (RequiredSize == 0) {\r | |
205 | *NumLevels = ReturnNumLevels + ReturnRemainNumLevels;\r | |
206 | \r | |
207 | RequiredSize = (*NumLevels) * sizeof (SCMI_PERFORMANCE_LEVEL);\r | |
208 | if (RequiredSize > (*LevelArraySize)) {\r | |
209 | // Update LevelArraySize with required size.\r | |
210 | *LevelArraySize = RequiredSize;\r | |
211 | return EFI_BUFFER_TOO_SMALL;\r | |
212 | }\r | |
213 | }\r | |
214 | \r | |
215 | for (LevelNo = 0; LevelNo < ReturnNumLevels; LevelNo++) {\r | |
216 | CopyMem (\r | |
217 | &LevelArray[LevelIndex++],\r | |
218 | &Levels->PerfLevel[LevelNo],\r | |
219 | sizeof (SCMI_PERFORMANCE_LEVEL)\r | |
220 | );\r | |
221 | }\r | |
222 | \r | |
223 | } while (ReturnRemainNumLevels != 0);\r | |
224 | \r | |
225 | *LevelArraySize = RequiredSize;\r | |
226 | \r | |
227 | return EFI_SUCCESS;\r | |
228 | }\r | |
229 | \r | |
230 | /** Set performance limits of a domain.\r | |
231 | \r | |
232 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
233 | @param[in] DomainId Identifier for the performance domain.\r | |
234 | @param[in] Limit Performance limit to set.\r | |
235 | \r | |
236 | @retval EFI_SUCCESS Performance limits set successfully.\r | |
237 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
238 | @retval !(EFI_SUCCESS) Other errors.\r | |
239 | **/\r | |
240 | EFI_STATUS\r | |
241 | PerformanceLimitsSet (\r | |
242 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
243 | IN UINT32 DomainId,\r | |
244 | IN SCMI_PERFORMANCE_LIMITS *Limits\r | |
245 | )\r | |
246 | {\r | |
247 | EFI_STATUS Status;\r | |
248 | UINT32 PayloadLength;\r | |
249 | SCMI_COMMAND Cmd;\r | |
250 | UINT32 *MessageParams;\r | |
251 | \r | |
252 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
253 | if (EFI_ERROR (Status)) {\r | |
254 | return Status;\r | |
255 | }\r | |
256 | \r | |
257 | *MessageParams++ = DomainId;\r | |
258 | *MessageParams++ = Limits->RangeMax;\r | |
259 | *MessageParams = Limits->RangeMin;\r | |
260 | \r | |
462f95ec | 261 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 262 | Cmd.MessageId = ScmiMessageIdPerformanceLimitsSet;\r |
4f2494cf GP |
263 | \r |
264 | PayloadLength = sizeof (DomainId) + sizeof (SCMI_PERFORMANCE_LIMITS);\r | |
265 | \r | |
266 | Status = ScmiCommandExecute (\r | |
267 | &Cmd,\r | |
268 | &PayloadLength,\r | |
269 | NULL\r | |
270 | );\r | |
271 | \r | |
272 | return Status;\r | |
273 | }\r | |
274 | \r | |
275 | /** Get performance limits of a domain.\r | |
276 | \r | |
277 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
278 | @param[in] DomainId Identifier for the performance domain.\r | |
279 | \r | |
280 | @param[out] Limit Performance Limits of the domain.\r | |
281 | \r | |
282 | @retval EFI_SUCCESS Performance limits are returned.\r | |
283 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
284 | @retval !(EFI_SUCCESS) Other errors.\r | |
285 | **/\r | |
286 | EFI_STATUS\r | |
287 | PerformanceLimitsGet (\r | |
288 | SCMI_PERFORMANCE_PROTOCOL *This,\r | |
289 | UINT32 DomainId,\r | |
290 | SCMI_PERFORMANCE_LIMITS *Limits\r | |
291 | )\r | |
292 | {\r | |
293 | EFI_STATUS Status;\r | |
294 | UINT32 PayloadLength;\r | |
295 | SCMI_COMMAND Cmd;\r | |
296 | UINT32 *MessageParams;\r | |
297 | \r | |
298 | SCMI_PERFORMANCE_LIMITS *ReturnValues;\r | |
299 | \r | |
300 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
301 | if (EFI_ERROR (Status)) {\r | |
302 | return Status;\r | |
303 | }\r | |
304 | \r | |
305 | *MessageParams = DomainId;\r | |
306 | \r | |
462f95ec | 307 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 308 | Cmd.MessageId = ScmiMessageIdPerformanceLimitsGet;\r |
4f2494cf GP |
309 | \r |
310 | PayloadLength = sizeof (DomainId);\r | |
311 | \r | |
312 | Status = ScmiCommandExecute (\r | |
313 | &Cmd,\r | |
314 | &PayloadLength,\r | |
315 | (UINT32**)&ReturnValues\r | |
316 | );\r | |
317 | if (EFI_ERROR (Status)) {\r | |
318 | return Status;\r | |
319 | }\r | |
320 | \r | |
321 | Limits->RangeMax = ReturnValues->RangeMax;\r | |
322 | Limits->RangeMin = ReturnValues->RangeMin;\r | |
323 | \r | |
324 | return EFI_SUCCESS;\r | |
325 | }\r | |
326 | \r | |
327 | /** Set performance level of a domain.\r | |
328 | \r | |
329 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
330 | @param[in] DomainId Identifier for the performance domain.\r | |
331 | @param[in] Level Performance level of the domain.\r | |
332 | \r | |
333 | @retval EFI_SUCCESS Performance level set successfully.\r | |
334 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
335 | @retval !(EFI_SUCCESS) Other errors.\r | |
336 | **/\r | |
337 | EFI_STATUS\r | |
338 | PerformanceLevelSet (\r | |
339 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
340 | IN UINT32 DomainId,\r | |
341 | IN UINT32 Level\r | |
342 | )\r | |
343 | {\r | |
344 | EFI_STATUS Status;\r | |
345 | UINT32 PayloadLength;\r | |
346 | SCMI_COMMAND Cmd;\r | |
347 | UINT32 *MessageParams;\r | |
348 | \r | |
349 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
350 | if (EFI_ERROR (Status)) {\r | |
351 | return Status;\r | |
352 | }\r | |
353 | \r | |
354 | *MessageParams++ = DomainId;\r | |
355 | *MessageParams = Level;\r | |
356 | \r | |
462f95ec | 357 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 358 | Cmd.MessageId = ScmiMessageIdPerformanceLevelSet;\r |
4f2494cf GP |
359 | \r |
360 | PayloadLength = sizeof (DomainId) + sizeof (Level);\r | |
361 | \r | |
362 | Status = ScmiCommandExecute (\r | |
363 | &Cmd,\r | |
364 | &PayloadLength,\r | |
365 | NULL\r | |
366 | );\r | |
367 | \r | |
368 | return Status;\r | |
369 | }\r | |
370 | \r | |
371 | /** Get performance level of a domain.\r | |
372 | \r | |
373 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
374 | @param[in] DomainId Identifier for the performance domain.\r | |
375 | \r | |
376 | @param[out] Level Performance level of the domain.\r | |
377 | \r | |
378 | @retval EFI_SUCCESS Performance level got successfully.\r | |
379 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
380 | @retval !(EFI_SUCCESS) Other errors.\r | |
381 | **/\r | |
382 | EFI_STATUS\r | |
383 | PerformanceLevelGet (\r | |
384 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
385 | IN UINT32 DomainId,\r | |
386 | OUT UINT32 *Level\r | |
387 | )\r | |
388 | {\r | |
389 | EFI_STATUS Status;\r | |
390 | UINT32 PayloadLength;\r | |
391 | SCMI_COMMAND Cmd;\r | |
392 | UINT32 *ReturnValues;\r | |
393 | UINT32 *MessageParams;\r | |
394 | \r | |
395 | Status = ScmiCommandGetPayload (&MessageParams);\r | |
396 | if (EFI_ERROR (Status)) {\r | |
397 | return Status;\r | |
398 | }\r | |
399 | \r | |
400 | *MessageParams = DomainId;\r | |
401 | \r | |
462f95ec | 402 | Cmd.ProtocolId = ScmiProtocolIdPerformance;\r |
96479947 | 403 | Cmd.MessageId = ScmiMessageIdPerformanceLevelGet;\r |
4f2494cf GP |
404 | \r |
405 | PayloadLength = sizeof (DomainId);\r | |
406 | \r | |
407 | Status = ScmiCommandExecute (\r | |
408 | &Cmd,\r | |
409 | &PayloadLength,\r | |
410 | &ReturnValues\r | |
411 | );\r | |
412 | if (EFI_ERROR (Status)) {\r | |
413 | return Status;\r | |
414 | }\r | |
415 | \r | |
416 | *Level = *ReturnValues;\r | |
417 | \r | |
418 | return EFI_SUCCESS;\r | |
419 | }\r | |
420 | \r | |
421 | // Instance of the SCMI performance management protocol.\r | |
422 | STATIC CONST SCMI_PERFORMANCE_PROTOCOL PerformanceProtocol = {\r | |
423 | PerformanceGetVersion,\r | |
424 | PerformanceGetAttributes,\r | |
425 | PerformanceDomainAttributes,\r | |
426 | PerformanceDescribeLevels,\r | |
427 | PerformanceLimitsSet,\r | |
428 | PerformanceLimitsGet,\r | |
429 | PerformanceLevelSet,\r | |
430 | PerformanceLevelGet\r | |
431 | };\r | |
432 | \r | |
433 | /** Initialize performance management protocol and install on a given Handle.\r | |
434 | \r | |
435 | @param[in] Handle Handle to install performance management\r | |
436 | protocol.\r | |
437 | \r | |
438 | @retval EFI_SUCCESS Performance protocol installed successfully.\r | |
439 | **/\r | |
440 | EFI_STATUS\r | |
441 | ScmiPerformanceProtocolInit (\r | |
442 | IN EFI_HANDLE* Handle\r | |
443 | )\r | |
444 | {\r | |
445 | return gBS->InstallMultipleProtocolInterfaces (\r | |
446 | Handle,\r | |
447 | &gArmScmiPerformanceProtocolGuid,\r | |
448 | &PerformanceProtocol,\r | |
449 | NULL\r | |
450 | );\r | |
451 | }\r |