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
156 // Fault Tolerant Write Protocol API
159 Starts a target block update. This function will record data about write
160 in fault tolerant storage and will complete the write in a recoverable
161 manner, ensuring at all times that either the original contents or
162 the modified contents are available.
165 @param This Calling context
166 @param FvbHandle The handle of FVB protocol that provides services for
167 reading, writing, and erasing the target block.
168 @param Lba The logical block address of the target block.
169 @param Offset The offset within the target block to place the data.
170 @param NumBytes The number of bytes to write to the target block.
171 @param Buffer The data to write.
173 @retval EFI_SUCCESS The function completed successfully
174 @retval EFI_BAD_BUFFER_SIZE The write would span a target block, which is not
176 @retval EFI_ACCESS_DENIED No writes have been allocated.
177 @retval EFI_NOT_FOUND Cannot find FVB by handle.
178 @retval EFI_OUT_OF_RESOURCES Cannot allocate memory.
179 @retval EFI_ABORTED The function could not complete successfully.
185 IN EFI_FTW_LITE_PROTOCOL
*This
,
186 IN EFI_HANDLE FvbHandle
,
189 IN OUT UINTN
*NumBytes
,
194 // Internal functions
197 Restarts a previously interrupted write. The caller must provide the
198 block protocol needed to complete the interrupted write.
201 @param FtwLiteDevice The private data of FTW_LITE driver
202 FvbHandle - The handle of FVB protocol that provides services for
203 reading, writing, and erasing the target block.
205 @retval EFI_SUCCESS The function completed successfully
206 @retval EFI_ACCESS_DENIED No pending writes exist
207 @retval EFI_NOT_FOUND FVB protocol not found by the handle
208 @retval EFI_ABORTED The function could not complete successfully
213 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
217 Aborts all previous allocated writes.
220 @param FtwLiteDevice The private data of FTW_LITE driver
222 @retval EFI_SUCCESS The function completed successfully
223 @retval EFI_ABORTED The function could not complete successfully.
224 @retval EFI_NOT_FOUND No allocated writes exist.
229 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
234 Write a record with fault tolerant mannaer.
235 Since the content has already backuped in spare block, the write is
236 guaranteed to be completed with fault tolerant manner.
239 @param FtwLiteDevice The private data of FTW_LITE driver
240 @param Fvb The FVB protocol that provides services for
241 reading, writing, and erasing the target block.
243 @retval EFI_SUCCESS The function completed successfully
244 @retval EFI_ABORTED The function could not complete successfully
249 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
250 IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
254 To Erase one block. The size is FTW_BLOCK_SIZE
257 @param FtwLiteDevice Calling context
258 @param FvBlock FVB Protocol interface
259 @param Lba Lba of the firmware block
261 @retval EFI_SUCCESS Block LBA is Erased successfully
262 @retval Others Error occurs
267 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
268 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
277 @param FtwLiteDevice Calling context
279 @retval EFI_SUCCESS The erase request was successfully
282 @retval EFI_ACCESS_DENIED The firmware volume is in the
284 @retval EFI_DEVICE_ERROR The block device is not functioning
285 correctly and could not be written.
286 The firmware device may have been
288 @retval EFI_INVALID_PARAMETER One or more of the LBAs listed
289 in the variable argument list do
290 not exist in the firmware volume.
295 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
299 Retrive the proper FVB protocol interface by HANDLE.
302 @param FvBlockHandle The handle of FVB protocol that provides services for
303 reading, writing, and erasing the target block.
304 @param FvBlock The interface of FVB protocol
306 @retval EFI_SUCCESS The function completed successfully
307 @retval EFI_ABORTED The function could not complete successfully
312 IN EFI_HANDLE FvBlockHandle
,
313 OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
**FvBlock
318 Get firmware block by address.
321 @param Address Address specified the block
322 @param FvBlock The block caller wanted
324 @retval EFI_SUCCESS The protocol instance if found.
325 @retval EFI_NOT_FOUND Block not found
330 IN EFI_PHYSICAL_ADDRESS Address
,
331 OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
**FvBlock
336 Is it in working block?
339 @param FtwLiteDevice Calling context
340 @param FvBlock Fvb protocol instance
341 @param Lba The block specified
343 @return A BOOLEAN value indicating in working block or not.
348 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
349 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
355 Check whether the block is a boot block.
358 @param FtwLiteDevice Calling context
359 @param FvBlock Fvb protocol instance
362 @retval FALSE This is a boot block.
363 @retval TRUE This is not a boot block.
368 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
369 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
374 Copy the content of spare block to a target block. Size is FTW_BLOCK_SIZE.
375 Spare block is accessed by FTW backup FVB protocol interface. LBA is
376 FtwLiteDevice->FtwSpareLba.
377 Target block is accessed by FvBlock protocol interface. LBA is Lba.
380 @param FtwLiteDevice The private data of FTW_LITE driver
381 @param FvBlock FVB Protocol interface to access target block
382 @param Lba Lba of the target block
384 @retval EFI_SUCCESS Spare block content is copied to target block
385 @retval EFI_INVALID_PARAMETER Input parameter error
386 @retval EFI_OUT_OF_RESOURCES Allocate memory error
387 @retval EFI_ABORTED The function could not complete successfully
391 FlushSpareBlockToTargetBlock (
392 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
393 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
398 Copy the content of spare block to working block. Size is FTW_BLOCK_SIZE.
399 Spare block is accessed by FTW backup FVB protocol interface. LBA is
400 FtwLiteDevice->FtwSpareLba.
401 Working block is accessed by FTW working FVB protocol interface. LBA is
402 FtwLiteDevice->FtwWorkBlockLba.
405 @param FtwLiteDevice The private data of FTW_LITE driver
407 @retval EFI_SUCCESS Spare block content is copied to target block
408 @retval EFI_OUT_OF_RESOURCES Allocate memory error
409 @retval EFI_ABORTED The function could not complete successfully
411 Since the working block header is important when FTW initializes, the
412 state of the operation should be handled carefully. The Crc value is
413 calculated without STATE element.
417 FlushSpareBlockToWorkingBlock (
418 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
422 Copy the content of spare block to a boot block. Size is FTW_BLOCK_SIZE.
423 Spare block is accessed by FTW backup FVB protocol interface. LBA is
424 FtwLiteDevice->FtwSpareLba.
425 Boot block is accessed by BootFvb protocol interface. LBA is 0.
428 @param FtwLiteDevice The private data of FTW_LITE driver
430 @retval EFI_SUCCESS Spare block content is copied to boot block
431 @retval EFI_INVALID_PARAMETER Input parameter error
432 @retval EFI_OUT_OF_RESOURCES Allocate memory error
433 @retval EFI_ABORTED The function could not complete successfully
438 FlushSpareBlockToBootBlock (
439 EFI_FTW_LITE_DEVICE
*FtwLiteDevice
443 Update a bit of state on a block device. The location of the bit is
444 calculated by the (Lba, Offset, bit). Here bit is determined by the
445 the name of a certain bit.
448 @param FvBlock FVB Protocol interface to access SrcBlock and DestBlock
449 @param Lba Lba of a block
450 @param Offset Offset on the Lba
451 @param NewBit New value that will override the old value if it can be change
453 @retval EFI_SUCCESS A state bit has been updated successfully
454 @retval Others Access block device error.
456 Assume all bits of State are inside the same BYTE.
457 @retval EFI_ABORTED Read block fail
462 IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvBlock
,
469 Get the last Write record pointer.
470 The last record is the record whose 'complete' state hasn't been set.
471 After all, this header may be a EMPTY header entry for next Allocate.
474 @param FtwLiteDevice Private data of this driver
475 @param FtwLastRecord Pointer to retrieve the last write record
477 @retval EFI_SUCCESS Get the last write record successfully
478 @retval EFI_ABORTED The FTW work space is damaged
483 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
484 OUT EFI_FTW_LITE_RECORD
**FtwLastRecord
489 Check whether a flash buffer is erased.
492 @param Polarity All 1 or all 0
493 @param Buffer Buffer to check
494 @param BufferSize Size of the buffer
496 @return A BOOLEAN value indicating erased or not.
500 IsErasedFlashBuffer (
507 Initialize a work space when there is no work space.
510 @param WorkingHeader Pointer of working block header
512 @retval EFI_SUCCESS The function completed successfully
513 @retval EFI_ABORTED The function could not complete successfully.
517 InitWorkSpaceHeader (
518 IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER
*WorkingHeader
522 Read from working block to refresh the work space in memory.
525 @param FtwLiteDevice Point to private data of FTW driver
527 @retval EFI_SUCCESS The function completed successfully
528 @retval EFI_ABORTED The function could not complete successfully.
533 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
537 Check to see if it is a valid work space.
540 @param WorkingHeader Pointer of working block header
542 @retval EFI_SUCCESS The function completed successfully
543 @retval EFI_ABORTED The function could not complete successfully.
548 IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER
*WorkingHeader
552 Reclaim the work space on the working block.
555 @param FtwLiteDevice Point to private data of FTW driver
556 @param PreserveRecord Whether to preserve the working record is needed
558 @retval EFI_SUCCESS The function completed successfully
559 @retval EFI_OUT_OF_RESOURCES Allocate memory error
560 @retval EFI_ABORTED The function could not complete successfully
564 FtwReclaimWorkSpace (
565 IN EFI_FTW_LITE_DEVICE
*FtwLiteDevice
,
566 IN BOOLEAN PreserveRecord