modify coding style to pass ecc tool and provide comments that complied with Doxgen.

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

/** @file\r
  This is a simple fault tolerant write driver, based on PlatformFd library.\r
  And it only supports write BufferSize <= SpareAreaLength.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\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 __FW_FAULT_TOLERANT_WRITE_LITE_PROTOCOL_H__\r
#define __FW_FAULT_TOLERANT_WRITE_LITE_PROTOCOL_H__\r
\r
#define EFI_FTW_LITE_PROTOCOL_GUID \\r
{ 0x3f557189, 0x8dae, 0x45ae, {0xa0, 0xb3, 0x2b, 0x99, 0xca, 0x7a, 0xa7, 0xa0 } }\r
\r
//\r
// Forward reference for pure ANSI compatability\r
//\r
typedef struct _EFI_FTW_LITE_PROTOCOL EFI_FTW_LITE_PROTOCOL;\r
\r
//\r
// Protocol API definitions\r
//\r
/**\r
  Starts a target block update. This records information about the write\r
  in fault tolerant storage and will complete the write in a recoverable\r
  manner, ensuring at all times that either the original contents or\r
  the modified contents are available.\r
\r
  @param  This                 Calling context \r
  @param  FvBlockHandle        The handle of FVB protocol that provides services \r
                               for reading, writing, and erasing the target \r
                               block. \r
  @param  Lba                  The logical block address of the target block. \r
  @param  Offset               The offset within the target block to place the \r
                               data. \r
  @param  Length               The number of bytes to write to the target block. \r
  @param  Buffer               The data to write. \r
\r
  @retval EFI_SUCCESS          The function completed successfully \r
  @retval EFI_ABORTED          The function could not complete successfully. \r
  @retval EFI_BAD_BUFFER_SIZE  The write would span a block boundary, which is \r
                               not a valid action. \r
  @retval EFI_ACCESS_DENIED    No writes have been allocated. \r
  @retval EFI_NOT_READY        The last write has not been completed. Restart () \r
                               must be called to complete it. \r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FTW_LITE_WRITE) (\r
  IN EFI_FTW_LITE_PROTOCOL             *This,\r
  IN EFI_HANDLE                        FvbHandle,\r
  IN EFI_LBA                           Lba,\r
  IN UINTN                             Offset,\r
  IN UINTN                             *NumBytes,\r
  IN VOID                              *Buffer\r
  )\r
;\r
\r
//\r
// Protocol declaration\r
//\r
struct _EFI_FTW_LITE_PROTOCOL {\r
  EFI_FTW_LITE_WRITE               Write;\r
};\r
\r
extern EFI_GUID gEfiFaultTolerantWriteLiteProtocolGuid;\r
\r
#endif\r