Tools/CodeTools/TianoTools/Common/EfiCompress.h

   1 /*++
   2
   3 Copyright (c) 2004, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   EfiCompress.h
  15
  16 Abstract:
  17
  18   Header file for compression routine
  19
  20 --*/
  21
  22 #ifndef _EFICOMPRESS_H
  23 #define _EFICOMPRESS_H
  24
  25 #include <string.h>
  26 #include <stdlib.h>
  27
  28 #include <Common/UefiBaseTypes.h>
  29
  30 EFI_STATUS
  31 Compress (
  32   IN      UINT8   *SrcBuffer,
  33   IN      UINT32  SrcSize,
  34   IN      UINT8   *DstBuffer,
  35   IN OUT  UINT32  *DstSize
  36   )
  37 ;
  38
  39 /*++
  40
  41 Routine Description:
  42
  43   The compression routine.
  44
  45 Arguments:
  46
  47   SrcBuffer   - The buffer storing the source data
  48   SrcSize     - The size of source data
  49   DstBuffer   - The buffer to store the compressed data
  50   DstSize     - On input, the size of DstBuffer; On output,
  51                 the size of the actual compressed data.
  52
  53 Returns:
  54
  55   EFI_BUFFER_TOO_SMALL  - The DstBuffer is too small. In this case,
  56                 DstSize contains the size needed.
  57   EFI_SUCCESS           - Compression is successful.
  58
  59 --*/
  60 typedef
  61 EFI_STATUS
  62 (*COMPRESS_FUNCTION) (
  63   IN      UINT8   *SrcBuffer,
  64   IN      UINT32  SrcSize,
  65   IN      UINT8   *DstBuffer,
  66   IN OUT  UINT32  *DstSize
  67   );
  68
  69 #endif