+++ /dev/null
-/*++ @file NorFlashFvbDxe.c\r
-\r
- Copyright (c) 2011 - 2020, ARM Ltd. All rights reserved.<BR>\r
-\r
- SPDX-License-Identifier: BSD-2-Clause-Patent\r
-\r
- --*/\r
-\r
-#include <PiDxe.h>\r
-\r
-#include <Library/PcdLib.h>\r
-#include <Library/BaseLib.h>\r
-#include <Library/HobLib.h>\r
-#include <Library/UefiLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/MemoryAllocationLib.h>\r
-#include <Library/DxeServicesTableLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-\r
-#include <Guid/VariableFormat.h>\r
-#include <Guid/SystemNvDataGuid.h>\r
-#include <Guid/NvVarStoreFormatted.h>\r
-\r
-#include "NorFlashDxe.h"\r
-\r
-STATIC EFI_EVENT mFvbVirtualAddrChangeEvent;\r
-STATIC UINTN mFlashNvStorageVariableBase;\r
-\r
-///\r
-/// The Firmware Volume Block Protocol is the low-level interface\r
-/// to a firmware volume. File-level access to a firmware volume\r
-/// should not be done using the Firmware Volume Block Protocol.\r
-/// Normal access to a firmware volume must use the Firmware\r
-/// Volume Protocol. Typically, only the file system driver that\r
-/// produces the Firmware Volume Protocol will bind to the\r
-/// Firmware Volume Block Protocol.\r
-///\r
-\r
-/**\r
- Initialises the FV Header and Variable Store Header\r
- to support variable operations.\r
-\r
- @param[in] Ptr - Location to initialise the headers\r
-\r
-**/\r
-EFI_STATUS\r
-InitializeFvAndVariableStoreHeaders (\r
- IN NOR_FLASH_INSTANCE *Instance\r
- )\r
-{\r
- EFI_STATUS Status;\r
- VOID* Headers;\r
- UINTN HeadersLength;\r
- EFI_FIRMWARE_VOLUME_HEADER *FirmwareVolumeHeader;\r
- VARIABLE_STORE_HEADER *VariableStoreHeader;\r
-\r
- HeadersLength = sizeof(EFI_FIRMWARE_VOLUME_HEADER) + sizeof(EFI_FV_BLOCK_MAP_ENTRY) + sizeof(VARIABLE_STORE_HEADER);\r
- Headers = AllocateZeroPool(HeadersLength);\r
-\r
- // FirmwareVolumeHeader->FvLength is declared to have the Variable area AND the FTW working area AND the FTW Spare contiguous.\r
- ASSERT(PcdGet32(PcdFlashNvStorageVariableBase) + PcdGet32(PcdFlashNvStorageVariableSize) == PcdGet32(PcdFlashNvStorageFtwWorkingBase));\r
- ASSERT(PcdGet32(PcdFlashNvStorageFtwWorkingBase) + PcdGet32(PcdFlashNvStorageFtwWorkingSize) == PcdGet32(PcdFlashNvStorageFtwSpareBase));\r
-\r
- // Check if the size of the area is at least one block size\r
- ASSERT((PcdGet32(PcdFlashNvStorageVariableSize) > 0) && (PcdGet32(PcdFlashNvStorageVariableSize) / Instance->Media.BlockSize > 0));\r
- ASSERT((PcdGet32(PcdFlashNvStorageFtwWorkingSize) > 0) && (PcdGet32(PcdFlashNvStorageFtwWorkingSize) / Instance->Media.BlockSize > 0));\r
- ASSERT((PcdGet32(PcdFlashNvStorageFtwSpareSize) > 0) && (PcdGet32(PcdFlashNvStorageFtwSpareSize) / Instance->Media.BlockSize > 0));\r
-\r
- // Ensure the Variable area Base Addresses are aligned on a block size boundaries\r
- ASSERT(PcdGet32(PcdFlashNvStorageVariableBase) % Instance->Media.BlockSize == 0);\r
- ASSERT(PcdGet32(PcdFlashNvStorageFtwWorkingBase) % Instance->Media.BlockSize == 0);\r
- ASSERT(PcdGet32(PcdFlashNvStorageFtwSpareBase) % Instance->Media.BlockSize == 0);\r
-\r
- //\r
- // EFI_FIRMWARE_VOLUME_HEADER\r
- //\r
- FirmwareVolumeHeader = (EFI_FIRMWARE_VOLUME_HEADER*)Headers;\r
- CopyGuid (&FirmwareVolumeHeader->FileSystemGuid, &gEfiSystemNvDataFvGuid);\r
- FirmwareVolumeHeader->FvLength =\r
- PcdGet32(PcdFlashNvStorageVariableSize) +\r
- PcdGet32(PcdFlashNvStorageFtwWorkingSize) +\r
- PcdGet32(PcdFlashNvStorageFtwSpareSize);\r
- FirmwareVolumeHeader->Signature = EFI_FVH_SIGNATURE;\r
- FirmwareVolumeHeader->Attributes = (EFI_FVB_ATTRIBUTES_2) (\r
- EFI_FVB2_READ_ENABLED_CAP | // Reads may be enabled\r
- EFI_FVB2_READ_STATUS | // Reads are currently enabled\r
- EFI_FVB2_STICKY_WRITE | // A block erase is required to flip bits into EFI_FVB2_ERASE_POLARITY\r
- EFI_FVB2_MEMORY_MAPPED | // It is memory mapped\r
- EFI_FVB2_ERASE_POLARITY | // After erasure all bits take this value (i.e. '1')\r
- EFI_FVB2_WRITE_STATUS | // Writes are currently enabled\r
- EFI_FVB2_WRITE_ENABLED_CAP // Writes may be enabled\r
- );\r
- FirmwareVolumeHeader->HeaderLength = sizeof(EFI_FIRMWARE_VOLUME_HEADER) + sizeof(EFI_FV_BLOCK_MAP_ENTRY);\r
- FirmwareVolumeHeader->Revision = EFI_FVH_REVISION;\r
- FirmwareVolumeHeader->BlockMap[0].NumBlocks = Instance->Media.LastBlock + 1;\r
- FirmwareVolumeHeader->BlockMap[0].Length = Instance->Media.BlockSize;\r
- FirmwareVolumeHeader->BlockMap[1].NumBlocks = 0;\r
- FirmwareVolumeHeader->BlockMap[1].Length = 0;\r
- FirmwareVolumeHeader->Checksum = CalculateCheckSum16 ((UINT16*)FirmwareVolumeHeader,FirmwareVolumeHeader->HeaderLength);\r
-\r
- //\r
- // VARIABLE_STORE_HEADER\r
- //\r
- VariableStoreHeader = (VARIABLE_STORE_HEADER*)((UINTN)Headers + FirmwareVolumeHeader->HeaderLength);\r
- CopyGuid (&VariableStoreHeader->Signature, &gEfiAuthenticatedVariableGuid);\r
- VariableStoreHeader->Size = PcdGet32(PcdFlashNvStorageVariableSize) - FirmwareVolumeHeader->HeaderLength;\r
- VariableStoreHeader->Format = VARIABLE_STORE_FORMATTED;\r
- VariableStoreHeader->State = VARIABLE_STORE_HEALTHY;\r
-\r
- // Install the combined super-header in the NorFlash\r
- Status = FvbWrite (&Instance->FvbProtocol, 0, 0, &HeadersLength, Headers);\r
-\r
- FreePool (Headers);\r
- return Status;\r
-}\r
-\r
-/**\r
- Check the integrity of firmware volume header.\r
-\r
- @param[in] FwVolHeader - A pointer to a firmware volume header\r
-\r
- @retval EFI_SUCCESS - The firmware volume is consistent\r
- @retval EFI_NOT_FOUND - The firmware volume has been corrupted.\r
-\r
-**/\r
-EFI_STATUS\r
-ValidateFvHeader (\r
- IN NOR_FLASH_INSTANCE *Instance\r
- )\r
-{\r
- UINT16 Checksum;\r
- EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
- VARIABLE_STORE_HEADER *VariableStoreHeader;\r
- UINTN VariableStoreLength;\r
- UINTN FvLength;\r
-\r
- FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER*)Instance->RegionBaseAddress;\r
-\r
- FvLength = PcdGet32(PcdFlashNvStorageVariableSize) + PcdGet32(PcdFlashNvStorageFtwWorkingSize) +\r
- PcdGet32(PcdFlashNvStorageFtwSpareSize);\r
-\r
- //\r
- // Verify the header revision, header signature, length\r
- // Length of FvBlock cannot be 2**64-1\r
- // HeaderLength cannot be an odd number\r
- //\r
- if ( (FwVolHeader->Revision != EFI_FVH_REVISION)\r
- || (FwVolHeader->Signature != EFI_FVH_SIGNATURE)\r
- || (FwVolHeader->FvLength != FvLength)\r
- )\r
- {\r
- DEBUG ((EFI_D_INFO, "%a: No Firmware Volume header present\n",\r
- __FUNCTION__));\r
- return EFI_NOT_FOUND;\r
- }\r
-\r
- // Check the Firmware Volume Guid\r
- if( CompareGuid (&FwVolHeader->FileSystemGuid, &gEfiSystemNvDataFvGuid) == FALSE ) {\r
- DEBUG ((EFI_D_INFO, "%a: Firmware Volume Guid non-compatible\n",\r
- __FUNCTION__));\r
- return EFI_NOT_FOUND;\r
- }\r
-\r
- // Verify the header checksum\r
- Checksum = CalculateSum16((UINT16*)FwVolHeader, FwVolHeader->HeaderLength);\r
- if (Checksum != 0) {\r
- DEBUG ((EFI_D_INFO, "%a: FV checksum is invalid (Checksum:0x%X)\n",\r
- __FUNCTION__, Checksum));\r
- return EFI_NOT_FOUND;\r
- }\r
-\r
- VariableStoreHeader = (VARIABLE_STORE_HEADER*)((UINTN)FwVolHeader + FwVolHeader->HeaderLength);\r
-\r
- // Check the Variable Store Guid\r
- if (!CompareGuid (&VariableStoreHeader->Signature, &gEfiVariableGuid) &&\r
- !CompareGuid (&VariableStoreHeader->Signature, &gEfiAuthenticatedVariableGuid)) {\r
- DEBUG ((EFI_D_INFO, "%a: Variable Store Guid non-compatible\n",\r
- __FUNCTION__));\r
- return EFI_NOT_FOUND;\r
- }\r
-\r
- VariableStoreLength = PcdGet32 (PcdFlashNvStorageVariableSize) - FwVolHeader->HeaderLength;\r
- if (VariableStoreHeader->Size != VariableStoreLength) {\r
- DEBUG ((EFI_D_INFO, "%a: Variable Store Length does not match\n",\r
- __FUNCTION__));\r
- return EFI_NOT_FOUND;\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- The GetAttributes() function retrieves the attributes and\r
- current settings of the block.\r
-\r
- @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
-\r
- @param Attributes Pointer to EFI_FVB_ATTRIBUTES_2 in which the attributes and\r
- current settings are returned.\r
- Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER.\r
-\r
- @retval EFI_SUCCESS The firmware volume attributes were returned.\r
-\r
- **/\r
-EFI_STATUS\r
-EFIAPI\r
-FvbGetAttributes(\r
- IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
- OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
- )\r
-{\r
- EFI_FVB_ATTRIBUTES_2 FlashFvbAttributes;\r
- NOR_FLASH_INSTANCE *Instance;\r
-\r
- Instance = INSTANCE_FROM_FVB_THIS(This);\r
-\r
- FlashFvbAttributes = (EFI_FVB_ATTRIBUTES_2) (\r
-\r
- EFI_FVB2_READ_ENABLED_CAP | // Reads may be enabled\r
- EFI_FVB2_READ_STATUS | // Reads are currently enabled\r
- EFI_FVB2_STICKY_WRITE | // A block erase is required to flip bits into EFI_FVB2_ERASE_POLARITY\r
- EFI_FVB2_MEMORY_MAPPED | // It is memory mapped\r
- EFI_FVB2_ERASE_POLARITY // After erasure all bits take this value (i.e. '1')\r
-\r
- );\r
-\r
- // Check if it is write protected\r
- if (Instance->Media.ReadOnly != TRUE) {\r
-\r
- FlashFvbAttributes = FlashFvbAttributes |\r
- EFI_FVB2_WRITE_STATUS | // Writes are currently enabled\r
- EFI_FVB2_WRITE_ENABLED_CAP; // Writes may be enabled\r
- }\r
-\r
- *Attributes = FlashFvbAttributes;\r
-\r
- DEBUG ((DEBUG_BLKIO, "FvbGetAttributes(0x%X)\n", *Attributes));\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- The SetAttributes() function sets configurable firmware volume attributes\r
- and returns the new settings of the firmware volume.\r
-\r
-\r
- @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
-\r
- @param Attributes On input, Attributes is a pointer to EFI_FVB_ATTRIBUTES_2\r
- that contains the desired firmware volume settings.\r
- On successful return, it contains the new settings of\r
- the firmware volume.\r
- Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER.\r
-\r
- @retval EFI_SUCCESS The firmware volume attributes were returned.\r
-\r
- @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with the capabilities\r
- as declared in the firmware volume header.\r
-\r
- **/\r
-EFI_STATUS\r
-EFIAPI\r
-FvbSetAttributes(\r
- IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
- IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
- )\r
-{\r
- DEBUG ((DEBUG_BLKIO, "FvbSetAttributes(0x%X) is not supported\n",*Attributes));\r
- return EFI_UNSUPPORTED;\r
-}\r
-\r
-/**\r
- The GetPhysicalAddress() function retrieves the base address of\r
- a memory-mapped firmware volume. This function should be called\r
- only for memory-mapped firmware volumes.\r
-\r
- @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
-\r
- @param Address Pointer to a caller-allocated\r
- EFI_PHYSICAL_ADDRESS that, on successful\r
- return from GetPhysicalAddress(), contains the\r
- base address of the firmware volume.\r
-\r
- @retval EFI_SUCCESS The firmware volume base address was returned.\r
-\r
- @retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.\r
-\r
- **/\r
-EFI_STATUS\r
-EFIAPI\r
-FvbGetPhysicalAddress (\r
- IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
- OUT EFI_PHYSICAL_ADDRESS *Address\r
- )\r
-{\r
- NOR_FLASH_INSTANCE *Instance;\r
-\r
- Instance = INSTANCE_FROM_FVB_THIS(This);\r
-\r
- DEBUG ((DEBUG_BLKIO, "FvbGetPhysicalAddress(BaseAddress=0x%08x)\n", Instance->RegionBaseAddress));\r
-\r
- ASSERT(Address != NULL);\r
-\r
- *Address = mFlashNvStorageVariableBase;\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- The GetBlockSize() function retrieves the size of the requested\r
- block. It also returns the number of additional blocks with\r
- the identical size. The GetBlockSize() function is used to\r
- retrieve the block map (see EFI_FIRMWARE_VOLUME_HEADER).\r
-\r
-\r
- @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
-\r
- @param Lba Indicates the block for which to return the size.\r
-\r
- @param BlockSize Pointer to a caller-allocated UINTN in which\r
- the size of the block is returned.\r
-\r
- @param NumberOfBlocks Pointer to a caller-allocated UINTN in\r
- which the number of consecutive blocks,\r
- starting with Lba, is returned. All\r
- blocks in this range have a size of\r
- BlockSize.\r
-\r
-\r
- @retval EFI_SUCCESS The firmware volume base address was returned.\r
-\r
- @retval EFI_INVALID_PARAMETER The requested LBA is out of range.\r
-\r
- **/\r
-EFI_STATUS\r
-EFIAPI\r
-FvbGetBlockSize (\r
- IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
- IN EFI_LBA Lba,\r
- OUT UINTN *BlockSize,\r
- OUT UINTN *NumberOfBlocks\r
- )\r
-{\r
- EFI_STATUS Status;\r
- NOR_FLASH_INSTANCE *Instance;\r
-\r
- Instance = INSTANCE_FROM_FVB_THIS(This);\r
-\r
- DEBUG ((DEBUG_BLKIO, "FvbGetBlockSize(Lba=%ld, BlockSize=0x%x, LastBlock=%ld)\n", Lba, Instance->Media.BlockSize, Instance->Media.LastBlock));\r
-\r
- if (Lba > Instance->Media.LastBlock) {\r
- DEBUG ((EFI_D_ERROR, "FvbGetBlockSize: ERROR - Parameter LBA %ld is beyond the last Lba (%ld).\n", Lba, Instance->Media.LastBlock));\r
- Status = EFI_INVALID_PARAMETER;\r
- } else {\r
- // This is easy because in this platform each NorFlash device has equal sized blocks.\r
- *BlockSize = (UINTN) Instance->Media.BlockSize;\r
- *NumberOfBlocks = (UINTN) (Instance->Media.LastBlock - Lba + 1);\r
-\r
- DEBUG ((DEBUG_BLKIO, "FvbGetBlockSize: *BlockSize=0x%x, *NumberOfBlocks=0x%x.\n", *BlockSize, *NumberOfBlocks));\r
-\r
- Status = EFI_SUCCESS;\r
- }\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Reads the specified number of bytes into a buffer from the specified block.\r
-\r
- The Read() function reads the requested number of bytes from the\r
- requested block and stores them in the provided buffer.\r
- Implementations should be mindful that the firmware volume\r
- might be in the ReadDisabled state. If it is in this state,\r
- the Read() function must return the status code\r
- EFI_ACCESS_DENIED without modifying the contents of the\r
- buffer. The Read() function must also prevent spanning block\r
- boundaries. If a read is requested that would span a block\r
- boundary, the read must read up to the boundary but not\r
- beyond. The output parameter NumBytes must be set to correctly\r
- indicate the number of bytes actually read. The caller must be\r
- aware that a read may be partially completed.\r
-\r
- @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
-\r
- @param Lba The starting logical block index from which to read.\r
-\r
- @param Offset Offset into the block at which to begin reading.\r
-\r
- @param NumBytes Pointer to a UINTN.\r
- At entry, *NumBytes contains the total size of the buffer.\r
- At exit, *NumBytes contains the total number of bytes read.\r
-\r
- @param Buffer Pointer to a caller-allocated buffer that will be used\r
- to hold the data that is read.\r
-\r
- @retval EFI_SUCCESS The firmware volume was read successfully, and contents are\r
- in Buffer.\r
-\r
- @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA boundary.\r
- On output, NumBytes contains the total number of bytes\r
- returned in Buffer.\r
-\r
- @retval EFI_ACCESS_DENIED The firmware volume is in the ReadDisabled state.\r
-\r
- @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be read.\r
-\r
- **/\r
-EFI_STATUS\r
-EFIAPI\r
-FvbRead (\r
- IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
- IN EFI_LBA Lba,\r
- IN UINTN Offset,\r
- IN OUT UINTN *NumBytes,\r
- IN OUT UINT8 *Buffer\r
- )\r
-{\r
- EFI_STATUS TempStatus;\r
- UINTN BlockSize;\r
- NOR_FLASH_INSTANCE *Instance;\r
-\r
- Instance = INSTANCE_FROM_FVB_THIS(This);\r
-\r
- DEBUG ((DEBUG_BLKIO, "FvbRead(Parameters: Lba=%ld, Offset=0x%x, *NumBytes=0x%x, Buffer @ 0x%08x)\n", Instance->StartLba + Lba, Offset, *NumBytes, Buffer));\r
-\r
- TempStatus = EFI_SUCCESS;\r
-\r
- // Cache the block size to avoid de-referencing pointers all the time\r
- BlockSize = Instance->Media.BlockSize;\r
-\r
- DEBUG ((DEBUG_BLKIO, "FvbRead: Check if (Offset=0x%x + NumBytes=0x%x) <= BlockSize=0x%x\n", Offset, *NumBytes, BlockSize ));\r
-\r
- // The read must not span block boundaries.\r
- // We need to check each variable individually because adding two large values together overflows.\r
- if ((Offset >= BlockSize) ||\r
- (*NumBytes > BlockSize) ||\r
- ((Offset + *NumBytes) > BlockSize)) {\r
- DEBUG ((EFI_D_ERROR, "FvbRead: ERROR - EFI_BAD_BUFFER_SIZE: (Offset=0x%x + NumBytes=0x%x) > BlockSize=0x%x\n", Offset, *NumBytes, BlockSize ));\r
- return EFI_BAD_BUFFER_SIZE;\r
- }\r
-\r
- // We must have some bytes to read\r
- if (*NumBytes == 0) {\r
- return EFI_BAD_BUFFER_SIZE;\r
- }\r
-\r
- // Decide if we are doing full block reads or not.\r
- if (*NumBytes % BlockSize != 0) {\r
- TempStatus = NorFlashRead (Instance, Instance->StartLba + Lba, Offset, *NumBytes, Buffer);\r
- if (EFI_ERROR (TempStatus)) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
- } else {\r
- // Read NOR Flash data into shadow buffer\r
- TempStatus = NorFlashReadBlocks (Instance, Instance->StartLba + Lba, BlockSize, Buffer);\r
- if (EFI_ERROR (TempStatus)) {\r
- // Return one of the pre-approved error statuses\r
- return EFI_DEVICE_ERROR;\r
- }\r
- }\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Writes the specified number of bytes from the input buffer to the block.\r
-\r
- The Write() function writes the specified number of bytes from\r
- the provided buffer to the specified block and offset. If the\r
- firmware volume is sticky write, the caller must ensure that\r
- all the bits of the specified range to write are in the\r
- EFI_FVB_ERASE_POLARITY state before calling the Write()\r
- function, or else the result will be unpredictable. This\r
- unpredictability arises because, for a sticky-write firmware\r
- volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY\r
- state but cannot flip it back again. Before calling the\r
- Write() function, it is recommended for the caller to first call\r
- the EraseBlocks() function to erase the specified block to\r
- write. A block erase cycle will transition bits from the\r
- (NOT)EFI_FVB_ERASE_POLARITY state back to the\r
- EFI_FVB_ERASE_POLARITY state. Implementations should be\r
- mindful that the firmware volume might be in the WriteDisabled\r
- state. If it is in this state, the Write() function must\r
- return the status code EFI_ACCESS_DENIED without modifying the\r
- contents of the firmware volume. The Write() function must\r
- also prevent spanning block boundaries. If a write is\r
- requested that spans a block boundary, the write must store up\r
- to the boundary but not beyond. The output parameter NumBytes\r
- must be set to correctly indicate the number of bytes actually\r
- written. The caller must be aware that a write may be\r
- partially completed. All writes, partial or otherwise, must be\r
- fully flushed to the hardware before the Write() service\r
- returns.\r
-\r
- @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
-\r
- @param Lba The starting logical block index to write to.\r
-\r
- @param Offset Offset into the block at which to begin writing.\r
-\r
- @param NumBytes The pointer to a UINTN.\r
- At entry, *NumBytes contains the total size of the buffer.\r
- At exit, *NumBytes contains the total number of bytes actually written.\r
-\r
- @param Buffer The pointer to a caller-allocated buffer that contains the source for the write.\r
-\r
- @retval EFI_SUCCESS The firmware volume was written successfully.\r
-\r
- @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary.\r
- On output, NumBytes contains the total number of bytes\r
- actually written.\r
-\r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.\r
-\r
- @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not be written.\r
-\r
-\r
- **/\r
-EFI_STATUS\r
-EFIAPI\r
-FvbWrite (\r
- IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
- IN EFI_LBA Lba,\r
- IN UINTN Offset,\r
- IN OUT UINTN *NumBytes,\r
- IN UINT8 *Buffer\r
- )\r
-{\r
- NOR_FLASH_INSTANCE *Instance;\r
-\r
- Instance = INSTANCE_FROM_FVB_THIS (This);\r
-\r
- return NorFlashWriteSingleBlock (Instance, Instance->StartLba + Lba, Offset, NumBytes, Buffer);\r
-}\r
-\r
-/**\r
- Erases and initialises a firmware volume block.\r
-\r
- The EraseBlocks() function erases one or more blocks as denoted\r
- by the variable argument list. The entire parameter list of\r
- blocks must be verified before erasing any blocks. If a block is\r
- requested that does not exist within the associated firmware\r
- volume (it has a larger index than the last block of the\r
- firmware volume), the EraseBlocks() function must return the\r
- status code EFI_INVALID_PARAMETER without modifying the contents\r
- of the firmware volume. Implementations should be mindful that\r
- the firmware volume might be in the WriteDisabled state. If it\r
- is in this state, the EraseBlocks() function must return the\r
- status code EFI_ACCESS_DENIED without modifying the contents of\r
- the firmware volume. All calls to EraseBlocks() must be fully\r
- flushed to the hardware before the EraseBlocks() service\r
- returns.\r
-\r
- @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL\r
- instance.\r
-\r
- @param ... The variable argument list is a list of tuples.\r
- Each tuple describes a range of LBAs to erase\r
- and consists of the following:\r
- - An EFI_LBA that indicates the starting LBA\r
- - A UINTN that indicates the number of blocks to erase.\r
-\r
- The list is terminated with an EFI_LBA_LIST_TERMINATOR.\r
- For example, the following indicates that two ranges of blocks\r
- (5-7 and 10-11) are to be erased:\r
- EraseBlocks (This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);\r
-\r
- @retval EFI_SUCCESS The erase request successfully completed.\r
-\r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.\r
-\r
- @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be written.\r
- The firmware device may have been partially erased.\r
-\r
- @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable argument list do\r
- not exist in the firmware volume.\r
-\r
- **/\r
-EFI_STATUS\r
-EFIAPI\r
-FvbEraseBlocks (\r
- IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
- ...\r
- )\r
-{\r
- EFI_STATUS Status;\r
- VA_LIST Args;\r
- UINTN BlockAddress; // Physical address of Lba to erase\r
- EFI_LBA StartingLba; // Lba from which we start erasing\r
- UINTN NumOfLba; // Number of Lba blocks to erase\r
- NOR_FLASH_INSTANCE *Instance;\r
-\r
- Instance = INSTANCE_FROM_FVB_THIS(This);\r
-\r
- DEBUG ((DEBUG_BLKIO, "FvbEraseBlocks()\n"));\r
-\r
- Status = EFI_SUCCESS;\r
-\r
- // Detect WriteDisabled state\r
- if (Instance->Media.ReadOnly == TRUE) {\r
- // Firmware volume is in WriteDisabled state\r
- DEBUG ((EFI_D_ERROR, "FvbEraseBlocks: ERROR - Device is in WriteDisabled state.\n"));\r
- return EFI_ACCESS_DENIED;\r
- }\r
-\r
- // Before erasing, check the entire list of parameters to ensure all specified blocks are valid\r
-\r
- VA_START (Args, This);\r
- do {\r
- // Get the Lba from which we start erasing\r
- StartingLba = VA_ARG (Args, EFI_LBA);\r
-\r
- // Have we reached the end of the list?\r
- if (StartingLba == EFI_LBA_LIST_TERMINATOR) {\r
- //Exit the while loop\r
- break;\r
- }\r
-\r
- // How many Lba blocks are we requested to erase?\r
- NumOfLba = VA_ARG (Args, UINTN);\r
-\r
- // All blocks must be within range\r
- DEBUG ((\r
- DEBUG_BLKIO,\r
- "FvbEraseBlocks: Check if: ( StartingLba=%ld + NumOfLba=%Lu - 1 ) > LastBlock=%ld.\n",\r
- Instance->StartLba + StartingLba,\r
- (UINT64)NumOfLba,\r
- Instance->Media.LastBlock\r
- ));\r
- if ((NumOfLba == 0) || ((Instance->StartLba + StartingLba + NumOfLba - 1) > Instance->Media.LastBlock)) {\r
- VA_END (Args);\r
- DEBUG ((EFI_D_ERROR, "FvbEraseBlocks: ERROR - Lba range goes past the last Lba.\n"));\r
- Status = EFI_INVALID_PARAMETER;\r
- goto EXIT;\r
- }\r
- } while (TRUE);\r
- VA_END (Args);\r
-\r
- //\r
- // To get here, all must be ok, so start erasing\r
- //\r
- VA_START (Args, This);\r
- do {\r
- // Get the Lba from which we start erasing\r
- StartingLba = VA_ARG (Args, EFI_LBA);\r
-\r
- // Have we reached the end of the list?\r
- if (StartingLba == EFI_LBA_LIST_TERMINATOR) {\r
- // Exit the while loop\r
- break;\r
- }\r
-\r
- // How many Lba blocks are we requested to erase?\r
- NumOfLba = VA_ARG (Args, UINTN);\r
-\r
- // Go through each one and erase it\r
- while (NumOfLba > 0) {\r
-\r
- // Get the physical address of Lba to erase\r
- BlockAddress = GET_NOR_BLOCK_ADDRESS (\r
- Instance->RegionBaseAddress,\r
- Instance->StartLba + StartingLba,\r
- Instance->Media.BlockSize\r
- );\r
-\r
- // Erase it\r
- DEBUG ((DEBUG_BLKIO, "FvbEraseBlocks: Erasing Lba=%ld @ 0x%08x.\n", Instance->StartLba + StartingLba, BlockAddress));\r
- Status = NorFlashUnlockAndEraseSingleBlock (Instance, BlockAddress);\r
- if (EFI_ERROR(Status)) {\r
- VA_END (Args);\r
- Status = EFI_DEVICE_ERROR;\r
- goto EXIT;\r
- }\r
-\r
- // Move to the next Lba\r
- StartingLba++;\r
- NumOfLba--;\r
- }\r
- } while (TRUE);\r
- VA_END (Args);\r
-\r
-EXIT:\r
- return Status;\r
-}\r
-\r
-/**\r
- Fixup internal data so that EFI can be call in virtual mode.\r
- Call the passed in Child Notify event and convert any pointers in\r
- lib to virtual mode.\r
-\r
- @param[in] Event The Event that is being processed\r
- @param[in] Context Event Context\r
-**/\r
-VOID\r
-EFIAPI\r
-FvbVirtualNotifyEvent (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-{\r
- EfiConvertPointer (0x0, (VOID**)&mFlashNvStorageVariableBase);\r
- return;\r
-}\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-NorFlashFvbInitialize (\r
- IN NOR_FLASH_INSTANCE* Instance\r
- )\r
-{\r
- EFI_STATUS Status;\r
- UINT32 FvbNumLba;\r
- EFI_BOOT_MODE BootMode;\r
- UINTN RuntimeMmioRegionSize;\r
-\r
- DEBUG((DEBUG_BLKIO,"NorFlashFvbInitialize\n"));\r
- ASSERT((Instance != NULL));\r
-\r
- //\r
- // Declare the Non-Volatile storage as EFI_MEMORY_RUNTIME\r
- //\r
-\r
- // Note: all the NOR Flash region needs to be reserved into the UEFI Runtime memory;\r
- // even if we only use the small block region at the top of the NOR Flash.\r
- // The reason is when the NOR Flash memory is set into program mode, the command\r
- // is written as the base of the flash region (ie: Instance->DeviceBaseAddress)\r
- RuntimeMmioRegionSize = (Instance->RegionBaseAddress - Instance->DeviceBaseAddress) + Instance->Size;\r
-\r
- Status = gDS->AddMemorySpace (\r
- EfiGcdMemoryTypeMemoryMappedIo,\r
- Instance->DeviceBaseAddress, RuntimeMmioRegionSize,\r
- EFI_MEMORY_UC | EFI_MEMORY_RUNTIME\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- Status = gDS->SetMemorySpaceAttributes (\r
- Instance->DeviceBaseAddress, RuntimeMmioRegionSize,\r
- EFI_MEMORY_UC | EFI_MEMORY_RUNTIME);\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- mFlashNvStorageVariableBase = PcdGet32 (PcdFlashNvStorageVariableBase);\r
-\r
- // Set the index of the first LBA for the FVB\r
- Instance->StartLba = (PcdGet32 (PcdFlashNvStorageVariableBase) - Instance->RegionBaseAddress) / Instance->Media.BlockSize;\r
-\r
- BootMode = GetBootModeHob ();\r
- if (BootMode == BOOT_WITH_DEFAULT_SETTINGS) {\r
- Status = EFI_INVALID_PARAMETER;\r
- } else {\r
- // Determine if there is a valid header at the beginning of the NorFlash\r
- Status = ValidateFvHeader (Instance);\r
- }\r
-\r
- // Install the Default FVB header if required\r
- if (EFI_ERROR(Status)) {\r
- // There is no valid header, so time to install one.\r
- DEBUG ((EFI_D_INFO, "%a: The FVB Header is not valid.\n", __FUNCTION__));\r
- DEBUG ((EFI_D_INFO, "%a: Installing a correct one for this volume.\n",\r
- __FUNCTION__));\r
-\r
- // Erase all the NorFlash that is reserved for variable storage\r
- FvbNumLba = (PcdGet32(PcdFlashNvStorageVariableSize) + PcdGet32(PcdFlashNvStorageFtwWorkingSize) + PcdGet32(PcdFlashNvStorageFtwSpareSize)) / Instance->Media.BlockSize;\r
-\r
- Status = FvbEraseBlocks (&Instance->FvbProtocol, (EFI_LBA)0, FvbNumLba, EFI_LBA_LIST_TERMINATOR);\r
- if (EFI_ERROR(Status)) {\r
- return Status;\r
- }\r
-\r
- // Install all appropriate headers\r
- Status = InitializeFvAndVariableStoreHeaders (Instance);\r
- if (EFI_ERROR(Status)) {\r
- return Status;\r
- }\r
- }\r
-\r
- //\r
- // The driver implementing the variable read service can now be dispatched;\r
- // the varstore headers are in place.\r
- //\r
- Status = gBS->InstallProtocolInterface (\r
- &gImageHandle,\r
- &gEdkiiNvVarStoreFormattedGuid,\r
- EFI_NATIVE_INTERFACE,\r
- NULL\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- //\r
- // Register for the virtual address change event\r
- //\r
- Status = gBS->CreateEventEx (\r
- EVT_NOTIFY_SIGNAL,\r
- TPL_NOTIFY,\r
- FvbVirtualNotifyEvent,\r
- NULL,\r
- &gEfiEventVirtualAddressChangeGuid,\r
- &mFvbVirtualAddrChangeEvent\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- return Status;\r
-}\r
projects / mirror_edk2.git / blobdiff