]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | LZMA Decompress Library header file\r | |
3 | \r | |
4 | Copyright (c) 2006 - 2010, Intel Corporation<BR>\r | |
5 | All rights reserved. This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef __LZMADECOMPRESS_H__\r | |
16 | #define __LZMADECOMPRESS_H__\r | |
17 | \r | |
18 | /**\r | |
19 | The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().\r | |
20 | \r | |
21 | @param Source The source buffer containing the compressed data.\r | |
22 | @param SourceSize The size of source buffer\r | |
23 | @param DestinationSize The size of destination buffer.\r | |
24 | @param ScratchSize The size of scratch buffer.\r | |
25 | \r | |
26 | @retval RETURN_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.\r | |
27 | @retval RETURN_INVALID_PARAMETER - The source data is corrupted\r | |
28 | **/\r | |
29 | RETURN_STATUS\r | |
30 | EFIAPI\r | |
31 | LzmaUefiDecompressGetInfo (\r | |
32 | IN CONST VOID *Source,\r | |
33 | IN UINT32 SourceSize,\r | |
34 | OUT UINT32 *DestinationSize,\r | |
35 | OUT UINT32 *ScratchSize\r | |
36 | );\r | |
37 | \r | |
38 | /**\r | |
39 | Decompresses a Lzma compressed source buffer.\r | |
40 | \r | |
41 | Extracts decompressed data to its original form.\r | |
42 | If the compressed source data specified by Source is successfully decompressed \r | |
43 | into Destination, then RETURN_SUCCESS is returned. If the compressed source data \r | |
44 | specified by Source is not in a valid compressed data format,\r | |
45 | then RETURN_INVALID_PARAMETER is returned.\r | |
46 | \r | |
47 | @param Source The source buffer containing the compressed data.\r | |
48 | @param SourceSize The size of source buffer.\r | |
49 | @param Destination The destination buffer to store the decompressed data\r | |
50 | @param Scratch A temporary scratch buffer that is used to perform the decompression.\r | |
51 | This is an optional parameter that may be NULL if the \r | |
52 | required scratch buffer size is 0.\r | |
53 | \r | |
54 | @retval RETURN_SUCCESS Decompression completed successfully, and \r | |
55 | the uncompressed buffer is returned in Destination.\r | |
56 | @retval RETURN_INVALID_PARAMETER \r | |
57 | The source buffer specified by Source is corrupted \r | |
58 | (not in a valid compressed format).\r | |
59 | **/\r | |
60 | RETURN_STATUS\r | |
61 | EFIAPI\r | |
62 | LzmaUefiDecompress (\r | |
63 | IN CONST VOID *Source,\r | |
64 | IN UINTN SourceSize,\r | |
65 | IN OUT VOID *Destination,\r | |
66 | IN OUT VOID *Scratch\r | |
67 | );\r | |
68 | \r | |
69 | #endif // __LZMADECOMPRESS_H__\r | |
70 | \r |