OvmfPkg EMU FVB: Add 2 functions to PlatformFvbLib

[mirror_edk2.git] / OvmfPkg / Include / Library / PlatformFvbLib.h

/** @file\r
  Library to define platform customization functions for a\r
  Firmare Volume Block driver.\r
\r
  Copyright (c) 2009 - 2011, 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
#ifndef __PLATFORM_FVB_LIB__\r
#define __PLATFORM_FVB_LIB__\r
\r
#include <Protocol/FirmwareVolumeBlock.h>\r
\r
/**\r
  This function will be called following a call to the\r
  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL Read function.\r
\r
  @param[in] This     The EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
  @param[in] Lba      The starting logical block index\r
                      from which to read.\r
  @param[in] Offset   Offset into the block at which to begin reading.\r
  @param[in] NumBytes The number of bytes read.\r
  @param[in] Buffer   Pointer to the buffer that was read, and will be\r
                      returned to the caller.\r
\r
**/\r
VOID\r
EFIAPI\r
PlatformFvbDataRead (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
  IN        EFI_LBA                             Lba,\r
  IN        UINTN                               Offset,\r
  IN        UINTN                               NumBytes,\r
  IN        UINT8                               *Buffer\r
  );\r
\r
\r
/**\r
  This function will be called following a call to the\r
  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL Write function.\r
\r
  @param[in] This     EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
  @param[in] Lba      The starting logical block index to written to.\r
  @param[in] Offset   Offset into the block at which to begin writing.\r
  @param[in] NumBytes The number of bytes written.\r
  @param[in] Buffer   Pointer to the buffer that was written.\r
\r
**/\r
VOID\r
EFIAPI\r
PlatformFvbDataWritten (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL  *This,\r
  IN        EFI_LBA                              Lba,\r
  IN        UINTN                                Offset,\r
  IN        UINTN                                NumBytes,\r
  IN        UINT8                                *Buffer\r
  );\r
\r
\r
/**\r
  This function will be called following a call to the\r
  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL Erase function.\r
\r
  @param This   Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL\r
                instance.\r
  @param List   The variable argument list as documented for\r
                the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL Erase\r
                function.\r
\r
**/\r
VOID\r
EFIAPI\r
PlatformFvbBlocksErased (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
  IN  VA_LIST       List\r
  );\r
\r
\r
#endif\r
\r