1. added functions header for BaseUefiDecompressLi

2. added some internal functions header for BaseLib
3. added EFIAPI for some internal assembly files declare

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

2 files changed, 76 insertions, 0 deletions

diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index ea61da1..6a43c16 100644
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@@ -2474,6 +2474,14 @@ InterlockedDecrement (
 /**

   Performs an atomic compare exchange operation on a 32-bit unsigned integer.

 

+  Performs an atomic compare exchange operation on the 32-bit unsigned integer

+  specified by Value.  If Value is equal to CompareValue, then Value is set to 

+  ExchangeValue and CompareValue is returned.  If Value is not equal to CompareValue,

+  then Value is returned.  The compare exchange operation must be performed using 

+  MP safe mechanisms.

+

+  If Value is NULL, then ASSERT().

+

   @param  Value         A pointer to the 32-bit value for the compare exchange

                         operation.

   @param  CompareValue  32-bit value used in compare operation.

@@ -2493,6 +2501,13 @@ InterlockedCompareExchange32 (
 /**

   Performs an atomic compare exchange operation on a 64-bit unsigned integer.

 

+  Performs an atomic compare exchange operation on the 64-bit unsigned integer specified 

+  by Value.  If Value is equal to CompareValue, then Value is set to ExchangeValue and 

+  CompareValue is returned.  If Value is not equal to CompareValue, then Value is returned. 

+  The compare exchange operation must be performed using MP safe mechanisms.

+

+  If Value is NULL, then ASSERT().

+

   @param  Value         A pointer to the 64-bit value for the compare exchange

                         operation.

   @param  CompareValue  64-bit value used in compare operation.

@@ -2566,6 +2581,7 @@ MemoryFence (
   calls to LongJump() cause a non-zero value to be returned by SetJump().

 

   If JumpBuffer is NULL, then ASSERT().

+  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().

 

   @param  JumpBuffer  A pointer to CPU context buffer.

 

@@ -2586,6 +2602,7 @@ SetJump (
   the state of JumpBuffer.

 

   If JumpBuffer is NULL, then ASSERT().

+  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().

   If Value is 0, then ASSERT().

 

   @param  JumpBuffer  A pointer to CPU context buffer.

diff --git a/MdePkg/Include/Library/UefiDecompressLib.h b/MdePkg/Include/Library/UefiDecompressLib.h
index d1cf2d7..f744abc 100644
--- a/MdePkg/Include/Library/UefiDecompressLib.h
+++ b/MdePkg/Include/Library/UefiDecompressLib.h
@@ -17,6 +17,39 @@
 #ifndef __UEFI_DECPOMPRESS_LIB_H__

 #define __UEFI_DECPOMPRESS_LIB_H__

 

+/**

+  Retrieves the size of the uncompressed buffer and the size of the scratch buffer.

+

+  Retrieves the size of the uncompressed buffer and the temporary scratch buffer 

+  required to decompress the buffer specified by Source and SourceSize.

+  If the size of the uncompressed buffer or the size of the scratch buffer cannot

+  be determined from the compressed data specified by Source and SourceData, 

+  then RETURN_INVALID_PARAMETER is returned.  Otherwise, the size of the uncompressed

+  buffer is returned in DestinationSize, the size of the scratch buffer is returned

+  in ScratchSize, and RETURN_SUCCESS is returned.

+  This function does not have scratch buffer available to perform a thorough 

+  checking of the validity of the source data.  It just retrieves the "Original Size"

+  field from the beginning bytes of the source data and output it as DestinationSize.

+  And ScratchSize is specific to the decompression implementation.

+

+  If Source is NULL, then ASSERT().

+  If DestinationSize is NULL, then ASSERT().

+  If ScratchSize is NULL, then ASSERT().

+

+  @param  Source          The source buffer containing the compressed data.

+  @param  SourceSize      The size, in bytes, of the source buffer.

+  @param  DestinationSize A pointer to the size, in bytes, of the uncompressed buffer

+                          that will be generated when the compressed buffer specified

+                          by Source and SourceSize is decompressed..

+  @param  ScratchSize     A pointer to the size, in bytes, of the scratch buffer that

+                          is required to decompress the compressed buffer specified 

+                          by Source and SourceSize.

+

+  @retval  RETURN_SUCCESS The size of destination buffer and the size of scratch 

+                          buffer are successull retrieved.

+  @retval  RETURN_INVALID_PARAMETER The source data is corrupted

+

+**/

 RETURN_STATUS

 EFIAPI

 UefiDecompressGetInfo (

@@ -26,6 +59,32 @@ UefiDecompressGetInfo (
   OUT UINT32      *ScratchSize

   );

 

+/**

+  Decompresses a compressed source buffer.

+

+  This function is designed so that the decompression algorithm can be implemented

+  without using any memory services.  As a result, this function is not allowed to

+  call any memory allocation services in its implementation.  It is the caller¡¯s r

+  esponsibility to allocate and free the Destination and Scratch buffers.

+  If the compressed source data specified by Source is sucessfully decompressed 

+  into Destination, then RETURN_SUCCESS is returned.  If the compressed source data 

+  specified by Source is not in a valid compressed data format,

+  then RETURN_INVALID_PARAMETER is returned.

+

+  If Source is NULL, then ASSERT().

+  If Destination is NULL, then ASSERT().

+  If the required scratch buffer size > 0 and Scratch is NULL, then ASSERT().

+

+  @param  Source      The source buffer containing the compressed data.

+  @param  Destination The destination buffer to store the decompressed data

+  @param  Scratch     A temporary scratch buffer that is used to perform the decompression.

+                      This is an optional parameter that may be NULL if the 

+                      required scratch buffer size is 0.

+                     

+  @retval  RETURN_SUCCESS Decompression is successfull

+  @retval  RETURN_INVALID_PARAMETER The source data is corrupted

+

+**/

 RETURN_STATUS

 EFIAPI

 UefiDecompress (