Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Ppi/FirmwareVolume.h b/MdePkg/Include/Ppi/FirmwareVolume.h
index 953ea6ac60b108a4d3048769aee603a7e77fa000..5a8f87c49bdf96fa0c65bd32de649f34c40fd191 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolume.h
+++ b/MdePkg/Include/Ppi/FirmwareVolume.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   This file provides functions for accessing a memory-mapped firmware volume of a specific format.\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
@@ -10,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  FirmwareVolume.h\r
-\r
   @par Revision Reference:\r
   This PPI is defined in PI.\r
   Version 1.00\r
@@ -31,6 +29,8 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI   EFI_PEI_FIRMWARE_VOLUME_PPI;
 \r
 \r
 /**\r
+  Process a firmware volume and create a volume handle.\r
+\r
   Create a volume handle from the information in the buffer. For\r
   memory-mapped firmware volumes, Buffer and BufferSize refer to\r
   the start of the firmware volume and the firmware volume size.\r
@@ -55,41 +55,18 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI   EFI_PEI_FIRMWARE_VOLUME_PPI;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_FV_PROCESS_FV) (\r
+(EFIAPI *EFI_PEI_FV_PROCESS_FV)(\r
   IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
   IN CONST  VOID                        *Buffer,\r
   IN CONST  UINTN                       BufferSize,\r
   OUT       EFI_PEI_FV_HANDLE           *FvHandle\r
 );\r
 \r
-\r
 /**\r
-  Create a volume handle from the information in the buffer. For\r
-  memory-mapped firmware volumes, Buffer and BufferSize refer to\r
-  the start of the firmware volume and the firmware volume size.\r
-  For non memory-mapped firmware volumes, this points to a\r
-  buffer which contains the necessary information for creating\r
-  the firmware volume handle. Normally, these values are derived\r
-  from the EFI_FIRMWARE_VOLUME_INFO_PPI.\r
-  \r
-  \r
-  @param This         Points to this instance of the\r
-                      EFI_PEI_FIRMWARE_VOLUME_PPI\r
-  @param Buffer       Points to the start of the buffer.\r
-  @param BufferSize   Size of the buffer.\r
-  @param FvHandle     Points to the returned firmware volume\r
-                      handle. The firmware volume handle must\r
-                      be unique within the system. \r
+  Finds the next file of the specified type.\r
 \r
-\r
-  @retval EFI_SUCCESS           Firmware volume handle.\r
-  @retval EFI_VOLUME_CORRUPTED  Volume was corrupt.\r
-\r
-**/\r
-\r
-/**\r
-  This service enables PEI modules to discover additional firmware files. The FileHandle must be\r
-  unique within the system.\r
+  This service enables PEI modules to discover additional firmware files. \r
+  The FileHandle must be unique within the system.\r
 \r
   @param This       Points to this instance of the\r
                     EFI_PEI_FIRMWARE_VOLUME_PPI. SearchType A filter\r
@@ -106,11 +83,10 @@ EFI_STATUS
 \r
 \r
   @retval EFI_SUCCESS   The file was found.\r
-  @retval EFI_NOT_FOUND The file was not found. FileHandle\r
-                        contains NULL.\r
+  @retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL.\r
 **/ \r
 typedef EFI_STATUS\r
-(EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE) ( \r
+(EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( \r
   IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI   *This, \r
   IN CONST  EFI_FV_FILETYPE               SearchType, \r
   IN CONST  EFI_PEI_FV_HANDLE             FvHandle,\r
@@ -119,7 +95,8 @@ typedef EFI_STATUS
 \r
 \r
 /**\r
-   \r
+  Find a file within a volume by its name. \r
+  \r
   This service searches for files with a specific name, within\r
   either the specified firmware volume or all firmware volumes.\r
 \r
@@ -149,7 +126,7 @@ typedef EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_FV_FIND_FILE_NAME) (\r
+(EFIAPI *EFI_PEI_FV_FIND_FILE_NAME)(\r
   IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
   IN CONST  EFI_GUID                    *FileName,\r
   IN CONST  EFI_PEI_FV_HANDLE           FvHandle,\r
@@ -158,6 +135,8 @@ EFI_STATUS
 \r
 \r
 /**\r
+  Returns information about a specific file.\r
+\r
   This function returns information about a specific\r
   file, including its file name, type, attributes, starting\r
   address and size. \r
@@ -180,7 +159,7 @@ EFI_STATUS
 **/ \r
 \r
 typedef\r
-EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_FILE_INFO) (\r
+EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_FILE_INFO)(\r
   IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI   *This, \r
   IN  CONST EFI_PEI_FILE_HANDLE           FileHandle, \r
   OUT       EFI_FV_FILE_INFO              *FileInfo\r
@@ -213,6 +192,8 @@ EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_INFO)(
 );\r
 \r
 /**\r
+  Find the next matching section in the firmware file.\r
+  \r
   This service enables PEI modules to discover sections of a given type within a valid file.\r
   \r
   @param This   Points to this instance of the\r
@@ -234,7 +215,7 @@ EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_INFO)(
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_FV_FIND_SECTION) (\r
+(EFIAPI *EFI_PEI_FV_FIND_SECTION)(\r
   IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI   *This,\r
   IN CONST  EFI_SECTION_TYPE              SearchType,\r
   IN CONST  EFI_PEI_FILE_HANDLE           FileHandle,\r
@@ -244,6 +225,7 @@ EFI_STATUS
 \r
 \r
 /*\r
+  @par Ppi Description:\r
   This PPI provides functions for accessing a memory-mapped firmware volume of a specific format.\r
 \r
   @param  ProcessVolume       Process a firmware volume and create a volume handle.\r