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

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

5 files changed, 126 insertions, 96 deletions

diff --git a/MdePkg/Include/Library/PeiCoreEntryPoint.h b/MdePkg/Include/Library/PeiCoreEntryPoint.h
index 4d38468685..42ba464fbe 100644
--- a/MdePkg/Include/Library/PeiCoreEntryPoint.h
+++ b/MdePkg/Include/Library/PeiCoreEntryPoint.h
@@ -16,27 +16,33 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __MODULE_ENTRY_POINT_H__

 

 /**

-

-  Enrty point to PEI core.

-

-  @param SecCoreData    Points to a data structure containing

-                        information about the PEI core's

-                        operating environment, such as the size

-                        and location of temporary RAM, the stack

-                        location and the BFV location. The type

-                        EFI_SEC_PEI_HAND_OFF is

-

-  @param PpiList        Points to a list of one or more PPI

-                        descriptors to be installed initially by

-                        the PEI core. An empty PPI list consists

-                        of a single descriptor with the end-tag

-                        EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.

-                        As part of its initialization phase, the

-                        PEI Foundation will add these SEC-hosted

-                        PPIs to its PPI database such that both

-                        the PEI Foundation and any modules can

-                        leverage the associated service calls

-                        and/or code in these early PPIs.

+  The entry point of PE/COFF Image for the PEI Core.

+

+  This function is the entry point for the PEI Foundation, which allows the SEC phase

+  to pass information about the stack, temporary RAM and the Boot Firmware Volume.

+  In addition, it also allows the SEC phase to pass services and data forward for use

+  during the PEI phase in the form of one or more PPIs.

+  There is no limit to the number of additional PPIs that can be passed from SEC into

+  the PEI Foundation. As part of its initialization phase, the PEI Foundation will add

+  these SEC-hosted PPIs to its PPI database such that both the PEI Foundation and any

+  modules can leverage the associated service calls and/or code in these early PPIs.

+  This function is required to call ProcessModuleEntryPointList() with the Context

+  parameter set to NULL.  ProcessModuleEntryPoint() is never expected to return.

+  The PEI Core is responsible for calling ProcessLibraryConstructorList() as soon as

+  the PEI Services Table and the file handle for the PEI Core itself have been established.

+  If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.

+

+  @param SecCoreData  Points to a data structure containing information about the PEI

+                      core's operating environment, such as the size and location of

+                      temporary RAM, the stack location and the BFV location. 

+

+  @param PpiList      Points to a list of one or more PPI descriptors to be installed

+                      initially by the PEI core. An empty PPI list consists of a single

+                      descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.

+                      As part of its initialization phase, the PEI Foundation will add

+                      these SEC-hosted PPIs to its PPI database such that both the PEI

+                      Foundation and any modules can leverage the associated service calls

+                      and/or code in these early PPIs.

 

 **/

 VOID

@@ -51,26 +57,17 @@ _ModuleEntryPoint(
 

   This function is required to call _ModuleEntryPoint() passing in SecCoreData and PpiList.

 

-  @param SecCoreData    Points to a data structure containing

-                        information about the PEI core's

-                        operating environment, such as the size

-                        and location of temporary RAM, the stack

-                        location and the BFV location. The type

-                        EFI_SEC_PEI_HAND_OFF is

-

-  @param PpiList        Points to a list of one or more PPI

-                        descriptors to be installed initially by

-                        the PEI core. An empty PPI list consists

-                        of a single descriptor with the end-tag

-                        EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.

-                        As part of its initialization phase, the

-                        PEI Foundation will add these SEC-hosted

-                        PPIs to its PPI database such that both

-                        the PEI Foundation and any modules can

-                        leverage the associated service calls

-                        and/or code in these early PPIs.

- 

-  @return Status returned by entry points of core and drivers. 

+  @param SecCoreData  Points to a data structure containing information about the PEI core's

+                      operating environment, such as the size and location of temporary RAM,

+                      the stack location and the BFV location. 

+

+  @param PpiList      Points to a list of one or more PPI descriptors to be installed

+                      initially by the PEI core.  An empty PPI list consists of a single

+                      descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.

+                      As part of its initialization phase, the PEI Foundation will add these

+                      SEC-hosted PPIs to its PPI database such that both the PEI Foundation

+                      and any modules can leverage the associated service calls and/or code

+                      in these early PPIs.

 

 **/

 VOID

@@ -84,12 +81,18 @@ EfiMain (
   Autogenerated function that calls the library constructors for all of the module's

   dependent libraries.

 

-  This function must be called by the PEI Core once an initial PEI Services Table has

-  been established.

+  This function must be called by the PEI Core once an initial PEI Services Table has been established.

+  This function calls the set of library constructors for the set of library instances that a

+  module depends on.  This include library instances that a module depends on directly and library

+  instances that a module depends on indirectly through other libraries.  

+  This function is autogenerated by build tools and those build tools are responsible for collecting

+  the set of library instances, determine which ones have constructors, and calling the library

+  constructors in the proper order based upon each of the library instances own dependencies.

+  The PEI Core must call this function with a NULL FileHandle value as soon as the initial PEI

+  Services Table has been established.

 

-  @param  FileHandle  Handle of the file being invoked. 

-                      Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().

-  @param  PeiServices Pointer to the PEI Services Table.

+  @param  FileHandle   Handle of the file being invoked.Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().

+  @param  PeiServices  Describes the list of possible PEI Services.

 

 **/

 VOID

@@ -104,25 +107,21 @@ ProcessLibraryConstructorList (
   Autogenerated function that calls a set of module entry points.

 

   This function must be called by _ModuleEntryPoint().

-

-  @param SecCoreData    Points to a data structure containing

-                        information about the PEI core's

-                        operating environment, such as the size

-                        and location of temporary RAM, the stack

-                        location and the BFV location. The type

-                        EFI_SEC_PEI_HAND_OFF is

-

-  @param PpiList        Points to a list of one or more PPI

-                        descriptors to be installed initially by

-                        the PEI core. An empty PPI list consists

-                        of a single descriptor with the end-tag

-                        EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.

-                        As part of its initialization phase, the

-                        PEI Foundation will add these SEC-hosted

-                        PPIs to its PPI database such that both

-                        the PEI Foundation and any modules can

-                        leverage the associated service calls

-                        and/or code in these early PPIs.

+  This function calls the set of module entry points.  

+  This function is autogenerated by build tools and those build tools are responsible

+  for collecting the module entry points and calling them in a specified order.

+

+  @param SecCoreData    Points to a data structure containing information about the PEI

+                        core's operating environment, such as the size and location of

+                        temporary RAM, the stack location and the BFV location. 

+

+  @param PpiList        Points to a list of one or more PPI descriptors to be installed

+                        initially by the PEI core. An empty PPI list consists of a single

+                        descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.

+                        As part of its initialization phase, the PEI Foundation will add

+                        these SEC-hosted PPIs to its PPI database such that both the PEI

+                        Foundation and any modules can leverage the associated service calls

+                        and/or code in these early PPIs. 

   @param  OldCoreData   Pointer to Original startup information.

 

 **/

diff --git a/MdePkg/Include/Library/SerialPortLib.h b/MdePkg/Include/Library/SerialPortLib.h
index e6a55eefa4..30b8aa9ccf 100644
--- a/MdePkg/Include/Library/SerialPortLib.h
+++ b/MdePkg/Include/Library/SerialPortLib.h
@@ -38,9 +38,7 @@ SerialPortInitialize (
   Writes NumberOfBytes data bytes from Buffer to the serial device.  

   The number of bytes actually written to the serial device is returned.

   If the return value is less than NumberOfBytes, then the write operation failed.

-

   If Buffer is NULL, then ASSERT(). 

-

   If NumberOfBytes is zero, then return 0.

 

   @param  Buffer           Pointer to the data buffer to be written.

@@ -65,16 +63,14 @@ SerialPortWrite (
   Reads NumberOfBytes data bytes from a serial device into the buffer

   specified by Buffer. The number of bytes actually read is returned. 

   If the return value is less than NumberOfBytes, then the rest operation failed.

-

   If Buffer is NULL, then ASSERT(). 

-

   If NumberOfBytes is zero, then return 0.

 

   @param  Buffer           Pointer to the data buffer to store the data read from the serial device.

   @param  NumberOfBytes    Number of bytes which will be read.

 

   @retval 0                Read data failed, No data is to be read.

-  @retval !0               Aactual number of bytes read from serial device.

+  @retval >0               Aactual number of bytes read from serial device.

 

 **/

 UINTN

diff --git a/MdePkg/Include/Library/TimerLib.h b/MdePkg/Include/Library/TimerLib.h
index 4f920311c6..e24342e1f6 100644
--- a/MdePkg/Include/Library/TimerLib.h
+++ b/MdePkg/Include/Library/TimerLib.h
@@ -16,6 +16,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __TIMER_LIB__

 

 /**

+  Stalls the CPU for at least the given number of microseconds.

+

   Stalls the CPU for the number of microseconds specified by MicroSeconds.

 

   @param  MicroSeconds  The minimum number of microseconds to delay.

@@ -30,6 +32,8 @@ MicroSecondDelay (
   );

 

 /**

+  Stalls the CPU for at least the given number of nanoseconds.

+

   Stalls the CPU for the number of nanoseconds specified by NanoSeconds.

 

   @param  NanoSeconds The minimum number of nanoseconds to delay.

@@ -44,7 +48,8 @@ NanoSecondDelay (
   );

 

 /**

-  Retrieves the current value of a 64-bit free running performance counter. 

+  Retrieves the current value of a 64-bit free running performance counter.

+

   The counter can either count up by 1 or count down by 1. If the physical

   performance counter counts by a larger increment, then the counter values

   must be translated. The properties of the counter can be retrieved from

diff --git a/MdePkg/Include/Library/UefiApplicationEntryPoint.h b/MdePkg/Include/Library/UefiApplicationEntryPoint.h
index b6c193b710..9497f9a162 100644
--- a/MdePkg/Include/Library/UefiApplicationEntryPoint.h
+++ b/MdePkg/Include/Library/UefiApplicationEntryPoint.h
@@ -24,11 +24,18 @@ extern CONST UINT32        _gUefiDriverRevision;
 /**

   Enrty point to UEFI Application.

 

-  @param  ImageHandle ImageHandle of the loaded driver.

-  @param  SystemTable Pointer to the EFI System Table.

+  This function is the entry point for a UEFI Application. This function must call

+  ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList().

+  The return value from ProcessModuleEntryPointList() is returned.

+  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,

+  then return EFI_INCOMPATIBLE_VERSION.

 

-  @retval  EFI_SUCCESS One or more of the drivers returned a success code.

-  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.

+  @param  ImageHandle  The image handle of the UEFI Application.

+  @param  SystemTable  A pointer to the EFI System Table.

+

+  @retval  EFI_SUCCESS               The UEFI Application exited normally.

+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.

+  @retval  Other                     Return value from ProcessModuleEntryPointList().

 

 **/

 EFI_STATUS

@@ -40,13 +47,14 @@ _ModuleEntryPoint (
 

 

 /**

-  Enrty point wrapper of UEFI Application.

+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). 

 

-  @param  ImageHandle ImageHandle of the loaded driver.

-  @param  SystemTable Pointer to the EFI System Table.

+  @param  ImageHandle  The image handle of the UEFI Application.

+  @param  SystemTable  A pointer to the EFI System Table.

 

-  @retval  EFI_SUCCESS One or more of the drivers returned a success code.

-  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.

+  @retval  EFI_SUCCESS               The UEFI Application exited normally.

+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.

+  @retval  Other                     Return value from ProcessModuleEntryPointList().

 

 **/

 EFI_STATUS

@@ -58,10 +66,13 @@ EfiMain (
 

 

 /**

-  Invoke the destuctors of all libraries and call gBS->Exit

-  to return control to firmware core.

+  Invokes the library destructors fror all dependent libraries and terminates

+  the UEFI Application. 

+

+  This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit()

+  with a status specified by Status.

 

-  @param  Status Status returned by the application that is exiting.

+  @param  Status  Status returned by the application that is exiting.

   

 **/

 VOID

@@ -72,11 +83,20 @@ Exit (
 

 

 /**

-  Call constructors for all libraries.  Autogen tool inserts the implementation

-  of this function into Autogen.c.

-

-  @param  ImageHandle ImageHandle of the loaded driver.

-  @param  SystemTable Pointer to the EFI System Table.

+  Autogenerated function that calls the library constructors for all of the module's

+  dependent libraries.

+

+  This function must be called by _ModuleEntryPoint().

+  This function calls the set of library constructors for the set of library instances

+  that a module depends on. This includes library instances that a module depends on

+  directly and library instances that a module depends on indirectly through other libraries.  

+  This function is autogenerated by build tools and those build tools are responsible for

+  collecting the set of library instances, determine which ones have constructors, and

+  calling the library constructors in the proper order based upon each of the library

+  instances own dependencies.

+

+  @param  ImageHandle  The image handle of the UEFI Application.

+  @param  SystemTable  A pointer to the EFI System Table.

   

 **/

 VOID

@@ -88,11 +108,20 @@ ProcessLibraryConstructorList (
 

 

 /**

-  Call destructors for all libraries. Autogen tool inserts the implementation

-  of this function into Autogen.c.

+  Autogenerated function that calls the library descructors for all of the module's

+  dependent libraries.

 

-  @param  ImageHandle ImageHandle of the loaded driver.

-  @param  SystemTable Pointer to the EFI System Table.

+  This function may be called by _ModuleEntryPoint()or ExitDriver().

+  This function calls the set of library destructors for the set of library instances

+  that a module depends on.  This includes library instances that a module depends on

+  directly and library instances that a module depends on indirectly through other libraries.  

+  This function is autogenerated by build tools and those build tools are responsible

+  for collecting the set of library instances, determine which ones have destructors,

+  and calling the library destructors in the proper order based upon each of the library

+  instances own dependencies.

+

+  @param  ImageHandle  The image handle of the UEFI Application.

+  @param  SystemTable  A pointer to the EFI System Table.

 

 **/

 VOID

@@ -110,9 +139,9 @@ ProcessLibraryDestructorList (
   @param  ImageHandle ImageHandle of the loaded driver.

   @param  SystemTable Pointer to the EFI System Table.

 

-  @return Status returned by entry points specified by

-          the user.  

- 

+  @retval  EFI_SUCCESS   The UEFI Application executed normally.

+  @retval  !EFI_SUCCESS  The UEFI Application failed to execute normally.

+

 **/

 EFI_STATUS

 EFIAPI

diff --git a/MdePkg/Include/Library/UefiDriverEntryPoint.h b/MdePkg/Include/Library/UefiDriverEntryPoint.h
index 54ae03ddef..ef9570ba04 100644
--- a/MdePkg/Include/Library/UefiDriverEntryPoint.h
+++ b/MdePkg/Include/Library/UefiDriverEntryPoint.h
@@ -44,7 +44,8 @@ extern CONST UINT8                    _gDriverUnloadImageCount;
   @param  ImageHandle  ImageHandle of the loaded driver.

   @param  SystemTable  Pointer to the EFI System Table.

 

-  @retval  EFI_SUCCESS               One or more of the drivers returned a success code.

+  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,

+                                     or UEFI Driver exited normally.

   @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.

   @retval  Other                     Return value from ProcessModuleEntryPointList().