]>
Commit | Line | Data |
---|---|---|
cec7b8fb KM |
1 | // /** @file\r |
2 | // Firmware Management Protocol Device Package\r | |
3 | //\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 | |
8 | //\r | |
278c3d48 | 9 | // Copyright (c) 2018 - 2019, Intel Corporation. All rights reserved.<BR>\r |
cec7b8fb | 10 | //\r |
bcef758c | 11 | // SPDX-License-Identifier: BSD-2-Clause-Patent\r |
cec7b8fb KM |
12 | //\r |
13 | // **/\r | |
14 | \r | |
15 | #string STR_PACKAGE_ABSTRACT #language en-US "Firmware Management Protocol Software Development Kit"\r | |
16 | \r | |
17 | #string STR_PACKAGE_DESCRIPTION #language en-US "This package provides libraries that support the implementation of a module that produces the Firmware Management Protocol to support the update of a system firmware component."\r | |
18 | \r | |
11d35494 EJ |
19 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceStorageAccessEnable_PROMPT #language en-US "Firmware Device Storage Access Enabled."\r |
20 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceStorageAccessEnable_HELP #language en-US "Indicates if the Firmware Management Protocol supports access to"\r | |
21 | "to a firmware storage device. If set to FALSE, then only GetImageInfo()"\r | |
95d28836 | 22 | "is supported. This is used by FMP drivers that require the smallest"\r |
11d35494 EJ |
23 | "possible Firmware Management Protocol implementation that supports"\r |
24 | "advertising the updatable firmware device in the ESRT.<BR>"\r | |
25 | " TRUE - All Firmware Management Protocol services supported.<BR>"\r | |
26 | " FALSE - Firmware Management Protocol returns EFI_UNSUPPORTED for"\r | |
27 | " all services except GetImageInfo().<BR>"\r | |
28 | \r | |
cec7b8fb KM |
29 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceTestKeySha256Digest_PROMPT #language en-US "SHA-256 hash of PKCS7 test key."\r |
30 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceTestKeySha256Digest_HELP #language en-US "The SHA-256 hash of a PKCS7 test key that is used to detect if a test key"\r | |
31 | "is being used to authenticate capsules. Test key detection can be disabled"\r | |
32 | "by setting the value to {0}"\r | |
33 | \r | |
34 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressColor_PROMPT #language en-US "Firmware Device Progress Bar Color."\r | |
35 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressColor_HELP #language en-US "The color of the progress bar during a firmware update. Each firmware"\r | |
36 | "device can set its own color. The default color is white.<BR><BR>\n"\r | |
37 | "Bits 7..0 - Red<BR>\n"\r | |
38 | "Bits 15..8 - Green<BR>\n"\r | |
39 | "Bits 23..16 - Blue<BR>\n"\r | |
40 | \r | |
41 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceImageIdName_PROMPT #language en-US "Firmware Device ImageIdName string."\r | |
42 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceImageIdName_HELP #language en-US "The Null-terminated Unicode string used to fill in the ImageIdName field of"\r | |
43 | "the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the"\r | |
44 | "GetImageInfo() service of the Firmware Management Protocol for the firmware"\r | |
45 | "device. An ImageIdName string must be provided for each firmware device."\r | |
46 | "The default value is an empty string."\r | |
47 | \r | |
48 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceBuildTimeLowestSupportedVersion_PROMPT #language en-US "Build Time Firmware Device Lowest Support Version."\r | |
49 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceBuildTimeLowestSupportedVersion_HELP #language en-US "The build time value used to fill in the LowestSupportedVersion field of"\r | |
50 | "the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the"\r | |
51 | "GetImageInfo() service of the Firmware Management Protocol. This value is"\r | |
52 | "only used if the firmware device does not provide a method to report the"\r | |
53 | "lowest supported version value from the current firmware image and the"\r | |
54 | "UEFI variable used to provide the lowest supported version value does not"\r | |
55 | "exist. The default value is 0."\r | |
56 | \r | |
57 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressWatchdogTimeInSeconds_PROMPT #language en-US "Firmware Device Watchdog Time in Seconds."\r | |
58 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressWatchdogTimeInSeconds_HELP #language en-US "Indicates the time in seconds to arm a watchdog timer during the update of"\r | |
59 | "a firmware device. The watchdog is re-armed each time the FmpDeviceLib"\r | |
60 | "calls the Progress() function passed into FmpDeviceSetImage() function."\r | |
61 | "The FmpDeviceLib calls Progress() to update the percent completion of a"\r | |
62 | "firmware update. If the watchdog timer expires, the system reboots. A"\r | |
63 | "value of 0 disables the watchdog timer. The default value is 0 (watchdog"\r | |
64 | "disabled)."\r | |
65 | \r | |
278c3d48 EJ |
66 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceImageTypeIdGuid_PROMPT #language en-US "Firmware Device Image Type ID."\r |
67 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceImageTypeIdGuid_HELP #language en-US "The Image Type ID to use if one is not provided by FmpDeviceLib. If this"\r | |
68 | "PCD is not a valid GUID value, then gEfiCallerIdGuid is used."\r | |
69 | \r | |
a6d73269 SZ |
70 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_PROMPT #language en-US "One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images"\r |
71 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_HELP #language en-US "Provides one or more PKCS7 certificates used to verify a firmware device"\r | |
72 | "capsule update image. This PCD is encoded using the Variable-Length Opaque"\r | |
73 | "Data format of RFC 4506 External Data Representation Standard (XDR)."\r | |
74 | "The default value is empty with 0 certificates."\r | |
cec7b8fb | 75 | \r |
a6d73269 SZ |
76 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_PROMPT #language en-US "Firmware Device Lock Event GUID."\r |
77 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_HELP #language en-US "An event GUID that locks the firmware device when the event is signaled."\r | |
78 | "If this PCD is not a valid GUID value, then the firmware device is locked"\r | |
79 | "when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled. The"\r | |
80 | "default value is empty, so by default the firmware device is locked at the"\r | |
81 | "end of the DXE phase."\r | |
cec7b8fb KM |
82 | \r |
83 | \r |