FmpDevicePkg/FmpDxe: Different variable for each FMP Descriptor
[mirror_edk2.git] / FmpDevicePkg / FmpDevicePkg.dec
1## @file\r
2# Firmware Management Protocol Device Package\r
4# This package provides an implementation of a Firmware Management Protocol\r
5# instance that supports the update of firmware storage devices using UEFI\r
6# Capsules. The behavior of the Firmware Management Protocol instance is\r
7# customized using libraries and PCDs.\r
9# Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>\r
10# Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r
bcef758c 12# SPDX-License-Identifier: BSD-2-Clause-Patent\r
17 DEC_SPECIFICATION = 0x00010005\r
18 PACKAGE_NAME = FmpDevicePkg\r
19 PACKAGE_UNI_FILE = FmpDevicePkg.uni\r
20 PACKAGE_GUID = 080b5b4f-27c6-11e8-84d1-f8597177a00a\r
24 Include\r
27 ## @libraryclass Provides services to retrieve values from a capsule's FMP\r
28 # Payload Header. The structure is not included in the\r
29 # library class. Instead, services are provided to retrieve\r
30 # information from the FMP Payload Header. If information is\r
31 # added to the FMP Payload Header, then new services may be\r
32 # added to this library class to retrieve the new information.\r
33 FmpPayloadHeaderLib|Include/Library/FmpPayloadHeaderLib.h\r
35 ## @libraryclass Provides platform policy services used during a capsule\r
36 # update.\r
37 CapsuleUpdatePolicyLib|Include/Library/CapsuleUpdatePolicyLib.h\r
39 ## @libraryclass Provides firmware device specific services to support\r
40 # updates of a firmware image stored in a firmware device.\r
41 FmpDeviceLib|Include/Library/FmpDeviceLib.h\r
44 ## Firmware Management Protocol Device Package Token Space GUID\r
45 gFmpDevicePkgTokenSpaceGuid = { 0x40b2d964, 0xfe11, 0x40dc, { 0x82, 0x83, 0x2e, 0xfb, 0xda, 0x29, 0x53, 0x56 } }\r
48 ## The SHA-256 hash of a PKCS7 test key that is used to detect if a test key\r
49 # is being used to authenticate capsules. Test key detection is disabled by\r
50 # setting the value to {0}.\r
51 # @Prompt SHA-256 hash of PKCS7 test key.\r
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\r
54[PcdsFixedAtBuild, PcdsPatchableInModule]\r
55 ## The color of the progress bar during a firmware update. Each firmware\r
56 # device can set its own color. The default color is white.<BR><BR>\r
57 # Bits 7..0 - Red<BR>\r
58 # Bits 15..8 - Green<BR>\r
59 # Bits 23..16 - Blue<BR>\r
60 # @Prompt Firmware Device Progress Bar Color.\r
61 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressColor|0x00FFFFFF|UINT32|0x40000004\r
63 ## The Null-terminated Unicode string used to fill in the ImageIdName field of\r
64 # the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the\r
65 # GetImageInfo() service of the Firmware Management Protocol for the firmware\r
66 # device. An ImageIdName string must be provided for each firmware device.\r
67 # The default value is an empty string.\r
68 # @Prompt Firmware Device ImageIdName string.\r
69 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageIdName|L""|VOID*|0x40000007\r
71 ## The build time value used to fill in the LowestSupportedVersion field of\r
72 # the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the\r
73 # GetImageInfo() service of the Firmware Management Protocol. This value is\r
74 # only used if the firmware device does not provide a method to report the\r
75 # lowest supported version value from the current firmware image and the\r
76 # UEFI variable used to provide the lowest supported version value does not\r
77 # exist. The default value is 0.\r
78 # @Prompt Build Time Firmware Device Lowest Support Version.\r
79 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceBuildTimeLowestSupportedVersion|0x0|UINT32|0x4000000C\r
81 ## The time in seconds to arm a watchdog timer during the update of a firmware\r
82 # device. The watchdog is re-armed each time the FmpDeviceLib calls the\r
83 # Progress() function passed into FmpDeviceSetImage() function. The\r
84 # FmpDeviceLib calls Progress() to update the percent completion of a\r
85 # firmware update. If the watchdog timer expires, the system reboots. A\r
86 # value of 0 disables the watchdog timer. The default value is 0 (watchdog\r
87 # disabled).\r
88 # @Prompt Firmware Device Watchdog Time in Seconds.\r
89 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressWatchdogTimeInSeconds|0x0|UINT8|0x4000000D\r
91[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]\r
92 ## One or more PKCS7 certificates used to verify a firmware device capsule\r
93 # update image. Encoded using the Variable-Length Opaque Data format of RFC\r
94 # 4506 External Data Representation Standard (XDR). The default value is\r
95 # empty with 0 certificates.\r
96 # @Prompt One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images.\r
97 gFmpDevicePkgTokenSpaceGuid.PcdFmpDevicePkcs7CertBufferXdr|{0x0}|VOID*|0x4000000E\r
99 ## An event GUID that locks the firmware device when the event is signaled.\r
100 # If this PCD is not a valid GUID value, then the firmware device is locked\r
101 # when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled. The\r
102 # default value is empty, so by default the firmware device is locked at the\r
103 # end of the DXE phase.\r
104 # @Prompt Firmware Device Lock Event GUID.\r
105 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceLockEventGuid|{0}|VOID*|0x4000000F\r
108 FmpDevicePkgExtra.uni\r