FmpDevicePkg: Add FmpDependencyDevice library class and NULL instance

[mirror_edk2.git] / FmpDevicePkg / FmpDevicePkg.dec

## @file\r
# Firmware Management Protocol Device Package\r
#\r
# This package provides an implementation of a Firmware Management Protocol\r
# instance that supports the update of firmware storage devices using UEFI\r
# Capsules.  The behavior of the Firmware Management Protocol instance is\r
# customized using libraries and PCDs.\r
#\r
# Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>\r
# Copyright (c) 2018 - 2020, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
##\r
\r
[Defines]\r
  DEC_SPECIFICATION = 0x00010005\r
  PACKAGE_NAME      = FmpDevicePkg\r
  PACKAGE_UNI_FILE  = FmpDevicePkg.uni\r
  PACKAGE_GUID      = 080b5b4f-27c6-11e8-84d1-f8597177a00a\r
  PACKAGE_VERSION   = 0.1\r
\r
[Includes]\r
  Include\r
\r
[Includes.Common.Private]\r
  PrivateInclude\r
\r
[LibraryClasses]\r
  ##  @libraryclass  Provides platform policy services used during a capsule\r
  #                  update.\r
  CapsuleUpdatePolicyLib|Include/Library/CapsuleUpdatePolicyLib.h\r
\r
  ##  @libraryclass  Provides firmware device specific services to support\r
  #                  updates of a firmware image stored in a firmware device.\r
  FmpDeviceLib|Include/Library/FmpDeviceLib.h\r
\r
  ##  @libraryclass  Provides generic services to support capsule dependency\r
  #                  expression evaluation.\r
  FmpDependencyLib|Include/Library/FmpDependencyLib.h\r
\r
  ##  @libraryclass  Provides platform specific services to support dependency\r
  #                  check during update of firmware image.\r
  FmpDependencyCheckLib|Include/Library/FmpDependencyCheckLib.h\r
\r
  ##  @libraryclass  Provides firmware device specific services to support\r
  #                  saving dependency to firmware device and getting dependency\r
  #                  from firmware device.\r
  FmpDependencyDeviceLib|Include/Library/FmpDependencyDeviceLib.h\r
\r
[LibraryClasses.Common.Private]\r
  ##  @libraryclass  Provides services to retrieve values from a capsule's FMP\r
  #                  Payload Header.  The structure is not included in the\r
  #                  library class.  Instead, services are provided to retrieve\r
  #                  information from the FMP Payload Header.  If information is\r
  #                  added to the FMP Payload Header, then new services may be\r
  #                  added to this library class to retrieve the new information.\r
  FmpPayloadHeaderLib|PrivateInclude/Library/FmpPayloadHeaderLib.h\r
\r
[Guids]\r
  ## Firmware Management Protocol Device Package Token Space GUID\r
  gFmpDevicePkgTokenSpaceGuid = { 0x40b2d964, 0xfe11, 0x40dc, { 0x82, 0x83, 0x2e, 0xfb, 0xda, 0x29, 0x53, 0x56 } }\r
\r
[Protocols.Common.Private]\r
  ## Capsule Update Policy Protocol\r
  gEdkiiCapsuleUpdatePolicyProtocolGuid = { 0x487784c5, 0x6299, 0x4ba6, { 0xb0, 0x96, 0x5c, 0xc5, 0x27, 0x7c, 0xf7, 0x57 } }\r
\r
[PcdsFeatureFlag]\r
  ## Indicates if the Firmware Management Protocol supports access to\r
  #  to a firmware storage device.  If set to FALSE, then only GetImageInfo()\r
  #  is supported.  This is used by FMP drivers that require the smallest\r
  #  possible Firmware Management Protocol implementation that supports\r
  #  advertising the updatable firmware device in the ESRT.<BR>\r
  #    TRUE  - All Firmware Management Protocol services supported.<BR>\r
  #    FALSE - Firmware Management Protocol returns EFI_UNSUPPORTED for\r
  #            all services except GetImageInfo().<BR>\r
  # @Prompt Firmware Device Storage Access Enabled.\r
  gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceStorageAccessEnable|TRUE|BOOLEAN|0x40000011\r
