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
|
/** @file
Copyright (c) 2017-2021, Arm Limited. All rights reserved.
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/ArmMtlLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include "ScmiPrivate.h"
// Arbitrary timeout value 20ms.
#define RESPONSE_TIMEOUT 20000
/** Return a pointer to the message payload.
@param[out] Payload Holds pointer to the message payload.
@retval EFI_SUCCESS Payload holds a valid message payload pointer.
@retval EFI_TIMEOUT Time out error if MTL channel is busy.
@retval EFI_UNSUPPORTED If MTL channel is unsupported.
**/
EFI_STATUS
ScmiCommandGetPayload (
OUT UINT32** Payload
)
{
EFI_STATUS Status;
MTL_CHANNEL *Channel;
// Get handle to the Channel.
Status = MtlGetChannel (MTL_CHANNEL_TYPE_LOW, &Channel);
if (EFI_ERROR (Status)) {
return Status;
}
// Payload will not be populated until channel is free.
Status = MtlWaitUntilChannelFree (Channel, RESPONSE_TIMEOUT);
if (EFI_ERROR (Status)) {
return Status;
}
// Get the address of the payload.
*Payload = MtlGetChannelPayload (Channel);
return EFI_SUCCESS;
}
/** Execute a SCMI command and receive a response.
This function uses a MTL channel to transfer message to SCP
and waits for a response.
@param[in] Command Pointer to the SCMI command (Protocol ID
and Message ID)
@param[in,out] PayloadLength SCMI command message length.
@param[out] OPTIONAL ReturnValues Pointer to SCMI response.
@retval OUT EFI_SUCCESS Command sent and message received successfully.
@retval OUT EFI_UNSUPPORTED Channel not supported.
@retval OUT EFI_TIMEOUT Timeout on the channel.
@retval OUT EFI_DEVICE_ERROR Channel not ready.
@retval OUT EFI_DEVICE_ERROR Message Header corrupted.
@retval OUT EFI_DEVICE_ERROR SCMI error.
**/
EFI_STATUS
ScmiCommandExecute (
IN SCMI_COMMAND *Command,
IN OUT UINT32 *PayloadLength,
OUT UINT32 **ReturnValues OPTIONAL
)
{
EFI_STATUS Status;
SCMI_MESSAGE_RESPONSE *Response;
UINT32 MessageHeader;
UINT32 ResponseHeader;
MTL_CHANNEL *Channel;
ASSERT (PayloadLength != NULL);
Status = MtlGetChannel (MTL_CHANNEL_TYPE_LOW, &Channel);
if (EFI_ERROR (Status)) {
return Status;
}
// Fill in message header.
MessageHeader = SCMI_MESSAGE_HEADER (
Command->MessageId,
SCMI_MESSAGE_TYPE_COMMAND,
Command->ProtocolId
);
// Send payload using MTL channel.
Status = MtlSendMessage (
Channel,
MessageHeader,
*PayloadLength
);
if (EFI_ERROR (Status)) {
return Status;
}
// Wait for the response on the channel.
Status = MtlReceiveMessage (Channel, &ResponseHeader, PayloadLength);
if (EFI_ERROR (Status)) {
return Status;
}
// SCMI must return MessageHeader unmodified.
if (MessageHeader != ResponseHeader) {
ASSERT (FALSE);
return EFI_DEVICE_ERROR;
}
Response = (SCMI_MESSAGE_RESPONSE*)MtlGetChannelPayload (Channel);
if (Response->Status != SCMI_SUCCESS) {
DEBUG ((DEBUG_ERROR, "SCMI error: ProtocolId = 0x%x, MessageId = 0x%x, error = %d\n",
Command->ProtocolId,
Command->MessageId,
Response->Status
));
ASSERT (FALSE);
return EFI_DEVICE_ERROR;
}
if (ReturnValues != NULL) {
*ReturnValues = Response->ReturnValues;
}
return EFI_SUCCESS;
}
/** Internal common function useful for common protocol discovery messages.
@param[in] ProtocolId Protocol Id of the the protocol.
@param[in] MesaageId Message Id of the message.
@param[out] ReturnValues SCMI response return values.
@retval EFI_SUCCESS Success with valid return values.
@retval EFI_DEVICE_ERROR SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
STATIC
EFI_STATUS
ScmiProtocolDiscoveryCommon (
IN SCMI_PROTOCOL_ID ProtocolId,
IN SCMI_MESSAGE_ID MessageId,
OUT UINT32 **ReturnValues
)
{
SCMI_COMMAND Command;
UINT32 PayloadLength;
PayloadLength = 0;
Command.ProtocolId = ProtocolId;
Command.MessageId = MessageId;
return ScmiCommandExecute (
&Command,
&PayloadLength,
ReturnValues
);
}
/** Return protocol version from SCP for a given protocol ID.
@param[in] Protocol ID Protocol ID.
@param[out] Version Pointer to version of the protocol.
@retval EFI_SUCCESS Version holds a valid version received
from the SCP.
@retval EFI_DEVICE_ERROR SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
EFI_STATUS
ScmiGetProtocolVersion (
IN SCMI_PROTOCOL_ID ProtocolId,
OUT UINT32 *Version
)
{
EFI_STATUS Status;
UINT32 *ProtocolVersion;
Status = ScmiProtocolDiscoveryCommon (
ProtocolId,
SCMI_MESSAGE_ID_PROTOCOL_VERSION,
(UINT32**)&ProtocolVersion
);
if (EFI_ERROR (Status)) {
return Status;
}
*Version = *ProtocolVersion;
return EFI_SUCCESS;
}
/** Return protocol attributes from SCP for a given protocol ID.
@param[in] Protocol ID Protocol ID.
@param[out] ReturnValues Pointer to attributes of the protocol.
@retval EFI_SUCCESS ReturnValues points to protocol attributes.
@retval EFI_DEVICE_ERROR SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
EFI_STATUS
ScmiGetProtocolAttributes (
IN SCMI_PROTOCOL_ID ProtocolId,
OUT UINT32 **ReturnValues
)
{
return ScmiProtocolDiscoveryCommon (
ProtocolId,
SCMI_MESSAGE_ID_PROTOCOL_ATTRIBUTES,
ReturnValues
);
}
/** Return protocol message attributes from SCP for a given protocol ID.
@param[in] Protocol ID Protocol ID.
@param[out] Attributes Pointer to attributes of the protocol.
@retval EFI_SUCCESS ReturnValues points to protocol message attributes.
@retval EFI_DEVICE_ERROR SCMI error.
@retval !(EFI_SUCCESS) Other errors.
**/
EFI_STATUS
ScmiGetProtocolMessageAttributes (
IN SCMI_PROTOCOL_ID ProtocolId,
OUT UINT32 **ReturnValues
)
{
return ScmiProtocolDiscoveryCommon (
ProtocolId,
SCMI_MESSAGE_ID_PROTOCOL_MESSAGE_ATTRIBUTES,
ReturnValues
);
}
|
