]>
git.proxmox.com Git - mirror_edk2.git/blob - EdkModulePkg/Library/BaseUefiTianoDecompressLib/BaseUefiTianoDecompressLibInternals.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_TIANO_DECOMPRESS_LIB_INTERNALS_H__
18 #define __BASE_UEFI_TIANO_DECOMPRESS_LIB_INTERNALS_H__
21 // Decompression algorithm begins here
30 // C: Char&Len Set; P: Position Set; T: exTra Set
32 #define NC (0xff + MAXMATCH + 2 - THRESHOLD)
36 #define MAXNP ((1U << MAXPBIT) - 1)
37 #define NT (CODE_BIT + 3)
45 UINT8
*mSrcBase
; // Starting address of compressed data
46 UINT8
*mDstBase
; // Starting address of decompressed data
59 UINT16 mLeft
[2 * NC
- 1];
60 UINT16 mRight
[2 * NC
- 1];
67 // The length of the field 'Position Set Code Length Array Size' in Block Header.
68 // For EFI 1.1 de/compression algorithm, mPBit = 4
69 // For Tiano de/compression algorithm, mPBit = 5
75 Read NumOfBit of bits from source into mBitBuf
77 Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
79 @param Sd The global scratch data
80 @param NumOfBits The number of bits to shift and read.
90 Get NumOfBits of bits out from mBitBuf
92 Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent
93 NumOfBits of bits from source. Returns NumOfBits of bits that are
96 @param Sd The global scratch data.
97 @param NumOfBits The number of bits to pop and read.
99 @return The bits that are popped out.
109 Creates Huffman Code mapping table according to code length array.
111 Creates Huffman Code mapping table for Extra Set, Char&Len Set
112 and Position Set according to code length array.
114 @param Sd The global scratch data
115 @param NumOfChar Number of symbols in the symbol set
116 @param BitLen Code length array
117 @param TableBits The width of the mapping table
118 @param Table The table
121 @retval BAD_TABLE The table is corrupted.
134 Decodes a position value.
136 Get a position value according to Position Huffman Table.
138 @param Sd the global scratch data
140 @return The position value decoded.
149 Reads code lengths for the Extra Set or the Position Set.
151 Read in the Extra Set or Pointion Set Length Arrary, then
152 generate the Huffman code mapping for them.
154 @param Sd The global scratch data.
155 @param nn Number of symbols.
156 @param nbit Number of bits needed to represent nn.
157 @param Special The special symbol that needs to be taken care of.
160 @retval BAD_TABLE Table is corrupted.
172 Reads code lengths for Char&Len Set.
174 Read in and decode the Char&Len Set Code Length Array, then
175 generate the Huffman Code mapping table for the Char&Len Set.
177 @param Sd the global scratch data
186 Decode a character/length value.
188 Read one value from mBitBuf, Get one code from mBitBuf. If it is at block boundary, generates
189 Huffman code mapping table for Extra Set, Code&Len Set and
192 @param Sd The global scratch data.
194 @return The value decoded.
203 Decode the source data and put the resulting data into the destination buffer.
205 Decode the source data and put the resulting data into the destination buffer.
207 @param Sd The global scratch data
217 UefiTianoDecompress (
218 IN CONST VOID
*Source
,
219 IN OUT VOID
*Destination
,
220 IN OUT VOID
*Scratch
,