ScmiPerformanceProtocol.c 12 KB

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