]> git.proxmox.com Git - mirror_edk2.git/blame - EdkCompatibilityPkg/Sample/Tools/Source/Common/Compress.h
Add in the 1st version of ECP.
[mirror_edk2.git] / EdkCompatibilityPkg / Sample / Tools / Source / Common / Compress.h
CommitLineData
3eb9473e 1/*++\r
2\r
3Copyright (c) 2004 - 2006, Intel Corporation \r
4All rights reserved. This program and the accompanying materials \r
5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
12Module Name:\r
13\r
14 Compress.h\r
15\r
16Abstract:\r
17\r
18 Header file for compression routine.\r
19 Providing both EFI and Tiano Compress algorithms.\r
20 \r
21--*/\r
22\r
23#ifndef _COMPRESS_H_\r
24#define _COMPRESS_H_\r
25\r
26/*++\r
27\r
28Routine Description:\r
29\r
30 Tiano compression routine.\r
31\r
32--*/\r
33EFI_STATUS\r
34TianoCompress (\r
35 IN UINT8 *SrcBuffer,\r
36 IN UINT32 SrcSize,\r
37 IN UINT8 *DstBuffer,\r
38 IN OUT UINT32 *DstSize\r
39 )\r
40;\r
41\r
42/*++\r
43\r
44Routine Description:\r
45\r
46 Efi compression routine.\r
47\r
48--*/\r
49EFI_STATUS\r
50EfiCompress (\r
51 IN UINT8 *SrcBuffer,\r
52 IN UINT32 SrcSize,\r
53 IN UINT8 *DstBuffer,\r
54 IN OUT UINT32 *DstSize\r
55 )\r
56;\r
57\r
58/*++\r
59\r
60Routine Description:\r
61\r
62 The compression routine.\r
63\r
64Arguments:\r
65\r
66 SrcBuffer - The buffer storing the source data\r
67 SrcSize - The size of source data\r
68 DstBuffer - The buffer to store the compressed data\r
69 DstSize - On input, the size of DstBuffer; On output,\r
70 the size of the actual compressed data.\r
71\r
72Returns:\r
73\r
74 EFI_BUFFER_TOO_SMALL - The DstBuffer is too small. In this case,\r
75 DstSize contains the size needed.\r
76 EFI_SUCCESS - Compression is successful.\r
77 EFI_OUT_OF_RESOURCES - No resource to complete function.\r
78 EFI_INVALID_PARAMETER - Parameter supplied is wrong.\r
79\r
80--*/\r
81typedef\r
82EFI_STATUS\r
83(*COMPRESS_FUNCTION) (\r
84 IN UINT8 *SrcBuffer,\r
85 IN UINT32 SrcSize,\r
86 IN UINT8 *DstBuffer,\r
87 IN OUT UINT32 *DstSize\r
88 );\r
89\r
90#endif\r