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

8 files changed, 48 insertions, 5 deletions

diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
index 0cb81040be..c98f3821eb 100644
--- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
+++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
@@ -1,6 +1,13 @@
 /** @file

   This file declares Boot Script Executer PPI.

 

+  This PPI is published by a PEIM upon dispatch and provides an execution engine for the

+  Framework boot script. This PEIM should be platform neutral and have no specific knowledge of

+  platform instructions and other information. The ability to interpret the boot script depends on the

+  abundance of other PPIs that are available. For example, if the script requests an SMBus command

+  execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it

+  by issuing the native IA-32 instruction.

+

   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

diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
index 7ed3217134..2139d158bf 100644
--- a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
@@ -1,5 +1,12 @@
 /** @file

   This file declares Device Recovery Module PPI.

+  The interface of this PPI does the following:

+    - Reports the number of recovery DXE capsules that exist on the associated device(s)

+    - Finds the requested firmware binary capsule

+    - Loads that capsule into memory

+  A device can be either a group of devices, such as a block device, or an individual device.T he

+  module determines the internal search order, with capsule number 1 as the highest load priority and

+  number N as the lowest priority.

 

   Copyright (c) 2007, Intel Corporation

   All rights reserved. This program and the accompanying materials

diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index 7c1c65470d..6e6c0873a5 100644
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -1,5 +1,10 @@
 /** @file

   This file declares Read-only Variable Service PPI

+  These services provide a lightweight, read-only variant of the full EFI variable services. The

+  reason that these services are read-only is to reduce the complexity of flash management. Also,

+  some implementation of the PEI may use the same physical flash part for variable and PEIM

+  storage; as such, a write command to certain technologies would alter the contents of the entire part,

+  thus making the in situ PEIM execution not follow the required flow.

 

   Copyright (c) 2006, Intel Corporation

   All rights reserved. This program and the accompanying materials

diff --git a/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
index 02b71837fe..adfe436d5f 100644
--- a/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
@@ -1,5 +1,6 @@
 /** @file

-  This file declares Recovery Module PPI.

+  This file declares Recovery Module PPI. 

+  This PPI is used to find and load the recovery files.

 

   Copyright (c) 2007, Intel Corporation

   All rights reserved. This program and the accompanying materials

diff --git a/IntelFrameworkPkg/Include/Ppi/S3Resume.h b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
index cbb38f5722..b04a62ab79 100644
--- a/IntelFrameworkPkg/Include/Ppi/S3Resume.h
+++ b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
@@ -1,6 +1,22 @@
 /** @file

-  This file declares S3 Resume PPI.

-

+  This file declares S3 Resume PPI which accomplishes the firmware S3 resume boot path

+  and transfers control to OS.

+  

+  This PPI is published by the S3 resume PEIM and can be used on the S3 resume boot path to

+  restore the platform to its preboot configuration and transfer control to OS. The information that is

+  required for an S3 resume can be saved during the normal boot path using

+  EFI_ACPI_S3_SAVE_PROTOCOL. This presaved information can then be restored in the S3

+  resume boot path using EFI_PEI_S3_RESUME_PPI. Architecturally, the S3 resume PEIM is the

+  last PEIM to be dispatched in the S3 resume boot path.

+  Before using this PPI, the caller has to ensure the necessary information for the S3 resume, such as

+  the following, is available for the S3 resume boot path:

+  - EFI_ACPI_S3_RESUME_SCRIPT_TABLE script table. Type

+    EFI_ACPI_S3_RESUME_SCRIPT_TABLE is defined in the Intel® Platform Innovation

+    Framework for EFI Boot Script Specification.

+  - OS waking vector.

+  - The reserved memory range to be used for the S3 resume.

+  Otherwise, the S3 resume boot path may fail.

+  

   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

diff --git a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h b/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
index e872bf78c9..7d2ea98e0a 100644
--- a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
+++ b/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
@@ -1,5 +1,7 @@
 /** @file

   This file declares Section Extraction PPI.

+  This PPI supports encapsulating sections, such as GUIDed sections used to authenticate the file

+  encapsulation of other domain-specific wrapping.

 

   Copyright (c) 2006, Intel Corporation

   All rights reserved. This program and the accompanying materials

diff --git a/IntelFrameworkPkg/Include/Ppi/Security.h b/IntelFrameworkPkg/Include/Ppi/Security.h
index 4656e57774..8c7adb6fa0 100644
--- a/IntelFrameworkPkg/Include/Ppi/Security.h
+++ b/IntelFrameworkPkg/Include/Ppi/Security.h
@@ -1,6 +1,10 @@
 /** @file

   This file declares Security Architectural PPI.

-

+  

+  This PPI is installed by some platform PEIM that abstracts the security policy to the PEI

+  Foundation, namely the case of a PEIM¡¯s authentication state being returned during the PEI section

+  extraction process.

+  

   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

diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h
index e179d0ceb3..afb2491086 100644
--- a/IntelFrameworkPkg/Include/Ppi/Smbus.h
+++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h
@@ -1,5 +1,6 @@
 /** @file

-  This file declares Smbus PPI.

+  This file declares Smbus PPI which provides the basic I/O interfaces that a PEIM 

+  uses to access its SMBus controller and the slave devices attached to it.

 

   Copyright (c) 2007, Intel Corporation

   All rights reserved. This program and the accompanying materials