]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Guid/FmpCapsule.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / Guid / FmpCapsule.h
index 4c358b82bb6d08891baad1887c3f21b2166a1b8b..4d699b44a793f8c7f57ee226e3236d4f4fa32610 100644 (file)
@@ -2,21 +2,14 @@
   Guid & data structure used for Delivering Capsules Containing Updates to Firmware\r
   Management Protocol\r
 \r
-  Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>\r
-  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
+  Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Revision Reference:\r
   GUIDs defined in UEFI 2.4 spec.\r
 \r
 **/\r
 \r
-\r
 #ifndef _FMP_CAPSULE_GUID_H__\r
 #define _FMP_CAPSULE_GUID_H__\r
 \r
 #pragma pack(1)\r
 \r
 typedef struct {\r
-  UINT32 Version;\r
+  UINT32    Version;\r
 \r
   ///\r
   /// The number of drivers included in the capsule and the number of corresponding\r
-  /// offsets stored in ItemOffsetList array. \r
+  /// offsets stored in ItemOffsetList array.\r
   ///\r
-  UINT16 EmbeddedDriverCount;\r
+  UINT16    EmbeddedDriverCount;\r
 \r
   ///\r
   /// The number of payload items included in the capsule and the number of\r
   /// corresponding offsets stored in the ItemOffsetList array.\r
   ///\r
-  UINT16 PayloadItemCount;\r
+  UINT16    PayloadItemCount;\r
 \r
   ///\r
   /// Variable length array of dimension [EmbeddedDriverCount + PayloadItemCount]\r
@@ -53,37 +46,54 @@ typedef struct {
 } EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER;\r
 \r
 typedef struct {\r
-  UINT32   Version;\r
+  UINT32      Version;\r
 \r
   ///\r
-  /// Used to identifiy device firmware targeted by this update. This guid is matched by\r
+  /// Used to identify device firmware targeted by this update. This guid is matched by\r
   /// system firmware against ImageTypeId field within a EFI_FIRMWARE_IMAGE_DESCRIPTOR\r
   ///\r
-  EFI_GUID UpdateImageTypeId;\r
+  EFI_GUID    UpdateImageTypeId;\r
 \r
   ///\r
   /// Passed as ImageIndex in call to EFI_FIRMWARE_MANAGEMENT_PROTOCOL.SetImage()\r
   ///\r
-  UINT8    UpdateImageIndex;\r
-  UINT8    reserved_bytes[3];\r
+  UINT8       UpdateImageIndex;\r
+  UINT8       reserved_bytes[3];\r
 \r
   ///\r
   /// Size of the binary update image which immediately follows this structure\r
   ///\r
-  UINT32   UpdateImageSize;\r
+  UINT32      UpdateImageSize;\r
+\r
+  ///\r
+  /// Size of the VendorCode bytes which optionally immediately follow binary update image in the capsule\r
+  ///\r
+  UINT32      UpdateVendorCodeSize;\r
 \r
   ///\r
-  ///Size of the VendorCode bytes which optionally immediately follow binary update image in the capsule\r
+  /// The HardwareInstance to target with this update. If value is zero it means match all\r
+  /// HardwareInstances. This field allows update software to target only a single device in\r
+  /// cases where there are more than one device with the same ImageTypeId GUID.\r
+  /// This header is outside the signed data of the Authentication Info structure and\r
+  /// therefore can be modified without changing the Auth data.\r
   ///\r
-  UINT32   UpdateVendorCodeSize;\r
+  UINT64    UpdateHardwareInstance;\r
+\r
+  ///\r
+  /// A 64-bit bitmask that determines what sections are added to the payload.\r
+  /// #define CAPSULE_SUPPORT_AUTHENTICATION 0x0000000000000001\r
+  /// #define CAPSULE_SUPPORT_DEPENDENCY 0x0000000000000002\r
+  ///\r
+  UINT64    ImageCapsuleSupport;\r
 } EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER;\r
 \r
 #pragma pack()\r
 \r
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER_INIT_VERSION        0x00000001\r
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER_INIT_VERSION  0x00000003\r
+#define CAPSULE_SUPPORT_AUTHENTICATION                             0x0000000000000001\r
+#define CAPSULE_SUPPORT_DEPENDENCY                                 0x0000000000000002\r
 \r
-#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER_INIT_VERSION       0x00000001  \r
-#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER_INIT_VERSION 0x00000001\r
-\r
-extern EFI_GUID gEfiFmpCapsuleGuid;\r
+extern EFI_GUID  gEfiFmpCapsuleGuid;\r
 \r
 #endif\r