Add comments for these header files

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / FvbExtension.h

/** @file\r
\r
  FVB Extension protocol provides one extended service to FVB protocol defined in PI specification.\r
  This service can erase the specified range of a firmware volume block.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. 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 __FVB_EXTENSION_H__\r
#define __FVB_EXTENSION_H__\r
\r
#define EFI_FVB_EXTENSION_PROTOCOL_GUID  \\r
  {0x53a4c71b, 0xb581, 0x4170, {0x91, 0xb3, 0x8d, 0xb8, 0x7a, 0x4b, 0x5c, 0x46 } }\r
\r
typedef struct _EFI_FVB_EXTENSION_PROTOCOL EFI_FVB_EXTENSION_PROTOCOL;\r
\r
//\r
//  FVB Extension Function Prototypes\r
//\r
/**\r
  Erases and initializes a specified range of a firmware volume block.\r
\r
  @param[in]     This           Pointer to the FVB Extension protocol instance\r
  @param[in]     StartLba       The starting logical block index to be erased\r
  @param[in]     OffsetStartLba Offset into the starting block at which to begin erasing    \r
  @param[in]     LastLba        The last logical block index to be erased\r
  @param[in]     OffsetLastLba  Offset into the last block at which to end erasing     \r
\r
  @retval EFI_SUCCESS           The specified range was erased successfully\r
  @retval EFI_ACCESS_DENIED     The firmware volume block is in the WriteDisabled state\r
  @retval EFI_DEVICE_ERROR      The block device is not functioning correctly and \r
                                could not be written. Firmware device may have been\r
                                partially erased.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FV_ERASE_CUSTOM_BLOCK)(\r
  IN EFI_FVB_EXTENSION_PROTOCOL   *This,\r
  IN EFI_LBA                      StartLba,\r
  IN UINTN                        OffsetStartLba,\r
  IN EFI_LBA                      LastLba,\r
  IN UINTN                        OffsetLastLba\r
);\r
\r
//\r
// FVB Extension PROTOCOL\r
//\r
struct _EFI_FVB_EXTENSION_PROTOCOL {\r
  EFI_FV_ERASE_CUSTOM_BLOCK               EraseFvbCustomBlock;\r
};\r
\r
extern EFI_GUID                           gEfiFvbExtensionProtocolGuid;\r
\r
#endif\r
\r