BaseTools: Library hashing fix and optimization for --hash feature

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

/*++\r
\r
Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
Module Name:\r
\r
  FwBlockService.h\r
\r
Abstract:\r
\r
  Firmware volume block driver for Intel Firmware Hub (FWH) device\r
\r
--*/\r
\r
#ifndef _FW_BLOCK_SERVICE_H\r
#define _FW_BLOCK_SERVICE_H\r
\r
//\r
// Fvb Protocol instance data\r
//\r
#define FVB_DEVICE_FROM_THIS(a)         CR (a, EFI_FW_VOL_BLOCK_DEVICE, FwVolBlockInstance, FVB_DEVICE_SIGNATURE)\r
#define FVB_DEVICE_SIGNATURE            SIGNATURE_32 ('F', 'V', 'B', 'N')\r
\r
#pragma pack (1)\r
\r
typedef struct {\r
\r
  EFI_FIRMWARE_VOLUME_HEADER FvHdr;\r
  EFI_FV_BLOCK_MAP_ENTRY     EndBlockMap;\r
  VARIABLE_STORE_HEADER      VarHdr;\r
\r
} FVB_FV_HDR_AND_VARS_TEMPLATE;\r
\r
typedef struct {\r
  MEMMAP_DEVICE_PATH        MemMapDevPath;\r
  EFI_DEVICE_PATH_PROTOCOL  EndDevPath;\r
} FV_DEVICE_PATH;\r
\r
#pragma pack ()\r
\r
typedef struct {\r
  UINTN                               Signature;\r
  FV_DEVICE_PATH                      DevicePath;\r
  VOID                                *BufferPtr;\r
  UINTN                               BlockSize;\r
  UINTN                               Size;\r
  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  FwVolBlockInstance;\r
} EFI_FW_VOL_BLOCK_DEVICE;\r
\r
\r
//\r
// Constants\r
//\r
#define EMU_FVB_BLOCK_SIZE \\r
  EFI_PAGE_SIZE\r
#define EMU_FVB_NUM_SPARE_BLOCKS \\r
  EFI_SIZE_TO_PAGES ((UINTN)FixedPcdGet32 (PcdFlashNvStorageFtwSpareSize))\r
#define EMU_FVB_NUM_TOTAL_BLOCKS \\r
  (2 * EMU_FVB_NUM_SPARE_BLOCKS)\r
#define EMU_FVB_SIZE \\r
  (EMU_FVB_NUM_TOTAL_BLOCKS * EMU_FVB_BLOCK_SIZE)\r
#define FTW_WRITE_QUEUE_SIZE \\r
  (FixedPcdGet32 (PcdFlashNvStorageFtwWorkingSize) - \\r
   sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER))\r
#define EMU_FV_HEADER_LENGTH OFFSET_OF (FVB_FV_HDR_AND_VARS_TEMPLATE, VarHdr)\r
\r
#define NOT_ERASED_BIT 0\r
#define ERASED_BIT     1\r
#define ERASED_UINT8   0xff\r
#define ERASED_UINT32  0xffffffff\r
\r
//\r
// Protocol APIs\r
//\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolGetAttributes (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *This,\r
  OUT       EFI_FVB_ATTRIBUTES_2                *Attributes\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolSetAttributes (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *This,\r
  IN OUT    EFI_FVB_ATTRIBUTES_2                *Attributes\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolGetPhysicalAddress (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *This,\r
  OUT       EFI_PHYSICAL_ADDRESS                *Address\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolGetBlockSize (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *This,\r
  IN        EFI_LBA                             Lba,\r
  OUT       UINTN                               *BlockSize,\r
  OUT       UINTN                               *NumberOfBlocks\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolRead (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *This,\r
  IN        EFI_LBA                             Lba,\r
  IN        UINTN                               Offset,\r
  IN OUT    UINTN                               *NumBytes,\r
  IN OUT    UINT8                               *Buffer\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
FvbProtocolWrite (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK_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_STATUS\r
EFIAPI\r
FvbProtocolEraseBlocks (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *This,\r
  ...\r
  )\r
;\r
\r
#endif\r