From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 192.55.52.120, mailfrom: liming.gao@intel.com) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by groups.io with SMTP; Sat, 04 May 2019 22:26:51 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 04 May 2019 22:26:51 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,431,1549958400"; d="scan'208";a="167816154" Received: from fmsmsx106.amr.corp.intel.com ([10.18.124.204]) by fmsmga002.fm.intel.com with ESMTP; 04 May 2019 22:26:51 -0700 Received: from shsmsx105.ccr.corp.intel.com (10.239.4.158) by FMSMSX106.amr.corp.intel.com (10.18.124.204) with Microsoft SMTP Server (TLS) id 14.3.408.0; Sat, 4 May 2019 22:26:50 -0700 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.33]) by SHSMSX105.ccr.corp.intel.com ([169.254.11.10]) with mapi id 14.03.0415.000; Sun, 5 May 2019 13:26:48 +0800 From: "Liming Gao" To: "Bi, Dandan" , "devel@edk2.groups.io" CC: "Kinney, Michael D" , "Wang, Jian J" , "Wu, Hao A" , "Ni, Ray" , "Sun, Zailiang" , "Qian, Yi" , Ard Biesheuvel , "Leif Lindholm" Subject: Re: [RFC] [patch] Merge MdeModulePkg\BaseTianoCustomDecompressLib into MdePkg\BaseUefiDecompressLib Thread-Topic: [RFC] [patch] Merge MdeModulePkg\BaseTianoCustomDecompressLib into MdePkg\BaseUefiDecompressLib Thread-Index: AQHU/zL3Od5KaleYmECJ03SdCHbbAKZcB6OQ Date: Sun, 5 May 2019 05:26:48 +0000 Message-ID: <4A89E2EF3DFEDB4C8BFDE51014F606A14E441277@SHSMSX104.ccr.corp.intel.com> References: <20190430085841.15144-1-dandan.bi@intel.com> In-Reply-To: <20190430085841.15144-1-dandan.bi@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Return-Path: liming.gao@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Dandan: This change is good. Please list the information in its BZ.=20 Thanks Liming >-----Original Message----- >From: Bi, Dandan >Sent: Tuesday, April 30, 2019 4:59 PM >To: devel@edk2.groups.io >Cc: Kinney, Michael D ; Gao, Liming >; Wang, Jian J ; Wu, Hao A >; Ni, Ray ; Sun, Zailiang >; Qian, Yi ; Ard Biesheuvel >; Leif Lindholm >Subject: [RFC] [patch] Merge >MdeModulePkg\BaseTianoCustomDecompressLib into >MdePkg\BaseUefiDecompressLib > >BaseUefiDecompressLib in MdePkg implements the UEFI Decompress >algorithm. >BaseUefiTianoCustomDecompressLib in MdeModulePkg implements the UEFI >Decompress algorithm >and Tiano Custom Decompression algorithm. >Tiano custom decompression algorithm shares most of the code with the UEFI >Decompress algorithm. >So BaseUefiDecompressLib and BaseUefiTianoCustomDecompressLib have >lots common code. >We plan to merge the MdeModulePkg\BaseTianoCustomDecompressLib into >MdePkg\BaseUefiDecompressLib, >in order to reduce the duplicated codes and maintain these two Decompress >algorithms easily. > >Propose to update: >1. Make the implemtations of these two Decompress algorithms in exstring >MdePkg/Library/BaseUefiDecompressLib. >2. keep existing BaseUefiDecompressLib.inf in >MdePkg/Library/BaseUefiDecompressLib for UEFI Decompress algorithm. >3. Add BaseTianoCustomDecompressLib.inf in >MdePkg/Library/BaseUefiDecompressLib for Tiano Custom Decompression >algorithm. >4. Make existing BaseUefiDecompressLib.c in >MdePkg/Library/BaseUefiDecompressLib to support the Tiano Custom >Decompression algorithm > besides existing UEFI Decompress algorithm. >5. Remove the gTianoCustomDecompressGuid header file from >MdeModulePkg/Include/Guid/TianoDecompress.h > Move the gTianoCustomDecompressGuid definition from >MdeModulePkg.dec to MdePkg.dec. >6. Remove the MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib >from edk2. > >The draf updates are covered by this patch. > >Impact analysis: >1. No impact to the usage of BaseUefiDecompressLib. >2. Need to update the consumers of > >MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano >CustomDecompressLib.inf > to use > >MdePkg/Library/BaseUefiDecompressLib/BaseTianoCustomDecompressLib.in >f >3. Current impacted platforms: > edk2 repo: > Nt32Pkg > Quark > vlv2tbltdevicepkg > edk2-platforms repo: > AMD Overdrive > Lemaker Cello > Raspberry Pi3 > SoftIron 1000 > D03/D05/D06 > Hikey/Hikey960 > >For platforms in edk2 repo, we can add the >BaseTianoCustomDecompressLib.inf in >MdePkg/Library/BaseUefiDecompressLib firstly >and then update platform consumers, remove the >MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib at last. > >For the platforms in edk2-platforms repo, I find they don't use the Tiano >Custom Decompression algorithm actually. >So we can update them to use the >MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.inf firstly >to avoid any >imconpatible changes. > >Cc: Michael D Kinney >Cc: Liming Gao >Cc: Jian J Wang >Cc: Hao Wu >Cc: Ray Ni >Cc: Zailiang Sun >Cc: Yi Qian >Cc: Ard Biesheuvel >Cc: Leif Lindholm > >Signed-off-by: Dandan Bi >--- > MdeModulePkg/Include/Guid/TianoDecompress.h | 22 - > .../BaseUefiTianoCustomDecompressLib.c | 1063 ----------------- > ...aseUefiTianoCustomDecompressLibInternals.h | 214 ---- > .../BaseUefiTianoDecompressLib.uni | 16 - > MdeModulePkg/MdeModulePkg.dec | 4 - > MdeModulePkg/MdeModulePkg.dsc | 1 - > .../BaseTianoCustomDecompressLib.inf | 5 +- > .../BaseUefiDecompressLib.c | 261 +++- > .../BaseUefiDecompressLib.inf | 2 + > .../BaseUefiDecompressLib.uni | 6 +- > MdePkg/MdePkg.dec | 5 + > MdePkg/MdePkg.dsc | 1 + > 12 files changed, 270 insertions(+), 1330 deletions(-) > delete mode 100644 MdeModulePkg/Include/Guid/TianoDecompress.h > delete mode 100644 >MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano >CustomDecompressLib.c > delete mode 100644 >MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano >CustomDecompressLibInternals.h > delete mode 100644 >MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano >DecompressLib.uni > rename >MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano >CustomDecompressLib.inf =3D> >MdePkg/Library/BaseUefiDecompressLib/BaseTianoCustomDecompressLib.in >f (88%) > >diff --git a/MdeModulePkg/Include/Guid/TianoDecompress.h >b/MdeModulePkg/Include/Guid/TianoDecompress.h >deleted file mode 100644 >index 40f74f88f3..0000000000 >--- a/MdeModulePkg/Include/Guid/TianoDecompress.h >+++ /dev/null >@@ -1,22 +0,0 @@ >-/** @file >- Tiano Custom decompress Guid definition. >- >-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
>-SPDX-License-Identifier: BSD-2-Clause-Patent >- >-**/ >- >-#ifndef __TIANO_CUSTOM_DECOMPRESS_GUID_H__ >-#define __TIANO_CUSTOM_DECOMPRESS_GUID_H__ >- >-/// >-/// The Global ID used to identify a section of an FFS file of type >-/// EFI_SECTION_GUID_DEFINED, whose contents have been compressed >using >-/// Tiano Custom compression. >-/// >-#define TIANO_CUSTOM_DECOMPRESS_GUID \ >- { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x4= 7, >0x79 } } >- >-extern GUID gTianoCustomDecompressGuid; >- >-#endif >diff --git >a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noCustomDecompressLib.c >b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noCustomDecompressLib.c >deleted file mode 100644 >index 38b66b1906..0000000000 >--- >a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noCustomDecompressLib.c >+++ /dev/null >@@ -1,1063 +0,0 @@ >-/** @file >- UEFI and Tiano Custom Decompress Library >- It will do Tiano or UEFI decompress with different verison parameter. >- >-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
>-SPDX-License-Identifier: BSD-2-Clause-Patent >- >-**/ >- >-#include "BaseUefiTianoCustomDecompressLibInternals.h" >- >-/** >- Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source. >- >- @param Sd The global scratch data >- @param NumOfBits The number of bits to shift and read. >-**/ >-VOID >-FillBuf ( >- IN SCRATCH_DATA *Sd, >- IN UINT16 NumOfBits >- ) >-{ >- // >- // Left shift NumOfBits of bits in advance >- // >- Sd->mBitBuf =3D (UINT32) LShiftU64 (((UINT64)Sd->mBitBuf), NumOfBits); >- >- // >- // Copy data needed in bytes into mSbuBitBuf >- // >- while (NumOfBits > Sd->mBitCount) { >- NumOfBits =3D (UINT16) (NumOfBits - Sd->mBitCount); >- Sd->mBitBuf |=3D (UINT32) LShiftU64 (((UINT64)Sd->mSubBitBuf), >NumOfBits); >- >- if (Sd->mCompSize > 0) { >- // >- // Get 1 byte into SubBitBuf >- // >- Sd->mCompSize--; >- Sd->mSubBitBuf =3D 0; >- Sd->mSubBitBuf =3D Sd->mSrcBase[Sd->mInBuf++]; >- Sd->mBitCount =3D 8; >- >- } else { >- // >- // No more bits from the source, just pad zero bit. >- // >- Sd->mSubBitBuf =3D 0; >- Sd->mBitCount =3D 8; >- >- } >- } >- >- // >- // Calculate additional bit count read to update mBitCount >- // >- Sd->mBitCount =3D (UINT16) (Sd->mBitCount - NumOfBits); >- >- // >- // Copy NumOfBits of bits from mSubBitBuf into mBitBuf >- // >- Sd->mBitBuf |=3D Sd->mSubBitBuf >> Sd->mBitCount; >-} >- >-/** >- Get NumOfBits of bits out from mBitBuf >- >- Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent >- NumOfBits of bits from source. Returns NumOfBits of bits that are >- popped out. >- >- @param Sd The global scratch data. >- @param NumOfBits The number of bits to pop and read. >- >- @return The bits that are popped out. >- >-**/ >-UINT32 >-GetBits ( >- IN SCRATCH_DATA *Sd, >- IN UINT16 NumOfBits >- ) >-{ >- UINT32 OutBits; >- >- // >- // Pop NumOfBits of Bits from Left >- // >- OutBits =3D (UINT32) (Sd->mBitBuf >> (BITBUFSIZ - NumOfBits)); >- >- // >- // Fill up mBitBuf from source >- // >- FillBuf (Sd, NumOfBits); >- >- return OutBits; >-} >- >-/** >- Creates Huffman Code mapping table according to code length array. >- >- Creates Huffman Code mapping table for Extra Set, Char&Len Set >- and Position Set according to code length array. >- If TableBits > 16, then ASSERT (). >- >- @param Sd The global scratch data >- @param NumOfChar Number of symbols in the symbol set >- @param BitLen Code length array >- @param TableBits The width of the mapping table >- @param Table The table to be created. >- >- @retval 0 OK. >- @retval BAD_TABLE The table is corrupted. >- >-**/ >-UINT16 >-MakeTable ( >- IN SCRATCH_DATA *Sd, >- IN UINT16 NumOfChar, >- IN UINT8 *BitLen, >- IN UINT16 TableBits, >- OUT UINT16 *Table >- ) >-{ >- UINT16 Count[17]; >- UINT16 Weight[17]; >- UINT16 Start[18]; >- UINT16 *Pointer; >- UINT16 Index3; >- UINT16 Index; >- UINT16 Len; >- UINT16 Char; >- UINT16 JuBits; >- UINT16 Avail; >- UINT16 NextCode; >- UINT16 Mask; >- UINT16 WordOfStart; >- UINT16 WordOfCount; >- UINT16 MaxTableLength; >- >- // >- // The maximum mapping table width supported by this internal >- // working function is 16. >- // >- ASSERT (TableBits <=3D 16); >- >- for (Index =3D 0; Index <=3D 16; Index++) { >- Count[Index] =3D 0; >- } >- >- for (Index =3D 0; Index < NumOfChar; Index++) { >- if (BitLen[Index] > 16) { >- return (UINT16) BAD_TABLE; >- } >- Count[BitLen[Index]]++; >- } >- >- Start[0] =3D 0; >- Start[1] =3D 0; >- >- for (Index =3D 1; Index <=3D 16; Index++) { >- WordOfStart =3D Start[Index]; >- WordOfCount =3D Count[Index]; >- Start[Index + 1] =3D (UINT16) (WordOfStart + (WordOfCount << (16 - In= dex))); >- } >- >- if (Start[17] !=3D 0) { >- /*(1U << 16)*/ >- return (UINT16) BAD_TABLE; >- } >- >- JuBits =3D (UINT16) (16 - TableBits); >- >- Weight[0] =3D 0; >- for (Index =3D 1; Index <=3D TableBits; Index++) { >- Start[Index] >>=3D JuBits; >- Weight[Index] =3D (UINT16) (1U << (TableBits - Index)); >- } >- >- while (Index <=3D 16) { >- Weight[Index] =3D (UINT16) (1U << (16 - Index)); >- Index++; >- } >- >- Index =3D (UINT16) (Start[TableBits + 1] >> JuBits); >- >- if (Index !=3D 0) { >- Index3 =3D (UINT16) (1U << TableBits); >- if (Index < Index3) { >- SetMem16 (Table + Index, (Index3 - Index) * sizeof (*Table), 0); >- } >- } >- >- Avail =3D NumOfChar; >- Mask =3D (UINT16) (1U << (15 - TableBits)); >- MaxTableLength =3D (UINT16) (1U << TableBits); >- >- for (Char =3D 0; Char < NumOfChar; Char++) { >- >- Len =3D BitLen[Char]; >- if (Len =3D=3D 0 || Len >=3D 17) { >- continue; >- } >- >- NextCode =3D (UINT16) (Start[Len] + Weight[Len]); >- >- if (Len <=3D TableBits) { >- >- for (Index =3D Start[Len]; Index < NextCode; Index++) { >- if (Index >=3D MaxTableLength) { >- return (UINT16) BAD_TABLE; >- } >- Table[Index] =3D Char; >- } >- >- } else { >- >- Index3 =3D Start[Len]; >- Pointer =3D &Table[Index3 >> JuBits]; >- Index =3D (UINT16) (Len - TableBits); >- >- while (Index !=3D 0) { >- if (*Pointer =3D=3D 0 && Avail < (2 * NC - 1)) { >- Sd->mRight[Avail] =3D Sd->mLeft[Avail] =3D 0; >- *Pointer =3D Avail++; >- } >- >- if (*Pointer < (2 * NC - 1)) { >- if ((Index3 & Mask) !=3D 0) { >- Pointer =3D &Sd->mRight[*Pointer]; >- } else { >- Pointer =3D &Sd->mLeft[*Pointer]; >- } >- } >- >- Index3 <<=3D 1; >- Index--; >- } >- >- *Pointer =3D Char; >- >- } >- >- Start[Len] =3D NextCode; >- } >- // >- // Succeeds >- // >- return 0; >-} >- >-/** >- Decodes a position value. >- >- Get a position value according to Position Huffman Table. >- >- @param Sd the global scratch data >- >- @return The position value decoded. >-**/ >-UINT32 >-DecodeP ( >- IN SCRATCH_DATA *Sd >- ) >-{ >- UINT16 Val; >- UINT32 Mask; >- UINT32 Pos; >- >- Val =3D Sd->mPTTable[Sd->mBitBuf >> (BITBUFSIZ - 8)]; >- >- if (Val >=3D MAXNP) { >- Mask =3D 1U << (BITBUFSIZ - 1 - 8); >- >- do { >- >- if ((Sd->mBitBuf & Mask) !=3D 0) { >- Val =3D Sd->mRight[Val]; >- } else { >- Val =3D Sd->mLeft[Val]; >- } >- >- Mask >>=3D 1; >- } while (Val >=3D MAXNP); >- } >- // >- // Advance what we have read >- // >- FillBuf (Sd, Sd->mPTLen[Val]); >- >- Pos =3D Val; >- if (Val > 1) { >- Pos =3D (UINT32) ((1U << (Val - 1)) + GetBits (Sd, (UINT16) (Val - 1)= )); >- } >- >- return Pos; >-} >- >-/** >- Reads code lengths for the Extra Set or the Position Set. >- >- Read in the Extra Set or Position Set Length Array, then >- generate the Huffman code mapping for them. >- >- @param Sd The global scratch data. >- @param nn Number of symbols. >- @param nbit Number of bits needed to represent nn. >- @param Special The special symbol that needs to be taken care of. >- >- @retval 0 OK. >- @retval BAD_TABLE Table is corrupted. >- >-**/ >-UINT16 >-ReadPTLen ( >- IN SCRATCH_DATA *Sd, >- IN UINT16 nn, >- IN UINT16 nbit, >- IN UINT16 Special >- ) >-{ >- UINT16 Number; >- UINT16 CharC; >- UINT16 Index; >- UINT32 Mask; >- >- ASSERT (nn <=3D NPT); >- // >- // Read Extra Set Code Length Array size >- // >- Number =3D (UINT16) GetBits (Sd, nbit); >- >- if (Number =3D=3D 0) { >- // >- // This represents only Huffman code used >- // >- CharC =3D (UINT16) GetBits (Sd, nbit); >- >- for (Index =3D 0; Index < 256; Index++) { >- Sd->mPTTable[Index] =3D CharC; >- } >- >- SetMem (Sd->mPTLen, nn, 0); >- >- return 0; >- } >- >- Index =3D 0; >- >- while (Index < Number && Index < NPT) { >- >- CharC =3D (UINT16) (Sd->mBitBuf >> (BITBUFSIZ - 3)); >- >- // >- // If a code length is less than 7, then it is encoded as a 3-bit >- // value. Or it is encoded as a series of "1"s followed by a >- // terminating "0". The number of "1"s =3D Code length - 4. >- // >- if (CharC =3D=3D 7) { >- Mask =3D 1U << (BITBUFSIZ - 1 - 3); >- while (Mask & Sd->mBitBuf) { >- Mask >>=3D 1; >- CharC +=3D 1; >- } >- } >- >- FillBuf (Sd, (UINT16) ((CharC < 7) ? 3 : CharC - 3)); >- >- Sd->mPTLen[Index++] =3D (UINT8) CharC; >- >- // >- // For Code&Len Set, >- // After the third length of the code length concatenation, >- // a 2-bit value is used to indicated the number of consecutive >- // zero lengths after the third length. >- // >- if (Index =3D=3D Special) { >- CharC =3D (UINT16) GetBits (Sd, 2); >- while ((INT16) (--CharC) >=3D 0 && Index < NPT) { >- Sd->mPTLen[Index++] =3D 0; >- } >- } >- } >- >- while (Index < nn && Index < NPT) { >- Sd->mPTLen[Index++] =3D 0; >- } >- >- return MakeTable (Sd, nn, Sd->mPTLen, 8, Sd->mPTTable); >-} >- >-/** >- Reads code lengths for Char&Len Set. >- >- Read in and decode the Char&Len Set Code Length Array, then >- generate the Huffman Code mapping table for the Char&Len Set. >- >- @param Sd the global scratch data >- >-**/ >-VOID >-ReadCLen ( >- SCRATCH_DATA *Sd >- ) >-{ >- UINT16 Number; >- UINT16 CharC; >- UINT16 Index; >- UINT32 Mask; >- >- Number =3D (UINT16) GetBits (Sd, CBIT); >- >- if (Number =3D=3D 0) { >- // >- // This represents only Huffman code used >- // >- CharC =3D (UINT16) GetBits (Sd, CBIT); >- >- SetMem (Sd->mCLen, NC, 0); >- >- for (Index =3D 0; Index < 4096; Index++) { >- Sd->mCTable[Index] =3D CharC; >- } >- >- return ; >- } >- >- Index =3D 0; >- while (Index < Number && Index < NC) { >- CharC =3D Sd->mPTTable[Sd->mBitBuf >> (BITBUFSIZ - 8)]; >- if (CharC >=3D NT) { >- Mask =3D 1U << (BITBUFSIZ - 1 - 8); >- >- do { >- >- if (Mask & Sd->mBitBuf) { >- CharC =3D Sd->mRight[CharC]; >- } else { >- CharC =3D Sd->mLeft[CharC]; >- } >- >- Mask >>=3D 1; >- >- } while (CharC >=3D NT); >- } >- // >- // Advance what we have read >- // >- FillBuf (Sd, Sd->mPTLen[CharC]); >- >- if (CharC <=3D 2) { >- >- if (CharC =3D=3D 0) { >- CharC =3D 1; >- } else if (CharC =3D=3D 1) { >- CharC =3D (UINT16) (GetBits (Sd, 4) + 3); >- } else if (CharC =3D=3D 2) { >- CharC =3D (UINT16) (GetBits (Sd, CBIT) + 20); >- } >- >- while ((INT16) (--CharC) >=3D 0 && Index < NC) { >- Sd->mCLen[Index++] =3D 0; >- } >- >- } else { >- >- Sd->mCLen[Index++] =3D (UINT8) (CharC - 2); >- >- } >- } >- >- SetMem (Sd->mCLen + Index, NC - Index, 0); >- >- MakeTable (Sd, NC, Sd->mCLen, 12, Sd->mCTable); >- >- return ; >-} >- >-/** >- Decode a character/length value. >- >- Read one value from mBitBuf, Get one code from mBitBuf. If it is at blo= ck >boundary, generates >- Huffman code mapping table for Extra Set, Code&Len Set and >- Position Set. >- >- @param Sd The global scratch data. >- >- @return The value decoded. >- >-**/ >-UINT16 >-DecodeC ( >- SCRATCH_DATA *Sd >- ) >-{ >- UINT16 Index2; >- UINT32 Mask; >- >- if (Sd->mBlockSize =3D=3D 0) { >- // >- // Starting a new block >- // Read BlockSize from block header >- // >- Sd->mBlockSize =3D (UINT16) GetBits (Sd, 16); >- >- // >- // Read in the Extra Set Code Length Array, >- // Generate the Huffman code mapping table for Extra Set. >- // >- Sd->mBadTableFlag =3D ReadPTLen (Sd, NT, TBIT, 3); >- if (Sd->mBadTableFlag !=3D 0) { >- return 0; >- } >- >- // >- // Read in and decode the Char&Len Set Code Length Array, >- // Generate the Huffman code mapping table for Char&Len Set. >- // >- ReadCLen (Sd); >- >- // >- // Read in the Position Set Code Length Array, >- // Generate the Huffman code mapping table for the Position Set. >- // >- Sd->mBadTableFlag =3D ReadPTLen (Sd, MAXNP, Sd->mPBit, (UINT16) (-1))= ; >- if (Sd->mBadTableFlag !=3D 0) { >- return 0; >- } >- } >- >- // >- // Get one code according to Code&Set Huffman Table >- // >- Sd->mBlockSize--; >- Index2 =3D Sd->mCTable[Sd->mBitBuf >> (BITBUFSIZ - 12)]; >- >- if (Index2 >=3D NC) { >- Mask =3D 1U << (BITBUFSIZ - 1 - 12); >- >- do { >- if ((Sd->mBitBuf & Mask) !=3D 0) { >- Index2 =3D Sd->mRight[Index2]; >- } else { >- Index2 =3D Sd->mLeft[Index2]; >- } >- >- Mask >>=3D 1; >- } while (Index2 >=3D NC); >- } >- // >- // Advance what we have read >- // >- FillBuf (Sd, Sd->mCLen[Index2]); >- >- return Index2; >-} >- >-/** >- Decode the source data and put the resulting data into the destination >buffer. >- >- @param Sd The global scratch data >-**/ >-VOID >-Decode ( >- SCRATCH_DATA *Sd >- ) >-{ >- UINT16 BytesRemain; >- UINT32 DataIdx; >- UINT16 CharC; >- >- BytesRemain =3D (UINT16) (-1); >- >- DataIdx =3D 0; >- >- for (;;) { >- // >- // Get one code from mBitBuf >- // >- CharC =3D DecodeC (Sd); >- if (Sd->mBadTableFlag !=3D 0) { >- goto Done; >- } >- >- if (CharC < 256) { >- // >- // Process an Original character >- // >- if (Sd->mOutBuf >=3D Sd->mOrigSize) { >- goto Done; >- } else { >- // >- // Write orignal character into mDstBase >- // >- Sd->mDstBase[Sd->mOutBuf++] =3D (UINT8) CharC; >- } >- >- } else { >- // >- // Process a Pointer >- // >- CharC =3D (UINT16) (CharC - (BIT8 - THRESHOLD)); >- >- // >- // Get string length >- // >- BytesRemain =3D CharC; >- >- // >- // Locate string position >- // >- DataIdx =3D Sd->mOutBuf - DecodeP (Sd) - 1; >- >- // >- // Write BytesRemain of bytes into mDstBase >- // >- BytesRemain--; >- while ((INT16) (BytesRemain) >=3D 0) { >- if (Sd->mOutBuf >=3D Sd->mOrigSize) { >- goto Done ; >- } >- if (DataIdx >=3D Sd->mOrigSize) { >- Sd->mBadTableFlag =3D (UINT16) BAD_TABLE; >- goto Done ; >- } >- Sd->mDstBase[Sd->mOutBuf++] =3D Sd->mDstBase[DataIdx++]; >- >- BytesRemain--; >- } >- // >- // Once mOutBuf is fully filled, directly return >- // >- if (Sd->mOutBuf >=3D Sd->mOrigSize) { >- goto Done ; >- } >- } >- } >- >-Done: >- return ; >-} >- >-/** >- Given a compressed source buffer, this function retrieves the size of >- the uncompressed buffer and the size of the scratch buffer required >- to decompress the compressed source buffer. >- >- Retrieves the size of the uncompressed buffer and the temporary scratch >buffer >- required to decompress the buffer specified by Source and SourceSize. >- If the size of the uncompressed buffer or the size of the scratch buffe= r >cannot >- be determined from the compressed data specified by Source and >SourceData, >- then RETURN_INVALID_PARAMETER is returned. Otherwise, the size of the >uncompressed >- buffer is returned in DestinationSize, the size of the scratch buffer i= s >returned >- in ScratchSize, and RETURN_SUCCESS is returned. >- This function does not have scratch buffer available to perform a thoro= ugh >- checking of the validity of the source data. It just retrieves the "Or= iginal >Size" >- field from the beginning bytes of the source data and output it as >DestinationSize. >- And ScratchSize is specific to the decompression implementation. >- >- If Source is NULL, then ASSERT(). >- If DestinationSize is NULL, then ASSERT(). >- If ScratchSize is NULL, then ASSERT(). >- >- @param Source The source buffer containing the compressed dat= a. >- @param SourceSize The size, in bytes, of the source buffer. >- @param DestinationSize A pointer to the size, in bytes, of the >uncompressed buffer >- that will be generated when the compressed buff= er specified >- by Source and SourceSize is decompressed.. >- @param ScratchSize A pointer to the size, in bytes, of the scratch= buffer >that >- is required to decompress the compressed buffer= specified >- by Source and SourceSize. >- >- @retval RETURN_SUCCESS The size of the uncompressed data was >returned >- in DestinationSize and the size of the scratch >- buffer was returned in ScratchSize. >- @retval RETURN_INVALID_PARAMETER >- The size of the uncompressed data or the size o= f >- the scratch buffer cannot be determined from >- the compressed data specified by Source >- and SourceSize. >-**/ >-RETURN_STATUS >-EFIAPI >-UefiDecompressGetInfo ( >- IN CONST VOID *Source, >- IN UINT32 SourceSize, >- OUT UINT32 *DestinationSize, >- OUT UINT32 *ScratchSize >- ) >-{ >- UINT32 CompressedSize; >- >- ASSERT (Source !=3D NULL); >- ASSERT (DestinationSize !=3D NULL); >- ASSERT (ScratchSize !=3D NULL); >- >- if (SourceSize < 8) { >- return RETURN_INVALID_PARAMETER; >- } >- >- CompressedSize =3D ReadUnaligned32 ((UINT32 *)Source); >- if (SourceSize < (CompressedSize + 8) || (CompressedSize + 8) < 8) { >- return RETURN_INVALID_PARAMETER; >- } >- >- *ScratchSize =3D sizeof (SCRATCH_DATA); >- *DestinationSize =3D ReadUnaligned32 ((UINT32 *)Source + 1); >- >- return RETURN_SUCCESS; >-} >- >-/** >- Decompresses a compressed source buffer by EFI or Tiano algorithm. >- >- Extracts decompressed data to its original form. >- This function is designed so that the decompression algorithm can be >implemented >- without using any memory services. As a result, this function is not a= llowed >to >- call any memory allocation services in its implementation. It is the c= aller's >- responsibility to allocate and free the Destination and Scratch buffers= . >- If the compressed source data specified by Source is successfully >decompressed >- into Destination, then RETURN_SUCCESS is returned. If the compressed >source data >- specified by Source is not in a valid compressed data format, >- then RETURN_INVALID_PARAMETER is returned. >- >- If Source is NULL, then ASSERT(). >- If Destination is NULL, then ASSERT(). >- If the required scratch buffer size > 0 and Scratch is NULL, then ASSER= T(). >- >- @param Source The source buffer containing the compressed data. >- @param Destination The destination buffer to store the decompressed >data >- @param Scratch A temporary scratch buffer that is used to perform = the >decompression. >- This is an optional parameter that may be NULL if t= he >- required scratch buffer size is 0. >- @param Version 1 for UEFI Decompress algoruthm, 2 for Tiano >Decompess algorithm. >- >- @retval RETURN_SUCCESS Decompression completed successfully, and >- the uncompressed buffer is returned in Destinat= ion. >- @retval RETURN_INVALID_PARAMETER >- The source buffer specified by Source is corrup= ted >- (not in a valid compressed format). >-**/ >-RETURN_STATUS >-EFIAPI >-UefiTianoDecompress ( >- IN CONST VOID *Source, >- IN OUT VOID *Destination, >- IN OUT VOID *Scratch, >- IN UINT32 Version >- ) >-{ >- UINT32 CompSize; >- UINT32 OrigSize; >- SCRATCH_DATA *Sd; >- CONST UINT8 *Src; >- UINT8 *Dst; >- >- ASSERT (Source !=3D NULL); >- ASSERT (Destination !=3D NULL); >- ASSERT (Scratch !=3D NULL); >- >- Src =3D Source; >- Dst =3D Destination; >- >- Sd =3D (SCRATCH_DATA *) Scratch; >- >- CompSize =3D Src[0] + (Src[1] << 8) + (Src[2] << 16) + (Src[3] << 24); >- OrigSize =3D Src[4] + (Src[5] << 8) + (Src[6] << 16) + (Src[7] << 24); >- >- // >- // If compressed file size is 0, return >- // >- if (OrigSize =3D=3D 0) { >- return RETURN_SUCCESS; >- } >- >- Src =3D Src + 8; >- >- SetMem (Sd, sizeof (SCRATCH_DATA), 0); >- >- // >- // The length of the field 'Position Set Code Length Array Size' in Blo= ck >Header. >- // For UEFI 2.0 de/compression algorithm(Version 1), mPBit =3D 4 >- // For Tiano de/compression algorithm(Version 2), mPBit =3D 5 >- // >- switch (Version) { >- case 1 : >- Sd->mPBit =3D 4; >- break; >- case 2 : >- Sd->mPBit =3D 5; >- break; >- default: >- ASSERT (FALSE); >- } >- Sd->mSrcBase =3D (UINT8 *)Src; >- Sd->mDstBase =3D Dst; >- // >- // CompSize and OrigSize are calculated in bytes >- // >- Sd->mCompSize =3D CompSize; >- Sd->mOrigSize =3D OrigSize; >- >- // >- // Fill the first BITBUFSIZ bits >- // >- FillBuf (Sd, BITBUFSIZ); >- >- // >- // Decompress it >- // >- Decode (Sd); >- >- if (Sd->mBadTableFlag !=3D 0) { >- // >- // Something wrong with the source >- // >- return RETURN_INVALID_PARAMETER; >- } >- >- return RETURN_SUCCESS; >-} >- >-/** >- Decompresses a UEFI compressed source buffer. >- >- Extracts decompressed data to its original form. >- This function is designed so that the decompression algorithm can be >implemented >- without using any memory services. As a result, this function is not a= llowed >to >- call any memory allocation services in its implementation. It is the c= aller's >- responsibility to allocate and free the Destination and Scratch buffers= . >- If the compressed source data specified by Source is successfully >decompressed >- into Destination, then RETURN_SUCCESS is returned. If the compressed >source data >- specified by Source is not in a valid compressed data format, >- then RETURN_INVALID_PARAMETER is returned. >- >- If Source is NULL, then ASSERT(). >- If Destination is NULL, then ASSERT(). >- If the required scratch buffer size > 0 and Scratch is NULL, then ASSER= T(). >- >- @param Source The source buffer containing the compressed data. >- @param Destination The destination buffer to store the decompressed >data >- @param Scratch A temporary scratch buffer that is used to perform = the >decompression. >- This is an optional parameter that may be NULL if t= he >- required scratch buffer size is 0. >- >- @retval RETURN_SUCCESS Decompression completed successfully, and >- the uncompressed buffer is returned in Destinat= ion. >- @retval RETURN_INVALID_PARAMETER >- The source buffer specified by Source is corrup= ted >- (not in a valid compressed format). >-**/ >-RETURN_STATUS >-EFIAPI >-UefiDecompress ( >- IN CONST VOID *Source, >- IN OUT VOID *Destination, >- IN OUT VOID *Scratch OPTIONAL >- ) >-{ >- return UefiTianoDecompress (Source, Destination, Scratch, 1); >-} >- >-/** >- Examines a GUIDed section and returns the size of the decoded buffer an= d >the >- size of an optional scratch buffer required to actually decode the data= in a >GUIDed section. >- >- Examines a GUIDed section specified by InputSection. >- If GUID for InputSection does not match the GUID that this handler supp= orts, >- then RETURN_UNSUPPORTED is returned. >- If the required information can not be retrieved from InputSection, >- then RETURN_INVALID_PARAMETER is returned. >- If the GUID of InputSection does match the GUID that this handler suppo= rts, >- then the size required to hold the decoded buffer is returned in >OututBufferSize, >- the size of an optional scratch buffer is returned in ScratchSize, and = the >Attributes field >- from EFI_GUID_DEFINED_SECTION header of InputSection is returned in >SectionAttribute. >- >- If InputSection is NULL, then ASSERT(). >- If OutputBufferSize is NULL, then ASSERT(). >- If ScratchBufferSize is NULL, then ASSERT(). >- If SectionAttribute is NULL, then ASSERT(). >- >- >- @param[in] InputSection A pointer to a GUIDed section of an FFS >formatted file. >- @param[out] OutputBufferSize A pointer to the size, in bytes, of an o= utput >buffer required >- if the buffer specified by InputSection = were decoded. >- @param[out] ScratchBufferSize A pointer to the size, in bytes, require= d as >scratch space >- if the buffer specified by InputSection = were decoded. >- @param[out] SectionAttribute A pointer to the attributes of the GUIDe= d >section. See the Attributes >- field of EFI_GUID_DEFINED_SECTION in the= PI Specification. >- >- @retval RETURN_SUCCESS The information about InputSection w= as >returned. >- @retval RETURN_UNSUPPORTED The section specified by InputSectio= n >does not match the GUID this handler supports. >- @retval RETURN_INVALID_PARAMETER The information can not be >retrieved from the section specified by InputSection. >- >-**/ >-RETURN_STATUS >-EFIAPI >-TianoDecompressGetInfo ( >- IN CONST VOID *InputSection, >- OUT UINT32 *OutputBufferSize, >- OUT UINT32 *ScratchBufferSize, >- OUT UINT16 *SectionAttribute >- ) >- >-{ >- ASSERT (SectionAttribute !=3D NULL); >- >- if (InputSection =3D=3D NULL) { >- return RETURN_INVALID_PARAMETER; >- } >- >- if (IS_SECTION2 (InputSection)) { >- if (!CompareGuid ( >- &gTianoCustomDecompressGuid, >- &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)- >>SectionDefinitionGuid))) { >- return RETURN_INVALID_PARAMETER; >- } >- // >- // Get guid attribute of guid section. >- // >- *SectionAttribute =3D ((EFI_GUID_DEFINED_SECTION2 *) InputSection)- >>Attributes; >- >- // >- // Call Tiano GetInfo to get the required size info. >- // >- return UefiDecompressGetInfo ( >- (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION2 *) >InputSection)->DataOffset, >- SECTION2_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION2 *= ) >InputSection)->DataOffset, >- OutputBufferSize, >- ScratchBufferSize >- ); >- } else { >- if (!CompareGuid ( >- &gTianoCustomDecompressGuid, >- &(((EFI_GUID_DEFINED_SECTION *) InputSection)- >>SectionDefinitionGuid))) { >- return RETURN_INVALID_PARAMETER; >- } >- // >- // Get guid attribute of guid section. >- // >- *SectionAttribute =3D ((EFI_GUID_DEFINED_SECTION *) InputSection)- >>Attributes; >- >- // >- // Call Tiano GetInfo to get the required size info. >- // >- return UefiDecompressGetInfo ( >- (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION *) >InputSection)->DataOffset, >- SECTION_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION *) >InputSection)->DataOffset, >- OutputBufferSize, >- ScratchBufferSize >- ); >- } >-} >- >-/** >- Decompress a Tiano compressed GUIDed section into a caller allocated >output buffer. >- >- Decodes the GUIDed section specified by InputSection. >- If GUID for InputSection does not match the GUID that this handler supp= orts, >then RETURN_UNSUPPORTED is returned. >- If the data in InputSection can not be decoded, then >RETURN_INVALID_PARAMETER is returned. >- If the GUID of InputSection does match the GUID that this handler suppo= rts, >then InputSection >- is decoded into the buffer specified by OutputBuffer and the authentica= tion >status of this >- decode operation is returned in AuthenticationStatus. If the decoded >buffer is identical to the >- data in InputSection, then OutputBuffer is set to point at the data in >InputSection. Otherwise, >- the decoded data will be placed in caller allocated buffer specified by >OutputBuffer. >- >- If InputSection is NULL, then ASSERT(). >- If OutputBuffer is NULL, then ASSERT(). >- If ScratchBuffer is NULL and this decode operation requires a scratch b= uffer, >then ASSERT(). >- If AuthenticationStatus is NULL, then ASSERT(). >- >- >- @param[in] InputSection A pointer to a GUIDed section of an FFS >formatted file. >- @param[out] OutputBuffer A pointer to a buffer that contains the resul= t of >a decode operation. >- @param[in] ScratchBuffer A caller allocated buffer that may be require= d by >this function >- as a scratch buffer to perform the decode ope= ration. >- @param[out] AuthenticationStatus >- A pointer to the authentication status of the= decoded output >buffer. >- See the definition of authentication status i= n the >EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI >- section of the PI Specification. >EFI_AUTH_STATUS_PLATFORM_OVERRIDE must >- never be set by this handler. >- >- @retval RETURN_SUCCESS The buffer specified by InputSection= was >decoded. >- @retval RETURN_UNSUPPORTED The section specified by InputSectio= n >does not match the GUID this handler supports. >- @retval RETURN_INVALID_PARAMETER The section specified by >InputSection can not be decoded. >- >-**/ >-RETURN_STATUS >-EFIAPI >-TianoDecompress ( >- IN CONST VOID *InputSection, >- OUT VOID **OutputBuffer, >- IN VOID *ScratchBuffer, OPTIONAL >- OUT UINT32 *AuthenticationStatus >- ) >-{ >- ASSERT (OutputBuffer !=3D NULL); >- ASSERT (InputSection !=3D NULL); >- >- if (IS_SECTION2 (InputSection)) { >- if (!CompareGuid ( >- &gTianoCustomDecompressGuid, >- &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)- >>SectionDefinitionGuid))) { >- return RETURN_INVALID_PARAMETER; >- } >- >- // >- // Set Authentication to Zero. >- // >- *AuthenticationStatus =3D 0; >- >- // >- // Call Tiano Decompress to get the raw data >- // >- return UefiTianoDecompress ( >- (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION2 *) >InputSection)->DataOffset, >- *OutputBuffer, >- ScratchBuffer, >- 2 >- ); >- } else { >- if (!CompareGuid ( >- &gTianoCustomDecompressGuid, >- &(((EFI_GUID_DEFINED_SECTION *) InputSection)- >>SectionDefinitionGuid))) { >- return RETURN_INVALID_PARAMETER; >- } >- >- // >- // Set Authentication to Zero. >- // >- *AuthenticationStatus =3D 0; >- >- // >- // Call Tiano Decompress to get the raw data >- // >- return UefiTianoDecompress ( >- (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION *) >InputSection)->DataOffset, >- *OutputBuffer, >- ScratchBuffer, >- 2 >- ); >- } >-} >- >-/** >- Registers TianoDecompress and TianoDecompressGetInfo handlers with >TianoCustomerDecompressGuid >- >- @retval RETURN_SUCCESS Register successfully. >- @retval RETURN_OUT_OF_RESOURCES No enough memory to store this >handler. >-**/ >-RETURN_STATUS >-EFIAPI >-TianoDecompressLibConstructor ( >- VOID >-) >-{ >- return ExtractGuidedSectionRegisterHandlers ( >- &gTianoCustomDecompressGuid, >- TianoDecompressGetInfo, >- TianoDecompress >- ); >-} >diff --git >a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noCustomDecompressLibInternals.h >b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noCustomDecompressLibInternals.h >deleted file mode 100644 >index 846abdb78e..0000000000 >--- >a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noCustomDecompressLibInternals.h >+++ /dev/null >@@ -1,214 +0,0 @@ >-/** @file >- Internal data structure and interfaces defintions for UEFI and Tiano >Decompress Library. >- >- Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
>- SPDX-License-Identifier: BSD-2-Clause-Patent >- >-**/ >- >-#ifndef __BASE_UEFI_TIANO_CUSTOM_DECOMPRESS_LIB_INTERNALS_H__ >-#define >__BASE_UEFI_TIANO_CUSTOM_DECOMPRESS_LIB_INTERNALS_H__ >- >-#include >- >-#include >-#include >-#include >-#include >-#include >-#include >- >-// >-// Decompression algorithm begins here >-// >-#define BITBUFSIZ 32 >-#define MAXMATCH 256 >-#define THRESHOLD 3 >-#define CODE_BIT 16 >-#define BAD_TABLE - 1 >- >-// >-// C: Char&Len Set; P: Position Set; T: exTra Set >-// >-#define NC (0xff + MAXMATCH + 2 - THRESHOLD) >-#define CBIT 9 >-#define MAXPBIT 5 >-#define TBIT 5 >-#define MAXNP ((1U << MAXPBIT) - 1) >-#define NT (CODE_BIT + 3) >-#if NT > MAXNP >-#define NPT NT >-#else >-#define NPT MAXNP >-#endif >- >-typedef struct { >- UINT8 *mSrcBase; // Starting address of compressed data >- UINT8 *mDstBase; // Starting address of decompressed data >- UINT32 mOutBuf; >- UINT32 mInBuf; >- >- UINT16 mBitCount; >- UINT32 mBitBuf; >- UINT32 mSubBitBuf; >- UINT16 mBlockSize; >- UINT32 mCompSize; >- UINT32 mOrigSize; >- >- UINT16 mBadTableFlag; >- >- UINT16 mLeft[2 * NC - 1]; >- UINT16 mRight[2 * NC - 1]; >- UINT8 mCLen[NC]; >- UINT8 mPTLen[NPT]; >- UINT16 mCTable[4096]; >- UINT16 mPTTable[256]; >- >- /// >- /// The length of the field 'Position Set Code Length Array Size' in Bl= ock >Header. >- /// For UEFI 2.0 de/compression algorithm, mPBit =3D 4 >- /// For Tiano de/compression algorithm, mPBit =3D 5 >- /// >- UINT8 mPBit; >-} SCRATCH_DATA; >- >-/** >- Read NumOfBit of bits from source into mBitBuf. >- >- Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source. >- >- @param Sd The global scratch data >- @param NumOfBits The number of bits to shift and read. >- >-**/ >-VOID >-FillBuf ( >- IN SCRATCH_DATA *Sd, >- IN UINT16 NumOfBits >- ); >- >-/** >- Get NumOfBits of bits out from mBitBuf. >- >- Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent >- NumOfBits of bits from source. Returns NumOfBits of bits that are >- popped out. >- >- @param Sd The global scratch data. >- @param NumOfBits The number of bits to pop and read. >- >- @return The bits that are popped out. >- >-**/ >-UINT32 >-GetBits ( >- IN SCRATCH_DATA *Sd, >- IN UINT16 NumOfBits >- ); >- >-/** >- Creates Huffman Code mapping table according to code length array. >- >- Creates Huffman Code mapping table for Extra Set, Char&Len Set >- and Position Set according to code length array. >- >- @param Sd The global scratch data >- @param NumOfChar Number of symbols in the symbol set >- @param BitLen Code length array >- @param TableBits The width of the mapping table >- @param Table The table to be created. >- >- @retval 0 OK. >- @retval BAD_TABLE The table is corrupted. >- >-**/ >-UINT16 >-MakeTable ( >- IN SCRATCH_DATA *Sd, >- IN UINT16 NumOfChar, >- IN UINT8 *BitLen, >- IN UINT16 TableBits, >- OUT UINT16 *Table >- ); >- >-/** >- Decodes a position value. >- >- Get a position value according to Position Huffman Table. >- >- @param Sd the global scratch data >- >- @return The position value decoded. >- >-**/ >-UINT32 >-DecodeP ( >- IN SCRATCH_DATA *Sd >- ); >- >-/** >- Reads code lengths for the Extra Set or the Position Set. >- >- Read in the Extra Set or Position Set Length Array, then >- generate the Huffman code mapping for them. >- >- @param Sd The global scratch data. >- @param nn Number of symbols. >- @param nbit Number of bits needed to represent nn. >- @param Special The special symbol that needs to be taken care of. >- >- @retval 0 OK. >- @retval BAD_TABLE Table is corrupted. >- >-**/ >-UINT16 >-ReadPTLen ( >- IN SCRATCH_DATA *Sd, >- IN UINT16 nn, >- IN UINT16 nbit, >- IN UINT16 Special >- ); >- >-/** >- Reads code lengths for Char&Len Set. >- >- Read in and decode the Char&Len Set Code Length Array, then >- generate the Huffman Code mapping table for the Char&Len Set. >- >- @param Sd the global scratch data >- >-**/ >-VOID >-ReadCLen ( >- SCRATCH_DATA *Sd >- ); >- >-/** >- Decode a character/length value. >- >- Read one value from mBitBuf, Get one code from mBitBuf. If it is at blo= ck >boundary, generates >- Huffman code mapping table for Extra Set, Code&Len Set and >- Position Set. >- >- @param Sd The global scratch data. >- >- @return The value decoded. >- >-**/ >-UINT16 >-DecodeC ( >- SCRATCH_DATA *Sd >- ); >- >-/** >- Decode the source data and put the resulting data into the destination >buffer. >- >- @param Sd The global scratch data >- >-**/ >-VOID >-Decode ( >- SCRATCH_DATA *Sd >- ); >- >-#endif >diff --git >a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noDecompressLib.uni >b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noDecompressLib.uni >deleted file mode 100644 >index c384dacbef..0000000000 >--- >a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noDecompressLib.uni >+++ /dev/null >@@ -1,16 +0,0 @@ >-// /** @file >-// This library instance produces UefiDecompressLib and Tiano Custom >decompression algorithm. >-// >-// Tiano custom decompression algorithm shares most of code with Uefi >Decompress algorithm. >-// >-// Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.
>-// >-// SPDX-License-Identifier: BSD-2-Clause-Patent >-// >-// **/ >- >- >-#string STR_MODULE_ABSTRACT #language en-US "Produces >UefiDecompressLib and Tiano Custom decompression algorithm" >- >-#string STR_MODULE_DESCRIPTION #language en-US "Tiano custom >decompression algorithm shares most of the code with the UEFI Decompress >algorithm." >- >diff --git a/MdeModulePkg/MdeModulePkg.dec >b/MdeModulePkg/MdeModulePkg.dec >index be84916cc0..1261f80537 100644 >--- a/MdeModulePkg/MdeModulePkg.dec >+++ b/MdeModulePkg/MdeModulePkg.dec >@@ -371,14 +371,10 @@ > ## GUID indicates the LZMA custom compress/decompress algorithm. > # Include/Guid/LzmaDecompress.h > gLzmaCustomDecompressGuid =3D { 0xEE4E5898, 0x3914, 0x4259, { 0x9D= , >0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF }} > gLzmaF86CustomDecompressGuid =3D { 0xD42AE6BD, 0x1352, 0x4bfb, { 0x= 90, >0x9A, 0xCA, 0x72, 0xA6, 0xEA, 0xE8, 0x89 }} > >- ## GUID indicates the tiano custom compress/decompress algorithm. >- # Include/Guid/TianoDecompress.h >- gTianoCustomDecompressGuid =3D { 0xA31280AD, 0x481E, 0x41B6, { 0x95= , >0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }} >- > ## Include/Guid/TtyTerm.h > gEfiTtyTermGuid =3D { 0x7d916d80, 0x5bb1, 0x458c, {0xa4,= 0x8f, 0xe2, >0x5f, 0xdd, 0x51, 0xef, 0x94 }} > > ## Include/Guid/HiiBootMaintenanceFormset.h > gEfiIfrBootMaintenanceGuid =3D { 0xb2dedc91, 0xd59f, 0x48d2, { 0x8= 9, 0x8a, >0x12, 0x49, 0xc, 0x74, 0xa4, 0xe0 }} >diff --git a/MdeModulePkg/MdeModulePkg.dsc >b/MdeModulePkg/MdeModulePkg.dsc >index b302f4a4f3..0da28e74c2 100644 >--- a/MdeModulePkg/MdeModulePkg.dsc >+++ b/MdeModulePkg/MdeModulePkg.dsc >@@ -311,11 +311,10 @@ > MdeModulePkg/Library/FrameBufferBltLib/FrameBufferBltLib.inf > >MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscover >ableDeviceRegistrationLib.inf > MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf > >MdeModulePkg/Library/DisplayUpdateProgressLibGraphics/DisplayUpdatePr >ogressLibGraphics.inf > >MdeModulePkg/Library/DisplayUpdateProgressLibText/DisplayUpdateProgre >ssLibText.inf >- >MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano >CustomDecompressLib.inf > > MdeModulePkg/Universal/BdsDxe/BdsDxe.inf > >MdeModulePkg/Application/BootManagerMenuApp/BootManagerMenuAp >p.inf > MdeModulePkg/Application/UiApp/UiApp.inf{ > >diff --git >a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noCustomDecompressLib.inf >b/MdePkg/Library/BaseUefiDecompressLib/BaseTianoCustomDecompressLib >.inf >similarity index 88% >rename from >MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano >CustomDecompressLib.inf >rename to >MdePkg/Library/BaseUefiDecompressLib/BaseTianoCustomDecompressLib.in >f >index c9c19d6d3c..5d2b54e2db 100644 >--- >a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTia >noCustomDecompressLib.inf >+++ >b/MdePkg/Library/BaseUefiDecompressLib/BaseTianoCustomDecompressLib >.inf >@@ -23,16 +23,15 @@ > # > # VALID_ARCHITECTURES =3D IA32 X64 EBC > # > > [Sources] >- BaseUefiTianoCustomDecompressLibInternals.h >- BaseUefiTianoCustomDecompressLib.c >+ BaseUefiDecompressLibInternals.h >+ BaseUefiDecompressLib.c > > [Packages] > MdePkg/MdePkg.dec >- MdeModulePkg/MdeModulePkg.dec > > [LibraryClasses] > BaseLib > DebugLib > BaseMemoryLib >diff --git >a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c >b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c >index 8e502b0fdb..c390363d14 100644 >--- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c >+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c >@@ -5,16 +5,17 @@ > Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
> SPDX-License-Identifier: BSD-2-Clause-Patent > > **/ > >- >+#include > #include > #include > #include > #include > #include >+#include > > #include "BaseUefiDecompressLibInternals.h" > > /** > Read NumOfBit of bits from source into mBitBuf. >@@ -747,14 +748,15 @@ UefiDecompressGetInfo ( > The source buffer specified by Source is corrup= ted > (not in a valid compressed format). > **/ > RETURN_STATUS > EFIAPI >-UefiDecompress ( >+UefiTianoDecompress ( > IN CONST VOID *Source, > IN OUT VOID *Destination, >- IN OUT VOID *Scratch OPTIONAL >+ IN OUT VOID *Scratch, >+ IN UINT32 Version > ) > { > UINT32 CompSize; > UINT32 OrigSize; > SCRATCH_DATA *Sd; >@@ -784,12 +786,22 @@ UefiDecompress ( > SetMem (Sd, sizeof (SCRATCH_DATA), 0); > > // > // The length of the field 'Position Set Code Length Array Size' in Blo= ck >Header. > // For UEFI 2.0 de/compression algorithm(Version 1), mPBit =3D 4 >+ // For Tiano de/compression algorithm(Version 2), mPBit =3D 5 > // >- Sd->mPBit =3D 4; >+ switch (Version) { >+ case 1 : >+ Sd->mPBit =3D 4; >+ break; >+ case 2 : >+ Sd->mPBit =3D 5; >+ break; >+ default: >+ ASSERT (FALSE); >+ } > Sd->mSrcBase =3D (UINT8 *)Src; > Sd->mDstBase =3D Dst; > // > // CompSize and OrigSize are calculated in bytes > // >@@ -813,5 +825,246 @@ UefiDecompress ( > return RETURN_INVALID_PARAMETER; > } > > return RETURN_SUCCESS; > } >+ >+/** >+ Decompresses a UEFI compressed source buffer. >+ >+ Extracts decompressed data to its original form. >+ This function is designed so that the decompression algorithm can be >implemented >+ without using any memory services. As a result, this function is not a= llowed >to >+ call any memory allocation services in its implementation. It is the c= aller's >+ responsibility to allocate and free the Destination and Scratch buffers= . >+ If the compressed source data specified by Source is successfully >decompressed >+ into Destination, then RETURN_SUCCESS is returned. If the compressed >source data >+ specified by Source is not in a valid compressed data format, >+ then RETURN_INVALID_PARAMETER is returned. >+ >+ If Source is NULL, then ASSERT(). >+ If Destination is NULL, then ASSERT(). >+ If the required scratch buffer size > 0 and Scratch is NULL, then ASSER= T(). >+ >+ @param Source The source buffer containing the compressed data. >+ @param Destination The destination buffer to store the decompressed >data >+ @param Scratch A temporary scratch buffer that is used to perform = the >decompression. >+ This is an optional parameter that may be NULL if t= he >+ required scratch buffer size is 0. >+ >+ @retval RETURN_SUCCESS Decompression completed successfully, and >+ the uncompressed buffer is returned in Destinat= ion. >+ @retval RETURN_INVALID_PARAMETER >+ The source buffer specified by Source is corrup= ted >+ (not in a valid compressed format). >+**/ >+RETURN_STATUS >+EFIAPI >+UefiDecompress ( >+ IN CONST VOID *Source, >+ IN OUT VOID *Destination, >+ IN OUT VOID *Scratch OPTIONAL >+ ) >+{ >+ return UefiTianoDecompress (Source, Destination, Scratch, 1); >+} >+ >+/** >+ Examines a GUIDed section and returns the size of the decoded buffer an= d >the >+ size of an optional scratch buffer required to actually decode the data= in a >GUIDed section. >+ >+ Examines a GUIDed section specified by InputSection. >+ If GUID for InputSection does not match the GUID that this handler >supports, >+ then RETURN_UNSUPPORTED is returned. >+ If the required information can not be retrieved from InputSection, >+ then RETURN_INVALID_PARAMETER is returned. >+ If the GUID of InputSection does match the GUID that this handler suppo= rts, >+ then the size required to hold the decoded buffer is returned in >OututBufferSize, >+ the size of an optional scratch buffer is returned in ScratchSize, and = the >Attributes field >+ from EFI_GUID_DEFINED_SECTION header of InputSection is returned in >SectionAttribute. >+ >+ If InputSection is NULL, then ASSERT(). >+ If OutputBufferSize is NULL, then ASSERT(). >+ If ScratchBufferSize is NULL, then ASSERT(). >+ If SectionAttribute is NULL, then ASSERT(). >+ >+ >+ @param[in] InputSection A pointer to a GUIDed section of an FFS >formatted file. >+ @param[out] OutputBufferSize A pointer to the size, in bytes, of an >output buffer required >+ if the buffer specified by InputSection = were decoded. >+ @param[out] ScratchBufferSize A pointer to the size, in bytes, require= d as >scratch space >+ if the buffer specified by InputSection = were decoded. >+ @param[out] SectionAttribute A pointer to the attributes of the GUIDe= d >section. See the Attributes >+ field of EFI_GUID_DEFINED_SECTION in the= PI Specification. >+ >+ @retval RETURN_SUCCESS The information about InputSection w= as >returned. >+ @retval RETURN_UNSUPPORTED The section specified by InputSectio= n >does not match the GUID this handler supports. >+ @retval RETURN_INVALID_PARAMETER The information can not be >retrieved from the section specified by InputSection. >+ >+**/ >+RETURN_STATUS >+EFIAPI >+TianoDecompressGetInfo ( >+ IN CONST VOID *InputSection, >+ OUT UINT32 *OutputBufferSize, >+ OUT UINT32 *ScratchBufferSize, >+ OUT UINT16 *SectionAttribute >+ ) >+ >+{ >+ ASSERT (SectionAttribute !=3D NULL); >+ >+ if (InputSection =3D=3D NULL) { >+ return RETURN_INVALID_PARAMETER; >+ } >+ >+ if (IS_SECTION2 (InputSection)) { >+ if (!CompareGuid ( >+ &gTianoCustomDecompressGuid, >+ &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)- >>SectionDefinitionGuid))) { >+ return RETURN_INVALID_PARAMETER; >+ } >+ // >+ // Get guid attribute of guid section. >+ // >+ *SectionAttribute =3D ((EFI_GUID_DEFINED_SECTION2 *) InputSection)- >>Attributes; >+ >+ // >+ // Call Tiano GetInfo to get the required size info. >+ // >+ return UefiDecompressGetInfo ( >+ (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION2 *) >InputSection)->DataOffset, >+ SECTION2_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION2 *= ) >InputSection)->DataOffset, >+ OutputBufferSize, >+ ScratchBufferSize >+ ); >+ } else { >+ if (!CompareGuid ( >+ &gTianoCustomDecompressGuid, >+ &(((EFI_GUID_DEFINED_SECTION *) InputSection)- >>SectionDefinitionGuid))) { >+ return RETURN_INVALID_PARAMETER; >+ } >+ // >+ // Get guid attribute of guid section. >+ // >+ *SectionAttribute =3D ((EFI_GUID_DEFINED_SECTION *) InputSection)- >>Attributes; >+ >+ // >+ // Call Tiano GetInfo to get the required size info. >+ // >+ return UefiDecompressGetInfo ( >+ (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION *) >InputSection)->DataOffset, >+ SECTION_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION *) >InputSection)->DataOffset, >+ OutputBufferSize, >+ ScratchBufferSize >+ ); >+ } >+} >+ >+/** >+ Decompress a Tiano compressed GUIDed section into a caller allocated >output buffer. >+ >+ Decodes the GUIDed section specified by InputSection. >+ If GUID for InputSection does not match the GUID that this handler >supports, then RETURN_UNSUPPORTED is returned. >+ If the data in InputSection can not be decoded, then >RETURN_INVALID_PARAMETER is returned. >+ If the GUID of InputSection does match the GUID that this handler suppo= rts, >then InputSection >+ is decoded into the buffer specified by OutputBuffer and the >authentication status of this >+ decode operation is returned in AuthenticationStatus. If the decoded >buffer is identical to the >+ data in InputSection, then OutputBuffer is set to point at the data in >InputSection. Otherwise, >+ the decoded data will be placed in caller allocated buffer specified by >OutputBuffer. >+ >+ If InputSection is NULL, then ASSERT(). >+ If OutputBuffer is NULL, then ASSERT(). >+ If ScratchBuffer is NULL and this decode operation requires a scratch b= uffer, >then ASSERT(). >+ If AuthenticationStatus is NULL, then ASSERT(). >+ >+ >+ @param[in] InputSection A pointer to a GUIDed section of an FFS >formatted file. >+ @param[out] OutputBuffer A pointer to a buffer that contains the resul= t of >a decode operation. >+ @param[in] ScratchBuffer A caller allocated buffer that may be require= d by >this function >+ as a scratch buffer to perform the decode ope= ration. >+ @param[out] AuthenticationStatus >+ A pointer to the authentication status of the= decoded output >buffer. >+ See the definition of authentication status i= n the >EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI >+ section of the PI Specification. >EFI_AUTH_STATUS_PLATFORM_OVERRIDE must >+ never be set by this handler. >+ >+ @retval RETURN_SUCCESS The buffer specified by InputSection= was >decoded. >+ @retval RETURN_UNSUPPORTED The section specified by InputSectio= n >does not match the GUID this handler supports. >+ @retval RETURN_INVALID_PARAMETER The section specified by >InputSection can not be decoded. >+ >+**/ >+RETURN_STATUS >+EFIAPI >+TianoDecompress ( >+ IN CONST VOID *InputSection, >+ OUT VOID **OutputBuffer, >+ IN VOID *ScratchBuffer, OPTIONAL >+ OUT UINT32 *AuthenticationStatus >+ ) >+{ >+ ASSERT (OutputBuffer !=3D NULL); >+ ASSERT (InputSection !=3D NULL); >+ >+ if (IS_SECTION2 (InputSection)) { >+ if (!CompareGuid ( >+ &gTianoCustomDecompressGuid, >+ &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)- >>SectionDefinitionGuid))) { >+ return RETURN_INVALID_PARAMETER; >+ } >+ >+ // >+ // Set Authentication to Zero. >+ // >+ *AuthenticationStatus =3D 0; >+ >+ // >+ // Call Tiano Decompress to get the raw data >+ // >+ return UefiTianoDecompress ( >+ (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION2 *) >InputSection)->DataOffset, >+ *OutputBuffer, >+ ScratchBuffer, >+ 2 >+ ); >+ } else { >+ if (!CompareGuid ( >+ &gTianoCustomDecompressGuid, >+ &(((EFI_GUID_DEFINED_SECTION *) InputSection)- >>SectionDefinitionGuid))) { >+ return RETURN_INVALID_PARAMETER; >+ } >+ >+ // >+ // Set Authentication to Zero. >+ // >+ *AuthenticationStatus =3D 0; >+ >+ // >+ // Call Tiano Decompress to get the raw data >+ // >+ return UefiTianoDecompress ( >+ (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION *) >InputSection)->DataOffset, >+ *OutputBuffer, >+ ScratchBuffer, >+ 2 >+ ); >+ } >+} >+ >+/** >+ Registers TianoDecompress and TianoDecompressGetInfo handlers with >TianoCustomerDecompressGuid >+ >+ @retval RETURN_SUCCESS Register successfully. >+ @retval RETURN_OUT_OF_RESOURCES No enough memory to store this >handler. >+**/ >+RETURN_STATUS >+EFIAPI >+TianoDecompressLibConstructor ( >+ VOID >+) >+{ >+ return ExtractGuidedSectionRegisterHandlers ( >+ &gTianoCustomDecompressGuid, >+ TianoDecompressGetInfo, >+ TianoDecompress >+ ); >+} >diff --git >a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.inf >b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.inf >index 356c39a4fe..b25680adc5 100644 >--- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.inf >+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.inf >@@ -34,5 +34,7 @@ > [LibraryClasses] > BaseLib > DebugLib > BaseMemoryLib > >+[Guids] >+ gTianoCustomDecompressGuid ## PRODUCES ## UNDEFINED # specifies >tiano custom decompress algorithm. >diff --git >a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.uni >b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.uni >index 1cec6bd965..25f379d047 100644 >--- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.uni >+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.uni >@@ -1,16 +1,16 @@ > // /** @file > // UEFI Decompress Library implementation. > // > // UEFI Decompress Library implementation. > // >-// Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.
>+// Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.
> // > // SPDX-License-Identifier: BSD-2-Clause-Patent > // > // **/ > > >-#string STR_MODULE_ABSTRACT #language en-US "UEFI Decompress >Library implementation" >+#string STR_MODULE_ABSTRACT #language en-US "UEFI Decompress >Library and Tiano Custom Decompress Library implementation." > >-#string STR_MODULE_DESCRIPTION #language en-US "UEFI Decompress >Library implementation." >+#string STR_MODULE_DESCRIPTION #language en-US "Tiano custom >decompression algorithm shares most of the code with the UEFI Decompress >algorithm." > >diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec >index e2ea8fff66..4344ea3594 100644 >--- a/MdePkg/MdePkg.dec >+++ b/MdePkg/MdePkg.dec >@@ -759,10 +759,15 @@ > # GUID defined in Windows UEFI Firmware Update Platform doc > # > ## Include/IndustryStandard/WindowsUxCapsule.h > gWindowsUxCapsuleGuid =3D { 0x3b8c8162, 0x188c, 0x46a4, { 0xae= , 0xc9, >0xbe, 0x43, 0xf1, 0xd6, 0x56, 0x97}} > >+ # >+ # GUID indicates the tiano custom compress/decompress algorithm. >+ # >+ gTianoCustomDecompressGuid =3D { 0xA31280AD, 0x481E, 0x41B6, { 0x95= , >0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }} >+ > [Guids.IA32, Guids.X64] > ## Include/Guid/Cper.h > gEfiIa32X64ErrorTypeCacheCheckGuid =3D { 0xA55701F5, 0xE3EF, 0x43de, >{ 0xAC, 0x72, 0x24, 0x9B, 0x57, 0x3F, 0xAD, 0x2C }} > > ## Include/Guid/Cper.h >diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc >index 21743e384c..dbc24a297e 100644 >--- a/MdePkg/MdePkg.dsc >+++ b/MdePkg/MdePkg.dsc >@@ -55,10 +55,11 @@ > >MdePkg/Library/BaseReportStatusCodeLibNull/BaseReportStatusCodeLibNull >.inf > MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.inf > MdePkg/Library/BaseSynchronizationLib/BaseSynchronizationLib.inf > MdePkg/Library/BaseTimerLibNullTemplate/BaseTimerLibNullTemplate.inf > MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.inf >+ >MdePkg/Library/BaseUefiDecompressLib/BaseTianoCustomDecompressLib.in >f > MdePkg/Library/BaseSmbusLibNull/BaseSmbusLibNull.inf > MdePkg/Library/BaseSafeIntLib/BaseSafeIntLib.inf > > MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.inf > MdePkg/Library/DxeCoreHobLib/DxeCoreHobLib.inf >-- >2.18.0.windows.1