Add more comments for IntelFramework's header files.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5003 6f19259b-4bc3-4df7-8a09-765794883524

3 files changed, 16 insertions, 17 deletions

diff --git a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
index a64ffd4531..0ef70175b6 100644
--- a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
+++ b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
@@ -1,5 +1,8 @@
 /** @file

-

+  This protocol is used to prepare all information that is needed for the S3 resume boot path. This

+  protocol is not required for all platforms.

+  This protocol is defined in framework S3Resume v0.9, page 21.

+  

 Copyright (c) 2006, Intel Corporation

 All rights reserved. This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

@@ -9,13 +12,6 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-Module Name:

-

-  AcpiS3Save.h

-

-Abstract:

-

-

 **/

 

 #ifndef _ACPI_S3_SAVE_PROTOCOL_H

diff --git a/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h b/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
index 8955e8e028..c22f637451 100644
--- a/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
+++ b/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
@@ -1,6 +1,15 @@
 /** @file

-  Definition of the ACPI Support protocol.

+  This protocol provides some basic services to support publishing ACPI system tables. The

+  services handle many of the more mundane tasks that are required to publish a set of tables. The

+  services will do the following:

+  	- Generate common tables.

+	- Update the table links.

+	- Ensure that tables are properly aligned and use correct types of memory.

+	- Update checksum values and IDs.

+	- Complete the final installation of the tables.

 

+  This is defined in the ACPI Specification 0.9.

+  

   Copyright (c) 2007, Intel Corporation

   All rights reserved. This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

@@ -10,11 +19,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-  Module Name:  AcpiSupport.h

-

-  @par Revision Reference:

-  This is defined in the ACPI Specification 0.9.

-

 **/

 

 #ifndef _ACPI_SUPPORT_PROTOCOL_H_

diff --git a/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h b/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
index cb1a9c98af..828cb8c46e 100644
--- a/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
+++ b/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
@@ -1,5 +1,6 @@
 /** @file

-  Definition of the Boot Script Save protocol.

+  This protocol is used to store or record various boot scripts into boot 

+  script tables.

 

   Copyright (c) 2007, Intel Corporation

   All rights reserved. This program and the accompanying materials

@@ -10,8 +11,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-  Module Name:  BootScriptSave.h

-

   @par Revision Reference:

   This protocol defined in the Boot Script Specification, Version 0.91.