]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Include/Protocol/FvbExtension.h
Add comments and DoxyGen format for these files.
[mirror_edk2.git] / MdeModulePkg / Include / Protocol / FvbExtension.h
CommitLineData
504214c4 1/** @file\r
88f20127 2\r
504214c4
LG
3 FVB Extension protocol that extends the FVB Class in a component fashion.\r
4\r
5Copyright (c) 2006 - 2008, Intel Corporation\r
88f20127 6All rights reserved. This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
504214c4 14**/\r
88f20127 15\r
16#ifndef __FVB_EXTENSION_H__\r
17#define __FVB_EXTENSION_H__\r
18\r
19#define EFI_FVB_EXTENSION_PROTOCOL_GUID \\r
20 {0x53a4c71b, 0xb581, 0x4170, {0x91, 0xb3, 0x8d, 0xb8, 0x7a, 0x4b, 0x5c, 0x46 } }\r
21\r
22typedef struct _EFI_FVB_EXTENSION_PROTOCOL EFI_FVB_EXTENSION_PROTOCOL;\r
23\r
24//\r
25// FVB Extension Function Prototypes\r
26//\r
504214c4
LG
27/**
28 Erases and initializes a specified range of a firmware volume\r
29
30 @param[in] This Pointer to the FVB Extension protocol instance
31 @param[in] StartLba The starting logical block index to be erased
32 @param[in] OffsetStartLba Offset into the starting block at which to \r
33 begin erasing
34 @param[in] LastLba The last logical block index to be erased
35 @param[in] OffsetLastLba Offset into the last block at which to end erasing
36
37 @retval EFI_EFI_SUCCESS Range was erased
38 @retval EFI_INVALID_PARAMETER invalid parameter
39 @retval EFI_UNSUPPORTED Range can not be erased\r
40
41**/\r
88f20127 42typedef\r
43EFI_STATUS\r
44(EFIAPI * EFI_FV_ERASE_CUSTOM_BLOCK) (\r
45 IN EFI_FVB_EXTENSION_PROTOCOL *This,\r
46 IN EFI_LBA StartLba,\r
47 IN UINTN OffsetStartLba,\r
48 IN EFI_LBA LastLba,\r
49 IN UINTN OffsetLastLba\r
50);\r
51\r
52//\r
504214c4 53// FVB Extension PROTOCOL\r
88f20127 54//\r
55struct _EFI_FVB_EXTENSION_PROTOCOL {\r
56 EFI_FV_ERASE_CUSTOM_BLOCK EraseFvbCustomBlock;\r
57};\r
58\r
59extern EFI_GUID gEfiFvbExtensionProtocolGuid;\r
60\r
61#endif\r
62\r