FmpDevicePkg.dec 5.6 KB

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