From ed299e3c41904ce9094471cea348a6c387c1e5fc Mon Sep 17 00:00:00 2001 From: lgao4 Date: Fri, 8 Aug 2008 03:33:16 +0000 Subject: Correct some comments to add the detailed information. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5620 6f19259b-4bc3-4df7-8a09-765794883524 --- MdeModulePkg/Core/Pei/Image/Image.c | 88 ++++++++++++------------------------- 1 file changed, 27 insertions(+), 61 deletions(-) (limited to 'MdeModulePkg/Core/Pei/Image') diff --git a/MdeModulePkg/Core/Pei/Image/Image.c b/MdeModulePkg/Core/Pei/Image/Image.c index 786266b080..6ac537b42f 100644 --- a/MdeModulePkg/Core/Pei/Image/Image.c +++ b/MdeModulePkg/Core/Pei/Image/Image.c @@ -1,7 +1,7 @@ /** @file Pei Core Load Image Support -Copyright (c) 2006 - 2007, Intel Corporation +Copyright (c) 2006 - 2008, Intel Corporation All rights reserved. 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 @@ -14,32 +14,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include -/** - Routine for loading file 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 ImageAddressArg Pointer to PE/TE image. - @param ImageSizeArg Size of PE/TE 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. - -**/ -EFI_STATUS -PeiLoadImageLoadImage ( - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_PEI_FILE_HANDLE FileHandle, - OUT EFI_PHYSICAL_ADDRESS *ImageAddressArg, OPTIONAL - OUT UINT64 *ImageSizeArg, OPTIONAL - OUT EFI_PHYSICAL_ADDRESS *EntryPoint, - OUT UINT32 *AuthenticationState - ) -; - /** The wrapper function of PeiLoadImageLoadImage(). @@ -94,27 +68,17 @@ EFIAPI PeiImageRead ( IN VOID *FileHandle, IN UINTN FileOffset, - IN OUT UINTN *ReadSize, + IN UINTN *ReadSize, OUT VOID *Buffer ) { - CHAR8 *Destination8; - CHAR8 *Source8; - UINTN Length; - - Destination8 = Buffer; - Source8 = (CHAR8 *) ((UINTN) FileHandle + FileOffset); - Length = *ReadSize; - while (Length--) { - *(Destination8++) = *(Source8++); - } - + CopyMem (Buffer, (VOID *)((UINTN) FileHandle + FileOffset), *ReadSize); return EFI_SUCCESS; } /** - Support routine to return the Image Read. + Support routine to get the Image read file function. @param ImageContext - The context of the image being loaded @@ -150,6 +114,7 @@ GetImageReadFunction ( @retval EFI_SUCCESS The file was loaded and relocated @retval EFI_OUT_OF_RESOURCES There was not enough memory to load and relocate the PE/COFF file + @retval EFI_INVALID_PARAMETER The image withou .reloc section can't be relocated. **/ EFI_STATUS @@ -223,18 +188,20 @@ LoadAndRelocatePeCoffImage ( } /** - Routine for loading file image. + Loads a PEIM into memory for subsequent execution. If there are compressed + images or images that need to be relocated into memory for performance reasons, + this service performs that transformation. - @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. + @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. @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 EFI_UNSUPPORTED Image Machine Type is not supported. **/ EFI_STATUS @@ -428,18 +395,18 @@ PeiLoadImageLoadImageWrapper ( } /** + Routine to load image file for subsequent execution by LoadFile Ppi. + If any LoadFile Ppi is not found, the build-in support function for the PE32+/TE + XIP image format is used. - Routine for load image file. - - - @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. + @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 @@ -502,13 +469,12 @@ PeiLoadImage ( /** - Initialize image service that install PeiLoadFilePpi. - @param PrivateData Pointer to PeiCore's private data structure PEI_CORE_INSTANCE. - @param OldCoreData Pointer to Old PeiCore's private data. - If NULL, PeiCore is entered at first time, stack/heap in temporary memory. - If not NULL, PeiCore is entered at second time, stack/heap has been moved - to permenent memory. + Install Pei Load File PPI. + + + @param PrivateData - Pointer to PEI_CORE_INSTANCE. + @param OldCoreData - Pointer to PEI_CORE_INSTANCE. **/ VOID -- cgit v1.2.3