]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Library / UefiDriverEntryPoint / DriverEntryPoint.c
index b4ed987bf93d17279117ca42ce9fc2b62de61ddd..dc6445b8a57771c2eec299a3b05ac75ba3046c4c 100644 (file)
@@ -1,19 +1,11 @@
 /** @file\r
   Entry point to a EFI/DXE driver.\r
 \r
-Copyright (c) 2006 - 2010, 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
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-\r
-\r
 #include <Uefi.h>\r
 \r
 #include <Protocol/LoadedImage.h>\r
@@ -23,13 +15,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #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
@@ -37,7 +29,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 EFI_STATUS\r
 EFIAPI\r
 _DriverUnloadHandler (\r
-  EFI_HANDLE ImageHandle\r
+  EFI_HANDLE  ImageHandle\r
   )\r
 {\r
   EFI_STATUS  Status;\r
@@ -62,29 +54,28 @@ _DriverUnloadHandler (
   return Status;\r
 }\r
 \r
-\r
 /**\r
-  The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM \r
-  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 \r
-  value from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount \r
-  is greater than zero, then an unload handler must be registered for this image \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
+  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
+  @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
+  @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
+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than\r
                                     SystemTable->Hdr.Revision.\r
   @retval  Other                     Return value from ProcessModuleEntryPointList().\r
 \r
@@ -144,20 +135,19 @@ _ModuleEntryPoint (
   return Status;\r
 }\r
 \r
-\r
 /**\r
-  Required by the EBC compiler and identical in functionality to _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,\r
   and SystemTable.\r
 \r
-  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE \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 \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
+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than\r
                                      SystemTable->Hdr.Revision.\r
   @retval  Other                     Return value from ProcessModuleEntryPointList().\r
 **/\r