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