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