MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Ppi / S3Resume2.h

diff --git a/MdePkg/Include/Ppi/S3Resume2.h b/MdePkg/Include/Ppi/S3Resume2.h
index 69d71fa765526b4c1ec5a12482041cf1dbd7cc05..daa855955d024e4cc110b0bb254499c1fcaae9f8 100644 (file)
--- a/MdePkg/Include/Ppi/S3Resume2.h
+++ b/MdePkg/Include/Ppi/S3Resume2.h
@@ -1,23 +1,17 @@
 /** @file\r
   This PPI produces functions to interpret and execute the PI boot script table.\r
-  \r
+\r
   This PPI is published by a PEIM and provides for the restoration of the platform's\r
-  configuration when resuming from the ACPI S3 power state. The ability to execute \r
-  the boot script may depend on the availability of other PPIs. For example, if \r
-  the boot script includes an SMBus command, this PEIM looks for the relevant PPI \r
-  that is able to execute that command.  \r
-  \r
-  Copyright (c) 2010, 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
+  configuration when resuming from the ACPI S3 power state. The ability to execute\r
+  the boot script may depend on the availability of other PPIs. For example, if\r
+  the boot script includes an SMBus command, this PEIM looks for the relevant PPI\r
+  that is able to execute that command.\r
+\r
+  Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Revision Reference:\r
-  This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: \r
+  This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5:\r
   Standards\r
 \r
 **/\r
@@ -42,30 +36,30 @@ typedef struct _EFI_PEI_S3_RESUME2_PPI  EFI_PEI_S3_RESUME2_PPI;
   Restores the platform to its preboot configuration for an S3 resume and\r
   jumps to the OS waking vector.\r
 \r
-  This function will restore the platform to its pre-boot configuration that was \r
+  This function will restore the platform to its pre-boot configuration that was\r
   pre-stored in the boot script table and transfer control to OS waking vector.\r
-  Upon invocation, this function is responsible for locating the following \r
+  Upon invocation, this function is responsible for locating the following\r
   information before jumping to OS waking vector:\r
     - ACPI tables\r
     - boot script table\r
     - any other information that it needs\r
-    \r
-  The S3RestoreConfig() function then executes the pre-stored boot script table \r
-  and transitions the platform to the pre-boot state. The boot script is recorded \r
+\r
+  The S3RestoreConfig() function then executes the pre-stored boot script table\r
+  and transitions the platform to the pre-boot state. The boot script is recorded\r
   during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and\r
-  EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions.  Finally, this function \r
-  transfers control to the OS waking vector. If the OS supports only a real-mode \r
-  waking vector, this function will switch from flat mode to real mode before \r
-  jumping to the waking vector.  If all platform pre-boot configurations are \r
-  successfully restored and all other necessary information is ready, this \r
-  function will never return and instead will directly jump to the OS waking \r
-  vector. If this function returns, it indicates that the attempt to resume \r
-  from the ACPI S3 sleep state failed.  \r
-  \r
+  EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions.  Finally, this function\r
+  transfers control to the OS waking vector. If the OS supports only a real-mode\r
+  waking vector, this function will switch from flat mode to real mode before\r
+  jumping to the waking vector.  If all platform pre-boot configurations are\r
+  successfully restored and all other necessary information is ready, this\r
+  function will never return and instead will directly jump to the OS waking\r
+  vector. If this function returns, it indicates that the attempt to resume\r
+  from the ACPI S3 sleep state failed.\r
+\r
   @param[in] This   Pointer to this instance of the PEI_S3_RESUME_PPI\r
 \r
   @retval EFI_ABORTED     Execution of the S3 resume boot script table failed.\r
-  @retval EFI_NOT_FOUND   Some necessary information that is used for the S3 \r
+  @retval EFI_NOT_FOUND   Some necessary information that is used for the S3\r
                           resume boot path could not be located.\r
 \r
 **/\r