Ported LZMA to DUET platform.

[mirror_edk2.git] / DuetPkg / EfiLdr / LzmaDecompress.h

/** @file\r
  LZMA Decompress Library header file\r
\r
  Copyright (c) 2006 - 2009, Intel Corporation<BR>\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
  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
\r
**/\r
\r
#ifndef __LZMADECOMPRESS_H__\r
#define __LZMADECOMPRESS_H__\r
\r
/**\r
  The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().\r
  \r
  @param Source           The source buffer containing the compressed data.\r
  @param SourceSize       The size of source buffer\r
  @param DestinationSize  The size of destination buffer.\r
  @param ScratchSize      The size of scratch buffer.\r
\r
  @retval RETURN_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
  @retval RETURN_INVALID_PARAMETER - The source data is corrupted\r
**/\r
RETURN_STATUS\r
EFIAPI\r
LzmaUefiDecompressGetInfo (\r
  IN  CONST VOID  *Source,\r
  IN  UINT32      SourceSize,\r
  OUT UINT32      *DestinationSize,\r
  OUT UINT32      *ScratchSize\r
  );\r
\r
/**\r
  The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().\r
  \r
  @param Source          - The source buffer containing the compressed data.\r
  @param Destination     - The destination buffer to store the decompressed data\r
  @param Scratch         - The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
\r
  @retval RETURN_SUCCESS           - Decompression is successfull\r
  @retval RETURN_INVALID_PARAMETER - The source data is corrupted  \r
**/\r
RETURN_STATUS\r
EFIAPI\r
LzmaUefiDecompress (\r
  IN CONST VOID  *Source,\r
  IN OUT VOID    *Destination,\r
  IN OUT VOID    *Scratch\r
  );\r
\r
#endif // __LZMADECOMPRESS_H__\r
\r