FirmwareManagement.h

Go to the documentation of this file.

 
#ifndef __EFI_FIRMWARE_MANAGEMENT_PROTOCOL_H__
#define __EFI_FIRMWARE_MANAGEMENT_PROTOCOL_H__
 
#define EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID \
  { \
    0x86c77a67, 0xb97, 0x4633, {0xa1, 0x87, 0x49, 0x10, 0x4d, 0x6, 0x85, 0xc7 } \
  }
 
typedef struct _EFI_FIRMWARE_MANAGEMENT_PROTOCOL EFI_FIRMWARE_MANAGEMENT_PROTOCOL;
 
#define EFI_FMP_DEP_PUSH_GUID       0x00
#define EFI_FMP_DEP_PUSH_VERSION    0x01
#define EFI_FMP_DEP_VERSION_STR     0x02
#define EFI_FMP_DEP_AND             0x03
#define EFI_FMP_DEP_OR              0x04
#define EFI_FMP_DEP_NOT             0x05
#define EFI_FMP_DEP_TRUE            0x06
#define EFI_FMP_DEP_FALSE           0x07
#define EFI_FMP_DEP_EQ              0x08
#define EFI_FMP_DEP_GT              0x09
#define EFI_FMP_DEP_GTE             0x0A
#define EFI_FMP_DEP_LT              0x0B
#define EFI_FMP_DEP_LTE             0x0C
#define EFI_FMP_DEP_END             0x0D
#define EFI_FMP_DEP_DECLARE_LENGTH  0x0E
 
typedef struct {
  UINT8    Dependencies[1];
} EFI_FIRMWARE_IMAGE_DEP;
 
typedef struct {
  UINT8       ImageIndex;
  EFI_GUID    ImageTypeId;
  UINT64      ImageId;
  CHAR16      *ImageIdName;
  UINT32      Version;
  CHAR16      *VersionName;
  UINTN       Size;
  UINT64      AttributesSupported;
  UINT64      AttributesSetting;
  UINT64      Compatibilities;
  UINT32      LowestSupportedImageVersion;
  UINT32      LastAttemptVersion;
  UINT32      LastAttemptStatus;
  UINT64                    HardwareInstance;
  EFI_FIRMWARE_IMAGE_DEP    *Dependencies;
} EFI_FIRMWARE_IMAGE_DESCRIPTOR;
 
//
// Image Attribute Definitions
//
#define    IMAGE_ATTRIBUTE_IMAGE_UPDATABLE  0x0000000000000001
#define    IMAGE_ATTRIBUTE_RESET_REQUIRED  0x0000000000000002
#define    IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED  0x0000000000000004
#define    IMAGE_ATTRIBUTE_IN_USE  0x0000000000000008
#define    IMAGE_ATTRIBUTE_UEFI_IMAGE  0x0000000000000010
#define    IMAGE_ATTRIBUTE_DEPENDENCY  0x0000000000000020
 
//
// Image Compatibility Definitions
//
#define   IMAGE_COMPATIBILITY_CHECK_SUPPORTED  0x0000000000000001
 
#define   EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION  4
 
typedef struct {
  UINT64                       MonotonicCount;
  WIN_CERTIFICATE_UEFI_GUID    AuthInfo;
} EFI_FIRMWARE_IMAGE_AUTHENTICATION;
 
//
// ImageUpdatable Definitions
//
#define  IMAGE_UPDATABLE_VALID  0x0000000000000001
#define  IMAGE_UPDATABLE_INVALID  0x0000000000000002
#define  IMAGE_UPDATABLE_INVALID_TYPE  0x0000000000000004
#define  IMAGE_UPDATABLE_INVALID_OLD  0x0000000000000008
#define IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE  0x0000000000000010
 
//
// Package Attribute Definitions
//
#define  PACKAGE_ATTRIBUTE_VERSION_UPDATABLE  0x0000000000000001
#define  PACKAGE_ATTRIBUTE_RESET_REQUIRED  0x0000000000000002
#define  PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED  0x0000000000000004
 
typedef
EFI_STATUS
(EFIAPI *EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS)(
  IN  UINTN                          Completion
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE_INFO)(
  IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL       *This,
  IN OUT    UINTN                           *ImageInfoSize,
  IN OUT    EFI_FIRMWARE_IMAGE_DESCRIPTOR   *ImageInfo,
  OUT       UINT32                          *DescriptorVersion,
  OUT       UINT8                           *DescriptorCount,
  OUT       UINTN                           *DescriptorSize,
  OUT       UINT32                          *PackageVersion,
  OUT       CHAR16                          **PackageVersionName
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE)(
  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL  *This,
  IN  UINT8                             ImageIndex,
  OUT  VOID                             *Image,
  IN  OUT  UINTN                        *ImageSize
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_IMAGE)(
  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL                 *This,
  IN  UINT8                                            ImageIndex,
  IN  CONST VOID                                       *Image,
  IN  UINTN                                            ImageSize,
  IN  CONST VOID                                       *VendorCode,
  IN  EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS    Progress,
  OUT CHAR16                                           **AbortReason
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_CHECK_IMAGE)(
  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL  *This,
  IN  UINT8                             ImageIndex,
  IN  CONST VOID                        *Image,
  IN  UINTN                             ImageSize,
  OUT UINT32                            *ImageUpdatable
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_PACKAGE_INFO)(
  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,
  OUT UINT32                           *PackageVersion,
  OUT CHAR16                           **PackageVersionName,
  OUT UINT32                           *PackageVersionNameMaxLen,
  OUT UINT64                           *AttributesSupported,
  OUT UINT64                           *AttributesSetting
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_PACKAGE_INFO)(
  IN  EFI_FIRMWARE_MANAGEMENT_PROTOCOL   *This,
  IN  CONST VOID                         *Image,
  IN  UINTN                              ImageSize,
  IN  CONST VOID                         *VendorCode,
  IN  UINT32                             PackageVersion,
  IN  CONST CHAR16                       *PackageVersionName
  );
 
struct _EFI_FIRMWARE_MANAGEMENT_PROTOCOL {
  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE_INFO      GetImageInfo;
  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE           GetImage;
  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_IMAGE           SetImage;
  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_CHECK_IMAGE         CheckImage;
  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_PACKAGE_INFO    GetPackageInfo;
  EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_PACKAGE_INFO    SetPackageInfo;
};
 
extern EFI_GUID  gEfiFirmwareManagementProtocolGuid;
 
#endif