Minor code enhancement.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / FindFv.h

diff --git a/IntelFrameworkPkg/Include/Ppi/FindFv.h b/IntelFrameworkPkg/Include/Ppi/FindFv.h
index 9a3e173742b71afe72e3a1803035c00539f3df98..40c3177f9f591de3b5d0c0d51f650eea125ac4e5 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/FindFv.h
+++ b/IntelFrameworkPkg/Include/Ppi/FindFv.h
@@ -1,16 +1,14 @@
 /** @file\r
   This file declares FindFv PPI used to locate FVs that contain PEIMs in PEI\r
 \r
-  Copyright (c) 2006, 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2007 - 2009, 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
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  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:  FindFv.h\r
+  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
   @par Revision Reference:\r
   This PPI is defined in PEI CIS\r
@@ -18,9 +16,13 @@
 \r
 **/\r
 \r
-#ifndef __FIND_FV_H__\r
-#define __FIND_FV_H__\r
+#ifndef _FIND_FV_H_\r
+#define _FIND_FV_H_\r
 \r
+///\r
+///  Inconsistent with specification here: \r
+///  GUID value format has been changed to the standard GUID format.\r
+///\r
 #define EFI_PEI_FIND_FV_PPI_GUID \\r
   { \\r
     0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \\r
@@ -29,8 +31,8 @@
 typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;\r
 \r
 /**\r
-  This interface returns the base address of the firmware volume whose index \r
-  was passed in FvNumber.Once this function reports a firmware volume \r
+  This interface returns the base address of the firmware volume whose index\r
+  was passed in FvNumber. Once this function reports a firmware volume\r
   index/base address pair, that index/address pairing must continue throughout PEI.\r
 \r
   @param  PeiServices    Pointer to the PEI Services Table.\r
@@ -45,25 +47,20 @@ typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_FIND_FV_FINDFV) (\r
-  IN EFI_PEI_FIND_FV_PPI      *This,\r
-  IN EFI_PEI_SERVICES         **PeiServices,\r
-  UINT8                       *FvNumber,\r
-  EFI_FIRMWARE_VOLUME_HEADER  **FVAddress\r
+(EFIAPI *EFI_PEI_FIND_FV_FINDFV)(\r
+  IN EFI_PEI_FIND_FV_PPI             *This,\r
+  IN EFI_PEI_SERVICES                **PeiServices,\r
+  IN UINT8                           *FvNumber,\r
+  IN OUT EFI_FIRMWARE_VOLUME_HEADER  **FVAddress\r
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   Hardware mechanisms for locating FVs in a platform vary widely.\r
-  EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the \r
+  EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the\r
   PEI Foundation can remain standard across a wide variety of platforms.\r
-\r
-  @param FindFv\r
-  Service that abstracts the location of additional firmware volumes.\r
-\r
 **/\r
 struct _EFI_PEI_FIND_FV_PPI {\r
-  EFI_PEI_FIND_FV_FINDFV  FindFv;\r
+  EFI_PEI_FIND_FV_FINDFV  FindFv;   ///< Service that abstracts the location of additional firmware volumes.\r
 };\r
 \r
 extern EFI_GUID gEfiFindFvPpiGuid;\r