\r
[PcdsFixedAtBuild]\r
  ## The SHA-256 hash of a PKCS7 test key that is used to detect if a test key\r
  #  is being used to authenticate capsules.  Test key detection is disabled by\r
  #  setting the value to {0}.\r
  # @Prompt SHA-256 hash of PKCS7 test key.\r
  gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceTestKeySha256Digest|{0x2E, 0x97, 0x89, 0x1B, 0xDB, 0xE7, 0x08, 0xAA,  0x8C, 0xB2, 0x8F, 0xAD, 0x20, 0xA9, 0x83, 0xC7,  0x84, 0x7D, 0x4F, 0xEE, 0x48, 0x25, 0xE9, 0x4D,  0x39, 0xFA, 0x34, 0x9A, 0xB8, 0xB1, 0xC4, 0x26}|VOID*|0x40000009\r
\r
[PcdsFixedAtBuild, PcdsPatchableInModule]\r
  ## The color of the progress bar during a firmware update.  Each firmware\r
  #  device can set its own color.  The default color is white.<BR><BR>\r
  #  Bits  7..0  - Red<BR>\r
  #  Bits 15..8  - Green<BR>\r
  #  Bits 23..16 - Blue<BR>\r
  # @Prompt Firmware Device Progress Bar Color.\r
  gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressColor|0x00FFFFFF|UINT32|0x40000004\r
\r
  ## The Null-terminated Unicode string used to fill in the ImageIdName field of\r
  #  the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the\r
  #  GetImageInfo() service of the Firmware Management Protocol for the firmware\r
  #  device.  An ImageIdName string must be provided for each firmware device.\r
  #  The default value is an empty string.\r
  # @Prompt Firmware Device ImageIdName string.\r
  gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageIdName|L""|VOID*|0x40000007\r
\r
  ## The build time value used to fill in the LowestSupportedVersion field of\r
  #  the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the\r
  #  GetImageInfo() service of the Firmware Management Protocol.  This value is\r
  #  only used if the firmware device does not provide a method to report the\r
  #  lowest supported version value from the current firmware image and the\r
  #  UEFI variable used to provide the lowest supported version value does not\r
  #  exist.  The default value is 0.\r
  # @Prompt Build Time Firmware Device Lowest Support Version.\r
  gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceBuildTimeLowestSupportedVersion|0x0|UINT32|0x4000000C\r
\r
  ## The time in seconds to arm a watchdog timer during the update of a firmware\r
  #  device.  The watchdog is re-armed each time the FmpDeviceLib calls the\r
  #  Progress() function passed into FmpDeviceSetImage() function.  The\r
  #  FmpDeviceLib calls Progress() to update the percent completion of a\r
  #  firmware update.  If the watchdog timer expires, the system reboots.  A\r
  #  value of 0 disables the watchdog timer.  The default value is 0 (watchdog\r
  #  disabled).\r
  # @Prompt Firmware Device Watchdog Time in Seconds.\r
  gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressWatchdogTimeInSeconds|0x0|UINT8|0x4000000D\r
\r
  ## The Image Type ID to use if one is not provided by FmpDeviceLib. If this\r
  #  PCD is not a valid GUID value, then gEfiCallerIdGuid is used.\r
  # @Prompt Firmware Device Image Type ID\r
  gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageTypeIdGuid|{0}|VOID*|0x40000010\r
\r
[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]\r
  ## One or more PKCS7 certificates used to verify a firmware device capsule\r
  #  update image.  Encoded using the Variable-Length Opaque Data format of RFC\r
  #  4506 External Data Representation Standard (XDR).  The default value is\r
  #  empty with 0 certificates.\r
  # @Prompt One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images.\r
  gFmpDevicePkgTokenSpaceGuid.PcdFmpDevicePkcs7CertBufferXdr|{0x0}|VOID*|0x4000000E\r
\r
  ## An event GUID that locks the firmware device when the event is signaled.\r
  #  If this PCD is not a valid GUID value, then the firmware device is locked\r
  #  when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled.  The\r
  #  default value is empty, so by default the firmware device is locked at the\r
  #  end of the DXE phase.\r
  # @Prompt Firmware Device Lock Event GUID.\r
  gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceLockEventGuid|{0}|VOID*|0x4000000F\r
\r
[UserExtensions.TianoCore."ExtraFiles"]\r
  FmpDevicePkgExtra.uni\r