FmpDevicePkg FmpDxe: Use Attributes to know whether reset is required
[mirror_edk2.git] / 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 # Redistribution and use in source and binary forms, with or without
13 # modification, are permitted provided that the following conditions are met:
14 # 1. Redistributions of source code must retain the above copyright notice,
15 # this list of conditions and the following disclaimer.
16 # 2. Redistributions in binary form must reproduce the above copyright notice,
17 # this list of conditions and the following disclaimer in the documentation
18 # and/or other materials provided with the distribution.
19 #
20 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 # IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
24 # INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
28 # OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29 # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #
31 ##
32
33 [Defines]
34 DEC_SPECIFICATION = 0x00010005
35 PACKAGE_NAME = FmpDevicePkg
36 PACKAGE_UNI_FILE = FmpDevicePkg.uni
37 PACKAGE_GUID = 080b5b4f-27c6-11e8-84d1-f8597177a00a
38 PACKAGE_VERSION = 0.1
39
40 [Includes]
41 Include
42
43 [LibraryClasses]
44 ## @libraryclass Provides services to retrieve values from a capsule's FMP
45 # Payload Header. The structure is not included in the
46 # library class. Instead, services are provided to retrieve
47 # information from the FMP Payload Header. If information is
48 # added to the FMP Payload Header, then new services may be
49 # added to this library class to retrieve the new information.
50 FmpPayloadHeaderLib|Include/Library/FmpPayloadHeaderLib.h
51
52 ## @libraryclass Provides platform policy services used during a capsule
53 # update.
54 CapsuleUpdatePolicyLib|Include/Library/CapsuleUpdatePolicyLib.h
55
56 ## @libraryclass Provides firmware device specific services to support
57 # updates of a firmware image stored in a firmware device.
58 FmpDeviceLib|Include/Library/FmpDeviceLib.h
59
60 [Guids]
61 ## Firmware Management Protocol Device Package Token Space GUID
62 gFmpDevicePkgTokenSpaceGuid = { 0x40b2d964, 0xfe11, 0x40dc, { 0x82, 0x83, 0x2e, 0xfb, 0xda, 0x29, 0x53, 0x56 } }
63
64 [PcdsFixedAtBuild]
65 ## The SHA-256 hash of a PKCS7 test key that is used to detect if a test key
66 # is being used to authenticate capsules. Test key detection is disabled by
67 # setting the value to {0}.
68 # @Prompt SHA-256 hash of PKCS7 test key.
69 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
70
71 [PcdsFixedAtBuild, PcdsPatchableInModule]
72 ## The color of the progress bar during a firmware update. Each firmware
73 # device can set its own color. The default color is white.<BR><BR>
74 # Bits 7..0 - Red<BR>
75 # Bits 15..8 - Green<BR>
76 # Bits 23..16 - Blue<BR>
77 # @Prompt Firmware Device Progress Bar Color.
78 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressColor|0x00FFFFFF|UINT32|0x40000004
79
80 ## The Null-terminated Unicode string used to fill in the ImageIdName field of
81 # the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the
82 # GetImageInfo() service of the Firmware Management Protocol for the firmware
83 # device. An ImageIdName string must be provided for each firmware device.
84 # The default value is an empty string.
85 # @Prompt Firmware Device ImageIdName string.
86 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageIdName|L""|VOID*|0x40000007
87
88 ## The build time value used to fill in the LowestSupportedVersion field of
89 # the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the
90 # GetImageInfo() service of the Firmware Management Protocol. This value is
91 # only used if the firmware device does not provide a method to report the
92 # lowest supported version value from the current firmware image and the
93 # UEFI variable used to provide the lowest supported version value does not
94 # exist. The default value is 0.
95 # @Prompt Build Time Firmware Device Lowest Support Version.
96 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceBuildTimeLowestSupportedVersion|0x0|UINT32|0x4000000C
97
98 ## The time in seconds to arm a watchdog timer during the update of a firmware
99 # device. The watchdog is re-armed each time the FmpDeviceLib calls the
100 # Progress() function passed into FmpDeviceSetImage() function. The
101 # FmpDeviceLib calls Progress() to update the percent completion of a
102 # firmware update. If the watchdog timer expires, the system reboots. A
103 # value of 0 disables the watchdog timer. The default value is 0 (watchdog
104 # disabled).
105 # @Prompt Firmware Device Watchdog Time in Seconds.
106 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceProgressWatchdogTimeInSeconds|0x0|UINT8|0x4000000D
107
108 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
109 ## One or more PKCS7 certificates used to verify a firmware device capsule
110 # update image. Encoded using the Variable-Length Opaque Data format of RFC
111 # 4506 External Data Representation Standard (XDR). The default value is
112 # empty with 0 certificates.
113 # @Prompt One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images.
114 gFmpDevicePkgTokenSpaceGuid.PcdFmpDevicePkcs7CertBufferXdr|{0x0}|VOID*|0x4000000E
115
116 ## An event GUID that locks the firmware device when the event is signaled.
117 # If this PCD is not a valid GUID value, then the firmware device is locked
118 # when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled. The
119 # default value is empty, so by default the firmware device is locked at the
120 # end of the DXE phase.
121 # @Prompt Firmware Device Lock Event GUID.
122 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceLockEventGuid|{0}|VOID*|0x4000000F
123
124 [UserExtensions.TianoCore."ExtraFiles"]
125 FmpDevicePkgExtra.uni