IntelFrameworkPkg: Replace BSD License with BSD+Patent License

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

diff --git a/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h b/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
index 86d40da1462843cd0fba4841c5ed5409f339994c..d90059792ec7d165cf1cdce0a542df392aeb5fd6 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
+++ b/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
@@ -2,20 +2,14 @@
   This protocol provides some basic services to support publishing ACPI system tables. The\r
   services handle many of the more mundane tasks that are required to publish a set of tables. The\r
   services will:\r
   This protocol provides some basic services to support publishing ACPI system tables. The\r
   services handle many of the more mundane tasks that are required to publish a set of tables. The\r
   services will:\r

-  - Generate common tables.\r
-       - Update the table links.\r
-       - Ensure that tables are properly aligned and use correct types of memory.\r
-       - Update checksum values and IDs.\r
-       - Complete the final installation of the tables.\r
- \r
-  Copyright (c) 2007, 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
+        - Generate common tables.\r
+  - Update the table links.\r
+  - Ensure that tables are properly aligned and use correct types of memory.\r
+  - Update checksum values and IDs.\r
+  - Complete the final installation of the tables.\r
+\r
+Copyright (c) 2007 - 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 ACPI Specification.\r
 \r
   @par Revision Reference:\r
   This Protocol is defined in Framework ACPI Specification.\r


@@ -48,9 +42,9 @@ typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;
 \r
   @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
   @param  Index                 The zero-based index of the table to retrieve.\r
 \r
   @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
   @param  Index                 The zero-based index of the table to retrieve.\r

-  @param  Table                 Pointer for returning the table buffer.\r
+  @param  Table                 The pointer for returning the table buffer.\r

   @param  Version               Updated with the ACPI versions to which this table belongs.\r
   @param  Version               Updated with the ACPI versions to which this table belongs.\r

-  @param  Handle                Pointer for identifying the table.\r
+  @param  Handle                The pointer for identifying the table.\r

 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_FOUND         The requested index is too large and a table was not found.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_FOUND         The requested index is too large and a table was not found.\r


@@ -70,11 +64,11 @@ EFI_STATUS
   Used to add, remove, or update ACPI tables.\r
 \r
   @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
   Used to add, remove, or update ACPI tables.\r
 \r
   @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r

-  @param  Table                 Pointer to the new table to add or update.\r
+  @param  Table                 The pointer to the new table to add or update.\r

   @param  Checksum              If TRUE, indicates that the checksum should be\r
                                 calculated for this table.\r
   @param  Version               Indicates to which version(s) of ACPI the table should be added.\r
   @param  Checksum              If TRUE, indicates that the checksum should be\r
                                 calculated for this table.\r
   @param  Version               Indicates to which version(s) of ACPI the table should be added.\r

-  @param  Handle                Pointer to the handle of the table to remove or update.\r
+  @param  Handle                The pointer to the handle of the table to remove or update.\r

 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.\r


@@ -95,10 +89,10 @@ EFI_STATUS
   Causes one or more versions of the ACPI tables to be published in\r
   the EFI system configuration tables.\r
 \r
   Causes one or more versions of the ACPI tables to be published in\r
   the EFI system configuration tables.\r
 \r

-  The PublishTables() function installs the ACPI tables for the versions that are specified in \r
-  Version. No tables are published for Version equal to EFI_ACPI_VERSION_NONE. Once \r
-  published, tables will continue to be updated as tables are modified with \r
-  EFI_ACPI_SUPPORT_PROTOCOL.SetAcpiTable(). \r
+  The PublishTables() function installs the ACPI tables for the versions that are specified in\r
+  Version. No tables are published for Version equal to EFI_ACPI_VERSION_NONE. Once\r
+  published, tables will continue to be updated as tables are modified with\r
+  EFI_ACPI_SUPPORT_PROTOCOL.SetAcpiTable().\r

 \r
   @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
   @param  Version               Indicates to which version(s) of ACPI the table should be published.\r
 \r
   @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
   @param  Version               Indicates to which version(s) of ACPI the table should be published.\r


@@ -129,7 +123,7 @@ struct _EFI_ACPI_SUPPORT_PROTOCOL {
   EFI_ACPI_GET_ACPI_TABLE GetAcpiTable;\r
 \r
   ///\r
   EFI_ACPI_GET_ACPI_TABLE GetAcpiTable;\r
 \r
   ///\r

-  /// Adds, removes, or updates ACPI tables\r
+  /// Adds, removes, or updates ACPI tables.\r

   ///\r
   EFI_ACPI_SET_ACPI_TABLE SetAcpiTable;\r
 \r
   ///\r
   EFI_ACPI_SET_ACPI_TABLE SetAcpiTable;\r
 \r