]>
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 |
71 | //\r | |
72 | // MACRO for Block size.\r | |
73 | // Flash Erasing will do in block granularity.\r | |
74 | //\r | |
75 | #ifdef FV_BLOCK_SIZE\r | |
76 | #define FTW_BLOCK_SIZE FV_BLOCK_SIZE\r | |
77 | #else\r | |
78 | #define FV_BLOCK_SIZE 0x10000\r | |
79 | #define FTW_BLOCK_SIZE FV_BLOCK_SIZE\r | |
80 | #endif\r | |
81 | //\r | |
82 | // MACRO for FTW WORK SPACE Base & Size\r | |
83 | //\r | |
84 | #ifdef EFI_FTW_WORKING_OFFSET\r | |
85 | #define FTW_WORK_SPACE_BASE EFI_FTW_WORKING_OFFSET\r | |
86 | #else\r | |
87 | #define FTW_WORK_SPACE_BASE 0x00E000\r | |
88 | #endif\r | |
89 | \r | |
90 | #ifdef EFI_FTW_WORKING_LENGTH\r | |
91 | #define FTW_WORK_SPACE_SIZE EFI_FTW_WORKING_LENGTH\r | |
92 | #else\r | |
93 | #define FTW_WORK_SPACE_SIZE 0x002000\r | |
94 | #endif\r | |
95 | //\r | |
96 | // MACRO for FTW header and record\r | |
97 | //\r | |
d7dec593 | 98 | #define FTW_LITE_RECORD_SIZE (sizeof (EFI_FTW_LITE_RECORD))\r |
d7dec593 | 99 | \r |
100 | //\r | |
101 | // EFI Fault tolerant protocol private data structure\r | |
102 | //\r | |
103 | typedef struct {\r | |
104 | UINTN Signature;\r | |
105 | EFI_HANDLE Handle;\r | |
106 | EFI_FTW_LITE_PROTOCOL FtwLiteInstance;\r | |
107 | EFI_PHYSICAL_ADDRESS WorkSpaceAddress;\r | |
108 | UINTN WorkSpaceLength;\r | |
109 | EFI_PHYSICAL_ADDRESS SpareAreaAddress;\r | |
110 | UINTN SpareAreaLength;\r | |
111 | UINTN NumberOfSpareBlock; // Number of the blocks in spare block\r | |
112 | UINTN SizeOfSpareBlock; // Block size in bytes of the blocks in spare block\r | |
113 | EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *FtwWorkSpaceHeader;\r | |
114 | EFI_FTW_LITE_RECORD *FtwLastRecord;\r | |
115 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FtwFvBlock; // FVB of working block\r | |
116 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FtwBackupFvb; // FVB of spare block\r | |
117 | EFI_LBA FtwSpareLba;\r | |
118 | EFI_LBA FtwWorkBlockLba; // Start LBA of working block\r | |
119 | EFI_LBA FtwWorkSpaceLba; // Start LBA of working space\r | |
120 | UINTN FtwWorkSpaceBase; // Offset from LBA start addr\r | |
121 | UINTN FtwWorkSpaceSize;\r | |
122 | UINT8 *FtwWorkSpace;\r | |
123 | //\r | |
124 | // Following a buffer of FtwWorkSpace[FTW_WORK_SPACE_SIZE],\r | |
125 | // Allocated with EFI_FTW_LITE_DEVICE.\r | |
126 | //\r | |
127 | } EFI_FTW_LITE_DEVICE;\r | |
128 | \r | |
129 | #define FTW_LITE_CONTEXT_FROM_THIS(a) CR (a, EFI_FTW_LITE_DEVICE, FtwLiteInstance, FTW_LITE_DEVICE_SIGNATURE)\r | |
130 | \r | |
131 | //\r | |
132 | // Driver entry point\r | |
133 | //\r | |
6aab8214 | 134 | /**\r |
135 | This function is the entry point of the Fault Tolerant Write driver.\r | |
136 | \r | |
137 | \r | |
5944a83b | 138 | @param ImageHandle A handle for the image that is initializing\r |
6aab8214 | 139 | this driver\r |
5944a83b | 140 | @param SystemTable A pointer to the EFI system table\r |
6aab8214 | 141 | \r |
142 | @retval EFI_SUCCESS FTW has finished the initialization\r | |
143 | @retval EFI_ABORTED FTW initialization error\r | |
144 | \r | |
145 | **/\r | |
d7dec593 | 146 | EFI_STATUS\r |
147 | EFIAPI\r | |
148 | InitializeFtwLite (\r | |
149 | IN EFI_HANDLE ImageHandle,\r | |
150 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
ed66e1bc | 151 | );\r |
d7dec593 | 152 | \r |
153 | //\r | |
154 | // Fault Tolerant Write Protocol API\r | |
155 | //\r | |
6aab8214 | 156 | /**\r |
157 | Starts a target block update. This function will record data about write\r | |
158 | in fault tolerant storage and will complete the write in a recoverable\r | |
159 | manner, ensuring at all times that either the original contents or\r | |
160 | the modified contents are available.\r | |
161 | \r | |
162 | \r | |
163 | @param This Calling context\r | |
164 | @param FvbHandle The handle of FVB protocol that provides services for\r | |
165 | reading, writing, and erasing the target block.\r | |
166 | @param Lba The logical block address of the target block.\r | |
167 | @param Offset The offset within the target block to place the data.\r | |
168 | @param NumBytes The number of bytes to write to the target block.\r | |
169 | @param Buffer The data to write.\r | |
170 | \r | |
171 | @retval EFI_SUCCESS The function completed successfully\r | |
172 | @retval EFI_BAD_BUFFER_SIZE The write would span a target block, which is not\r | |
173 | a valid action.\r | |
174 | @retval EFI_ACCESS_DENIED No writes have been allocated.\r | |
175 | @retval EFI_NOT_FOUND Cannot find FVB by handle.\r | |
176 | @retval EFI_OUT_OF_RESOURCES Cannot allocate memory.\r | |
177 | @retval EFI_ABORTED The function could not complete successfully.\r | |
178 | \r | |
179 | **/\r | |
d7dec593 | 180 | EFI_STATUS\r |
181 | EFIAPI\r | |
182 | FtwLiteWrite (\r | |
6aab8214 | 183 | IN EFI_FTW_LITE_PROTOCOL *This,\r |
184 | IN EFI_HANDLE FvbHandle,\r | |
185 | IN EFI_LBA Lba,\r | |
186 | IN UINTN Offset,\r | |
187 | IN OUT UINTN *NumBytes,\r | |
188 | IN VOID *Buffer\r | |
ed66e1bc | 189 | );\r |
d7dec593 | 190 | \r |
191 | //\r | |
192 | // Internal functions\r | |
193 | //\r | |
6aab8214 | 194 | /**\r |
195 | Restarts a previously interrupted write. The caller must provide the\r | |
196 | block protocol needed to complete the interrupted write.\r | |
197 | \r | |
198 | \r | |
199 | @param FtwLiteDevice The private data of FTW_LITE driver\r | |
200 | FvbHandle - The handle of FVB protocol that provides services for\r | |
201 | reading, writing, and erasing the target block.\r | |
202 | \r | |
203 | @retval EFI_SUCCESS The function completed successfully\r | |
204 | @retval EFI_ACCESS_DENIED No pending writes exist\r | |
205 | @retval EFI_NOT_FOUND FVB protocol not found by the handle\r | |
206 | @retval EFI_ABORTED The function could not complete successfully\r | |
207 | \r | |
208 | **/\r | |
d7dec593 | 209 | EFI_STATUS\r |
210 | FtwRestart (\r | |
211 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 212 | );\r |
d7dec593 | 213 | \r |
6aab8214 | 214 | /**\r |
215 | Aborts all previous allocated writes.\r | |
d7dec593 | 216 | \r |
d7dec593 | 217 | \r |
6aab8214 | 218 | @param FtwLiteDevice The private data of FTW_LITE driver\r |
d7dec593 | 219 | \r |
6aab8214 | 220 | @retval EFI_SUCCESS The function completed successfully\r |
221 | @retval EFI_ABORTED The function could not complete successfully.\r | |
222 | @retval EFI_NOT_FOUND No allocated writes exist.\r | |
d7dec593 | 223 | \r |
6aab8214 | 224 | **/\r |
d7dec593 | 225 | EFI_STATUS\r |
226 | FtwAbort (\r | |
227 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 228 | );\r |
d7dec593 | 229 | \r |
d7dec593 | 230 | \r |
6aab8214 | 231 | /**\r |
232 | Write a record with fault tolerant mannaer.\r | |
233 | Since the content has already backuped in spare block, the write is\r | |
234 | guaranteed to be completed with fault tolerant manner.\r | |
d7dec593 | 235 | \r |
d7dec593 | 236 | \r |
6aab8214 | 237 | @param FtwLiteDevice The private data of FTW_LITE driver\r |
238 | @param Fvb The FVB protocol that provides services for\r | |
239 | reading, writing, and erasing the target block.\r | |
d7dec593 | 240 | \r |
6aab8214 | 241 | @retval EFI_SUCCESS The function completed successfully\r |
242 | @retval EFI_ABORTED The function could not complete successfully\r | |
d7dec593 | 243 | \r |
6aab8214 | 244 | **/\r |
d7dec593 | 245 | EFI_STATUS\r |
246 | FtwWriteRecord (\r | |
247 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
248 | IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb\r | |
ed66e1bc | 249 | );\r |
d7dec593 | 250 | \r |
6aab8214 | 251 | /**\r |
252 | To Erase one block. The size is FTW_BLOCK_SIZE\r | |
d7dec593 | 253 | \r |
d7dec593 | 254 | \r |
6aab8214 | 255 | @param FtwLiteDevice Calling context\r |
256 | @param FvBlock FVB Protocol interface\r | |
257 | @param Lba Lba of the firmware block\r | |
d7dec593 | 258 | \r |
6aab8214 | 259 | @retval EFI_SUCCESS Block LBA is Erased successfully\r |
260 | @retval Others Error occurs\r | |
d7dec593 | 261 | \r |
6aab8214 | 262 | **/\r |
d7dec593 | 263 | EFI_STATUS\r |
264 | FtwEraseBlock (\r | |
265 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
266 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r | |
267 | EFI_LBA Lba\r | |
ed66e1bc | 268 | );\r |
d7dec593 | 269 | \r |
6aab8214 | 270 | /**\r |
d7dec593 | 271 | \r |
6aab8214 | 272 | Erase spare block.\r |
d7dec593 | 273 | \r |
d7dec593 | 274 | \r |
6aab8214 | 275 | @param FtwLiteDevice Calling context\r |
d7dec593 | 276 | \r |
6aab8214 | 277 | @retval EFI_SUCCESS The erase request was successfully\r |
278 | completed.\r | |
279 | \r | |
280 | @retval EFI_ACCESS_DENIED The firmware volume is in the\r | |
281 | WriteDisabled state.\r | |
282 | @retval EFI_DEVICE_ERROR The block device is not functioning\r | |
283 | correctly and could not be written.\r | |
284 | The firmware device may have been\r | |
285 | partially erased.\r | |
286 | @retval EFI_INVALID_PARAMETER One or more of the LBAs listed\r | |
287 | in the variable argument list do\r | |
288 | not exist in the firmware volume. \r | |
289 | \r | |
290 | **/\r | |
d7dec593 | 291 | EFI_STATUS\r |
292 | FtwEraseSpareBlock (\r | |
293 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 294 | );\r |
d7dec593 | 295 | \r |
6aab8214 | 296 | /**\r |
297 | Retrive the proper FVB protocol interface by HANDLE.\r | |
d7dec593 | 298 | \r |
d7dec593 | 299 | \r |
6aab8214 | 300 | @param FvBlockHandle The handle of FVB protocol that provides services for\r |
301 | reading, writing, and erasing the target block.\r | |
302 | @param FvBlock The interface of FVB protocol\r | |
d7dec593 | 303 | \r |
6aab8214 | 304 | @retval EFI_SUCCESS The function completed successfully\r |
305 | @retval EFI_ABORTED The function could not complete successfully\r | |
d7dec593 | 306 | \r |
6aab8214 | 307 | **/\r |
d7dec593 | 308 | EFI_STATUS\r |
309 | FtwGetFvbByHandle (\r | |
310 | IN EFI_HANDLE FvBlockHandle,\r | |
311 | OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock\r | |
ed66e1bc | 312 | );\r |
d7dec593 | 313 | \r |
6aab8214 | 314 | /**\r |
d7dec593 | 315 | \r |
6aab8214 | 316 | Get firmware block by address.\r |
d7dec593 | 317 | \r |
d7dec593 | 318 | \r |
6aab8214 | 319 | @param Address Address specified the block\r |
320 | @param FvBlock The block caller wanted\r | |
321 | \r | |
322 | @retval EFI_SUCCESS The protocol instance if found.\r | |
323 | @retval EFI_NOT_FOUND Block not found\r | |
324 | \r | |
325 | **/\r | |
d7dec593 | 326 | EFI_STATUS\r |
327 | GetFvbByAddress (\r | |
328 | IN EFI_PHYSICAL_ADDRESS Address,\r | |
329 | OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock\r | |
ed66e1bc | 330 | );\r |
d7dec593 | 331 | \r |
6aab8214 | 332 | /**\r |
d7dec593 | 333 | \r |
6aab8214 | 334 | Is it in working block?\r |
d7dec593 | 335 | \r |
d7dec593 | 336 | \r |
6aab8214 | 337 | @param FtwLiteDevice Calling context\r |
338 | @param FvBlock Fvb protocol instance\r | |
339 | @param Lba The block specified\r | |
d7dec593 | 340 | \r |
6aab8214 | 341 | @return A BOOLEAN value indicating in working block or not.\r |
d7dec593 | 342 | \r |
6aab8214 | 343 | **/\r |
d7dec593 | 344 | BOOLEAN\r |
345 | IsInWorkingBlock (\r | |
346 | EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
347 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r | |
348 | EFI_LBA Lba\r | |
ed66e1bc | 349 | );\r |
d7dec593 | 350 | \r |
6aab8214 | 351 | /**\r |
d7dec593 | 352 | \r |
6aab8214 | 353 | Check whether the block is a boot block.\r |
d7dec593 | 354 | \r |
d7dec593 | 355 | \r |
6aab8214 | 356 | @param FtwLiteDevice Calling context\r |
357 | @param FvBlock Fvb protocol instance\r | |
358 | @param Lba Lba value\r | |
d7dec593 | 359 | \r |
6aab8214 | 360 | @retval FALSE This is a boot block.\r |
361 | @retval TRUE This is not a boot block.\r | |
d7dec593 | 362 | \r |
6aab8214 | 363 | **/\r |
d7dec593 | 364 | BOOLEAN\r |
365 | IsBootBlock (\r | |
366 | EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
367 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r | |
368 | EFI_LBA Lba\r | |
ed66e1bc | 369 | );\r |
d7dec593 | 370 | \r |
6aab8214 | 371 | /**\r |
372 | Copy the content of spare block to a target block. Size is FTW_BLOCK_SIZE.\r | |
373 | Spare block is accessed by FTW backup FVB protocol interface. LBA is\r | |
374 | FtwLiteDevice->FtwSpareLba.\r | |
375 | Target block is accessed by FvBlock protocol interface. LBA is Lba.\r | |
d7dec593 | 376 | \r |
d7dec593 | 377 | \r |
6aab8214 | 378 | @param FtwLiteDevice The private data of FTW_LITE driver\r |
379 | @param FvBlock FVB Protocol interface to access target block\r | |
380 | @param Lba Lba of the target block\r | |
d7dec593 | 381 | \r |
6aab8214 | 382 | @retval EFI_SUCCESS Spare block content is copied to target block\r |
383 | @retval EFI_INVALID_PARAMETER Input parameter error\r | |
384 | @retval EFI_OUT_OF_RESOURCES Allocate memory error\r | |
385 | @retval EFI_ABORTED The function could not complete successfully\r | |
d7dec593 | 386 | \r |
6aab8214 | 387 | **/\r |
d7dec593 | 388 | EFI_STATUS\r |
389 | FlushSpareBlockToTargetBlock (\r | |
390 | EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
391 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r | |
392 | EFI_LBA Lba\r | |
ed66e1bc | 393 | );\r |
d7dec593 | 394 | \r |
6aab8214 | 395 | /**\r |
396 | Copy the content of spare block to working block. Size is FTW_BLOCK_SIZE.\r | |
397 | Spare block is accessed by FTW backup FVB protocol interface. LBA is\r | |
398 | FtwLiteDevice->FtwSpareLba.\r | |
399 | Working block is accessed by FTW working FVB protocol interface. LBA is\r | |
400 | FtwLiteDevice->FtwWorkBlockLba.\r | |
401 | \r | |
402 | \r | |
403 | @param FtwLiteDevice The private data of FTW_LITE driver\r | |
404 | \r | |
405 | @retval EFI_SUCCESS Spare block content is copied to target block\r | |
406 | @retval EFI_OUT_OF_RESOURCES Allocate memory error\r | |
407 | @retval EFI_ABORTED The function could not complete successfully\r | |
408 | Notes:\r | |
409 | Since the working block header is important when FTW initializes, the\r | |
410 | state of the operation should be handled carefully. The Crc value is\r | |
411 | calculated without STATE element.\r | |
412 | \r | |
413 | **/\r | |
d7dec593 | 414 | EFI_STATUS\r |
415 | FlushSpareBlockToWorkingBlock (\r | |
416 | EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 417 | );\r |
d7dec593 | 418 | \r |
6aab8214 | 419 | /**\r |
420 | Copy the content of spare block to a boot block. Size is FTW_BLOCK_SIZE.\r | |
421 | Spare block is accessed by FTW backup FVB protocol interface. LBA is\r | |
422 | FtwLiteDevice->FtwSpareLba.\r | |
423 | Boot block is accessed by BootFvb protocol interface. LBA is 0.\r | |
d7dec593 | 424 | \r |
d7dec593 | 425 | \r |
6aab8214 | 426 | @param FtwLiteDevice The private data of FTW_LITE driver\r |
d7dec593 | 427 | \r |
6aab8214 | 428 | @retval EFI_SUCCESS Spare block content is copied to boot block\r |
429 | @retval EFI_INVALID_PARAMETER Input parameter error\r | |
430 | @retval EFI_OUT_OF_RESOURCES Allocate memory error\r | |
431 | @retval EFI_ABORTED The function could not complete successfully\r | |
432 | Notes:\r | |
d7dec593 | 433 | \r |
6aab8214 | 434 | **/\r |
d7dec593 | 435 | EFI_STATUS\r |
436 | FlushSpareBlockToBootBlock (\r | |
437 | EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 438 | );\r |
d7dec593 | 439 | \r |
6aab8214 | 440 | /**\r |
441 | Update a bit of state on a block device. The location of the bit is\r | |
442 | calculated by the (Lba, Offset, bit). Here bit is determined by the\r | |
443 | the name of a certain bit.\r | |
d7dec593 | 444 | \r |
d7dec593 | 445 | \r |
6aab8214 | 446 | @param FvBlock FVB Protocol interface to access SrcBlock and DestBlock\r |
447 | @param Lba Lba of a block\r | |
448 | @param Offset Offset on the Lba\r | |
449 | @param NewBit New value that will override the old value if it can be change\r | |
d7dec593 | 450 | \r |
6aab8214 | 451 | @retval EFI_SUCCESS A state bit has been updated successfully\r |
452 | @retval Others Access block device error.\r | |
453 | Notes:\r | |
454 | Assume all bits of State are inside the same BYTE.\r | |
455 | @retval EFI_ABORTED Read block fail\r | |
d7dec593 | 456 | \r |
6aab8214 | 457 | **/\r |
d7dec593 | 458 | EFI_STATUS\r |
459 | FtwUpdateFvState (\r | |
460 | IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r | |
461 | IN EFI_LBA Lba,\r | |
462 | IN UINTN Offset,\r | |
463 | IN UINT8 NewBit\r | |
ed66e1bc | 464 | );\r |
d7dec593 | 465 | \r |
6aab8214 | 466 | /**\r |
467 | Get the last Write record pointer.\r | |
468 | The last record is the record whose 'complete' state hasn't been set.\r | |
469 | After all, this header may be a EMPTY header entry for next Allocate.\r | |
d7dec593 | 470 | \r |
d7dec593 | 471 | \r |
6aab8214 | 472 | @param FtwLiteDevice Private data of this driver\r |
473 | @param FtwLastRecord Pointer to retrieve the last write record\r | |
d7dec593 | 474 | \r |
6aab8214 | 475 | @retval EFI_SUCCESS Get the last write record successfully\r |
476 | @retval EFI_ABORTED The FTW work space is damaged\r | |
d7dec593 | 477 | \r |
6aab8214 | 478 | **/\r |
d7dec593 | 479 | EFI_STATUS\r |
480 | FtwGetLastRecord (\r | |
481 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r | |
482 | OUT EFI_FTW_LITE_RECORD **FtwLastRecord\r | |
ed66e1bc | 483 | );\r |
d7dec593 | 484 | \r |
6aab8214 | 485 | /**\r |
d7dec593 | 486 | \r |
6aab8214 | 487 | Check whether a flash buffer is erased.\r |
d7dec593 | 488 | \r |
d7dec593 | 489 | \r |
6aab8214 | 490 | @param Polarity All 1 or all 0\r |
491 | @param Buffer Buffer to check\r | |
492 | @param BufferSize Size of the buffer\r | |
d7dec593 | 493 | \r |
6aab8214 | 494 | @return A BOOLEAN value indicating erased or not.\r |
495 | \r | |
496 | **/\r | |
d7dec593 | 497 | BOOLEAN\r |
498 | IsErasedFlashBuffer (\r | |
499 | IN BOOLEAN Polarity,\r | |
500 | IN UINT8 *Buffer,\r | |
501 | IN UINTN BufferSize\r | |
ed66e1bc | 502 | );\r |
d7dec593 | 503 | \r |
6aab8214 | 504 | /**\r |
505 | Initialize a work space when there is no work space.\r | |
d7dec593 | 506 | \r |
d7dec593 | 507 | \r |
6aab8214 | 508 | @param WorkingHeader Pointer of working block header\r |
d7dec593 | 509 | \r |
6aab8214 | 510 | @retval EFI_SUCCESS The function completed successfully\r |
511 | @retval EFI_ABORTED The function could not complete successfully.\r | |
d7dec593 | 512 | \r |
6aab8214 | 513 | **/\r |
d7dec593 | 514 | EFI_STATUS\r |
515 | InitWorkSpaceHeader (\r | |
516 | IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *WorkingHeader\r | |
ed66e1bc | 517 | );\r |
d7dec593 | 518 | \r |
6aab8214 | 519 | /**\r |
520 | Read from working block to refresh the work space in memory.\r | |
d7dec593 | 521 | \r |
d7dec593 | 522 | \r |
6aab8214 | 523 | @param FtwLiteDevice Point to private data of FTW driver\r |
d7dec593 | 524 | \r |
6aab8214 | 525 | @retval EFI_SUCCESS The function completed successfully\r |
526 | @retval EFI_ABORTED The function could not complete successfully.\r | |
d7dec593 | 527 | \r |
6aab8214 | 528 | **/\r |
d7dec593 | 529 | EFI_STATUS\r |
530 | WorkSpaceRefresh (\r | |
531 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r | |
ed66e1bc | 532 | );\r |
d7dec593 | 533 | \r |
6aab8214 | 534 | /**\r |
535 | Check to see if it is a valid work space.\r | |
d7dec593 | 536 | \r |
d7dec593 | 537 | \r |
6aab8214 | 538 | @param WorkingHeader Pointer of working block header\r |
d7dec593 | 539 | \r |
6aab8214 | 540 | @retval EFI_SUCCESS The function completed successfully\r |
541 | @retval EFI_ABORTED The function could not complete successfully.\r | |
d7dec593 | 542 | \r |
6aab8214 | 543 | **/\r |
d7dec593 | 544 | BOOLEAN\r |
545 | IsValidWorkSpace (\r | |
546 | IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *WorkingHeader\r | |
ed66e1bc | 547 | );\r |
d7dec593 | 548 | \r |
6aab8214 | 549 | /**\r |
550 | Reclaim the work space on the working block.\r | |
d7dec593 | 551 | \r |
d7dec593 | 552 | \r |
6aab8214 | 553 | @param FtwLiteDevice Point to private data of FTW driver\r |
e11ae3a5 | 554 | @param PreserveRecord Whether to preserve the working record is needed\r |
d7dec593 | 555 | \r |
6aab8214 | 556 | @retval EFI_SUCCESS The function completed successfully\r |
557 | @retval EFI_OUT_OF_RESOURCES Allocate memory error\r | |
558 | @retval EFI_ABORTED The function could not complete successfully\r | |
d7dec593 | 559 | \r |
6aab8214 | 560 | **/\r |
d7dec593 | 561 | EFI_STATUS\r |
562 | FtwReclaimWorkSpace (\r | |
e11ae3a5 LG |
563 | IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r |
564 | IN BOOLEAN PreserveRecord\r | |
ed66e1bc | 565 | );\r |
d7dec593 | 566 | \r |
567 | #endif\r |