MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / FaultTolerantWrite.h

diff --git a/MdeModulePkg/Include/Protocol/FaultTolerantWrite.h b/MdeModulePkg/Include/Protocol/FaultTolerantWrite.h
index 6767d65a9aef004017db045f1e55e0ac681fbb38..cf7026169fdaa9f794aed7063994884f05936a68 100644 (file)
--- a/MdeModulePkg/Include/Protocol/FaultTolerantWrite.h
+++ b/MdeModulePkg/Include/Protocol/FaultTolerantWrite.h
@@ -1,17 +1,11 @@
 /** @file\r
-Fault Tolerant Write protocol provides boot-time service for fault tolerant \r
-write capability for block devices.  The protocol provides for non-volatile \r
-storage of the intermediate data and private information a caller would need to \r
-recover from a critical fault, such as a power failure.   \r
-\r
-Copyright (c) 2009 - 2010, 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
+  Fault Tolerant Write protocol provides boot-time service for fault tolerant\r
+  write capability for block devices.  The protocol provides for non-volatile\r
+  storage of the intermediate data and private information a caller would need to\r
+  recover from a critical fault, such as a power failure.\r
+\r
+Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -36,7 +30,7 @@ typedef struct _EFI_FAULT_TOLERANT_WRITE_PROTOCOL  EFI_FAULT_TOLERANT_WRITE_PROT
                                updated to indicate the size of the largest block\r
                                that can be updated.\r
 \r
-  @retval EFI_SUCCESS          The function completed successfully\r
+  @retval EFI_SUCCESS          The function completed successfully.\r
   @retval EFI_ABORTED          The function could not complete successfully.\r
 \r
 **/\r
@@ -83,7 +77,7 @@ EFI_STATUS
   manner, ensuring at all times that either the original contents or\r
   the modified contents are available.\r
 \r
-  @param  This                 Calling context\r
+  @param  This                 The calling context.\r
   @param  Lba                  The logical block address of the target block.\r
   @param  Offset               The offset within the target block to place the\r
                                data.\r
@@ -95,7 +89,7 @@ EFI_STATUS
                                for reading, writing, and erasing the target block.\r
   @param  Buffer               The data to write.\r
 \r
-  @retval EFI_SUCCESS          The function completed successfully\r
+  @retval EFI_SUCCESS          The function completed successfully.\r
   @retval EFI_ABORTED          The function could not complete successfully.\r
   @retval EFI_BAD_BUFFER_SIZE  The write would span a block boundary, which is not\r
                                a valid action.\r
@@ -120,11 +114,11 @@ EFI_STATUS
   Restarts a previously interrupted write. The caller must provide the\r
   block protocol needed to complete the interrupted write.\r
 \r
-  @param  This                 Calling context.\r
-  @param  FvBlockProtocol      The handle of FVB protocol that provides services\r
+  @param  This                 The calling context.\r
+  @param  FvBlockProtocol      The handle of FVB protocol that provides services.\r
                                for reading, writing, and erasing the target block.\r
 \r
-  @retval EFI_SUCCESS          The function completed successfully\r
+  @retval EFI_SUCCESS          The function completed successfully.\r
   @retval EFI_ABORTED          The function could not complete successfully.\r
   @retval EFI_ACCESS_DENIED    No pending writes exist.\r
 \r
@@ -139,9 +133,9 @@ EFI_STATUS
 /**\r
   Aborts all previously allocated writes.\r
 \r
-  @param  This                 Calling context\r
+  @param  This                 The calling context.\r
 \r
-  @retval EFI_SUCCESS          The function completed successfully\r
+  @retval EFI_SUCCESS          The function completed successfully.\r
   @retval EFI_ABORTED          The function could not complete successfully.\r
   @retval EFI_NOT_FOUND        No allocated writes exist.\r
 \r
@@ -154,7 +148,7 @@ EFI_STATUS
 \r
 /**\r
   Starts a target block update. This function records information about the write\r
-  in fault tolerant storage and completes the write in a recoverable\r
+  in fault-tolerant storage and completes the write in a recoverable\r
   manner, ensuring at all times that either the original contents or\r
   the modified contents are available.\r
 \r
@@ -172,7 +166,7 @@ EFI_STATUS
   @param  Complete             A Boolean value with TRUE indicating that the write\r
                                was completed.\r
 \r
-  @retval EFI_SUCCESS          The function completed successfully\r
+  @retval EFI_SUCCESS          The function completed successfully.\r
   @retval EFI_ABORTED          The function could not complete successfully.\r
   @retval EFI_NOT_FOUND        No allocated writes exist.\r
 \r