]>
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 | EfiDecompress.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Header file for compression routine\r | |
19 | \r | |
20 | --*/\r | |
878ddf1f | 21 | \r |
22 | #ifndef _EFI_DECOMPRESS_H\r | |
23 | #define _EFI_DECOMPRESS_H\r | |
ce53a8c3 | 24 | \r |
25 | #include <Common/UefiBaseTypes.h>\r | |
26 | \r | |
878ddf1f | 27 | EFI_STATUS\r |
28 | GetInfo (\r | |
29 | IN VOID *Source,\r | |
30 | IN UINT32 SrcSize,\r | |
31 | OUT UINT32 *DstSize,\r | |
32 | OUT UINT32 *ScratchSize\r | |
33 | );\r | |
34 | \r | |
35 | /*++\r | |
36 | \r | |
37 | Routine Description:\r | |
38 | \r | |
39 | The implementation of EFI_DECOMPRESS_PROTOCOL.GetInfo().\r | |
40 | \r | |
41 | Arguments:\r | |
42 | \r | |
43 | Source - The source buffer containing the compressed data.\r | |
44 | SrcSize - The size of source buffer\r | |
45 | DstSize - The size of destination buffer.\r | |
46 | ScratchSize - The size of scratch buffer.\r | |
47 | \r | |
48 | Returns:\r | |
49 | \r | |
50 | EFI_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.\r | |
51 | EFI_INVALID_PARAMETER - The source data is corrupted\r | |
52 | \r | |
53 | --*/\r | |
54 | EFI_STATUS\r | |
55 | Decompress (\r | |
56 | IN VOID *Source,\r | |
57 | IN UINT32 SrcSize,\r | |
58 | IN OUT VOID *Destination,\r | |
59 | IN UINT32 DstSize,\r | |
60 | IN OUT VOID *Scratch,\r | |
61 | IN UINT32 ScratchSize\r | |
62 | )\r | |
63 | ;\r | |
64 | \r | |
65 | /*++\r | |
66 | \r | |
67 | Routine Description:\r | |
68 | \r | |
69 | The implementation of EFI_DECOMPRESS_PROTOCOL.Decompress().\r | |
70 | \r | |
71 | Arguments:\r | |
72 | \r | |
73 | This - The protocol instance pointer\r | |
74 | Source - The source buffer containing the compressed data.\r | |
75 | SrcSize - The size of source buffer\r | |
76 | Destination - The destination buffer to store the decompressed data\r | |
77 | DstSize - The size of destination buffer.\r | |
78 | Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.\r | |
79 | ScratchSize - The size of scratch buffer.\r | |
80 | \r | |
81 | Returns:\r | |
82 | \r | |
83 | EFI_SUCCESS - Decompression is successfull\r | |
84 | EFI_INVALID_PARAMETER - The source data is corrupted\r | |
85 | \r | |
86 | --*/\r | |
87 | typedef\r | |
88 | EFI_STATUS\r | |
89 | (*GETINFO_FUNCTION) (\r | |
90 | IN VOID *Source,\r | |
91 | IN UINT32 SrcSize,\r | |
92 | OUT UINT32 *DstSize,\r | |
93 | OUT UINT32 *ScratchSize\r | |
94 | );\r | |
95 | \r | |
96 | typedef\r | |
97 | EFI_STATUS\r | |
98 | (*DECOMPRESS_FUNCTION) (\r | |
99 | IN VOID *Source,\r | |
100 | IN UINT32 SrcSize,\r | |
101 | IN OUT VOID *Destination,\r | |
102 | IN UINT32 DstSize,\r | |
103 | IN OUT VOID *Scratch,\r | |
104 | IN UINT32 ScratchSize\r | |
105 | );\r | |
106 | #endif\r |