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, 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 [LibraryClasses]
  27   ##  @libraryclass  Provides services to retrieve values from a capsule's FMP
  28   #                  Payload Header.  The structure is not included in the
  29   #                  library class.  Instead, services are provided to retrieve
  30   #                  information from the FMP Payload Header.  If information is
  31   #                  added to the FMP Payload Header, then new services may be
  32   #                  added to this library class to retrieve the new information.
  33   FmpPayloadHeaderLib|Include/Library/FmpPayloadHeaderLib.h
  34
  35   ##  @libraryclass  Provides platform policy services used during a capsule
  36   #                  update.
  37   CapsuleUpdatePolicyLib|Include/Library/CapsuleUpdatePolicyLib.h
  38
  39   ##  @libraryclass  Provides firmware device specific services to support
  40   #                  updates of a firmware image stored in a firmware device.
  41   FmpDeviceLib|Include/Library/FmpDeviceLib.h
  42
  43 [Guids]
  44   ## Firmware Management Protocol Device Package Token Space GUID
  45   gFmpDevicePkgTokenSpaceGuid = { 0x40b2d964, 0xfe11, 0x40dc, { 0x82, 0x83, 0x2e, 0xfb, 0xda, 0x29, 0x53, 0x56 } }
  46
  47 [PcdsFixedAtBuild]
  48   ## The SHA-256 hash of a PKCS7 test key that is used to detect if a test key
  49   #  is being used to authenticate capsules.  Test key detection is disabled by
  50   #  setting the value to {0}.
  51   # @Prompt SHA-256 hash of PKCS7 test key.
  52   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
  53
  54 [PcdsFixedAtBuild, PcdsPatchableInModule]
  55   ## The color of the progress bar during a firmware update.  Each firmware
  56   #  device can set its own color.  The default color is white.<BR><BR>
  57   #  Bits  7..0  - Red<BR>
  58   #  Bits 15..8  - Green<BR>
  59   #  Bits 23..16 - Blue<BR>
  60   # @Prompt Firmware Device Progress Bar Color.
  61   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressColor|0x00FFFFFF|UINT32|0x40000004
  62
  63   ## The Null-terminated Unicode string used to fill in the ImageIdName field of
  64   #  the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the
  65   #  GetImageInfo() service of the Firmware Management Protocol for the firmware
  66   #  device.  An ImageIdName string must be provided for each firmware device.
  67   #  The default value is an empty string.
  68   # @Prompt Firmware Device ImageIdName string.
  69   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageIdName|L""|VOID*|0x40000007
  70
  71   ## The build time value used to fill in the LowestSupportedVersion field of
  72   #  the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the
  73   #  GetImageInfo() service of the Firmware Management Protocol.  This value is
  74   #  only used if the firmware device does not provide a method to report the
  75   #  lowest supported version value from the current firmware image and the
  76   #  UEFI variable used to provide the lowest supported version value does not
  77   #  exist.  The default value is 0.
  78   # @Prompt Build Time Firmware Device Lowest Support Version.
  79   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceBuildTimeLowestSupportedVersion|0x0|UINT32|0x4000000C
  80
  81   ## The time in seconds to arm a watchdog timer during the update of a firmware
  82   #  device.  The watchdog is re-armed each time the FmpDeviceLib calls the
  83   #  Progress() function passed into FmpDeviceSetImage() function.  The
  84   #  FmpDeviceLib calls Progress() to update the percent completion of a
  85   #  firmware update.  If the watchdog timer expires, the system reboots.  A
  86   #  value of 0 disables the watchdog timer.  The default value is 0 (watchdog
  87   #  disabled).
  88   # @Prompt Firmware Device Watchdog Time in Seconds.
  89   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressWatchdogTimeInSeconds|0x0|UINT8|0x4000000D
  90
  91 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
  92   ## One or more PKCS7 certificates used to verify a firmware device capsule
  93   #  update image.  Encoded using the Variable-Length Opaque Data format of RFC
  94   #  4506 External Data Representation Standard (XDR).  The default value is
  95   #  empty with 0 certificates.
  96   # @Prompt One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images.
  97   gFmpDevicePkgTokenSpaceGuid.PcdFmpDevicePkcs7CertBufferXdr|{0x0}|VOID*|0x4000000E
  98
  99   ## An event GUID that locks the firmware device when the event is signaled.
 100   #  If this PCD is not a valid GUID value, then the firmware device is locked
 101   #  when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled.  The
 102   #  default value is empty, so by default the firmware device is locked at the
 103   #  end of the DXE phase.
 104   # @Prompt Firmware Device Lock Event GUID.
 105   gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceLockEventGuid|{0}|VOID*|0x4000000F
 106
 107 [UserExtensions.TianoCore."ExtraFiles"]
 108   FmpDevicePkgExtra.uni