Function headers in .h and .c files synchronized with spec

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

11 files changed, 101 insertions, 113 deletions

diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h
index e417870cdb..9714bb8ff1 100644
--- a/MdePkg/Include/Library/PeiServicesLib.h
+++ b/MdePkg/Include/Library/PeiServicesLib.h
@@ -16,7 +16,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __PEI_SERVICES_LIB_H__

 

 /**

-  This service enables a given PEIM to register an interface into the PEI Foundation. 

+  This service enables a given PEIM to register an interface into the PEI Foundation.

 

   @param  PpiList               A pointer to the list of interfaces that the caller shall install.

 

@@ -98,7 +98,7 @@ PeiServicesNotifyPpi (
   );

 

 /**

-  This service enables PEIMs to ascertain the present value of the boot mode.  

+  This service enables PEIMs to ascertain the present value of the boot mode.

 

   @param  BootMode              A pointer to contain the value of the boot mode.

 

@@ -113,7 +113,7 @@ PeiServicesGetBootMode (
   );

 

 /**

-  This service enables PEIMs to update the boot mode variable.    

+  This service enables PEIMs to update the boot mode variable.

 

   @param  BootMode              The value of the boot mode to set.

 

@@ -165,7 +165,7 @@ PeiServicesCreateHob (
 

   @param  Instance              This instance of the firmware volume to find.  The value 0 is the

                                 Boot Firmware Volume (BFV).

-  @param  VolumeHandle          Pointer to the firmware volume header of the volume to return.

+  @param  VolumeHandle          Handle of the firmware volume header of the volume to return.

 

   @retval EFI_SUCCESS           The volume was found.

   @retval EFI_NOT_FOUND         The volume was not found.

@@ -185,7 +185,7 @@ PeiServicesFfsFindNextVolume (
   @param  SearchType            A filter to find files only of this type.

   @param  VolumeHandle          Pointer to the firmware volume header of the volume to search.

                                 This parameter must point to a valid FFS volume.

-  @param  FileHandle            Pointer to the current file from which to begin searching.

+  @param  FileHandle            Handle of the current file from which to begin searching.

 

   @retval EFI_SUCCESS           The file was found.

   @retval EFI_NOT_FOUND         The file was not found.

diff --git a/MdePkg/Include/Library/PostCodeLib.h b/MdePkg/Include/Library/PostCodeLib.h
index 092f7ee15e..86ad1c6761 100644
--- a/MdePkg/Include/Library/PostCodeLib.h
+++ b/MdePkg/Include/Library/PostCodeLib.h
@@ -33,7 +33,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

   @param  Value  The 32-bit value to write to the POST card.

 

-  @return  Value The 32-bit value to write to the POST card.

+  @return The 32-bit value to write to the POST card.

 

 **/

 UINT32

