diff options
Diffstat (limited to 'MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c')
| -rw-r--r-- | MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c | 38 |
1 files changed, 16 insertions, 22 deletions
diff --git a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c index 021e4b777b82f..a8336763da79e 100644 --- a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c +++ b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c @@ -1,14 +1,8 @@ /** @file Entry point to a EFI/DXE driver. -Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR> -This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -27,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Unloads an image from memory. - This function is a callback that a driver registers to do cleanup + This function is a callback that a driver registers to do cleanup when the UnloadImage boot service function is called. @param ImageHandle The handle to the image to unload. @@ -65,27 +59,27 @@ _DriverUnloadHandler ( /** - The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM - Driver, or UEFI 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 + 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 + If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison, then return EFI_INCOMPATIBLE_VERSION. - @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, + @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. @param SystemTable A pointer to the EFI System Table. - @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM + @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 + @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision. @retval Other Return value from ProcessModuleEntryPointList(). @@ -147,18 +141,18 @@ _ModuleEntryPoint ( /** - Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). + 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 The image handle of the DXE Driver, DXE Runtime Driver, DXE + @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. @param SystemTable A pointer to the EFI System Table. - @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM + @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 + @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision. @retval Other Return value from ProcessModuleEntryPointList(). **/ |