DriverEntryPoint.c File Reference

#include <Uefi.h>
#include <Protocol/LoadedImage.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	_DriverUnloadHandler (EFI_HANDLE ImageHandle)
EFI_STATUS EFIAPI	_ModuleEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI	EfiMain (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Detailed Description

Entry point to a EFI/DXE driver.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DriverEntryPoint.c.

Function Documentation

_DriverUnloadHandler()

EFI_STATUS EFIAPI _DriverUnloadHandler

(

EFI_HANDLE

ImageHandle

)

Unloads an image from memory.

This function is a callback that a driver registers to do cleanup when the UnloadImage boot service function is called.

Parameters

ImageHandle

The handle to the image to unload.

Returns

Status returned by all unload().

Definition at line 31 of file DriverEntryPoint.c.

_ModuleEntryPoint()

EFI_STATUS EFIAPI _ModuleEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

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.

Parameters

ImageHandle	The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver exited normally.
EFI_INCOMPATIBLE_VERSION	_gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
Other	Return value from ProcessModuleEntryPointList().

Definition at line 85 of file DriverEntryPoint.c.

EfiMain()

EFI_STATUS EFIAPI EfiMain	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

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

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

Parameters

ImageHandle	The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver exited normally.
EFI_INCOMPATIBLE_VERSION	_gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
Other	Return value from ProcessModuleEntryPointList().

Definition at line 156 of file DriverEntryPoint.c.