]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /*++\r |
2 | \r | |
30f80dd8 | 3 | Copyright (c) 2004 - 2006, Intel Corporation \r |
878ddf1f | 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 | |
30f80dd8 | 14 | Compress.h\r |
878ddf1f | 15 | \r |
16 | Abstract:\r | |
17 | \r | |
30f80dd8 | 18 | Header file for compression routine.\r |
19 | Providing both EFI and Tiano Compress algorithms.\r | |
878ddf1f | 20 | \r |
21 | --*/\r | |
22 | \r | |
30f80dd8 | 23 | #ifndef _COMPRESS_H_\r |
24 | #define _COMPRESS_H_\r | |
ce53a8c3 | 25 | \r |
878ddf1f | 26 | #include <string.h>\r |
27 | #include <stdlib.h>\r | |
878ddf1f | 28 | \r |
ce53a8c3 | 29 | #include <Common/UefiBaseTypes.h>\r |
30f80dd8 | 30 | /*++\r |
31 | \r | |
32 | Routine Description:\r | |
ce53a8c3 | 33 | \r |
30f80dd8 | 34 | Tiano compression routine.\r |
35 | \r | |
36 | --*/\r | |
37 | EFI_STATUS\r | |
38 | TianoCompress (\r | |
39 | IN UINT8 *SrcBuffer,\r | |
40 | IN UINT32 SrcSize,\r | |
41 | IN UINT8 *DstBuffer,\r | |
42 | IN OUT UINT32 *DstSize\r | |
43 | )\r | |
44 | ;\r | |
45 | \r | |
46 | /*++\r | |
47 | \r | |
48 | Routine Description:\r | |
49 | \r | |
50 | Efi compression routine.\r | |
51 | \r | |
52 | --*/\r | |
878ddf1f | 53 | EFI_STATUS\r |
30f80dd8 | 54 | EfiCompress (\r |
878ddf1f | 55 | IN UINT8 *SrcBuffer,\r |
56 | IN UINT32 SrcSize,\r | |
57 | IN UINT8 *DstBuffer,\r | |
58 | IN OUT UINT32 *DstSize\r | |
59 | )\r | |
60 | ;\r | |
61 | \r | |
62 | /*++\r | |
63 | \r | |
64 | Routine Description:\r | |
65 | \r | |
66 | The compression routine.\r | |
67 | \r | |
68 | Arguments:\r | |
69 | \r | |
70 | SrcBuffer - The buffer storing the source data\r | |
71 | SrcSize - The size of source data\r | |
72 | DstBuffer - The buffer to store the compressed data\r | |
73 | DstSize - On input, the size of DstBuffer; On output,\r | |
74 | the size of the actual compressed data.\r | |
75 | \r | |
76 | Returns:\r | |
77 | \r | |
78 | EFI_BUFFER_TOO_SMALL - The DstBuffer is too small. In this case,\r | |
79 | DstSize contains the size needed.\r | |
80 | EFI_SUCCESS - Compression is successful.\r | |
30f80dd8 | 81 | EFI_OUT_OF_RESOURCES - No resource to complete function.\r |
82 | EFI_INVALID_PARAMETER - Parameter supplied is wrong.\r | |
878ddf1f | 83 | \r |
84 | --*/\r | |
85 | typedef\r | |
86 | EFI_STATUS\r | |
87 | (*COMPRESS_FUNCTION) (\r | |
88 | IN UINT8 *SrcBuffer,\r | |
89 | IN UINT32 SrcSize,\r | |
90 | IN UINT8 *DstBuffer,\r | |
91 | IN OUT UINT32 *DstSize\r | |
92 | );\r | |
93 | \r | |
94 | #endif\r |