[mirror_edk2.git] / OvmfPkg / EmuVariableFvbRuntimeDxe / Fvb.c

/** @file\r
  Firmware Block Services to support emulating non-volatile variables\r
  by pretending that a memory buffer is storage for the NV variables.\r
\r
  Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "PiDxe.h"\r
#include <Guid/EventGroup.h>\r
#include <Guid/SystemNvDataGuid.h>\r
#include <Guid/VariableFormat.h>\r
\r
#include <Protocol/FirmwareVolumeBlock.h>\r
#include <Protocol/DevicePath.h>\r
\r
#include <Library/UefiLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/PlatformFvbLib.h>\r
#include "Fvb.h"\r
\r
//\r
// Virtual Address Change Event\r
//\r
// This is needed for runtime variable access.\r
//\r
EFI_EVENT   mEmuVarsFvbAddrChangeEvent = NULL;\r
\r
//\r
// This is the single instance supported by this driver.  It\r
// supports the FVB and Device Path protocols.\r
//\r
EFI_FW_VOL_BLOCK_DEVICE mEmuVarsFvb = {\r
  FVB_DEVICE_SIGNATURE,\r
  {     // DevicePath\r
    {\r
      {\r
        HARDWARE_DEVICE_PATH,\r
        HW_MEMMAP_DP,\r
        {\r
          sizeof (MEMMAP_DEVICE_PATH),\r
          0\r
        }\r
      },\r
      EfiMemoryMappedIO,\r
      0,\r
      0,\r
    },\r
    {\r
      END_DEVICE_PATH_TYPE,\r
      END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
      {\r
        sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
        0\r
      }\r
    }\r
  },\r
  NULL, // BufferPtr\r
  FixedPcdGet32 (PcdFlashNvStorageFtwSpareSize), // BlockSize\r
  2 * FixedPcdGet32 (PcdFlashNvStorageFtwSpareSize), // Size\r
  {     // FwVolBlockInstance\r
    FvbProtocolGetAttributes,\r
    FvbProtocolSetAttributes,\r
    FvbProtocolGetPhysicalAddress,\r
    FvbProtocolGetBlockSize,\r
    FvbProtocolRead,\r
    FvbProtocolWrite,\r
    FvbProtocolEraseBlocks,\r
    NULL\r
  },\r
};\r
\r
\r
/**\r
  Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.\r
\r
  This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r
  It converts pointer to new virtual address.\r
\r
  @param  Event        Event whose notification function is being invoked.\r
  @param  Context      Pointer to the notification function's context.\r
\r
**/\r
VOID\r
EFIAPI\r
FvbVirtualAddressChangeEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  EfiConvertPointer (0x0, &mEmuVarsFvb.BufferPtr);\r
}\r
\r
\r
//\r
// FVB protocol APIs\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 is returned.\r
  \r
  @retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolGetPhysicalAddress (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
  OUT       EFI_PHYSICAL_ADDRESS                *Address\r
  )\r
{\r
  EFI_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
\r
  FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
\r
  *Address = (EFI_PHYSICAL_ADDRESS)(UINTN) FvbDevice->BufferPtr;\r
\r
  return EFI_SUCCESS;\r
}\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 is returned.\r
  \r
  @retval EFI_INVALID_PARAMETER   The requested LBA is out of range.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolGetBlockSize (\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_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
\r
  if (Lba > 1) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
\r
  *BlockSize = FvbDevice->BlockSize;\r
  *NumberOfBlocks = (UINTN) (2 - (UINTN) Lba);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  The GetAttributes() function retrieves the attributes and\r
  current settings of the block. Status Codes Returned\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\r
                    attributes and current settings are\r
                    returned. Type EFI_FVB_ATTRIBUTES_2 is defined\r
                    in EFI_FIRMWARE_VOLUME_HEADER.\r
\r
  @retval EFI_SUCCESS The firmware volume attributes were\r
                      returned.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolGetAttributes (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
  OUT       EFI_FVB_ATTRIBUTES_2                *Attributes\r
  )\r
{\r
  *Attributes =\r
    (EFI_FVB_ATTRIBUTES_2) (\r
      EFI_FVB2_READ_ENABLED_CAP |\r
      EFI_FVB2_READ_STATUS |\r
      EFI_FVB2_WRITE_ENABLED_CAP |\r
      EFI_FVB2_WRITE_STATUS |\r
      EFI_FVB2_ERASE_POLARITY\r
      );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  The SetAttributes() function sets configurable firmware volume\r
  attributes and returns the new settings of the firmware volume.\r
\r
  @param This         Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
\r
  @param Attributes   On input, Attributes is a pointer to\r
                      EFI_FVB_ATTRIBUTES_2 that contains the\r
                      desired firmware volume settings. On\r
                      successful return, it contains the new\r
                      settings of the firmware volume. Type\r
                      EFI_FVB_ATTRIBUTES_2 is defined in\r
                      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\r
                                conflict with the capabilities\r
                                as declared in the firmware\r
                                volume header.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolSetAttributes (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
  IN OUT    EFI_FVB_ATTRIBUTES_2                *Attributes\r
  )\r
{\r
  return EFI_ACCESS_DENIED;\r
}\r
\r
\r
/**\r
  Erases and initializes 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\r
                  erase\r
\r
                The list is terminated with an\r
                EFI_LBA_LIST_TERMINATOR. For example, the\r
                following indicates that two ranges of blocks\r
                (5-7 and 10-11) are to be erased: EraseBlocks\r
                (This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);\r
\r
  @retval EFI_SUCCESS The erase request was successfully\r
                      completed.\r
  \r
  @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
                              WriteDisabled state.\r
  @retval EFI_DEVICE_ERROR  The block device is not functioning\r
                            correctly and could not be written.\r
                            The firmware device may have been\r
                            partially erased.\r
  @retval EFI_INVALID_PARAMETER One or more of the LBAs listed\r
                                in the variable argument list do\r
                                not exist in the firmware volume.  \r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolEraseBlocks (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
  ...\r
  )\r
{\r
  EFI_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
  VA_LIST                 args;\r
  EFI_LBA                 StartingLba;\r
  UINTN                   NumOfLba;\r
  UINT8                   Erase;\r
  VOID                    *ErasePtr;\r
  UINTN                   EraseSize;\r
\r
  FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
  Erase = 0;\r
\r
  VA_START (args, This);\r
\r
  do {\r
    StartingLba = VA_ARG (args, EFI_LBA);\r
    if (StartingLba == EFI_LBA_LIST_TERMINATOR) {\r
      break;\r
    }\r
\r
    NumOfLba = VA_ARG (args, UINT32);\r
\r
    //\r
    // Check input parameters\r
    //\r
    if ((NumOfLba == 0) || (StartingLba > 1) || ((StartingLba + NumOfLba) > 2)) {\r
      VA_END (args);\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (StartingLba == 0) {\r
      Erase = (UINT8) (Erase | BIT0);\r
    }\r
    if ((StartingLba + NumOfLba) == 2) {\r
      Erase = (UINT8) (Erase | BIT1);\r
    }\r
\r
  } while (1);\r
\r
  VA_END (args);\r
\r
  ErasePtr = (UINT8*) FvbDevice->BufferPtr;\r
  EraseSize = 0;\r
\r
  if ((Erase & BIT0) != 0) {\r
    EraseSize = EraseSize + FvbDevice->BlockSize;\r
  } else {\r
    ErasePtr = (VOID*) ((UINT8*)ErasePtr + FvbDevice->BlockSize);\r
  }\r
\r
  if ((Erase & BIT1) != 0) {\r
    EraseSize = EraseSize + FvbDevice->BlockSize;\r
  }\r
\r
  if (EraseSize != 0) {\r
    SetMem (\r
      (VOID*) ErasePtr,\r
      EraseSize,\r
      ERASED_UINT8\r
      );\r
    VA_START (args, This);\r
    PlatformFvbBlocksErased (This, args);\r
    VA_END (args);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\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. In general, before\r
  calling the Write() function, the caller should call the\r
  EraseBlocks() function first 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 Pointer to a UINTN. At entry, *NumBytes\r
                  contains the total size of the buffer. At\r
                  exit, *NumBytes contains the total number of\r
                  bytes actually written.\r
  \r
  @param Buffer   Pointer to a caller-allocated buffer that\r
                  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\r
                              LBA boundary. On output, NumBytes\r
                              contains the total number of bytes\r
                              actually written.\r
  \r
  @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
                              WriteDisabled state.\r
  \r
  @retval EFI_DEVICE_ERROR    The block device is malfunctioning\r
                              and could not be written.\r
\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolWrite (\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
\r
  EFI_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
  UINT8                   *FvbDataPtr;\r
\r
  FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
\r
  if ((Lba > 1) || (Offset > FvbDevice->BlockSize)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((Offset + *NumBytes) > FvbDevice->BlockSize) {\r
    *NumBytes = FvbDevice->BlockSize - Offset;\r
  }\r
\r
  FvbDataPtr =\r
    (UINT8*) FvbDevice->BufferPtr +\r
    MultU64x32 (Lba, (UINT32) FvbDevice->BlockSize) +\r
    Offset;\r
\r
  if (*NumBytes > 0) {\r
    CopyMem (FvbDataPtr, Buffer, *NumBytes);\r
    PlatformFvbDataWritten (This, Lba, Offset, *NumBytes, Buffer);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\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\r
                  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. At entry, *NumBytes\r
                  contains the total size of the buffer. At\r
                  exit, *NumBytes contains the total number of\r
                  bytes read.\r
\r
  @param Buffer   Pointer to a caller-allocated buffer that will\r
                  be used to hold the data that is read.\r
\r
  @retval EFI_SUCCESS         The firmware volume was read successfully\r
                              and contents are in Buffer.\r
  \r
  @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA\r
                              boundary. On output, NumBytes\r
                              contains the total number of bytes\r
                              returned in Buffer.\r
  \r
  @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
                              ReadDisabled state.\r
  \r
  @retval EFI_DEVICE_ERROR    The block device is not\r
                              functioning correctly and could\r
                              not be read.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolRead (\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_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
  UINT8                   *FvbDataPtr;\r
\r
  FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
\r
  if ((Lba > 1) || (Offset > FvbDevice->BlockSize)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((Offset + *NumBytes) > FvbDevice->BlockSize) {\r
    *NumBytes = FvbDevice->BlockSize - Offset;\r
  }\r
\r
  FvbDataPtr =\r
    (UINT8*) FvbDevice->BufferPtr +\r
    MultU64x32 (Lba, (UINT32) FvbDevice->BlockSize) +\r
    Offset;\r
\r
  if (*NumBytes > 0) {\r
    CopyMem (Buffer, FvbDataPtr, *NumBytes);\r
    PlatformFvbDataRead (This, Lba, Offset, *NumBytes, Buffer);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\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 EFI_FIRMWARE_VOLUME_HEADER   *FwVolHeader\r
  )\r
{\r
  UINT16  Checksum;\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 != EMU_FVB_SIZE) ||\r
      (FwVolHeader->HeaderLength != EMU_FV_HEADER_LENGTH)\r
      ) {\r
    DEBUG ((EFI_D_INFO, "EMU Variable FVB: Basic FV headers were invalid\n"));\r
    return EFI_NOT_FOUND;\r
  }\r
  //\r
  // Verify the header checksum\r
  //\r
  Checksum = CalculateSum16((VOID*) FwVolHeader, FwVolHeader->HeaderLength);\r
\r
  if (Checksum != 0) {\r
    DEBUG ((EFI_D_INFO, "EMU Variable FVB: FV checksum was invalid\n"));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Initializes the FV Header and Variable Store Header\r
  to support variable operations.\r
\r
  @param[in]  Ptr - Location to initialize the headers\r
\r
**/\r
VOID\r
InitializeFvAndVariableStoreHeaders (\r
  IN  VOID   *Ptr\r
  )\r
{\r
  STATIC FVB_FV_HDR_AND_VARS_TEMPLATE FvAndVarTemplate = {\r
    { // EFI_FIRMWARE_VOLUME_HEADER FvHdr;\r
      // UINT8                     ZeroVector[16];\r
      { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },\r
\r
      // EFI_GUID                  FileSystemGuid;\r
      EFI_SYSTEM_NV_DATA_FV_GUID,\r
\r
      // UINT64                    FvLength;\r
      EMU_FVB_SIZE,\r
\r
      // UINT32                    Signature;\r
      EFI_FVH_SIGNATURE,\r
\r
      // EFI_FVB_ATTRIBUTES_2      Attributes;\r
      0x4feff,\r
\r
      // UINT16                    HeaderLength;\r
      EMU_FV_HEADER_LENGTH,\r
\r
      // UINT16                    Checksum;\r
      0,\r
\r
      // UINT16                    ExtHeaderOffset;\r
      0,\r
\r
      // UINT8                     Reserved[1];\r
      0,\r
\r
      // UINT8                     Revision;\r
      EFI_FVH_REVISION,\r
\r
      // EFI_FV_BLOCK_MAP_ENTRY    BlockMap[1];\r
      { 2, // UINT32 NumBlocks;\r
        EMU_FVB_BLOCK_SIZE  // UINT32 Length;\r
      }\r
    },\r
    // EFI_FV_BLOCK_MAP_ENTRY     EndBlockMap;\r
    { 0, 0 }, // End of block map\r
    { // VARIABLE_STORE_HEADER      VarHdr;\r
      // EFI_GUID  Signature;\r
      EFI_VARIABLE_GUID,\r
\r
      // UINT32  Size;\r
      (\r
        FixedPcdGet32 (PcdVariableStoreSize) -\r
        OFFSET_OF (FVB_FV_HDR_AND_VARS_TEMPLATE, VarHdr)\r
      ),\r
\r
      // UINT8   Format;\r
      VARIABLE_STORE_FORMATTED,\r
\r
      // UINT8   State;\r
      VARIABLE_STORE_HEALTHY,\r
\r
      // UINT16  Reserved;\r
      0,\r
\r
      // UINT32  Reserved1;\r
      0\r
    }\r
  };\r
  EFI_FIRMWARE_VOLUME_HEADER  *Fv;\r
\r
  //\r
  // Copy the template structure into the location\r
  //\r
  CopyMem (Ptr, (VOID*)&FvAndVarTemplate, sizeof (FvAndVarTemplate));\r
\r
  //\r
  // Update the checksum for the FV header\r
  //\r
  Fv = (EFI_FIRMWARE_VOLUME_HEADER*) Ptr;\r
  Fv->Checksum = CalculateCheckSum16 (Ptr, Fv->HeaderLength);\r
}\r
\r
\r
/**\r
  Initializes the Fault Tolerant Write data structure\r
\r
  This data structure is used by the Fault Tolerant Write driver.\r
\r
  @param[in]  Buffer - Location for the FTW data structure\r
\r
**/\r
VOID\r
InitializeFtwState (\r
  IN  VOID   *Buffer\r
  )\r
{\r
  EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *Hdr;\r
  UINT32                                  TempCrc;\r
  STATIC EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER DefaultFtw = {\r
    EFI_SYSTEM_NV_DATA_FV_GUID, // EFI_GUID  Signature;\r
    ERASED_UINT32,              // UINT32    Crc;\r
    ERASED_BIT,                 // UINT8     WorkingBlockValid : 1;\r
    ERASED_BIT,                 // UINT8     WorkingBlockInvalid : 1;\r
    0,                          // UINT8     Reserved : 6;\r
    { 0, 0, 0 },                // UINT8     Reserved3[3];\r
    FTW_WRITE_QUEUE_SIZE        // UINT64    WriteQueueSize;\r
  };\r
\r
  CopyMem (Buffer, (VOID*) &DefaultFtw, sizeof (DefaultFtw));\r
\r
  Hdr = (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER*) Buffer;\r
\r
  //\r
  // Calculate checksum.\r
  //\r
  // The Crc, WorkingBlockValid and WorkingBlockInvalid bits should\r
  // be set to the erased state before computing the checksum.\r
  //\r
  gBS->CalculateCrc32 (Buffer, sizeof (DefaultFtw), &TempCrc);\r
  Hdr->Crc = TempCrc;\r
\r
  //\r
  // Mark as valid.\r
  //\r
  Hdr->WorkingBlockValid = NOT_ERASED_BIT;\r
}\r
\r
\r
/**\r
  Main entry point.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.  \r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
  \r
  @retval EFI_SUCCESS       Successfully initialized.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FvbInitialize (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  VOID                                *Ptr;\r
  VOID                                *SubPtr;\r
  BOOLEAN                             Initialize;\r
  EFI_HANDLE                          Handle;\r
  EFI_PHYSICAL_ADDRESS                Address;\r
\r
  DEBUG ((EFI_D_INFO, "EMU Variable FVB Started\n"));\r
\r
  //\r
  // Verify that the PCD's are set correctly.\r
  //\r
  if (\r
       (PcdGet32 (PcdVariableStoreSize) +\r
        PcdGet32 (PcdFlashNvStorageFtwWorkingSize)\r
       ) >\r
       EMU_FVB_BLOCK_SIZE\r
     ) {\r
    DEBUG ((EFI_D_ERROR, "EMU Variable invalid PCD sizes\n"));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // By default we will initialize the FV contents.  But, if\r
  // PcdEmuVariableNvStoreReserved is non-zero, then we will\r
  // use this location for our buffer.\r
  //\r
  // If this location does not have a proper FV header, then\r
  // we will initialize it.\r
  //\r
  Initialize = TRUE;\r
  if (PcdGet64 (PcdEmuVariableNvStoreReserved) != 0) {\r
    Ptr = (VOID*)(UINTN) PcdGet64 (PcdEmuVariableNvStoreReserved);\r
    DEBUG ((\r
      EFI_D_INFO,\r
      "EMU Variable FVB: Using pre-reserved block at %p\n",\r
      Ptr\r
      ));\r
    Status = ValidateFvHeader (Ptr);\r
    if (!EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_INFO, "EMU Variable FVB: Found valid pre-existing FV\n"));\r
      Initialize = FALSE;\r
    }\r
  } else {\r
    Ptr = AllocateAlignedRuntimePages (\r
            EFI_SIZE_TO_PAGES (EMU_FVB_SIZE),\r
            SIZE_64KB\r
            );\r
  }\r
\r
  mEmuVarsFvb.BufferPtr = Ptr;\r
\r
  //\r
  // Initialize the main FV header and variable store header\r
  //\r
  if (Initialize) {\r
    SetMem (Ptr, EMU_FVB_SIZE, ERASED_UINT8);\r
    InitializeFvAndVariableStoreHeaders (Ptr);\r
  }\r
  PcdSet64 (PcdFlashNvStorageVariableBase64, (UINT32)(UINTN) Ptr);\r
\r
  //\r
  // Initialize the Fault Tolerant Write data area\r
  //\r
  SubPtr = (VOID*) ((UINT8*) Ptr + PcdGet32 (PcdVariableStoreSize));\r
  if (Initialize) {\r
    InitializeFtwState (SubPtr);\r
  }\r
  PcdSet32 (PcdFlashNvStorageFtwWorkingBase, (UINT32)(UINTN) SubPtr);\r
\r
  //\r
  // Initialize the Fault Tolerant Write spare block\r
  //\r
  SubPtr = (VOID*) ((UINT8*) Ptr + EMU_FVB_BLOCK_SIZE);\r
  PcdSet32 (PcdFlashNvStorageFtwSpareBase, (UINT32)(UINTN) SubPtr);\r
\r
  //\r
  // Setup FVB device path\r
  //\r
  Address = (EFI_PHYSICAL_ADDRESS)(UINTN) Ptr;\r
  mEmuVarsFvb.DevicePath.MemMapDevPath.StartingAddress = Address;\r
  mEmuVarsFvb.DevicePath.MemMapDevPath.EndingAddress = Address + EMU_FVB_SIZE - 1;\r
\r
  //\r
  // Install the protocols\r
  //\r
  DEBUG ((EFI_D_INFO, "Installing FVB for EMU Variable support\n"));\r
  Handle = 0;\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Handle,\r
                  &gEfiFirmwareVolumeBlock2ProtocolGuid,\r
                  &mEmuVarsFvb.FwVolBlockInstance,\r
                  &gEfiDevicePathProtocolGuid,\r
                  &mEmuVarsFvb.DevicePath,\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
                  FvbVirtualAddressChangeEvent,\r
                  NULL,\r
                  &gEfiEventVirtualAddressChangeGuid,\r
                  &mEmuVarsFvbAddrChangeEvent\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r