1 /*++ @file NorFlashFvbDxe.c
3 Copyright (c) 2011 - 2020, ARM Ltd. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
11 #include <Library/PcdLib.h>
12 #include <Library/BaseLib.h>
13 #include <Library/HobLib.h>
14 #include <Library/UefiLib.h>
15 #include <Library/BaseMemoryLib.h>
16 #include <Library/MemoryAllocationLib.h>
17 #include <Library/DxeServicesTableLib.h>
18 #include <Library/UefiBootServicesTableLib.h>
20 #include <Guid/VariableFormat.h>
21 #include <Guid/SystemNvDataGuid.h>
22 #include <Guid/NvVarStoreFormatted.h>
24 #include "NorFlashDxe.h"
26 STATIC EFI_EVENT mFvbVirtualAddrChangeEvent
;
27 STATIC UINTN mFlashNvStorageVariableBase
;
30 /// The Firmware Volume Block Protocol is the low-level interface
31 /// to a firmware volume. File-level access to a firmware volume
32 /// should not be done using the Firmware Volume Block Protocol.
33 /// Normal access to a firmware volume must use the Firmware
34 /// Volume Protocol. Typically, only the file system driver that
35 /// produces the Firmware Volume Protocol will bind to the
36 /// Firmware Volume Block Protocol.
40 Initialises the FV Header and Variable Store Header
41 to support variable operations.
43 @param[in] Ptr - Location to initialise the headers
47 InitializeFvAndVariableStoreHeaders (
48 IN NOR_FLASH_INSTANCE
*Instance
54 EFI_FIRMWARE_VOLUME_HEADER
*FirmwareVolumeHeader
;
55 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
57 HeadersLength
= sizeof(EFI_FIRMWARE_VOLUME_HEADER
) + sizeof(EFI_FV_BLOCK_MAP_ENTRY
) + sizeof(VARIABLE_STORE_HEADER
);
58 Headers
= AllocateZeroPool(HeadersLength
);
60 // FirmwareVolumeHeader->FvLength is declared to have the Variable area AND the FTW working area AND the FTW Spare contiguous.
61 ASSERT(PcdGet32(PcdFlashNvStorageVariableBase
) + PcdGet32(PcdFlashNvStorageVariableSize
) == PcdGet32(PcdFlashNvStorageFtwWorkingBase
));
62 ASSERT(PcdGet32(PcdFlashNvStorageFtwWorkingBase
) + PcdGet32(PcdFlashNvStorageFtwWorkingSize
) == PcdGet32(PcdFlashNvStorageFtwSpareBase
));
64 // Check if the size of the area is at least one block size
65 ASSERT((PcdGet32(PcdFlashNvStorageVariableSize
) > 0) && (PcdGet32(PcdFlashNvStorageVariableSize
) / Instance
->Media
.BlockSize
> 0));
66 ASSERT((PcdGet32(PcdFlashNvStorageFtwWorkingSize
) > 0) && (PcdGet32(PcdFlashNvStorageFtwWorkingSize
) / Instance
->Media
.BlockSize
> 0));
67 ASSERT((PcdGet32(PcdFlashNvStorageFtwSpareSize
) > 0) && (PcdGet32(PcdFlashNvStorageFtwSpareSize
) / Instance
->Media
.BlockSize
> 0));
69 // Ensure the Variable area Base Addresses are aligned on a block size boundaries
70 ASSERT(PcdGet32(PcdFlashNvStorageVariableBase
) % Instance
->Media
.BlockSize
== 0);
71 ASSERT(PcdGet32(PcdFlashNvStorageFtwWorkingBase
) % Instance
->Media
.BlockSize
== 0);
72 ASSERT(PcdGet32(PcdFlashNvStorageFtwSpareBase
) % Instance
->Media
.BlockSize
== 0);
75 // EFI_FIRMWARE_VOLUME_HEADER
77 FirmwareVolumeHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*)Headers
;
78 CopyGuid (&FirmwareVolumeHeader
->FileSystemGuid
, &gEfiSystemNvDataFvGuid
);
79 FirmwareVolumeHeader
->FvLength
=
80 PcdGet32(PcdFlashNvStorageVariableSize
) +
81 PcdGet32(PcdFlashNvStorageFtwWorkingSize
) +
82 PcdGet32(PcdFlashNvStorageFtwSpareSize
);
83 FirmwareVolumeHeader
->Signature
= EFI_FVH_SIGNATURE
;
84 FirmwareVolumeHeader
->Attributes
= (EFI_FVB_ATTRIBUTES_2
) (
85 EFI_FVB2_READ_ENABLED_CAP
| // Reads may be enabled
86 EFI_FVB2_READ_STATUS
| // Reads are currently enabled
87 EFI_FVB2_STICKY_WRITE
| // A block erase is required to flip bits into EFI_FVB2_ERASE_POLARITY
88 EFI_FVB2_MEMORY_MAPPED
| // It is memory mapped
89 EFI_FVB2_ERASE_POLARITY
| // After erasure all bits take this value (i.e. '1')
90 EFI_FVB2_WRITE_STATUS
| // Writes are currently enabled
91 EFI_FVB2_WRITE_ENABLED_CAP
// Writes may be enabled
93 FirmwareVolumeHeader
->HeaderLength
= sizeof(EFI_FIRMWARE_VOLUME_HEADER
) + sizeof(EFI_FV_BLOCK_MAP_ENTRY
);
94 FirmwareVolumeHeader
->Revision
= EFI_FVH_REVISION
;
95 FirmwareVolumeHeader
->BlockMap
[0].NumBlocks
= Instance
->Media
.LastBlock
+ 1;
96 FirmwareVolumeHeader
->BlockMap
[0].Length
= Instance
->Media
.BlockSize
;
97 FirmwareVolumeHeader
->BlockMap
[1].NumBlocks
= 0;
98 FirmwareVolumeHeader
->BlockMap
[1].Length
= 0;
99 FirmwareVolumeHeader
->Checksum
= CalculateCheckSum16 ((UINT16
*)FirmwareVolumeHeader
,FirmwareVolumeHeader
->HeaderLength
);
102 // VARIABLE_STORE_HEADER
104 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*)((UINTN
)Headers
+ FirmwareVolumeHeader
->HeaderLength
);
105 CopyGuid (&VariableStoreHeader
->Signature
, &gEfiAuthenticatedVariableGuid
);
106 VariableStoreHeader
->Size
= PcdGet32(PcdFlashNvStorageVariableSize
) - FirmwareVolumeHeader
->HeaderLength
;
107 VariableStoreHeader
->Format
= VARIABLE_STORE_FORMATTED
;
108 VariableStoreHeader
->State
= VARIABLE_STORE_HEALTHY
;
110 // Install the combined super-header in the NorFlash
111 Status
= FvbWrite (&Instance
->FvbProtocol
, 0, 0, &HeadersLength
, Headers
);
118 Check the integrity of firmware volume header.
120 @param[in] FwVolHeader - A pointer to a firmware volume header
122 @retval EFI_SUCCESS - The firmware volume is consistent
123 @retval EFI_NOT_FOUND - The firmware volume has been corrupted.
128 IN NOR_FLASH_INSTANCE
*Instance
132 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
133 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
134 UINTN VariableStoreLength
;
137 FwVolHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*)Instance
->RegionBaseAddress
;
139 FvLength
= PcdGet32(PcdFlashNvStorageVariableSize
) + PcdGet32(PcdFlashNvStorageFtwWorkingSize
) +
140 PcdGet32(PcdFlashNvStorageFtwSpareSize
);
143 // Verify the header revision, header signature, length
144 // Length of FvBlock cannot be 2**64-1
145 // HeaderLength cannot be an odd number
147 if ( (FwVolHeader
->Revision
!= EFI_FVH_REVISION
)
148 || (FwVolHeader
->Signature
!= EFI_FVH_SIGNATURE
)
149 || (FwVolHeader
->FvLength
!= FvLength
)
152 DEBUG ((EFI_D_INFO
, "%a: No Firmware Volume header present\n",
154 return EFI_NOT_FOUND
;
157 // Check the Firmware Volume Guid
158 if( CompareGuid (&FwVolHeader
->FileSystemGuid
, &gEfiSystemNvDataFvGuid
) == FALSE
) {
159 DEBUG ((EFI_D_INFO
, "%a: Firmware Volume Guid non-compatible\n",
161 return EFI_NOT_FOUND
;
164 // Verify the header checksum
165 Checksum
= CalculateSum16((UINT16
*)FwVolHeader
, FwVolHeader
->HeaderLength
);
167 DEBUG ((EFI_D_INFO
, "%a: FV checksum is invalid (Checksum:0x%X)\n",
168 __FUNCTION__
, Checksum
));
169 return EFI_NOT_FOUND
;
172 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*)((UINTN
)FwVolHeader
+ FwVolHeader
->HeaderLength
);
174 // Check the Variable Store Guid
175 if (!CompareGuid (&VariableStoreHeader
->Signature
, &gEfiVariableGuid
) &&
176 !CompareGuid (&VariableStoreHeader
->Signature
, &gEfiAuthenticatedVariableGuid
)) {
177 DEBUG ((EFI_D_INFO
, "%a: Variable Store Guid non-compatible\n",
179 return EFI_NOT_FOUND
;
182 VariableStoreLength
= PcdGet32 (PcdFlashNvStorageVariableSize
) - FwVolHeader
->HeaderLength
;
183 if (VariableStoreHeader
->Size
!= VariableStoreLength
) {
184 DEBUG ((EFI_D_INFO
, "%a: 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
= mFlashNvStorageVariableBase
;
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
,
417 EFI_STATUS TempStatus
;
419 NOR_FLASH_INSTANCE
*Instance
;
421 Instance
= INSTANCE_FROM_FVB_THIS(This
);
423 DEBUG ((DEBUG_BLKIO
, "FvbRead(Parameters: Lba=%ld, Offset=0x%x, *NumBytes=0x%x, Buffer @ 0x%08x)\n", Instance
->StartLba
+ Lba
, Offset
, *NumBytes
, Buffer
));
425 TempStatus
= EFI_SUCCESS
;
427 // Cache the block size to avoid de-referencing pointers all the time
428 BlockSize
= Instance
->Media
.BlockSize
;
430 DEBUG ((DEBUG_BLKIO
, "FvbRead: Check if (Offset=0x%x + NumBytes=0x%x) <= BlockSize=0x%x\n", Offset
, *NumBytes
, BlockSize
));
432 // The read must not span block boundaries.
433 // We need to check each variable individually because adding two large values together overflows.
434 if ((Offset
>= BlockSize
) ||
435 (*NumBytes
> BlockSize
) ||
436 ((Offset
+ *NumBytes
) > BlockSize
)) {
437 DEBUG ((EFI_D_ERROR
, "FvbRead: ERROR - EFI_BAD_BUFFER_SIZE: (Offset=0x%x + NumBytes=0x%x) > BlockSize=0x%x\n", Offset
, *NumBytes
, BlockSize
));
438 return EFI_BAD_BUFFER_SIZE
;
441 // We must have some bytes to read
442 if (*NumBytes
== 0) {
443 return EFI_BAD_BUFFER_SIZE
;
446 // Decide if we are doing full block reads or not.
447 if (*NumBytes
% BlockSize
!= 0) {
448 TempStatus
= NorFlashRead (Instance
, Instance
->StartLba
+ Lba
, Offset
, *NumBytes
, Buffer
);
449 if (EFI_ERROR (TempStatus
)) {
450 return EFI_DEVICE_ERROR
;
453 // Read NOR Flash data into shadow buffer
454 TempStatus
= NorFlashReadBlocks (Instance
, Instance
->StartLba
+ Lba
, BlockSize
, Buffer
);
455 if (EFI_ERROR (TempStatus
)) {
456 // Return one of the pre-approved error statuses
457 return EFI_DEVICE_ERROR
;
464 Writes the specified number of bytes from the input buffer to the block.
466 The Write() function writes the specified number of bytes from
467 the provided buffer to the specified block and offset. If the
468 firmware volume is sticky write, the caller must ensure that
469 all the bits of the specified range to write are in the
470 EFI_FVB_ERASE_POLARITY state before calling the Write()
471 function, or else the result will be unpredictable. This
472 unpredictability arises because, for a sticky-write firmware
473 volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY
474 state but cannot flip it back again. Before calling the
475 Write() function, it is recommended for the caller to first call
476 the EraseBlocks() function to erase the specified block to
477 write. A block erase cycle will transition bits from the
478 (NOT)EFI_FVB_ERASE_POLARITY state back to the
479 EFI_FVB_ERASE_POLARITY state. Implementations should be
480 mindful that the firmware volume might be in the WriteDisabled
481 state. If it is in this state, the Write() function must
482 return the status code EFI_ACCESS_DENIED without modifying the
483 contents of the firmware volume. The Write() function must
484 also prevent spanning block boundaries. If a write is
485 requested that spans a block boundary, the write must store up
486 to the boundary but not beyond. The output parameter NumBytes
487 must be set to correctly indicate the number of bytes actually
488 written. The caller must be aware that a write may be
489 partially completed. All writes, partial or otherwise, must be
490 fully flushed to the hardware before the Write() service
493 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
495 @param Lba The starting logical block index to write to.
497 @param Offset Offset into the block at which to begin writing.
499 @param NumBytes The pointer to a UINTN.
500 At entry, *NumBytes contains the total size of the buffer.
501 At exit, *NumBytes contains the total number of bytes actually written.
503 @param Buffer The pointer to a caller-allocated buffer that contains the source for the write.
505 @retval EFI_SUCCESS The firmware volume was written successfully.
507 @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary.
508 On output, NumBytes contains the total number of bytes
511 @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.
513 @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not be written.
520 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
523 IN OUT UINTN
*NumBytes
,
527 NOR_FLASH_INSTANCE
*Instance
;
529 Instance
= INSTANCE_FROM_FVB_THIS (This
);
531 return NorFlashWriteSingleBlock (Instance
, Instance
->StartLba
+ Lba
, Offset
, NumBytes
, Buffer
);
535 Erases and initialises a firmware volume block.
537 The EraseBlocks() function erases one or more blocks as denoted
538 by the variable argument list. The entire parameter list of
539 blocks must be verified before erasing any blocks. If a block is
540 requested that does not exist within the associated firmware
541 volume (it has a larger index than the last block of the
542 firmware volume), the EraseBlocks() function must return the
543 status code EFI_INVALID_PARAMETER without modifying the contents
544 of the firmware volume. Implementations should be mindful that
545 the firmware volume might be in the WriteDisabled state. If it
546 is in this state, the EraseBlocks() function must return the
547 status code EFI_ACCESS_DENIED without modifying the contents of
548 the firmware volume. All calls to EraseBlocks() must be fully
549 flushed to the hardware before the EraseBlocks() service
552 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
555 @param ... The variable argument list is a list of tuples.
556 Each tuple describes a range of LBAs to erase
557 and consists of the following:
558 - An EFI_LBA that indicates the starting LBA
559 - A UINTN that indicates the number of blocks to erase.
561 The list is terminated with an EFI_LBA_LIST_TERMINATOR.
562 For example, the following indicates that two ranges of blocks
563 (5-7 and 10-11) are to be erased:
564 EraseBlocks (This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);
566 @retval EFI_SUCCESS The erase request successfully completed.
568 @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.
570 @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be written.
571 The firmware device may have been partially erased.
573 @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable argument list do
574 not exist in the firmware volume.
580 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
586 UINTN BlockAddress
; // Physical address of Lba to erase
587 EFI_LBA StartingLba
; // Lba from which we start erasing
588 UINTN NumOfLba
; // Number of Lba blocks to erase
589 NOR_FLASH_INSTANCE
*Instance
;
591 Instance
= INSTANCE_FROM_FVB_THIS(This
);
593 DEBUG ((DEBUG_BLKIO
, "FvbEraseBlocks()\n"));
595 Status
= EFI_SUCCESS
;
597 // Detect WriteDisabled state
598 if (Instance
->Media
.ReadOnly
== TRUE
) {
599 // Firmware volume is in WriteDisabled state
600 DEBUG ((EFI_D_ERROR
, "FvbEraseBlocks: ERROR - Device is in WriteDisabled state.\n"));
601 return EFI_ACCESS_DENIED
;
604 // Before erasing, check the entire list of parameters to ensure all specified blocks are valid
606 VA_START (Args
, This
);
608 // Get the Lba from which we start erasing
609 StartingLba
= VA_ARG (Args
, EFI_LBA
);
611 // Have we reached the end of the list?
612 if (StartingLba
== EFI_LBA_LIST_TERMINATOR
) {
613 //Exit the while loop
617 // How many Lba blocks are we requested to erase?
618 NumOfLba
= VA_ARG (Args
, UINTN
);
620 // All blocks must be within range
623 "FvbEraseBlocks: Check if: ( StartingLba=%ld + NumOfLba=%Lu - 1 ) > LastBlock=%ld.\n",
624 Instance
->StartLba
+ StartingLba
,
626 Instance
->Media
.LastBlock
628 if ((NumOfLba
== 0) || ((Instance
->StartLba
+ StartingLba
+ NumOfLba
- 1) > Instance
->Media
.LastBlock
)) {
630 DEBUG ((EFI_D_ERROR
, "FvbEraseBlocks: ERROR - Lba range goes past the last Lba.\n"));
631 Status
= EFI_INVALID_PARAMETER
;
638 // To get here, all must be ok, so start erasing
640 VA_START (Args
, This
);
642 // Get the Lba from which we start erasing
643 StartingLba
= VA_ARG (Args
, EFI_LBA
);
645 // Have we reached the end of the list?
646 if (StartingLba
== EFI_LBA_LIST_TERMINATOR
) {
647 // Exit the while loop
651 // How many Lba blocks are we requested to erase?
652 NumOfLba
= VA_ARG (Args
, UINTN
);
654 // Go through each one and erase it
655 while (NumOfLba
> 0) {
657 // Get the physical address of Lba to erase
658 BlockAddress
= GET_NOR_BLOCK_ADDRESS (
659 Instance
->RegionBaseAddress
,
660 Instance
->StartLba
+ StartingLba
,
661 Instance
->Media
.BlockSize
665 DEBUG ((DEBUG_BLKIO
, "FvbEraseBlocks: Erasing Lba=%ld @ 0x%08x.\n", Instance
->StartLba
+ StartingLba
, BlockAddress
));
666 Status
= NorFlashUnlockAndEraseSingleBlock (Instance
, BlockAddress
);
667 if (EFI_ERROR(Status
)) {
669 Status
= EFI_DEVICE_ERROR
;
673 // Move to the next Lba
685 Fixup internal data so that EFI can be call in virtual mode.
686 Call the passed in Child Notify event and convert any pointers in
689 @param[in] Event The Event that is being processed
690 @param[in] Context Event Context
694 FvbVirtualNotifyEvent (
699 EfiConvertPointer (0x0, (VOID
**)&mFlashNvStorageVariableBase
);
705 NorFlashFvbInitialize (
706 IN NOR_FLASH_INSTANCE
* Instance
711 EFI_BOOT_MODE BootMode
;
712 UINTN RuntimeMmioRegionSize
;
714 DEBUG((DEBUG_BLKIO
,"NorFlashFvbInitialize\n"));
715 ASSERT((Instance
!= NULL
));
718 // Declare the Non-Volatile storage as EFI_MEMORY_RUNTIME
721 // Note: all the NOR Flash region needs to be reserved into the UEFI Runtime memory;
722 // even if we only use the small block region at the top of the NOR Flash.
723 // The reason is when the NOR Flash memory is set into program mode, the command
724 // is written as the base of the flash region (ie: Instance->DeviceBaseAddress)
725 RuntimeMmioRegionSize
= (Instance
->RegionBaseAddress
- Instance
->DeviceBaseAddress
) + Instance
->Size
;
727 Status
= gDS
->AddMemorySpace (
728 EfiGcdMemoryTypeMemoryMappedIo
,
729 Instance
->DeviceBaseAddress
, RuntimeMmioRegionSize
,
730 EFI_MEMORY_UC
| EFI_MEMORY_RUNTIME
732 ASSERT_EFI_ERROR (Status
);
734 Status
= gDS
->SetMemorySpaceAttributes (
735 Instance
->DeviceBaseAddress
, RuntimeMmioRegionSize
,
736 EFI_MEMORY_UC
| EFI_MEMORY_RUNTIME
);
737 ASSERT_EFI_ERROR (Status
);
739 mFlashNvStorageVariableBase
= PcdGet32 (PcdFlashNvStorageVariableBase
);
741 // Set the index of the first LBA for the FVB
742 Instance
->StartLba
= (PcdGet32 (PcdFlashNvStorageVariableBase
) - Instance
->RegionBaseAddress
) / Instance
->Media
.BlockSize
;
744 BootMode
= GetBootModeHob ();
745 if (BootMode
== BOOT_WITH_DEFAULT_SETTINGS
) {
746 Status
= EFI_INVALID_PARAMETER
;
748 // Determine if there is a valid header at the beginning of the NorFlash
749 Status
= ValidateFvHeader (Instance
);
752 // Install the Default FVB header if required
753 if (EFI_ERROR(Status
)) {
754 // There is no valid header, so time to install one.
755 DEBUG ((EFI_D_INFO
, "%a: The FVB Header is not valid.\n", __FUNCTION__
));
756 DEBUG ((EFI_D_INFO
, "%a: Installing a correct one for this volume.\n",
759 // Erase all the NorFlash that is reserved for variable storage
760 FvbNumLba
= (PcdGet32(PcdFlashNvStorageVariableSize
) + PcdGet32(PcdFlashNvStorageFtwWorkingSize
) + PcdGet32(PcdFlashNvStorageFtwSpareSize
)) / Instance
->Media
.BlockSize
;
762 Status
= FvbEraseBlocks (&Instance
->FvbProtocol
, (EFI_LBA
)0, FvbNumLba
, EFI_LBA_LIST_TERMINATOR
);
763 if (EFI_ERROR(Status
)) {
767 // Install all appropriate headers
768 Status
= InitializeFvAndVariableStoreHeaders (Instance
);
769 if (EFI_ERROR(Status
)) {
775 // The driver implementing the variable read service can now be dispatched;
776 // the varstore headers are in place.
778 Status
= gBS
->InstallProtocolInterface (
780 &gEdkiiNvVarStoreFormattedGuid
,
781 EFI_NATIVE_INTERFACE
,
784 ASSERT_EFI_ERROR (Status
);
787 // Register for the virtual address change event
789 Status
= gBS
->CreateEventEx (
792 FvbVirtualNotifyEvent
,
794 &gEfiEventVirtualAddressChangeGuid
,
795 &mFvbVirtualAddrChangeEvent
797 ASSERT_EFI_ERROR (Status
);