MdePkg/Include/Protocol/Tls.h: pack structures from the TLS RFC

[mirror_edk2.git] / MdePkg / Include / Protocol / Decompress.h

diff --git a/MdePkg/Include/Protocol/Decompress.h b/MdePkg/Include/Protocol/Decompress.h
index cdd2e130ad9b0b9e2d134471a4f8c12544149cc7..8a4bac2b16d65c325f0f0f9e568c4d6425479668 100644 (file)
--- a/MdePkg/Include/Protocol/Decompress.h
+++ b/MdePkg/Include/Protocol/Decompress.h
@@ -1,8 +1,8 @@
 /** @file\r
-  The Decompress Protocol Interface\r
+  The Decompress Protocol Interface as defined in UEFI spec\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+  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
@@ -32,13 +32,13 @@ typedef struct _EFI_DECOMPRESS_PROTOCOL  EFI_DECOMPRESS_PROTOCOL;
   buffer is returned in DestinationSize, the size of the scratch buffer is \r
   returned in ScratchSize, and EFI_SUCCESS is returned.\r
 \r
-  The GetInfo() function does not have scratch buffer available to perform \r
+  The GetInfo() function does not have a scratch buffer available to perform \r
   a thorough checking of the validity of the source data. It just retrieves\r
   the 'Original Size' field from the beginning bytes of the source data and\r
   output it as DestinationSize.  And ScratchSize is specific to the decompression\r
   implementation.\r
 \r
-  @param  This            The protocol instance pointer\r
+  @param  This            A pointer to the EFI_DECOMPRESS_PROTOCOL instance.\r
   @param  Source          The source buffer containing the compressed data.\r
   @param  SourceSize      The size, in bytes, of source buffer.\r
   @param  DestinationSize A pointer to the size, in bytes, of the uncompressed buffer\r
@@ -57,7 +57,7 @@ typedef struct _EFI_DECOMPRESS_PROTOCOL  EFI_DECOMPRESS_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DECOMPRESS_GET_INFO) (\r
+(EFIAPI *EFI_DECOMPRESS_GET_INFO)(\r
   IN EFI_DECOMPRESS_PROTOCOL            *This,\r
   IN   VOID                             *Source,\r
   IN   UINT32                           SourceSize,\r
@@ -75,11 +75,11 @@ EFI_STATUS
   to allocate and free the Destination and Scratch buffers.\r
 \r
   If the compressed source data specified by Source and SourceSize is \r
-  sucessfully decompressed into Destination, then EFI_SUCCESS is returned.  \r
+  successfully decompressed into Destination, then EFI_SUCCESS is returned.  \r
   If the compressed source data specified by Source and SourceSize is not in \r
   a valid compressed data format, then EFI_INVALID_PARAMETER is returned.\r
 \r
-  @param  This            The protocol instance pointer\r
+  @param  This            A pointer to the EFI_DECOMPRESS_PROTOCOL instance.\r
   @param  Source          The source buffer containing the compressed data.\r
   @param  SourceSize      The size of source data.\r
   @param  Destination     On output, the destination buffer that contains\r
@@ -99,7 +99,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DECOMPRESS_DECOMPRESS) (\r
+(EFIAPI *EFI_DECOMPRESS_DECOMPRESS)(\r
   IN EFI_DECOMPRESS_PROTOCOL              *This,\r
   IN     VOID                             *Source,\r
   IN     UINT32                           SourceSize,\r
@@ -109,6 +109,9 @@ EFI_STATUS
   IN     UINT32                           ScratchSize\r
   );\r
 \r
+///\r
+/// Provides a decompression service.\r
+///\r
 struct _EFI_DECOMPRESS_PROTOCOL {\r
   EFI_DECOMPRESS_GET_INFO   GetInfo;\r
   EFI_DECOMPRESS_DECOMPRESS Decompress;\r