IntelFrameworkPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / AcpiS3Save.h

diff --git a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
index de68e324ee4ec5394ae47d178072b2501ae7957e..67e63270b58416ea3c8abd563b9437490fbac6f3 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
+++ b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
@@ -1,20 +1,14 @@
 /** @file\r
   This protocol is used to prepare all information that is needed for the S3 resume boot path. This\r
   protocol is not required for all platforms.\r
-  \r
-  Copyright (c) 2006 - 2009, 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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Revision Reference:\r
   This Protocol is defined in Framework of S3 Resume Boot Path Spec.\r
   Version 0.9.\r
-  \r
+\r
 **/\r
 \r
 #ifndef _ACPI_S3_SAVE_PROTOCOL_H_\r
@@ -38,14 +32,14 @@ typedef struct _EFI_ACPI_S3_SAVE_PROTOCOL EFI_ACPI_S3_SAVE_PROTOCOL;
 //\r
 \r
 /**\r
-       This function is used to:\r
-  \r
+   This function is used to:\r
+\r
   - Prepare all information that is needed in the S3 resume boot path. This information can include\r
   the following:\r
      -- Framework boot script table\r
      -- RSDT pointer\r
      -- Reserved memory for the S3 resume\r
-     \r
+\r
   - Get the minimum legacy memory length (meaning below 1 MB) that is required for the S3 resume boot path.\r
   If LegacyMemoryAddress is NULL, the firmware will be unable to jump into a real-mode\r
   waking vector. However, it might still be able to jump into a flat-mode waking vector as long as the\r
@@ -59,7 +53,7 @@ typedef struct _EFI_ACPI_S3_SAVE_PROTOCOL EFI_ACPI_S3_SAVE_PROTOCOL;
   @retval EFI_SUCCESS           All information was saved successfully.\r
   @retval EFI_INVALID_PARAMETER The memory range is not located below 1 MB.\r
   @retval EFI_OUT_OF_RESOURCES  Resources were insufficient to save all the information.\r
-  @retval EFI_NOT_FOUND         Some necessary information cannot be found. \r
+  @retval EFI_NOT_FOUND         Some necessary information cannot be found.\r
 \r
 **/\r
 typedef\r
@@ -79,11 +73,11 @@ EFI_STATUS
   scope of this specification.\r
 \r
   @param  This                  A pointer to the EFI_ACPI_S3_SAVE_PROTOCOL instance.\r
-  @param  Size                                                                 The returned size of legacy memory below 1MB.\r
+  @param  Size       The returned size of legacy memory below 1MB.\r
 \r
-  @retval EFI_SUCCESS           Size is successfully returned.\r
+  @retval EFI_SUCCESS           Size was successfully returned.\r
   @retval EFI_INVALID_PARAMETER The pointer Size is NULL.\r
-    \r
+\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -96,11 +90,11 @@ EFI_STATUS
   The EFI_ACPI_S3_SAVE_PROTOCOL is responsible for preparing all the information that the\r
   Framework needs to restore the platform's preboot state during an S3 resume boot. This\r
   information can include the following:\r
-    - The Framework boot script table, containing all necessary operations to initialize the platform\r
-    - ACPI table information, such as RSDT, through which the OS waking vector can be located\r
-    - Range of reserved memory that can be used on the S3 resume boot path\r
+    - The Framework boot script table, containing all necessary operations to initialize the platform.\r
+    - ACPI table information, such as RSDT, through which the OS waking vector can be located.\r
+    - The range of reserved memory that can be used on the S3 resume boot path.\r
   This protocol can be used after the Framework makes sure that the boot process is complete and\r
-  that no hardware has been left unconfigured. Where to call this protocol to save information is implementation-specific. \r
+  that no hardware has been left unconfigured. Where to call this protocol to save information is implementation-specific.\r
   In the case of an EFI-aware OS, ExitBootServices() can be a choice to provide this hook.\r
   The currently executing EFI OS loader image calls ExitBootServices()to terminate all boot\r
   services. After ExitBootServices() successfully completes, the loader becomes responsible\r
@@ -116,7 +110,7 @@ struct _EFI_ACPI_S3_SAVE_PROTOCOL {
   /// Gets the size of legacy memory below 1 MB that is required for S3 resume.\r
   ///\r
   EFI_ACPI_GET_LEGACY_MEMORY_SIZE   GetLegacyMemorySize;\r
-  \r
+\r
   ///\r
   /// Prepare all information for an S3 resume.\r
   ///\r