Fix a bug about the iSCSI DHCP dependency issue.

[mirror_edk2.git] / MdePkg / Library / UefiDriverEntryPoint / DriverEntryPoint.c

diff --git a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
index 68d6a4bb94a348df51b261e61d0342387bb1ac90..f5da5ac4ad10609b79d6cb9e653093d777c4c69a 100644 (file)
--- a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
+++ b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
@@ -1,8 +1,8 @@
 /** @file\r
   Entry point to a EFI/DXE driver.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+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
 http://opensource.org/licenses/bsd-license.php\r
@@ -19,16 +19,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/LoadedImage.h>\r
 \r
 #include <Library/UefiDriverEntryPoint.h>\r
+#include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 \r
 \r
 /**\r
-  Unload function that is registered in the LoadImage protocol.  It un-installs\r
-  protocols produced and deallocates pool used by the driver.  Called by the core\r
-  when unloading the driver.\r
+  Unloads an image from memory.\r
 \r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
+  This function is a callback that a driver registers to do cleanup \r
+  when the UnloadImage boot service function is called.\r
+\r
+  @param  ImageHandle The handle to the image to unload.\r
 \r
   @return Status returned by all unload().\r
 \r
@@ -63,25 +65,28 @@ _DriverUnloadHandler (
 \r
 \r
 /**\r
-  The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. \r
+  The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM \r
+  Driver, or UEFI Driver. \r
 \r
   This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
   or UEFI Driver.  This function must call ProcessLibraryConstructorList() and\r
   ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList()\r
-  is an error status, then ProcessLibraryDestructorList() must be called. The return value\r
-  from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater\r
-  than zero, then an unload handler must be registered for this image and the unload handler\r
-  must invoke ProcessModuleUnloadList().\r
-  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,\r
-  then return EFI_INCOMPATIBLE_VERSION.\r
-\r
-\r
-  @param  ImageHandle  ImageHandle of the loaded driver.\r
-  @param  SystemTable  Pointer to the EFI System Table.\r
-\r
-  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
-                                     or UEFI Driver exited normally.\r
-  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
+  is an error status, then ProcessLibraryDestructorList() must be called. The return \r
+  value from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount \r
+  is greater than zero, then an unload handler must be registered for this image \r
+  and the unload handler must invoke ProcessModuleUnloadList().\r
+  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than \r
+  _gUefiDriverRevison, then return EFI_INCOMPATIBLE_VERSION.\r
+\r
+\r
+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, \r
+                       DXE SMM Driver, or UEFI Driver.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
+\r
+  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM \r
+                                     Driver, or UEFI Driver exited normally.\r
+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than \r
+                                    SystemTable->Hdr.Revision.\r
   @retval  Other                     Return value from ProcessModuleEntryPointList().\r
 \r
 **/\r
@@ -144,14 +149,17 @@ _ModuleEntryPoint (
 /**\r
   Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). \r
 \r
-  This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.\r
+  This function is required to call _ModuleEntryPoint() passing in ImageHandle,\r
+  and SystemTable.\r
 \r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
-  @param  SystemTable Pointer to the EFI System Table.\r
+  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE \r
+                       SMM Driver, or UEFI Driver.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
 \r
-  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
-                                     or UEFI Driver exited normally.\r
-  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
+  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM \r
+                                     Driver, or UEFI Driver exited normally.\r
+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than \r
+                                     SystemTable->Hdr.Revision.\r
   @retval  Other                     Return value from ProcessModuleEntryPointList().\r
 **/\r
 EFI_STATUS\r