]>
Commit | Line | Data |
---|---|---|
6cc9ca32 | 1 | /** @file\r |
d7dec593 | 2 | \r |
6cc9ca32 LG |
3 | The internal header file includes the common header files, defines\r |
4 | internal structure and functions used by FtwLite module.\r | |
5 | \r | |
6 | Copyright (c) 2006 - 2008, Intel Corporation \r | |
d7dec593 | 7 | All rights reserved. This program and the accompanying materials \r |
8 | are licensed and made available under the terms and conditions of the BSD License \r | |
9 | which accompanies this distribution. The full text of the license may be found at \r | |
10 | http://opensource.org/licenses/bsd-license.php \r | |
11 | \r | |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
14 | \r | |
6cc9ca32 | 15 | **/\r |
d7dec593 | 16 | \r |
17 | #ifndef _EFI_FAULT_TOLERANT_WRITE_LITE_H_\r | |
18 | #define _EFI_FAULT_TOLERANT_WRITE_LITE_H_\r | |
19 | \r | |
ed7748fe | 20 | \r |
d7dec593 | 21 | #include <PiDxe.h>\r |
ed7748fe | 22 | \r |
d7dec593 | 23 | #include <Guid/SystemNvDataGuid.h>\r |
24 | #include <Protocol/FaultTolerantWriteLite.h>\r | |
25 | #include <Protocol/FirmwareVolumeBlock.h>\r | |
ed7748fe | 26 | \r |
d7dec593 | 27 | #include <Library/PcdLib.h>\r |
28 | #include <Library/DebugLib.h>\r | |
29 | #include <Library/UefiDriverEntryPoint.h>\r | |
30 | #include <Library/BaseMemoryLib.h>\r | |
31 | #include <Library/MemoryAllocationLib.h>\r | |
32 | #include <Library/UefiBootServicesTableLib.h>\r | |
1232b214 | 33 | #include <Library/DevicePathLib.h>\r |
d7dec593 | 34 | \r |
3cfb790c | 35 | #include <WorkingBlockHeader.h>\r |
d7dec593 | 36 | \r |
37 | #define EFI_D_FTW_LITE EFI_D_ERROR\r | |
38 | #define EFI_D_FTW_INFO EFI_D_INFO\r | |
39 | \r | |
40 | //\r | |
41 | // Flash erase polarity is 1\r | |
42 | //\r | |
43 | #define FTW_ERASE_POLARITY 1\r | |
44 | \r | |
45 | #define FTW_VALID_STATE 0\r | |
46 | #define FTW_INVALID_STATE 1\r | |
47 | \r | |
48 | #define FTW_ERASED_BYTE ((UINT8) (255))\r | |
49 | #define FTW_POLARITY_REVERT ((UINT8) (255))\r | |
50 | \r | |
51 | typedef struct {\r | |
52 | UINT8 WriteAllocated : 1;\r | |
53 | UINT8 SpareCompleted : 1;\r | |
54 | UINT8 WriteCompleted : 1;\r | |
55 | UINT8 Reserved : 5;\r | |
56 | #define WRITE_ALLOCATED 0x1\r | |
57 | #define SPARE_COMPLETED 0x2\r | |
58 | #define WRITE_COMPLETED 0x4\r | |
59 | \r | |
60 | EFI_DEV_PATH DevPath;\r | |
61 | EFI_LBA Lba;\r | |
62 | UINTN Offset;\r | |
63 | UINTN NumBytes;\r | |
64 | //\r | |
65 | // UINTN SpareAreaOffset;\r | |
66 | //\r | |
67 | } EFI_FTW_LITE_RECORD;\r | |
68 | \r | |
f3f2e05d | 69 | #define FTW_LITE_DEVICE_SIGNATURE SIGNATURE_32 ('F', 'T', 'W', 'L')\r |
d7dec593 | 70 | \r |
d7dec593 | 71 | //\r |
72 | // MACRO for FTW WORK SPACE Base & Size\r | |
73 | //\r | |
74 | #ifdef EFI_FTW_WORKING_OFFSET\r | |
75 | #define FTW_WORK_SPACE_BASE EFI_FTW_WORKING_OFFSET\r | |
76 | #else\r | |
77 | #define FTW_WORK_SPACE_BASE 0x00E000\r | |
78 | #endif\r | |
79 | \r | |
80 | #ifdef EFI_FTW_WORKING_LENGTH\r | |
81 | #define FTW_WORK_SPACE_SIZE EFI_FTW_WORKING_LENGTH\r | |
82 | #else\r | |
83 | #define FTW_WORK_SPACE_SIZE 0x002000\r | |
84 | #endif\r | |
85 | //\r | |
86 | // MACRO for FTW header and record\r | |
87 | //\r | |
d7dec593 | 88 | #define FTW_LITE_RECORD_SIZE (sizeof (EFI_FTW_LITE_RECORD))\r |
d7dec593 | 89 | \r |
90 | //\r | |
91 | // EFI Fault tolerant protocol private data structure\r | |
92 | //\r | |
93 | typedef struct {\r | |
94 | UINTN Signature;\r | |
95 | EFI_HANDLE Handle;\r | |
96 | EFI_FTW_LITE_PROTOCOL FtwLiteInstance;\r | |
97 | EFI_PHYSICAL_ADDRESS WorkSpaceAddress;\r | |
98 | UINTN WorkSpaceLength;\r | |
99 | EFI_PHYSICAL_ADDRESS SpareAreaAddress;\r | |
100 | UINTN SpareAreaLength;\r | |
101 | UINTN NumberOfSpareBlock; // Number of the blocks in spare block\r | |
102 | UINTN SizeOfSpareBlock; // Block size in bytes of the blocks in spare block\r | |
103 | EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *FtwWorkSpaceHeader;\r | |
104 | EFI_FTW_LITE_RECORD *FtwLastRecord;\r | |
105 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FtwFvBlock; // FVB of working block\r | |
106 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FtwBackupFvb; // FVB of spare block\r | |
107 | EFI_LBA FtwSpareLba;\r | |
108 | EFI_LBA FtwWorkBlockLba; // Start LBA of working block\r | |
109 | EFI_LBA FtwWorkSpaceLba; // Start LBA of working space\r | |
110 | UINTN FtwWorkSpaceBase; // Offset from LBA start addr\r | |
111 | UINTN FtwWorkSpaceSize;\r | |
112 | UINT8 *FtwWorkSpace;\r | |
113 | //\r | |
114 | // Following a buffer of FtwWorkSpace[FTW_WORK_SPACE_SIZE],\r | |
115 | // Allocated with EFI_FTW_LITE_DEVICE.\r | |
116 | //\r | |
117 | } EFI_FTW_LITE_DEVICE;\r | |
118 | \r | |
119 | #define FTW_LITE_CONTEXT_FROM_THIS(a) CR (a, EFI_FTW_LITE_DEVICE, FtwLiteInstance, FTW_LITE_DEVICE_SIGNATURE)\r | |
120 | \r | |
121 | //\r | |
122 | // Driver entry point\r | |
123 | //\r | |
6aab8214 | 124 | /**\r |
125 | This function is the entry point of the Fault Tolerant Write driver.\r | |
126 | \r | |
127 | \r | |
5944a83b | 128 | @param ImageHandle A handle for the image that is initializing\r |
6aab8214 | 129 | this driver\r |
5944a83b | 130 | @param SystemTable A pointer to the EFI system table\r |
6aab8214 | 131 | \r |
132 | @retval EFI_SUCCESS FTW has finished the initialization\r | |
133 | @retval EFI_ABORTED FTW initialization error\r | |
134 | \r | |
135 | **/\r | |
d7dec593 | 136 | EFI_STATUS\r |
137 | EFIAPI\r | |
138 | InitializeFtwLite (\r | |
139 | IN EFI_HANDLE ImageHandle,\r | |
140 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
ed66e1bc | 141 | );\r |
d7dec593 | 142 | \r |
143 | //\r | |
144 | // Fault Tolerant Write Protocol API\r | |
145 | //\r | |
6aab8214 | 146 | /**\r |
147 | Starts a target block update. This function will record data about write\r | |
148 | in fault tolerant storage and will complete the write in a recoverable\r | |
149 | manner, ensuring at all times that either the original contents or\r | |
150 | the modified contents are available.\r | |
151 | \r | |
152 | \r | |
153 | @param This Calling context\r | |
154 | @param FvbHandle The handle of FVB protocol that provides services for\r | |
155 | reading, writing, and erasing the target block.\r | |
156 | @param Lba The logical block address of the target block.\r | |
157 | @param Offset The offset within the target block to place the data.\r | |
158 | @param NumBytes The number of bytes to write to the target block.\r | |
159 | @param Buffer The data to write.\r | |
160 | \r | |
161 | @retval EFI_SUCCESS The function completed successfully\r | |
162 | @retval EFI_BAD_BUFFER_SIZE The write would span a target block, which is not\r | |
163 | a valid action.\r | |
164 | @retval EFI_ACCESS_DENIED No writes have been allocated.\r | |
165 | @retval EFI_NOT_FOUND Cannot find FVB by handle.\r | |
166 | @retval EFI_OUT_OF_RESOURCES Cannot allocate memory.\r | |
167 | @retval EFI_ABORTED The function could not complete successfully.\r | |
168 | \r | |
169 | **/\r | |
d7dec593 | 170 | EFI_STATUS\r |
171 | EFIAPI\r | |
172 | FtwLiteWrite (\r | |
6aab8214 | 173 | IN EFI_FTW_LITE_PROTOCOL *This,\r |
174 | IN EFI_HANDLE FvbHandle,\r | |
175 | IN EFI_LBA Lba,\r | |
176 | IN UINTN Offset,\r | |
177 | IN OUT UINTN *NumBytes,\r | |
178 | IN VOID *Buffer\r | |
ed66e1bc | 179 | );\r |
d7dec593 | 180 | \r |
181 | //\r | |
182 | // Internal functions\r | |
183 | //\r | |
6aab8214 | 184 | /**\r |
185 | Restarts a previously interrupted write. The caller must provide the\r | |
186 | block protocol needed to complete the interrupted write.\r | |
187 | \r | |
188 | \r | |
189 | @param FtwLiteDevice The private data of FTW_LITE driver\r | |
190 | FvbHandle - The handle of FVB protocol that provides services for\r | |
191 | reading, writing, and erasing the target block.\r | |
192 | \r | |
193 | @retval EFI_SUCCESS The function completed successfully\r | |
194 | @retval EFI_ACCESS_DENIED No pending writes exist\r | |
195 | @retval EFI_NOT_FOUND FVB protocol not found by the handle\r | |
196 | @retval EFI_ABORTED The function could not complete successfully\r | |
197 | \r | |
198 | **/\r | |
d7dec593 | 199 | EFI_STATUS\r |
200 | FtwRestart (\r | |
201 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 202 | );\r |
d7dec593 | 203 | \r |
6aab8214 | 204 | /**\r |
205 | Aborts all previous allocated writes.\r | |
d7dec593 | 206 | \r |
d7dec593 | 207 | \r |
6aab8214 | 208 | @param FtwLiteDevice The private data of FTW_LITE driver\r |
d7dec593 | 209 | \r |
6aab8214 | 210 | @retval EFI_SUCCESS The function completed successfully\r |
211 | @retval EFI_ABORTED The function could not complete successfully.\r | |
212 | @retval EFI_NOT_FOUND No allocated writes exist.\r | |
d7dec593 | 213 | \r |
6aab8214 | 214 | **/\r |
d7dec593 | 215 | EFI_STATUS\r |
216 | FtwAbort (\r | |
217 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 218 | );\r |
d7dec593 | 219 | \r |
d7dec593 | 220 | \r |
6aab8214 | 221 | /**\r |
222 | Write a record with fault tolerant mannaer.\r | |
223 | Since the content has already backuped in spare block, the write is\r | |
224 | guaranteed to be completed with fault tolerant manner.\r | |
d7dec593 | 225 | \r |
d7dec593 | 226 | \r |
6aab8214 | 227 | @param FtwLiteDevice The private data of FTW_LITE driver\r |
228 | @param Fvb The FVB protocol that provides services for\r | |
229 | reading, writing, and erasing the target block.\r | |
d7dec593 | 230 | \r |
6aab8214 | 231 | @retval EFI_SUCCESS The function completed successfully\r |
232 | @retval EFI_ABORTED The function could not complete successfully\r | |
d7dec593 | 233 | \r |
6aab8214 | 234 | **/\r |
d7dec593 | 235 | EFI_STATUS\r |
236 | FtwWriteRecord (\r | |
237 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
238 | IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb\r | |
ed66e1bc | 239 | );\r |
d7dec593 | 240 | \r |
6aab8214 | 241 | /**\r |
8986b8cd | 242 | To erase the block with the spare block size.\r |
d7dec593 | 243 | \r |
d7dec593 | 244 | \r |
6aab8214 | 245 | @param FtwLiteDevice Calling context\r |
246 | @param FvBlock FVB Protocol interface\r | |
247 | @param Lba Lba of the firmware block\r | |
d7dec593 | 248 | \r |
6aab8214 | 249 | @retval EFI_SUCCESS Block LBA is Erased successfully\r |
250 | @retval Others Error occurs\r | |
d7dec593 | 251 | \r |
6aab8214 | 252 | **/\r |
d7dec593 | 253 | EFI_STATUS\r |
254 | FtwEraseBlock (\r | |
255 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
256 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r | |
257 | EFI_LBA Lba\r | |
ed66e1bc | 258 | );\r |
d7dec593 | 259 | \r |
6aab8214 | 260 | /**\r |
d7dec593 | 261 | \r |
6aab8214 | 262 | Erase spare block.\r |
d7dec593 | 263 | \r |
d7dec593 | 264 | \r |
6aab8214 | 265 | @param FtwLiteDevice Calling context\r |
d7dec593 | 266 | \r |
6aab8214 | 267 | @retval EFI_SUCCESS The erase request was successfully\r |
268 | completed.\r | |
269 | \r | |
270 | @retval EFI_ACCESS_DENIED The firmware volume is in the\r | |
271 | WriteDisabled state.\r | |
272 | @retval EFI_DEVICE_ERROR The block device is not functioning\r | |
273 | correctly and could not be written.\r | |
274 | The firmware device may have been\r | |
275 | partially erased.\r | |
276 | @retval EFI_INVALID_PARAMETER One or more of the LBAs listed\r | |
277 | in the variable argument list do\r | |
278 | not exist in the firmware volume. \r | |
279 | \r | |
280 | **/\r | |
d7dec593 | 281 | EFI_STATUS\r |
282 | FtwEraseSpareBlock (\r | |
283 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 284 | );\r |
d7dec593 | 285 | \r |
6aab8214 | 286 | /**\r |
287 | Retrive the proper FVB protocol interface by HANDLE.\r | |
d7dec593 | 288 | \r |
d7dec593 | 289 | \r |
6aab8214 | 290 | @param FvBlockHandle The handle of FVB protocol that provides services for\r |
291 | reading, writing, and erasing the target block.\r | |
292 | @param FvBlock The interface of FVB protocol\r | |
d7dec593 | 293 | \r |
6aab8214 | 294 | @retval EFI_SUCCESS The function completed successfully\r |
295 | @retval EFI_ABORTED The function could not complete successfully\r | |
d7dec593 | 296 | \r |
6aab8214 | 297 | **/\r |
d7dec593 | 298 | EFI_STATUS\r |
299 | FtwGetFvbByHandle (\r | |
300 | IN EFI_HANDLE FvBlockHandle,\r | |
301 | OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock\r | |
ed66e1bc | 302 | );\r |
d7dec593 | 303 | \r |
6aab8214 | 304 | /**\r |
d7dec593 | 305 | \r |
6aab8214 | 306 | Get firmware block by address.\r |
d7dec593 | 307 | \r |
d7dec593 | 308 | \r |
6aab8214 | 309 | @param Address Address specified the block\r |
310 | @param FvBlock The block caller wanted\r | |
311 | \r | |
312 | @retval EFI_SUCCESS The protocol instance if found.\r | |
313 | @retval EFI_NOT_FOUND Block not found\r | |
314 | \r | |
315 | **/\r | |
d7dec593 | 316 | EFI_STATUS\r |
317 | GetFvbByAddress (\r | |
318 | IN EFI_PHYSICAL_ADDRESS Address,\r | |
319 | OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock\r | |
ed66e1bc | 320 | );\r |
d7dec593 | 321 | \r |
6aab8214 | 322 | /**\r |
d7dec593 | 323 | \r |
6aab8214 | 324 | Is it in working block?\r |
d7dec593 | 325 | \r |
d7dec593 | 326 | \r |
6aab8214 | 327 | @param FtwLiteDevice Calling context\r |
328 | @param FvBlock Fvb protocol instance\r | |
329 | @param Lba The block specified\r | |
d7dec593 | 330 | \r |
6aab8214 | 331 | @return A BOOLEAN value indicating in working block or not.\r |
d7dec593 | 332 | \r |
6aab8214 | 333 | **/\r |
d7dec593 | 334 | BOOLEAN\r |
335 | IsInWorkingBlock (\r | |
336 | EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
337 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r | |
338 | EFI_LBA Lba\r | |
ed66e1bc | 339 | );\r |
d7dec593 | 340 | \r |
6aab8214 | 341 | /**\r |
342 | Copy the content of spare block to a target block. Size is FTW_BLOCK_SIZE.\r | |
343 | Spare block is accessed by FTW backup FVB protocol interface. LBA is\r | |
344 | FtwLiteDevice->FtwSpareLba.\r | |
345 | Target block is accessed by FvBlock protocol interface. LBA is Lba.\r | |
d7dec593 | 346 | \r |
d7dec593 | 347 | \r |
6aab8214 | 348 | @param FtwLiteDevice The private data of FTW_LITE driver\r |
349 | @param FvBlock FVB Protocol interface to access target block\r | |
350 | @param Lba Lba of the target block\r | |
d7dec593 | 351 | \r |
6aab8214 | 352 | @retval EFI_SUCCESS Spare block content is copied to target block\r |
353 | @retval EFI_INVALID_PARAMETER Input parameter error\r | |
354 | @retval EFI_OUT_OF_RESOURCES Allocate memory error\r | |
355 | @retval EFI_ABORTED The function could not complete successfully\r | |
d7dec593 | 356 | \r |
6aab8214 | 357 | **/\r |
d7dec593 | 358 | EFI_STATUS\r |
359 | FlushSpareBlockToTargetBlock (\r | |
360 | EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
361 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r | |
362 | EFI_LBA Lba\r | |
ed66e1bc | 363 | );\r |
d7dec593 | 364 | \r |
6aab8214 | 365 | /**\r |
366 | Copy the content of spare block to working block. Size is FTW_BLOCK_SIZE.\r | |
367 | Spare block is accessed by FTW backup FVB protocol interface. LBA is\r | |
368 | FtwLiteDevice->FtwSpareLba.\r | |
369 | Working block is accessed by FTW working FVB protocol interface. LBA is\r | |
370 | FtwLiteDevice->FtwWorkBlockLba.\r | |
371 | \r | |
372 | \r | |
373 | @param FtwLiteDevice The private data of FTW_LITE driver\r | |
374 | \r | |
375 | @retval EFI_SUCCESS Spare block content is copied to target block\r | |
376 | @retval EFI_OUT_OF_RESOURCES Allocate memory error\r | |
377 | @retval EFI_ABORTED The function could not complete successfully\r | |
378 | Notes:\r | |
379 | Since the working block header is important when FTW initializes, the\r | |
380 | state of the operation should be handled carefully. The Crc value is\r | |
381 | calculated without STATE element.\r | |
382 | \r | |
383 | **/\r | |
d7dec593 | 384 | EFI_STATUS\r |
385 | FlushSpareBlockToWorkingBlock (\r | |
386 | EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 387 | );\r |
d7dec593 | 388 | \r |
6aab8214 | 389 | /**\r |
390 | Update a bit of state on a block device. The location of the bit is\r | |
391 | calculated by the (Lba, Offset, bit). Here bit is determined by the\r | |
392 | the name of a certain bit.\r | |
d7dec593 | 393 | \r |
d7dec593 | 394 | \r |
6aab8214 | 395 | @param FvBlock FVB Protocol interface to access SrcBlock and DestBlock\r |
396 | @param Lba Lba of a block\r | |
397 | @param Offset Offset on the Lba\r | |
398 | @param NewBit New value that will override the old value if it can be change\r | |
d7dec593 | 399 | \r |
6aab8214 | 400 | @retval EFI_SUCCESS A state bit has been updated successfully\r |
401 | @retval Others Access block device error.\r | |
402 | Notes:\r | |
403 | Assume all bits of State are inside the same BYTE.\r | |
404 | @retval EFI_ABORTED Read block fail\r | |
d7dec593 | 405 | \r |
6aab8214 | 406 | **/\r |
d7dec593 | 407 | EFI_STATUS\r |
408 | FtwUpdateFvState (\r | |
409 | IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r | |
410 | IN EFI_LBA Lba,\r | |
411 | IN UINTN Offset,\r | |
412 | IN UINT8 NewBit\r | |
ed66e1bc | 413 | );\r |
d7dec593 | 414 | \r |
6aab8214 | 415 | /**\r |
416 | Get the last Write record pointer.\r | |
417 | The last record is the record whose 'complete' state hasn't been set.\r | |
418 | After all, this header may be a EMPTY header entry for next Allocate.\r | |
d7dec593 | 419 | \r |
d7dec593 | 420 | \r |
6aab8214 | 421 | @param FtwLiteDevice Private data of this driver\r |
422 | @param FtwLastRecord Pointer to retrieve the last write record\r | |
d7dec593 | 423 | \r |
6aab8214 | 424 | @retval EFI_SUCCESS Get the last write record successfully\r |
425 | @retval EFI_ABORTED The FTW work space is damaged\r | |
d7dec593 | 426 | \r |
6aab8214 | 427 | **/\r |
d7dec593 | 428 | EFI_STATUS\r |
429 | FtwGetLastRecord (\r | |
430 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
431 | OUT EFI_FTW_LITE_RECORD **FtwLastRecord\r | |
ed66e1bc | 432 | );\r |
d7dec593 | 433 | \r |
6aab8214 | 434 | /**\r |
d7dec593 | 435 | \r |
6aab8214 | 436 | Check whether a flash buffer is erased.\r |
d7dec593 | 437 | \r |
d7dec593 | 438 | \r |
6aab8214 | 439 | @param Polarity All 1 or all 0\r |
440 | @param Buffer Buffer to check\r | |
441 | @param BufferSize Size of the buffer\r | |
d7dec593 | 442 | \r |
6aab8214 | 443 | @return A BOOLEAN value indicating erased or not.\r |
444 | \r | |
445 | **/\r | |
d7dec593 | 446 | BOOLEAN\r |
447 | IsErasedFlashBuffer (\r | |
448 | IN BOOLEAN Polarity,\r | |
449 | IN UINT8 *Buffer,\r | |
450 | IN UINTN BufferSize\r | |
ed66e1bc | 451 | );\r |
d7dec593 | 452 | \r |
6aab8214 | 453 | /**\r |
454 | Initialize a work space when there is no work space.\r | |
d7dec593 | 455 | \r |
d7dec593 | 456 | \r |
6aab8214 | 457 | @param WorkingHeader Pointer of working block header\r |
d7dec593 | 458 | \r |
6aab8214 | 459 | @retval EFI_SUCCESS The function completed successfully\r |
460 | @retval EFI_ABORTED The function could not complete successfully.\r | |
d7dec593 | 461 | \r |
6aab8214 | 462 | **/\r |
d7dec593 | 463 | EFI_STATUS\r |
464 | InitWorkSpaceHeader (\r | |
465 | IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *WorkingHeader\r | |
ed66e1bc | 466 | );\r |
d7dec593 | 467 | \r |
6aab8214 | 468 | /**\r |
469 | Read from working block to refresh the work space in memory.\r | |
d7dec593 | 470 | \r |
d7dec593 | 471 | \r |
6aab8214 | 472 | @param FtwLiteDevice Point to private data of FTW driver\r |
d7dec593 | 473 | \r |
6aab8214 | 474 | @retval EFI_SUCCESS The function completed successfully\r |
475 | @retval EFI_ABORTED The function could not complete successfully.\r | |
d7dec593 | 476 | \r |
6aab8214 | 477 | **/\r |
d7dec593 | 478 | EFI_STATUS\r |
479 | WorkSpaceRefresh (\r | |
480 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 481 | );\r |
d7dec593 | 482 | \r |
6aab8214 | 483 | /**\r |
484 | Check to see if it is a valid work space.\r | |
d7dec593 | 485 | \r |
d7dec593 | 486 | \r |
6aab8214 | 487 | @param WorkingHeader Pointer of working block header\r |
d7dec593 | 488 | \r |
6aab8214 | 489 | @retval EFI_SUCCESS The function completed successfully\r |
490 | @retval EFI_ABORTED The function could not complete successfully.\r | |
d7dec593 | 491 | \r |
6aab8214 | 492 | **/\r |
d7dec593 | 493 | BOOLEAN\r |
494 | IsValidWorkSpace (\r | |
495 | IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *WorkingHeader\r | |
ed66e1bc | 496 | );\r |
d7dec593 | 497 | \r |
6aab8214 | 498 | /**\r |
499 | Reclaim the work space on the working block.\r | |
d7dec593 | 500 | \r |
d7dec593 | 501 | \r |
6aab8214 | 502 | @param FtwLiteDevice Point to private data of FTW driver\r |
e11ae3a5 | 503 | @param PreserveRecord Whether to preserve the working record is needed\r |
d7dec593 | 504 | \r |
6aab8214 | 505 | @retval EFI_SUCCESS The function completed successfully\r |
506 | @retval EFI_OUT_OF_RESOURCES Allocate memory error\r | |
507 | @retval EFI_ABORTED The function could not complete successfully\r | |
d7dec593 | 508 | \r |
6aab8214 | 509 | **/\r |
d7dec593 | 510 | EFI_STATUS\r |
511 | FtwReclaimWorkSpace (\r | |
e11ae3a5 LG |
512 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r |
513 | IN BOOLEAN PreserveRecord\r | |
ed66e1bc | 514 | );\r |
d7dec593 | 515 | \r |
516 | #endif\r |