MdePkg: Deprecate EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS

Mark EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS as deprecated. Also update
some function descriptors accordingly.

Cc: Long Qin <qin.long@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Chao Zhang <chao.b.zhang@intel.com>
Reviewed-by: Long Qin <qin.long@intel.com>

2 files changed, 8 insertions, 8 deletions

diff --git a/MdePkg/Include/Uefi/UefiMultiPhase.h b/MdePkg/Include/Uefi/UefiMultiPhase.h
index 9f1ef3ecb0..0dcbb1b9ee 100644
--- a/MdePkg/Include/Uefi/UefiMultiPhase.h
+++ b/MdePkg/Include/Uefi/UefiMultiPhase.h
@@ -1,7 +1,7 @@
 /** @file

   This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.

 

-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials are licensed and made available under

 the terms and conditions of the BSD License that accompanies this distribution.

 The full text of the license may be found at

@@ -169,10 +169,12 @@ typedef struct {
 ///

 /// Attributes of Authenticated Variable

 ///

-#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS              0x00000010

 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS   0x00000020

 #define EFI_VARIABLE_APPEND_WRITE                            0x00000040

-

+///

+/// NOTE: EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is deprecated and should be considered reserved.

+///

+#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS              0x00000010

 

 ///

 /// AuthInfo is a WIN_CERTIFICATE using the wCertificateType

diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index d394127482..92575aea3f 100644
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -701,8 +701,7 @@ EFI_STATUS
                                  then EFI_INVALID_PARAMETER is returned.

   @param[in]  VendorGuid         A unique identifier for the vendor.

   @param[in]  Attributes         Attributes bitmask to set for the variable.

-  @param[in]  DataSize           The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE, 

-                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or 

+  @param[in]  DataSize           The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE or

                                  EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero 

                                  causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is 

                                  set, then a SetVariable() call with a DataSize of zero will not cause any change to 

@@ -721,9 +720,8 @@ EFI_STATUS
   @retval EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.

   @retval EFI_WRITE_PROTECTED    The variable in question is read-only.

   @retval EFI_WRITE_PROTECTED    The variable in question cannot be deleted.

-  @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 

-                                 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo 

-                                 does NOT pass the validation check carried out by the firmware.

+  @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set,

+                                 but the AuthInfo does NOT pass the validation check carried out by the firmware.

   

   @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.