tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-25 06:34:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6723 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jji4 2008-11-25 08:38:41 +00:00
parent cf8ae2f6fe
commit 66770ccb0d
2 changed files with 37 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
MdePkg/Include/Library/UefiDriverEntryPoint.h
View File

@ -28,17 +28,18 @@ extern CONST UINT8 _gDriverUnloadImageCount;
/** /**
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, 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 or UEFI Driver. This function must call ProcessLibraryConstructorList() and
ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList() ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList()
is an error status, then ProcessLibraryDestructorList() must be called. The return is an error status, then ProcessLibraryDestructorList() must be called. The return value
value from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater
greater than zero, then an unload handler must be registered for this image and the than zero, then an unload handler must be registered for this image and the unload handler
unload handler must invoke ProcessModuleUnloadList(). If _gUefiDriverRevision is not must invoke ProcessModuleUnloadList().
zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison, then return If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,
EFI_INCOMPATIBLE_VERSION. then return EFI_INCOMPATIBLE_VERSION.
@param ImageHandle ImageHandle of the loaded driver. @param ImageHandle ImageHandle of the loaded driver.
@param SystemTable Pointer to the EFI System Table. @param SystemTable Pointer to the EFI System Table.
@ -57,7 +58,7 @@ _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. This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.
@ -100,7 +101,7 @@ ExitDriver (
This function must be called by _ModuleEntryPoint(). This function must be called by _ModuleEntryPoint().
This function calls the set of library constructors for the set of library instances This function calls the set of library constructors for the set of library instances
that a module depends on. This includes library instances that a module depends on that a module depends on. This includes library instances that a module depends on
directly and library instances that a module depends on indirectly through other libraries. directly and library instances that a module depends on indirectly through other libraries.
This function is autogenerated by build tools and those build tools are responsible This function is autogenerated by build tools and those build tools are responsible
for collecting the set of library instances, determine which ones have constructors, for collecting the set of library instances, determine which ones have constructors,
@ -120,7 +121,8 @@ ProcessLibraryConstructorList (
/** /**
Autogenerated function that calls the library descructors for all of the module's dependent libraries. Autogenerated function that calls the library descructors for all of the module's
dependent libraries.
This function may be called by _ModuleEntryPoint() or ExitDriver(). This function may be called by _ModuleEntryPoint() or ExitDriver().
This function calls the set of library destructors for the set of library instances This function calls the set of library destructors for the set of library instances

33
MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
View File

@ -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.
@param ImageHandle ImageHandle of the loaded driver. This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver,
@param SystemTable Pointer to the EFI System Table. 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.
@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 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 ImageHandle ImageHandle of the loaded driver.
@param SystemTable Pointer to the EFI System Table. @param SystemTable Pointer to the EFI System Table.
@retval EFI_SUCCESS One or more of the drivers returned a success code. @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM Driver,
@retval !EFI_SUCESS The return status from the last driver entry point in the list. or UEFI Driver exited normally.
@retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
@retval Other Return value from ProcessModuleEntryPointList().
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI