From dafa11b191748a841a2a6a4ebab5e40c21026401 Mon Sep 17 00:00:00 2001 From: xli24 Date: Thu, 4 Sep 2008 09:15:21 +0000 Subject: Update MdePkg/Include/Ppi according to code review comments. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5818 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Ppi/LoadFile.h | 86 ++++++++++++++++--------------------------- 1 file changed, 32 insertions(+), 54 deletions(-) (limited to 'MdePkg/Include/Ppi/LoadFile.h') diff --git a/MdePkg/Include/Ppi/LoadFile.h b/MdePkg/Include/Ppi/LoadFile.h index 96955f764a..79cf0cd299 100644 --- a/MdePkg/Include/Ppi/LoadFile.h +++ b/MdePkg/Include/Ppi/LoadFile.h @@ -27,70 +27,48 @@ typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI; /** Loads a PEIM into memory for subsequent execution. - This service is the single member function of EFI_LOAD_FILE_PPI. This service separates - image loading and relocating from the PEI Foundation. + This service is the single member function of EFI_LOAD_FILE_PPI. + This service separates image loading and relocating from the PEI Foundation. - @param This Interface pointer that implements - the Load File PPI instance. - - @param FileHandle File handle of the file to load. - Type EFI_PEI_FILE_HANDLE is defined in - FfsFindNextFile(). - - @param ImageAddress Pointer to the address of the - loaded image. - - @param ImageSize Pointer to the size of the loaded - image. - - @param EntryPoint Pointer to the entry point of the - image. - - @param AuthenticationState On exit, points to the attestation - authentication state of the image - or 0 if no attestation was - performed. The format of - AuthenticationState is defined in - EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI.ExtractSection() - - - @retval EFI_SUCCESS The image was loaded successfully. - + @param This Interface pointer that implements + the Load File PPI instance. + @param FileHandle File handle of the file to load. + @param ImageAddress Pointer to the address of the loaded image. + @param ImageSize Pointer to the size of the loaded image. + @param EntryPoint Pointer to the entry point of the image. + @param AuthenticationState On exit, points to the attestation + authentication state of the image + or 0 if no attestation was performed. + + @retval EFI_SUCCESS The image was loaded successfully. @retval EFI_OUT_OF_RESOURCES There was not enough memory. - - @retval EFI_LOAD_ERROR There was no supported image in - the file. - @retval EFI_INVALID_PARAMETER EntryPoint was NULL. - Or FileHandle was not a valid firmware file handle. - @retval EFI_NOT_SUPPORTED An image requires relocations or - is not memory mapped. + @retval EFI_LOAD_ERROR There was no supported image in the file. + @retval EFI_INVALID_PARAMETER FileHandle was not a valid firmware file handle. + @retval EFI_INVALID_PARAMETER EntryPoint was NULL. + @retval EFI_NOT_SUPPORTED An image requires relocations or is not + memory mapped. **/ typedef EFI_STATUS (EFIAPI *EFI_PEI_LOAD_FILE)( - IN CONST EFI_PEI_LOAD_FILE_PPI *This, - IN CONST EFI_PEI_FILE_HANDLE FileHandle, - OUT EFI_PHYSICAL_ADDRESS *ImageAddress, - OUT UINT64 *ImageSize, - OUT EFI_PHYSICAL_ADDRESS *EntryPoint, - OUT UINT32 *AuthenticationState + IN CONST EFI_PEI_LOAD_FILE_PPI *This, + IN EFI_PEI_FILE_HANDLE FileHandle, + OUT EFI_PHYSICAL_ADDRESS *ImageAddress, + OUT UINT64 *ImageSize, + OUT EFI_PHYSICAL_ADDRESS *EntryPoint, + OUT UINT32 *AuthenticationState ); - -/** - @par Ppi Description: - This PPI is a pointer to the Load File service. - This service will be published by a PEIM. The PEI Foundation - will use this service to launch the known PEI module images. - - - @param LoadFile Loads a PEIM into memory for subsequent - execution. See the LoadFile() function - description. - -**/ +/// +/// This PPI is a pointer to the Load File service. +/// This service will be published by a PEIM. The PEI Foundation +/// will use this service to launch the known PEI module images. +/// struct _EFI_PEI_LOAD_FILE_PPI { + /// + /// Loads a PEIM into memory for subsequent execution. + /// EFI_PEI_LOAD_FILE LoadFile; }; -- cgit v1.2.3