projects / mirror_edk2.git / blame
| 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 | |
| 9 | // Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r | |
| 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 | |
| cec7b8fb KM |
19 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceTestKeySha256Digest_PROMPT #language en-US "SHA-256 hash of PKCS7 test key."\r |
| 20 | #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 | |
| 21 | "is being used to authenticate capsules. Test key detection can be disabled"\r | |
| 22 | "by setting the value to {0}"\r | |
| 23 | \r | |
| 24 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressColor_PROMPT #language en-US "Firmware Device Progress Bar Color."\r | |
| 25 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressColor_HELP #language en-US "The color of the progress bar during a firmware update. Each firmware"\r | |
| 26 | "device can set its own color. The default color is white.<BR><BR>\n"\r | |
| 27 | "Bits 7..0 - Red<BR>\n"\r | |
| 28 | "Bits 15..8 - Green<BR>\n"\r | |
| 29 | "Bits 23..16 - Blue<BR>\n"\r | |
| 30 | \r | |
| 31 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceImageIdName_PROMPT #language en-US "Firmware Device ImageIdName string."\r | |
| 32 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceImageIdName_HELP #language en-US "The Null-terminated Unicode string used to fill in the ImageIdName field of"\r | |
| 33 | "the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the"\r | |
| 34 | "GetImageInfo() service of the Firmware Management Protocol for the firmware"\r | |
| 35 | "device. An ImageIdName string must be provided for each firmware device."\r | |
| 36 | "The default value is an empty string."\r | |
| 37 | \r | |
| 38 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceBuildTimeLowestSupportedVersion_PROMPT #language en-US "Build Time Firmware Device Lowest Support Version."\r | |
| 39 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceBuildTimeLowestSupportedVersion_HELP #language en-US "The build time value used to fill in the LowestSupportedVersion field of"\r | |
| 40 | "the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the"\r | |
| 41 | "GetImageInfo() service of the Firmware Management Protocol. This value is"\r | |
| 42 | "only used if the firmware device does not provide a method to report the"\r | |
| 43 | "lowest supported version value from the current firmware image and the"\r | |
| 44 | "UEFI variable used to provide the lowest supported version value does not"\r | |
| 45 | "exist. The default value is 0."\r | |
| 46 | \r | |
| 47 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressWatchdogTimeInSeconds_PROMPT #language en-US "Firmware Device Watchdog Time in Seconds."\r | |
| 48 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressWatchdogTimeInSeconds_HELP #language en-US "Indicates the time in seconds to arm a watchdog timer during the update of"\r | |
| 49 | "a firmware device. The watchdog is re-armed each time the FmpDeviceLib"\r | |
| 50 | "calls the Progress() function passed into FmpDeviceSetImage() function."\r | |
| 51 | "The FmpDeviceLib calls Progress() to update the percent completion of a"\r | |
| 52 | "firmware update. If the watchdog timer expires, the system reboots. A"\r | |
| 53 | "value of 0 disables the watchdog timer. The default value is 0 (watchdog"\r | |
| 54 | "disabled)."\r | |
| 55 | \r | |
| a6d73269 SZ |
56 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_PROMPT #language en-US "One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images"\r |
| 57 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_HELP #language en-US "Provides one or more PKCS7 certificates used to verify a firmware device"\r | |
| 58 | "capsule update image. This PCD is encoded using the Variable-Length Opaque"\r | |
| 59 | "Data format of RFC 4506 External Data Representation Standard (XDR)."\r | |
| 60 | "The default value is empty with 0 certificates."\r | |
| cec7b8fb | 61 | \r |
| a6d73269 SZ |
62 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_PROMPT #language en-US "Firmware Device Lock Event GUID."\r |
| 63 | #string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_HELP #language en-US "An event GUID that locks the firmware device when the event is signaled."\r | |
| 64 | "If this PCD is not a valid GUID value, then the firmware device is locked"\r | |
| 65 | "when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled. The"\r | |
| 66 | "default value is empty, so by default the firmware device is locked at the"\r | |
| 67 | "end of the DXE phase."\r | |
| cec7b8fb KM |
68 | \r |
| 69 | \r |