]>
Commit | Line | Data |
---|---|---|
8a2d4996 | 1 | /** @file\r |
2 | \r | |
3 | This is a simple fault tolerant write driver that is intended to use in the SMM environment.\r | |
4 | \r | |
5 | This boot service protocol only provides fault tolerant write capability for \r | |
6 | block devices. The protocol has internal non-volatile intermediate storage \r | |
7 | of the data and private information. It should be able to recover \r | |
8 | automatically from a critical fault, such as power failure. \r | |
9 | \r | |
10 | The implementation uses an FTW (Fault Tolerant Write) Work Space. \r | |
11 | This work space is a memory copy of the work space on the Working Block,\r | |
12 | the size of the work space is the FTW_WORK_SPACE_SIZE bytes.\r | |
13 | \r | |
14 | The work space stores each write record as EFI_FTW_RECORD structure.\r | |
15 | The spare block stores the write buffer before write to the target block.\r | |
16 | \r | |
17 | The write record has three states to specify the different phase of write operation.\r | |
18 | 1) WRITE_ALLOCATED is that the record is allocated in write space.\r | |
19 | The information of write operation is stored in write record structure.\r | |
20 | 2) SPARE_COMPLETED is that the data from write buffer is writed into the spare block as the backup.\r | |
21 | 3) WRITE_COMPLETED is that the data is copied from the spare block to the target block.\r | |
22 | \r | |
23 | This driver operates the data as the whole size of spare block.\r | |
24 | It first read the SpareAreaLength data from the target block into the spare memory buffer.\r | |
25 | Then copy the write buffer data into the spare memory buffer.\r | |
26 | Then write the spare memory buffer into the spare block.\r | |
27 | Final copy the data from the spare block to the target block.\r | |
28 | \r | |
29 | To make this drive work well, the following conditions must be satisfied:\r | |
30 | 1. The write NumBytes data must be fit within Spare area. \r | |
31 | Offset + NumBytes <= SpareAreaLength\r | |
32 | 2. The whole flash range has the same block size.\r | |
33 | 3. Working block is an area which contains working space in its last block and has the same size as spare block.\r | |
34 | 4. Working Block area must be in the single one Firmware Volume Block range which FVB protocol is produced on. \r | |
35 | 5. Spare area must be in the single one Firmware Volume Block range which FVB protocol is produced on.\r | |
36 | 6. Any write data area (SpareAreaLength Area) which the data will be written into must be \r | |
37 | in the single one Firmware Volume Block range which FVB protocol is produced on.\r | |
38 | 7. If write data area (such as Variable range) is enlarged, the spare area range must be enlarged.\r | |
39 | The spare area must be enough large to store the write data before write them into the target range.\r | |
40 | If one of them is not satisfied, FtwWrite may fail.\r | |
41 | Usually, Spare area only takes one block. That's SpareAreaLength = BlockSize, NumberOfSpareBlock = 1.\r | |
42 | \r | |
c219324c ED |
43 | Caution: This module requires additional review when modified.\r |
44 | This driver need to make sure the CommBuffer is not in the SMRAM range. \r | |
45 | \r | |
f07268bd | 46 | Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>\r |
8a2d4996 | 47 | This program and the accompanying materials \r |
48 | are licensed and made available under the terms and conditions of the BSD License \r | |
49 | which accompanies this distribution. The full text of the license may be found at \r | |
50 | http://opensource.org/licenses/bsd-license.php \r | |
51 | \r | |
52 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
53 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
54 | \r | |
55 | **/\r | |
56 | \r | |
f3b80a8e | 57 | #include <PiSmm.h>\r |
8a2d4996 | 58 | #include <Library/SmmServicesTableLib.h>\r |
8a2d4996 | 59 | #include <Protocol/SmmSwapAddressRange.h>\r |
f3b80a8e | 60 | #include "FaultTolerantWrite.h"\r |
61 | #include "FaultTolerantWriteSmmCommon.h"\r | |
c219324c | 62 | #include <Protocol/SmmAccess2.h>\r |
f07268bd | 63 | #include <Protocol/SmmEndOfDxe.h>\r |
8a2d4996 | 64 | \r |
65 | EFI_EVENT mFvbRegistration = NULL;\r | |
f3b80a8e | 66 | EFI_FTW_DEVICE *mFtwDevice = NULL;\r |
c219324c ED |
67 | EFI_SMRAM_DESCRIPTOR *mSmramRanges;\r |
68 | UINTN mSmramRangeCount;\r | |
69 | \r | |
f07268bd SZ |
70 | ///\r |
71 | /// The flag to indicate whether the platform has left the DXE phase of execution.\r | |
72 | ///\r | |
73 | BOOLEAN mEndOfDxe = FALSE;\r | |
c219324c ED |
74 | \r |
75 | /**\r | |
76 | This function check if the address is in SMRAM.\r | |
77 | \r | |
78 | @param Buffer the buffer address to be checked.\r | |
79 | @param Length the buffer length to be checked.\r | |
80 | \r | |
81 | @retval TRUE this address is in SMRAM.\r | |
82 | @retval FALSE this address is NOT in SMRAM.\r | |
83 | **/\r | |
84 | BOOLEAN\r | |
85 | InternalIsAddressInSmram (\r | |
86 | IN EFI_PHYSICAL_ADDRESS Buffer,\r | |
87 | IN UINT64 Length\r | |
88 | )\r | |
89 | {\r | |
90 | UINTN Index;\r | |
91 | \r | |
92 | for (Index = 0; Index < mSmramRangeCount; Index ++) {\r | |
93 | if (((Buffer >= mSmramRanges[Index].CpuStart) && (Buffer < mSmramRanges[Index].CpuStart + mSmramRanges[Index].PhysicalSize)) ||\r | |
94 | ((mSmramRanges[Index].CpuStart >= Buffer) && (mSmramRanges[Index].CpuStart < Buffer + Length))) {\r | |
95 | return TRUE;\r | |
96 | }\r | |
97 | }\r | |
98 | \r | |
99 | return FALSE;\r | |
100 | }\r | |
101 | \r | |
9d00d20e SZ |
102 | /**\r |
103 | This function check if the address refered by Buffer and Length is valid.\r | |
104 | \r | |
105 | @param Buffer the buffer address to be checked.\r | |
106 | @param Length the buffer length to be checked.\r | |
107 | \r | |
108 | @retval TRUE this address is valid.\r | |
109 | @retval FALSE this address is NOT valid.\r | |
110 | **/\r | |
111 | BOOLEAN\r | |
112 | InternalIsAddressValid (\r | |
113 | IN UINTN Buffer,\r | |
114 | IN UINTN Length\r | |
115 | )\r | |
116 | {\r | |
117 | if (Buffer > (MAX_ADDRESS - Length)) {\r | |
118 | //\r | |
119 | // Overflow happen\r | |
120 | //\r | |
121 | return FALSE;\r | |
122 | }\r | |
123 | if (InternalIsAddressInSmram ((EFI_PHYSICAL_ADDRESS)Buffer, (UINT64)Length)) {\r | |
124 | return FALSE;\r | |
125 | }\r | |
126 | return TRUE;\r | |
127 | }\r | |
8a2d4996 | 128 | \r |
129 | /**\r | |
130 | Retrive the SMM FVB protocol interface by HANDLE.\r | |
131 | \r | |
132 | @param[in] FvBlockHandle The handle of SMM FVB protocol that provides services for\r | |
133 | reading, writing, and erasing the target block.\r | |
134 | @param[out] FvBlock The interface of SMM FVB protocol\r | |
135 | \r | |
136 | @retval EFI_SUCCESS The interface information for the specified protocol was returned.\r | |
137 | @retval EFI_UNSUPPORTED The device does not support the SMM FVB protocol.\r | |
138 | @retval EFI_INVALID_PARAMETER FvBlockHandle is not a valid EFI_HANDLE or FvBlock is NULL.\r | |
139 | \r | |
140 | **/\r | |
141 | EFI_STATUS\r | |
142 | FtwGetFvbByHandle (\r | |
143 | IN EFI_HANDLE FvBlockHandle,\r | |
144 | OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock\r | |
145 | )\r | |
146 | {\r | |
147 | //\r | |
148 | // To get the SMM FVB protocol interface on the handle\r | |
149 | //\r | |
150 | return gSmst->SmmHandleProtocol (\r | |
151 | FvBlockHandle,\r | |
152 | &gEfiSmmFirmwareVolumeBlockProtocolGuid,\r | |
153 | (VOID **) FvBlock\r | |
154 | );\r | |
155 | }\r | |
156 | \r | |
157 | /**\r | |
158 | Retrive the SMM Swap Address Range protocol interface.\r | |
159 | \r | |
160 | @param[out] SarProtocol The interface of SMM SAR protocol\r | |
161 | \r | |
162 | @retval EFI_SUCCESS The SMM SAR protocol instance was found and returned in SarProtocol.\r | |
163 | @retval EFI_NOT_FOUND The SMM SAR protocol instance was not found.\r | |
164 | @retval EFI_INVALID_PARAMETER SarProtocol is NULL.\r | |
165 | \r | |
166 | **/\r | |
167 | EFI_STATUS\r | |
168 | FtwGetSarProtocol (\r | |
169 | OUT VOID **SarProtocol\r | |
170 | )\r | |
171 | {\r | |
172 | EFI_STATUS Status;\r | |
173 | \r | |
174 | //\r | |
175 | // Locate Smm Swap Address Range protocol\r | |
176 | //\r | |
177 | Status = gSmst->SmmLocateProtocol (\r | |
178 | &gEfiSmmSwapAddressRangeProtocolGuid, \r | |
179 | NULL, \r | |
180 | SarProtocol\r | |
181 | );\r | |
182 | return Status;\r | |
183 | }\r | |
184 | \r | |
185 | /**\r | |
186 | Function returns an array of handles that support the SMM FVB protocol\r | |
187 | in a buffer allocated from pool. \r | |
188 | \r | |
189 | @param[out] NumberHandles The number of handles returned in Buffer.\r | |
190 | @param[out] Buffer A pointer to the buffer to return the requested\r | |
191 | array of handles that support SMM FVB protocol.\r | |
192 | \r | |
193 | @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of\r | |
194 | handles in Buffer was returned in NumberHandles.\r | |
195 | @retval EFI_NOT_FOUND No SMM FVB handle was found.\r | |
196 | @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.\r | |
197 | @retval EFI_INVALID_PARAMETER NumberHandles is NULL or Buffer is NULL.\r | |
198 | \r | |
199 | **/\r | |
200 | EFI_STATUS\r | |
201 | GetFvbCountAndBuffer (\r | |
202 | OUT UINTN *NumberHandles,\r | |
203 | OUT EFI_HANDLE **Buffer\r | |
204 | )\r | |
205 | {\r | |
206 | EFI_STATUS Status;\r | |
207 | UINTN BufferSize;\r | |
208 | \r | |
209 | if ((NumberHandles == NULL) || (Buffer == NULL)) {\r | |
210 | return EFI_INVALID_PARAMETER;\r | |
211 | }\r | |
212 | \r | |
213 | BufferSize = 0;\r | |
214 | *NumberHandles = 0;\r | |
215 | *Buffer = NULL;\r | |
216 | Status = gSmst->SmmLocateHandle (\r | |
217 | ByProtocol,\r | |
218 | &gEfiSmmFirmwareVolumeBlockProtocolGuid,\r | |
219 | NULL,\r | |
220 | &BufferSize,\r | |
221 | *Buffer\r | |
222 | );\r | |
223 | if (EFI_ERROR(Status) && Status != EFI_BUFFER_TOO_SMALL) {\r | |
224 | return EFI_NOT_FOUND;\r | |
225 | }\r | |
226 | \r | |
227 | *Buffer = AllocatePool (BufferSize);\r | |
228 | if (*Buffer == NULL) {\r | |
229 | return EFI_OUT_OF_RESOURCES;\r | |
230 | }\r | |
231 | \r | |
232 | Status = gSmst->SmmLocateHandle (\r | |
233 | ByProtocol,\r | |
234 | &gEfiSmmFirmwareVolumeBlockProtocolGuid,\r | |
235 | NULL,\r | |
236 | &BufferSize,\r | |
237 | *Buffer\r | |
238 | );\r | |
239 | \r | |
240 | *NumberHandles = BufferSize / sizeof(EFI_HANDLE);\r | |
241 | if (EFI_ERROR(Status)) {\r | |
242 | *NumberHandles = 0;\r | |
d26c7e82 SZ |
243 | FreePool (*Buffer);\r |
244 | *Buffer = NULL;\r | |
8a2d4996 | 245 | }\r |
246 | \r | |
247 | return Status;\r | |
248 | }\r | |
249 | \r | |
250 | \r | |
f3b80a8e | 251 | /**\r |
252 | Get the handle of the SMM FVB protocol by the FVB base address and attributes.\r | |
253 | \r | |
254 | @param[in] Address The base address of SMM FVB protocol.\r | |
255 | @param[in] Attributes The attributes of the SMM FVB protocol.\r | |
256 | @param[out] SmmFvbHandle The handle of the SMM FVB protocol.\r | |
257 | \r | |
258 | @retval EFI_SUCCESS The FVB handle is found.\r | |
259 | @retval EFI_ABORTED The FVB protocol is not found.\r | |
260 | \r | |
261 | **/\r | |
262 | EFI_STATUS\r | |
263 | GetFvbByAddressAndAttribute (\r | |
264 | IN EFI_PHYSICAL_ADDRESS Address,\r | |
265 | IN EFI_FVB_ATTRIBUTES_2 Attributes,\r | |
266 | OUT EFI_HANDLE *SmmFvbHandle\r | |
267 | )\r | |
268 | {\r | |
269 | EFI_STATUS Status;\r | |
270 | EFI_HANDLE *HandleBuffer;\r | |
271 | UINTN HandleCount;\r | |
272 | UINTN Index;\r | |
273 | EFI_PHYSICAL_ADDRESS FvbBaseAddress;\r | |
274 | EFI_FVB_ATTRIBUTES_2 FvbAttributes;\r | |
275 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;\r | |
276 | \r | |
277 | //\r | |
278 | // Locate all handles of SMM Fvb protocol.\r | |
279 | //\r | |
280 | Status = GetFvbCountAndBuffer (&HandleCount, &HandleBuffer);\r | |
281 | if (EFI_ERROR (Status)) {\r | |
282 | return EFI_ABORTED;\r | |
283 | }\r | |
284 | \r | |
285 | //\r | |
286 | // Find the proper SMM Fvb handle by the address and attributes.\r | |
287 | //\r | |
288 | for (Index = 0; Index < HandleCount; Index++) {\r | |
289 | Status = FtwGetFvbByHandle (HandleBuffer[Index], &Fvb);\r | |
290 | if (EFI_ERROR (Status)) {\r | |
291 | break;\r | |
292 | }\r | |
293 | //\r | |
294 | // Compare the address.\r | |
295 | //\r | |
296 | Status = Fvb->GetPhysicalAddress (Fvb, &FvbBaseAddress);\r | |
297 | if (EFI_ERROR (Status)) {\r | |
298 | continue;\r | |
299 | }\r | |
300 | if (Address != FvbBaseAddress) {\r | |
301 | continue;\r | |
302 | }\r | |
303 | \r | |
304 | //\r | |
305 | // Compare the attribute.\r | |
306 | //\r | |
307 | Status = Fvb->GetAttributes (Fvb, &FvbAttributes);\r | |
308 | if (EFI_ERROR (Status)) {\r | |
309 | continue;\r | |
310 | }\r | |
311 | if (Attributes != FvbAttributes) {\r | |
312 | continue;\r | |
313 | }\r | |
314 | \r | |
315 | //\r | |
316 | // Found the proper FVB handle.\r | |
317 | //\r | |
318 | *SmmFvbHandle = HandleBuffer[Index];\r | |
319 | FreePool (HandleBuffer);\r | |
320 | return EFI_SUCCESS;\r | |
321 | }\r | |
322 | \r | |
323 | FreePool (HandleBuffer);\r | |
324 | return EFI_ABORTED;\r | |
325 | }\r | |
326 | \r | |
327 | /**\r | |
328 | Communication service SMI Handler entry.\r | |
329 | \r | |
330 | This SMI handler provides services for the fault tolerant write wrapper driver.\r | |
331 | \r | |
c219324c ED |
332 | Caution: This function requires additional review when modified.\r |
333 | This driver need to make sure the CommBuffer is not in the SMRAM range. \r | |
334 | Also in FTW_FUNCTION_GET_LAST_WRITE case, check SmmFtwGetLastWriteHeader->Data + \r | |
335 | SmmFtwGetLastWriteHeader->PrivateDataSize within communication buffer.\r | |
336 | \r | |
f3b80a8e | 337 | @param[in] DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r |
338 | @param[in] RegisterContext Points to an optional handler context which was specified when the\r | |
339 | handler was registered.\r | |
340 | @param[in, out] CommBuffer A pointer to a collection of data in memory that will be conveyed\r | |
341 | from a non-SMM environment into an SMM environment.\r | |
342 | @param[in, out] CommBufferSize The size of the CommBuffer.\r | |
343 | \r | |
344 | @retval EFI_SUCCESS The interrupt was handled and quiesced. No other handlers \r | |
345 | should still be called.\r | |
346 | @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED The interrupt has been quiesced but other handlers should \r | |
347 | still be called.\r | |
348 | @retval EFI_WARN_INTERRUPT_SOURCE_PENDING The interrupt is still pending and other handlers should still \r | |
349 | be called.\r | |
350 | @retval EFI_INTERRUPT_PENDING The interrupt could not be quiesced.\r | |
351 | \r | |
352 | **/\r | |
353 | EFI_STATUS\r | |
354 | EFIAPI\r | |
355 | SmmFaultTolerantWriteHandler (\r | |
356 | IN EFI_HANDLE DispatchHandle,\r | |
357 | IN CONST VOID *RegisterContext,\r | |
358 | IN OUT VOID *CommBuffer,\r | |
359 | IN OUT UINTN *CommBufferSize\r | |
360 | )\r | |
361 | {\r | |
362 | EFI_STATUS Status;\r | |
363 | SMM_FTW_COMMUNICATE_FUNCTION_HEADER *SmmFtwFunctionHeader;\r | |
364 | SMM_FTW_GET_MAX_BLOCK_SIZE_HEADER *SmmGetMaxBlockSizeHeader;\r | |
365 | SMM_FTW_ALLOCATE_HEADER *SmmFtwAllocateHeader;\r | |
366 | SMM_FTW_WRITE_HEADER *SmmFtwWriteHeader;\r | |
367 | SMM_FTW_RESTART_HEADER *SmmFtwRestartHeader;\r | |
368 | SMM_FTW_GET_LAST_WRITE_HEADER *SmmFtwGetLastWriteHeader;\r | |
369 | VOID *PrivateData;\r | |
370 | EFI_HANDLE SmmFvbHandle;\r | |
7ea4cf3f | 371 | UINTN InfoSize;\r |
5e5bb2a9 SZ |
372 | UINTN CommBufferPayloadSize;\r |
373 | UINTN PrivateDataSize;\r | |
374 | UINTN Length;\r | |
164a9b67 | 375 | UINTN TempCommBufferSize;\r |
7ea4cf3f SZ |
376 | \r |
377 | //\r | |
378 | // If input is invalid, stop processing this SMI\r | |
379 | //\r | |
380 | if (CommBuffer == NULL || CommBufferSize == NULL) {\r | |
381 | return EFI_SUCCESS;\r | |
382 | }\r | |
383 | \r | |
164a9b67 SZ |
384 | TempCommBufferSize = *CommBufferSize;\r |
385 | \r | |
386 | if (TempCommBufferSize < SMM_FTW_COMMUNICATE_HEADER_SIZE) {\r | |
5e5bb2a9 | 387 | DEBUG ((EFI_D_ERROR, "SmmFtwHandler: SMM communication buffer size invalid!\n"));\r |
7ea4cf3f SZ |
388 | return EFI_SUCCESS;\r |
389 | }\r | |
164a9b67 | 390 | CommBufferPayloadSize = TempCommBufferSize - SMM_FTW_COMMUNICATE_HEADER_SIZE;\r |
f3b80a8e | 391 | \r |
164a9b67 | 392 | if (!InternalIsAddressValid ((UINTN)CommBuffer, TempCommBufferSize)) {\r |
5e5bb2a9 | 393 | DEBUG ((EFI_D_ERROR, "SmmFtwHandler: SMM communication buffer in SMRAM or overflow!\n"));\r |
c219324c ED |
394 | return EFI_SUCCESS;\r |
395 | }\r | |
396 | \r | |
f3b80a8e | 397 | SmmFtwFunctionHeader = (SMM_FTW_COMMUNICATE_FUNCTION_HEADER *)CommBuffer;\r |
f07268bd SZ |
398 | \r |
399 | if (mEndOfDxe) {\r | |
400 | //\r | |
401 | // It will be not safe to expose the operations after End Of Dxe.\r | |
402 | //\r | |
403 | DEBUG ((EFI_D_ERROR, "SmmFtwHandler: Not safe to do the operation: %x after End Of Dxe, so access denied!\n", SmmFtwFunctionHeader->Function));\r | |
404 | SmmFtwFunctionHeader->ReturnStatus = EFI_ACCESS_DENIED;\r | |
405 | return EFI_SUCCESS;\r | |
406 | }\r | |
407 | \r | |
f3b80a8e | 408 | switch (SmmFtwFunctionHeader->Function) {\r |
409 | case FTW_FUNCTION_GET_MAX_BLOCK_SIZE:\r | |
5e5bb2a9 SZ |
410 | if (CommBufferPayloadSize < sizeof (SMM_FTW_GET_MAX_BLOCK_SIZE_HEADER)) {\r |
411 | DEBUG ((EFI_D_ERROR, "GetMaxBlockSize: SMM communication buffer size invalid!\n"));\r | |
412 | return EFI_SUCCESS;\r | |
7ea4cf3f | 413 | }\r |
5e5bb2a9 | 414 | SmmGetMaxBlockSizeHeader = (SMM_FTW_GET_MAX_BLOCK_SIZE_HEADER *) SmmFtwFunctionHeader->Data;\r |
7ea4cf3f | 415 | \r |
f3b80a8e | 416 | Status = FtwGetMaxBlockSize (\r |
417 | &mFtwDevice->FtwInstance,\r | |
418 | &SmmGetMaxBlockSizeHeader->BlockSize\r | |
419 | );\r | |
420 | break;\r | |
421 | \r | |
422 | case FTW_FUNCTION_ALLOCATE:\r | |
5e5bb2a9 SZ |
423 | if (CommBufferPayloadSize < sizeof (SMM_FTW_ALLOCATE_HEADER)) {\r |
424 | DEBUG ((EFI_D_ERROR, "Allocate: SMM communication buffer size invalid!\n"));\r | |
425 | return EFI_SUCCESS;\r | |
426 | }\r | |
f3b80a8e | 427 | SmmFtwAllocateHeader = (SMM_FTW_ALLOCATE_HEADER *) SmmFtwFunctionHeader->Data;\r |
428 | Status = FtwAllocate (\r | |
429 | &mFtwDevice->FtwInstance,\r | |
430 | &SmmFtwAllocateHeader->CallerId,\r | |
431 | SmmFtwAllocateHeader->PrivateDataSize,\r | |
432 | SmmFtwAllocateHeader->NumberOfWrites\r | |
433 | );\r | |
434 | break;\r | |
435 | \r | |
436 | case FTW_FUNCTION_WRITE:\r | |
5e5bb2a9 SZ |
437 | if (CommBufferPayloadSize < OFFSET_OF (SMM_FTW_WRITE_HEADER, Data)) {\r |
438 | DEBUG ((EFI_D_ERROR, "Write: SMM communication buffer size invalid!\n"));\r | |
439 | return EFI_SUCCESS;\r | |
440 | }\r | |
f3b80a8e | 441 | SmmFtwWriteHeader = (SMM_FTW_WRITE_HEADER *) SmmFtwFunctionHeader->Data;\r |
5e5bb2a9 SZ |
442 | Length = SmmFtwWriteHeader->Length;\r |
443 | PrivateDataSize = SmmFtwWriteHeader->PrivateDataSize;\r | |
444 | if (((UINTN)(~0) - Length < OFFSET_OF (SMM_FTW_WRITE_HEADER, Data)) ||\r | |
445 | ((UINTN)(~0) - PrivateDataSize < OFFSET_OF (SMM_FTW_WRITE_HEADER, Data) + Length)) {\r | |
446 | //\r | |
447 | // Prevent InfoSize overflow\r | |
448 | //\r | |
449 | Status = EFI_ACCESS_DENIED;\r | |
450 | break;\r | |
451 | }\r | |
452 | InfoSize = OFFSET_OF (SMM_FTW_WRITE_HEADER, Data) + Length + PrivateDataSize;\r | |
453 | \r | |
454 | //\r | |
455 | // SMRAM range check already covered before\r | |
456 | //\r | |
457 | if (InfoSize > CommBufferPayloadSize) {\r | |
458 | DEBUG ((EFI_D_ERROR, "Write: Data size exceed communication buffer size limit!\n"));\r | |
459 | Status = EFI_ACCESS_DENIED;\r | |
460 | break;\r | |
461 | }\r | |
462 | \r | |
463 | if (PrivateDataSize == 0) {\r | |
f3b80a8e | 464 | PrivateData = NULL;\r |
465 | } else {\r | |
5e5bb2a9 | 466 | PrivateData = (VOID *)&SmmFtwWriteHeader->Data[Length];\r |
f3b80a8e | 467 | }\r |
468 | Status = GetFvbByAddressAndAttribute (\r | |
469 | SmmFtwWriteHeader->FvbBaseAddress, \r | |
470 | SmmFtwWriteHeader->FvbAttributes,\r | |
471 | &SmmFvbHandle\r | |
472 | );\r | |
473 | if (!EFI_ERROR (Status)) {\r | |
474 | Status = FtwWrite(\r | |
475 | &mFtwDevice->FtwInstance,\r | |
476 | SmmFtwWriteHeader->Lba,\r | |
477 | SmmFtwWriteHeader->Offset,\r | |
5e5bb2a9 | 478 | Length,\r |
f3b80a8e | 479 | PrivateData,\r |
480 | SmmFvbHandle,\r | |
481 | SmmFtwWriteHeader->Data\r | |
482 | );\r | |
483 | }\r | |
484 | break;\r | |
485 | \r | |
486 | case FTW_FUNCTION_RESTART:\r | |
5e5bb2a9 SZ |
487 | if (CommBufferPayloadSize < sizeof (SMM_FTW_RESTART_HEADER)) {\r |
488 | DEBUG ((EFI_D_ERROR, "Restart: SMM communication buffer size invalid!\n"));\r | |
489 | return EFI_SUCCESS;\r | |
490 | }\r | |
f3b80a8e | 491 | SmmFtwRestartHeader = (SMM_FTW_RESTART_HEADER *) SmmFtwFunctionHeader->Data;\r |
492 | Status = GetFvbByAddressAndAttribute (\r | |
493 | SmmFtwRestartHeader->FvbBaseAddress, \r | |
494 | SmmFtwRestartHeader->FvbAttributes,\r | |
495 | &SmmFvbHandle\r | |
496 | ); \r | |
497 | if (!EFI_ERROR (Status)) {\r | |
498 | Status = FtwRestart (&mFtwDevice->FtwInstance, SmmFvbHandle);\r | |
499 | }\r | |
500 | break;\r | |
501 | \r | |
502 | case FTW_FUNCTION_ABORT:\r | |
503 | Status = FtwAbort (&mFtwDevice->FtwInstance);\r | |
504 | break;\r | |
505 | \r | |
506 | case FTW_FUNCTION_GET_LAST_WRITE:\r | |
5e5bb2a9 SZ |
507 | if (CommBufferPayloadSize < OFFSET_OF (SMM_FTW_GET_LAST_WRITE_HEADER, Data)) {\r |
508 | DEBUG ((EFI_D_ERROR, "GetLastWrite: SMM communication buffer size invalid!\n"));\r | |
509 | return EFI_SUCCESS;\r | |
510 | }\r | |
f3b80a8e | 511 | SmmFtwGetLastWriteHeader = (SMM_FTW_GET_LAST_WRITE_HEADER *) SmmFtwFunctionHeader->Data;\r |
5e5bb2a9 SZ |
512 | PrivateDataSize = SmmFtwGetLastWriteHeader->PrivateDataSize;\r |
513 | if ((UINTN)(~0) - PrivateDataSize < OFFSET_OF (SMM_FTW_GET_LAST_WRITE_HEADER, Data)){\r | |
f07268bd SZ |
514 | //\r |
515 | // Prevent InfoSize overflow\r | |
516 | //\r | |
517 | Status = EFI_ACCESS_DENIED;\r | |
518 | break;\r | |
519 | }\r | |
5e5bb2a9 | 520 | InfoSize = OFFSET_OF (SMM_FTW_GET_LAST_WRITE_HEADER, Data) + PrivateDataSize;\r |
7ea4cf3f SZ |
521 | \r |
522 | //\r | |
523 | // SMRAM range check already covered before\r | |
524 | //\r | |
5e5bb2a9 | 525 | if (InfoSize > CommBufferPayloadSize) {\r |
7ea4cf3f SZ |
526 | DEBUG ((EFI_D_ERROR, "Data size exceed communication buffer size limit!\n"));\r |
527 | Status = EFI_ACCESS_DENIED;\r | |
528 | break;\r | |
c219324c | 529 | }\r |
7ea4cf3f SZ |
530 | \r |
531 | Status = FtwGetLastWrite (\r | |
532 | &mFtwDevice->FtwInstance,\r | |
533 | &SmmFtwGetLastWriteHeader->CallerId,\r | |
534 | &SmmFtwGetLastWriteHeader->Lba,\r | |
535 | &SmmFtwGetLastWriteHeader->Offset,\r | |
536 | &SmmFtwGetLastWriteHeader->Length,\r | |
5e5bb2a9 | 537 | &PrivateDataSize,\r |
7ea4cf3f SZ |
538 | (VOID *)SmmFtwGetLastWriteHeader->Data,\r |
539 | &SmmFtwGetLastWriteHeader->Complete\r | |
540 | );\r | |
5e5bb2a9 | 541 | SmmFtwGetLastWriteHeader->PrivateDataSize = PrivateDataSize;\r |
f3b80a8e | 542 | break;\r |
543 | \r | |
544 | default:\r | |
f3b80a8e | 545 | Status = EFI_UNSUPPORTED;\r |
546 | }\r | |
547 | \r | |
548 | SmmFtwFunctionHeader->ReturnStatus = Status;\r | |
549 | \r | |
550 | return EFI_SUCCESS;\r | |
551 | }\r | |
552 | \r | |
553 | \r | |
8a2d4996 | 554 | /**\r |
555 | SMM Firmware Volume Block Protocol notification event handler.\r | |
556 | \r | |
557 | @param[in] Protocol Points to the protocol's unique identifier\r | |
558 | @param[in] Interface Points to the interface instance\r | |
559 | @param[in] Handle The handle on which the interface was installed\r | |
560 | \r | |
561 | @retval EFI_SUCCESS SmmEventCallback runs successfully\r | |
562 | \r | |
563 | **/\r | |
564 | EFI_STATUS\r | |
565 | EFIAPI\r | |
566 | FvbNotificationEvent (\r | |
567 | IN CONST EFI_GUID *Protocol,\r | |
568 | IN VOID *Interface,\r | |
569 | IN EFI_HANDLE Handle\r | |
570 | )\r | |
571 | {\r | |
572 | EFI_STATUS Status;\r | |
573 | EFI_SMM_FAULT_TOLERANT_WRITE_PROTOCOL *FtwProtocol;\r | |
f3b80a8e | 574 | EFI_HANDLE SmmFtwHandle;\r |
5e5bb2a9 | 575 | EFI_HANDLE FtwHandle;\r |
8a2d4996 | 576 | \r |
577 | //\r | |
578 | // Just return to avoid install SMM FaultTolerantWriteProtocol again\r | |
579 | // if SMM Fault Tolerant Write protocol had been installed.\r | |
580 | // \r | |
581 | Status = gSmst->SmmLocateProtocol (\r | |
582 | &gEfiSmmFaultTolerantWriteProtocolGuid, \r | |
583 | NULL, \r | |
584 | (VOID **) &FtwProtocol\r | |
585 | );\r | |
586 | if (!EFI_ERROR (Status)) {\r | |
587 | return EFI_SUCCESS;\r | |
588 | }\r | |
589 | \r | |
590 | //\r | |
591 | // Found proper FVB protocol and initialize FtwDevice for protocol installation\r | |
592 | //\r | |
f3b80a8e | 593 | Status = InitFtwProtocol (mFtwDevice);\r |
8a2d4996 | 594 | if (EFI_ERROR(Status)) {\r |
595 | return Status;\r | |
596 | }\r | |
5e5bb2a9 | 597 | \r |
8a2d4996 | 598 | //\r |
599 | // Install protocol interface\r | |
600 | //\r | |
601 | Status = gSmst->SmmInstallProtocolInterface (\r | |
f3b80a8e | 602 | &mFtwDevice->Handle,\r |
8a2d4996 | 603 | &gEfiSmmFaultTolerantWriteProtocolGuid,\r |
604 | EFI_NATIVE_INTERFACE,\r | |
f3b80a8e | 605 | &mFtwDevice->FtwInstance\r |
8a2d4996 | 606 | );\r |
607 | ASSERT_EFI_ERROR (Status); \r | |
f3b80a8e | 608 | \r |
5e5bb2a9 SZ |
609 | ///\r |
610 | /// Register SMM FTW SMI handler\r | |
611 | ///\r | |
612 | Status = gSmst->SmiHandlerRegister (SmmFaultTolerantWriteHandler, &gEfiSmmFaultTolerantWriteProtocolGuid, &SmmFtwHandle);\r | |
613 | ASSERT_EFI_ERROR (Status);\r | |
614 | \r | |
f3b80a8e | 615 | //\r |
616 | // Notify the Ftw wrapper driver SMM Ftw is ready\r | |
617 | //\r | |
5e5bb2a9 | 618 | FtwHandle = NULL;\r |
f3b80a8e | 619 | Status = gBS->InstallProtocolInterface (\r |
5e5bb2a9 | 620 | &FtwHandle,\r |
f3b80a8e | 621 | &gEfiSmmFaultTolerantWriteProtocolGuid,\r |
622 | EFI_NATIVE_INTERFACE,\r | |
623 | NULL\r | |
624 | );\r | |
625 | ASSERT_EFI_ERROR (Status);\r | |
8a2d4996 | 626 | \r |
627 | return EFI_SUCCESS;\r | |
628 | }\r | |
629 | \r | |
f07268bd SZ |
630 | /**\r |
631 | SMM END_OF_DXE protocol notification event handler.\r | |
632 | \r | |
633 | @param Protocol Points to the protocol's unique identifier\r | |
634 | @param Interface Points to the interface instance\r | |
635 | @param Handle The handle on which the interface was installed\r | |
636 | \r | |
637 | @retval EFI_SUCCESS SmmEndOfDxeCallback runs successfully\r | |
638 | \r | |
639 | **/\r | |
640 | EFI_STATUS\r | |
641 | EFIAPI\r | |
642 | SmmEndOfDxeCallback (\r | |
643 | IN CONST EFI_GUID *Protocol,\r | |
644 | IN VOID *Interface,\r | |
645 | IN EFI_HANDLE Handle\r | |
646 | )\r | |
647 | {\r | |
648 | mEndOfDxe = TRUE;\r | |
649 | return EFI_SUCCESS;\r | |
650 | }\r | |
8a2d4996 | 651 | \r |
652 | /**\r | |
653 | This function is the entry point of the Fault Tolerant Write driver.\r | |
654 | \r | |
655 | @param[in] ImageHandle A handle for the image that is initializing this driver\r | |
656 | @param[in] SystemTable A pointer to the EFI system table\r | |
657 | \r | |
658 | @retval EFI_SUCCESS The initialization finished successfully.\r | |
659 | @retval EFI_OUT_OF_RESOURCES Allocate memory error\r | |
660 | @retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist\r | |
661 | \r | |
662 | **/\r | |
663 | EFI_STATUS\r | |
664 | EFIAPI\r | |
665 | SmmFaultTolerantWriteInitialize (\r | |
666 | IN EFI_HANDLE ImageHandle,\r | |
667 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
668 | )\r | |
669 | {\r | |
670 | EFI_STATUS Status;\r | |
c219324c ED |
671 | EFI_SMM_ACCESS2_PROTOCOL *SmmAccess;\r |
672 | UINTN Size;\r | |
f07268bd SZ |
673 | VOID *SmmEndOfDxeRegistration;\r |
674 | \r | |
8a2d4996 | 675 | //\r |
676 | // Allocate private data structure for SMM FTW protocol and do some initialization\r | |
677 | //\r | |
f3b80a8e | 678 | Status = InitFtwDevice (&mFtwDevice);\r |
8a2d4996 | 679 | if (EFI_ERROR(Status)) {\r |
680 | return Status;\r | |
681 | }\r | |
c219324c ED |
682 | \r |
683 | //\r | |
684 | // Get SMRAM information\r | |
685 | //\r | |
686 | Status = gBS->LocateProtocol (&gEfiSmmAccess2ProtocolGuid, NULL, (VOID **)&SmmAccess);\r | |
687 | ASSERT_EFI_ERROR (Status);\r | |
688 | \r | |
689 | Size = 0;\r | |
690 | Status = SmmAccess->GetCapabilities (SmmAccess, &Size, NULL);\r | |
691 | ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r | |
692 | \r | |
693 | Status = gSmst->SmmAllocatePool (\r | |
694 | EfiRuntimeServicesData,\r | |
695 | Size,\r | |
696 | (VOID **)&mSmramRanges\r | |
697 | );\r | |
698 | ASSERT_EFI_ERROR (Status);\r | |
699 | \r | |
700 | Status = SmmAccess->GetCapabilities (SmmAccess, &Size, mSmramRanges);\r | |
701 | ASSERT_EFI_ERROR (Status);\r | |
702 | \r | |
703 | mSmramRangeCount = Size / sizeof (EFI_SMRAM_DESCRIPTOR);\r | |
704 | \r | |
f07268bd SZ |
705 | //\r |
706 | // Register EFI_SMM_END_OF_DXE_PROTOCOL_GUID notify function.\r | |
707 | //\r | |
708 | Status = gSmst->SmmRegisterProtocolNotify (\r | |
709 | &gEfiSmmEndOfDxeProtocolGuid,\r | |
710 | SmmEndOfDxeCallback,\r | |
711 | &SmmEndOfDxeRegistration\r | |
712 | );\r | |
713 | ASSERT_EFI_ERROR (Status);\r | |
714 | \r | |
8a2d4996 | 715 | //\r |
716 | // Register FvbNotificationEvent () notify function.\r | |
717 | // \r | |
718 | Status = gSmst->SmmRegisterProtocolNotify (\r | |
719 | &gEfiSmmFirmwareVolumeBlockProtocolGuid,\r | |
720 | FvbNotificationEvent,\r | |
721 | &mFvbRegistration\r | |
722 | );\r | |
723 | ASSERT_EFI_ERROR (Status);\r | |
724 | \r | |
725 | FvbNotificationEvent (NULL, NULL, NULL);\r | |
726 | \r | |
727 | return EFI_SUCCESS;\r | |
728 | }\r |