e94be43b4849f70031228f15c4f9ec5c5acdf585
[mirror_edk2.git] / EdkModulePkg / Library / EdkNullCustomizedDecompressLib / CustomizedDecompress.h
1 /*++
2
3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 Module Name:
13
14 CustomizedDecompress.h
15
16 Abstract:
17
18 Header file for Customized decompression routine
19
20 --*/
21 #ifndef _CUSTOMIZED_DECOMPRESS_LIB_H_
22 #define _CUSTOMIZED_DECOMPRESS_LIB_H_
23
24
25
26
27 EFI_STATUS
28 EFIAPI
29 CustomizedGetInfo (
30 IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL *This,
31 IN VOID *Source,
32 IN UINT32 SrcSize,
33 OUT UINT32 *DstSize,
34 OUT UINT32 *ScratchSize
35 )
36 /*++
37
38 Routine Description:
39
40 The implementation of Customized GetInfo().
41
42 Arguments:
43 This - The EFI customized decompress protocol
44 Source - The source buffer containing the compressed data.
45 SrcSize - The size of source buffer
46 DstSize - The size of destination buffer.
47 ScratchSize - The size of scratch buffer.
48
49 Returns:
50
51 EFI_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.
52 EFI_INVALID_PARAMETER - The source data is corrupted
53 EFI_UNSUPPORTED - Not supported
54
55 --*/
56 ;
57
58 EFI_STATUS
59 EFIAPI
60 CustomizedDecompress (
61 IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL *This,
62 IN VOID *Source,
63 IN UINT32 SrcSize,
64 IN OUT VOID *Destination,
65 IN UINT32 DstSize,
66 IN OUT VOID *Scratch,
67 IN UINT32 ScratchSize
68 )
69 /*++
70
71 Routine Description:
72
73 The implementation of Customized Decompress().
74
75 Arguments:
76
77 This - The protocol instance pointer
78 Source - The source buffer containing the compressed data.
79 SrcSize - The size of source buffer
80 Destination - The destination buffer to store the decompressed data
81 DstSize - The size of destination buffer.
82 Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
83 ScratchSize - The size of scratch buffer.
84
85 Returns:
86
87 EFI_SUCCESS - Decompression is successfull
88 EFI_INVALID_PARAMETER - The source data is corrupted
89 EFI_UNSUPPORTED - Not supported
90
91 --*/
92 ;
93
94
95 #endif