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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
/** @file
Copyright (c) 2017-2021, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
System Control and Management Interface V1.0
http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/
DEN0056A_System_Control_and_Management_Interface.pdf
**/
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Protocol/ArmScmiBaseProtocol.h>
#include "ArmScmiBaseProtocolPrivate.h"
#include "ScmiPrivate.h"
/** Return version of the Base protocol supported by SCP firmware.
@param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.
@param[out] Version Version of the supported SCMI Base protocol.
@retval EFI_SUCCESS The version of the protocol is returned.
@retval EFI_DEVICE_ERROR SCP returns an SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
STATIC
EFI_STATUS
BaseGetVersion (
IN SCMI_BASE_PROTOCOL *This,
OUT UINT32 *Version
)
{
return ScmiGetProtocolVersion (ScmiProtocolIdBase, Version);
}
/** Return total number of SCMI protocols supported by the SCP firmware.
@param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.
@param[out] TotalProtocols Total number of SCMI protocols supported.
@retval EFI_SUCCESS Total number of protocols supported are returned.
@retval EFI_DEVICE_ERROR SCP returns a SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
STATIC
EFI_STATUS
BaseGetTotalProtocols (
IN SCMI_BASE_PROTOCOL *This,
OUT UINT32 *TotalProtocols
)
{
EFI_STATUS Status;
UINT32 *ReturnValues;
Status = ScmiGetProtocolAttributes (ScmiProtocolIdBase, &ReturnValues);
if (EFI_ERROR (Status)) {
return Status;
}
*TotalProtocols = SCMI_TOTAL_PROTOCOLS (ReturnValues[0]);
return EFI_SUCCESS;
}
/** Common function which returns vendor details.
@param[in] MessageId ScmiMessageIdBaseDiscoverVendor
OR
ScmiMessageIdBaseDiscoverSubVendor
@param[out] VendorIdentifier ASCII name of the vendor/subvendor.
@retval EFI_SUCCESS VendorIdentifier is returned.
@retval EFI_DEVICE_ERROR SCP returns an SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
STATIC
EFI_STATUS
BaseDiscoverVendorDetails (
IN SCMI_MESSAGE_ID_BASE MessageId,
OUT UINT8 VendorIdentifier[SCMI_MAX_STR_LEN]
)
{
EFI_STATUS Status;
UINT32 *ReturnValues;
SCMI_COMMAND Cmd;
UINT32 PayloadLength;
Cmd.ProtocolId = ScmiProtocolIdBase;
Cmd.MessageId = MessageId;
PayloadLength = 0;
Status = ScmiCommandExecute (
&Cmd,
&PayloadLength,
&ReturnValues
);
if (EFI_ERROR (Status)) {
return Status;
}
AsciiStrCpyS (
(CHAR8*)VendorIdentifier,
SCMI_MAX_STR_LEN,
(CONST CHAR8*)ReturnValues
);
return EFI_SUCCESS;
}
/** Return vendor name.
@param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.
@param[out] VendorIdentifier Null terminated ASCII string of up to
16 bytes with a vendor name.
@retval EFI_SUCCESS VendorIdentifier is returned.
@retval EFI_DEVICE_ERROR SCP returns a SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
STATIC
EFI_STATUS
BaseDiscoverVendor (
IN SCMI_BASE_PROTOCOL *This,
OUT UINT8 VendorIdentifier[SCMI_MAX_STR_LEN]
)
{
return BaseDiscoverVendorDetails (
ScmiMessageIdBaseDiscoverVendor,
VendorIdentifier
);
}
/** Return sub vendor name.
@param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.
@param[out] VendorIdentifier Null terminated ASCII string of up to
16 bytes with a sub vendor name.
@retval EFI_SUCCESS VendorIdentifier is returned.
@retval EFI_DEVICE_ERROR SCP returns a SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
EFI_STATUS
BaseDiscoverSubVendor (
IN SCMI_BASE_PROTOCOL *This,
OUT UINT8 VendorIdentifier[SCMI_MAX_STR_LEN]
)
{
return BaseDiscoverVendorDetails (
ScmiMessageIdBaseDiscoverSubVendor,
VendorIdentifier
);
}
/** Return implementation version.
@param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.
@param[out] ImplementationVersion Vendor specific implementation version.
@retval EFI_SUCCESS Implementation version is returned.
@retval EFI_DEVICE_ERROR SCP returns a SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
STATIC
EFI_STATUS
BaseDiscoverImplVersion (
IN SCMI_BASE_PROTOCOL *This,
OUT UINT32 *ImplementationVersion
)
{
EFI_STATUS Status;
UINT32 *ReturnValues;
SCMI_COMMAND Cmd;
UINT32 PayloadLength;
Cmd.ProtocolId = ScmiProtocolIdBase;
Cmd.MessageId = ScmiMessageIdBaseDiscoverImplementationVersion;
PayloadLength = 0;
Status = ScmiCommandExecute (
&Cmd,
&PayloadLength,
&ReturnValues
);
if (EFI_ERROR (Status)) {
return Status;
}
*ImplementationVersion = ReturnValues[0];
return EFI_SUCCESS;
}
/** Return list of protocols.
@param[in] This A Pointer to SCMI_BASE_PROTOCOL Instance.
@param[out] ProtocolListSize Size of the ProtocolList.
@param[out] ProtocolList Protocol list.
@retval EFI_SUCCESS List of protocols is returned.
@retval EFI_BUFFER_TOO_SMALL ProtocolListSize is too small for the result.
It has been updated to the size needed.
@retval EFI_DEVICE_ERROR SCP returns a SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
STATIC
EFI_STATUS
BaseDiscoverListProtocols (
IN SCMI_BASE_PROTOCOL *This,
IN OUT UINT32 *ProtocolListSize,
OUT UINT8 *ProtocolList
)
{
EFI_STATUS Status;
UINT32 TotalProtocols;
UINT32 *MessageParams;
BASE_DISCOVER_LIST *DiscoverList;
UINT32 Skip;
UINT32 Index;
SCMI_COMMAND Cmd;
UINT32 PayloadLength;
UINT32 RequiredSize;
Status = BaseGetTotalProtocols (This, &TotalProtocols);
if (EFI_ERROR (Status)) {
return Status;
}
Status = ScmiCommandGetPayload (&MessageParams);
if (EFI_ERROR (Status)) {
return Status;
}
RequiredSize = sizeof (UINT8) * TotalProtocols;
if (*ProtocolListSize < RequiredSize) {
*ProtocolListSize = RequiredSize;
return EFI_BUFFER_TOO_SMALL;
}
Cmd.ProtocolId = ScmiProtocolIdBase;
Cmd.MessageId = ScmiMessageIdBaseDiscoverListProtocols;
Skip = 0;
while (Skip < TotalProtocols) {
*MessageParams = Skip;
// Note PayloadLength is a IN/OUT parameter.
PayloadLength = sizeof (Skip);
Status = ScmiCommandExecute (
&Cmd,
&PayloadLength,
(UINT32**)&DiscoverList
);
if (EFI_ERROR (Status)) {
return Status;
}
for (Index = 0; Index < DiscoverList->NumProtocols; Index++) {
ProtocolList[Skip++] = DiscoverList->Protocols[Index];
}
}
*ProtocolListSize = RequiredSize;
return EFI_SUCCESS;
}
// Instance of the SCMI Base protocol.
STATIC CONST SCMI_BASE_PROTOCOL BaseProtocol = {
BaseGetVersion,
BaseGetTotalProtocols,
BaseDiscoverVendor,
BaseDiscoverSubVendor,
BaseDiscoverImplVersion,
BaseDiscoverListProtocols
};
/** Initialize Base protocol and install protocol on a given handle.
@param[in] Handle Handle to install Base protocol.
@retval EFI_SUCCESS Base protocol interface installed
successfully.
**/
EFI_STATUS
ScmiBaseProtocolInit (
IN OUT EFI_HANDLE* Handle
)
{
return gBS->InstallMultipleProtocolInterfaces (
Handle,
&gArmScmiBaseProtocolGuid,
&BaseProtocol,
NULL
);
}
|
