Add comments and DoxyGen format for these files.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5028 6f19259b-4bc3-4df7-8a09-765794883524

5 files changed, 108 insertions, 52 deletions

diff --git a/MdeModulePkg/Include/Guid/AlternateFvBlock.h b/MdeModulePkg/Include/Guid/AlternateFvBlock.h
index 5eac2fe620..4ea8a2143d 100644
--- a/MdeModulePkg/Include/Guid/AlternateFvBlock.h
+++ b/MdeModulePkg/Include/Guid/AlternateFvBlock.h
@@ -1,6 +1,8 @@
-/*++

+/** @file

 

-Copyright (c) 2006 - 2007, Intel Corporation

+  Tiano Guid used to define the Alternate Firmware Volume Block Guid.

+

+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

@@ -9,15 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-Module Name:

-

-  AlternateFvBlock.h

-

-Abstract:

-

-  Tiano Guid used to define the Alternate Firmware Volume Block Guid.

-

---*/

+**/

 

 #ifndef __ALT_FVB_GUID_H__

 #define __ALT_FVB_GUID_H__

diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h
index 8ac5d0cf46..118e08b5b1 100644
--- a/MdeModulePkg/Include/Guid/CapsuleVendor.h
+++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h
@@ -1,6 +1,8 @@
-/*++

+/** @file

 

-Copyright (c) 2006 - 2007, Intel Corporation

+  Capsule update Guid definitions for capsule varialbe and capsule hob.

+

+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

@@ -9,15 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-Module Name:

-

-  CapsuleVendor.h

-

-Abstract:

-

-  Capsule update Guid definitions

-

---*/

+**/

 

 #ifndef __EFI_CAPSULE_VENDOR_GUID_H__

 #define __EFI_CAPSULE_VENDOR_GUID_H__

diff --git a/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h b/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h
index 95ee354277..eaca8e6f23 100644
--- a/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h
+++ b/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h
@@ -1,21 +1,17 @@
-/*++

+/** @file

+  

+  GUID for the PE/COFF Loader APIs shared between SEC, PEI and DXE

 

-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        

 http://opensource.org/licenses/bsd-license.php                                            

                                                                                           

 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.               

 

-Module Name:

-    PeiPeCoffLoader.h

-    

-Abstract:

-  GUID for the PE/COFF Loader APIs shared between PEI and DXE

-

---*/

+**/

 

 #ifndef __PEI_PE_COFF_LOADER_H__

 #define __PEI_PE_COFF_LOADER_H__

@@ -30,30 +26,107 @@ Abstract:
 

 typedef struct _EFI_PEI_PE_COFF_LOADER_PROTOCOL   EFI_PEI_PE_COFF_LOADER_PROTOCOL;

 

+/**

+  Retrieves information about a PE/COFF image.

+

+  Computes the PeCoffHeaderOffset, ImageAddress, ImageSize, DestinationAddress, CodeView,

+  PdbPointer, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva

+  fields of the ImageContext structure.  If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.

+  If the PE/COFF image accessed through the ImageRead service in the ImageContext structure is not

+  a supported PE/COFF image type, then return RETURN_UNSUPPORTED.  If any errors occur while

+  computing the fields of ImageContext, then the error status is returned in the ImageError field of

+  ImageContext. 

+

+  @param  This                      Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.

+  @param  ImageContext              Pointer to the image context structure that describes the PE/COFF

+                                    image that needs to be examined by this function.

+

+  @retval RETURN_SUCCESS            The information on the PE/COFF image was collected.

+  @retval RETURN_INVALID_PARAMETER  ImageContext is NULL.

+  @retval RETURN_UNSUPPORTED        The PE/COFF image is not supported.

 

+**/

 typedef 

-EFI_STATUS

+RETURN_STATUS

 (EFIAPI *EFI_PEI_PE_COFF_LOADER_GET_IMAGE_INFO) (

   IN EFI_PEI_PE_COFF_LOADER_PROTOCOL          *This,

   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT         *ImageContext

   );

 

