#include <PiPei.h>
#include <Library/ExtractGuidedSectionLib.h>
#include <brotli/c/include/brotli/types.h>
#include <brotli/c/include/brotli/decode.h>

Data Structures
struct	BROTLI_BUFF

Macros
#define	FILE_BUFFER_SIZE 65536

#define	BROTLI_INFO_SIZE 8

#define	BROTLI_DECODE_MAX 8

#define	BROTLI_SCRATCH_MAX 16

Functions
EFI_STATUS EFIAPI	BrotliUefiDecompressGetInfo (IN CONST VOID Source, IN UINT32 SourceSize, OUT UINT32 DestinationSize, OUT UINT32 *ScratchSize)

EFI_STATUS EFIAPI	BrotliUefiDecompress (IN CONST VOID Source, IN UINTN SourceSize, IN OUT VOID Destination, IN OUT VOID *Scratch)

Detailed Description

BROTLI UEFI header file

Allows BROTLI code to build under UEFI (edk2) build environment

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

Definition in file BrotliDecompressLibInternal.h.

Macro Definition Documentation

◆ BROTLI_DECODE_MAX

#define BROTLI_DECODE_MAX 8

Definition at line 26 of file BrotliDecompressLibInternal.h.

◆ BROTLI_INFO_SIZE

#define BROTLI_INFO_SIZE 8

Definition at line 25 of file BrotliDecompressLibInternal.h.

◆ BROTLI_SCRATCH_MAX

#define BROTLI_SCRATCH_MAX 16

Definition at line 27 of file BrotliDecompressLibInternal.h.

◆ FILE_BUFFER_SIZE

#define FILE_BUFFER_SIZE 65536

Definition at line 24 of file BrotliDecompressLibInternal.h.

Function Documentation

◆ BrotliUefiDecompress()

EFI_STATUS EFIAPI BrotliUefiDecompress	(	IN CONST VOID *	Source,
		IN UINTN	SourceSize,
		IN OUT VOID *	Destination,
		IN OUT VOID *	Scratch
	)

Decompresses a Brotli compressed source buffer.

Extracts decompressed data to its original form. 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.

Parameters

Source	The source buffer containing the compressed data.
SourceSize	The size of source buffer.
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

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

Definition at line 272 of file BrotliDecompress.c.

◆ BrotliUefiDecompressGetInfo()

EFI_STATUS EFIAPI BrotliUefiDecompressGetInfo	(	IN CONST VOID *	Source,
		IN UINT32	SourceSize,
		OUT UINT32 *	DestinationSize,
		OUT UINT32 *	ScratchSize
	)

Given a Brotli 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. The size of the uncompressed buffer is returned in DestinationSize, the size of the scratch buffer is returned in ScratchSize, and EFI_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 BROTLI_SCRATCH_MAX beginning bytes of the source data and output it as DestinationSize. And ScratchSize is specific to the decompression implementation.

If SourceSize is less than BROTLI_SCRATCH_MAX, 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

EFI_SUCCESS The size of the uncompressed data was returned in DestinationSize and the size of the scratch buffer was returned in ScratchSize.

Definition at line 227 of file BrotliDecompress.c.

Data Structures

Macros

Functions