1. Add ExtractGuidedSectionLib library to replace customdecompress library.

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / BaseUefiTianoCustomDecompressLib / BaseUefiTianoCustomDecompressLibInternals.h

/** @file\r
  Internal include file for Base UEFI Decompress Libary.\r
\r
  Copyright (c) 2006, Intel Corporation\r
  All rights reserved. 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
\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:  BaseUefiCustomDecompressLibInternals.h\r
\r
**/\r
\r
#ifndef __BASE_UEFI_TIANO_CUSTOM_DECOMPRESS_LIB_INTERNALS_H__\r
#define __BASE_UEFI_TIANO_CUSTOM_DECOMPRESS_LIB_INTERNALS_H__\r
\r
#include <PiPei.h>\r
\r
#include <Library/UefiDecompressLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
\r
//\r
// Decompression algorithm begins here\r
//\r
#define BITBUFSIZ 32\r
#define MAXMATCH  256\r
#define THRESHOLD 3\r
#define CODE_BIT  16\r
#define BAD_TABLE - 1\r
\r
//\r
// C: Char&Len Set; P: Position Set; T: exTra Set\r
//\r
#define NC      (0xff + MAXMATCH + 2 - THRESHOLD)\r
#define CBIT    9\r
#define MAXPBIT 5\r
#define TBIT    5\r
#define MAXNP   ((1U << MAXPBIT) - 1)\r
#define NT      (CODE_BIT + 3)\r
#if NT > MAXNP\r
#define NPT NT\r
#else\r
#define NPT MAXNP\r
#endif\r
\r
typedef struct {\r
  UINT8   *mSrcBase;  // Starting address of compressed data\r
  UINT8   *mDstBase;  // Starting address of decompressed data\r
  UINT32  mOutBuf;\r
  UINT32  mInBuf;\r
\r
  UINT16  mBitCount;\r
  UINT32  mBitBuf;\r
  UINT32  mSubBitBuf;\r
  UINT16  mBlockSize;\r
  UINT32  mCompSize;\r
  UINT32  mOrigSize;\r
\r
  UINT16  mBadTableFlag;\r
\r
  UINT16  mLeft[2 * NC - 1];\r
  UINT16  mRight[2 * NC - 1];\r
  UINT8   mCLen[NC];\r
  UINT8   mPTLen[NPT];\r
  UINT16  mCTable[4096];\r
  UINT16  mPTTable[256];\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
  //\r
  UINT8   mPBit;\r
} SCRATCH_DATA;\r
\r
/**\r
  Read NumOfBit of bits from source into mBitBuf\r
\r
  Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.\r
\r
  @param  Sd        The global scratch data\r
  @param  NumOfBits The number of bits to shift and read.\r
\r
**/\r
VOID\r
FillBuf (\r
  IN  SCRATCH_DATA  *Sd,\r
  IN  UINT16        NumOfBits\r
  );\r
\r
/**\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
  popped out.\r
\r
  @param  Sd        The global scratch data.\r
  @param  NumOfBits The number of bits to pop and read.\r
\r
  @return The bits that are popped out.\r
\r
**/\r
UINT32\r
GetBits (\r
  IN  SCRATCH_DATA  *Sd,\r
  IN  UINT16        NumOfBits\r
  );\r
\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
  and Position Set according to code length array.\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
\r
  @retval  0 OK.\r
  @retval  BAD_TABLE The table is corrupted.\r
\r
**/\r
UINT16\r
MakeTable (\r
  IN  SCRATCH_DATA  *Sd,\r
  IN  UINT16        NumOfChar,\r
  IN  UINT8         *BitLen,\r
  IN  UINT16        TableBits,\r
  OUT UINT16        *Table\r
  );\r
\r
/**\r
  Decodes a position value.\r
\r
  Get a position value according to Position Huffman Table.\r
  \r
  @param  Sd the global scratch data\r
\r
  @return The position value decoded.\r
\r
**/\r
UINT32\r
DecodeP (\r
  IN  SCRATCH_DATA  *Sd\r
  );\r
\r
/**\r
  Reads code lengths for the Extra Set or the Position Set.\r
\r
  Read in the Extra Set or Pointion Set Length Arrary, then\r
  generate the Huffman code mapping for them.\r
\r
  @param  Sd      The global scratch data.\r
  @param  nn      Number of symbols.\r
  @param  nbit    Number of bits needed to represent nn.\r
  @param  Special The special symbol that needs to be taken care of.\r
\r
  @retval  0 OK.\r
  @retval  BAD_TABLE Table is corrupted.\r
\r
**/\r
UINT16\r
ReadPTLen (\r
  IN  SCRATCH_DATA  *Sd,\r
  IN  UINT16        nn,\r
  IN  UINT16        nbit,\r
  IN  UINT16        Special\r
  );\r
\r
/**\r
  Reads code lengths for Char&Len Set.\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
  @param  Sd the global scratch data\r
\r
**/\r
VOID\r
ReadCLen (\r
  SCRATCH_DATA  *Sd\r
  );\r
\r
/**\r
  Decode a character/length value.\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
  @param  Sd The global scratch data.\r
\r
  @return The value decoded.\r
\r
**/\r
UINT16\r
DecodeC (\r
  SCRATCH_DATA  *Sd\r
  );\r
\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
VOID\r
Decode (\r
  SCRATCH_DATA  *Sd\r
  );\r
\r
RETURN_STATUS\r
EFIAPI\r
UefiTianoDecompress (\r
  IN CONST VOID  *Source,\r
  IN OUT VOID    *Destination,\r
  IN OUT VOID    *Scratch,\r
  IN UINT32      Version\r
  );\r
\r
#endif\r