+/**

+  Loads a PE/COFF image into memory.

+

+  Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer

+  specified by the ImageAddress and ImageSize fields of ImageContext.  The caller must allocate

+  the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.

+  The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.

+  If ImageContext is NULL, then ASSERT().

+

+  @param  This                      Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.

+  @param  ImageContext              Pointer to the image context structure that describes the PE/COFF

+                                    image that is being loaded.

+

+  @retval RETURN_SUCCESS            The PE/COFF image was loaded into the buffer specified by

+                                    the ImageAddress and ImageSize fields of ImageContext.

+                                    Extended status information is in the ImageError field of ImageContext.

+  @retval RETURN_BUFFER_TOO_SMALL   The caller did not provide a large enough buffer.

+                                    Extended status information is in the ImageError field of ImageContext.

+  @retval RETURN_LOAD_ERROR         The PE/COFF image is an EFI Runtime image with no relocations.

+                                    Extended status information is in the ImageError field of ImageContext.

+  @retval RETURN_INVALID_PARAMETER  The image address is invalid.

+                                    Extended status information is in the ImageError field of ImageContext.

+

+**/

 typedef 

-EFI_STATUS

+RETURN_STATUS

 (EFIAPI *EFI_PEI_PE_COFF_LOADER_LOAD_IMAGE) (

   IN EFI_PEI_PE_COFF_LOADER_PROTOCOL          *This,

   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT         *ImageContext

   );

 

+/**

+  Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().

+

+  If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of

+  ImageContext as the relocation base address.  Otherwise, use the DestinationAddress field

+  of ImageContext as the relocation base address.  The caller must allocate the relocation

+  fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.  

+  If ImageContext is NULL, then ASSERT().

+

+  @param  This                Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.

+  @param  ImageContext        Pointer to the image context structure that describes the PE/COFF

+                              image that is being relocated.

+

+  @retval RETURN_SUCCESS      The PE/COFF image was relocated.

+                              Extended status information is in the ImageError field of ImageContext.

+  @retval RETURN_LOAD_ERROR   The image in not a valid PE/COFF image.

+                              Extended status information is in the ImageError field of ImageContext.

+  @retval RETURN_UNSUPPORTED  A relocation record type is not supported.

+                              Extended status information is in the ImageError field of ImageContext.

+

+**/

 typedef 

-EFI_STATUS

+RETURN_STATUS

 (EFIAPI *EFI_PEI_PE_COFF_LOADER_RELOCATE_IMAGE) (

   IN EFI_PEI_PE_COFF_LOADER_PROTOCOL          *This,

   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT         *ImageContext

   );

 

+/**

+  Unloads a loaded PE/COFF image from memory and releases its taken resource.

+   

+  For NT32 emulator, the PE/COFF image loaded by system needs to release.

+  For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, 

+  this function can simply return RETURN_SUCCESS.

+

+  @param  This                      Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.

+  @param  ImageContext              Pointer to the image context structure that describes the PE/COFF

+                                    image to be unloaded.

+

+  @retval RETURN_SUCCESS            The PE/COFF image was unloaded successfully.

+**/

 typedef 

-EFI_STATUS

+RETURN_STATUS

 (EFIAPI *EFI_PEI_PE_COFF_LOADER_UNLOAD_IMAGE) (

   IN EFI_PEI_PE_COFF_LOADER_PROTOCOL          *This,

   IN PE_COFF_LOADER_IMAGE_CONTEXT         *ImageContext

diff --git a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
index 946d4d8d03..fd807f93a2 100644
--- a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
+++ b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
@@ -1,6 +1,9 @@
-/*++

+/** @file

 

-Copyright (c) 2006, Intel Corporation                                                         

+  GUIDs used for System Non Volatile HOB entries in the in the HOB list and FV Guids carrying

+  the System specific information.

+

+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        

@@ -9,16 +12,7 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

 

-Module Name:

-  

-    SystemNvDataGuid.h

-    

-Abstract:

-

-  GUIDs used for System Non Volatile HOB entries in the in the HOB list and FV Guids carrying

-  the System specific information.

-

---*/

+**/

 

 #ifndef __SYSTEM_NV_DATA_GUID_H__

 #define __SYSTEM_NV_DATA_GUID_H__

diff --git a/MdeModulePkg/Include/Guid/VariableInfo.h b/MdeModulePkg/Include/Guid/VariableInfo.h
index d6eb734d94..a7e624d90f 100644
--- a/MdeModulePkg/Include/Guid/VariableInfo.h
+++ b/MdeModulePkg/Include/Guid/VariableInfo.h
@@ -1,6 +1,8 @@
-/*++

+/** @file

 

-Copyright (c) 2006 - 2007, Intel Corporation

+  GUIDs used for variable list entries put in the EFI system table.

+

+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

@@ -9,8 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-

---*/

+**/

 

 #ifndef __VARIABLE_INFO_GUID_H__

 #define __VARIABLE_INFO_GUID_H__