MdePkg: Clean up source files

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

diff --git a/MdePkg/Include/Protocol/VariableWrite.h b/MdePkg/Include/Protocol/VariableWrite.h
index 8c21df54f1e13e4d740590408ef6cad9b2994e19..1e55b2fc54ef89067a16b6b5c79f17f10da3a9b9 100644 (file)
--- a/MdePkg/Include/Protocol/VariableWrite.h
+++ b/MdePkg/Include/Protocol/VariableWrite.h
@@ -1,38 +1,45 @@
 /** @file\r
-  Variable Write Architectural Protocol as defined in the DXE CIS\r
-\r
-  This code is used to produce the EFI 1.0 runtime variable services\r
-\r
-  The SetVariable () EFI 1.0 services may be updated to the EFI system table and the \r
-  EFI_VARIABLE_WRITE_ARCH_PROTOCOL_GUID protocol is registered with a NULL pointer.\r
-\r
-  No CRC of the EFI system table is required, as it is done in the DXE core.\r
-\r
-  Copyright (c) 2006, Intel Corporation                                                         \r
-  All rights reserved. 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
-  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
-  Module Name:  VariableWrite.h\r
-\r
-  @par Revision Reference:\r
-  Version 0.91B.\r
+  Variable Write Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
+\r
+  This provides the services required to set nonvolatile environment variables.\r
+  This protocol must be produced by a runtime DXE driver and may be consumed only\r
+  by the DXE Foundation.\r
+\r
+  The DXE driver that produces this protocol must be a runtime driver. This driver\r
+  may update the SetVariable() field of the UEFI Runtime Services Table.\r
+\r
+  After the UEFI Runtime Services Table has been initialized, the driver must\r
+  install the EFI_VARIABLE_WRITE_ARCH_PROTOCOL_GUID on a new handle with a NULL\r
+  interface pointer. The installation of this protocol informs the DXE Foundation\r
+  that the write services for nonvolatile environment variables are now available\r
+  and that the DXE Foundation must update the 32-bit CRC of the UEFI Runtime Services\r
+  Table. The full complement of environment variable services are not available\r
+  until both this protocol and EFI_VARIABLE_ARCH_PROTOCOL are installed. DXE drivers\r
+  that require read-only access or read/write access to volatile environment variables\r
+  must have the EFI_VARIABLE_WRITE_ARCH_PROTOCOL in their dependency expressions.\r
+  DXE drivers that require write access to nonvolatile environment variables must\r
+  have this architectural protocol in their dependency expressions.\r
+\r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<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
+  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
 #ifndef __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__\r
 #define __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__\r
 \r
-//\r
-// Global ID for the Variable Write Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Variable Write Architectural Protocol\r
+///\r
 #define EFI_VARIABLE_WRITE_ARCH_PROTOCOL_GUID \\r
   { 0x6441f818, 0x6362, 0x4e44, {0xb5, 0x70, 0x7d, 0xba, 0x31, 0xdd, 0x24, 0x53 } }\r
 \r
 extern EFI_GUID gEfiVariableWriteArchProtocolGuid;\r
 \r
-#endif \r
+#endif\r