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/DxeServicesTableLib.h>
24 #include <Library/UefiBootServicesTableLib.h>
26 #include <Guid/VariableFormat.h>
27 #include <Guid/SystemNvDataGuid.h>
28 #include <Guid/NvVarStoreFormatted.h>
30 #include "NorFlashDxe.h"
32 STATIC EFI_EVENT mFvbVirtualAddrChangeEvent
;
33 STATIC UINTN mFlashNvStorageVariableBase
;
36 /// The Firmware Volume Block Protocol is the low-level interface
37 /// to a firmware volume. File-level access to a firmware volume
38 /// should not be done using the Firmware Volume Block Protocol.
39 /// Normal access to a firmware volume must use the Firmware
40 /// Volume Protocol. Typically, only the file system driver that
41 /// produces the Firmware Volume Protocol will bind to the
42 /// Firmware Volume Block Protocol.
46 Initialises the FV Header and Variable Store Header
47 to support variable operations.
49 @param[in] Ptr - Location to initialise the headers
53 InitializeFvAndVariableStoreHeaders (
54 IN NOR_FLASH_INSTANCE
*Instance
60 EFI_FIRMWARE_VOLUME_HEADER
*FirmwareVolumeHeader
;
61 VARIABLE_STORE_HEADER
*VariableStoreHeader
;
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
, &gEfiAuthenticatedVariableGuid
);
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_INFO
, "%a: No Firmware Volume header present\n",
160 return EFI_NOT_FOUND
;
163 // Check the Firmware Volume Guid
164 if( CompareGuid (&FwVolHeader
->FileSystemGuid
, &gEfiSystemNvDataFvGuid
) == FALSE
) {
165 DEBUG ((EFI_D_INFO
, "%a: Firmware Volume Guid non-compatible\n",
167 return EFI_NOT_FOUND
;
170 // Verify the header checksum
171 Checksum
= CalculateSum16((UINT16
*)FwVolHeader
, FwVolHeader
->HeaderLength
);
173 DEBUG ((EFI_D_INFO
, "%a: FV checksum is invalid (Checksum:0x%X)\n",
174 __FUNCTION__
, Checksum
));
175 return EFI_NOT_FOUND
;
178 VariableStoreHeader
= (VARIABLE_STORE_HEADER
*)((UINTN
)FwVolHeader
+ FwVolHeader
->HeaderLength
);
180 // Check the Variable Store Guid
181 if (!CompareGuid (&VariableStoreHeader
->Signature
, &gEfiVariableGuid
) &&
182 !CompareGuid (&VariableStoreHeader
->Signature
, &gEfiAuthenticatedVariableGuid
)) {
183 DEBUG ((EFI_D_INFO
, "%a: Variable Store Guid non-compatible\n",
185 return EFI_NOT_FOUND
;
188 VariableStoreLength
= PcdGet32 (PcdFlashNvStorageVariableSize
) - FwVolHeader
->HeaderLength
;
189 if (VariableStoreHeader
->Size
!= VariableStoreLength
) {
190 DEBUG ((EFI_D_INFO
, "%a: Variable Store Length does not match\n",
192 return EFI_NOT_FOUND
;
199 The GetAttributes() function retrieves the attributes and
200 current settings of the block.
202 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
204 @param Attributes Pointer to EFI_FVB_ATTRIBUTES_2 in which the attributes and
205 current settings are returned.
206 Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER.
208 @retval EFI_SUCCESS The firmware volume attributes were returned.
214 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
215 OUT EFI_FVB_ATTRIBUTES_2
*Attributes
218 EFI_FVB_ATTRIBUTES_2 FlashFvbAttributes
;
219 NOR_FLASH_INSTANCE
*Instance
;
221 Instance
= INSTANCE_FROM_FVB_THIS(This
);
223 FlashFvbAttributes
= (EFI_FVB_ATTRIBUTES_2
) (
225 EFI_FVB2_READ_ENABLED_CAP
| // Reads may be enabled
226 EFI_FVB2_READ_STATUS
| // Reads are currently enabled
227 EFI_FVB2_STICKY_WRITE
| // A block erase is required to flip bits into EFI_FVB2_ERASE_POLARITY
228 EFI_FVB2_MEMORY_MAPPED
| // It is memory mapped
229 EFI_FVB2_ERASE_POLARITY
// After erasure all bits take this value (i.e. '1')
233 // Check if it is write protected
234 if (Instance
->Media
.ReadOnly
!= TRUE
) {
236 FlashFvbAttributes
= FlashFvbAttributes
|
237 EFI_FVB2_WRITE_STATUS
| // Writes are currently enabled
238 EFI_FVB2_WRITE_ENABLED_CAP
; // Writes may be enabled
241 *Attributes
= FlashFvbAttributes
;
243 DEBUG ((DEBUG_BLKIO
, "FvbGetAttributes(0x%X)\n", *Attributes
));
249 The SetAttributes() function sets configurable firmware volume attributes
250 and returns the new settings of the firmware volume.
253 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
255 @param Attributes On input, Attributes is a pointer to EFI_FVB_ATTRIBUTES_2
256 that contains the desired firmware volume settings.
257 On successful return, it contains the new settings of
259 Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER.
261 @retval EFI_SUCCESS The firmware volume attributes were returned.
263 @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with the capabilities
264 as declared in the firmware volume header.
270 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
271 IN OUT EFI_FVB_ATTRIBUTES_2
*Attributes
274 DEBUG ((DEBUG_BLKIO
, "FvbSetAttributes(0x%X) is not supported\n",*Attributes
));
275 return EFI_UNSUPPORTED
;
279 The GetPhysicalAddress() function retrieves the base address of
280 a memory-mapped firmware volume. This function should be called
281 only for memory-mapped firmware volumes.
283 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
285 @param Address Pointer to a caller-allocated
286 EFI_PHYSICAL_ADDRESS that, on successful
287 return from GetPhysicalAddress(), contains the
288 base address of the firmware volume.
290 @retval EFI_SUCCESS The firmware volume base address was returned.
292 @retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.
297 FvbGetPhysicalAddress (
298 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
299 OUT EFI_PHYSICAL_ADDRESS
*Address
302 NOR_FLASH_INSTANCE
*Instance
;
304 Instance
= INSTANCE_FROM_FVB_THIS(This
);
306 DEBUG ((DEBUG_BLKIO
, "FvbGetPhysicalAddress(BaseAddress=0x%08x)\n", Instance
->RegionBaseAddress
));
308 ASSERT(Address
!= NULL
);
310 *Address
= mFlashNvStorageVariableBase
;
315 The GetBlockSize() function retrieves the size of the requested
316 block. It also returns the number of additional blocks with
317 the identical size. The GetBlockSize() function is used to
318 retrieve the block map (see EFI_FIRMWARE_VOLUME_HEADER).
321 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
323 @param Lba Indicates the block for which to return the size.
325 @param BlockSize Pointer to a caller-allocated UINTN in which
326 the size of the block is returned.
328 @param NumberOfBlocks Pointer to a caller-allocated UINTN in
329 which the number of consecutive blocks,
330 starting with Lba, is returned. All
331 blocks in this range have a size of
335 @retval EFI_SUCCESS The firmware volume base address was returned.
337 @retval EFI_INVALID_PARAMETER The requested LBA is out of range.
343 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
345 OUT UINTN
*BlockSize
,
346 OUT UINTN
*NumberOfBlocks
350 NOR_FLASH_INSTANCE
*Instance
;
352 Instance
= INSTANCE_FROM_FVB_THIS(This
);
354 DEBUG ((DEBUG_BLKIO
, "FvbGetBlockSize(Lba=%ld, BlockSize=0x%x, LastBlock=%ld)\n", Lba
, Instance
->Media
.BlockSize
, Instance
->Media
.LastBlock
));
356 if (Lba
> Instance
->Media
.LastBlock
) {
357 DEBUG ((EFI_D_ERROR
, "FvbGetBlockSize: ERROR - Parameter LBA %ld is beyond the last Lba (%ld).\n", Lba
, Instance
->Media
.LastBlock
));
358 Status
= EFI_INVALID_PARAMETER
;
360 // This is easy because in this platform each NorFlash device has equal sized blocks.
361 *BlockSize
= (UINTN
) Instance
->Media
.BlockSize
;
362 *NumberOfBlocks
= (UINTN
) (Instance
->Media
.LastBlock
- Lba
+ 1);
364 DEBUG ((DEBUG_BLKIO
, "FvbGetBlockSize: *BlockSize=0x%x, *NumberOfBlocks=0x%x.\n", *BlockSize
, *NumberOfBlocks
));
366 Status
= EFI_SUCCESS
;
373 Reads the specified number of bytes into a buffer from the specified block.
375 The Read() function reads the requested number of bytes from the
376 requested block and stores them in the provided buffer.
377 Implementations should be mindful that the firmware volume
378 might be in the ReadDisabled state. If it is in this state,
379 the Read() function must return the status code
380 EFI_ACCESS_DENIED without modifying the contents of the
381 buffer. The Read() function must also prevent spanning block
382 boundaries. If a read is requested that would span a block
383 boundary, the read must read up to the boundary but not
384 beyond. The output parameter NumBytes must be set to correctly
385 indicate the number of bytes actually read. The caller must be
386 aware that a read may be partially completed.
388 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
390 @param Lba The starting logical block index from which to read.
392 @param Offset Offset into the block at which to begin reading.
394 @param NumBytes Pointer to a UINTN.
395 At entry, *NumBytes contains the total size of the buffer.
396 At exit, *NumBytes contains the total number of bytes read.
398 @param Buffer Pointer to a caller-allocated buffer that will be used
399 to hold the data that is read.
401 @retval EFI_SUCCESS The firmware volume was read successfully, and contents are
404 @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA boundary.
405 On output, NumBytes contains the total number of bytes
408 @retval EFI_ACCESS_DENIED The firmware volume is in the ReadDisabled state.
410 @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be read.
416 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
419 IN OUT UINTN
*NumBytes
,
423 EFI_STATUS TempStatus
;
425 NOR_FLASH_INSTANCE
*Instance
;
427 Instance
= INSTANCE_FROM_FVB_THIS(This
);
429 DEBUG ((DEBUG_BLKIO
, "FvbRead(Parameters: Lba=%ld, Offset=0x%x, *NumBytes=0x%x, Buffer @ 0x%08x)\n", Instance
->StartLba
+ Lba
, Offset
, *NumBytes
, Buffer
));
431 TempStatus
= 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 // Decide if we are doing full block reads or not.
453 if (*NumBytes
% BlockSize
!= 0) {
454 TempStatus
= NorFlashRead (Instance
, Instance
->StartLba
+ Lba
, Offset
, *NumBytes
, Buffer
);
455 if (EFI_ERROR (TempStatus
)) {
456 return EFI_DEVICE_ERROR
;
459 // Read NOR Flash data into shadow buffer
460 TempStatus
= NorFlashReadBlocks (Instance
, Instance
->StartLba
+ Lba
, BlockSize
, Buffer
);
461 if (EFI_ERROR (TempStatus
)) {
462 // Return one of the pre-approved error statuses
463 return EFI_DEVICE_ERROR
;
470 Writes the specified number of bytes from the input buffer to the block.
472 The Write() function writes the specified number of bytes from
473 the provided buffer to the specified block and offset. If the
474 firmware volume is sticky write, the caller must ensure that
475 all the bits of the specified range to write are in the
476 EFI_FVB_ERASE_POLARITY state before calling the Write()
477 function, or else the result will be unpredictable. This
478 unpredictability arises because, for a sticky-write firmware
479 volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY
480 state but cannot flip it back again. Before calling the
481 Write() function, it is recommended for the caller to first call
482 the EraseBlocks() function to erase the specified block to
483 write. A block erase cycle will transition bits from the
484 (NOT)EFI_FVB_ERASE_POLARITY state back to the
485 EFI_FVB_ERASE_POLARITY state. Implementations should be
486 mindful that the firmware volume might be in the WriteDisabled
487 state. If it is in this state, the Write() function must
488 return the status code EFI_ACCESS_DENIED without modifying the
489 contents of the firmware volume. The Write() function must
490 also prevent spanning block boundaries. If a write is
491 requested that spans a block boundary, the write must store up
492 to the boundary but not beyond. The output parameter NumBytes
493 must be set to correctly indicate the number of bytes actually
494 written. The caller must be aware that a write may be
495 partially completed. All writes, partial or otherwise, must be
496 fully flushed to the hardware before the Write() service
499 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
501 @param Lba The starting logical block index to write to.
503 @param Offset Offset into the block at which to begin writing.
505 @param NumBytes The pointer to a UINTN.
506 At entry, *NumBytes contains the total size of the buffer.
507 At exit, *NumBytes contains the total number of bytes actually written.
509 @param Buffer The pointer to a caller-allocated buffer that contains the source for the write.
511 @retval EFI_SUCCESS The firmware volume was written successfully.
513 @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary.
514 On output, NumBytes contains the total number of bytes
517 @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.
519 @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not be written.
526 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
529 IN OUT UINTN
*NumBytes
,
533 NOR_FLASH_INSTANCE
*Instance
;
535 Instance
= INSTANCE_FROM_FVB_THIS (This
);
537 return NorFlashWriteSingleBlock (Instance
, Instance
->StartLba
+ Lba
, Offset
, NumBytes
, Buffer
);
541 Erases and initialises a firmware volume block.
543 The EraseBlocks() function erases one or more blocks as denoted
544 by the variable argument list. The entire parameter list of
545 blocks must be verified before erasing any blocks. If a block is
546 requested that does not exist within the associated firmware
547 volume (it has a larger index than the last block of the
548 firmware volume), the EraseBlocks() function must return the
549 status code EFI_INVALID_PARAMETER without modifying the contents
550 of the firmware volume. Implementations should be mindful that
551 the firmware volume might be in the WriteDisabled state. If it
552 is in this state, the EraseBlocks() function must return the
553 status code EFI_ACCESS_DENIED without modifying the contents of
554 the firmware volume. All calls to EraseBlocks() must be fully
555 flushed to the hardware before the EraseBlocks() service
558 @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
561 @param ... The variable argument list is a list of tuples.
562 Each tuple describes a range of LBAs to erase
563 and consists of the following:
564 - An EFI_LBA that indicates the starting LBA
565 - A UINTN that indicates the number of blocks to erase.
567 The list is terminated with an EFI_LBA_LIST_TERMINATOR.
568 For example, the following indicates that two ranges of blocks
569 (5-7 and 10-11) are to be erased:
570 EraseBlocks (This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);
572 @retval EFI_SUCCESS The erase request successfully completed.
574 @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.
576 @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be written.
577 The firmware device may have been partially erased.
579 @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable argument list do
580 not exist in the firmware volume.
586 IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL
*This
,
592 UINTN BlockAddress
; // Physical address of Lba to erase
593 EFI_LBA StartingLba
; // Lba from which we start erasing
594 UINTN NumOfLba
; // Number of Lba blocks to erase
595 NOR_FLASH_INSTANCE
*Instance
;
597 Instance
= INSTANCE_FROM_FVB_THIS(This
);
599 DEBUG ((DEBUG_BLKIO
, "FvbEraseBlocks()\n"));
601 Status
= EFI_SUCCESS
;
603 // Detect WriteDisabled state
604 if (Instance
->Media
.ReadOnly
== TRUE
) {
605 // Firmware volume is in WriteDisabled state
606 DEBUG ((EFI_D_ERROR
, "FvbEraseBlocks: ERROR - Device is in WriteDisabled state.\n"));
607 return EFI_ACCESS_DENIED
;
610 // Before erasing, check the entire list of parameters to ensure all specified blocks are valid
612 VA_START (Args
, This
);
614 // Get the Lba from which we start erasing
615 StartingLba
= VA_ARG (Args
, EFI_LBA
);
617 // Have we reached the end of the list?
618 if (StartingLba
== EFI_LBA_LIST_TERMINATOR
) {
619 //Exit the while loop
623 // How many Lba blocks are we requested to erase?
624 NumOfLba
= VA_ARG (Args
, UINTN
);
626 // All blocks must be within range
629 "FvbEraseBlocks: Check if: ( StartingLba=%ld + NumOfLba=%Lu - 1 ) > LastBlock=%ld.\n",
630 Instance
->StartLba
+ StartingLba
,
632 Instance
->Media
.LastBlock
634 if ((NumOfLba
== 0) || ((Instance
->StartLba
+ StartingLba
+ NumOfLba
- 1) > Instance
->Media
.LastBlock
)) {
636 DEBUG ((EFI_D_ERROR
, "FvbEraseBlocks: ERROR - Lba range goes past the last Lba.\n"));
637 Status
= EFI_INVALID_PARAMETER
;
644 // To get here, all must be ok, so start erasing
646 VA_START (Args
, This
);
648 // Get the Lba from which we start erasing
649 StartingLba
= VA_ARG (Args
, EFI_LBA
);
651 // Have we reached the end of the list?
652 if (StartingLba
== EFI_LBA_LIST_TERMINATOR
) {
653 // Exit the while loop
657 // How many Lba blocks are we requested to erase?
658 NumOfLba
= VA_ARG (Args
, UINTN
);
660 // Go through each one and erase it
661 while (NumOfLba
> 0) {
663 // Get the physical address of Lba to erase
664 BlockAddress
= GET_NOR_BLOCK_ADDRESS (
665 Instance
->RegionBaseAddress
,
666 Instance
->StartLba
+ StartingLba
,
667 Instance
->Media
.BlockSize
671 DEBUG ((DEBUG_BLKIO
, "FvbEraseBlocks: Erasing Lba=%ld @ 0x%08x.\n", Instance
->StartLba
+ StartingLba
, BlockAddress
));
672 Status
= NorFlashUnlockAndEraseSingleBlock (Instance
, BlockAddress
);
673 if (EFI_ERROR(Status
)) {
675 Status
= EFI_DEVICE_ERROR
;
679 // Move to the next Lba
691 Fixup internal data so that EFI can be call in virtual mode.
692 Call the passed in Child Notify event and convert any pointers in
695 @param[in] Event The Event that is being processed
696 @param[in] Context Event Context
700 FvbVirtualNotifyEvent (
705 EfiConvertPointer (0x0, (VOID
**)&mFlashNvStorageVariableBase
);
711 NorFlashFvbInitialize (
712 IN NOR_FLASH_INSTANCE
* Instance
717 EFI_BOOT_MODE BootMode
;
718 UINTN RuntimeMmioRegionSize
;
720 DEBUG((DEBUG_BLKIO
,"NorFlashFvbInitialize\n"));
721 ASSERT((Instance
!= NULL
));
724 // Declare the Non-Volatile storage as EFI_MEMORY_RUNTIME
727 // Note: all the NOR Flash region needs to be reserved into the UEFI Runtime memory;
728 // even if we only use the small block region at the top of the NOR Flash.
729 // The reason is when the NOR Flash memory is set into program mode, the command
730 // is written as the base of the flash region (ie: Instance->DeviceBaseAddress)
731 RuntimeMmioRegionSize
= (Instance
->RegionBaseAddress
- Instance
->DeviceBaseAddress
) + Instance
->Size
;
733 Status
= gDS
->AddMemorySpace (
734 EfiGcdMemoryTypeMemoryMappedIo
,
735 Instance
->DeviceBaseAddress
, RuntimeMmioRegionSize
,
736 EFI_MEMORY_UC
| EFI_MEMORY_RUNTIME
738 ASSERT_EFI_ERROR (Status
);
740 Status
= gDS
->SetMemorySpaceAttributes (
741 Instance
->DeviceBaseAddress
, RuntimeMmioRegionSize
,
742 EFI_MEMORY_UC
| EFI_MEMORY_RUNTIME
);
743 ASSERT_EFI_ERROR (Status
);
745 mFlashNvStorageVariableBase
= FixedPcdGet32 (PcdFlashNvStorageVariableBase
);
747 // Set the index of the first LBA for the FVB
748 Instance
->StartLba
= (PcdGet32 (PcdFlashNvStorageVariableBase
) - Instance
->RegionBaseAddress
) / Instance
->Media
.BlockSize
;
750 BootMode
= GetBootModeHob ();
751 if (BootMode
== BOOT_WITH_DEFAULT_SETTINGS
) {
752 Status
= EFI_INVALID_PARAMETER
;
754 // Determine if there is a valid header at the beginning of the NorFlash
755 Status
= ValidateFvHeader (Instance
);
758 // Install the Default FVB header if required
759 if (EFI_ERROR(Status
)) {
760 // There is no valid header, so time to install one.
761 DEBUG ((EFI_D_INFO
, "%a: The FVB Header is not valid.\n", __FUNCTION__
));
762 DEBUG ((EFI_D_INFO
, "%a: Installing a correct one for this volume.\n",
765 // Erase all the NorFlash that is reserved for variable storage
766 FvbNumLba
= (PcdGet32(PcdFlashNvStorageVariableSize
) + PcdGet32(PcdFlashNvStorageFtwWorkingSize
) + PcdGet32(PcdFlashNvStorageFtwSpareSize
)) / Instance
->Media
.BlockSize
;
768 Status
= FvbEraseBlocks (&Instance
->FvbProtocol
, (EFI_LBA
)0, FvbNumLba
, EFI_LBA_LIST_TERMINATOR
);
769 if (EFI_ERROR(Status
)) {
773 // Install all appropriate headers
774 Status
= InitializeFvAndVariableStoreHeaders (Instance
);
775 if (EFI_ERROR(Status
)) {
781 // The driver implementing the variable read service can now be dispatched;
782 // the varstore headers are in place.
784 Status
= gBS
->InstallProtocolInterface (
786 &gEdkiiNvVarStoreFormattedGuid
,
787 EFI_NATIVE_INTERFACE
,
790 ASSERT_EFI_ERROR (Status
);
793 // Register for the virtual address change event
795 Status
= gBS
->CreateEventEx (
798 FvbVirtualNotifyEvent
,
800 &gEfiEventVirtualAddressChangeGuid
,
801 &mFvbVirtualAddrChangeEvent
803 ASSERT_EFI_ERROR (Status
);