]>
Commit | Line | Data |
---|---|---|
4f2494cf GP |
1 | /** @file\r |
2 | \r | |
3 | Copyright (c) 2017-2018, Arm Limited. All rights reserved.\r | |
4 | \r | |
5 | This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | System Control and Management Interface V1.0\r | |
14 | http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/\r | |
15 | DEN0056A_System_Control_and_Management_Interface.pdf\r | |
16 | **/\r | |
17 | \r | |
18 | #ifndef ARM_SCMI_PERFORMANCE_PROTOCOL_H_\r | |
19 | #define ARM_SCMI_PERFORMANCE_PROTOCOL_H_\r | |
20 | \r | |
21 | #include <Protocol/ArmScmi.h>\r | |
22 | \r | |
23 | #define PERFORMANCE_PROTOCOL_VERSION 0x10000\r | |
24 | \r | |
25 | #define ARM_SCMI_PERFORMANCE_PROTOCOL_GUID { \\r | |
26 | 0x9b8ba84, 0x3dd3, 0x49a6, {0xa0, 0x5a, 0x31, 0x34, 0xa5, 0xf0, 0x7b, 0xad} \\r | |
27 | }\r | |
28 | \r | |
29 | extern EFI_GUID gArmScmiPerformanceProtocolGuid;\r | |
30 | \r | |
31 | typedef struct _SCMI_PERFORMANCE_PROTOCOL SCMI_PERFORMANCE_PROTOCOL;\r | |
32 | \r | |
33 | #pragma pack(1)\r | |
34 | \r | |
35 | #define POWER_IN_MW_SHIFT 16\r | |
36 | #define POWER_IN_MW_MASK 0x1\r | |
37 | #define NUM_PERF_DOMAINS_MASK 0xFFFF\r | |
38 | \r | |
39 | // Total number of performance domains, Attr Bits [15:0]\r | |
40 | #define SCMI_PERF_TOTAL_DOMAINS(Attr) (Attr & NUM_PERF_DOMAINS_MASK)\r | |
41 | \r | |
42 | // A flag to express power values in mW or platform specific way, Attr Bit [16]\r | |
43 | #define SCMI_PERF_POWER_IN_MW(Attr) ((Attr >> POWER_IN_MW_SHIFT) & \\r | |
44 | POWER_IN_MW_MASK)\r | |
45 | \r | |
46 | // Performance protocol attributes return values.\r | |
47 | typedef struct {\r | |
48 | UINT32 Attributes;\r | |
49 | UINT64 StatisticsAddress;\r | |
50 | UINT32 StatisticsLen;\r | |
51 | } SCMI_PERFORMANCE_PROTOCOL_ATTRIBUTES;\r | |
52 | \r | |
53 | #define SCMI_PERF_SUPPORT_LVL_CHANGE_NOTIFY(Attr) ((Attr >> 28) & 0x1)\r | |
54 | #define SCMI_PERF_SUPPORT_LIM_CHANGE_NOTIFY(Attr) ((Attr >> 29) & 0x1)\r | |
55 | #define SCMI_PERF_SUPPORT_SET_LVL(Attr) ((Attr >> 30) & 0x1)\r | |
56 | #define SCMI_PERF_SUPPORT_SET_LIM(Attr) ((Attr >> 31) & 0x1)\r | |
57 | #define SCMI_PERF_RATE_LIMIT(RateLimit) (RateLimit & 0xFFF)\r | |
58 | \r | |
59 | // Performance protocol domain attributes.\r | |
60 | typedef struct {\r | |
61 | UINT32 Attributes;\r | |
62 | UINT32 RateLimit;\r | |
63 | UINT32 SustainedFreq;\r | |
64 | UINT32 SustainedPerfLevel;\r | |
65 | UINT8 Name[SCMI_MAX_STR_LEN];\r | |
66 | } SCMI_PERFORMANCE_DOMAIN_ATTRIBUTES;\r | |
67 | \r | |
68 | // Worst case latency in microseconds, Bits[15:0]\r | |
69 | #define PERF_LATENCY_MASK 0xFFFF\r | |
70 | #define SCMI_PERFORMANCE_PROTOCOL_LATENCY(Latency) (Latency & PERF_LATENCY_MASK)\r | |
71 | \r | |
72 | // Performance protocol performance level.\r | |
73 | typedef struct {\r | |
74 | UINT32 Level;\r | |
75 | UINT32 PowerCost;\r | |
76 | UINT32 Latency;\r | |
77 | } SCMI_PERFORMANCE_LEVEL;\r | |
78 | \r | |
79 | // Performance protocol performance limit.\r | |
80 | typedef struct {\r | |
81 | UINT32 RangeMax;\r | |
82 | UINT32 RangeMin;\r | |
83 | } SCMI_PERFORMANCE_LIMITS;\r | |
84 | \r | |
85 | #pragma pack()\r | |
86 | \r | |
87 | /** Return version of the performance management protocol supported by SCP.\r | |
88 | firmware.\r | |
89 | \r | |
90 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
91 | \r | |
92 | @param[out] Version Version of the supported SCMI performance management\r | |
93 | protocol.\r | |
94 | \r | |
95 | @retval EFI_SUCCESS The version is returned.\r | |
96 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
97 | @retval !(EFI_SUCCESS) Other errors.\r | |
98 | **/\r | |
99 | typedef\r | |
100 | EFI_STATUS\r | |
101 | (EFIAPI *SCMI_PERFORMANCE_GET_VERSION) (\r | |
102 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
103 | OUT UINT32 *Version\r | |
104 | );\r | |
105 | \r | |
106 | /** Return protocol attributes of the performance management protocol.\r | |
107 | \r | |
108 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
109 | \r | |
110 | @param[out] Attributes Protocol attributes.\r | |
111 | \r | |
112 | @retval EFI_SUCCESS Protocol attributes are returned.\r | |
113 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
114 | @retval !(EFI_SUCCESS) Other errors.\r | |
115 | **/\r | |
116 | typedef\r | |
117 | EFI_STATUS\r | |
118 | (EFIAPI *SCMI_PERFORMANCE_GET_ATTRIBUTES) (\r | |
119 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
120 | OUT SCMI_PERFORMANCE_PROTOCOL_ATTRIBUTES *Attributes\r | |
121 | \r | |
122 | );\r | |
123 | \r | |
124 | /** Return performance domain attributes.\r | |
125 | \r | |
126 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
127 | @param[in] DomainId Identifier for the performance domain.\r | |
128 | \r | |
129 | @param[out] Attributes Performance domain attributes.\r | |
130 | \r | |
131 | @retval EFI_SUCCESS Domain attributes are returned.\r | |
132 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
133 | @retval !(EFI_SUCCESS) Other errors.\r | |
134 | **/\r | |
135 | typedef\r | |
136 | EFI_STATUS\r | |
137 | (EFIAPI *SCMI_PERFORMANCE_GET_DOMAIN_ATTRIBUTES) (\r | |
138 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
139 | IN UINT32 DomainId,\r | |
140 | OUT SCMI_PERFORMANCE_DOMAIN_ATTRIBUTES *DomainAttributes\r | |
141 | );\r | |
142 | \r | |
143 | /** Return list of performance domain levels of a given domain.\r | |
144 | \r | |
145 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
146 | @param[in] DomainId Identifier for the performance domain.\r | |
147 | \r | |
148 | @param[out] NumLevels Total number of levels a domain can support.\r | |
149 | \r | |
150 | @param[in,out] LevelArraySize Size of the performance level array.\r | |
151 | \r | |
152 | @param[out] LevelArray Array of the performance levels.\r | |
153 | \r | |
154 | @retval EFI_SUCCESS Domain levels are returned.\r | |
155 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
156 | @retval EFI_BUFFER_TOO_SMALL LevelArraySize is too small for the result.\r | |
157 | It has been updated to the size needed.\r | |
158 | @retval !(EFI_SUCCESS) Other errors.\r | |
159 | **/\r | |
160 | typedef\r | |
161 | EFI_STATUS\r | |
162 | (EFIAPI *SCMI_PERFORMANCE_DESCRIBE_LEVELS) (\r | |
163 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
164 | IN UINT32 DomainId,\r | |
165 | OUT UINT32 *NumLevels,\r | |
166 | IN OUT UINT32 *LevelArraySize,\r | |
167 | OUT SCMI_PERFORMANCE_LEVEL *LevelArray\r | |
168 | );\r | |
169 | \r | |
170 | /** Set performance limits of a domain.\r | |
171 | \r | |
172 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
173 | @param[in] DomainId Identifier for the performance domain.\r | |
174 | @param[in] Limit Performance limit to set.\r | |
175 | \r | |
176 | @retval EFI_SUCCESS Performance limits set successfully.\r | |
177 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
178 | @retval !(EFI_SUCCESS) Other errors.\r | |
179 | **/\r | |
180 | typedef\r | |
181 | EFI_STATUS\r | |
182 | (EFIAPI *SCMI_PERFORMANCE_LIMITS_SET) (\r | |
183 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
184 | IN UINT32 DomainId,\r | |
185 | IN SCMI_PERFORMANCE_LIMITS *Limits\r | |
186 | );\r | |
187 | \r | |
188 | /** Get performance limits of a domain.\r | |
189 | \r | |
190 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
191 | @param[in] DomainId Identifier for the performance domain.\r | |
192 | \r | |
193 | @param[out] Limit Performance Limits of the domain.\r | |
194 | \r | |
195 | @retval EFI_SUCCESS Performance limits are returned.\r | |
196 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
197 | @retval !(EFI_SUCCESS) Other errors.\r | |
198 | **/\r | |
199 | typedef\r | |
200 | EFI_STATUS\r | |
201 | (EFIAPI *SCMI_PERFORMANCE_LIMITS_GET) (\r | |
202 | SCMI_PERFORMANCE_PROTOCOL *This,\r | |
203 | UINT32 DomainId,\r | |
204 | SCMI_PERFORMANCE_LIMITS *Limits\r | |
205 | );\r | |
206 | \r | |
207 | /** Set performance level of a domain.\r | |
208 | \r | |
209 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
210 | @param[in] DomainId Identifier for the performance domain.\r | |
211 | @param[in] Level Performance level of the domain.\r | |
212 | \r | |
213 | @retval EFI_SUCCESS Performance level set successfully.\r | |
214 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
215 | @retval !(EFI_SUCCESS) Other errors.\r | |
216 | **/\r | |
217 | typedef\r | |
218 | EFI_STATUS\r | |
219 | (EFIAPI *SCMI_PERFORMANCE_LEVEL_SET) (\r | |
220 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
221 | IN UINT32 DomainId,\r | |
222 | IN UINT32 Level\r | |
223 | );\r | |
224 | \r | |
225 | /** Get performance level of a domain.\r | |
226 | \r | |
227 | @param[in] This A Pointer to SCMI_PERFORMANCE_PROTOCOL Instance.\r | |
228 | @param[in] DomainId Identifier for the performance domain.\r | |
229 | \r | |
230 | @param[out] Level Performance level of the domain.\r | |
231 | \r | |
232 | @retval EFI_SUCCESS Performance level got successfully.\r | |
233 | @retval EFI_DEVICE_ERROR SCP returns an SCMI error.\r | |
234 | @retval !(EFI_SUCCESS) Other errors.\r | |
235 | **/\r | |
236 | typedef\r | |
237 | EFI_STATUS\r | |
238 | (EFIAPI *SCMI_PERFORMANCE_LEVEL_GET) (\r | |
239 | IN SCMI_PERFORMANCE_PROTOCOL *This,\r | |
240 | IN UINT32 DomainId,\r | |
241 | OUT UINT32 *Level\r | |
242 | );\r | |
243 | \r | |
244 | typedef struct _SCMI_PERFORMANCE_PROTOCOL {\r | |
245 | SCMI_PERFORMANCE_GET_VERSION GetVersion;\r | |
246 | SCMI_PERFORMANCE_GET_ATTRIBUTES GetProtocolAttributes;\r | |
247 | SCMI_PERFORMANCE_GET_DOMAIN_ATTRIBUTES GetDomainAttributes;\r | |
248 | SCMI_PERFORMANCE_DESCRIBE_LEVELS DescribeLevels;\r | |
249 | SCMI_PERFORMANCE_LIMITS_SET LimitsSet;\r | |
250 | SCMI_PERFORMANCE_LIMITS_GET LimitsGet;\r | |
251 | SCMI_PERFORMANCE_LEVEL_SET LevelSet;\r | |
252 | SCMI_PERFORMANCE_LEVEL_GET LevelGet;\r | |
253 | } SCMI_PERFORMANCE_PROTOCOL;\r | |
254 | \r | |
255 | typedef enum {\r | |
256 | SCMI_MESSAGE_ID_PERFORMANCE_DOMAIN_ATTRIBUTES = 0x3,\r | |
257 | SCMI_MESSAGE_ID_PERFORMANCE_DESCRIBE_LEVELS = 0x4,\r | |
258 | SCMI_MESSAGE_ID_PERFORMANCE_LIMITS_SET = 0x5,\r | |
259 | SCMI_MESSAGE_ID_PERFORMANCE_LIMITS_GET = 0x6,\r | |
260 | SCMI_MESSAGE_ID_PERFORMANCE_LEVEL_SET = 0x7,\r | |
261 | SCMI_MESSAGE_ID_PERFORMANCE_LEVEL_GET = 0x8,\r | |
262 | } SCMI_MESSAGE_ID_PERFORMANCE;\r | |
263 | \r | |
264 | #endif /* ARM_SCMI_PERFORMANCE_PROTOCOL_H_ */\r | |
265 | \r |