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