]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/FirmwareManagement.h
1. add EFI Firmware Management protocol definition in MdePkg.
[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareManagement.h
diff --git a/MdePkg/Include/Protocol/FirmwareManagement.h b/MdePkg/Include/Protocol/FirmwareManagement.h
new file mode 100644 (file)
index 0000000..4bca4d3
--- /dev/null
@@ -0,0 +1,492 @@
+/** @file\r
+  UEFI Firmware Management Protocol definition\r
+  Firmware Management Protocol provides an abstraction for device to provide firmware \r
+  management support. The base requirements for managing device firmware images include \r
+  identifying firmware image revision level and programming the image into the device.\r
+\r
+  GetImageInfo() is the only required function. GetImage(), SetImage(), \r
+  CheckImage(), GetPackageInfo(), and SetPackageInfo() shall return \r
+  EFI_UNSUPPORTED if not supported by the driver.\r
+  \r
+  Copyright (c) 2009, Intel Corporation                                                         \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
+  @par Revision Reference:          \r
+  This Protocol is introduced in UEFI Specification 2.3      \r
+\r
+**/\r
+\r
+#ifndef __EFI_FIRMWARE_MANAGEMENT_PROTOCOL_H__\r
+#define __EFI_FIRMWARE_MANAGEMENT_PROTOCOL_H__\r
+\r
+\r
+#define EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID \\r
+  { \\r
+    0x86c77a67, 0xb97, 0x4633, {0xa1, 0x87, 0x49, 0x10, 0x4d, 0x6, 0x85, 0xc7 } \\r
+  }\r
+\r
+typedef struct _EFI_FIRMWARE_MANAGEMENT_PROTOCOL EFI_FIRMWARE_MANAGEMENT_PROTOCOL;\r
+\r
+///\r
+/// EFI_FIRMWARE_IMAGE_DESCRIPTOR\r
+///\r
+typedef struct {\r
+  /// \r
+  /// A unique number identifying the firmware image within the device.  The number is \r
+  /// between 1 and DescriptorCount.\r
+  /// \r
+  UINT8                            ImageIndex;\r
+  ///\r
+  /// A unique number identifying the firmware image type.  \r
+  /// \r
+  EFI_GUID                         ImageTypeId;\r
+  /// \r
+  /// A unique number identifying the firmware image. \r
+  /// \r
+  UINT64                           ImageId;\r
+  /// \r
+  /// A pointer to a null-terminated Unicode string representing the firmware image name.  \r
+  /// \r
+  CHAR16                           *ImageIdName;\r
+  /// \r
+  /// Identifies the version of the device firmware. The format is vendor specific and new \r
+  /// version must have a greater value than an old version.\r
+  /// \r
+  UINT32                           Version;\r
+  /// \r
+  /// A pointer to a null-terminated Unicode string representing the firmware image version name.\r
+  /// \r
+  CHAR16                           *VersionName;\r
+  /// \r
+  /// Size of the image in bytes.  If size=0, then only ImageIndex and ImageTypeId are valid.\r
+  /// \r
+  UINTN                            Size;\r
+  /// \r
+  /// Image attributes that are supported by this device.  See 'Image Attribute Definitions' \r
+  /// for possible returned values of this parameter.  A value of 1 indicates the attribute is \r
+  /// supported and the current setting value is indicated in AttributesSetting.  A \r
+  /// value of 0 indicates the attribute is not supported and the current setting value in \r
+  /// AttributesSetting is meaningless.\r
+  /// \r
+  UINT64                           AttributesSupported;\r
+  /// \r
+  /// Image attributes.  See 'Image Attribute Definitions' for possible returned values of \r
+  /// this parameter.\r
+  /// \r
+  UINT64                           AttributesSetting;\r
+  /// \r
+  /// Image compatibilities.  See 'Image Compatibility Definitions' for possible returned \r
+  /// values of this parameter.\r
+  /// \r
+  UINT64                           Compatibilities;\r
+} EFI_FIRMWARE_IMAGE_DESCRIPTOR;\r
+\r
+\r
+//\r
+// Image Attribute Definitions\r
+//\r
+///\r
+/// The attribute IMAGE_ATTRIBUTE_IMAGE_UPDATABLE indicates this device supports firmware \r
+/// image update.\r
+///\r
+#define    IMAGE_ATTRIBUTE_IMAGE_UPDATABLE         0x0000000000000001\r
+///\r
+/// The attribute IMAGE_ATTRIBUTE_RESET_REQUIRED indicates a reset of the device is required \r
+/// for the new firmware image to take effect after a firmware update.  The device is the device hosting \r
+/// the firmware image.\r
+/// \r
+#define    IMAGE_ATTRIBUTE_RESET_REQUIRED          0x0000000000000002\r
+///\r
+/// The attribute IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED indicates authentication is \r
+/// required to perform the following image operations: GetImage(), SetImage(), and \r
+/// CheckImage(). See 'Image Attribute - Authentication'.\r
+/// \r
+#define    IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004\r
+///\r
+/// The attribute IMAGE_ATTRIBUTE_IN_USE indicates the current state of the firmware image.  \r
+/// This distinguishes firmware images in a device that supports redundant images.  \r
+/// \r
+#define    IMAGE_ATTRIBUTE_IN_USE                  0x0000000000000008\r
+\r
+\r
+//\r
+// Image Compatibility Definitions\r
+//\r
+/// Values from 0x0000000000000002 thru 0x000000000000FFFF are reserved for future assignments.\r
+/// Values from 0x0000000000010000 thru 0xFFFFFFFFFFFFFFFF are used by firmware vendor for \r
+/// compatibility check.\r
+///\r
+#define   IMAGE_COMPATIBILITY_CHECK_SUPPORTED      0x0000000000000001\r
+\r
+///\r
+/// Descriptor Version\r
+///\r
+#define   EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION   1\r
+\r
+\r
+///\r
+/// Image Attribute ¨CAuthentication Required\r
+///\r
+typedef struct {\r
+  ///\r
+  /// It is included in the signature of AuthInfo.  It is used to ensure freshness/no replay.   \r
+  /// It is incremented during each firmware image operation.  \r
+  ///                                \r
+  UINT64                                  MonotonicCount;\r
+  ///\r
+  /// Provides the authorization for the firmware image operations.  It is a signature across \r
+  /// the image data and the Monotonic Count value.  Caller uses the private key that is \r
+  /// associated with a public key that has been provisioned via the key exchange.  \r
+  ///\r
+  WIN_CERTIFICATE_UEFI_GUID               AuthInfo;\r
+} EFI_FIRMWARE_IMAGE_AUTHENTICATION;\r
+\r
+\r
+//\r
+// ImageUpdatable Definitions\r
+//\r
+///\r
+/// IMAGE_UPDATABLE_VALID indicates SetImage() will accept the new image and update the \r
+/// device with the new image.\r
+///\r
+#define  IMAGE_UPDATABLE_VALID                     0x0000000000000001\r
+///\r
+/// IMAGE_UPDATABLE_INVALID indicates SetImage() will reject the new image. No additional \r
+/// information is provided for the rejection.\r
+///\r
+#define  IMAGE_UPDATABLE_INVALID                   0x0000000000000002\r
+///\r
+/// IMAGE_UPDATABLE_INVALID_TYPE indicates SetImage() will reject the new image. The \r
+/// rejection is due to the new image is not a firmware image recognized for this device.\r
+///\r
+#define  IMAGE_UPDATABLE_INVALID_TYPE              0x0000000000000004\r
+///\r
+/// IMAGE_UPDATABLE_INVALID_OLD indicates SetImage() will reject the new image. The \r
+/// rejection is due to the new image version is older than the current firmware image\r
+/// version in the device. The device firmware update policy does not support firmware \r
+/// version downgrade.\r
+///\r
+#define  IMAGE_UPDATABLE_INVALID_OLD               0x0000000000000008\r
+\r
+\r
+//\r
+// Package Attribute Definitions\r
+//\r
+///\r
+/// The attribute PACKAGE_ATTRIBUTE_VERSION_UPDATABLE indicates this device supports the \r
+/// update of the firmware package version.\r
+///\r
+#define  PACKAGE_ATTRIBUTE_VERSION_UPDATABLE       0x0000000000000001\r
+///\r
+/// The attribute PACKAGE_ATTRIBUTE_RESET_REQUIRED indicates a reset of the device is \r
+/// required for the new package info to take effect after an update.\r
+///\r
+#define  PACKAGE_ATTRIBUTE_RESET_REQUIRED          0x0000000000000002\r
+///\r
+/// The attribute PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED indicates authentication \r
+/// is required to update the package info.\r
+///\r
+#define  PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004\r
+\r
+/** \r
+  Callback funtion to report the process of the firmware updating.\r
+\r
+  @param[in]  Completion    A value between 1 and 100 indicating the current completion\r
+                            progress of the firmware update. Completion progress is \r
+                            reported as from 1 to 100 percent. A value of 0 is used by\r
+                            the driver to indicate that progress reporting is not supported.\r
+\r
+  @retval EFI_SUCCESS       SetImage() continues to do the callback if supported.\r
+  @retval other             SetImage() discontinues the callback and completes\r
+                            the update and returns.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS)(\r
+  IN  UINTN                          Completion\r
+  );\r
+\r
+/**\r
+  Returns information about the current firmware image(s) of the device.\r
+\r
+  This function allows a copy of the current firmware image to be created and saved.\r
+  The saved copy could later been used, for example, in firmware image recovery or rollback.\r
+\r
+  @param[in]      This               A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r
+  @param[in, out] ImageInfoSize      A pointer to the size, in bytes, of the ImageInfo buffer. \r
+                                     On input, this is the size of the buffer allocated by the caller.\r
+                                     On output, it is the size of the buffer returned by the firmware \r
+                                     if the buffer was large enough, or the size of the buffer needed\r
+                                     to contain the image(s) information if the buffer was too small.\r
+  @param[in, out] ImageInfo          A pointer to the buffer in which firmware places the current image(s)\r
+                                     information. The information is an array of EFI_FIRMWARE_IMAGE_DESCRIPTORs.\r
+  @param[out]     DescriptorVersion  A pointer to the location in which firmware returns the version number\r
+                                     associated with the EFI_FIRMWARE_IMAGE_DESCRIPTOR. \r
+  @param[out]     DescriptorCount    A pointer to the location in which firmware returns the number of\r
+                                     descriptors or firmware images within this device.\r
+  @param[out]     DescriptorSize     A pointer to the location in which firmware returns the size, in bytes,\r
+                                     of an individual EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
+  @param[out]     PackageVersion     A version number that represents all the firmware images in the device.\r
+                                     The format is vendor specific and new version must have a greater value\r
+                                     than the old version. If PackageVersion is not supported, the value is\r
+                                     0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version comparison\r
+                                     is to be performed using PackageVersionName. A value of 0xFFFFFFFD indicates\r
+                                     that package version update is in progress.\r
+  @param[out]     PackageVersionName A pointer to a pointer to a null-terminated Unicode string representing the\r
+                                     package version name. The buffer is allocated by this function with \r
+                                     AllocatePool(), and it is the caller's responsibility to free it with a call\r
+                                     to FreePool().\r
+\r
+  @retval EFI_SUCCESS                The device was successfully updated with the new image.\r
+  @retval EFI_BUFFER_TOO_SMALL       The ImageInfo buffer was too small. The current buffer size \r
+                                     needed to hold the image(s) information is returned in ImageInfoSize.                                               \r
+  @retval EFI_INVALID_PARAMETER      ImageInfoSize is NULL.\r
+  @retval EFI_DEVICE_ERROR           Valid information could not be returned. Possible corrupted image.\r
+\r
+**/                         \r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE_INFO)(\r
+  IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL       *This,\r
+  IN OUT    UINTN                           *ImageInfoSize,\r
+  IN OUT    EFI_FIRMWARE_IMAGE_DESCRIPTOR   *ImageInfo,\r
+  OUT       UINT32                          *DescriptorVersion,\r
+  OUT       UINT8                           *DescriptorCount,\r
+  OUT       UINTN                           *DescriptorSize,\r
+  OUT       UINT32                          *PackageVersion,\r
+  OUT       CHAR16                          **PackageVersionName\r
+  );\r
+\r
+/**\r
+  Retrieves a copy of the current firmware image of the device. \r
+\r
+  This function allows a copy of the current firmware image to be created and saved.\r
+  The saved copy could later been used, for example, in firmware image recovery or rollback.\r
+\r
+  @param[in]  This               A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r
+  @param[in]  ImageIndex         A unique number identifying the firmware image(s) within the device.\r
+                                 The number is between 1 and DescriptorCount.\r
+  @param[out] Image              Points to the buffer where the current image is copied to.\r
+  @param[out] ImageSize          On entry, points to the size of the buffer pointed to by Image, in bytes.\r
+                                 On return, points to the length of the image, in bytes.\r
+\r
+  @retval EFI_SUCCESS            The device was successfully updated with the new image.\r
+  @retval EFI_BUFFER_TOO_SMALL   The buffer specified by ImageSize is too small to hold the \r
+                                 image. The current buffer size needed to hold the image is returned \r
+                                 in ImageSize.\r
+  @retval EFI_INVALID_PARAMETER  The Image was NULL.\r
+  @retval EFI_NOT_FOUND          The current image is not copied to the buffer.\r
+  @retval EFI_UNSUPPORTED        The operation is not supported.\r
+  @retval EFI_SECURITY_VIOLATIO  The operation could not be performed due to an authentication failure.\r
+\r
+**/                         \r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE)(\r
+  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL  *This,\r
+  IN  UINT8                             ImageIndex,\r
+  IN  OUT  VOID                         *Image,\r
+  IN  OUT  UINTN                        *ImageSize\r
+  );\r
+\r
+/**\r
+  Updates the firmware image of the device.\r
+\r
+  This function updates the hardware with the new firmware image.\r
+  This function returns EFI_UNSUPPORTED if the firmware image is not updatable.\r
+  If the firmware image is updatable, the function should perform the following minimal validations\r
+  before proceeding to do the firmware image update.\r
+  - Validate the image authentication if image has attribute \r
+    IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED.  The function returns \r
+    EFI_SECURITY_VIOLATION if the validation fails.\r
+  - Validate the image is a supported image for this device.  The function returns EFI_ABORTED if \r
+    the image is unsupported.  The function can optionally provide more detailed information on \r
+    why the image is not a supported image.\r
+  - Validate the data from VendorCode if not null.  Image validation must be performed before \r
+    VendorCode data validation.  VendorCode data is ignored or considered invalid if image \r
+    validation failed.  The function returns EFI_ABORTED if the data is invalid.\r
+  \r
+  VendorCode enables vendor to implement vendor-specific firmware image update policy.  Null if \r
+  the caller did not specify the policy or use the default policy.  As an example, vendor can implement \r
+  a policy to allow an option to force a firmware image update when the abort reason is due to the new \r
+  firmware image version is older than the current firmware image version or bad image checksum.  \r
+  Sensitive operations such as those wiping the entire firmware image and render the device to be\r
+  non-functional should be encoded in the image itself rather than passed with the VendorCode.\r
+  AbortReason enables vendor to have the option to provide a more detailed description of the abort\r
+  reason to the caller.\r
+\r
+  @param[in]  This               A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r
+  @param[in]  ImageIndex         A unique number identifying the firmware image(s) within the device.\r
+                                 The number is between 1 and DescriptorCount.\r
+  @param[in]  Image              Points to the new image.\r
+  @param[in]  ImageSize          Size of the new image in bytes.\r
+  @param[in]  VendorCode         This enables vendor to implement vendor-specific firmware image update policy.  \r
+                                 Null indicates the caller did not specify the policy or use the default policy.\r
+  @param[in]  Progress           A function used by the driver to report the progress of the firmware update.\r
+  @param[out] AbortReason        A pointer to a pointer to a null-terminated Unicode string providing more\r
+                                 details for the aborted operation. The buffer is allocated by this function \r
+                                 with AllocatePool(), and it is the caller's responsibility to free it with a\r
+                                 call to FreePool().\r
+\r
+  @retval EFI_SUCCESS            The device was successfully updated with the new image.\r
+  @retval EFI_ABORTED            The operation is aborted.\r
+  @retval EFI_INVALID_PARAMETER  The Image was NULL.\r
+  @retval EFI_UNSUPPORTED        The operation is not supported.\r
+  @retval EFI_SECURITY_VIOLATIO  The operation could not be performed due to an authentication failure.\r
+\r
+**/                         \r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_IMAGE)(\r
+  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL                 *This,\r
+  IN  UINT8                                            ImageIndex,\r
+  IN  CONST VOID                                       *Image,\r
+  IN  UINTN                                            ImageSize,\r
+  IN  CONST VOID                                       *VendorCode,\r
+  IN  EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS    Progress,\r
+  OUT CHAR16                                           **AbortReason\r
+  );\r
+\r
+/**\r
+  Checks if the firmware image is valid for the device.\r
+\r
+  This function allows firmware update application to validate the firmware image without \r
+  invoking the SetImage() first.\r
+\r
+  @param[in]  This               A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r
+  @param[in]  ImageIndex         A unique number identifying the firmware image(s) within the device.\r
+                                 The number is between 1 and DescriptorCount.\r
+  @param[in]  Image              Points to the new image.\r
+  @param[in]  ImageSize          Size of the new image in bytes.\r
+  @param[out] ImageUpdatable     Indicates if the new image is valid for update. It also provides,\r
+                                 if available, additional information if the image is invalid. \r
+\r
+  @retval EFI_SUCCESS            The image was successfully checked.\r
+  @retval EFI_INVALID_PARAMETER  The Image was NULL.\r
+  @retval EFI_UNSUPPORTED        The operation is not supported.\r
+  @retval EFI_SECURITY_VIOLATIO  The operation could not be performed due to an authentication failure.\r
+\r
+**/                         \r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_CHECK_IMAGE)(\r
+  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL  *This,\r
+  IN  UINT8                             ImageIndex,\r
+  IN  CONST VOID                        *Image,\r
+  IN  UINTN                             ImageSize,\r
+  OUT UINT32                            *ImageUpdatable\r
+  );\r
+\r
+/**\r
+  Returns information about the firmware package. \r
+\r
+  This function returns package information.\r
+\r
+  @param[in]  This                     A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r
+  @param[out] PackageVersion           A version number that represents all the firmware images in the device.\r
+                                       The format is vendor specific and new version must have a greater value\r
+                                       than the old version. If PackageVersion is not supported, the value is\r
+                                       0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version\r
+                                       comparison is to be performed using PackageVersionName. A value of\r
+                                       0xFFFFFFFD indicates that package version update is in progress.\r
+  @param[out] PackageVersionName       A pointer to a pointer to a null-terminated Unicode string representing\r
+                                       the package version name. The buffer is allocated by this function with\r
+                                       AllocatePool(), and it is the caller's responsibility to free it with a\r
+                                       call to FreePool().\r
+  @param[out] PackageVersionNameMaxLen The maximum length of package version name if device supports update of\r
+                                       package version name. A value of 0 indicates the device does not support\r
+                                       update of package version name. Length is the number of Unicode characters,\r
+                                       including the terminating null character.\r
+  @param[out] AttributesSupported      Package attributes that are supported by this device. See 'Package Attribute \r
+                                       Definitions' for possible returned values of this parameter. A value of 1 \r
+                                       indicates the attribute is supported and the current setting value is\r
+                                       indicated in AttributesSetting. A value of 0 indicates the attribute is not\r
+                                       supported and the current setting value in AttributesSetting is meaningless.\r
+  @param[out] AttributesSetting        Package attributes. See 'Package Attribute Definitions' for possible returned\r
+                                       values of this parameter\r
+\r
+  @retval EFI_SUCCESS                  The package information was successfully returned.\r
+  @retval EFI_UNSUPPORTED              The operation is not supported.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_PACKAGE_INFO)(\r
+  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,\r
+  OUT UINT32                           *PackageVersion,\r
+  OUT CHAR16                           **PackageVersionName,\r
+  OUT UINT32                           *PackageVersionNameMaxLen,\r
+  OUT UINT64                           *AttributesSupported,\r
+  OUT UINT64                           *AttributesSetting\r
+  );\r
+\r
+/**\r
+  Updates information about the firmware package.\r
+\r
+  This function updates package information.\r
+  This function returns EFI_UNSUPPORTED if the package information is not updatable.\r
+  VendorCode enables vendor to implement vendor-specific package information update policy.\r
+  Null if the caller did not specify this policy or use the default policy.\r
+\r
+  @param[in]  This               A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r
+  @param[in]  Image              Points to the authentication image.\r
+                                 Null if authentication is not required.\r
+  @param[in]  ImageSize          Size of the authentication image in bytes.\r
+                                 0 if authentication is not required.\r
+  @param[in]  VendorCode         This enables vendor to implement vendor-specific firmware\r
+                                 image update policy.  \r
+                                 Null indicates the caller did not specify this policy or use\r
+                                 the default policy.\r
+  @param[in]  PackageVersion     The new package version.\r
+  @param[in]  PackageVersionName A pointer to the new null-terminated Unicode string representing\r
+                                 the package version name. \r
+                                 The string length is equal to or less than the value returned in \r
+                                 PackageVersionNameMaxLen.\r
+\r
+  @retval EFI_SUCCESS            The device was successfully updated with the new package\r
+                                 information.\r
+  @retval EFI_INVALID_PARAMETER  The PackageVersionName length is longer than the value \r
+                                 returned in PackageVersionNameMaxLen.\r
+  @retval EFI_UNSUPPORTED        The operation is not supported.\r
+  @retval EFI_SECURITY_VIOLATIO  The operation could not be performed due to an authentication failure.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_PACKAGE_INFO)(\r
+  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL   *This,\r
+  IN  CONST VOID                         *Image,\r
+  IN  UINTN                              ImageSize,\r
+  IN  CONST VOID                         *VendorCode,\r
+  IN  UINT32                             PackageVersion,\r
+  IN  CONST CHAR16                       *PackageVersionName\r
+  );\r
+\r
+///\r
+/// EFI_FIRMWARE_MANAGEMENT_PROTOCOL\r
+/// The protocol for managing firmware provides the following services.\r
+/// - Get the attributes of the current firmware image. Attributes include revision level.\r
+/// - Get a copy of the current firmware image. As an example, this service could be used by a \r
+///   management application to facilitate a firmware roll-back.\r
+/// - Program the device with a firmware image supplied by the user.\r
+/// - Label all the firmware images within a device with a single version.\r
+///\r
+struct _EFI_FIRMWARE_MANAGEMENT_PROTOCOL {\r
+  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE_INFO    GetImageInfo;\r
+  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE         GetImage;\r
+  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_IMAGE         SetImage;\r
+  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_CHECK_IMAGE       CheckImage;\r
+  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_PACKAGE_INFO  GetPackageInfo;\r
+  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_PACKAGE_INFO  SetPackageInfo;\r
+};\r
+\r
+extern EFI_GUID gEfiFirmwareManagementProtocolGuid;\r
+\r
+#endif\r