3 The internal header file includes the common header files, defines
4 internal structure and functions used by FtwLite module.
6 Copyright (c) 2006 - 2008, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef _EFI_FAULT_TOLERANT_WRITE_LITE_H_
18 #define _EFI_FAULT_TOLERANT_WRITE_LITE_H_
23 #include <Protocol/PciRootBridgeIo.h>
24 #include <Guid/SystemNvDataGuid.h>
25 #include <Protocol/FaultTolerantWriteLite.h>
26 #include <Protocol/FirmwareVolumeBlock.h>
28 #include <Library/PcdLib.h>
29 #include <Library/DebugLib.h>
30 #include <Library/UefiDriverEntryPoint.h>
31 #include <Library/BaseMemoryLib.h>
32 #include <Library/MemoryAllocationLib.h>
33 #include <Library/UefiBootServicesTableLib.h>
35 #include <WorkingBlockHeader.h>
37 #define EFI_D_FTW_LITE EFI_D_ERROR
38 #define EFI_D_FTW_INFO EFI_D_INFO
41 // Flash erase polarity is 1
43 #define FTW_ERASE_POLARITY 1
45 #define FTW_VALID_STATE 0
46 #define FTW_INVALID_STATE 1
48 #define FTW_ERASED_BYTE ((UINT8) (255))
49 #define FTW_POLARITY_REVERT ((UINT8) (255))
52 UINT8 WriteAllocated
: 1;
53 UINT8 SpareCompleted
: 1;
54 UINT8 WriteCompleted
: 1;
56 #define WRITE_ALLOCATED 0x1
57 #define SPARE_COMPLETED 0x2
58 #define WRITE_COMPLETED 0x4
65 // UINTN SpareAreaOffset;
67 } EFI_FTW_LITE_RECORD
;
69 #define FTW_LITE_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('F', 'T', 'W', 'L')
72 // MACRO for Block size.
73 // Flash Erasing will do in block granularity.
76 #define FTW_BLOCK_SIZE FV_BLOCK_SIZE
78 #define FV_BLOCK_SIZE 0x10000
79 #define FTW_BLOCK_SIZE FV_BLOCK_SIZE
82 // MACRO for FTW WORK SPACE Base & Size
84 #ifdef EFI_FTW_WORKING_OFFSET
85 #define FTW_WORK_SPACE_BASE EFI_FTW_WORKING_OFFSET
87 #define FTW_WORK_SPACE_BASE 0x00E000
90 #ifdef EFI_FTW_WORKING_LENGTH
91 #define FTW_WORK_SPACE_SIZE EFI_FTW_WORKING_LENGTH
93 #define FTW_WORK_SPACE_SIZE 0x002000
96 // MACRO for FTW header and record
98 #define FTW_WORKING_QUEUE_SIZE (FTW_WORK_SPACE_SIZE - sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER))
99 #define FTW_LITE_RECORD_SIZE (sizeof (EFI_FTW_LITE_RECORD))
100 #define WRITE_TOTAL_SIZE FTW_LITE_RECORD_SIZE
103 // EFI Fault tolerant protocol private data structure
108 EFI_FTW_LITE_PROTOCOL FtwLiteInstance
;
109 EFI_PHYSICAL_ADDRESS WorkSpaceAddress
;
110 UINTN WorkSpaceLength
;
111 EFI_PHYSICAL_ADDRESS SpareAreaAddress
;
112 UINTN SpareAreaLength
;
113 UINTN NumberOfSpareBlock
; // Number of the blocks in spare block
114 UINTN SizeOfSpareBlock
; // Block size in bytes of the blocks in spare block
115 EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER
*FtwWorkSpaceHeader
;
116 EFI_FTW_LITE_RECORD
*FtwLastRecord
;
117 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FtwFvBlock
; // FVB of working block
118 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FtwBackupFvb
; // FVB of spare block
120 EFI_LBA FtwWorkBlockLba
; // Start LBA of working block
121 EFI_LBA FtwWorkSpaceLba
; // Start LBA of working space
122 UINTN FtwWorkSpaceBase
; // Offset from LBA start addr
123 UINTN FtwWorkSpaceSize
;
126 // Following a buffer of FtwWorkSpace[FTW_WORK_SPACE_SIZE],
127 // Allocated with EFI_FTW_LITE_DEVICE.
129 } EFI_FTW_LITE_DEVICE
;
131 #define FTW_LITE_CONTEXT_FROM_THIS(a) CR (a, EFI_FTW_LITE_DEVICE, FtwLiteInstance, FTW_LITE_DEVICE_SIGNATURE)
134 // Driver entry point
137 This function is the entry point of the Fault Tolerant Write driver.
140 @param ImageHandle EFI_HANDLE: A handle for the image that is initializing
142 @param SystemTable EFI_SYSTEM_TABLE: A pointer to the EFI system table
144 @retval EFI_SUCCESS FTW has finished the initialization
145 @retval EFI_ABORTED FTW initialization error
151 IN EFI_HANDLE ImageHandle
,
152 IN EFI_SYSTEM_TABLE
*SystemTable
157 // Fault Tolerant Write Protocol API
160 Starts a target block update. This function will record data about write
161 in fault tolerant storage and will complete the write in a recoverable
162 manner, ensuring at all times that either the original contents or
163 the modified contents are available.
166 @param This Calling context
167 @param FvbHandle The handle of FVB protocol that provides services for
168 reading, writing, and erasing the target block.
169 @param Lba The logical block address of the target block.
170 @param Offset The offset within the target block to place the data.
171 @param NumBytes The number of bytes to write to the target block.
172 @param Buffer The data to write.
174 @retval EFI_SUCCESS The function completed successfully
175 @retval EFI_BAD_BUFFER_SIZE The write would span a target block, which is not
177 @retval EFI_ACCESS_DENIED No writes have been allocated.
178 @retval EFI_NOT_FOUND Cannot find FVB by handle.
179 @retval EFI_OUT_OF_RESOURCES Cannot allocate memory.
180 @retval EFI_ABORTED The function could not complete successfully.
186 IN EFI_FTW_LITE_PROTOCOL
*This
,
187 IN EFI_HANDLE FvbHandle
,
190 IN OUT UINTN
*NumBytes
,
196 // Internal functions
199 Restarts a previously interrupted write. The caller must provide the
200 block protocol needed to complete the interrupted write.
203 @param FtwLiteDevice The private data of FTW_LITE driver
204 FvbHandle - The handle of FVB protocol that provides services for
205 reading, writing, and erasing the target block.
207 @retval EFI_SUCCESS The function completed successfully
208 @retval EFI_ACCESS_DENIED No pending writes exist
209 @retval EFI_NOT_FOUND FVB protocol not found by the handle
210 @retval EFI_ABORTED The function could not complete successfully
215 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
220 Aborts all previous allocated writes.
223 @param FtwLiteDevice The private data of FTW_LITE driver
225 @retval EFI_SUCCESS The function completed successfully
226 @retval EFI_ABORTED The function could not complete successfully.
227 @retval EFI_NOT_FOUND No allocated writes exist.
232 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
238 Write a record with fault tolerant mannaer.
239 Since the content has already backuped in spare block, the write is
240 guaranteed to be completed with fault tolerant manner.
243 @param FtwLiteDevice The private data of FTW_LITE driver
244 @param Fvb The FVB protocol that provides services for
245 reading, writing, and erasing the target block.
247 @retval EFI_SUCCESS The function completed successfully
248 @retval EFI_ABORTED The function could not complete successfully
253 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
254 IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
259 To Erase one block. The size is FTW_BLOCK_SIZE
262 @param FtwLiteDevice Calling context
263 @param FvBlock FVB Protocol interface
264 @param Lba Lba of the firmware block
266 @retval EFI_SUCCESS Block LBA is Erased successfully
267 @retval Others Error occurs
272 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
273 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
283 @param FtwLiteDevice Calling context
285 @retval EFI_SUCCESS The erase request was successfully
288 @retval EFI_ACCESS_DENIED The firmware volume is in the
290 @retval EFI_DEVICE_ERROR The block device is not functioning
291 correctly and could not be written.
292 The firmware device may have been
294 @retval EFI_INVALID_PARAMETER One or more of the LBAs listed
295 in the variable argument list do
296 not exist in the firmware volume.
301 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
306 Retrive the proper FVB protocol interface by HANDLE.
309 @param FvBlockHandle The handle of FVB protocol that provides services for
310 reading, writing, and erasing the target block.
311 @param FvBlock The interface of FVB protocol
313 @retval EFI_SUCCESS The function completed successfully
314 @retval EFI_ABORTED The function could not complete successfully
319 IN EFI_HANDLE FvBlockHandle
,
320 OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
**FvBlock
326 Get firmware block by address.
329 @param Address Address specified the block
330 @param FvBlock The block caller wanted
332 @retval EFI_SUCCESS The protocol instance if found.
333 @retval EFI_NOT_FOUND Block not found
338 IN EFI_PHYSICAL_ADDRESS Address
,
339 OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
**FvBlock
345 Is it in working block?
348 @param FtwLiteDevice Calling context
349 @param FvBlock Fvb protocol instance
350 @param Lba The block specified
352 @return A BOOLEAN value indicating in working block or not.
357 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
358 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
365 Check whether the block is a boot block.
368 @param FtwLiteDevice Calling context
369 @param FvBlock Fvb protocol instance
372 @retval FALSE This is a boot block.
373 @retval TRUE This is not a boot block.
378 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
379 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
385 Copy the content of spare block to a target block. Size is FTW_BLOCK_SIZE.
386 Spare block is accessed by FTW backup FVB protocol interface. LBA is
387 FtwLiteDevice->FtwSpareLba.
388 Target block is accessed by FvBlock protocol interface. LBA is Lba.
391 @param FtwLiteDevice The private data of FTW_LITE driver
392 @param FvBlock FVB Protocol interface to access target block
393 @param Lba Lba of the target block
395 @retval EFI_SUCCESS Spare block content is copied to target block
396 @retval EFI_INVALID_PARAMETER Input parameter error
397 @retval EFI_OUT_OF_RESOURCES Allocate memory error
398 @retval EFI_ABORTED The function could not complete successfully
402 FlushSpareBlockToTargetBlock (
403 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
404 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
410 Copy the content of spare block to working block. Size is FTW_BLOCK_SIZE.
411 Spare block is accessed by FTW backup FVB protocol interface. LBA is
412 FtwLiteDevice->FtwSpareLba.
413 Working block is accessed by FTW working FVB protocol interface. LBA is
414 FtwLiteDevice->FtwWorkBlockLba.
417 @param FtwLiteDevice The private data of FTW_LITE driver
419 @retval EFI_SUCCESS Spare block content is copied to target block
420 @retval EFI_OUT_OF_RESOURCES Allocate memory error
421 @retval EFI_ABORTED The function could not complete successfully
423 Since the working block header is important when FTW initializes, the
424 state of the operation should be handled carefully. The Crc value is
425 calculated without STATE element.
429 FlushSpareBlockToWorkingBlock (
430 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
435 Copy the content of spare block to a boot block. Size is FTW_BLOCK_SIZE.
436 Spare block is accessed by FTW backup FVB protocol interface. LBA is
437 FtwLiteDevice->FtwSpareLba.
438 Boot block is accessed by BootFvb protocol interface. LBA is 0.
441 @param FtwLiteDevice The private data of FTW_LITE driver
443 @retval EFI_SUCCESS Spare block content is copied to boot block
444 @retval EFI_INVALID_PARAMETER Input parameter error
445 @retval EFI_OUT_OF_RESOURCES Allocate memory error
446 @retval EFI_ABORTED The function could not complete successfully
451 FlushSpareBlockToBootBlock (
452 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
457 Update a bit of state on a block device. The location of the bit is
458 calculated by the (Lba, Offset, bit). Here bit is determined by the
459 the name of a certain bit.
462 @param FvBlock FVB Protocol interface to access SrcBlock and DestBlock
463 @param Lba Lba of a block
464 @param Offset Offset on the Lba
465 @param NewBit New value that will override the old value if it can be change
467 @retval EFI_SUCCESS A state bit has been updated successfully
468 @retval Others Access block device error.
470 Assume all bits of State are inside the same BYTE.
471 @retval EFI_ABORTED Read block fail
476 IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
484 Get the last Write record pointer.
485 The last record is the record whose 'complete' state hasn't been set.
486 After all, this header may be a EMPTY header entry for next Allocate.
489 @param FtwLiteDevice Private data of this driver
490 @param FtwLastRecord Pointer to retrieve the last write record
492 @retval EFI_SUCCESS Get the last write record successfully
493 @retval EFI_ABORTED The FTW work space is damaged
498 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
499 OUT EFI_FTW_LITE_RECORD
**FtwLastRecord
505 Check whether a flash buffer is erased.
508 @param Polarity All 1 or all 0
509 @param Buffer Buffer to check
510 @param BufferSize Size of the buffer
512 @return A BOOLEAN value indicating erased or not.
516 IsErasedFlashBuffer (
524 Initialize a work space when there is no work space.
527 @param WorkingHeader Pointer of working block header
529 @retval EFI_SUCCESS The function completed successfully
530 @retval EFI_ABORTED The function could not complete successfully.
534 InitWorkSpaceHeader (
535 IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER
*WorkingHeader
540 Read from working block to refresh the work space in memory.
543 @param FtwLiteDevice Point to private data of FTW driver
545 @retval EFI_SUCCESS The function completed successfully
546 @retval EFI_ABORTED The function could not complete successfully.
551 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
556 Check to see if it is a valid work space.
559 @param WorkingHeader Pointer of working block header
561 @retval EFI_SUCCESS The function completed successfully
562 @retval EFI_ABORTED The function could not complete successfully.
567 IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER
*WorkingHeader
572 Reclaim the work space on the working block.
575 @param FtwLiteDevice Point to private data of FTW driver
576 @param PreserveRecord Whether to preserve the working record is needed
578 @retval EFI_SUCCESS The function completed successfully
579 @retval EFI_OUT_OF_RESOURCES Allocate memory error
580 @retval EFI_ABORTED The function could not complete successfully
584 FtwReclaimWorkSpace (
585 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
586 IN BOOLEAN PreserveRecord