From d73d93c31ea139aa1d98ff703eeb38bab0d21ed9 Mon Sep 17 00:00:00 2001 From: klu2 Date: Fri, 8 Aug 2008 03:22:23 +0000 Subject: [PATCH] Synchronize the comments for PeiService. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5619 6f19259b-4bc3-4df7-8a09-765794883524 --- MdeModulePkg/Core/Pei/Dependency/Dependency.c | 4 ++-- MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c | 4 ++-- MdeModulePkg/Core/Pei/FwVol/FwVol.c | 6 +++--- MdeModulePkg/Core/Pei/Hob/Hob.c | 4 ++-- MdeModulePkg/Core/Pei/Image/Image.c | 18 ++++++++--------- MdeModulePkg/Core/Pei/Memory/MemoryServices.c | 20 +++++++++---------- MdeModulePkg/Core/Pei/PeiMain.inf | 1 - MdeModulePkg/Core/Pei/StatusCode/StatusCode.c | 2 +- 8 files changed, 29 insertions(+), 30 deletions(-) diff --git a/MdeModulePkg/Core/Pei/Dependency/Dependency.c b/MdeModulePkg/Core/Pei/Dependency/Dependency.c index cbdbe35b1e..234e0bf82d 100644 --- a/MdeModulePkg/Core/Pei/Dependency/Dependency.c +++ b/MdeModulePkg/Core/Pei/Dependency/Dependency.c @@ -26,7 +26,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. been published and can be queried from the PPI database. - @param PeiServices The PEI core services table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param Stack Reference to EVAL_STACK_ENTRY that contains PPI GUID to check @retval TRUE if the PPI is already installed. @@ -84,7 +84,7 @@ IsPpiInstalled ( operation types (AND, OR). - @param PeiServices Calling context. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param DependencyExpression Pointer to a dependency expression. The Grammar adheres to the BNF described above and is stored in postfix notation. diff --git a/MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c b/MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c index 53bbecd5bc..a4ed45af52 100644 --- a/MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c +++ b/MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c @@ -175,7 +175,7 @@ DiscoverPeimsAndOrderWithApriori ( /** Shadow PeiCore module from flash to installed memory. - @param PeiServices Pointer to PeiService table + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param PrivateInMem PeiCore's private data structure **/ @@ -793,7 +793,7 @@ PeiRegisterForShadow ( /** Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob. - @param PeiServices Pointer to the PEI Core Services Table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param FvFileHandle File handle of a Fv type file. @param AuthenticationState Pointer to attestation authentication state of image. diff --git a/MdeModulePkg/Core/Pei/FwVol/FwVol.c b/MdeModulePkg/Core/Pei/FwVol/FwVol.c index c507c0be9a..89bac8c6de 100644 --- a/MdeModulePkg/Core/Pei/FwVol/FwVol.c +++ b/MdeModulePkg/Core/Pei/FwVol/FwVol.c @@ -542,7 +542,7 @@ PeiFfsProcessSection ( FFS volume. - @param PeiServices Pointer to the PEI Core Services Table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param SectionType Filter to find only sections of this type. @param FileHandle Pointer to the current file to search. @param SectionData Pointer to the Section matching SectionType in FfsFileHeader. @@ -591,7 +591,7 @@ PeiFfsFindSectionData ( the Firmware Volume defined by FwVolHeader. - @param PeiServices Pointer to the PEI Core Services Table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param SearchType Filter to find only files of this type. Type EFI_FV_FILETYPE_ALL causes no filtering to be done. @param VolumeHandle Pointer to the FV header of the volume to search. @@ -617,7 +617,7 @@ PeiFfsFindNextFile ( /** search the firmware volumes by index - @param PeiServices The PEI core services table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param Instance Instance of FV to find @param VolumeHandle Pointer to found Volume. diff --git a/MdeModulePkg/Core/Pei/Hob/Hob.c b/MdeModulePkg/Core/Pei/Hob/Hob.c index 4eb4b9a892..fcabb8d175 100644 --- a/MdeModulePkg/Core/Pei/Hob/Hob.c +++ b/MdeModulePkg/Core/Pei/Hob/Hob.c @@ -18,7 +18,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Gets the pointer to the HOB List. - @param PeiServices The PEI core services table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param HobList Pointer to the HOB List. @retval EFI_SUCCESS Get the pointer of HOB List @@ -56,7 +56,7 @@ PeiGetHobList ( /** Add a new HOB to the HOB List. - @param PeiServices The PEI core services table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param Type Type of the new HOB. @param Length Length of the new HOB to allocate. @param Hob Pointer to the new HOB. diff --git a/MdeModulePkg/Core/Pei/Image/Image.c b/MdeModulePkg/Core/Pei/Image/Image.c index c4fcea6556..786266b080 100644 --- a/MdeModulePkg/Core/Pei/Image/Image.c +++ b/MdeModulePkg/Core/Pei/Image/Image.c @@ -17,7 +17,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Routine for loading file image. - @param PeiServices The PEI core services table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param FileHandle Pointer to the FFS file header of the image. @param ImageAddressArg Pointer to PE/TE image. @param ImageSizeArg Size of PE/TE image. @@ -225,7 +225,7 @@ LoadAndRelocatePeCoffImage ( /** Routine for loading file image. - @param PeiServices The PEI core services table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param FileHandle Pointer to the FFS file header of the image. @param ImageAddressArg Pointer to PE/TE image. @param ImageSizeArg Size of PE/TE image. @@ -432,14 +432,14 @@ PeiLoadImageLoadImageWrapper ( Routine for load image file. - @param PeiServices - The PEI core services table. - @param FileHandle - Pointer to the FFS file header of the image. - @param EntryPoint - Pointer to entry point of specified image file for output. - @param AuthenticationState - Pointer to attestation authentication state of image. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. + @param FileHandle Pointer to the FFS file header of the image. + @param EntryPoint Pointer to entry point of specified image file for output. + @param AuthenticationState Pointer to attestation authentication state of image. - @retval EFI_SUCCESS - Image is successfully loaded. - @retval EFI_NOT_FOUND - Fail to locate necessary PPI - @retval Others - Fail to load file. + @retval EFI_SUCCESS Image is successfully loaded. + @retval EFI_NOT_FOUND Fail to locate necessary PPI + @retval Others Fail to load file. **/ EFI_STATUS diff --git a/MdeModulePkg/Core/Pei/Memory/MemoryServices.c b/MdeModulePkg/Core/Pei/Memory/MemoryServices.c index de32b69bd2..d24897d776 100644 --- a/MdeModulePkg/Core/Pei/Memory/MemoryServices.c +++ b/MdeModulePkg/Core/Pei/Memory/MemoryServices.c @@ -79,9 +79,9 @@ InitializeMemoryServices ( Install the permanent memory is now available. Creates HOB (PHIT and Stack). - @param PeiServices - The PEI core services table. - @param MemoryBegin - Start of memory address. - @param MemoryLength - Length of memory. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. + @param MemoryBegin Start of memory address. + @param MemoryLength Length of memory. @return EFI_SUCCESS Always success. @@ -114,10 +114,10 @@ PeiInstallPeiMemory ( not usable prior to the memory installation. - @param PeiServices - The PEI core services table. - @param MemoryType - Type of memory to allocate. - @param Pages - Number of pages to allocate. - @param Memory - Pointer of memory allocated. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. + @param MemoryType Type of memory to allocate. + @param Pages Number of pages to allocate. + @param Memory Pointer of memory allocated. @retval EFI_SUCCESS The allocation was successful @retval EFI_INVALID_PARAMETER Only AllocateAnyAddress is supported. @@ -213,9 +213,9 @@ PeiAllocatePages ( Memory allocation service on the CAR. - @param PeiServices - The PEI core services table. - @param Size - Amount of memory required - @param Buffer - Address of pointer to the buffer + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. + @param Size Amount of memory required + @param Buffer Address of pointer to the buffer @retval EFI_SUCCESS The allocation was successful @retval EFI_OUT_OF_RESOURCES There is not enough heap to satisfy the requirement diff --git a/MdeModulePkg/Core/Pei/PeiMain.inf b/MdeModulePkg/Core/Pei/PeiMain.inf index 59eed9f7e8..7a94f53184 100644 --- a/MdeModulePkg/Core/Pei/PeiMain.inf +++ b/MdeModulePkg/Core/Pei/PeiMain.inf @@ -95,4 +95,3 @@ [FeaturePcd.common] gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreImageLoaderSearchTeSectionFirst - diff --git a/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c b/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c index d39311c7a4..5f3e3b63e8 100644 --- a/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c +++ b/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Core version of the Status Code reporter - @param PeiServices The PEI core services table. + @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param CodeType Type of Status Code. @param Value Value to output for Status Code. @param Instance Instance Number of this status code. -- 2.39.2