FmpDevicePkg/FmpDevicePkg.dec

   1 ## @file
   2 # Firmware Management Protocol Device Package
   3 #
   4 # This package provides an implementation of a Firmware Management Protocol
   5 # instance that supports the update of firmware storage devices using UEFI
   6 # Capsules.  The behavior of the Firmware Management Protocol instance is
   7 # customized using libraries and PCDs.
   8 #
   9 # Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>
  10 # Copyright (c) 2018 - 2020, Intel Corporation. All rights reserved.<BR>
  11 #
  12 # SPDX-License-Identifier: BSD-2-Clause-Patent
  13 #
  14 ##
  15
  16 [Defines]
  17   DEC_SPECIFICATION = 0x00010005
  18   PACKAGE_NAME      = FmpDevicePkg
  19   PACKAGE_UNI_FILE  = FmpDevicePkg.uni
  20   PACKAGE_GUID      = 080b5b4f-27c6-11e8-84d1-f8597177a00a
  21   PACKAGE_VERSION   = 0.1
  22
  23 [Includes]
  24   Include
  25
  26 [Includes.Common.Private]
  27   PrivateInclude
  28
  29 [LibraryClasses]
  30   ##  @libraryclass  Provides platform policy services used during a capsule
  31   #                  update.
  32   CapsuleUpdatePolicyLib|Include/Library/CapsuleUpdatePolicyLib.h
  33
  34   ##  @libraryclass  Provides firmware device specific services to support
  35   #                  updates of a firmware image stored in a firmware device.
  36   FmpDeviceLib|Include/Library/FmpDeviceLib.h
  37
  38   ##  @libraryclass  Provides generic services to support capsule dependency
  39   #                  expression evaluation.
  40   FmpDependencyLib|Include/Library/FmpDependencyLib.h
  41
  42 [LibraryClasses.Common.Private]
  43   ##  @libraryclass  Provides services to retrieve values from a capsule's FMP
  44   #                  Payload Header.  The structure is not included in the
  45   #                  library class.  Instead, services are provided to retrieve
  46   #                  information from the FMP Payload Header.  If information is
  47   #                  added to the FMP Payload Header, then new services may be
  48   #                  added to this library class to retrieve the new information.
  49   FmpPayloadHeaderLib|PrivateInclude/Library/FmpPayloadHeaderLib.h
  50
  51 [Guids]
  52   ## Firmware Management Protocol Device Package Token Space GUID
  53   gFmpDevicePkgTokenSpaceGuid = { 0x40b2d964, 0xfe11, 0x40dc, { 0x82, 0x83, 0x2e, 0xfb, 0xda, 0x29, 0x53, 0x56 } }
  54
  55 [Protocols.Common.Private]
  56   ## Capsule Update Policy Protocol
  57   gEdkiiCapsuleUpdatePolicyProtocolGuid = { 0x487784c5, 0x6299, 0x4ba6, { 0xb0, 0x96, 0x5c, 0xc5, 0x27, 0x7c, 0xf7, 0x57 } }
  58
  59 [PcdsFeatureFlag]
  60   ## Indicates if the Firmware Management Protocol supports access to
  61   #  to a firmware storage device.  If set to FALSE, then only GetImageInfo()
  62   #  is supported.  This is used by FMP drivers that require the smallest
  63   #  possible Firmware Management Protocol implementation that supports
  64   #  advertising the updatable firmware device in the ESRT.<BR>
  65   #    TRUE  - All Firmware Management Protocol services supported.<BR>
  66   #    FALSE - Firmware Management Protocol returns EFI_UNSUPPORTED for
  67   #            all services except GetImageInfo().<BR>
  68   # @Prompt Firmware Device Storage Access Enabled.
  69   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceStorageAccessEnable|TRUE|BOOLEAN|0x40000011
  70
  71 [PcdsFixedAtBuild]
  72   ## The SHA-256 hash of a PKCS7 test key that is used to detect if a test key
  73   #  is being used to authenticate capsules.  Test key detection is disabled by
  74   #  setting the value to {0}.
  75   # @Prompt SHA-256 hash of PKCS7 test key.
  76   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
  77
  78 [PcdsFixedAtBuild, PcdsPatchableInModule]
  79   ## The color of the progress bar during a firmware update.  Each firmware
  80   #  device can set its own color.  The default color is white.<BR><BR>
  81   #  Bits  7..0  - Red<BR>
  82   #  Bits 15..8  - Green<BR>
  83   #  Bits 23..16 - Blue<BR>
  84   # @Prompt Firmware Device Progress Bar Color.
  85   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressColor|0x00FFFFFF|UINT32|0x40000004
  86
  87   ## The Null-terminated Unicode string used to fill in the ImageIdName field of
  88   #  the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the
  89   #  GetImageInfo() service of the Firmware Management Protocol for the firmware
  90   #  device.  An ImageIdName string must be provided for each firmware device.
  91   #  The default value is an empty string.
  92   # @Prompt Firmware Device ImageIdName string.
  93   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageIdName|L""|VOID*|0x40000007
  94
  95   ## The build time value used to fill in the LowestSupportedVersion field of
  96   #  the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the
  97   #  GetImageInfo() service of the Firmware Management Protocol.  This value is
  98   #  only used if the firmware device does not provide a method to report the
  99   #  lowest supported version value from the current firmware image and the
 100   #  UEFI variable used to provide the lowest supported version value does not
 101   #  exist.  The default value is 0.
 102   # @Prompt Build Time Firmware Device Lowest Support Version.
 103   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceBuildTimeLowestSupportedVersion|0x0|UINT32|0x4000000C
 104
 105   ## The time in seconds to arm a watchdog timer during the update of a firmware
 106   #  device.  The watchdog is re-armed each time the FmpDeviceLib calls the
 107   #  Progress() function passed into FmpDeviceSetImage() function.  The
 108   #  FmpDeviceLib calls Progress() to update the percent completion of a
 109   #  firmware update.  If the watchdog timer expires, the system reboots.  A
 110   #  value of 0 disables the watchdog timer.  The default value is 0 (watchdog
 111   #  disabled).
 112   # @Prompt Firmware Device Watchdog Time in Seconds.
 113   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressWatchdogTimeInSeconds|0x0|UINT8|0x4000000D
 114
 115   ## The Image Type ID to use if one is not provided by FmpDeviceLib. If this
 116   #  PCD is not a valid GUID value, then gEfiCallerIdGuid is used.
 117   # @Prompt Firmware Device Image Type ID
 118   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageTypeIdGuid|{0}|VOID*|0x40000010
 119
 120 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
 121   ## One or more PKCS7 certificates used to verify a firmware device capsule
 122   #  update image.  Encoded using the Variable-Length Opaque Data format of RFC
 123   #  4506 External Data Representation Standard (XDR).  The default value is
 124   #  empty with 0 certificates.
 125   # @Prompt One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images.
 126   gFmpDevicePkgTokenSpaceGuid.PcdFmpDevicePkcs7CertBufferXdr|{0x0}|VOID*|0x4000000E
 127
 128   ## An event GUID that locks the firmware device when the event is signaled.
 129   #  If this PCD is not a valid GUID value, then the firmware device is locked
 130   #  when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled.  The
 131   #  default value is empty, so by default the firmware device is locked at the
 132   #  end of the DXE phase.
 133   # @Prompt Firmware Device Lock Event GUID.
 134   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceLockEventGuid|{0}|VOID*|0x4000000F
 135
 136 [UserExtensions.TianoCore."ExtraFiles"]
 137   FmpDevicePkgExtra.uni