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   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _EFI_SHELL_COMPRESS_H_
  10 #define _EFI_SHELL_COMPRESS_H_
  11
  12 /**
  13   The compression routine.
  14
  15   @param[in]       SrcBuffer     The buffer containing the source data.
  16   @param[in]       SrcSize       Number of bytes in SrcBuffer.
  17   @param[in]       DstBuffer     The buffer to put the compressed image in.
  18   @param[in, out]  DstSize       On input the size (in bytes) of DstBuffer, on
  19                                  return the number of bytes placed in DstBuffer.
  20
  21   @retval EFI_SUCCESS           The compression was sucessful.
  22   @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.  DstSize is required.
  23 **/
  24 EFI_STATUS
  25 Compress (
  26   IN      VOID    *SrcBuffer,
  27   IN      UINT64  SrcSize,
  28   IN      VOID    *DstBuffer,
  29   IN OUT  UINT64  *DstSize
  30   );
  31
  32 #endif