Code Scrub for header files in MdePkg/Include/Ppi and Uefi directory.

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

diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h
index ceb1342326986027413084439abd09aa29caf1b9..1cc6e989ba5c7039dbca800deb70590694e28055 100644 (file)
--- a/MdePkg/Include/Ppi/CpuIo.h
+++ b/MdePkg/Include/Ppi/CpuIo.h
@@ -1,7 +1,8 @@
 /** @file\r
 /** @file\r

-  This file declares CPU IO PPI that abstracts CPU IO access\r
+  This PPI provides a set of memory- and I/O-based services. \r
+  The perspective of the services is that of the processor, not the bus or system.\r

 \r
 \r

-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -90,7 +91,7 @@ typedef struct {
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT8\r
+  @return UINT8          An 8-bit value is returned from the I/O space.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -108,7 +109,7 @@ UINT8
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT16\r
+  @return UINT16         A 16-bit value is returned from the I/O space.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -126,7 +127,7 @@ UINT16
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT32\r
+  @return UINT32         A 32-bit value is returned from the I/O space.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -144,7 +145,7 @@ UINT32
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT64\r
+  @return UINT64         A 64-bit value is returned from the I/O space.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -242,7 +243,7 @@ VOID
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT8\r
+  @return UINT8          An 8-bit value is returned from the memory space.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -260,7 +261,7 @@ UINT8
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT16\r
+  @return UINT16         A 16-bit value is returned from the memory space.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -278,7 +279,7 @@ UINT16
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT32\r
+  @return UINT32         A 32-bit value is returned from the memory space.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -296,7 +297,7 @@ UINT32
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT64\r
+  @return UINT64         A 64-bit value is returned from the memory space.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r

diff --git a/MdePkg/Include/Ppi/Decompress.h b/MdePkg/Include/Ppi/Decompress.h
index 51ef963246c7b8d5da584f33cd4c55419ff2ba4a..07623d1c89abb6bb9e32b391661a735042dfbe53 100644 (file)
--- a/MdePkg/Include/Ppi/Decompress.h
+++ b/MdePkg/Include/Ppi/Decompress.h
@@ -1,7 +1,7 @@
 /** @file\r
   Provides decompression services to the PEI Foundatoin.\r
 \r
 /** @file\r
   Provides decompression services to the PEI Foundatoin.\r
 \r

-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -23,7 +23,9 @@
 \r
 typedef struct _EFI_PEI_DECOMPRESS_PPI  EFI_PEI_DECOMPRESS_PPI;\r
 \r
 \r
 typedef struct _EFI_PEI_DECOMPRESS_PPI  EFI_PEI_DECOMPRESS_PPI;\r
 \r

-/**                                                              \r
+/** \r
+  Decompress a single compression section in a firmware file.\r
+                                                               \r

   Decompresses the data in a compressed section and returns it\r
   as a series of standard PI Firmware File Sections. The\r
   required memory is allocated from permanent memory.\r
   Decompresses the data in a compressed section and returns it\r
   as a series of standard PI Firmware File Sections. The\r
   required memory is allocated from permanent memory.\r

diff --git a/MdePkg/Include/Ppi/DxeIpl.h b/MdePkg/Include/Ppi/DxeIpl.h
index c4fb18e22e41b1d986a90035c49c2f03c93d0f45..29c4df51b9d829d7dda5b6c8d706819d4b9c5541 100644 (file)
--- a/MdePkg/Include/Ppi/DxeIpl.h
+++ b/MdePkg/Include/Ppi/DxeIpl.h
@@ -1,8 +1,8 @@
 /** @file\r
   This file declares DXE Initial Program Load PPI.\r
 /** @file\r
   This file declares DXE Initial Program Load PPI.\r

-  When the PEI core is done it calls the DXE IPL via this PPI.\r
+  When the PEI core is done it calls the DXE IPL PPI to load the DXE Foundation.\r

 \r
 \r

-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -35,8 +35,9 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
   @param  PeiServices    Pointer to the PEI Services Table.\r
   @param  HobList        Pointer to the list of Hand-Off Block (HOB) entries.\r
 \r
   @param  PeiServices    Pointer to the PEI Services Table.\r
   @param  HobList        Pointer to the list of Hand-Off Block (HOB) entries.\r
 \r

-  @retval EFI_SUCCESS           Upon this return code, the PEI Foundation should enter\r
-                                some exception handling.Under normal circumstances, the DXE IPL PPI should not return.\r
+  @retval EFI_SUCCESS    Upon this return code, the PEI Foundation should enter\r
+                         some exception handling.Under normal circumstances, \r
+                         the DXE IPL PPI should not return.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r

diff --git a/MdePkg/Include/Ppi/EndOfPeiPhase.h b/MdePkg/Include/Ppi/EndOfPeiPhase.h
index e4c47345574f076eadf4ef92f31f3bf6415a0db1..a5a89b4bb41d8a509c14dd695d6e474ae3ad89e9 100644 (file)
--- a/MdePkg/Include/Ppi/EndOfPeiPhase.h
+++ b/MdePkg/Include/Ppi/EndOfPeiPhase.h
@@ -1,8 +1,10 @@
 /** @file\r
 /** @file\r

-  PPI to be used to signal when the PEI ownership of the memory map\r
-  officially ends and DXE will take over\r
+  This PPI will be installed at the end of PEI for all boot paths, including \r
+  normal, recovery, and S3. It allows for PEIMs to possibly quiesce hardware, \r
+  build handoff information for the next phase of execution, \r
+  or provide some terminal processing behavior.\r

 \r
 \r

-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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

diff --git a/MdePkg/Include/Ppi/FirmwareVolume.h b/MdePkg/Include/Ppi/FirmwareVolume.h
index 81b20db83904878195d1a4bb772317f9490d6c21..2c2a3eaca27eb456a982ea96e505f791b45553a7 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolume.h
+++ b/MdePkg/Include/Ppi/FirmwareVolume.h
@@ -29,6 +29,8 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI   EFI_PEI_FIRMWARE_VOLUME_PPI;
 \r
 \r
 /**\r
 \r
 \r
 /**\r

+  Process a firmware volume and create a volume handle.\r
+\r

   Create a volume handle from the information in the buffer. For\r
   memory-mapped firmware volumes, Buffer and BufferSize refer to\r
   the start of the firmware volume and the firmware volume size.\r
   Create a volume handle from the information in the buffer. For\r
   memory-mapped firmware volumes, Buffer and BufferSize refer to\r
   the start of the firmware volume and the firmware volume size.\r


@@ -60,34 +62,11 @@ EFI_STATUS
   OUT       EFI_PEI_FV_HANDLE           *FvHandle\r
 );\r
 \r
   OUT       EFI_PEI_FV_HANDLE           *FvHandle\r
 );\r
 \r

-\r

 /**\r
 /**\r

-  Create a volume handle from the information in the buffer. For\r
-  memory-mapped firmware volumes, Buffer and BufferSize refer to\r
-  the start of the firmware volume and the firmware volume size.\r
-  For non memory-mapped firmware volumes, this points to a\r
-  buffer which contains the necessary information for creating\r
-  the firmware volume handle. Normally, these values are derived\r
-  from the EFI_FIRMWARE_VOLUME_INFO_PPI.\r
-  \r
-  \r
-  @param This         Points to this instance of the\r
-                      EFI_PEI_FIRMWARE_VOLUME_PPI\r
-  @param Buffer       Points to the start of the buffer.\r
-  @param BufferSize   Size of the buffer.\r
-  @param FvHandle     Points to the returned firmware volume\r
-                      handle. The firmware volume handle must\r
-                      be unique within the system. \r
-\r
-\r
-  @retval EFI_SUCCESS           Firmware volume handle.\r
-  @retval EFI_VOLUME_CORRUPTED  Volume was corrupt.\r
+  Finds the next file of the specified type.\r

 \r
 \r

-**/\r
-\r
-/**\r
-  This service enables PEI modules to discover additional firmware files. The FileHandle must be\r
-  unique within the system.\r
+  This service enables PEI modules to discover additional firmware files. \r
+  The FileHandle must be unique within the system.\r

 \r
   @param This       Points to this instance of the\r
                     EFI_PEI_FIRMWARE_VOLUME_PPI. SearchType A filter\r
 \r
   @param This       Points to this instance of the\r
                     EFI_PEI_FIRMWARE_VOLUME_PPI. SearchType A filter\r


@@ -104,8 +83,7 @@ EFI_STATUS
 \r
 \r
   @retval EFI_SUCCESS   The file was found.\r
 \r
 \r
   @retval EFI_SUCCESS   The file was found.\r

-  @retval EFI_NOT_FOUND The file was not found. FileHandle\r
-                        contains NULL.\r
+  @retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL.\r

 **/ \r
 typedef EFI_STATUS\r
 (EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( \r
 **/ \r
 typedef EFI_STATUS\r
 (EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( \r


@@ -117,7 +95,8 @@ typedef EFI_STATUS
 \r
 \r
 /**\r
 \r
 \r
 /**\r

-   \r
+  Find a file within a volume by its name. \r
+  \r

   This service searches for files with a specific name, within\r
   either the specified firmware volume or all firmware volumes.\r
 \r
   This service searches for files with a specific name, within\r
   either the specified firmware volume or all firmware volumes.\r
 \r


@@ -156,6 +135,8 @@ EFI_STATUS
 \r
 \r
 /**\r
 \r
 \r
 /**\r

+  Returns information about a specific file.\r
+\r

   This function returns information about a specific\r
   file, including its file name, type, attributes, starting\r
   address and size. \r
   This function returns information about a specific\r
   file, including its file name, type, attributes, starting\r
   address and size. \r


@@ -211,6 +192,8 @@ EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_INFO)(
 );\r
 \r
 /**\r
 );\r
 \r
 /**\r

+  Find the next matching section in the firmware file.\r
+  \r

   This service enables PEI modules to discover sections of a given type within a valid file.\r
   \r
   @param This   Points to this instance of the\r
   This service enables PEI modules to discover sections of a given type within a valid file.\r
   \r
   @param This   Points to this instance of the\r

diff --git a/MdePkg/Include/Ppi/GuidedSectionExtraction.h b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
index d4753f9ac4b82f38bf03ede05f9e9a792be28752..360ae951b32939c8b8cda71c0ea19e0f2838bd96 100644 (file)
--- a/MdePkg/Include/Ppi/GuidedSectionExtraction.h
+++ b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
@@ -2,9 +2,9 @@
   If a GUID-defined section is encountered when doing section extraction, \r
   the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance \r
   calls the appropriate instance of the GUIDed Section Extraction PPI \r
   If a GUID-defined section is encountered when doing section extraction, \r
   the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance \r
   calls the appropriate instance of the GUIDed Section Extraction PPI \r

-  to extract the section stream contained therein.. \r
+  to extract the section stream contained therein. \r

 \r
 \r

-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -39,6 +39,9 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI   EFI_PEI_GUIDED_SECTION_E
 \r
 \r
 /**\r
 \r
 \r
 /**\r

+  Processes the input section and returns the data contained therein \r
+  along with the authentication status.\r
+\r

   The ExtractSection() function processes the input section and\r
   returns a pointer to the section contents. If the section being\r
   extracted does not require processing (if the section\r
   The ExtractSection() function processes the input section and\r
   returns a pointer to the section contents. If the section being\r
   extracted does not require processing (if the section\r


@@ -85,7 +88,7 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI   EFI_PEI_GUIDED_SECTION_E
   @retval EFI_OUT_OF_RESOURCES  The system has insufficient\r
                                 resources to process the request.\r
   \r
   @retval EFI_OUT_OF_RESOURCES  The system has insufficient\r
                                 resources to process the request.\r
   \r

-  @reteval EFI_INVALID_PARAMETER The GUID in InputSection does\r
+  @retval EFI_INVALID_PARAMETER The GUID in InputSection does\r

                                 not match this instance of the\r
                                 GUIDed Section Extraction PPI.\r
 **/\r
                                 not match this instance of the\r
                                 GUIDed Section Extraction PPI.\r
 **/\r

diff --git a/MdePkg/Include/Ppi/LoadFile.h b/MdePkg/Include/Ppi/LoadFile.h
index 1e5d7f964b7d10651c8fbdbc89c8f41602086ccb..39ad72ea81cd6042d9849518428a5416d931b210 100644 (file)
--- a/MdePkg/Include/Ppi/LoadFile.h
+++ b/MdePkg/Include/Ppi/LoadFile.h
@@ -25,6 +25,8 @@
 typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;\r
 \r
 /**\r
 typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;\r
 \r
 /**\r

+  Loads a PEIM into memory for subsequent execution.\r
+\r

   This service is the single member function of EFI_LOAD_FILE_PPI. This service separates\r
   image loading and relocating from the PEI Foundation.\r
   \r
   This service is the single member function of EFI_LOAD_FILE_PPI. This service separates\r
   image loading and relocating from the PEI Foundation.\r
   \r


@@ -57,11 +59,9 @@ typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;
   @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r
 \r
   @retval EFI_LOAD_ERROR      There was no supported image in\r
   @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r
 \r
   @retval EFI_LOAD_ERROR      There was no supported image in\r

-                              the file EFI_INVALID_PARAMETER\r
-                              FileHandle was not a valid\r
-                              firmware file handle.\r
+                              the file.\r

   @retval EFI_INVALID_PARAMETER   EntryPoint was NULL.\r
   @retval EFI_INVALID_PARAMETER   EntryPoint was NULL.\r

-\r
+                              Or FileHandle was not a valid firmware file handle.\r

   @retval EFI_NOT_SUPPORTED   An image requires relocations or\r
                               is not memory mapped.\r
    \r
   @retval EFI_NOT_SUPPORTED   An image requires relocations or\r
                               is not memory mapped.\r
    \r

diff --git a/MdePkg/Include/Ppi/MasterBootMode.h b/MdePkg/Include/Ppi/MasterBootMode.h
index 695032f83340532b323725e9c927856bdc87236c..40cf366f3532b3b1ed6dee9b9de45a1b8feee15a 100644 (file)
--- a/MdePkg/Include/Ppi/MasterBootMode.h
+++ b/MdePkg/Include/Ppi/MasterBootMode.h
@@ -1,10 +1,11 @@
 /** @file\r
 /** @file\r

-  This file declares Boot Mode PPI\r
+  This file declares Boot Mode PPI.\r
+\r

   The Master Boot Mode PPI is installed by a PEIM to signal that a final \r
   boot has been determined and set. This signal is useful in that PEIMs \r
   with boot-mode-specific behavior can put this PPI in their dependency expression.\r
 \r
   The Master Boot Mode PPI is installed by a PEIM to signal that a final \r
   boot has been determined and set. This signal is useful in that PEIMs \r
   with boot-mode-specific behavior can put this PPI in their dependency expression.\r
 \r

-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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

diff --git a/MdePkg/Include/Ppi/MemoryDiscovered.h b/MdePkg/Include/Ppi/MemoryDiscovered.h
index ea456bbe8d6693a29d6729f564c704c4f91aab84..38da5a17501cd8823b02c8ecf60ed64ad6f2028c 100644 (file)
--- a/MdePkg/Include/Ppi/MemoryDiscovered.h
+++ b/MdePkg/Include/Ppi/MemoryDiscovered.h
@@ -1,10 +1,11 @@
 /** @file\r
   This file declares Memory Discovered PPI.\r
 /** @file\r
   This file declares Memory Discovered PPI.\r

-  This PPI is installed by the PEI Foundation at the point of system \r
-  evolution when the permanent memory size has been registered and \r
-  waiting PEIMs can use the main memory store. \r

 \r
 \r

-  Copyright (c) 2006, Intel Corporation                                                         \r
+  This PPI is published by the PEI Foundation when the main memory is installed. \r
+  It is essentially a PPI with no associated interface. Its purpose is to be used\r
+  as a signal for other PEIMs who can register for a notification on its installation. \r
+\r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -14,8 +15,8 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r

-  This PPI is defined in PEI CIS\r
-  Version 0.91.\r
+  This PPI is defined in PI\r
+  Version 1.0.\r

 \r
 **/\r
 \r
 \r
 **/\r
 \r

diff --git a/MdePkg/Include/Ppi/PciCfg2.h b/MdePkg/Include/Ppi/PciCfg2.h
index 390ec4be345ba6cc838e2ea1bb3e1d13b0e90644..d44ee09ef00031f9f7f98a2abe9d08c706dfb528 100644 (file)
--- a/MdePkg/Include/Ppi/PciCfg2.h
+++ b/MdePkg/Include/Ppi/PciCfg2.h
@@ -1,7 +1,10 @@
 /** @file\r
 /** @file\r

-  This file declares PciCfg PPI used to access PCI configuration space in PEI\r
+  This file declares PciCfg2 PPI.\r

 \r
 \r

-  Copyright (c) 2006 - 2007, Intel Corporation\r
+  This ppi Provides platform or chipset-specific access to \r
+  the PCI configuration space for a specific PCI segment.\r
+\r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -92,7 +95,8 @@ EFI_STATUS
 \r
 \r
 /**\r
 \r
 \r
 /**\r

-  PCI read-modify-write operation.\r
+  Performs a read-modify-write operation on the contents \r
+  from a given location in the PCI configuration space.\r

 \r
   @param  PeiServices     An indirect pointer to the PEI Services Table\r
                           published by the PEI Foundation.\r
 \r
   @param  PeiServices     An indirect pointer to the PEI Services Table\r
                           published by the PEI Foundation.\r

diff --git a/MdePkg/Include/Ppi/ReadOnlyVariable2.h b/MdePkg/Include/Ppi/ReadOnlyVariable2.h
index 2efd1d03c18adad01d2445c23ec1f2ed3390d10d..eeace52d1ce1e5b561eab9b30df355e790f8b8ee 100644 (file)
--- a/MdePkg/Include/Ppi/ReadOnlyVariable2.h
+++ b/MdePkg/Include/Ppi/ReadOnlyVariable2.h
@@ -1,7 +1,8 @@
 /** @file\r
 /** @file\r

-  This file declares Read-only Variable Service PPI\r
+  This file declares Read-only Variable Service2 PPI.\r
+  This ppi permits read-only access to the UEFI variable store during the PEI phase.\r

 \r
 \r

-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -26,6 +27,8 @@
 typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI  EFI_PEI_READ_ONLY_VARIABLE2_PPI;\r
 \r
 /**\r
 typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI  EFI_PEI_READ_ONLY_VARIABLE2_PPI;\r
 \r
 /**\r

+  This service retrieves a variable's value using its name and GUID.\r
+\r

   Read the specified variable from the UEFI variable store. If the Data \r
   buffer is too small to hold the contents of the variable, \r
   the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the\r
   Read the specified variable from the UEFI variable store. If the Data \r
   buffer is too small to hold the contents of the variable, \r
   the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the\r


@@ -73,6 +76,8 @@ EFI_STATUS
 \r
 \r
 /**\r
 \r
 \r
 /**\r

+  Return the next variable name and GUID.\r
+\r

   This function is called multiple times to retrieve the VariableName \r
   and VariableGuid of all variables currently available in the system. \r
   On each call, the previous results are passed into the interface, \r
   This function is called multiple times to retrieve the VariableName \r
   and VariableGuid of all variables currently available in the system. \r
   On each call, the previous results are passed into the interface, \r

diff --git a/MdePkg/Include/Ppi/Reset.h b/MdePkg/Include/Ppi/Reset.h
index 109f37e5d44788d607a0b357c2191a3d4bed0953..ccefd9679083cd88b9d31ff8768ff2b773572fcf 100644 (file)
--- a/MdePkg/Include/Ppi/Reset.h
+++ b/MdePkg/Include/Ppi/Reset.h
@@ -1,7 +1,10 @@
 /** @file\r
 /** @file\r

-  This file declares Reset PPI used to reset the platform\r
+  This file declares Reset PPI used to reset the platform.\r
+  \r
+  This PPI is installed by some platform- or chipset-specific PEIM that \r
+  abstracts the Reset Service to other agents.\r

 \r
 \r

-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -19,11 +22,20 @@
 #ifndef __RESET_PPI_H__\r
 #define __RESET_PPI_H__\r
 \r
 #ifndef __RESET_PPI_H__\r
 #define __RESET_PPI_H__\r
 \r

+#include <Pi/PiPeiCis.h>\r
+\r

 #define EFI_PEI_RESET_PPI_GUID \\r
   { \\r
     0xef398d58, 0x9dfd, 0x4103, {0xbf, 0x94, 0x78, 0xc6, 0xf4, 0xfe, 0x71, 0x2f } \\r
   }\r
 \r
 #define EFI_PEI_RESET_PPI_GUID \\r
   { \\r
     0xef398d58, 0x9dfd, 0x4103, {0xbf, 0x94, 0x78, 0xc6, 0xf4, 0xfe, 0x71, 0x2f } \\r
   }\r
 \r

+/**\r
+  This PPI provides provide a simple reset service. \r
+\r
+  @param ResetSystem\r
+  A service to reset the entire platform.\r
+\r
+**/\r

 typedef struct {\r
   EFI_PEI_RESET_SYSTEM  ResetSystem;\r
 } EFI_PEI_RESET_PPI;\r
 typedef struct {\r
   EFI_PEI_RESET_SYSTEM  ResetSystem;\r
 } EFI_PEI_RESET_PPI;\r

diff --git a/MdePkg/Include/Ppi/SecPlatformInformation.h b/MdePkg/Include/Ppi/SecPlatformInformation.h
index ef040ec0d059f9e93bf27f29d62b84b8578be257..21783656df227a98b14bcbe9f60e6f04a6208376 100644 (file)
--- a/MdePkg/Include/Ppi/SecPlatformInformation.h
+++ b/MdePkg/Include/Ppi/SecPlatformInformation.h
@@ -1,7 +1,12 @@
 /** @file\r
   This file declares Sec Platform Information PPI.\r
 \r
 /** @file\r
   This file declares Sec Platform Information PPI.\r
 \r

-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  This service is the primary handoff state into the PEI Foundation. \r
+  The Security (SEC) component creates the early, transitory memory \r
+  environment and also encapsulates knowledge of at least the \r
+  location of the Boot Firmware Volume (BFV).\r
+\r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -29,6 +34,8 @@ typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PP
 \r
 //\r
 // EFI_HEALTH_FLAGS\r
 \r
 //\r
 // EFI_HEALTH_FLAGS\r

+// Contains information generated by microcode, hardware, and/or the Itanium\r
+// processor PAL code about the state of the processor upon reset.\r

 //\r
 typedef union {\r
   struct {\r
 //\r
 typedef union {\r
   struct {\r


@@ -44,27 +51,6 @@ typedef union {
   UINT32     Uint32;\r
 } EFI_HEALTH_FLAGS;\r
 \r
   UINT32     Uint32;\r
 } EFI_HEALTH_FLAGS;\r
 \r

-\r
-/**\r
-\r
-  @param BootPhase  entry r20 value.\r
-\r
-  @param UniqueId   PAL arbitration ID.\r
-\r
-  @param HealthStat Health Status\r
-\r
-  @param PALRetAddress  Return address to PAL\r
-   \r
-**/\r
-/*\r
-typedef struct {\r
-  UINTN BootPhase;\r
-  UINTN UniqueId;\r
-  UINTN HealthStat;\r
-  UINTN PALRetAddress;\r
-} IPF_HANDOFF_STATUS;\r
-*/\r
-\r

 #define NORMAL_BOOT_CALL    0x0\r
 #define RECOVERY_CHECK_CALL 0x3\r
 \r
 #define NORMAL_BOOT_CALL    0x0\r
 #define RECOVERY_CHECK_CALL 0x3\r
 \r


@@ -116,9 +102,12 @@ EFI_STATUS
 \r
 \r
 /**\r
 \r
 \r
 /**\r

-  Ppi Description:\r
+  This service abstracts platform-specific information. It is necessary \r
+  to convey this information to the PEI Foundation so that it can \r
+  discover where to begin dispatching PEIMs.\r

 \r
 \r

-  @param Name\r
+  @param PlatformInformation \r
+  Conveys state information out of the SEC phase into PEI.\r

 \r
 **/\r
 struct _EFI_SEC_PLATFORM_INFORMATION_PPI {\r
 \r
 **/\r
 struct _EFI_SEC_PLATFORM_INFORMATION_PPI {\r

diff --git a/MdePkg/Include/Ppi/Security2.h b/MdePkg/Include/Ppi/Security2.h
index f1eafab8d5009d6b2971476203235a75d61c1c44..c39e17381e4e179fae3eced68dd1f1414141f3f5 100644 (file)
--- a/MdePkg/Include/Ppi/Security2.h
+++ b/MdePkg/Include/Ppi/Security2.h
@@ -1,7 +1,11 @@
 /** @file\r
 /** @file\r

-  This file declares Security2 Architectural PPI.\r
+  This file declares Pei Security2 PPI.\r

 \r
 \r

-  Copyright (c) 2006 - 2007, Intel Corporation\r
+  This PPI is installed by some platform PEIM that abstracts the security \r
+  policy to the PEI Foundation, namely the case of a PEIM¡¯s authentication \r
+  state being returned during the PEI section extraction process.\r
+\r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -26,7 +30,9 @@
 typedef struct _EFI_PEI_SECURITY2_PPI  EFI_PEI_SECURITY2_PPI;\r
 \r
 /**\r
 typedef struct _EFI_PEI_SECURITY2_PPI  EFI_PEI_SECURITY2_PPI;\r
 \r
 /**\r

-   \r
+  Allows the platform builder to implement a security policy \r
+  in response to varying file authentication states.\r
+\r

   This service is published by some platform PEIM. The purpose of\r
   this service is to expose a given platform's policy-based\r
   response to the PEI Foundation. For example, if there is a PEIM\r
   This service is published by some platform PEIM. The purpose of\r
   this service is to expose a given platform's policy-based\r
   response to the PEI Foundation. For example, if there is a PEIM\r


@@ -58,6 +64,8 @@ typedef struct _EFI_PEI_SECURITY2_PPI  EFI_PEI_SECURITY2_PPI;
   PEIM being discovered. These latter behaviors are platform-\r
   and market-specific and thus outside the scope of the PEI CIS.\r
 \r
   PEIM being discovered. These latter behaviors are platform-\r
   and market-specific and thus outside the scope of the PEI CIS.\r
 \r

+  @param PeiServices   An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+\r

   @param This   Interface pointer that implements the particular\r
                 EFI_PEI_SECURITY2_PPI instance.\r
 \r
   @param This   Interface pointer that implements the particular\r
                 EFI_PEI_SECURITY2_PPI instance.\r
 \r

diff --git a/MdePkg/Include/Ppi/Smbus2.h b/MdePkg/Include/Ppi/Smbus2.h
index beee06bc8130004069e5b55300a8512b251994b7..e2c375640554a460cd82b39289ee505a77c54c18 100644 (file)
--- a/MdePkg/Include/Ppi/Smbus2.h
+++ b/MdePkg/Include/Ppi/Smbus2.h
@@ -1,7 +1,9 @@
 /** @file\r
   This file declares Smbus2 PPI.\r
 /** @file\r
   This file declares Smbus2 PPI.\r

+  This PPI provides the basic I/O interfaces that a PEIM uses to access its \r
+  SMBus controller and the slave devices attached to it.\r

 \r
 \r

-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -16,8 +18,8 @@
 \r
 **/\r
 \r
 \r
 **/\r
 \r

-#ifndef _PEI_SMBUS2_PPI_H\r
-#define _PEI_SMBUS2_PPI_H\r
+#ifndef __PEI_SMBUS2_PPI_H__\r
+#define __PEI_SMBUS2_PPI_H__\r

 #include <PiPei.h>\r
 #include <IndustryStandard/SmBus.h>\r
 \r
 #include <PiPei.h>\r
 #include <IndustryStandard/SmBus.h>\r
 \r


@@ -34,7 +36,8 @@ typedef UINTN   EFI_SMBUS_DEVICE_COMMAND;
 \r
 \r
 /*\r
 \r
 \r
 /*\r

-  Executes an SMBus operation to an SMBus controller.\r
+  Executes an SMBus operation to an SMBus controller. Returns when either \r
+  the command has been executed or an error is encountered in doing the operation.\r

 \r
   @param  This            A pointer to the EFI_PEI_SMBUS2_PPI instance.\r
   @param  SlaveAddress    The SMBUS hardware address to which the SMBUS device is preassigned or\r
 \r
   @param  This            A pointer to the EFI_PEI_SMBUS2_PPI instance.\r
   @param  SlaveAddress    The SMBUS hardware address to which the SMBUS device is preassigned or\r


@@ -73,7 +76,7 @@ typedef UINTN   EFI_SMBUS_DEVICE_COMMAND;
                                 a failure reflected in the Host Status Register bit.\r
   @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.\r
                                 Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and\r
                                 a failure reflected in the Host Status Register bit.\r
   @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.\r
                                 Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and\r

-                                EfiSmbusQuickWrite. Length is outside the range of valid values.\r
+                                EfiSmbusQuickWrite. Or Length is outside the range of valid values.\r

   @retval EFI_UNSUPPORTED       The SMBus operation or PEC is not supported.\r
   @retval EFI_BUFFER_TOO_SMALL  Buffer is not sufficient for this operation.\r
 \r
   @retval EFI_UNSUPPORTED       The SMBus operation or PEC is not supported.\r
   @retval EFI_BUFFER_TOO_SMALL  Buffer is not sufficient for this operation.\r
 \r


@@ -90,30 +93,11 @@ EFI_STATUS
   IN OUT    VOID                      *Buffer\r
 );\r
 \r
   IN OUT    VOID                      *Buffer\r
 );\r
 \r

-/**\r
-  CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.\r
-\r
-  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  @param  SlaveAddress   The SMBUS hardware address to which the SMBUS\r
-                         device is preassigned or allocated.\r
-  @param  Data           Data of the SMBus host notify command that\r
-                         the caller wants to be called.\r
-\r
-  @return Status Code\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_PEI_SMBUS_NOTIFY2_FUNCTION)(\r
-  IN CONST  EFI_PEI_SMBUS2_PPI        *SmbusPpi,\r
-  IN CONST  EFI_SMBUS_DEVICE_ADDRESS  SlaveAddress,\r
-  IN CONST  UINTN                     Data\r
-);\r

 /**\r
   The ArpDevice() function enumerates the entire bus or enumerates a specific \r
   device that is identified by SmbusUdid. \r
 \r
 /**\r
   The ArpDevice() function enumerates the entire bus or enumerates a specific \r
   device that is identified by SmbusUdid. \r
 \r

-  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+  @param  This           A pointer to the EFI_PEI_SMBUS2_PPI instance.\r

   @param  ArpAll         A Boolean expression that indicates if the host drivers need\r
                          to enumerate all the devices or enumerate only the device that is identified\r
                          by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.\r
   @param  ArpAll         A Boolean expression that indicates if the host drivers need\r
                          to enumerate all the devices or enumerate only the device that is identified\r
                          by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.\r


@@ -130,6 +114,7 @@ EFI_STATUS
                                 due to a lack of resources.\r
   @retval EFI_TIMEOUT           The SMBus slave device did not respond.\r
   @retval EFI_DEVICE_ERROR      The request was not completed because the transaction failed.\r
                                 due to a lack of resources.\r
   @retval EFI_TIMEOUT           The SMBus slave device did not respond.\r
   @retval EFI_DEVICE_ERROR      The request was not completed because the transaction failed.\r

+  @retval EFI_UNSUPPORTED       ArpDevice, GetArpMap, and Notify are not implemented by this PEIM.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -151,12 +136,13 @@ typedef struct {
   The GetArpMap() function returns the mapping of all the SMBus devices \r
   that are enumerated by the SMBus host driver. \r
 \r
   The GetArpMap() function returns the mapping of all the SMBus devices \r
   that are enumerated by the SMBus host driver. \r
 \r

-  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+  @param  This           A pointer to the EFI_PEI_SMBUS2_PPI instance.\r

   @param  Length         Size of the buffer that contains the SMBus device map.\r
   @param  SmbusDeviceMap The pointer to the device map as enumerated\r
                          by the SMBus controller driver.\r
 \r
   @retval EFI_SUCCESS           The device map was returned correctly in the buffer.\r
   @param  Length         Size of the buffer that contains the SMBus device map.\r
   @param  SmbusDeviceMap The pointer to the device map as enumerated\r
                          by the SMBus controller driver.\r
 \r
   @retval EFI_SUCCESS           The device map was returned correctly in the buffer.\r

+  @retval EFI_UNSUPPORTED       ArpDevice, GetArpMap, and Notify are not implemented by this PEIM.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -167,12 +153,30 @@ EFI_STATUS
   IN OUT    EFI_SMBUS_DEVICE_MAP  **SmbusDeviceMap\r
 );\r
 \r
   IN OUT    EFI_SMBUS_DEVICE_MAP  **SmbusDeviceMap\r
 );\r
 \r

+/**\r
+  CallBack function can be registered in EFI_PEI_SMBUS2_PPI_NOTIFY.\r
+\r
+  @param  This           A pointer to the EFI_PEI_SMBUS2_PPI instance.\r
+  @param  SlaveAddress   The SMBUS hardware address to which the SMBUS\r
+                         device is preassigned or allocated.\r
+  @param  Data           Data of the SMBus host notify command that\r
+                         the caller wants to be called.\r
+\r
+  @return Status\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_SMBUS_NOTIFY2_FUNCTION)(\r
+  IN CONST  EFI_PEI_SMBUS2_PPI        *SmbusPpi,\r
+  IN CONST  EFI_SMBUS_DEVICE_ADDRESS  SlaveAddress,\r
+  IN CONST  UINTN                     Data\r
+);\r

 \r
 /**\r
   The Notify() function registers all the callback functions to allow the \r
   bus driver to call these functions when the SlaveAddress/Data pair happens.\r
 \r
 \r
 /**\r
   The Notify() function registers all the callback functions to allow the \r
   bus driver to call these functions when the SlaveAddress/Data pair happens.\r
 \r

-  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+  @param  This           A pointer to the EFI_PEI_SMBUS2_PPI instance.\r

   @param  SlaveAddress   Address that the host controller detects as\r
                          sending a message and calls all the registered functions.\r
   @param  Data           Data that the host controller detects as sending a message\r
   @param  SlaveAddress   Address that the host controller detects as\r
                          sending a message and calls all the registered functions.\r
   @param  Data           Data that the host controller detects as sending a message\r


@@ -180,8 +184,9 @@ EFI_STATUS
   @param  NotifyFunction The function to call when the bus driver\r
                          detects the SlaveAddress and Data pair.\r
 \r
   @param  NotifyFunction The function to call when the bus driver\r
                          detects the SlaveAddress and Data pair.\r
 \r

-  @retval EFI_SUCCESS           NotifyFunction has been registered.\r
-\r
+  @retval EFI_SUCCESS     NotifyFunction has been registered.\r
+  @retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are not\r
+                          implemented by this PEIM.\r

 **/\r
 typedef\r
 EFI_STATUS\r
 **/\r
 typedef\r
 EFI_STATUS\r

diff --git a/MdePkg/Include/Ppi/Stall.h b/MdePkg/Include/Ppi/Stall.h
index 2a7e225dc15a562c2bee0ef9102938dd73f1ce65..eab8c07ae3a590d4d7bab350599a0cc61330ff70 100644 (file)
--- a/MdePkg/Include/Ppi/Stall.h
+++ b/MdePkg/Include/Ppi/Stall.h
@@ -1,9 +1,9 @@
 /** @file\r
   This file declares Stall PPI.\r
 \r
 /** @file\r
   This file declares Stall PPI.\r
 \r

-  This code abstracts the PEI core to provide Stall services.\r
+  This ppi abstracts the blocking stall service to other agents.\r

 \r
 \r

-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -35,7 +35,7 @@ typedef struct _EFI_PEI_STALL_PPI EFI_PEI_STALL_PPI;
   @param  This           Pointer to the local data for the interface.\r
   @param  Microseconds   Number of microseconds for which to stall.\r
 \r
   @param  This           Pointer to the local data for the interface.\r
   @param  Microseconds   Number of microseconds for which to stall.\r
 \r

-  @retval EFI_SUCCESS           The service provided at least the required delay.\r
+  @retval EFI_SUCCESS    The service provided at least the required delay.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r

diff --git a/MdePkg/Include/Ppi/StatusCode.h b/MdePkg/Include/Ppi/StatusCode.h
index 35e221bbf3c163841ba63031730146f37561263c..1283e5ee121ebb71a56d8a7fbb8af55593bba1fe 100644 (file)
--- a/MdePkg/Include/Ppi/StatusCode.h
+++ b/MdePkg/Include/Ppi/StatusCode.h
@@ -1,7 +1,8 @@
 /** @file\r
   This file declares Status Code PPI.\r
 /** @file\r
   This file declares Status Code PPI.\r

+  This ppi provides service that allows PEIMs to report status codes.\r

 \r
 \r

-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -19,6 +20,8 @@
 #ifndef __STATUS_CODE_PPI_H__\r
 #define __STATUS_CODE_PPI_H__\r
 \r
 #ifndef __STATUS_CODE_PPI_H__\r
 #define __STATUS_CODE_PPI_H__\r
 \r

+#include <Pi/PiPeiCis.h>\r
+\r

 #define EFI_PEI_REPORT_PROGRESS_CODE_PPI_GUID \\r
   { 0x229832d3, 0x7a30, 0x4b36, {0xb8, 0x27, 0xf4, 0xc, 0xb7, 0xd4, 0x54, 0x36 } }\r
 \r
 #define EFI_PEI_REPORT_PROGRESS_CODE_PPI_GUID \\r
   { 0x229832d3, 0x7a30, 0x4b36, {0xb8, 0x27, 0xf4, 0xc, 0xb7, 0xd4, 0x54, 0x36 } }\r
 \r


@@ -28,7 +31,7 @@
   of this service in the system.\r
 \r
   @param ReportStatusCode\r
   of this service in the system.\r
 \r
   @param ReportStatusCode\r

-  Service that allows PEIMs to report status codes. This function is defined in Peicis.h\r
+  Service that allows PEIMs to report status codes. This function is defined in PiPeicis.h\r

 \r
 **/\r
 typedef struct {\r
 \r
 **/\r
 typedef struct {\r

diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h
index dcb01e9440c9bcedaf5045f0a4004c9c981198f8..7b3cef024f99cb7485db4bc342fa40832c946839 100644 (file)
--- a/MdePkg/Include/Ppi/TemporaryRamSupport.h
+++ b/MdePkg/Include/Ppi/TemporaryRamSupport.h
@@ -1,7 +1,8 @@
 /** @file\r
   This file declares Temporary RAM Support PPI.\r
 /** @file\r
   This file declares Temporary RAM Support PPI.\r

+  This Ppi provides the service that migrates temporary RAM into permanent memory.\r

 \r
 \r

-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   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


@@ -55,7 +56,14 @@ EFI_STATUS
   IN UINTN                    CopySize\r
 );\r
 \r
   IN UINTN                    CopySize\r
 );\r
 \r

+/**\r
+  This service abstracts the ability to migrate contents of the platform early memory store.\r

 \r
 \r

+  @param ResetSystem\r
+  Perform the migration of contents of Temporary RAM to Permanent RAM.\r
+  Terminate the Temporary RAM if it cannot coexist with the Permanent RAM.\r
+\r
+**/\r

 typedef struct {\r
   TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;\r
 } TEMPORARY_RAM_SUPPORT_PPI;\r
 typedef struct {\r
   TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;\r
 } TEMPORARY_RAM_SUPPORT_PPI;\r

diff --git a/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h b/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
index e1b3f9bfcb7321100803f881482831a791328b1c..81fa2399eb5afc82a416334492c35a90c107f26b 100644 (file)
--- a/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
+++ b/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
@@ -1,4 +1,3 @@
-\r

 /** @file\r
   This file defines the encoding for the VFR (Visual Form Representation) language.\r
   IFR is primarily consumed by the EFI presentation engine, and produced by EFI\r
 /** @file\r
   This file defines the encoding for the VFR (Visual Form Representation) language.\r
   IFR is primarily consumed by the EFI presentation engine, and produced by EFI\r


@@ -581,6 +580,9 @@ typedef union {
   EFI_STRING_ID   string;\r
 } EFI_IFR_TYPE_VALUE;\r
 \r
   EFI_STRING_ID   string;\r
 } EFI_IFR_TYPE_VALUE;\r
 \r

+//\r
+// IFR Opcodes\r
+//\r

 #define EFI_IFR_FORM_OP                0x01\r
 #define EFI_IFR_SUBTITLE_OP            0x02\r
 #define EFI_IFR_TEXT_OP                0x03\r
 #define EFI_IFR_FORM_OP                0x01\r
 #define EFI_IFR_SUBTITLE_OP            0x02\r
 #define EFI_IFR_TEXT_OP                0x03\r

diff --git a/MdePkg/Include/Uefi/UefiMultiPhase.h b/MdePkg/Include/Uefi/UefiMultiPhase.h
index c663a68cedf63e6c6d8e99b6a026ac52dc103053..0cbf2a6a63c7e7fabddbcfd92a4b7be4bd4c92aa 100644 (file)
--- a/MdePkg/Include/Uefi/UefiMultiPhase.h
+++ b/MdePkg/Include/Uefi/UefiMultiPhase.h
@@ -135,16 +135,6 @@ typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {
                     this case the value is\r
                     EFI_CERT_BLOCK_RSA_2048_SHA256.\r
 \r
                     this case the value is\r
                     EFI_CERT_BLOCK_RSA_2048_SHA256.\r
 \r

-  @param Information  The WIN_CERTIFICATE_UEFI_GUID certificate\r
-                      type allows new types of certificates to\r
-                      be developed for driver authentication\r
-                      without requiring a new certificate type.\r
-                      The CertType defines the format of the\r
-                      CertData, which length is defined by the\r
-                      size of the certificate less the fixed\r
-                      size of the WIN_CERTIFICATE_UEFI_GUID\r
-                      structure.\r
-\r

 **/\r
 typedef struct _WIN_CERTIFICATE_UEFI_GUID {\r
   WIN_CERTIFICATE   Hdr;\r
 **/\r
 typedef struct _WIN_CERTIFICATE_UEFI_GUID {\r
   WIN_CERTIFICATE   Hdr;\r