added function header

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@935 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
vanjeff 2006-07-13 01:17:21 +00:00
parent da1508dd53
commit a42b182076
6 changed files with 82 additions and 0 deletions

View File

@ -17,6 +17,15 @@
#ifndef __PEI_SERVICES_TABLE_POINTER_LIB_H__
#define __PEI_SERVICES_TABLE_POINTER_LIB_H__
/**
The function returns the pointer to PEI services.
The function returns the pointer to PEI services.
It will ASSERT() if the pointer to PEI services is NULL.
@retval The pointer to PeiServices.
**/
EFI_PEI_SERVICES **
GetPeiServicesTablePointer (
VOID

View File

@ -19,6 +19,18 @@
EFI_DXE_SERVICES *gDS = NULL;
/**
The constructor function caches the pointer of System Configuration Table.
The constructor function caches the pointer of System Configuration Table.
It will ASSERT() if that operation fails.
It will ASSERT() if the pointer of System Configuration Table is NULL.
It will always return EFI_SUCCESS.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
**/
EFI_STATUS
DxeServicesTableLibConstructor (

View File

@ -18,6 +18,15 @@
static EFI_PEI_SERVICES **gPeiServices;
/**
The function returns the pointer to PEI services.
The function returns the pointer to PEI services.
It will ASSERT() if the pointer to PEI services is NULL.
@retval The pointer to PeiServices.
**/
EFI_PEI_SERVICES **
GetPeiServicesTablePointer (
VOID
@ -27,7 +36,18 @@ GetPeiServicesTablePointer (
return gPeiServices;
}
/**
The constructor function caches the pointer to PEI services.
The constructor function caches the pointer to PEI services.
It will always return EFI_SUCCESS.
@param FfsHeader Pointer to FFS header the loaded driver.
@param PeiServices Pointer to the PEI services.
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
**/
EFI_STATUS
PeiServicesTablePointerLibConstructor (

View File

@ -15,7 +15,15 @@
**/
/**
The function returns the pointer to PeiServices.
The function returns the pointer to PeiServices.
It will ASSERT() if the pointer to PeiServices is NULL.
@retval The pointer to PeiServices.
**/
EFI_PEI_SERVICES **
GetPeiServicesTablePointer (
VOID
@ -29,6 +37,16 @@ GetPeiServicesTablePointer (
}
/**
The constructor function caches the pointer to PEI services.
The constructor function caches the pointer to PEI services.
It will always return EFI_SUCCESS.
@param FfsHeader Pointer to FFS header the loaded driver.
@param PeiServices Pointer to the PEI services.
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
**/
EFI_STATUS
PeiServicesTablePointerLibConstructor (

View File

@ -19,6 +19,18 @@ EFI_SYSTEM_TABLE *gST;
EFI_BOOT_SERVICES *gBS;
/**
The constructor function caches the pointer of Boot Services Table.
The constructor function caches the pointer of Boot Services Table through System Table.
It will ASSERT() if the pointer of System Table is NULL.
It will ASSERT() if the pointer of Boot Services Table is NULL.
It will always return EFI_SUCCESS.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
**/
EFI_STATUS
UefiBootServicesTableLibConstructor (

View File

@ -20,6 +20,17 @@
EFI_RUNTIME_SERVICES *gRT = NULL;
/**
The constructor function caches the pointer of Runtime Services Table.
The constructor function caches the pointer of Runtime Services Table.
It will ASSERT() if the pointer of Runtime Services Table is NULL.
It will always return EFI_SUCCESS.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
**/
EFI_STATUS
UefiRuntimeServicesTableLibConstructor (