Code scrub for the Debug library, PostCode library, Print library, and ExtractGuidedSection library.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5478 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -1,7 +1,12 @@
|
||||
/** @file
|
||||
Return UEFI Decompress Protocol
|
||||
UEFI Decompress Library Functions defintion
|
||||
|
||||
Copyright (c) 2006, Intel Corporation
|
||||
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 - 2008, Intel Corporation
|
||||
All rights reserved. This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
@@ -16,7 +21,9 @@
|
||||
#define __UEFI_DECPOMPRESS_LIB_H__
|
||||
|
||||
/**
|
||||
Retrieves the size of the uncompressed buffer and the size of the scratch buffer.
|
||||
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.
|
||||
@@ -43,10 +50,14 @@
|
||||
is required to decompress the compressed buffer specified
|
||||
by Source and SourceSize.
|
||||
|
||||
@retval RETURN_SUCCESS The size of destination buffer and the size of scratch
|
||||
buffer are successull retrieved.
|
||||
@retval RETURN_INVALID_PARAMETER The source data is corrupted
|
||||
|
||||
@retval RETURN_SUCCESS The size of the uncompressed data was returned
|
||||
in DestinationSize and the size of the scratch
|
||||
buffer was returned in ScratchSize.
|
||||
@retval 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.
|
||||
**/
|
||||
RETURN_STATUS
|
||||
EFIAPI
|
||||
@@ -60,6 +71,7 @@ UefiDecompressGetInfo (
|
||||
/**
|
||||
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 r
|
||||
@@ -79,9 +91,11 @@ UefiDecompressGetInfo (
|
||||
This is an optional parameter that may be NULL if the
|
||||
required scratch buffer size is 0.
|
||||
|
||||
@retval RETURN_SUCCESS Decompression is successfull
|
||||
@retval RETURN_INVALID_PARAMETER The source data is corrupted
|
||||
|
||||
@retval RETURN_SUCCESS Decompression completed successfully, and
|
||||
the uncompressed buffer is returned in Destination.
|
||||
@retval RETURN_INVALID_PARAMETER
|
||||
The source buffer specified by Source is corrupted
|
||||
(not in a valid compressed format).
|
||||
**/
|
||||
RETURN_STATUS
|
||||
EFIAPI
|
||||
|
Reference in New Issue
Block a user