]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Include/Library/CapsuleLib.h
Update HiiGetBrowserData API
[mirror_edk2.git] / MdeModulePkg / Include / Library / CapsuleLib.h
CommitLineData
0537d50f 1/** @file\r
504214c4 2\r
109e9a61 3 This library class defines a set of interfaces on how to process capusle image update.\r
0537d50f 4\r
109e9a61 5 Copyright (c) 2007 - 2008, Intel Corporation\r
0537d50f
LG
6 All rights reserved. This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10 \r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef __CAPSULE_LIB_H__\r
17#define __CAPSULE_LIB_H__\r
18\r
19/**\r
109e9a61
LG
20 The firmware checks whether the capsule image is supported \r
21 by the CapsuleGuid in CapsuleHeader or other specific information in capsule image.\r
0537d50f 22 \r
2ae8963c
LG
23 @param CapsuleHeader Point to the UEFI capsule image to be checked.\r
24 \r
0537d50f
LG
25 @retval EFI_SUCESS Input capsule is supported by firmware.\r
26 @retval EFI_UNSUPPORTED Input capsule is not supported by the firmware.\r
27**/\r
28EFI_STATUS\r
29EFIAPI\r
30SupportCapsuleImage (\r
31 IN EFI_CAPSULE_HEADER *CapsuleHeader\r
ed66e1bc 32 );\r
0537d50f
LG
33\r
34/**\r
109e9a61
LG
35 The firmware specific implementation processes the capsule image\r
36 if it recognized the format of this capsule image.\r
0537d50f 37 \r
2ae8963c
LG
38 @param CapsuleHeader Point to the UEFI capsule image to be processed. \r
39 \r
0537d50f
LG
40 @retval EFI_SUCESS Process Capsule Image successfully. \r
41 @retval EFI_UNSUPPORTED Capsule image is not supported by the firmware.\r
42**/\r
43EFI_STATUS\r
44EFIAPI\r
45ProcessCapsuleImage (\r
46 IN EFI_CAPSULE_HEADER *CapsuleHeader\r
ed66e1bc 47 );\r
0537d50f
LG
48\r
49#endif\r