Synchronize function comment in

MdePkg\Library\CpuLib.h, DebugLib.h,DevicePathLib.h, DxeServicesLib.h, DxeServicesTableLib.h, ExtractGuidedSectionLib.h, HobLib.h
with the c file instance of  this functions in MdePkg.

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

7 files changed, 47 insertions, 52 deletions

diff --git a/MdePkg/Include/Library/CpuLib.h b/MdePkg/Include/Library/CpuLib.h
index b54dd26991..b9a1869425 100644
--- a/MdePkg/Include/Library/CpuLib.h
+++ b/MdePkg/Include/Library/CpuLib.h
@@ -7,7 +7,7 @@
   PAL Calls require PEI and DXE specific mechanisms to look up PAL Entry Point.

   As a result, these services could not be defined in the Base Library.

 

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2008, Intel Corporation<BR>

 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

diff --git a/MdePkg/Include/Library/DebugLib.h b/MdePkg/Include/Library/DebugLib.h
index 51da314ea2..0c07aab5fb 100644
--- a/MdePkg/Include/Library/DebugLib.h
+++ b/MdePkg/Include/Library/DebugLib.h
@@ -4,7 +4,7 @@
   The Debug library supports debug print and asserts based on a combination of macros and code.

   The debug library can be turned on and off so that the debug code does not increase the size of an image.

   

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2008, Intel Corporation<BR>

 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

