+++ /dev/null
-/*++\r
-\r
-Copyright (c) 2004 - 2006, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
-\r
-Module Name:\r
-\r
- EdkIIGlueUefiDecompressLib.h\r
- \r
-Abstract: \r
-\r
- Public header file for UEFI Decompress Lib\r
-\r
---*/\r
-\r
-#ifndef __EDKII_GLUE_UEFI_DECPOMPRESS_LIB_H__\r
-#define __EDKII_GLUE_UEFI_DECPOMPRESS_LIB_H__\r
-\r
-#define FillBuf(_SD, _NUMOFBITS) GlueFillBuf(_SD, _NUMOFBITS)\r
-#define GetBits(_SD, _NUMOFBITS) GlueGetBits(_SD, _NUMOFBITS)\r
-#define MakeTable(_SD, _NUMOFCHAR, _BITLEN, _TABLEBITS, _TABLE) GlueMakeTable(_SD, _NUMOFCHAR, _BITLEN, _TABLEBITS, _TABLE)\r
-#define DecodeP(_SD) GlueDecodeP(_SD)\r
-#define ReadPTLen( _SD, _NN, _NBIT, _SPECIAL) GlueReadPTLen( _SD, _NN, _NBIT, _SPECIAL)\r
-#define ReadCLen(_SD) GlueReadCLen(_SD)\r
-#define DecodeC(_SD) GlueDecodeC(_SD)\r
-#define Decode(_SD) GlueDecode(_SD)\r
-\r
-\r
-\r
-/**\r
- Retrieves the size of the uncompressed buffer and the size of the scratch buffer.\r
-\r
- Retrieves the size of the uncompressed buffer and the temporary scratch buffer \r
- required to decompress the buffer specified by Source and SourceSize.\r
- If the size of the uncompressed buffer or the size of the scratch buffer cannot\r
- be determined from the compressed data specified by Source and SourceData, \r
- then RETURN_INVALID_PARAMETER is returned. Otherwise, the size of the uncompressed\r
- buffer is returned in DestinationSize, the size of the scratch buffer is returned\r
- in ScratchSize, and RETURN_SUCCESS is returned.\r
- This function does not have scratch buffer available to perform a thorough \r
- checking of the validity of the source data. It just retrieves the "Original Size"\r
- field from the beginning bytes of the source data and output it as DestinationSize.\r
- And ScratchSize is specific to the decompression implementation.\r
-\r
- If Source is NULL, then ASSERT().\r
- If DestinationSize is NULL, then ASSERT().\r
- If ScratchSize is NULL, then ASSERT().\r
-\r
- @param Source The source buffer containing the compressed data.\r
- @param SourceSize The size, in bytes, of the source buffer.\r
- @param DestinationSize A pointer to the size, in bytes, of the uncompressed buffer\r
- that will be generated when the compressed buffer specified\r
- by Source and SourceSize is decompressed..\r
- @param ScratchSize A pointer to the size, in bytes, of the scratch buffer that\r
- is required to decompress the compressed buffer specified \r
- by Source and SourceSize.\r
-\r
- @retval RETURN_SUCCESS The size of destination buffer and the size of scratch \r
- buffer are successfully retrieved.\r
- @retval RETURN_INVALID_PARAMETER The source data is corrupted\r
-\r
-**/\r
-RETURN_STATUS\r
-EFIAPI\r
-UefiDecompressGetInfo (\r
- IN CONST VOID *Source,\r
- IN UINT32 SourceSize,\r
- OUT UINT32 *DestinationSize,\r
- OUT UINT32 *ScratchSize\r
- );\r
-\r
-/**\r
- Decompresses a compressed source buffer.\r
-\r
- This function is designed so that the decompression algorithm can be implemented\r
- without using any memory services. As a result, this function is not allowed to\r
- call any memory allocation services in its implementation. It is the caller's r\r
- esponsibility to allocate and free the Destination and Scratch buffers.\r
- If the compressed source data specified by Source is sucessfully decompressed \r
- into Destination, then RETURN_SUCCESS is returned. If the compressed source data \r
- specified by Source is not in a valid compressed data format,\r
- then RETURN_INVALID_PARAMETER is returned.\r
-\r
- If Source is NULL, then ASSERT().\r
- If Destination is NULL, then ASSERT().\r
- If the required scratch buffer size > 0 and Scratch is NULL, then ASSERT().\r
-\r
- @param Source The source buffer containing the compressed data.\r
- @param Destination The destination buffer to store the decompressed data\r
- @param Scratch A temporary scratch buffer that is used to perform the decompression.\r
- This is an optional parameter that may be NULL if the \r
- required scratch buffer size is 0.\r
- \r
- @retval RETURN_SUCCESS Decompression is successfull\r
- @retval RETURN_INVALID_PARAMETER The source data is corrupted\r
-\r
-**/\r
-RETURN_STATUS\r
-EFIAPI\r
-UefiDecompress (\r
- IN CONST VOID *Source,\r
- IN OUT VOID *Destination,\r
- IN OUT VOID *Scratch\r
- );\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff