1 /*++ @file NorFlashFvbDxe.c
3 Copyright (c) 2011 - 2014, ARM Ltd. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Library/PcdLib.h>
18 #include <Library/BaseLib.h>
19 #include <Library/HobLib.h>
20 #include <Library/UefiLib.h>
21 #include <Library/BaseMemoryLib.h>
22 #include <Library/MemoryAllocationLib.h>
23 #include <Library/UefiBootServicesTableLib.h>
25 #include <Guid/VariableFormat.h>
26 #include <Guid/SystemNvDataGuid.h>
28 #include "NorFlashDxe.h"
32 /// The Firmware Volume Block Protocol is the low-level interface
33 /// to a firmware volume. File-level access to a firmware volume
34 /// should not be done using the Firmware Volume Block Protocol.
35 /// Normal access to a firmware volume must use the Firmware
36 /// Volume Protocol. Typically, only the file system driver that
37 /// produces the Firmware Volume Protocol will bind to the
38 /// Firmware Volume Block Protocol.
42 Initialises the FV Header and Variable Store Header
43 to support variable operations.
45 @param[in] Ptr - Location to initialise the headers
49 InitializeFvAndVariableStoreHeaders (
50 IN NOR_FLASH_INSTANCE
*Instance
56 EFI_FIRMWARE_VOLUME_HEADER
*FirmwareVolumeHeader
;
57 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
59 if (!Instance
->Initialized
&& Instance
->Initialize
) {
60 Instance
->Initialize (Instance
);
63 HeadersLength
= sizeof(EFI_FIRMWARE_VOLUME_HEADER
) + sizeof(EFI_FV_BLOCK_MAP_ENTRY
) + sizeof(VARIABLE_STORE_HEADER
);
64 Headers
= AllocateZeroPool(HeadersLength
);
66 // FirmwareVolumeHeader->FvLength is declared to have the Variable area AND the FTW working area AND the FTW Spare contiguous.
67 ASSERT(PcdGet32(PcdFlashNvStorageVariableBase
) + PcdGet32(PcdFlashNvStorageVariableSize
) == PcdGet32(PcdFlashNvStorageFtwWorkingBase
));
68 ASSERT(PcdGet32(PcdFlashNvStorageFtwWorkingBase
) + PcdGet32(PcdFlashNvStorageFtwWorkingSize
) == PcdGet32(PcdFlashNvStorageFtwSpareBase
));
70 // Check if the size of the area is at least one block size
71 ASSERT((PcdGet32(PcdFlashNvStorageVariableSize
) > 0) && (PcdGet32(PcdFlashNvStorageVariableSize
) / Instance
->Media
.BlockSize
> 0));
72 ASSERT((PcdGet32(PcdFlashNvStorageFtwWorkingSize
) > 0) && (PcdGet32(PcdFlashNvStorageFtwWorkingSize
) / Instance
->Media
.BlockSize
> 0));
73 ASSERT((PcdGet32(PcdFlashNvStorageFtwSpareSize
) > 0) && (PcdGet32(PcdFlashNvStorageFtwSpareSize
) / Instance
->Media
.BlockSize
> 0));
75 // Ensure the Variable area Base Addresses are aligned on a block size boundaries
76 ASSERT(PcdGet32(PcdFlashNvStorageVariableBase
) % Instance
->Media
.BlockSize
== 0);
77 ASSERT(PcdGet32(PcdFlashNvStorageFtwWorkingBase
) % Instance
->Media
.BlockSize
== 0);
78 ASSERT(PcdGet32(PcdFlashNvStorageFtwSpareBase
) % Instance
->Media
.BlockSize
== 0);
81 // EFI_FIRMWARE_VOLUME_HEADER
83 FirmwareVolumeHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*)Headers
;
84 CopyGuid (&FirmwareVolumeHeader
->FileSystemGuid
, &gEfiSystemNvDataFvGuid
);
85 FirmwareVolumeHeader
->FvLength
=
86 PcdGet32(PcdFlashNvStorageVariableSize
) +
87 PcdGet32(PcdFlashNvStorageFtwWorkingSize
) +
88 PcdGet32(PcdFlashNvStorageFtwSpareSize
);
89 FirmwareVolumeHeader
->Signature
= EFI_FVH_SIGNATURE
;
90 FirmwareVolumeHeader
->Attributes
= (EFI_FVB_ATTRIBUTES_2
) (
91 EFI_FVB2_READ_ENABLED_CAP
| // Reads may be enabled
92 EFI_FVB2_READ_STATUS
| // Reads are currently enabled
93 EFI_FVB2_STICKY_WRITE
| // A block erase is required to flip bits into EFI_FVB2_ERASE_POLARITY
94 EFI_FVB2_MEMORY_MAPPED
| // It is memory mapped
95 EFI_FVB2_ERASE_POLARITY
| // After erasure all bits take this value (i.e. '1')
96 EFI_FVB2_WRITE_STATUS
| // Writes are currently enabled
97 EFI_FVB2_WRITE_ENABLED_CAP
// Writes may be enabled
99 FirmwareVolumeHeader
->HeaderLength
= sizeof(EFI_FIRMWARE_VOLUME_HEADER
) + sizeof(EFI_FV_BLOCK_MAP_ENTRY
);
100 FirmwareVolumeHeader
->Revision
= EFI_FVH_REVISION
;
101 FirmwareVolumeHeader
->BlockMap
[0].NumBlocks
= Instance
->Media
.LastBlock
+ 1;
102 FirmwareVolumeHeader
->BlockMap
[0].Length
= Instance
->Media
.BlockSize
;
103 FirmwareVolumeHeader
->BlockMap
[1].NumBlocks
= 0;
104 FirmwareVolumeHeader
->BlockMap
[1].Length
= 0;
105 FirmwareVolumeHeader
->Checksum
= CalculateCheckSum16 ((UINT16
*)FirmwareVolumeHeader
,FirmwareVolumeHeader
->HeaderLength
);
108 // VARIABLE_STORE_HEADER
110 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*)((UINTN
)Headers
+ FirmwareVolumeHeader
->HeaderLength
);
111 CopyGuid (&VariableStoreHeader
->Signature
, &gEfiVariableGuid
);
112 VariableStoreHeader
->Size
= PcdGet32(PcdFlashNvStorageVariableSize
) - FirmwareVolumeHeader
->HeaderLength
;
113 VariableStoreHeader
->Format
= VARIABLE_STORE_FORMATTED
;
114 VariableStoreHeader
->State
= VARIABLE_STORE_HEALTHY
;
116 // Install the combined super-header in the NorFlash
117 Status
= FvbWrite (&Instance
->FvbProtocol
, 0, 0, &HeadersLength
, Headers
);
124 Check the integrity of firmware volume header.
126 @param[in] FwVolHeader - A pointer to a firmware volume header
128 @retval EFI_SUCCESS - The firmware volume is consistent
129 @retval EFI_NOT_FOUND - The firmware volume has been corrupted.
134 IN NOR_FLASH_INSTANCE
*Instance
138 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
139 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
140 UINTN VariableStoreLength
;
143 FwVolHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*)Instance
->RegionBaseAddress
;
145 FvLength
= PcdGet32(PcdFlashNvStorageVariableSize
) + PcdGet32(PcdFlashNvStorageFtwWorkingSize
) +
146 PcdGet32(PcdFlashNvStorageFtwSpareSize
);
149 // Verify the header revision, header signature, length
150 // Length of FvBlock cannot be 2**64-1
151 // HeaderLength cannot be an odd number
153 if ( (FwVolHeader
->Revision
!= EFI_FVH_REVISION
)
154 || (FwVolHeader
->Signature
!= EFI_FVH_SIGNATURE
)
155 || (FwVolHeader
->FvLength
!= FvLength
)
158 DEBUG ((EFI_D_ERROR
, "ValidateFvHeader: No Firmware Volume header present\n"));
159 return EFI_NOT_FOUND
;
162 // Check the Firmware Volume Guid
163 if( CompareGuid (&FwVolHeader
->FileSystemGuid
, &gEfiSystemNvDataFvGuid
) == FALSE
) {
164 DEBUG ((EFI_D_ERROR
, "ValidateFvHeader: Firmware Volume Guid non-compatible\n"));
165 return EFI_NOT_FOUND
;
168 // Verify the header checksum
169 Checksum
= CalculateSum16((UINT16
*)FwVolHeader
, FwVolHeader
->HeaderLength
);
171 DEBUG ((EFI_D_ERROR
, "ValidateFvHeader: FV checksum is invalid (Checksum:0x%X)\n",Checksum
));
172 return EFI_NOT_FOUND
;
175 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*)((UINTN
)FwVolHeader
+ FwVolHeader
->HeaderLength
);
177 // Check the Variable Store Guid
178 if( CompareGuid (&VariableStoreHeader
->Signature
, &gEfiVariableGuid
) == FALSE
) {
179 DEBUG ((EFI_D_ERROR
, "ValidateFvHeader: Variable Store Guid non-compatible\n"));
180 return EFI_NOT_FOUND
;
183 VariableStoreLength
= PcdGet32 (PcdFlashNvStorageVariableSize
) - FwVolHeader
->HeaderLength
;
184 if (VariableStoreHeader
->Size
!= VariableStoreLength
) {
185 DEBUG ((EFI_D_ERROR
, "ValidateFvHeader: Variable Store Length does not match\n"));
186 return EFI_NOT_FOUND
;
193 The GetAttributes() function retrieves the attributes and
194 current settings of the block.
196 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
198 @param Attributes Pointer to EFI_FVB_ATTRIBUTES_2 in which the attributes and
199 current settings are returned.
200 Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER.
202 @retval EFI_SUCCESS The firmware volume attributes were returned.
208 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
209 OUT EFI_FVB_ATTRIBUTES_2
*Attributes
212 EFI_FVB_ATTRIBUTES_2 FlashFvbAttributes
;
213 NOR_FLASH_INSTANCE
*Instance
;
215 Instance
= INSTANCE_FROM_FVB_THIS(This
);
217 FlashFvbAttributes
= (EFI_FVB_ATTRIBUTES_2
) (
219 EFI_FVB2_READ_ENABLED_CAP
| // Reads may be enabled
220 EFI_FVB2_READ_STATUS
| // Reads are currently enabled
221 EFI_FVB2_STICKY_WRITE
| // A block erase is required to flip bits into EFI_FVB2_ERASE_POLARITY
222 EFI_FVB2_MEMORY_MAPPED
| // It is memory mapped
223 EFI_FVB2_ERASE_POLARITY
// After erasure all bits take this value (i.e. '1')
227 // Check if it is write protected
228 if (Instance
->Media
.ReadOnly
!= TRUE
) {
230 FlashFvbAttributes
= FlashFvbAttributes
|
231 EFI_FVB2_WRITE_STATUS
| // Writes are currently enabled
232 EFI_FVB2_WRITE_ENABLED_CAP
; // Writes may be enabled
235 *Attributes
= FlashFvbAttributes
;
237 DEBUG ((DEBUG_BLKIO
, "FvbGetAttributes(0x%X)\n", *Attributes
));
243 The SetAttributes() function sets configurable firmware volume attributes
244 and returns the new settings of the firmware volume.
247 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
249 @param Attributes On input, Attributes is a pointer to EFI_FVB_ATTRIBUTES_2
250 that contains the desired firmware volume settings.
251 On successful return, it contains the new settings of
253 Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER.
255 @retval EFI_SUCCESS The firmware volume attributes were returned.
257 @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with the capabilities
258 as declared in the firmware volume header.
264 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
265 IN OUT EFI_FVB_ATTRIBUTES_2
*Attributes
268 DEBUG ((DEBUG_BLKIO
, "FvbSetAttributes(0x%X) is not supported\n",*Attributes
));
269 return EFI_UNSUPPORTED
;
273 The GetPhysicalAddress() function retrieves the base address of
274 a memory-mapped firmware volume. This function should be called
275 only for memory-mapped firmware volumes.
277 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
279 @param Address Pointer to a caller-allocated
280 EFI_PHYSICAL_ADDRESS that, on successful
281 return from GetPhysicalAddress(), contains the
282 base address of the firmware volume.
284 @retval EFI_SUCCESS The firmware volume base address was returned.
286 @retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.
291 FvbGetPhysicalAddress (
292 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
293 OUT EFI_PHYSICAL_ADDRESS
*Address
296 NOR_FLASH_INSTANCE
*Instance
;
298 Instance
= INSTANCE_FROM_FVB_THIS(This
);
300 DEBUG ((DEBUG_BLKIO
, "FvbGetPhysicalAddress(BaseAddress=0x%08x)\n", Instance
->RegionBaseAddress
));
302 ASSERT(Address
!= NULL
);
304 *Address
= PcdGet32 (PcdFlashNvStorageVariableBase
);
309 The GetBlockSize() function retrieves the size of the requested
310 block. It also returns the number of additional blocks with
311 the identical size. The GetBlockSize() function is used to
312 retrieve the block map (see EFI_FIRMWARE_VOLUME_HEADER).
315 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
317 @param Lba Indicates the block for which to return the size.
319 @param BlockSize Pointer to a caller-allocated UINTN in which
320 the size of the block is returned.
322 @param NumberOfBlocks Pointer to a caller-allocated UINTN in
323 which the number of consecutive blocks,
324 starting with Lba, is returned. All
325 blocks in this range have a size of
329 @retval EFI_SUCCESS The firmware volume base address was returned.
331 @retval EFI_INVALID_PARAMETER The requested LBA is out of range.
337 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
339 OUT UINTN
*BlockSize
,
340 OUT UINTN
*NumberOfBlocks
344 NOR_FLASH_INSTANCE
*Instance
;
346 Instance
= INSTANCE_FROM_FVB_THIS(This
);
348 DEBUG ((DEBUG_BLKIO
, "FvbGetBlockSize(Lba=%ld, BlockSize=0x%x, LastBlock=%ld)\n", Lba
, Instance
->Media
.BlockSize
, Instance
->Media
.LastBlock
));
350 if (Lba
> Instance
->Media
.LastBlock
) {
351 DEBUG ((EFI_D_ERROR
, "FvbGetBlockSize: ERROR - Parameter LBA %ld is beyond the last Lba (%ld).\n", Lba
, Instance
->Media
.LastBlock
));
352 Status
= EFI_INVALID_PARAMETER
;
354 // This is easy because in this platform each NorFlash device has equal sized blocks.
355 *BlockSize
= (UINTN
) Instance
->Media
.BlockSize
;
356 *NumberOfBlocks
= (UINTN
) (Instance
->Media
.LastBlock
- Lba
+ 1);
358 DEBUG ((DEBUG_BLKIO
, "FvbGetBlockSize: *BlockSize=0x%x, *NumberOfBlocks=0x%x.\n", *BlockSize
, *NumberOfBlocks
));
360 Status
= EFI_SUCCESS
;
367 Reads the specified number of bytes into a buffer from the specified block.
369 The Read() function reads the requested number of bytes from the
370 requested block and stores them in the provided buffer.
371 Implementations should be mindful that the firmware volume
372 might be in the ReadDisabled state. If it is in this state,
373 the Read() function must return the status code
374 EFI_ACCESS_DENIED without modifying the contents of the
375 buffer. The Read() function must also prevent spanning block
376 boundaries. If a read is requested that would span a block
377 boundary, the read must read up to the boundary but not
378 beyond. The output parameter NumBytes must be set to correctly
379 indicate the number of bytes actually read. The caller must be
380 aware that a read may be partially completed.
382 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
384 @param Lba The starting logical block index from which to read.
386 @param Offset Offset into the block at which to begin reading.
388 @param NumBytes Pointer to a UINTN.
389 At entry, *NumBytes contains the total size of the buffer.
390 At exit, *NumBytes contains the total number of bytes read.
392 @param Buffer Pointer to a caller-allocated buffer that will be used
393 to hold the data that is read.
395 @retval EFI_SUCCESS The firmware volume was read successfully, and contents are
398 @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA boundary.
399 On output, NumBytes contains the total number of bytes
402 @retval EFI_ACCESS_DENIED The firmware volume is in the ReadDisabled state.
404 @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be read.
410 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
413 IN OUT UINTN
*NumBytes
,
418 EFI_STATUS TempStatus
;
420 NOR_FLASH_INSTANCE
*Instance
;
422 Instance
= INSTANCE_FROM_FVB_THIS(This
);
424 DEBUG ((DEBUG_BLKIO
, "FvbRead(Parameters: Lba=%ld, Offset=0x%x, *NumBytes=0x%x, Buffer @ 0x%08x)\n", Instance
->StartLba
+ Lba
, Offset
, *NumBytes
, Buffer
));
426 if (!Instance
->Initialized
&& Instance
->Initialize
) {
427 Instance
->Initialize(Instance
);
430 Status
= EFI_SUCCESS
;
433 // Cache the block size to avoid de-referencing pointers all the time
434 BlockSize
= Instance
->Media
.BlockSize
;
436 DEBUG ((DEBUG_BLKIO
, "FvbRead: Check if (Offset=0x%x + NumBytes=0x%x) <= BlockSize=0x%x\n", Offset
, *NumBytes
, BlockSize
));
438 // The read must not span block boundaries.
439 // We need to check each variable individually because adding two large values together overflows.
440 if ((Offset
>= BlockSize
) ||
441 (*NumBytes
> BlockSize
) ||
442 ((Offset
+ *NumBytes
) > BlockSize
)) {
443 DEBUG ((EFI_D_ERROR
, "FvbRead: ERROR - EFI_BAD_BUFFER_SIZE: (Offset=0x%x + NumBytes=0x%x) > BlockSize=0x%x\n", Offset
, *NumBytes
, BlockSize
));
444 return EFI_BAD_BUFFER_SIZE
;
447 // We must have some bytes to read
448 if (*NumBytes
== 0) {
449 return EFI_BAD_BUFFER_SIZE
;
452 // Check we did get some memory
453 if (Instance
->FvbBuffer
== NULL
) {
454 DEBUG ((EFI_D_ERROR
, "FvbRead: ERROR - Buffer not ready\n"));
455 return EFI_DEVICE_ERROR
;
458 // Read NOR Flash data into shadow buffer
459 TempStatus
= NorFlashReadBlocks (Instance
, Instance
->StartLba
+ Lba
, BlockSize
, Instance
->FvbBuffer
);
460 if (EFI_ERROR (TempStatus
)) {
461 // Return one of the pre-approved error statuses
462 return EFI_DEVICE_ERROR
;
465 // Put the data at the appropriate location inside the buffer area
466 DEBUG ((DEBUG_BLKIO
, "FvbRead: CopyMem( Dst=0x%08x, Src=0x%08x, Size=0x%x ).\n", Buffer
, (UINTN
)Instance
->FvbBuffer
+ Offset
, *NumBytes
));
468 CopyMem (Buffer
, (VOID
*)((UINTN
)Instance
->FvbBuffer
+ Offset
), *NumBytes
);
474 Writes the specified number of bytes from the input buffer to the block.
476 The Write() function writes the specified number of bytes from
477 the provided buffer to the specified block and offset. If the
478 firmware volume is sticky write, the caller must ensure that
479 all the bits of the specified range to write are in the
480 EFI_FVB_ERASE_POLARITY state before calling the Write()
481 function, or else the result will be unpredictable. This
482 unpredictability arises because, for a sticky-write firmware
483 volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY
484 state but cannot flip it back again. Before calling the
485 Write() function, it is recommended for the caller to first call
486 the EraseBlocks() function to erase the specified block to
487 write. A block erase cycle will transition bits from the
488 (NOT)EFI_FVB_ERASE_POLARITY state back to the
489 EFI_FVB_ERASE_POLARITY state. Implementations should be
490 mindful that the firmware volume might be in the WriteDisabled
491 state. If it is in this state, the Write() function must
492 return the status code EFI_ACCESS_DENIED without modifying the
493 contents of the firmware volume. The Write() function must
494 also prevent spanning block boundaries. If a write is
495 requested that spans a block boundary, the write must store up
496 to the boundary but not beyond. The output parameter NumBytes
497 must be set to correctly indicate the number of bytes actually
498 written. The caller must be aware that a write may be
499 partially completed. All writes, partial or otherwise, must be
500 fully flushed to the hardware before the Write() service
503 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
505 @param Lba The starting logical block index to write to.
507 @param Offset Offset into the block at which to begin writing.
509 @param NumBytes The pointer to a UINTN.
510 At entry, *NumBytes contains the total size of the buffer.
511 At exit, *NumBytes contains the total number of bytes actually written.
513 @param Buffer The pointer to a caller-allocated buffer that contains the source for the write.
515 @retval EFI_SUCCESS The firmware volume was written successfully.
517 @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary.
518 On output, NumBytes contains the total number of bytes
521 @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.
523 @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not be written.
530 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
533 IN OUT UINTN
*NumBytes
,
538 EFI_STATUS TempStatus
;
540 NOR_FLASH_INSTANCE
*Instance
;
542 Instance
= INSTANCE_FROM_FVB_THIS(This
);
544 if (!Instance
->Initialized
&& Instance
->Initialize
) {
545 Instance
->Initialize(Instance
);
548 DEBUG ((DEBUG_BLKIO
, "FvbWrite(Parameters: Lba=%ld, Offset=0x%x, *NumBytes=0x%x, Buffer @ 0x%08x)\n", Instance
->StartLba
+ Lba
, Offset
, *NumBytes
, Buffer
));
550 Status
= EFI_SUCCESS
;
553 // Detect WriteDisabled state
554 if (Instance
->Media
.ReadOnly
== TRUE
) {
555 DEBUG ((EFI_D_ERROR
, "FvbWrite: ERROR - Can not write: Device is in WriteDisabled state.\n"));
556 // It is in WriteDisabled state, return an error right away
557 return EFI_ACCESS_DENIED
;
560 // Cache the block size to avoid de-referencing pointers all the time
561 BlockSize
= Instance
->Media
.BlockSize
;
563 // The write must not span block boundaries.
564 // We need to check each variable individually because adding two large values together overflows.
565 if ( ( Offset
>= BlockSize
) ||
566 ( *NumBytes
> BlockSize
) ||
567 ( (Offset
+ *NumBytes
) > BlockSize
) ) {
568 DEBUG ((EFI_D_ERROR
, "FvbWrite: ERROR - EFI_BAD_BUFFER_SIZE: (Offset=0x%x + NumBytes=0x%x) > BlockSize=0x%x\n", Offset
, *NumBytes
, BlockSize
));
569 return EFI_BAD_BUFFER_SIZE
;
572 // We must have some bytes to write
573 if (*NumBytes
== 0) {
574 DEBUG ((EFI_D_ERROR
, "FvbWrite: ERROR - EFI_BAD_BUFFER_SIZE: (Offset=0x%x + NumBytes=0x%x) > BlockSize=0x%x\n", Offset
, *NumBytes
, BlockSize
));
575 return EFI_BAD_BUFFER_SIZE
;
578 // Check we did get some memory
579 if (Instance
->FvbBuffer
== NULL
) {
580 DEBUG ((EFI_D_ERROR
, "FvbWrite: ERROR - Buffer not ready\n"));
581 return EFI_DEVICE_ERROR
;
584 // Read NOR Flash data into shadow buffer
585 TempStatus
= NorFlashReadBlocks (Instance
, Instance
->StartLba
+ Lba
, BlockSize
, Instance
->FvbBuffer
);
586 if (EFI_ERROR (TempStatus
)) {
587 // Return one of the pre-approved error statuses
588 return EFI_DEVICE_ERROR
;
591 // Put the data at the appropriate location inside the buffer area
592 CopyMem ((VOID
*)((UINTN
)Instance
->FvbBuffer
+ Offset
), Buffer
, *NumBytes
);
594 // Write the modified buffer back to the NorFlash
595 TempStatus
= NorFlashWriteBlocks (Instance
, Instance
->StartLba
+ Lba
, BlockSize
, Instance
->FvbBuffer
);
596 if (EFI_ERROR (TempStatus
)) {
597 // Return one of the pre-approved error statuses
598 return EFI_DEVICE_ERROR
;
605 Erases and initialises a firmware volume block.
607 The EraseBlocks() function erases one or more blocks as denoted
608 by the variable argument list. The entire parameter list of
609 blocks must be verified before erasing any blocks. If a block is
610 requested that does not exist within the associated firmware
611 volume (it has a larger index than the last block of the
612 firmware volume), the EraseBlocks() function must return the
613 status code EFI_INVALID_PARAMETER without modifying the contents
614 of the firmware volume. Implementations should be mindful that
615 the firmware volume might be in the WriteDisabled state. If it
616 is in this state, the EraseBlocks() function must return the
617 status code EFI_ACCESS_DENIED without modifying the contents of
618 the firmware volume. All calls to EraseBlocks() must be fully
619 flushed to the hardware before the EraseBlocks() service
622 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
625 @param ... The variable argument list is a list of tuples.
626 Each tuple describes a range of LBAs to erase
627 and consists of the following:
628 - An EFI_LBA that indicates the starting LBA
629 - A UINTN that indicates the number of blocks to erase.
631 The list is terminated with an EFI_LBA_LIST_TERMINATOR.
632 For example, the following indicates that two ranges of blocks
633 (5-7 and 10-11) are to be erased:
634 EraseBlocks (This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);
636 @retval EFI_SUCCESS The erase request successfully completed.
638 @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.
640 @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be written.
641 The firmware device may have been partially erased.
643 @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable argument list do
644 not exist in the firmware volume.
650 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
656 UINTN BlockAddress
; // Physical address of Lba to erase
657 EFI_LBA StartingLba
; // Lba from which we start erasing
658 UINTN NumOfLba
; // Number of Lba blocks to erase
659 NOR_FLASH_INSTANCE
*Instance
;
661 Instance
= INSTANCE_FROM_FVB_THIS(This
);
663 DEBUG ((DEBUG_BLKIO
, "FvbEraseBlocks()\n"));
665 Status
= EFI_SUCCESS
;
667 // Detect WriteDisabled state
668 if (Instance
->Media
.ReadOnly
== TRUE
) {
669 // Firmware volume is in WriteDisabled state
670 DEBUG ((EFI_D_ERROR
, "FvbEraseBlocks: ERROR - Device is in WriteDisabled state.\n"));
671 return EFI_ACCESS_DENIED
;
674 // Before erasing, check the entire list of parameters to ensure all specified blocks are valid
676 VA_START (Args
, This
);
678 // Get the Lba from which we start erasing
679 StartingLba
= VA_ARG (Args
, EFI_LBA
);
681 // Have we reached the end of the list?
682 if (StartingLba
== EFI_LBA_LIST_TERMINATOR
) {
683 //Exit the while loop
687 // How many Lba blocks are we requested to erase?
688 NumOfLba
= VA_ARG (Args
, UINT32
);
690 // All blocks must be within range
691 DEBUG ((DEBUG_BLKIO
, "FvbEraseBlocks: Check if: ( StartingLba=%ld + NumOfLba=%d - 1 ) > LastBlock=%ld.\n", Instance
->StartLba
+ StartingLba
, NumOfLba
, Instance
->Media
.LastBlock
));
692 if ((NumOfLba
== 0) || ((Instance
->StartLba
+ StartingLba
+ NumOfLba
- 1) > Instance
->Media
.LastBlock
)) {
694 DEBUG ((EFI_D_ERROR
, "FvbEraseBlocks: ERROR - Lba range goes past the last Lba.\n"));
695 Status
= EFI_INVALID_PARAMETER
;
702 // To get here, all must be ok, so start erasing
704 VA_START (Args
, This
);
706 // Get the Lba from which we start erasing
707 StartingLba
= VA_ARG (Args
, EFI_LBA
);
709 // Have we reached the end of the list?
710 if (StartingLba
== EFI_LBA_LIST_TERMINATOR
) {
711 // Exit the while loop
715 // How many Lba blocks are we requested to erase?
716 NumOfLba
= VA_ARG (Args
, UINT32
);
718 // Go through each one and erase it
719 while (NumOfLba
> 0) {
721 // Get the physical address of Lba to erase
722 BlockAddress
= GET_NOR_BLOCK_ADDRESS (
723 Instance
->RegionBaseAddress
,
724 Instance
->StartLba
+ StartingLba
,
725 Instance
->Media
.BlockSize
729 DEBUG ((DEBUG_BLKIO
, "FvbEraseBlocks: Erasing Lba=%ld @ 0x%08x.\n", Instance
->StartLba
+ StartingLba
, BlockAddress
));
730 Status
= NorFlashUnlockAndEraseSingleBlock (Instance
, BlockAddress
);
731 if (EFI_ERROR(Status
)) {
733 Status
= EFI_DEVICE_ERROR
;
737 // Move to the next Lba
750 NorFlashFvbInitialize (
751 IN NOR_FLASH_INSTANCE
* Instance
756 EFI_BOOT_MODE BootMode
;
758 DEBUG((DEBUG_BLKIO
,"NorFlashFvbInitialize\n"));
760 Instance
->Initialized
= TRUE
;
762 // Set the index of the first LBA for the FVB
763 Instance
->StartLba
= (PcdGet32 (PcdFlashNvStorageVariableBase
) - Instance
->RegionBaseAddress
) / Instance
->Media
.BlockSize
;
765 BootMode
= GetBootModeHob ();
766 if (BootMode
== BOOT_WITH_DEFAULT_SETTINGS
) {
767 Status
= EFI_INVALID_PARAMETER
;
769 // Determine if there is a valid header at the beginning of the NorFlash
770 Status
= ValidateFvHeader (Instance
);
773 // Install the Default FVB header if required
774 if (EFI_ERROR(Status
)) {
775 // There is no valid header, so time to install one.
776 DEBUG((EFI_D_ERROR
,"NorFlashFvbInitialize: ERROR - The FVB Header is not valid. Installing a correct one for this volume.\n"));
778 // Erase all the NorFlash that is reserved for variable storage
779 FvbNumLba
= (PcdGet32(PcdFlashNvStorageVariableSize
) + PcdGet32(PcdFlashNvStorageFtwWorkingSize
) + PcdGet32(PcdFlashNvStorageFtwSpareSize
)) / Instance
->Media
.BlockSize
;
781 Status
= FvbEraseBlocks (&Instance
->FvbProtocol
, (EFI_LBA
)0, FvbNumLba
, EFI_LBA_LIST_TERMINATOR
);
782 if (EFI_ERROR(Status
)) {
786 // Install all appropriate headers
787 Status
= InitializeFvAndVariableStoreHeaders (Instance
);
788 if (EFI_ERROR(Status
)) {