/** @file\r
- Internal include file for Base UEFI Decompress Libary.\r
+ Internal data structure defintions for Base UEFI Decompress Libary.\r
\r
- Copyright (c) 2006, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2006 - 2010, 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
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
- Module Name: BaseUefiDecompressLibInternals.h\r
-\r
**/\r
\r
#ifndef __BASE_UEFI_DECOMPRESS_LIB_INTERNALS_H__\r
#endif\r
\r
typedef struct {\r
- UINT8 *mSrcBase; ///< Starting address of compressed data\r
- UINT8 *mDstBase; ///< Starting address of decompressed data\r
+ UINT8 *mSrcBase; // Starting address of compressed data\r
+ UINT8 *mDstBase; // Starting address of decompressed data\r
UINT32 mOutBuf;\r
UINT32 mInBuf;\r
\r
\r
///\r
/// The length of the field 'Position Set Code Length Array Size' in Block Header.\r
- /// For EFI 1.1 de/compression algorithm, mPBit = 4\r
- /// For Tiano de/compression algorithm, mPBit = 5\r
+ /// For UEFI 2.0 de/compression algorithm, mPBit = 4\r
///\r
UINT8 mPBit;\r
} SCRATCH_DATA;\r
\r
/**\r
- Read NumOfBit of bits from source into mBitBuf\r
+ Read NumOfBit of bits from source into mBitBuf.\r
\r
Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.\r
\r
);\r
\r
/**\r
- Get NumOfBits of bits out from mBitBuf\r
+ Get NumOfBits of bits out from mBitBuf.\r
\r
- Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent \r
- NumOfBits of bits from source. Returns NumOfBits of bits that are \r
+ Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent\r
+ NumOfBits of bits from source. Returns NumOfBits of bits that are\r
popped out.\r
\r
@param Sd The global scratch data.\r
/**\r
Creates Huffman Code mapping table according to code length array.\r
\r
- Creates Huffman Code mapping table for Extra Set, Char&Len Set \r
+ Creates Huffman Code mapping table for Extra Set, Char&Len Set\r
and Position Set according to code length array.\r
+ If TableBits > 16, then ASSERT ().\r
\r
@param Sd The global scratch data\r
@param NumOfChar Number of symbols in the symbol set\r
@param BitLen Code length array\r
@param TableBits The width of the mapping table\r
- @param Table The table\r
+ @param Table The table to be created.\r
\r
@retval 0 OK.\r
@retval BAD_TABLE The table is corrupted.\r
Decodes a position value.\r
\r
Get a position value according to Position Huffman Table.\r
- \r
+\r
@param Sd the global scratch data\r
\r
@return The position value decoded.\r
\r
/**\r
Reads code lengths for Char&Len Set.\r
- \r
+\r
Read in and decode the Char&Len Set Code Length Array, then\r
generate the Huffman Code mapping table for the Char&Len Set.\r
\r
\r
/**\r
Decode a character/length value.\r
- \r
+\r
Read one value from mBitBuf, Get one code from mBitBuf. If it is at block boundary, generates\r
Huffman code mapping table for Extra Set, Code&Len Set and\r
Position Set.\r
/**\r
Decode the source data and put the resulting data into the destination buffer.\r
\r
- Decode the source data and put the resulting data into the destination buffer.\r
- \r
@param Sd The global scratch data\r
\r
**/\r