]>
git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLibInternals.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: BaseUefiCustomDecompressLibInternals.h
17 #ifndef __BASE_UEFI_TIANO_CUSTOM_DECOMPRESS_LIB_INTERNALS_H__
18 #define __BASE_UEFI_TIANO_CUSTOM_DECOMPRESS_LIB_INTERNALS_H__
22 #include <Library/UefiDecompressLib.h>
23 #include <Library/DebugLib.h>
24 #include <Library/BaseMemoryLib.h>
25 #include <Library/ExtractGuidedSectionLib.h>
28 // Decompression algorithm begins here
37 // C: Char&Len Set; P: Position Set; T: exTra Set
39 #define NC (0xff + MAXMATCH + 2 - THRESHOLD)
43 #define MAXNP ((1U << MAXPBIT) - 1)
44 #define NT (CODE_BIT + 3)
52 UINT8
*mSrcBase
; // Starting address of compressed data
53 UINT8
*mDstBase
; // Starting address of decompressed data
66 UINT16 mLeft
[2 * NC
- 1];
67 UINT16 mRight
[2 * NC
- 1];
74 // The length of the field 'Position Set Code Length Array Size' in Block Header.
75 // For UEFI 2.0 de/compression algorithm, mPBit = 4
76 // For Tiano de/compression algorithm, mPBit = 5
82 Read NumOfBit of bits from source into mBitBuf
84 Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
86 @param Sd The global scratch data
87 @param NumOfBits The number of bits to shift and read.
97 Get NumOfBits of bits out from mBitBuf
99 Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent
100 NumOfBits of bits from source. Returns NumOfBits of bits that are
103 @param Sd The global scratch data.
104 @param NumOfBits The number of bits to pop and read.
106 @return The bits that are popped out.
116 Creates Huffman Code mapping table according to code length array.
118 Creates Huffman Code mapping table for Extra Set, Char&Len Set
119 and Position Set according to code length array.
121 @param Sd The global scratch data
122 @param NumOfChar Number of symbols in the symbol set
123 @param BitLen Code length array
124 @param TableBits The width of the mapping table
125 @param Table The table
128 @retval BAD_TABLE The table is corrupted.
141 Decodes a position value.
143 Get a position value according to Position Huffman Table.
145 @param Sd the global scratch data
147 @return The position value decoded.
156 Reads code lengths for the Extra Set or the Position Set.
158 Read in the Extra Set or Pointion Set Length Arrary, then
159 generate the Huffman code mapping for them.
161 @param Sd The global scratch data.
162 @param nn Number of symbols.
163 @param nbit Number of bits needed to represent nn.
164 @param Special The special symbol that needs to be taken care of.
167 @retval BAD_TABLE Table is corrupted.
179 Reads code lengths for Char&Len Set.
181 Read in and decode the Char&Len Set Code Length Array, then
182 generate the Huffman Code mapping table for the Char&Len Set.
184 @param Sd the global scratch data
193 Decode a character/length value.
195 Read one value from mBitBuf, Get one code from mBitBuf. If it is at block boundary, generates
196 Huffman code mapping table for Extra Set, Code&Len Set and
199 @param Sd The global scratch data.
201 @return The value decoded.
210 Decode the source data and put the resulting data into the destination buffer.
212 Decode the source data and put the resulting data into the destination buffer.
214 @param Sd The global scratch data
224 UefiTianoDecompress (
225 IN CONST VOID
*Source
,
226 IN OUT VOID
*Destination
,
227 IN OUT VOID
*Scratch
,