Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Ppi / LoadFile.h

diff --git a/MdePkg/Include/Ppi/LoadFile.h b/MdePkg/Include/Ppi/LoadFile.h
index 542724b9ded377bc70a4fe881e89af5b0cb6f446..96955f764a9019988fa83db2b06764e7372e8a56 100644 (file)
--- a/MdePkg/Include/Ppi/LoadFile.h
+++ b/MdePkg/Include/Ppi/LoadFile.h
@@ -1,7 +1,7 @@
 /** @file\r
   Load image file from fv to memory. \r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -15,8 +15,8 @@
 \r
 **/\r
 \r
-#ifndef __FV_FILE_LOADER_PPI_H__\r
-#define __FV_FILE_LOADER_PPI_H__\r
+#ifndef __LOAD_FILE_PPI_H__\r
+#define __LOAD_FILE_PPI_H__\r
 \r
 #define EFI_PEI_LOAD_FILE_PPI_GUID \\r
   { 0xb9e0abfe, 0x5979, 0x4914, { 0x97, 0x7f, 0x6d, 0xee, 0x78, 0xc2, 0x78, 0xa6 } }\r
@@ -25,6 +25,8 @@
 typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;\r
 \r
 /**\r
+  Loads a PEIM into memory for subsequent execution.\r
+\r
   This service is the single member function of EFI_LOAD_FILE_PPI. This service separates\r
   image loading and relocating from the PEI Foundation.\r
   \r
@@ -57,18 +59,16 @@ typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;
   @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r
 \r
   @retval EFI_LOAD_ERROR      There was no supported image in\r
-                              the file EFI_INVALID_PARAMETER\r
-                              FileHandle was not a valid\r
-                              firmware file handle.\r
+                              the file.\r
   @retval EFI_INVALID_PARAMETER   EntryPoint was NULL.\r
-\r
+                              Or FileHandle was not a valid firmware file handle.\r
   @retval EFI_NOT_SUPPORTED   An image requires relocations or\r
                               is not memory mapped.\r
    \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_LOAD_FILE) (\r
+(EFIAPI *EFI_PEI_LOAD_FILE)(\r
   IN CONST  EFI_PEI_LOAD_FILE_PPI   *This,\r
   IN CONST  EFI_PEI_FILE_HANDLE     FileHandle,\r
   OUT       EFI_PHYSICAL_ADDRESS    *ImageAddress,\r
@@ -79,6 +79,7 @@ EFI_STATUS
 \r
 \r
 /**\r
+  @par Ppi Description:\r
   This PPI is a pointer to the Load File service.\r
   This service will be published by a PEIM. The PEI Foundation\r
   will use this service to launch the known PEI module images.\r
@@ -93,55 +94,6 @@ struct _EFI_PEI_LOAD_FILE_PPI {
   EFI_PEI_LOAD_FILE LoadFile;\r
 };\r
 \r
-\r
-\r
-#define EFI_PEI_FV_FILE_LOADER_GUID \\r
-  { \\r
-    0x7e1f0d85, 0x4ff, 0x4bb2, {0x86, 0x6a, 0x31, 0xa2, 0x99, 0x6a, 0x48, 0xa8 } \\r
-  }\r
-\r
-typedef struct _EFI_PEI_FV_FILE_LOADER_PPI  EFI_PEI_FV_FILE_LOADER_PPI;\r
-\r
-/**\r
-  Loads a PEIM into memory for subsequent execution.\r
-\r
-  @param  This           Interface pointer that implements the Load File PPI instance.\r
-  @param  FfsHeader      Pointer to the FFS header of the file to load.\r
-  @param  ImageAddress   Pointer to the address of the loaded Image\r
-  @param  ImageSize      Pointer to the size of the loaded image.\r
-  @param  EntryPoint     Pointer to the entry point of the image.\r
-\r
-  @retval EFI_SUCCESS           The image was loaded successfully.\r
-  @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r
-  @retval EFI_INVALID_PARAMETER The contents of the FFS file did not\r
-                                contain a valid PE/COFF image that could be loaded.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_PEI_FV_LOAD_FILE) (\r
-  IN EFI_PEI_FV_FILE_LOADER_PPI                 *This,\r
-  IN  EFI_FFS_FILE_HEADER                       *FfsHeader,\r
-  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
-  OUT UINT64                                    *ImageSize,\r
-  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
-  );\r
-\r
-/**\r
-  @par Ppi Description:\r
-  This PPI is a pointer to the Load File service. This service will be \r
-  published by a PEIM.The PEI Foundation will use this service to \r
-  launch the known non-XIP PE/COFF PEIM images.  This service may \r
-  depend upon the presence of the EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI.\r
-\r
-  @param FvLoadFile\r
-  Loads a PEIM into memory for subsequent execution\r
-\r
-**/\r
-struct _EFI_PEI_FV_FILE_LOADER_PPI {\r
-  EFI_PEI_FV_LOAD_FILE  FvLoadFile;\r
-};\r
-\r
-extern EFI_GUID gEfiPeiFvFileLoaderPpiGuid;\r
+extern EFI_GUID gEfiPeiLoadFilePpiGuid;\r
 \r
 #endif\r