]> git.proxmox.com Git - mirror_edk2.git/blobdiff - FmpDevicePkg/FmpDevicePkg.uni
FmpDevicePkg: Add package, library classes, and PCDs
[mirror_edk2.git] / FmpDevicePkg / FmpDevicePkg.uni
diff --git a/FmpDevicePkg/FmpDevicePkg.uni b/FmpDevicePkg/FmpDevicePkg.uni
new file mode 100644 (file)
index 0000000..da31d0a
--- /dev/null
@@ -0,0 +1,80 @@
+// /** @file\r
+// Firmware Management Protocol Device Package\r
+//\r
+// This package provides an implementation of a Firmware Management Protocol\r
+// instance that supports the update of firmware storage devices using UEFI\r
+// Capsules.  The behavior of the Firmware Management Protocol instance is\r
+// customized using libraries and PCDs.\r
+//\r
+// Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r
+//\r
+// This program and the accompanying materials are licensed and made available under\r
+// the terms and conditions of the BSD License which accompanies this distribution.\r
+// The full text of the license may be found at\r
+// http://opensource.org/licenses/bsd-license.php\r
+//\r
+// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+//\r
+// **/\r
+\r
+#string STR_PACKAGE_ABSTRACT     #language en-US  "Firmware Management Protocol Software Development Kit"\r
+\r
+#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
+\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceSystemResetRequired_PROMPT  #language en-US "FMP Device System Reset Required."\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceSystemResetRequired_HELP    #language en-US "Indicates if a full system reset is required before a firmware update to a firmware device takes effect.<BR><BR>\n"\r
+                                                                                                "TRUE  - System reset is required.<BR>\n"\r
+                                                                                                "FALSE - System reset is not required.<BR>"\r
+\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceTestKeySha256Digest_PROMPT  #language en-US "SHA-256 hash of PKCS7 test key."\r
+#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
+                                                                                                "is being used to authenticate capsules.  Test key detection can be disabled"\r
+                                                                                                "by setting the value to {0}"\r
+\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressColor_PROMPT  #language en-US "Firmware Device Progress Bar Color."\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressColor_HELP    #language en-US "The color of the progress bar during a firmware update.  Each firmware"\r
+                                                                                          "device can set its own color.  The default color is white.<BR><BR>\n"\r
+                                                                                          "Bits  7..0  - Red<BR>\n"\r
+                                                                                          "Bits 15..8  - Green<BR>\n"\r
+                                                                                          "Bits 23..16 - Blue<BR>\n"\r
+\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceImageIdName_PROMPT  #language en-US "Firmware Device ImageIdName string."\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceImageIdName_HELP    #language en-US "The Null-terminated Unicode string used to fill in the ImageIdName field of"\r
+                                                                                        "the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the"\r
+                                                                                        "GetImageInfo() service of the Firmware Management Protocol for the firmware"\r
+                                                                                        "device.  An ImageIdName string must be provided for each firmware device."\r
+                                                                                        "The default value is an empty string."\r
+\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceBuildTimeLowestSupportedVersion_PROMPT  #language en-US "Build Time Firmware Device Lowest Support Version."\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceBuildTimeLowestSupportedVersion_HELP    #language en-US "The build time value used to fill in the LowestSupportedVersion field of"\r
+                                                                                                            "the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the"\r
+                                                                                                            "GetImageInfo() service of the Firmware Management Protocol.  This value is"\r
+                                                                                                            "only used if the firmware device does not provide a method to report the"\r
+                                                                                                            "lowest supported version value from the current firmware image and the"\r
+                                                                                                            "UEFI variable used to provide the lowest supported version value does not"\r
+                                                                                                            "exist.  The default value is 0."\r
+\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressWatchdogTimeInSeconds_PROMPT  #language en-US "Firmware Device Watchdog Time in Seconds."\r
+#string STR_gFmpDevicePkgTokenSpaceGuid_PcdFmpDeviceProgressWatchdogTimeInSeconds_HELP    #language en-US "Indicates the time in seconds to arm a watchdog timer during the update of"\r
+                                                                                                          "a firmware device.  The watchdog is re-armed each time the FmpDeviceLib"\r
+                                                                                                          "calls the Progress() function passed into FmpDeviceSetImage() function."\r
+                                                                                                          "The FmpDeviceLib calls Progress() to update the percent completion of a"\r
+                                                                                                          "firmware update.  If the watchdog timer expires, the system reboots.  A"\r
+                                                                                                          "value of 0 disables the watchdog timer.  The default value is 0 (watchdog"\r
+                                                                                                          "disabled)."\r
+\r
+#string STR_gEfiSecurityPkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_PROMPT  #language en-US "One or more XDR encoded PKCS7 certificates used to verify firmware device capsule update images"\r
+#string STR_gEfiSecurityPkgTokenSpaceGuid_PcdFmpDevicePkcs7CertBufferXdr_HELP    #language en-US "Provides one or more PKCS7 certificates used to verify a firmware device"\r
+                                                                                                 "capsule update image.  This PCD is encoded using the Variable-Length Opaque"\r
+                                                                                                 "Data format of RFC 4506 External Data Representation Standard (XDR)."\r
+                                                                                                 "The default value is empty with 0 certificates."\r
+\r
+#string STR_gEfiSecurityPkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_PROMPT  #language en-US "Firmware Device Lock Event GUID."\r
+#string STR_gEfiSecurityPkgTokenSpaceGuid_PcdFmpDeviceLockEventGuid_HELP    #language en-US "An event GUID that locks the firmware device when the event is signaled."\r
+                                                                                            "If this PCD is not a valid GUID value, then the firmware device is locked"\r
+                                                                                            "when gEfiEndOfDxeEventGroupGuid (End of DXE Phase) is signaled.  The"\r
+                                                                                            "default value is empty, so by default the firmware device is locked at the"\r
+                                                                                            "end of the DXE phase."\r
+\r
+\r