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
2008-04-08 06:29:25 +00:00 · 2008-04-08 06:29:25 +00:00 · 4a71b21a63
parent f42be64210
commit 4a71b21a63
16 changed files with 79 additions and 39 deletions
--- a/IntelFrameworkPkg/Include/Framework/DataHubRecords.h
+++ b/IntelFrameworkPkg/Include/Framework/DataHubRecords.h
@ -1,4 +1,4 @@
-  /** @file
+/** @file
  This file defines GUIDs and associated data structures for records posted to the Data Hub.
  The producers of these records use these definitions to construct records.
  The consumers of these records use these definitions to retrieve, filter and parse records.
--- a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h
+++ b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h
@ -21,8 +21,6 @@
 #ifndef __FRAMEWORK_INTERNAL_FORMREPRESENTATION_H__
 #define __FRAMEWORK_INTERNAL_FORMREPRESENTATION_H__

-
-
 //
 // IFR Op codes
 //
--- a/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h
+++ b/IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h
@ -1,6 +1,11 @@
 /** @file
-  Public include file for the HII Library
-
+  Library class name: FrameworkHiiLib.
+  
+  FrameworkHiiLib is designed for produce interfaces to access
+  framework HII things. It firstly also produce all interfaces define
+  in HiiLib library class in MdePkg/Include/HiiLib.h. It also produce
+  framework's old interface PreparePackages to keep compatiblity.
+     
  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         
@ -10,8 +15,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:  HiiLib.h
-
 **/

 #ifndef __FRAMEWORK_HII_LIB_H__
@ -34,8 +37,7 @@
  @param  NumberOfPackages The number of HII packages to prepare.
  @param  Guid Package GUID.

-  @return
-  The allocated and initialized packages.
+  @return The allocated and initialized packages.

 **/
 EFI_HII_PACKAGES *
--- a/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h
+++ b/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h
@ -1,5 +1,9 @@
 /** @file
+  Library class name: FrameworkIfrSupportLib

+  FrameworkIfrSupportLib is designed for produce IFR operation interface .
+  The IFR format follows framework specification.
+  
 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,14 +13,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:
-
-  IfrSupportLib.h
-
-Abstract:
-
-  The file contain all library function for Ifr Operations.
-
 **/

 #ifndef _IFRSUPPORTLIBRARY_H
--- a/IntelFrameworkPkg/Include/Library/SmmLib.h
+++ b/IntelFrameworkPkg/Include/Library/SmmLib.h
@ -1,4 +1,6 @@
 /** @file
+  Library class name: SmmLib
+  
  SMM Library Services that abstracts both S/W SMI generation and detection. 

  Copyright (c) 2007, Intel Corporation                                                         
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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_
--- 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.