MdePkg FirmwareManagement.h: Fix typo EFI_SECURITY_VIOLATIO

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

diff --git a/MdePkg/Include/Protocol/FirmwareManagement.h b/MdePkg/Include/Protocol/FirmwareManagement.h
index 3fc10b877002e9fcbb1b07a1ed7e326f3bf20700..7c8f1ce65dede9583b6a6d92393a1b2aa1ea0ede 100644 (file)
--- a/MdePkg/Include/Protocol/FirmwareManagement.h
+++ b/MdePkg/Include/Protocol/FirmwareManagement.h
@@ -8,11 +8,11 @@
   CheckImage(), GetPackageInfo(), and SetPackageInfo() shall return\r
   EFI_UNSUPPORTED if not supported by the driver.\r
 \r
-  Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
   Copyright (c) 2013 - 2014, Hewlett-Packard Development Company, L.P.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution. The full text of the license may be found at\r
+  which accompanies this distribution.  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
@@ -154,6 +154,7 @@ typedef struct {
 //\r
 // Image Compatibility Definitions\r
 //\r
+///\r
 /// Values from 0x0000000000000002 thru 0x000000000000FFFF are reserved for future assignments.\r
 /// Values from 0x0000000000010000 thru 0xFFFFFFFFFFFFFFFF are used by firmware vendor for\r
 /// compatibility check.\r
@@ -167,7 +168,7 @@ typedef struct {
 \r
 \r
 ///\r
-/// Image Attribute -Authentication Required\r
+/// Image Attribute - Authentication Required\r
 ///\r
 typedef struct {\r
   ///\r
@@ -191,7 +192,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 +214,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
@@ -233,7 +242,7 @@ typedef struct {
 #define  PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004\r
 \r
 /**\r
-  Callback funtion to report the process of the firmware updating.\r
+  Callback function to report the process of the firmware updating.\r
 \r
   @param[in]  Completion    A value between 1 and 100 indicating the current completion\r
                             progress of the firmware update. Completion progress is\r
@@ -322,7 +331,7 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER  The Image was NULL.\r
   @retval EFI_NOT_FOUND          The current image is not copied to the buffer.\r
   @retval EFI_UNSUPPORTED        The operation is not supported.\r
-  @retval EFI_SECURITY_VIOLATIO  The operation could not be performed due to an authentication failure.\r
+  @retval EFI_SECURITY_VIOLATION The operation could not be performed due to an authentication failure.\r
 \r
 **/\r
 typedef\r
@@ -377,7 +386,7 @@ EFI_STATUS
   @retval EFI_ABORTED            The operation is aborted.\r
   @retval EFI_INVALID_PARAMETER  The Image was NULL.\r
   @retval EFI_UNSUPPORTED        The operation is not supported.\r
-  @retval EFI_SECURITY_VIOLATIO  The operation could not be performed due to an authentication failure.\r
+  @retval EFI_SECURITY_VIOLATION The operation could not be performed due to an authentication failure.\r
 \r
 **/\r
 typedef\r
@@ -409,7 +418,7 @@ EFI_STATUS
   @retval EFI_SUCCESS            The image was successfully checked.\r
   @retval EFI_INVALID_PARAMETER  The Image was NULL.\r
   @retval EFI_UNSUPPORTED        The operation is not supported.\r
-  @retval EFI_SECURITY_VIOLATIO  The operation could not be performed due to an authentication failure.\r
+  @retval EFI_SECURITY_VIOLATION The operation could not be performed due to an authentication failure.\r
 \r
 **/\r
 typedef\r
@@ -493,7 +502,7 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER  The PackageVersionName length is longer than the value\r
                                  returned in PackageVersionNameMaxLen.\r
   @retval EFI_UNSUPPORTED        The operation is not supported.\r
-  @retval EFI_SECURITY_VIOLATIO  The operation could not be performed due to an authentication failure.\r
+  @retval EFI_SECURITY_VIOLATION The operation could not be performed due to an authentication failure.\r
 \r
 **/\r
 typedef\r