Restructuring for better separation of Tool packages.

[mirror_edk2.git] / Tools / CodeTools / TianoTools / Common / EfiCustomizedCompress.h

/*++\r
\r
Copyright (c) 2004, 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
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
Module Name:\r
  \r
  EfiCustomizedCompress.h\r
\r
Abstract:\r
\r
  Header file for Customized compression routine\r
  \r
--*/\r
\r
#ifndef _EFICUSTOMIZEDCOMPRESS_H\r
#define _EFICUSTOMIZEDCOMPRESS_H\r
\r
#include <Common/UefiBaseTypes.h>\r
\r
EFI_STATUS\r
SetCustomizedCompressionType (\r
  IN  CHAR8   *Type\r
  )\r
;\r
\r
/*++\r
\r
Routine Description:\r
\r
The implementation of Customized SetCompressionType().\r
\r
Arguments:\r
  Type        - The type if compression.\r
    \r
Returns:\r
    \r
  EFI_SUCCESS           - The type has been set.\r
  EFI_UNSUPPORTED       - This type is unsupported.\r
\r
    \r
--*/\r
EFI_STATUS\r
CustomizedGetInfo (\r
  IN      VOID    *Source,\r
  IN      UINT32  SrcSize,\r
  OUT     UINT32  *DstSize,\r
  OUT     UINT32  *ScratchSize\r
  )\r
;\r
\r
/*++\r
\r
Routine Description:\r
\r
  The implementation of Customized GetInfo().\r
\r
Arguments:\r
\r
  Source      - The source buffer containing the compressed data.\r
  SrcSize     - The size of source buffer\r
  DstSize     - The size of destination buffer.\r
  ScratchSize - The size of scratch buffer.\r
\r
Returns:\r
\r
  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
EFI_STATUS\r
CustomizedDecompress (\r
  IN      VOID    *Source,\r
  IN      UINT32  SrcSize,\r
  IN OUT  VOID    *Destination,\r
  IN      UINT32  DstSize,\r
  IN OUT  VOID    *Scratch,\r
  IN      UINT32  ScratchSize\r
  )\r
;\r
\r
/*++\r
\r
Routine Description:\r
\r
  The implementation of Customized Decompress().\r
\r
Arguments:\r
\r
  This        - The protocol instance pointer\r
  Source      - The source buffer containing the compressed data.\r
  SrcSize     - The size of source buffer\r
  Destination - The destination buffer to store the decompressed data\r
  DstSize     - The size of destination buffer.\r
  Scratch     - The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
  ScratchSize - The size of scratch buffer.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Decompression is successfull\r
  EFI_INVALID_PARAMETER - The source data is corrupted\r
\r
--*/\r
EFI_STATUS\r
CustomizedCompress (\r
  IN      UINT8   *SrcBuffer,\r
  IN      UINT32  SrcSize,\r
  IN      UINT8   *DstBuffer,\r
  IN OUT  UINT32  *DstSize\r
  )\r
;\r
\r
/*++\r
\r
Routine Description:\r
\r
  The Customized compression routine.\r
\r
Arguments:\r
\r
  SrcBuffer   - The buffer storing the source data\r
  SrcSize     - The size of source data\r
  DstBuffer   - The buffer to store the compressed data\r
  DstSize     - On input, the size of DstBuffer; On output,\r
                the size of the actual compressed data.\r
\r
Returns:\r
\r
  EFI_BUFFER_TOO_SMALL  - The DstBuffer is too small. In this case,\r
                          DstSize contains the size needed.\r
  EFI_SUCCESS           - Compression is successful.\r
\r
--*/\r
\r
#endif\r