@@ -55,16 +55,16 @@ PostCode (
   value on the status reporting device.  

 

   PostCodeWithDescription()must actively prevent recursion.  If 

-  PostCodeWithDescription() is called while processing another any other 

-  Post Code Library function, then PostCodeWithDescription() 

-  must return Value immediately.

+  PostCodeWithDescription() is called while processing another any other Post 

+  Code Library function, then PostCodeWithDescription() must return Value 

+  immediately.

 

   @param  Value        The 32-bit value to write to the POST card.

   @param  Description  Pointer to an ASCII string that is a description of the 

                        POST code value.  This is an optional parameter that may 

                        be NULL.

 

-  @return  Value       The 32-bit value to write to the POST card.

+  @return The 32-bit value to write to the POST card.

 

 **/

 UINT32

diff --git a/MdePkg/Include/Library/ResourcePublicationLib.h b/MdePkg/Include/Library/ResourcePublicationLib.h
index 542463b88f..59d45b64a0 100644
--- a/MdePkg/Include/Library/ResourcePublicationLib.h
+++ b/MdePkg/Include/Library/ResourcePublicationLib.h
@@ -16,7 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __RESOURCE_PUBLICATION_LIB__

 

 /**

-  

   Declares the presence of permanent system memory in the platform.

 

   Declares that the system memory buffer specified by MemoryBegin and MemoryLength

diff --git a/MdePkg/Library/BasePeCoffGetEntryPointLib/PeCoffGetEntryPoint.c b/MdePkg/Library/BasePeCoffGetEntryPointLib/PeCoffGetEntryPoint.c
index 81a279afca..ed1982944c 100644
--- a/MdePkg/Library/BasePeCoffGetEntryPointLib/PeCoffGetEntryPoint.c
+++ b/MdePkg/Library/BasePeCoffGetEntryPointLib/PeCoffGetEntryPoint.c
@@ -127,7 +127,7 @@ PeCoffLoaderGetMachineType (
 

 /**

   Returns a pointer to the PDB file name for a PE/COFF image that has been

-  loaded into system memory with the PE/COFF Loader Library functions.

+  loaded into system memory with the PE/COFF Loader Library functions. 

 

   Returns the PDB file name for the PE/COFF image specified by Pe32Data.  If

   the PE/COFF image specified by Pe32Data is not a valid, then NULL is

diff --git a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
index 69033598e6..9756520aa6 100644
--- a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
+++ b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
@@ -181,6 +181,8 @@ PeCoffLoaderGetPeHeader (
   If any errors occur while computing the fields of ImageContext, 

   then the error status is returned in the ImageError field of ImageContext.  

   If the image is a TE image, then SectionAlignment is set to 0.

+  The ImageRead and Handle fields of ImageContext structure must be valid prior 

+  to invoking this service.

 

   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF

                                     image that needs to be examined by this function.

diff --git a/MdePkg/Library/BasePostCodeLibDebug/PostCode.c b/MdePkg/Library/BasePostCodeLibDebug/PostCode.c
index 974adceca7..f51af776c5 100644
--- a/MdePkg/Library/BasePostCodeLibDebug/PostCode.c
+++ b/MdePkg/Library/BasePostCodeLibDebug/PostCode.c
@@ -31,9 +31,9 @@
   processing another any other Post Code Library function, then 

   PostCode() must return Value immediately.

 

-  @param   Value  The 32-bit value to write to the POST card.

+  @param  Value  The 32-bit value to write to the POST card.

 

-  @return  The 32-bit value to write to the POST card.

+  @return The 32-bit value to write to the POST card.

 

 **/

 UINT32

diff --git a/MdePkg/Library/BasePrintLib/PrintLib.c b/MdePkg/Library/BasePrintLib/PrintLib.c
index d08024758a..308f6273bf 100644
--- a/MdePkg/Library/BasePrintLib/PrintLib.c
+++ b/MdePkg/Library/BasePrintLib/PrintLib.c
@@ -93,6 +93,7 @@ UnicodeVSPrint (
   @param  FormatString    Null-terminated Unicode format string.

   @param  ...             Variable argument list whose contents are accessed based on the 

                           format string specified by FormatString.

+  

   @return The number of Unicode characters in the produced output buffer not including the

           Null-terminator.

 

diff --git a/MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c b/MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c
index 1b8cd899c3..6f010f2d3b 100644
--- a/MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c
+++ b/MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c
@@ -39,19 +39,19 @@
 /**

   Sends an 32-bit value to a POST card.

 

-  Sends the 32-bit value specified by Value to a POST card, and returns Value.

-  Some implementations of this library function may perform I/O operations

-  directly to a POST card device.  Other implementations may send Value to

-  ReportStatusCode(), and the status code reporting mechanism will eventually

+  Sends the 32-bit value specified by Value to a POST card, and returns Value.  

+  Some implementations of this library function may perform I/O operations 

+  directly to a POST card device.  Other implementations may send Value to 

+  ReportStatusCode(), and the status code reporting mechanism will eventually 

   display the 32-bit value on the status reporting device.

-

-  PostCode() must actively prevent recursion.  If PostCode() is called while

-  processing another any other Post Code Library function, then

+  

+  PostCode() must actively prevent recursion.  If PostCode() is called while 

+  processing another any other Post Code Library function, then 

   PostCode() must return Value immediately.

 

   @param  Value  The 32-bit value to write to the POST card.

 

-  @return  Value The 32-bit value to write to the POST card.

+  @return The 32-bit value to write to the POST card.

 

 **/

 UINT32

@@ -69,24 +69,24 @@ PostCode (
   Sends an 32-bit value to a POST and associated ASCII string.

 

   Sends the 32-bit value specified by Value to a POST card, and returns Value.

-  If Description is not NULL, then the ASCII string specified by Description is

-  also passed to the handler that displays the POST card value.  Some

-  implementations of this library function may perform I/O operations directly

-  to a POST card device.  Other implementations may send Value to ReportStatusCode(),

-  and the status code reporting mechanism will eventually display the 32-bit

-  value on the status reporting device.

-

-  PostCodeWithDescription()must actively prevent recursion.  If

-  PostCodeWithDescription() is called while processing another any other Post

-  Code Library function, then PostCodeWithDescription() must return Value

+  If Description is not NULL, then the ASCII string specified by Description is 

+  also passed to the handler that displays the POST card value.  Some 

+  implementations of this library function may perform I/O operations directly 

+  to a POST card device.  Other implementations may send Value to ReportStatusCode(), 

+  and the status code reporting mechanism will eventually display the 32-bit 

+  value on the status reporting device.  

+

+  PostCodeWithDescription()must actively prevent recursion.  If 

+  PostCodeWithDescription() is called while processing another any other Post 

+  Code Library function, then PostCodeWithDescription() must return Value 

   immediately.

 

   @param  Value        The 32-bit value to write to the POST card.

-  @param  Description  Pointer to an ASCII string that is a description of the

-                       POST code value.  This is an optional parameter that may

+  @param  Description  Pointer to an ASCII string that is a description of the 

+                       POST code value.  This is an optional parameter that may 

                        be NULL.

 

-  @return  Value       The 32-bit value to write to the POST card.

+  @return The 32-bit value to write to the POST card.

 

 **/

 UINT32

diff --git a/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c b/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c
index 729391d9c9..a02954ae05 100644
--- a/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c
+++ b/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c
@@ -273,23 +273,19 @@ PciSegmentOr8 (
 }

 

 /**

-  Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit

-  value.

-

-  Reads the 8-bit PCI configuration register specified by Address, performs a

-  bitwise AND between the read result and the value specified by AndData, and

-  writes the result to the 8-bit PCI configuration register specified by

-  Address. The value written to the PCI configuration register is returned.

-  This function must guarantee that all PCI read and write operations are

-  serialized.

+  Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value.

 

+  Reads the 8-bit PCI configuration register specified by Address,

+  performs a bitwise AND between the read result and the value specified by AndData,

+  and writes the result to the 8-bit PCI configuration register specified by Address.

+  The value written to the PCI configuration register is returned.

+  This function must guarantee that all PCI read and write operations are serialized.

   If any reserved bits in Address are set, then ASSERT().

 

-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and

-                  Register.

-  @param  AndData The value to AND with the PCI configuration register.

+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.

+  @param  AndData   The value to AND with the PCI configuration register.

 

-  @return The value written back to the PCI configuration register.

+  @return The value written to the PCI configuration register.

 

 **/

 UINT8

@@ -303,25 +299,23 @@ PciSegmentAnd8 (
 }

 

 /**

-  Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit

-  value, followed a  bitwise inclusive OR with another 8-bit value.

-

-  Reads the 8-bit PCI configuration register specified by Address, performs a

-  bitwise AND between the read result and the value specified by AndData,

-  performs a bitwise inclusive OR between the result of the AND operation and

-  the value specified by OrData, and writes the result to the 8-bit PCI

-  configuration register specified by Address. The value written to the PCI

-  configuration register is returned. This function must guarantee that all PCI

-  read and write operations are serialized.

-

+  Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value,

+  followed a  bitwise inclusive OR with another 8-bit value.

+  

+  Reads the 8-bit PCI configuration register specified by Address,

+  performs a bitwise AND between the read result and the value specified by AndData,

+  performs a bitwise inclusive OR between the result of the AND operation and the value specified by OrData,

+  and writes the result to the 8-bit PCI configuration register specified by Address.

+  The value written to the PCI configuration register is returned.

+  This function must guarantee that all PCI read and write operations are serialized.

+  

   If any reserved bits in Address are set, then ASSERT().

 

-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and

-                  Register.

-  @param  AndData The value to AND with the PCI configuration register.

-  @param  OrData  The value to OR with the result of the AND operation.

+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.

+  @param  AndData    The value to AND with the PCI configuration register.

+  @param  OrData    The value to OR with the PCI configuration register.

 

-  @return The value written back to the PCI configuration register.

+  @return The value written to the PCI configuration register.

 

 **/

 UINT8

@@ -617,23 +611,21 @@ PciSegmentOr16 (
 }

 

 /**

-  Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit

-  value.

-

-  Reads the 16-bit PCI configuration register specified by Address, performs a

-  bitwise AND between the read result and the value specified by AndData, and

-  writes the result to the 16-bit PCI configuration register specified by

-  Address. The value written to the PCI configuration register is returned.

-  This function must guarantee that all PCI read and write operations are

-  serialized.

+  Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value.

 

+  Reads the 16-bit PCI configuration register specified by Address,

+  performs a bitwise AND between the read result and the value specified by AndData,

+  and writes the result to the 16-bit PCI configuration register specified by Address.

+  The value written to the PCI configuration register is returned.

+  This function must guarantee that all PCI read and write operations are serialized.

+  

   If any reserved bits in Address are set, then ASSERT().

+  If Address is not aligned on a 16-bit boundary, then ASSERT().

+  

+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.

+  @param  AndData   The value to AND with the PCI configuration register.

 

-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and

-                  Register.

-  @param  AndData The value to AND with the PCI configuration register.

-

-  @return The value written back to the PCI configuration register.

+  @return The value written to the PCI configuration register.

 

 **/

 UINT16

@@ -961,23 +953,21 @@ PciSegmentOr32 (
 }

 

 /**

-  Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit

-  value.

-

-  Reads the 32-bit PCI configuration register specified by Address, performs a

-  bitwise AND between the read result and the value specified by AndData, and

-  writes the result to the 32-bit PCI configuration register specified by

-  Address. The value written to the PCI configuration register is returned.

-  This function must guarantee that all PCI read and write operations are

-  serialized.

+  Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value.

 

+  Reads the 32-bit PCI configuration register specified by Address,

+  performs a bitwise AND between the read result and the value specified by AndData,

+  and writes the result to the 32-bit PCI configuration register specified by Address.

+  The value written to the PCI configuration register is returned.

+  This function must guarantee that all PCI read and write operations are serialized.

+  

   If any reserved bits in Address are set, then ASSERT().

+  If Address is not aligned on a 32-bit boundary, then ASSERT().

 

-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and

-                  Register.

-  @param  AndData The value to AND with the PCI configuration register.

+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.

+  @param  AndData   The value to AND with the PCI configuration register.

 

-  @return The value written back to the PCI configuration register.

+  @return The value written to the PCI configuration register.

 

 **/

 UINT32

@@ -991,25 +981,24 @@ PciSegmentAnd32 (
 }

 

 /**

-  Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit

-  value, followed a  bitwise inclusive OR with another 32-bit value.

-

-  Reads the 32-bit PCI configuration register specified by Address, performs a

-  bitwise AND between the read result and the value specified by AndData,

-  performs a bitwise inclusive OR between the result of the AND operation and

-  the value specified by OrData, and writes the result to the 32-bit PCI

-  configuration register specified by Address. The value written to the PCI

-  configuration register is returned. This function must guarantee that all PCI

-  read and write operations are serialized.

-

+  Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value,

+  followed a  bitwise inclusive OR with another 32-bit value.

+  

+  Reads the 32-bit PCI configuration register specified by Address,

+  performs a bitwise AND between the read result and the value specified by AndData,

+  performs a bitwise inclusive OR between the result of the AND operation and the value specified by OrData,

+  and writes the result to the 32-bit PCI configuration register specified by Address.

+  The value written to the PCI configuration register is returned.

+  This function must guarantee that all PCI read and write operations are serialized.

+  

   If any reserved bits in Address are set, then ASSERT().

+  If Address is not aligned on a 32-bit boundary, then ASSERT().

 

-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and

-                  Register.

-  @param  AndData The value to AND with the PCI configuration register.

-  @param  OrData  The value to OR with the result of the AND operation.

+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.

+  @param  AndData   The value to AND with the PCI configuration register.

+  @param  OrData    The value to OR with the PCI configuration register.

 

-  @return The value written back to the PCI configuration register.

+  @return The value written to the PCI configuration register.

 

 **/

 UINT32

diff --git a/MdePkg/Library/PeiResourcePublicationLib/PeiResourcePublicationLib.c b/MdePkg/Library/PeiResourcePublicationLib/PeiResourcePublicationLib.c
index 175c2e9402..68e4f6acec 100644
--- a/MdePkg/Library/PeiResourcePublicationLib/PeiResourcePublicationLib.c
+++ b/MdePkg/Library/PeiResourcePublicationLib/PeiResourcePublicationLib.c
@@ -23,7 +23,6 @@
 

 

 /**

-  

   Declares the presence of permanent system memory in the platform.

 

   Declares that the system memory buffer specified by MemoryBegin and MemoryLength

diff --git a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c
index a2ce52dcd2..93495f04b8 100644
--- a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c
+++ b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c
@@ -282,7 +282,7 @@ PeiServicesFfsFindNextFile (
   This service enables PEIMs to discover sections of a given type within a valid FFS file.

 

   @param  SectionType           The value of the section type to find.

-  @param  FfsFileHeader         A pointer to the file header that contains the set of sections to

+  @param  FileHandle            A pointer to the file header that contains the set of sections to

                                 be searched.

   @param  SectionData           A pointer to the discovered section, if successful.

 

@@ -294,14 +294,14 @@ EFI_STATUS
 EFIAPI

 PeiServicesFfsFindSectionData (

   IN EFI_SECTION_TYPE           SectionType,

-  IN EFI_PEI_FILE_HANDLE        FfsFileHeader,

+  IN EFI_PEI_FILE_HANDLE        FileHandle,

   OUT VOID                      **SectionData

   )

 {

   CONST EFI_PEI_SERVICES **PeiServices;

 

   PeiServices = GetPeiServicesTablePointer ();

-  return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FfsFileHeader, SectionData);

+  return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FileHandle, SectionData);

 }

 

 /**

@@ -384,8 +384,6 @@ PeiServicesAllocatePool (
 /**

   Resets the entire platform.

 

-  @param  VOID

-

   @retval EFI_SUCCESS           The function completed successfully.

   @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.