@@ -69,7 +69,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define EFI_D_ERROR     DEBUG_ERROR

 

 /**

-

   Prints a debug message to the debug output device if the specified error level is enabled.

 

   If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print 

@@ -94,7 +93,6 @@ DebugPrint (
 

 

 /**

-

   Prints an assert message containing a filename, line number, and description.  

   This may be followed by a breakpoint or a dead loop.

 

@@ -108,7 +106,6 @@ DebugPrint (
   processing another DebugAssert(), then DebugAssert() must return immediately.

 

   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.

-

   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.

 

   @param  FileName     Pointer to the name of the source file that generated the assert condition.

@@ -126,14 +123,12 @@ DebugAssert (
 

 

 /**

-

   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.

 

   This function fills Length bytes of Buffer with the value specified by 

   PcdDebugClearMemoryValue, and returns Buffer.

 

   If Buffer is NULL, then ASSERT().

-

   If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). 

 

   @param   Buffer  Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.

@@ -151,7 +146,6 @@ DebugClearMemory (
 

 

 /**

-  

   Returns TRUE if ASSERT() macros are enabled.

 

   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of 

@@ -168,9 +162,8 @@ DebugAssertEnabled (
   );

 

 

-/**

-  

-  Returns TRUE if DEBUG()macros are enabled.

+/**  

+  Returns TRUE if DEBUG() macros are enabled.

 

   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of 

   PcdDebugProperyMask is set.  Otherwise FALSE is returned.

@@ -186,9 +179,8 @@ DebugPrintEnabled (
   );

 

 

-/**

-  

-  Returns TRUE if DEBUG_CODE()macros are enabled.

+/**  

+  Returns TRUE if DEBUG_CODE() macros are enabled.

 

   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of 

   PcdDebugProperyMask is set.  Otherwise FALSE is returned.

@@ -204,9 +196,8 @@ DebugCodeEnabled (
   );

 

 

-/**

-  

-  Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.

+/**  

+  Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.

 

   This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of 

   PcdDebugProperyMask is set.  Otherwise FALSE is returned.

@@ -222,8 +213,7 @@ DebugClearMemoryEnabled (
   );

 

 

-/**

-  

+/**  

   Internal worker macro that calls DebugAssert().

 

   This macro calls DebugAssert() passing in the filename, line number, and 

@@ -235,8 +225,7 @@ DebugClearMemoryEnabled (
 #define _ASSERT(Expression)  DebugAssert (__FILE__, __LINE__, #Expression)

 

 

-/**

-  

+/**  

   Internal worker macro that calls DebugPrint().

 

   This macro calls DebugPrint() passing in the debug error level, a format 

@@ -249,8 +238,7 @@ DebugClearMemoryEnabled (
 #define _DEBUG(Expression)   DebugPrint Expression

 

 

-/**

-  

+/**  

   Macro that calls DebugAssert() if a expression evaluates to FALSE.

 

   If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, 

@@ -271,8 +259,7 @@ DebugClearMemoryEnabled (
   } while (FALSE)

 

 

-/**

-  

+/**  

   Macro that calls DebugPrint().

 

   If the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set, 

@@ -291,8 +278,7 @@ DebugClearMemoryEnabled (
   } while (FALSE)

 

 

-/**

-  

+/**  

   Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code.

 

   If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, 

@@ -314,8 +300,7 @@ DebugClearMemoryEnabled (
   } while (FALSE)

 

 

-/**

-  

+/**  

   Macro that calls DebugAssert() if a protocol is already installed in the 

   handle database.

 

@@ -367,8 +352,7 @@ DebugClearMemoryEnabled (
 #define DEBUG_CODE_BEGIN()  do { if (DebugCodeEnabled ()) { UINT8  __DebugCodeLocal

 

 

-/**

-  

+/**  

   Macro that marks the end of debug source code.

 

   If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, 

@@ -380,8 +364,7 @@ DebugClearMemoryEnabled (
 #define DEBUG_CODE_END()    __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)

 

 

-/**

-  

+/**  

   Macro that declares a section of debug source code.

 

   If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, 

@@ -395,8 +378,7 @@ DebugClearMemoryEnabled (
   DEBUG_CODE_END ()

 

 

-/**

-  

+/**  

   Macro that calls DebugClearMemory() to clear a buffer to a default value.

 

   If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set, 

@@ -415,7 +397,6 @@ DebugClearMemoryEnabled (
 

 

 /**

-

   Macro that calls DebugAssert() if the containing record does not have a 

   matching signature.  If the signatures matches, then a pointer to the data 

   structure that contains a specified field of that data structure is returned.  

diff --git a/MdePkg/Include/Library/DevicePathLib.h b/MdePkg/Include/Library/DevicePathLib.h
index 891b5d657a..caa7f9dead 100644
--- a/MdePkg/Include/Library/DevicePathLib.h
+++ b/MdePkg/Include/Library/DevicePathLib.h
@@ -6,7 +6,7 @@
   path nodes make use of the ReadUnaligned16() and WriteUnaligned16() functions from 

   the Base Library, so this library class has an implied dependency on the Base Library.

 

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2008, Intel Corporation<BR>

 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

diff --git a/MdePkg/Include/Library/DxeServicesLib.h b/MdePkg/Include/Library/DxeServicesLib.h
index ef925c9c60..67ddc7f681 100644
--- a/MdePkg/Include/Library/DxeServicesLib.h
+++ b/MdePkg/Include/Library/DxeServicesLib.h
@@ -2,7 +2,7 @@
   MDE DXE Services Library provides functions that simplify the development of DXE Drivers.  

   These functions help access data from sections of FFS files.

 

-  Copyright (c) 2008, Intel Corporation                                                         

+  Copyright (c) 2008, Intel Corporation<BR>                                                         

   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        

@@ -45,12 +45,12 @@
   @param  SectionType          Indicates the FFS section type to search for within the FFS file specified by NameGuid.

   @param  SectionInstance      Indicates which section instance within the FFS file specified by NameGuid to retrieve.

   @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  

-                               Is it the caller's respobsibility to free this buffer using FreePool().

+                               Is it the caller's responsibility to free this buffer using FreePool().

   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.

 

   @retval  EFI_SUCCESS          The specified FFS section was returned.

   @retval  EFI_NOT_FOUND        The specified FFS section could not be found.

-  @retval  EFI_OUT_OF_RESOURCES There are not enough rsources available to retrieve the matching FFS section.

+  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.

   @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a device error.

   @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the firmware volume that 

                                 contains the matching FFS section does not allow reads.

@@ -91,13 +91,13 @@ GetSectionFromAnyFv  (
   @param  SectionType          Indicates the FFS section type to search for within the FFS file specified by NameGuid.

   @param  SectionInstance      Indicates which section instance within the FFS file specified by NameGuid to retrieve.

   @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  

-                               Is it the caller's respobsibility to free this buffer using FreePool().

+                               Is it the caller's responsibility to free this buffer using FreePool().

   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.

 

 

   @retval  EFI_SUCCESS          The specified FFS section was returned.

   @retval  EFI_NOT_FOUND        The specified FFS section could not be found.

-  @retval  EFI_OUT_OF_RESOURCES There are not enough rsources available to retrieve the matching FFS section.

+  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.

   @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a device error.

   @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the firmware volume that 

                                 contains the matching FFS section does not allow reads.  

@@ -137,12 +137,12 @@ GetSectionFromFv (
   @param  SectionInstance      Indicates which section instance to retrieve within the FFS file 

                                that the currently executing module was loaded from.

   @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  

-                               Is it the caller's respobsibility to free this buffer using FreePool().

+                               Is it the caller's responsibility to free this buffer using FreePool().

   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.

 

   @retval  EFI_SUCCESS          The specified FFS section was returned.

   @retval  EFI_NOT_FOUND        The specified FFS section could not be found.

-  @retval  EFI_OUT_OF_RESOURCES There are not enough rsources available to retrieve the matching FFS section.

+  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.

   @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a device error.

   @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the firmware volume that 

                                 contains the matching FFS section does not allow reads.  

diff --git a/MdePkg/Include/Library/DxeServicesTableLib.h b/MdePkg/Include/Library/DxeServicesTableLib.h
index 928730682b..2be06e4209 100644
--- a/MdePkg/Include/Library/DxeServicesTableLib.h
+++ b/MdePkg/Include/Library/DxeServicesTableLib.h
@@ -11,7 +11,7 @@
   Table should use this library.  This will typically be DXE Drivers that require GCD 

   or Dispatcher services.

    

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2008, Intel Corporation<BR>

 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

diff --git a/MdePkg/Include/Library/ExtractGuidedSectionLib.h b/MdePkg/Include/Library/ExtractGuidedSectionLib.h
index be963cb5a7..003fc898ba 100644
--- a/MdePkg/Include/Library/ExtractGuidedSectionLib.h
+++ b/MdePkg/Include/Library/ExtractGuidedSectionLib.h
@@ -1,7 +1,16 @@
 /** @file

   This library provides common functions to process the different guided section data. 

+  

+  This library provides functions to process GUIDed sections of FFS files.  Handlers may 

+  be registered to decode GUIDed sections of FFS files.  Services are provided to determine 

+  the set of supported section GUIDs, collection information about a specific GUIDed section, 

+  and decode a specific GUIDed section. 

+  

+  A library instance that produces this library class may be used to produce a 

+  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI or a EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL 

+  providing a simple method to extend the number of GUIDed sections types a platform supports.

 

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2008, Intel Corporation<BR>

 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

@@ -27,6 +36,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   then the size required to hold the decoded buffer is returned in OututBufferSize,

   the size of an optional scratch buffer is returned in ScratchSize, and the Attributes field

   from EFI_GUID_DEFINED_SECTION header of InputSection is returned in SectionAttribute.

+  

   If InputSection is NULL, then ASSERT().

   If OutputBufferSize is NULL, then ASSERT().

   If ScratchBufferSize is NULL, then ASSERT().

@@ -66,6 +76,7 @@ RETURN_STATUS
   decode operation is returned in AuthenticationStatus.  If the decoded buffer is identical to the

   data in InputSection, then OutputBuffer is set to point at the data in InputSection.  Otherwise,

   the decoded data will be placed in caller allocated buffer specified by OutputBuffer.

+  

   If InputSection is NULL, then ASSERT().

   If OutputBuffer is NULL, then ASSERT().

   If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().

@@ -100,9 +111,10 @@ RETURN_STATUS
   Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER

   for a specific GUID section type.

 

-  Registers the handlers specified by GetInfoHandler and DecodeHandler witg the GUID specified by SectionGuid.

+  Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid.

   If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.

   If there are not enough resources available to register the handlers  then RETURN_OUT_OF_RESOURCES is returned.

+  

   If SectionGuid is NULL, then ASSERT().

   If GetInfoHandler is NULL, then ASSERT().

   If DecodeHandler is NULL, then ASSERT().

@@ -136,7 +148,7 @@ ExtractGuidedSectionRegisterHandlers (
   and caller must treat this array of GUIDs as read-only data. 

   If ExtractHandlerGuidTable is NULL, then ASSERT().

 

-  @param[out]  ExtractHandlerGuidTable  A pointer to the array of GUIDs tht have been registerd through

+  @param[out]  ExtractHandlerGuidTable  A pointer to the array of GUIDs that have been registered through

                                         ExtractGuidedSectionRegisterHandlers().

 

   @return the number of the supported extract guided Handler.

@@ -149,7 +161,7 @@ ExtractGuidedSectionGetGuidList (
   );

 

 /**

-  Retrives a GUID from a GUIDed section and uses that GUID to select an associated handler of type

+  Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type

   EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().

   The selected handler is used to retrieve and return the size of the decoded buffer and the size of an

   optional scratch buffer required to actually decode the data in a GUIDed section.

@@ -161,6 +173,7 @@ ExtractGuidedSectionGetGuidList (
   of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()

   is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of

   type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.

+  

   If InputSection is NULL, then ASSERT().

   If OutputBufferSize is NULL, then ASSERT().

   If ScratchBufferSize is NULL, then ASSERT().

@@ -191,7 +204,7 @@ ExtractGuidedSectionGetInfo (
   );

 

 /**

-  Retrives the GUID from a GUIDed section and uses that GUID to select an associated handler of type

+  Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type

   EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().

   The selected handler is used to decode the data in a GUIDed section and return the result in a caller

   allocated output buffer.

@@ -205,7 +218,8 @@ ExtractGuidedSectionGetInfo (
   decode operation is returned in AuthenticationStatus.  If the decoded buffer is identical to the data in InputSection,

   then OutputBuffer is set to point at the data in InputSection.  Otherwise, the decoded data will be placed in caller

   allocated buffer specified by OutputBuffer.    This function is responsible for computing the  EFI_AUTH_STATUS_PLATFORM_OVERRIDE

-  bit of in AuthenticationStatus.  The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned.  

+  bit of in AuthenticationStatus.  The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned. 

+   

   If InputSection is NULL, then ASSERT().

   If OutputBuffer is NULL, then ASSERT().

   If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().

diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h
index 2e81704421..7f999e1ab8 100644
--- a/MdePkg/Include/Library/HobLib.h
+++ b/MdePkg/Include/Library/HobLib.h
@@ -8,7 +8,7 @@
   allows the PEI phase to pass information to the DXE phase. HOBs are position 

   independent and can be relocated easily to different memory memory locations.

 

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2008, Intel Corporation<BR>

 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