UefiDecompressLib.h File Reference

Functions
RETURN_STATUS EFIAPI	UefiDecompressGetInfo (IN CONST VOID *Source, IN UINT32 SourceSize, OUT UINT32 *DestinationSize, OUT UINT32 *ScratchSize)
RETURN_STATUS EFIAPI	UefiDecompress (IN CONST VOID *Source, IN OUT VOID *Destination, IN OUT VOID *Scratch)

Detailed Description

Provides services to decompress a buffer using the UEFI Decompress algorithm.

The UEFI Decompress Library enables the decompression of objects that were compressed using the UEFI compression scheme. The UEFI Decompress Library is independent of environment and requires the caller to allocate all required memory buffers.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Function Documentation

RETURN_STATUS EFIAPI UefiDecompress	(	IN CONST VOID *	Source,
		IN OUT VOID *	Destination,
		IN OUT VOID *	Scratch
	)

Decompresses a compressed source buffer.

Extracts decompressed data to its original form. This function is designed so that the decompression algorithm can be implemented without using any memory services. As a result, this function is not allowed to call any memory allocation services in its implementation. It is the caller's responsibility to allocate and free the Destination and Scratch buffers. If the compressed source data specified by Source is successfully decompressed into Destination, then RETURN_SUCCESS is returned. If the compressed source data specified by Source is not in a valid compressed data format, then RETURN_INVALID_PARAMETER is returned.

If Source is NULL, then ASSERT(). If Destination is NULL, then ASSERT(). If the required scratch buffer size > 0 and Scratch is NULL, then ASSERT().

Parameters

Source	The source buffer containing the compressed data.
Destination	The destination buffer to store the decompressed data
Scratch	A temporary scratch buffer that is used to perform the decompression. This is an optional parameter that may be NULL if the required scratch buffer size is 0.

Return values

RETURN_SUCCESS	Decompression completed successfully, and the uncompressed buffer is returned in Destination.
RETURN_INVALID_PARAMETER	The source buffer specified by Source is corrupted (not in a valid compressed format).

RETURN_STATUS EFIAPI UefiDecompressGetInfo	(	IN CONST VOID *	Source,
		IN UINT32	SourceSize,
		OUT UINT32 *	DestinationSize,
		OUT UINT32 *	ScratchSize
	)

Given a compressed source buffer, this function retrieves the size of the uncompressed buffer and the size of the scratch buffer required to decompress the compressed source buffer.

Retrieves the size of the uncompressed buffer and the temporary scratch buffer required to decompress the buffer specified by Source and SourceSize. If the size of the uncompressed buffer or the size of the scratch buffer cannot be determined from the compressed data specified by Source and SourceData, then RETURN_INVALID_PARAMETER is returned. Otherwise, the size of the uncompressed buffer is returned in DestinationSize, the size of the scratch buffer is returned in ScratchSize, and RETURN_SUCCESS is returned. This function does not have scratch buffer available to perform a thorough checking of the validity of the source data. It just retrieves the "Original Size" field from the beginning bytes of the source data and output it as DestinationSize. And ScratchSize is specific to the decompression implementation.

If Source is NULL, then ASSERT(). If DestinationSize is NULL, then ASSERT(). If ScratchSize is NULL, then ASSERT().

Parameters

Source	The source buffer containing the compressed data.
SourceSize	The size, in bytes, of the source buffer.
DestinationSize	A pointer to the size, in bytes, of the uncompressed buffer that will be generated when the compressed buffer specified by Source and SourceSize is decompressed.
ScratchSize	A pointer to the size, in bytes, of the scratch buffer that is required to decompress the compressed buffer specified by Source and SourceSize.

Return values

RETURN_SUCCESS	The size of the uncompressed data was returned in DestinationSize and the size of the scratch buffer was returned in ScratchSize.
RETURN_INVALID_PARAMETER	The size of the uncompressed data or the size of the scratch buffer cannot be determined from the compressed data specified by Source and SourceSize.