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

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

1 files changed, 24 insertions, 9 deletions

diff --git a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
index 68410ba3c9..02d7160588 100644
--- a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
+++ b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
@@ -63,13 +63,25 @@ _DriverUnloadHandler (
 

 

 /**

-  Enrty point to DXE Driver.

+  The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. 

+

+  This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver,

+  or UEFI Driver.  This function must call ProcessLibraryConstructorList() and

+  ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList()

+  is an error status, then ProcessLibraryDestructorList() must be called. The return value

+  from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater

+  than zero, then an unload handler must be registered for this image and the unload handler

+  must invoke ProcessModuleUnloadList().

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

+  then return EFI_INCOMPATIBLE_VERSION.

 

-  @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_SUCESS The return status from the last driver entry point in the list.

+  @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_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.

+  @retval  Other                     Return value from ProcessModuleEntryPointList().

 

 **/

 EFI_STATUS

@@ -129,14 +141,17 @@ _ModuleEntryPoint (
 

 

 /**

-  Enrty point wrapper of DXE Driver.

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

+

+  This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.

 

   @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_SUCESS The return status from the last driver entry point in the list.

-

+  @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().

 **/

 EFI_STATUS

 EFIAPI