]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
2 Internal data structure defintions for Base UEFI Decompress Libary.
4 Copyright (c) 2006 - 2008, 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.
15 #ifndef __BASE_UEFI_DECOMPRESS_LIB_INTERNALS_H__
16 #define __BASE_UEFI_DECOMPRESS_LIB_INTERNALS_H__
19 // Decompression algorithm begins here
28 // C: Char&Len Set; P: Position Set; T: exTra Set
30 #define NC (0xff + MAXMATCH + 2 - THRESHOLD)
34 #define MAXNP ((1U << MAXPBIT) - 1)
35 #define NT (CODE_BIT + 3)
43 UINT8
*mSrcBase
; // Starting address of compressed data
44 UINT8
*mDstBase
; // Starting address of decompressed data
57 UINT16 mLeft
[2 * NC
- 1];
58 UINT16 mRight
[2 * NC
- 1];
65 /// The length of the field 'Position Set Code Length Array Size' in Block Header.
66 /// For UEFI 2.0 de/compression algorithm, mPBit = 4
72 Read NumOfBit of bits from source into mBitBuf.
74 Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
76 @param Sd The global scratch data
77 @param NumOfBits The number of bits to shift and read.
87 Get NumOfBits of bits out from mBitBuf.
89 Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent
90 NumOfBits of bits from source. Returns NumOfBits of bits that are
93 @param Sd The global scratch data.
94 @param NumOfBits The number of bits to pop and read.
96 @return The bits that are popped out.
106 Creates Huffman Code mapping table according to code length array.
108 Creates Huffman Code mapping table for Extra Set, Char&Len Set
109 and Position Set according to code length array.
111 @param Sd The global scratch data
112 @param NumOfChar Number of symbols in the symbol set
113 @param BitLen Code length array
114 @param TableBits The width of the mapping table
115 @param Table The table to be created.
118 @retval BAD_TABLE The table is corrupted.
131 Decodes a position value.
133 Get a position value according to Position Huffman Table.
135 @param Sd the global scratch data
137 @return The position value decoded.
146 Reads code lengths for the Extra Set or the Position Set.
148 Read in the Extra Set or Pointion Set Length Arrary, then
149 generate the Huffman code mapping for them.
151 @param Sd The global scratch data.
152 @param nn Number of symbols.
153 @param nbit Number of bits needed to represent nn.
154 @param Special The special symbol that needs to be taken care of.
157 @retval BAD_TABLE Table is corrupted.
169 Reads code lengths for Char&Len Set.
171 Read in and decode the Char&Len Set Code Length Array, then
172 generate the Huffman Code mapping table for the Char&Len Set.
174 @param Sd the global scratch data
183 Decode a character/length value.
185 Read one value from mBitBuf, Get one code from mBitBuf. If it is at block boundary, generates
186 Huffman code mapping table for Extra Set, Code&Len Set and
189 @param Sd The global scratch data.
191 @return The value decoded.
200 Decode the source data and put the resulting data into the destination buffer.
202 @param Sd The global scratch data