1. add EFI Firmware Management protocol definition in MdePkg.

[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareManagement.h

/** @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