]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
2 Internal include file for Base UEFI Decompress Libary.
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: BaseUefiDecompressLibInternals.h
17 #ifndef __BASE_UEFI_DECOMPRESS_LIB_INTERNALS_H__
18 #define __BASE_UEFI_DECOMPRESS_LIB_INTERNALS_H__
21 // Include common header file for this module.
23 #include "CommonHeader.h"
26 // Decompression algorithm begins here
35 // C: Char&Len Set; P: Position Set; T: exTra Set
37 #define NC (0xff + MAXMATCH + 2 - THRESHOLD)
41 #define MAXNP ((1U << MAXPBIT) - 1)
42 #define NT (CODE_BIT + 3)
50 UINT8
*mSrcBase
; ///< Starting address of compressed data
51 UINT8
*mDstBase
; ///< Starting address of decompressed data
64 UINT16 mLeft
[2 * NC
- 1];
65 UINT16 mRight
[2 * NC
- 1];
72 /// The length of the field 'Position Set Code Length Array Size' in Block Header.
73 /// For EFI 1.1 de/compression algorithm, mPBit = 4
74 /// For Tiano de/compression algorithm, mPBit = 5
80 Read NumOfBit of bits from source into mBitBuf
82 Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
84 @param Sd The global scratch data
85 @param NumOfBits The number of bits to shift and read.
95 Get NumOfBits of bits out from mBitBuf
97 Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent
98 NumOfBits of bits from source. Returns NumOfBits of bits that are
101 @param Sd The global scratch data.
102 @param NumOfBits The number of bits to pop and read.
104 @return The bits that are popped out.
114 Creates Huffman Code mapping table according to code length array.
116 Creates Huffman Code mapping table for Extra Set, Char&Len Set
117 and Position Set according to code length array.
119 @param Sd The global scratch data
120 @param NumOfChar Number of symbols in the symbol set
121 @param BitLen Code length array
122 @param TableBits The width of the mapping table
123 @param Table The table
126 @retval BAD_TABLE The table is corrupted.
139 Decodes a position value.
141 Get a position value according to Position Huffman Table.
143 @param Sd the global scratch data
145 @return The position value decoded.
154 Reads code lengths for the Extra Set or the Position Set.
156 Read in the Extra Set or Pointion Set Length Arrary, then
157 generate the Huffman code mapping for them.
159 @param Sd The global scratch data.
160 @param nn Number of symbols.
161 @param nbit Number of bits needed to represent nn.
162 @param Special The special symbol that needs to be taken care of.
165 @retval BAD_TABLE Table is corrupted.
177 Reads code lengths for Char&Len Set.
179 Read in and decode the Char&Len Set Code Length Array, then
180 generate the Huffman Code mapping table for the Char&Len Set.
182 @param Sd the global scratch data
191 Decode a character/length value.
193 Read one value from mBitBuf, Get one code from mBitBuf. If it is at block boundary, generates
194 Huffman code mapping table for Extra Set, Code&Len Set and
197 @param Sd The global scratch data.
199 @return The value decoded.
208 Decode the source data and put the resulting data into the destination buffer.
210 Decode the source data and put the resulting data into the destination buffer.
212 @param Sd The global scratch data