MdePkg: EFI_FIRMWARE_MANAGEMENT_PROTOCOL.CheckImage() Description Update

[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareManagement.h

diff --git a/MdePkg/Include/Protocol/FirmwareManagement.h b/MdePkg/Include/Protocol/FirmwareManagement.h
index 7425d69c078ff2bc2c53be240a5db2041bd830d7..e615573a51bf09bd40f5389ab4353ed181e701c6 100644 (file)
--- a/MdePkg/Include/Protocol/FirmwareManagement.h
+++ b/MdePkg/Include/Protocol/FirmwareManagement.h
@@ -191,7 +191,9 @@ typedef struct {
 //\r
 ///\r
 /// IMAGE_UPDATABLE_VALID indicates SetImage() will accept the new image and update the\r
-/// device with the new image.\r
+/// device with the new image. The version of the new image could be higher or lower than\r
+/// the current image. SetImage VendorCode is optional but can be used for vendor\r
+/// specific action.\r
 ///\r
 #define  IMAGE_UPDATABLE_VALID                     0x0000000000000001\r
 ///\r
@@ -211,6 +213,12 @@ typedef struct {
 /// version downgrade.\r
 ///\r
 #define  IMAGE_UPDATABLE_INVALID_OLD               0x0000000000000008\r
+///\r
+/// IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE indicates SetImage() will accept and update\r
+/// the new image only if a correct VendorCode is provided or else image would be\r
+/// rejected and SetImage will return appropriate error.\r
+///\r
+#define IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE     0x0000000000000010\r
 \r
 \r
 //\r