Added Extract interface for easier wrapping of decompressor in Python
[people/mcb30/basetools.git] / Source / C / Common / Decompress.h
index 5984e0b..8bcf504 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2006, Intel Corporation                                                         \r
+Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
 All rights reserved. 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Header file for compression routine\r
   \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_DECOMPRESS_H\r
 #define _EFI_DECOMPRESS_H\r
@@ -31,7 +31,7 @@ EfiGetInfo (
   OUT     UINT32  *DstSize,\r
   OUT     UINT32  *ScratchSize\r
   );\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -49,7 +49,7 @@ Returns:
   EFI_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
   EFI_INVALID_PARAMETER - The source data is corrupted\r
 \r
---*/\r
+**/\r
 \r
 EFI_STATUS\r
 EfiDecompress (\r
@@ -60,7 +60,7 @@ EfiDecompress (
   IN OUT  VOID    *Scratch,\r
   IN      UINT32  ScratchSize\r
   );\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -80,7 +80,7 @@ Returns:
   EFI_SUCCESS           - Decompression is successfull\r
   EFI_INVALID_PARAMETER - The source data is corrupted\r
 \r
---*/\r
+**/\r
 \r
 EFI_STATUS\r
 TianoGetInfo (\r
@@ -89,7 +89,7 @@ TianoGetInfo (
   OUT     UINT32  *DstSize,\r
   OUT     UINT32  *ScratchSize\r
   );\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -107,7 +107,7 @@ Returns:
   EFI_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
   EFI_INVALID_PARAMETER - The source data is corrupted\r
 \r
---*/\r
+**/\r
 \r
 EFI_STATUS\r
 TianoDecompress (\r
@@ -118,7 +118,7 @@ TianoDecompress (
   IN OUT  VOID    *Scratch,\r
   IN      UINT32  ScratchSize\r
   );\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -138,7 +138,7 @@ Returns:
   EFI_SUCCESS           - Decompression is successfull\r
   EFI_INVALID_PARAMETER - The source data is corrupted\r
 \r
---*/\r
+**/\r
 \r
 typedef\r
 EFI_STATUS\r
@@ -159,4 +159,14 @@ EFI_STATUS
   IN OUT  VOID    *Scratch,\r
   IN      UINT32  ScratchSize\r
   );\r
+\r
+EFI_STATUS\r
+Extract (\r
+  IN      VOID    *Source,\r
+  IN      UINT32  SrcSize,\r
+  IN OUT  VOID    *Destination,\r
+  IN      UINT32  DstSize,\r
+  IN      UINT    Algorithm\r
+  );\r
+\r
 #endif\r