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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
/** @file
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "SmmTestPoint.h"
EFI_STATUS
GetAllSmmTestPointData (
IN OUT UINTN *DataSize,
IN OUT VOID *Data
)
{
EFI_STATUS Status;
EFI_ADAPTER_INFORMATION_PROTOCOL *Aip;
UINTN NoHandles;
EFI_HANDLE *Handles;
UINTN HandleBufSize;
UINTN Index;
EFI_GUID *InfoTypesBuffer;
UINTN InfoTypesBufferCount;
UINTN InfoTypesIndex;
EFI_ADAPTER_INFORMATION_PROTOCOL *AipCandidate;
VOID *InformationBlock;
UINTN InformationBlockSize;
UINTN TotalSize;
EFI_STATUS RetStatus;
TotalSize = 0;
Handles = NULL;
HandleBufSize = 0;
Status = gSmst->SmmLocateHandle (
ByProtocol,
&gEfiAdapterInformationProtocolGuid,
NULL,
&HandleBufSize,
Handles
);
if (Status != EFI_BUFFER_TOO_SMALL) {
RetStatus = EFI_NOT_FOUND;
goto Done ;
}
Handles = AllocateZeroPool (HandleBufSize);
if (Handles == NULL) {
RetStatus = EFI_OUT_OF_RESOURCES;
goto Done ;
}
Status = gSmst->SmmLocateHandle (
ByProtocol,
&gEfiAdapterInformationProtocolGuid,
NULL,
&HandleBufSize,
Handles
);
if (EFI_ERROR (Status)) {
RetStatus = Status;
goto Done ;
}
NoHandles = HandleBufSize / sizeof(EFI_HANDLE);
RetStatus = EFI_SUCCESS;
Aip = NULL;
InformationBlock = NULL;
InformationBlockSize = 0;
for (Index = 0; Index < NoHandles; Index++) {
Status = gSmst->SmmHandleProtocol (
Handles[Index],
&gEfiAdapterInformationProtocolGuid,
(VOID **)&Aip
);
if (EFI_ERROR (Status)) {
continue;
}
//
// Check AIP
//
Status = Aip->GetSupportedTypes (
Aip,
&InfoTypesBuffer,
&InfoTypesBufferCount
);
if (EFI_ERROR (Status)) {
continue;
}
AipCandidate = NULL;
for (InfoTypesIndex = 0; InfoTypesIndex < InfoTypesBufferCount; InfoTypesIndex++) {
if (CompareGuid (&InfoTypesBuffer[InfoTypesIndex], &gAdapterInfoPlatformTestPointGuid)) {
AipCandidate = Aip;
break;
}
}
FreePool (InfoTypesBuffer);
if (AipCandidate == NULL) {
continue;
}
//
// Check Role
//
Aip = AipCandidate;
Status = Aip->GetInformation (
Aip,
&gAdapterInfoPlatformTestPointGuid,
&InformationBlock,
&InformationBlockSize
);
if (EFI_ERROR (Status)) {
continue;
}
if ((Data != NULL) && (TotalSize + InformationBlockSize <= *DataSize)) {
CopyMem ((UINT8 *)Data + TotalSize, InformationBlock, InformationBlockSize);
} else {
RetStatus = EFI_BUFFER_TOO_SMALL;
}
TotalSize += InformationBlockSize;
FreePool (InformationBlock);
}
Done:
*DataSize = TotalSize;
if (Handles != NULL) {
FreePool (Handles);
}
return RetStatus;
}
/**
SMM test point SMI handler to get info.
@param SmiHandlerTestPointParameterGetInfo The parameter of SMM test point SMI handler get info.
**/
VOID
SmmTestPointSmiHandlerGetInfo (
IN SMI_HANDLER_TEST_POINT_PARAMETER_GET_INFO *SmiHandlerTestPointParameterGetInfo
)
{
UINTN DataSize;
EFI_STATUS Status;
DataSize = 0;
Status = GetAllSmmTestPointData (&DataSize, NULL);
if (Status == EFI_BUFFER_TOO_SMALL) {
SmiHandlerTestPointParameterGetInfo->DataSize = DataSize;
SmiHandlerTestPointParameterGetInfo->Header.ReturnStatus = 0;
} else {
SmiHandlerTestPointParameterGetInfo->DataSize = 0;
SmiHandlerTestPointParameterGetInfo->Header.ReturnStatus = (UINT64)(INT64)(INTN)EFI_NOT_FOUND;
}
}
/**
Copy SMM Test Point data.
@param DataBuffer The buffer to hold SMM Test Point data.
@param DataSize On input, data buffer size.
On output, actual data buffer size copied.
@param DataOffset On input, data buffer offset to copy.
On output, next time data buffer offset to copy.
**/
VOID
SmiHandlerTestPointCopyData (
IN VOID *InputData,
IN UINTN InputDataSize,
OUT VOID *DataBuffer,
IN OUT UINT64 *DataSize,
IN OUT UINT64 *DataOffset
)
{
if (*DataOffset >= InputDataSize) {
*DataOffset = InputDataSize;
return;
}
if (InputDataSize - *DataOffset < *DataSize) {
*DataSize = InputDataSize - *DataOffset;
}
CopyMem(
DataBuffer,
(UINT8 *)InputData + *DataOffset,
(UINTN)*DataSize
);
*DataOffset = *DataOffset + *DataSize;
}
/**
SMM test point SMI handler to get data by offset.
@param SmiHandlerTestPointParameterGetDataByOffset The parameter of SMM test point SMI handler get data by offset.
**/
VOID
SmmTestPointSmiHandlerGetDataByOffset (
IN SMI_HANDLER_TEST_POINT_PARAMETER_GET_DATA_BY_OFFSET *SmiHandlerTestPointParameterGetDataByOffset
)
{
SMI_HANDLER_TEST_POINT_PARAMETER_GET_DATA_BY_OFFSET SmiHandlerTestPointGetDataByOffset;
VOID *Data;
UINTN DataSize;
EFI_STATUS Status;
Data = NULL;
CopyMem (
&SmiHandlerTestPointGetDataByOffset,
SmiHandlerTestPointParameterGetDataByOffset,
sizeof(SmiHandlerTestPointGetDataByOffset)
);
//
// Sanity check
//
if (!SmmIsBufferOutsideSmmValid((UINTN)SmiHandlerTestPointGetDataByOffset.DataBuffer, (UINTN)SmiHandlerTestPointGetDataByOffset.DataSize)) {
DEBUG((DEBUG_ERROR, "SmmTestPointSmiHandlerGetDataByOffset: SmmTestPoint get data in SMRAM or overflow!\n"));
SmiHandlerTestPointParameterGetDataByOffset->Header.ReturnStatus = (UINT64)(INT64)(INTN)EFI_ACCESS_DENIED;
goto Done;
}
DataSize = 0;
Status = GetAllSmmTestPointData (&DataSize, NULL);
if (Status != EFI_BUFFER_TOO_SMALL) {
SmiHandlerTestPointParameterGetDataByOffset->Header.ReturnStatus = (UINT64)(INT64)(INTN)EFI_NOT_FOUND;
goto Done;
}
Data = AllocatePool (DataSize);
if (Data == NULL) {
SmiHandlerTestPointParameterGetDataByOffset->Header.ReturnStatus = (UINT64)(INT64)(INTN)EFI_OUT_OF_RESOURCES;
goto Done;
}
Status = GetAllSmmTestPointData (&DataSize, Data);
if (EFI_ERROR(Status)) {
SmiHandlerTestPointParameterGetDataByOffset->Header.ReturnStatus = (UINT64)(INT64)(INTN)Status;
goto Done;
}
SmiHandlerTestPointCopyData (
Data,
DataSize,
(VOID *)(UINTN)SmiHandlerTestPointGetDataByOffset.DataBuffer,
&SmiHandlerTestPointGetDataByOffset.DataSize,
&SmiHandlerTestPointGetDataByOffset.DataOffset
);
CopyMem (
SmiHandlerTestPointParameterGetDataByOffset,
&SmiHandlerTestPointGetDataByOffset,
sizeof(SmiHandlerTestPointGetDataByOffset)
);
SmiHandlerTestPointParameterGetDataByOffset->Header.ReturnStatus = 0;
Done:
if (Data != NULL) {
FreePool (Data);
}
}
/**
Dispatch function for a Software SMI handler.
Caution: This function may receive untrusted input.
Communicate buffer and buffer size are external input, so this function will do basic validation.
@param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
@param Context Points to an optional handler context which was specified when the
handler was registered.
@param CommBuffer A pointer to a collection of data in memory that will
be conveyed from a non-SMM environment into an SMM environment.
@param CommBufferSize The size of the CommBuffer.
@retval EFI_SUCCESS Command is handled successfully.
**/
EFI_STATUS
EFIAPI
SmmTestPointSmiHandler (
IN EFI_HANDLE DispatchHandle,
IN CONST VOID *Context OPTIONAL,
IN OUT VOID *CommBuffer OPTIONAL,
IN OUT UINTN *CommBufferSize OPTIONAL
)
{
SMI_HANDLER_TEST_POINT_PARAMETER_HEADER *SmiHandlerTestPointParameterHeader;
UINTN TempCommBufferSize;
DEBUG((DEBUG_ERROR, "SmmTestPointSmiHandler Enter\n"));
//
// If input is invalid, stop processing this SMI
//
if (CommBuffer == NULL || CommBufferSize == NULL) {
return EFI_SUCCESS;
}
TempCommBufferSize = *CommBufferSize;
if (TempCommBufferSize < sizeof(SMI_HANDLER_TEST_POINT_PARAMETER_HEADER)) {
DEBUG((DEBUG_ERROR, "SmmTestPointSmiHandler: SMM communication buffer size invalid!\n"));
return EFI_SUCCESS;
}
if (!SmmIsBufferOutsideSmmValid((UINTN)CommBuffer, TempCommBufferSize)) {
DEBUG((DEBUG_ERROR, "SmmTestPointSmiHandler: SMM communication buffer in SMRAM or overflow!\n"));
return EFI_SUCCESS;
}
SmiHandlerTestPointParameterHeader = (SMI_HANDLER_TEST_POINT_PARAMETER_HEADER *)((UINTN)CommBuffer);
SmiHandlerTestPointParameterHeader->ReturnStatus = (UINT64)-1;
switch (SmiHandlerTestPointParameterHeader->Command) {
case SMI_HANDLER_TEST_POINT_COMMAND_GET_INFO:
DEBUG((DEBUG_ERROR, "SmiHandlerTestPointHandlerGetInfo\n"));
if (TempCommBufferSize != sizeof(SMI_HANDLER_TEST_POINT_PARAMETER_GET_INFO)) {
DEBUG((DEBUG_ERROR, "SmmTestPointSmiHandler: SMM communication buffer size invalid!\n"));
return EFI_SUCCESS;
}
SmmTestPointSmiHandlerGetInfo((SMI_HANDLER_TEST_POINT_PARAMETER_GET_INFO *)(UINTN)CommBuffer);
break;
case SMI_HANDLER_TEST_POINT_COMMAND_GET_DATA_BY_OFFSET:
DEBUG((DEBUG_ERROR, "SmiHandlerTestPointHandlerGetDataByOffset\n"));
if (TempCommBufferSize != sizeof(SMI_HANDLER_TEST_POINT_PARAMETER_GET_DATA_BY_OFFSET)) {
DEBUG((DEBUG_ERROR, "SmmTestPointSmiHandler: SMM communication buffer size invalid!\n"));
return EFI_SUCCESS;
}
SmmTestPointSmiHandlerGetDataByOffset((SMI_HANDLER_TEST_POINT_PARAMETER_GET_DATA_BY_OFFSET *)(UINTN)CommBuffer);
break;
default:
break;
}
DEBUG((DEBUG_ERROR, "SmmTestPointSmiHandler Exit\n"));
return EFI_SUCCESS;
}
/**
Register SMM TestPoint handler.
**/
VOID
RegisterSmmTestPointSmiHandler (
VOID
)
{
EFI_HANDLE DispatchHandle;
EFI_STATUS Status;
STATIC BOOLEAN Registered = FALSE;
if (Registered) {
return ;
}
Status = gSmst->SmiHandlerRegister (
SmmTestPointSmiHandler,
&gAdapterInfoPlatformTestPointGuid,
&DispatchHandle
);
ASSERT_EFI_ERROR (Status);
Registered = TRUE;
}
|