Code Scrub for Protocol and Ppi Definition

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5564 6f19259b-4bc3-4df7-8a09-765794883524
2008-07-25 10:37:15 +00:00
parent bb80e3b213
commit 4ca9b6c4e7
105 changed files with 3354 additions and 1680 deletions
--- a/MdePkg/Include/Ppi/Decompress.h
+++ b/MdePkg/Include/Ppi/Decompress.h
@@ -61,7 +61,8 @@ EFI_STATUS
 );


-/**                                                              
+/**
+  @par Ppi Description:                                                              
  This PPI's single member function decompresses a compression
  encapsulated section. It is used by the PEI Foundation to
  process sectioned files. Prior to the installation of this PPI,
--- a/MdePkg/Include/Ppi/FirmwareVolume.h
+++ b/MdePkg/Include/Ppi/FirmwareVolume.h
@@ -225,6 +225,7 @@ EFI_STATUS


 /*
+  @par Ppi Description:
  This PPI provides functions for accessing a memory-mapped firmware volume of a specific format.

  @param  ProcessVolume       Process a firmware volume and create a volume handle.
--- a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
+++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
@@ -27,6 +27,7 @@
 typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;

 /**
+  @par Ppi Description:
  This PPI describes the location and format of a firmware volume. 
  The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for 
  a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is 
--- a/MdePkg/Include/Ppi/GuidedSectionExtraction.h
+++ b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
@@ -105,6 +105,7 @@ EFI_STATUS


 /**
+  @par Ppi Description:
  If a GUID-defined section is encountered when doing section extraction,
  the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance
  calls the appropriate instance of the GUIDed Section
--- a/MdePkg/Include/Ppi/LoadFile.h
+++ b/MdePkg/Include/Ppi/LoadFile.h
@@ -1,7 +1,7 @@
 /** @file
  Load image file from fv to memory. 

-  Copyright (c) 2006, Intel Corporation                                                         
+  Copyright (c) 2006 - 2008, 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         
  which accompanies this distribution.  The full text of the license may be found at        
@@ -79,6 +79,7 @@ EFI_STATUS


 /**
+  @par Ppi Description:
  This PPI is a pointer to the Load File service.
  This service will be published by a PEIM. The PEI Foundation
  will use this service to launch the known PEI module images.
--- a/MdePkg/Include/Ppi/LoadImage.h
+++ b/MdePkg/Include/Ppi/LoadImage.h
@@ -2,7 +2,7 @@
  The file descript the PPI which notifies other drivers 
  of the PEIM being initialized by the PEI Dispatcher.

-  Copyright (c) 2006 - 2007, Intel Corporation                                                         
+  Copyright (c) 2006 - 2008, 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         
  which accompanies this distribution.  The full text of the license may be found at        
@@ -27,6 +27,7 @@
 typedef struct _EFI_PEI_LOADED_IMAGE_PPI  EFI_PEI_LOADED_IMAGE_PPI;

 /*
+  @par Ppi Description:
  This interface is installed by the PEI Dispatcher after the image has been
  loaded and after all security checks have been performed, 
  to notify other PEIMs of the files which are being loaded.
--- a/MdePkg/Include/Ppi/Pcd.h
+++ b/MdePkg/Include/Ppi/Pcd.h
@@ -193,7 +193,7 @@ UINTN


 /**
-  Retrieves an 8-bit value for a given PCD token.
+  Retrieves an 8-bit value for a given PCD token and token space.

  Retrieves the 8-bit value of a particular PCD token.  
  If the TokenNumber is invalid or the token space
@@ -216,7 +216,7 @@ UINT8


 /**
-  Retrieves an 16-bit value for a given PCD token.
+  Retrieves an 16-bit value for a given PCD token and token space.

  Retrieves the 16-bit value of a particular PCD token.  
  If the TokenNumber is invalid or the token space
@@ -239,7 +239,7 @@ UINT16


 /**
-  Retrieves an 32-bit value for a given PCD token.
+  Retrieves an 32-bit value for a given PCD token and token space.

  Retrieves the 32-bit value of a particular PCD token.  
  If the TokenNumber is invalid or the token space
@@ -262,7 +262,7 @@ UINT32


 /**
-  Retrieves an 64-bit value for a given PCD token.
+  Retrieves an 64-bit value for a given PCD token and token space.

  Retrieves the 64-bit value of a particular PCD token.  
  If the TokenNumber is invalid or the token space
@@ -285,7 +285,7 @@ UINT64


 /**
-  Retrieves a pointer to a value for a given PCD token.
+  Retrieves a pointer to a value for a given PCD token and token space.

  Retrieves the current pointer to the buffer for a PCD token number.  
  Do not make any assumptions about the alignment of the pointer that 
@@ -308,7 +308,7 @@ VOID *


 /**
-  Retrieves an Boolean value for a given PCD token.
+  Retrieves an Boolean value for a given PCD token and token space.

  Retrieves the Boolean value of a particular PCD token.  
  If the TokenNumber is invalid or the token space
@@ -331,7 +331,7 @@ BOOLEAN


 /**
-  Retrieves the size of the value for a given PCD token.
+  Retrieves the size of the value for a given PCD token and token space.

  Retrieves the current size of a particular PCD token.  
  If the TokenNumber is invalid, the results are unpredictable.
@@ -819,6 +819,104 @@ EFI_STATUS
 //
 // Interface structure for the PCD PPI
 //
+/**
+  @par Ppi Description:
+  This service abstracts the ability to set/get Platform Configuration Database (PCD).
+
+  @param SetSku
+  Sets the SKU value for subsequent calls to set or get PCD token values.
+  
+  @param Get8
+  Retrieves an 8-bit value for a given PCD token.
+
+  @param Get16
+  Retrieves an 16-bit value for a given PCD token.
+
+  @param Get32
+  Retrieves an 32-bit value for a given PCD token.
+
+  @param Get64
+  Retrieves an 64-bit value for a given PCD token.
+
+  @param GetPtr
+  Retrieves a pointer to a value for a given PCD token.
+
+  @param GetBool
+  Retrieves an Boolean value for a given PCD token.
+
+  @param GetSize
+  Retrieves the size of the value for a given PCD token.
+
+  @param Get8Ex
+  Retrieves an 8-bit value for a given PCD token and token space.
+
+  @param Get16Ex
+  Retrieves an 16-bit value for a given PCD token and token space.
+
+  @param Get32Ex
+  Retrieves an 32-bit value for a given PCD token and token space.
+
+  @param Get64Ex
+  Retrieves an 64-bit value for a given PCD token and token space.
+
+  @param GetPtrEx
+  Retrieves a pointer to a value for a given PCD token and token space.
+
+  @param GetBoolEx
+  Retrieves an Boolean value for a given PCD token and token space.
+
+  @param GetSizeEx
+  Retrieves the size of the value for a given PCD token and token space.
+
+  @param Set8
+  Sets an 8-bit value for a given PCD token.
+
+  @param Set16
+  Sets an 16-bit value for a given PCD token.
+
+  @param Set32
+  Sets an 32-bit value for a given PCD token.
+
+  @param Set64
+  Sets an 64-bit value for a given PCD token.
+
+  @param SetPtr
+  Sets the buffer of a specified size for a given PCD token.
+
+  @param SetBool
+  Sets an Boolean value for a given PCD token.
+
+  @param Set8Ex
+  Sets an 8-bit value for a given PCD token and token space.
+
+  @param Set16Ex
+  Sets an 16-bit value for a given PCD token and token space.
+
+  @param Set32Ex
+  Sets an 32-bit value for a given PCD token and token space.
+
+  @param Set64Ex
+  Sets an 64-bit value for a given PCD token and token space.
+
+  @param SetPtrEx
+  Sets the buffer of a specified size for a given PCD token and token space.
+
+  @param SetBoolEx
+  Sets an Boolean value for a given PCD token and token space.
+  
+  @param CallbackOnSet
+  Specifies a function to be called anytime the value of a designated token is changed.
+  
+  @param CancelCallback
+  Cancels a previously set callback function for a particular PCD token number.
+  
+  @param GetNextToken
+  Retrieves the next valid PCD token for a given namespace.
+  
+  @param GetNextTokenSpace
+  Retrieves the next valid PCD token namespace for a given namespace.
+ 
+**/
 typedef struct {
  PCD_PPI_SET_SKU              SetSku;

--- a/MdePkg/Include/Ppi/ReadOnlyVariable2.h
+++ b/MdePkg/Include/Ppi/ReadOnlyVariable2.h
@@ -120,6 +120,7 @@ EFI_STATUS
  );

 /**
+  @par Ppi Description:
  This PPI provides a lightweight, read-only variant of the full EFI 
  variable services. 

--- a/MdePkg/Include/Ppi/Reset.h
+++ b/MdePkg/Include/Ppi/Reset.h
@@ -30,6 +30,7 @@
  }

 /**
+  @par Ppi Description:
  This PPI provides provide a simple reset service. 

  @param ResetSystem
--- a/MdePkg/Include/Ppi/SecPlatformInformation.h
+++ b/MdePkg/Include/Ppi/SecPlatformInformation.h
@@ -102,6 +102,7 @@ EFI_STATUS


 /**
+  @par Ppi Description:
  This service abstracts platform-specific information. It is necessary 
  to convey this information to the PEI Foundation so that it can 
  discover where to begin dispatching PEIMs.
--- a/MdePkg/Include/Ppi/Security2.h
+++ b/MdePkg/Include/Ppi/Security2.h
@@ -2,7 +2,7 @@
  This file declares Pei Security2 PPI.

  This PPI is installed by some platform PEIM that abstracts the security 
-  policy to the PEI Foundation, namely the case of a PEIM<EFBFBD><EFBFBD>s authentication 
+  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 - 2008, Intel Corporation
@@ -105,7 +105,7 @@ EFI_STATUS
 );

 /**
-   
+  @par Ppi Description: 
  This PPI is a means by which the platform builder can indicate
  a response to a PEIM's authentication state. This can be in
  the form of a requirement for the PEI Foundation to skip a
--- a/MdePkg/Include/Ppi/TemporaryRamSupport.h
+++ b/MdePkg/Include/Ppi/TemporaryRamSupport.h
@@ -57,6 +57,7 @@ EFI_STATUS
 );

 /**
+  @par Ppi Description:
  This service abstracts the ability to migrate contents of the platform early memory store.

  @param ResetSystem