]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkPkg/Include/Guid/Capsule.h
Keep inconsistency in code and add additional comments for that.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Guid / Capsule.h
CommitLineData
79964ac8 1/** @file\r
aa4a31e3 2 Framework Capule related Definition.\r
79964ac8 3\r
2bbaeb0d 4 Copyright (c) 2007 - 2009, Intel Corporation\r
79964ac8 5 All rights reserved. This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
79964ac8 13 @par Revision Reference:\r
aa4a31e3 14 Capsule Spec Version 0.9\r
79964ac8 15**/\r
16\r
17#ifndef _CAPSULE_GUID_H__\r
18#define _CAPSULE_GUID_H__\r
19\r
b80fbe85 20#include <PiPei.h>\r
21\r
79964ac8 22//\r
23// This is the GUID of the capsule header of the image on disk.\r
24//\r
25#define EFI_CAPSULE_GUID \\r
26 { \\r
27 0x3B6686BD, 0x0D76, 0x4030, {0xB7, 0x0E, 0xB5, 0x51, 0x9E, 0x2F, 0xC5, 0xA0 } \\r
28 }\r
29\r
30//\r
31// This is the GUID of the configuration results file created by the capsule\r
32// application.\r
33//\r
34#define EFI_CONFIG_FILE_NAME_GUID \\r
35 { \\r
36 0x98B8D59B, 0xE8BA, 0x48EE, {0x98, 0xDD, 0xC2, 0x95, 0x39, 0x2F, 0x1E, 0xDB } \\r
37 }\r
38\r
aa4a31e3
LG
39///\r
40/// Bits in the flags field of the capsule header\r
41/// This flag is set if the capsule can support setup changes and clear if it cannot.\r
42///\r
43#define EFI_CAPSULE_HEADER_FLAG_SETUP 0x00000001\r
1b144bbf 44\r
e89ec8f6 45#define CAPSULE_BLOCK_DESCRIPTOR_SIGNATURE SIGNATURE_32 ('C', 'B', 'D', 'S')\r
1b144bbf 46\r
47//\r
48// An array of these describe the blocks that make up a capsule for\r
49// a capsule update.\r
50//\r
51typedef struct {\r
2bbaeb0d 52 UINT64 Length; ///< length of the data block\r
53 EFI_PHYSICAL_ADDRESS Data; ///< physical address of the data block\r
54 UINT32 Signature; ///< CBDS\r
55 UINT32 CheckSum; ///< to sum this structure to 0\r
1b144bbf 56} FRAMEWORK_EFI_CAPSULE_BLOCK_DESCRIPTOR;\r
57\r
58typedef struct {\r
59 EFI_GUID OemGuid;\r
60 UINT32 HeaderSize;\r
61 //\r
62 // UINT8 OemHdrData[];\r
63 //\r
64} EFI_CAPSULE_OEM_HEADER;\r
65\r
66typedef struct {\r
aa4a31e3
LG
67 ///\r
68 /// A defined GUID that indicates the start of a capsule.\r
69 ///\r
1b144bbf 70 EFI_GUID CapsuleGuid;\r
aa4a31e3
LG
71 ///\r
72 /// The size of the EFI_CAPSULE_HEADER structure.\r
73 ///\r
1b144bbf 74 UINT32 HeaderSize;\r
aa4a31e3
LG
75 ///\r
76