Tools/Source/TianoTools/Common/EfiDecompress.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   EfiDecompress.h
  15
  16 Abstract:
  17
  18   Header file for compression routine
  19
  20 --*/
  21
  22 #ifndef _EFI_DECOMPRESS_H
  23 #define _EFI_DECOMPRESS_H
  24
  25 #include <Common/UefiBaseTypes.h>
  26
  27 EFI_STATUS
  28 GetInfo (
  29   IN      VOID    *Source,
  30   IN      UINT32  SrcSize,
  31   OUT     UINT32  *DstSize,
  32   OUT     UINT32  *ScratchSize
  33   );
  34
  35 /*++
  36
  37 Routine Description:
  38
  39   The implementation of EFI_DECOMPRESS_PROTOCOL.GetInfo().
  40
  41 Arguments:
  42
  43   Source      - The source buffer containing the compressed data.
  44   SrcSize     - The size of source buffer
  45   DstSize     - The size of destination buffer.
  46   ScratchSize - The size of scratch buffer.
  47
  48 Returns:
  49
  50   EFI_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.
  51   EFI_INVALID_PARAMETER - The source data is corrupted
  52
  53 --*/
  54 EFI_STATUS
  55 Decompress (
  56   IN      VOID    *Source,
  57   IN      UINT32  SrcSize,
  58   IN OUT  VOID    *Destination,
  59   IN      UINT32  DstSize,
  60   IN OUT  VOID    *Scratch,
  61   IN      UINT32  ScratchSize
  62   )
  63 ;
  64
  65 /*++
  66
  67 Routine Description:
  68
  69   The implementation of EFI_DECOMPRESS_PROTOCOL.Decompress().
  70
  71 Arguments:
  72
  73   This        - The protocol instance pointer
  74   Source      - The source buffer containing the compressed data.
  75   SrcSize     - The size of source buffer
  76   Destination - The destination buffer to store the decompressed data
  77   DstSize     - The size of destination buffer.
  78   Scratch     - The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.
  79   ScratchSize - The size of scratch buffer.
  80
  81 Returns:
  82
  83   EFI_SUCCESS           - Decompression is successfull
  84   EFI_INVALID_PARAMETER - The source data is corrupted
  85
  86 --*/
  87 typedef
  88 EFI_STATUS
  89 (*GETINFO_FUNCTION) (
  90   IN      VOID    *Source,
  91   IN      UINT32  SrcSize,
  92   OUT     UINT32  *DstSize,
  93   OUT     UINT32  *ScratchSize
  94   );
  95
  96 typedef
  97 EFI_STATUS
  98 (*DECOMPRESS_FUNCTION) (
  99   IN      VOID    *Source,
 100   IN      UINT32  SrcSize,
 101   IN OUT  VOID    *Destination,
 102   IN      UINT32  DstSize,
 103   IN OUT  VOID    *Scratch,
 104   IN      UINT32  ScratchSize
 105   );
 106 #endif