ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h

   1 /** @file
   2   Header file for compression routine.
   3
   4   Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _EFI_SHELL_COMPRESS_H_
  16 #define _EFI_SHELL_COMPRESS_H_
  17
  18 /**
  19   The compression routine.
  20
  21   @param[in]       SrcBuffer     The buffer containing the source data.
  22   @param[in]       SrcSize       Number of bytes in SrcBuffer.
  23   @param[in]       DstBuffer     The buffer to put the compressed image in.
  24   @param[in, out]  DstSize       On input the size (in bytes) of DstBuffer, on
  25                                  return the number of bytes placed in DstBuffer.
  26
  27   @retval EFI_SUCCESS           The compression was sucessful.
  28   @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.  DstSize is required.
  29 **/
  30 EFI_STATUS
  31 EFIAPI
  32 Compress (
  33   IN      VOID    *SrcBuffer,
  34   IN      UINT64  SrcSize,
  35   IN      VOID    *DstBuffer,
  36   IN OUT  UINT64  *DstSize
  37   );
  38
  39 #endif
  40