]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Decompress.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / Decompress.h
index 8a4bac2b16d65c325f0f0f9e568c4d6425479668..fe43668d63466d984829d1ff73698a7db08b967c 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
   The Decompress Protocol Interface as defined in UEFI spec\r
 \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
+  Copyright (c) 2006 - 2018, 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
 \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
+  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
 **/\r
 \r
 typedef struct _EFI_DECOMPRESS_PROTOCOL  EFI_DECOMPRESS_PROTOCOL;\r
 \r
 /**\r
-  The GetInfo() function retrieves the size of the uncompressed buffer \r
-  and the temporary scratch buffer required to decompress the buffer \r
+  The GetInfo() function retrieves the size of the uncompressed buffer\r
+  and the temporary scratch buffer required to decompress the buffer\r
   specified by Source and SourceSize.  If the size of the uncompressed\r
-  buffer or the size of the scratch buffer cannot be determined from \r
-  the compressed data specified by Source and SourceData, then \r
+  buffer or the size of the scratch buffer cannot be determined from\r
+  the compressed data specified by Source and SourceData, then\r
   EFI_INVALID_PARAMETER is returned.  Otherwise, the size of the uncompressed\r
-  buffer is returned in DestinationSize, the size of the scratch buffer is \r
+  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 a 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
@@ -68,15 +68,15 @@ EFI_STATUS
 /**\r
   The Decompress() function extracts decompressed data to its original form.\r
 \r
-  This protocol is designed so that the decompression algorithm can be \r
-  implemented without using any memory services.  As a result, the \r
-  Decompress() function is not allowed to call AllocatePool() or \r
-  AllocatePages() in its implementation.  It is the caller's responsibility \r
+  This protocol is designed so that the decompression algorithm can be\r
+  implemented without using any memory services.  As a result, the\r
+  Decompress() function is not allowed to call AllocatePool() or\r
+  AllocatePages() in its implementation.  It is the caller's responsibility\r
   to allocate and free the Destination and Scratch buffers.\r
 \r
-  If the compressed source data specified by Source and SourceSize is \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
+  If the compressed source data specified by Source and SourceSize is\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            A pointer to the EFI_DECOMPRESS_PROTOCOL instance.\r
@@ -87,7 +87,7 @@ EFI_STATUS
   @param  DestinationSize The size of destination buffer. The size of destination\r
                           buffer needed is obtained from GetInfo().\r
   @param  Scratch         A temporary scratch buffer that is used to perform the\r
-                          decompression.          \r
+                          decompression.\r
   @param  ScratchSize     The size of scratch buffer. The size of scratch buffer needed\r
                           is obtained from GetInfo().\r
 \r