Update CustomDecompress library to support algorithm guid and Update DxeIpl and DxeCo...
[mirror_edk2.git] / MdePkg / Include / Library / CustomDecompressLib.h
CommitLineData
842f5579
A
1/** @file\r
2 Custom Decompress Functions\r
c96769e5 3\r
842f5579
A
4 Copyright (c) 2006 - 2007, Intel Corporation\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
c96769e5 9\r
842f5579
A
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
c96769e5 12\r
842f5579 13**/\r
c96769e5 14\r
c96769e5 15\r
16#ifndef __CUSTOM_DECPOMPRESS_LIB_H__\r
17#define __CUSTOM_DECPOMPRESS_LIB_H__\r
18\r
d8c79a81
LG
19/**
20 Decompress GetInfo fucntion.\r
21\r
22 @param[in] DecompressGuid The guid matches this decompress method.
23 @param[in] Source The source buffer containing the compressed data.
24 @param[in] SourceSize The size of source buffer
25 @param[out] DestinationSize The size of destination buffer.
26 @param[out] ScratchSize The size of scratch buffer.
27
28 @retval RETURN_SUCCESS The size of destination buffer and the size of scratch buffer are successull retrieved.\r
29 @retval RETURN_INVALID_PARAMETER The source data is corrupted
30
31**/\r
c96769e5 32RETURN_STATUS\r
33EFIAPI\r
34CustomDecompressGetInfo (\r
d8c79a81 35 IN CONST GUID *DecompressGuid,\r
c96769e5 36 IN CONST VOID *Source,\r
37 IN UINT32 SourceSize,\r
38 OUT UINT32 *DestinationSize,\r
39 OUT UINT32 *ScratchSize\r
40 );\r
41\r
d8c79a81
LG
42/**
43 Decompress fucntion.\r
44\r
45 @param[in] DecompressGuid The guid matches this decompress method.
46 @param[in] Source The source buffer containing the compressed data.
47 @param[in] Destination The destination buffer to store the decompressed data
48 @param[out] Scratch The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.\r
49
50 @retval RETURN_SUCCESS Decompression is successfull\r
51 @retval RETURN_INVALID_PARAMETER The source data is corrupted
52
53**/\r
c96769e5 54RETURN_STATUS\r
55EFIAPI\r
56CustomDecompress (\r
d8c79a81
LG
57 IN CONST GUID *DecompressGuid,\r
58 IN CONST VOID *Source,\r
59 IN OUT VOID *Destination,\r
60 IN OUT VOID *Scratch\r
61 );\r
62\r
63/**
64 Get decompress method guid list.\r
65\r
66 @param[in, out] AlgorithmGuidTable The decompress method guid list.
67 @param[in, out] NumberOfAlgorithms The number of decompress methods.
68
69 @retval RETURN_SUCCESS Get all algorithmes list successfully..
70**/\r
71RETURN_STATUS\r
72EFIAPI\r
73CustomDecompressGetAlgorithms (\r
74 IN OUT GUID **AlgorithmGuidTable,\r
75 IN OUT UINTN *NumberOfAlgorithms\r
c96769e5 76 );\r
77\r
78#endif\r