MdePkg: Clean up source files
1. Do not use tab characters 2. No trailing white space in one line 3. All files must end with CRLF Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
@@ -1,12 +1,12 @@
|
||||
/** @file
|
||||
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
|
||||
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.<BR>
|
||||
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||
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
|
||||
@@ -21,18 +21,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
#define __UEFI_DECPOMPRESS_LIB_H__
|
||||
|
||||
/**
|
||||
Given a compressed source buffer, this function retrieves the size of
|
||||
the uncompressed buffer and the size of the scratch buffer required
|
||||
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
|
||||
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,
|
||||
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
|
||||
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.
|
||||
@@ -47,16 +47,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
that will be generated when the compressed buffer specified
|
||||
by Source and SourceSize is decompressed.
|
||||
@param ScratchSize A pointer to the size, in bytes, of the scratch buffer that
|
||||
is required to decompress the compressed buffer specified
|
||||
is required to decompress the compressed buffer specified
|
||||
by Source and SourceSize.
|
||||
|
||||
@retval RETURN_SUCCESS The size of the uncompressed data was returned
|
||||
in DestinationSize and the size of the scratch
|
||||
@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
|
||||
@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
|
||||
@@ -74,10 +74,10 @@ UefiDecompressGetInfo (
|
||||
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
|
||||
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
|
||||
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.
|
||||
|
||||
@@ -88,13 +88,13 @@ UefiDecompressGetInfo (
|
||||
@param Source The source buffer containing the compressed data.
|
||||
@param Destination The destination buffer to store the decompressed data
|
||||
@param Scratch A temporary scratch buffer that is used to perform the decompression.
|
||||
This is an optional parameter that may be NULL if the
|
||||
This is an optional parameter that may be NULL if the
|
||||
required scratch buffer size is 0.
|
||||
|
||||
@retval RETURN_SUCCESS Decompression completed successfully, and
|
||||
|
||||
@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
|
||||
@retval RETURN_INVALID_PARAMETER
|
||||
The source buffer specified by Source is corrupted
|
||||
(not in a valid compressed format).
|
||||
**/
|
||||
RETURN_STATUS
|
||||
|
Reference in New Issue
Block a user