EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Defines | Functions | Variables

UnixPkg/FvbServicesRuntimeDxe/FWBlockService.c File Reference

#include "PiDxe.h"
#include <Guid/EventGroup.h>
#include <Protocol/FirmwareVolumeBlock.h>
#include <Protocol/DevicePath.h>
#include <Library/UefiLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/BaseLib.h>
#include <Library/DxeServicesTableLib.h>
#include <Library/UefiRuntimeLib.h>
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DevicePathLib.h>
#include "FwBlockService.h"

Go to the source code of this file.

Defines

#define EFI_FVB2_STATUS   (EFI_FVB2_READ_STATUS | EFI_FVB2_WRITE_STATUS | EFI_FVB2_LOCK_STATUS)

Functions

VOID EFIAPI FvbVirtualddressChangeEvent (IN EFI_EVENT Event, IN VOID *Context)
EFI_STATUS GetFvbInstance (IN UINTN Instance, IN ESAL_FWB_GLOBAL *Global, OUT EFI_FW_VOL_INSTANCE **FwhInstance, IN BOOLEAN Virtual)
EFI_STATUS FvbGetPhysicalAddress (IN UINTN Instance, OUT EFI_PHYSICAL_ADDRESS *Address, IN ESAL_FWB_GLOBAL *Global, IN BOOLEAN Virtual)
EFI_STATUS FvbGetVolumeAttributes (IN UINTN Instance, OUT EFI_FVB_ATTRIBUTES_2 *Attributes, IN ESAL_FWB_GLOBAL *Global, IN BOOLEAN Virtual)
EFI_STATUS FvbGetLbaAddress (IN UINTN Instance, IN EFI_LBA Lba, OUT UINTN *LbaAddress, OUT UINTN *LbaLength, OUT UINTN *NumOfBlocks, IN ESAL_FWB_GLOBAL *Global, IN BOOLEAN Virtual)
EFI_STATUS FvbReadBlock (IN UINTN Instance, IN EFI_LBA Lba, IN UINTN BlockOffset, IN OUT UINTN *NumBytes, IN UINT8 *Buffer, IN ESAL_FWB_GLOBAL *Global, IN BOOLEAN Virtual)
EFI_STATUS FvbWriteBlock (IN UINTN Instance, IN EFI_LBA Lba, IN UINTN BlockOffset, IN OUT UINTN *NumBytes, IN UINT8 *Buffer, IN ESAL_FWB_GLOBAL *Global, IN BOOLEAN Virtual)
EFI_STATUS FvbEraseBlock (IN UINTN Instance, IN EFI_LBA Lba, IN ESAL_FWB_GLOBAL *Global, IN BOOLEAN Virtual)
EFI_STATUS FvbSetVolumeAttributes (IN UINTN Instance, IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes, IN ESAL_FWB_GLOBAL *Global, IN BOOLEAN Virtual)
EFI_STATUS EFIAPI FvbProtocolGetPhysicalAddress (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This, OUT EFI_PHYSICAL_ADDRESS *Address)
EFI_STATUS EFIAPI FvbProtocolGetBlockSize (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This, IN EFI_LBA Lba, OUT UINTN *BlockSize, OUT UINTN *NumOfBlocks)
EFI_STATUS EFIAPI FvbProtocolGetAttributes (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This, OUT EFI_FVB_ATTRIBUTES_2 *Attributes)
EFI_STATUS EFIAPI FvbProtocolSetAttributes (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This, IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes)
EFI_STATUS EFIAPI FvbProtocolEraseBlocks (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,...)
EFI_STATUS EFIAPI FvbProtocolWrite (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This, IN EFI_LBA Lba, IN UINTN Offset, IN OUT UINTN *NumBytes, IN UINT8 *Buffer)
EFI_STATUS EFIAPI FvbProtocolRead (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This, IN EFI_LBA Lba, IN UINTN Offset, IN OUT UINTN *NumBytes, IN UINT8 *Buffer)
EFI_STATUS ValidateFvHeader (EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader)
EFI_STATUS EFIAPI FvbInitialize (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables

ESAL_FWB_GLOBALmFvbModuleGlobal
EFI_FW_VOL_BLOCK_DEVICE mFvbDeviceTemplate

Define Documentation

#define EFI_FVB2_STATUS   (EFI_FVB2_READ_STATUS | EFI_FVB2_WRITE_STATUS | EFI_FVB2_LOCK_STATUS)

Definition at line 43 of file FWBlockService.c.


Function Documentation

EFI_STATUS FvbEraseBlock ( IN UINTN  Instance,
IN EFI_LBA  Lba,
IN ESAL_FWB_GLOBAL Global,
IN BOOLEAN  Virtual 
)

Definition at line 533 of file FWBlockService.c.

EFI_STATUS FvbGetLbaAddress ( IN UINTN  Instance,
IN EFI_LBA  Lba,
OUT UINTN LbaAddress,
OUT UINTN LbaLength,
OUT UINTN NumOfBlocks,
IN ESAL_FWB_GLOBAL Global,
IN BOOLEAN  Virtual 
)

Definition at line 267 of file FWBlockService.c.

EFI_STATUS FvbGetPhysicalAddress ( IN UINTN  Instance,
OUT EFI_PHYSICAL_ADDRESS Address,
IN ESAL_FWB_GLOBAL Global,
IN BOOLEAN  Virtual 
)

Definition at line 186 of file FWBlockService.c.

EFI_STATUS FvbGetVolumeAttributes ( IN UINTN  Instance,
OUT EFI_FVB_ATTRIBUTES_2 Attributes,
IN ESAL_FWB_GLOBAL Global,
IN BOOLEAN  Virtual 
)

Definition at line 227 of file FWBlockService.c.

EFI_STATUS EFIAPI FvbInitialize ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Main entry point.

Parameters:
[in]ImageHandleThe firmware allocated handle for the EFI image.
[in]SystemTableA pointer to the EFI System Table.
Return values:
EFI_SUCCESSSuccessfully initialized.

Definition at line 1111 of file FWBlockService.c.

EFI_STATUS EFIAPI FvbProtocolEraseBlocks ( IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This,
  ... 
)

Erases and initializes a firmware volume block.

The EraseBlocks() function erases one or more blocks as denoted by the variable argument list. The entire parameter list of blocks must be verified before erasing any blocks. If a block is requested that does not exist within the associated firmware volume (it has a larger index than the last block of the firmware volume), the EraseBlocks() function must return the status code EFI_INVALID_PARAMETER without modifying the contents of the firmware volume. Implementations should be mindful that the firmware volume might be in the WriteDisabled state. If it is in this state, the EraseBlocks() function must return the status code EFI_ACCESS_DENIED without modifying the contents of the firmware volume. All calls to EraseBlocks() must be fully flushed to the hardware before the EraseBlocks() service returns.

Parameters:
ThisIndicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
...The variable argument list is a list of tuples. Each tuple describes a range of LBAs to erase and consists of the following:

  • An EFI_LBA that indicates the starting LBA
  • A UINTN that indicates the number of blocks to erase

The list is terminated with an EFI_LBA_LIST_TERMINATOR. For example, the following indicates that two ranges of blocks (5-7 and 10-11) are to be erased: EraseBlocks (This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);

Return values:
EFI_SUCCESSThe erase request was successfully completed.
EFI_ACCESS_DENIEDThe firmware volume is in the WriteDisabled state.
EFI_DEVICE_ERRORThe block device is not functioning correctly and could not be written. The firmware device may have been partially erased.
EFI_INVALID_PARAMETEROne or more of the LBAs listed in the variable argument list do not exist in the firmware volume.

Definition at line 864 of file FWBlockService.c.

EFI_STATUS EFIAPI FvbProtocolGetAttributes ( IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This,
OUT EFI_FVB_ATTRIBUTES_2 Attributes 
)

The GetAttributes() function retrieves the attributes and current settings of the block. Status Codes Returned

Parameters:
ThisIndicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
AttributesPointer to EFI_FVB_ATTRIBUTES_2 in which the attributes and current settings are returned. Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER.
Return values:
EFI_SUCCESSThe firmware volume attributes were returned.

Definition at line 810 of file FWBlockService.c.

EFI_STATUS EFIAPI FvbProtocolGetBlockSize ( IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This,
IN EFI_LBA  Lba,
OUT UINTN BlockSize,
OUT UINTN NumOfBlocks 
)

The GetBlockSize() function retrieves the size of the requested block. It also returns the number of additional blocks with the identical size. The GetBlockSize() function is used to retrieve the block map (see EFI_FIRMWARE_VOLUME_HEADER).

Parameters:
ThisIndicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
LbaIndicates the block for which to return the size.
BlockSizePointer to a caller-allocated UINTN in which the size of the block is returned.
NumberOfBlocksPointer to a caller-allocated UINTN in which the number of consecutive blocks, starting with Lba, is returned. All blocks in this range have a size of BlockSize.
Return values:
EFI_SUCCESSThe firmware volume base address is returned.
EFI_INVALID_PARAMETERThe requested LBA is out of range.

Definition at line 766 of file FWBlockService.c.

EFI_STATUS EFIAPI FvbProtocolGetPhysicalAddress ( IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This,
OUT EFI_PHYSICAL_ADDRESS Address 
)

The GetPhysicalAddress() function retrieves the base address of a memory-mapped firmware volume. This function should be called only for memory-mapped firmware volumes.

Parameters:
ThisIndicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
AddressPointer to a caller-allocated EFI_PHYSICAL_ADDRESS that, on successful return from GetPhysicalAddress(), contains the base address of the firmware volume.
Return values:
EFI_SUCCESSThe firmware volume base address is returned.
EFI_NOT_SUPPORTEDThe firmware volume is not memory mapped.

Definition at line 735 of file FWBlockService.c.

EFI_STATUS EFIAPI FvbProtocolRead ( IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This,
IN EFI_LBA  Lba,
IN UINTN  Offset,
IN OUT UINTN NumBytes,
IN UINT8 Buffer 
)

Definition at line 1010 of file FWBlockService.c.

EFI_STATUS EFIAPI FvbProtocolSetAttributes ( IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This,
IN OUT EFI_FVB_ATTRIBUTES_2 Attributes 
)

The SetAttributes() function sets configurable firmware volume attributes and returns the new settings of the firmware volume.

Parameters:
ThisIndicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
AttributesOn input, Attributes is a pointer to EFI_FVB_ATTRIBUTES_2 that contains the desired firmware volume settings. On successful return, it contains the new settings of the firmware volume. Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER.
Return values:
EFI_SUCCESSThe firmware volume attributes were returned.
EFI_INVALID_PARAMETERThe attributes requested are in conflict with the capabilities as declared in the firmware volume header.

Definition at line 837 of file FWBlockService.c.

EFI_STATUS EFIAPI FvbProtocolWrite ( IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This,
IN EFI_LBA  Lba,
IN UINTN  Offset,
IN OUT UINTN NumBytes,
IN UINT8 Buffer 
)

Writes the specified number of bytes from the input buffer to the block.

The Write() function writes the specified number of bytes from the provided buffer to the specified block and offset. If the firmware volume is sticky write, the caller must ensure that all the bits of the specified range to write are in the EFI_FVB_ERASE_POLARITY state before calling the Write() function, or else the result will be unpredictable. This unpredictability arises because, for a sticky-write firmware volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY state but cannot flip it back again. In general, before calling the Write() function, the caller should call the EraseBlocks() function first to erase the specified block to write. A block erase cycle will transition bits from the (NOT)EFI_FVB_ERASE_POLARITY state back to the EFI_FVB_ERASE_POLARITY state. Implementations should be mindful that the firmware volume might be in the WriteDisabled state. If it is in this state, the Write() function must return the status code EFI_ACCESS_DENIED without modifying the contents of the firmware volume. The Write() function must also prevent spanning block boundaries. If a write is requested that spans a block boundary, the write must store up to the boundary but not beyond. The output parameter NumBytes must be set to correctly indicate the number of bytes actually written. The caller must be aware that a write may be partially completed. All writes, partial or otherwise, must be fully flushed to the hardware before the Write() service returns.

Parameters:
ThisIndicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.
LbaThe starting logical block index to write to.
OffsetOffset into the block at which to begin writing.
NumBytesPointer to a UINTN. At entry, *NumBytes contains the total size of the buffer. At exit, *NumBytes contains the total number of bytes actually written.
BufferPointer to a caller-allocated buffer that contains the source for the write.
Return values:
EFI_SUCCESSThe firmware volume was written successfully.
EFI_BAD_BUFFER_SIZEThe write was attempted across an LBA boundary. On output, NumBytes contains the total number of bytes actually written.
EFI_ACCESS_DENIEDThe firmware volume is in the WriteDisabled state.
EFI_DEVICE_ERRORThe block device is malfunctioning and could not be written.

Definition at line 962 of file FWBlockService.c.

EFI_STATUS FvbReadBlock ( IN UINTN  Instance,
IN EFI_LBA  Lba,
IN UINTN  BlockOffset,
IN OUT UINTN NumBytes,
IN UINT8 Buffer,
IN ESAL_FWB_GLOBAL Global,
IN BOOLEAN  Virtual 
)

Definition at line 360 of file FWBlockService.c.

EFI_STATUS FvbSetVolumeAttributes ( IN UINTN  Instance,
IN OUT EFI_FVB_ATTRIBUTES_2 Attributes,
IN ESAL_FWB_GLOBAL Global,
IN BOOLEAN  Virtual 
)

Definition at line 597 of file FWBlockService.c.

VOID EFIAPI FvbVirtualddressChangeEvent ( IN EFI_EVENT  Event,
IN VOID *  Context 
)

Definition at line 87 of file FWBlockService.c.

EFI_STATUS FvbWriteBlock ( IN UINTN  Instance,
IN EFI_LBA  Lba,
IN UINTN  BlockOffset,
IN OUT UINTN NumBytes,
IN UINT8 Buffer,
IN ESAL_FWB_GLOBAL Global,
IN BOOLEAN  Virtual 
)

Definition at line 446 of file FWBlockService.c.

EFI_STATUS GetFvbInstance ( IN UINTN  Instance,
IN ESAL_FWB_GLOBAL Global,
OUT EFI_FW_VOL_INSTANCE **  FwhInstance,
IN BOOLEAN  Virtual 
)

Definition at line 137 of file FWBlockService.c.

EFI_STATUS ValidateFvHeader ( EFI_FIRMWARE_VOLUME_HEADER FwVolHeader)

Definition at line 1057 of file FWBlockService.c.


Variable Documentation

Definition at line 45 of file FWBlockService.c.

Definition at line 41 of file FWBlockService.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines