[patch v2 0/3] Merge MdeModulePkg\BaseTianoCustomDecompressLib into MdePkg\BaseUefiDecompressLib

[patch v2 0/3] Merge MdeModulePkg\BaseTianoCustomDecompressLib into MdePkg\BaseUefiDecompressLib

[Dandan Bi]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1722

V2:
1. Address the comments for patch 1 and take R-b tags from Liming.
2. Since QuarkPlatformPkg and Vlv2TbltDevicePkg has been moved
into edk2-platforms repo, drop the update for these platforms
in this v2 series, and will send seperate patches for them.
3. No change for other patches.

We plan to merge the BaseUefiTianoCustomDecompressLib
in MdeModulePkg into the BaseUefDecompressLib in MdePkg.
In order to reduce the duplicated codes and maintain
easily.
Patch 1 adds a new fdf file in BaseUefDecompressLib
(BaseUefiTianoCustomDecompressLib.inf) to keep the same
functionality and usage model with the one in MdeModulePkg.
Patch 2-4  update consumer to use this new one in MdePkg.
Patch 5 remove the one in MdeModulePkg finally.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Dandan Bi (3):
  MdePkg: Merge TianoCustomDecompress algorithm into
  Nt32Pkg: Update UefiDecompressLib instance path
  MdeModulePkg/Library: Remove BaseUefiTianoCustomDecompressLib

 MdeModulePkg/Include/Guid/TianoDecompress.h   |   22 -
 .../BaseUefiTianoCustomDecompressLib.c        | 1063 -----------------
 ...aseUefiTianoCustomDecompressLibInternals.h |  214 ----
 .../BaseUefiTianoDecompressLib.uni            |   16 -
 MdeModulePkg/MdeModulePkg.dec                 |    4 -
 MdeModulePkg/MdeModulePkg.dsc                 |    1 -
 .../BaseUefiDecompressLib.c                   |   72 +-
 .../BaseUefiDecompressLib.uni                 |    6 +-
 .../BaseUefiDecompressLibInternals.h          |   44 +-
 .../BaseUefiTianoCustomDecompressLib.c        |  213 ++++
 .../BaseUefiTianoCustomDecompressLib.inf      |   11 +-
 MdePkg/MdePkg.dec                             |    5 +
 MdePkg/MdePkg.dsc                             |    1 +
 Nt32Pkg/Nt32Pkg.dsc                           |    2 +-
 14 files changed, 330 insertions(+), 1344 deletions(-)
 delete mode 100644 MdeModulePkg/Include/Guid/TianoDecompress.h
 delete mode 100644 MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.c
 delete mode 100644 MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLibInternals.h
 delete mode 100644 MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoDecompressLib.uni
 create mode 100644 MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.c
 rename {MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib => MdePkg/Library/BaseUefiDecompressLib}/BaseUefiTianoCustomDecompressLib.inf (76%)

-- 
2.18.0.windows.1

[patch v2 1/3] MdePkg: Merge TianoCustomDecompress algorithm into

[Dandan Bi]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1722

We plan to merge the BaseUefiTianoCustomDecompressLib
in MdeModulePkg into the BaseUefDecompressLib in MdePkg.
In order to reduce the duplicated codes and maintain
easily.
This patch adds a new fdf file in BaseUefDecompressLib
(BaseUefiTianoCustomDecompressLib.inf) to keep the same
functionality and usage model with the one in MdeModulePkg,
and then update consumer to use this new one one and
remove the one in MdeModulePkg finally.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
---
 .../BaseUefiDecompressLib.c                   |  72 ++++--
 .../BaseUefiDecompressLib.uni                 |   6 +-
 .../BaseUefiDecompressLibInternals.h          |  44 +++-
 .../BaseUefiTianoCustomDecompressLib.c        | 213 ++++++++++++++++++
 .../BaseUefiTianoCustomDecompressLib.inf      |  42 ++++
 MdePkg/MdePkg.dec                             |   5 +
 MdePkg/MdePkg.dsc                             |   1 +
 7 files changed, 366 insertions(+), 17 deletions(-)
 create mode 100644 MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.c
 create mode 100644 MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.inf

diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
index 8e502b0fdb..28b4bf9d8b 100644
--- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
@@ -1,21 +1,14 @@
 /** @file
   UEFI Decompress Library implementation refer to UEFI specification.
 
-  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
   Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
 
-
-#include <Base.h>
-#include <Library/BaseLib.h>
-#include <Library/DebugLib.h>
-#include <Library/BaseMemoryLib.h>
-#include <Library/UefiDecompressLib.h>
-
 #include "BaseUefiDecompressLibInternals.h"
 
 /**
   Read NumOfBit of bits from source into mBitBuf.
 
@@ -732,29 +725,31 @@ UefiDecompressGetInfo (
   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 ASSERT().
+  If the Version is not 1 or 2, then ASSERT().
 
   @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 the
                       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 Destination.
   @retval  RETURN_INVALID_PARAMETER
                           The source buffer specified by Source is corrupted
                           (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;
@@ -762,10 +757,11 @@ UefiDecompress (
   UINT8            *Dst;
 
   ASSERT (Source != NULL);
   ASSERT (Destination != NULL);
   ASSERT (Scratch != NULL);
+  ASSERT (Version == 1 || Version == 2);
 
   Src     = Source;
   Dst     = Destination;
 
   Sd = (SCRATCH_DATA *) Scratch;
@@ -784,12 +780,22 @@ UefiDecompress (
   SetMem (Sd, sizeof (SCRATCH_DATA), 0);
 
   //
   // The length of the field 'Position Set Code Length Array Size' in Block Header.
   // For UEFI 2.0 de/compression algorithm(Version 1), mPBit = 4
-  //
-  Sd->mPBit     = 4;
+  // For Tiano de/compression algorithm(Version 2), mPBit = 5
+  //
+  switch (Version) {
+    case 1 :
+      Sd->mPBit = 4;
+      break;
+    case 2 :
+      Sd->mPBit = 5;
+      break;
+    default:
+      ASSERT (FALSE);
+  }
   Sd->mSrcBase  = (UINT8 *)Src;
   Sd->mDstBase  = Dst;
   //
   // CompSize and OrigSize are calculated in bytes
   //
@@ -813,5 +819,45 @@ 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 allowed to
+  call any memory allocation services in its implementation.  It is the caller'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 ASSERT().
+
+  @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 the
+                      required scratch buffer size is 0.
+
+  @retval  RETURN_SUCCESS Decompression completed successfully, and
+                          the uncompressed buffer is returned in Destination.
+  @retval  RETURN_INVALID_PARAMETER
+                          The source buffer specified by Source is corrupted
+                          (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);
+}
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.<BR>
+// Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
 //
 // 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/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
index 9821c19c7b..0bfb503337 100644
--- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
@@ -1,16 +1,21 @@
 /** @file
   Internal data structure defintions for Base UEFI Decompress Library.
 
-  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
 
 #ifndef __BASE_UEFI_DECOMPRESS_LIB_INTERNALS_H__
 #define __BASE_UEFI_DECOMPRESS_LIB_INTERNALS_H__
 
+#include <Base.h>
+#include <Library/BaseLib.h>
+#include <Library/DebugLib.h>
+#include <Library/BaseMemoryLib.h>
+#include <Library/UefiDecompressLib.h>
 //
 // Decompression algorithm begins here
 //
 #define BITBUFSIZ 32
 #define MAXMATCH  256
@@ -56,10 +61,11 @@ typedef struct {
   UINT16  mPTTable[256];
 
   ///
   /// The length of the field 'Position Set Code Length Array Size' in Block Header.
   /// For UEFI 2.0 de/compression algorithm, mPBit = 4.
+  /// For Tiano de/compression algorithm, mPBit = 5.
   ///
   UINT8   mPBit;
 } SCRATCH_DATA;
 
 /**
@@ -200,6 +206,42 @@ DecodeC (
 VOID
 Decode (
   SCRATCH_DATA  *Sd
   );
 
+/**
+  Decompresses a 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 allowed to
+  call any memory allocation services in its implementation.  It is the caller'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 ASSERT().
+
+  @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 the
+                      required scratch buffer size is 0.
+
+  @retval  RETURN_SUCCESS Decompression completed successfully, and
+                          the uncompressed buffer is returned in Destination.
+  @retval  RETURN_INVALID_PARAMETER
+                          The source buffer specified by Source is corrupted
+                          (not in a valid compressed format).
+**/
+RETURN_STATUS
+UefiTianoDecompress (
+  IN CONST VOID  *Source,
+  IN OUT VOID    *Destination,
+  IN OUT VOID    *Scratch,
+  IN UINT32      Version
+  );
 #endif
diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.c b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.c
new file mode 100644
index 0000000000..5a73933d2a
--- /dev/null
+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.c
@@ -0,0 +1,213 @@
+/** @file
+  UEFI Decompress Library implementation refer to UEFI specification.
+
+  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
+  Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#include <PiPei.h>
+#include <Library/ExtractGuidedSectionLib.h>
+#include "BaseUefiDecompressLibInternals.h"
+
+/**
+  Examines a GUIDed section and returns the size of the decoded buffer and 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 supports,
+  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, required as scratch space
+                                 if the buffer specified by InputSection were decoded.
+  @param[out] SectionAttribute   A pointer to the attributes of the GUIDed section. See the Attributes
+                                 field of EFI_GUID_DEFINED_SECTION in the PI Specification.
+
+  @retval  RETURN_SUCCESS            The information about InputSection was returned.
+  @retval  RETURN_UNSUPPORTED        The section specified by InputSection 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 != NULL);
+
+  if (InputSection == 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 = ((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 = ((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 supports, 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 buffer, 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 result of a decode operation.
+  @param[in] ScratchBuffer  A caller allocated buffer that may be required by this function
+                            as a scratch buffer to perform the decode operation.
+  @param[out] AuthenticationStatus
+                            A pointer to the authentication status of the decoded output buffer.
+                            See the definition of authentication status in 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 InputSection 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 != NULL);
+  ASSERT (InputSection != NULL);
+
+  if (IS_SECTION2 (InputSection)) {
+    if (!CompareGuid (
+        &gTianoCustomDecompressGuid,
+        &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)->SectionDefinitionGuid))) {
+      return RETURN_INVALID_PARAMETER;
+    }
+
+    //
+    // Set Authentication to Zero.
+    //
+    *AuthenticationStatus = 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 = 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/BaseUefiTianoCustomDecompressLib.inf b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.inf
new file mode 100644
index 0000000000..280a5f307d
--- /dev/null
+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.inf
@@ -0,0 +1,42 @@
+## @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 - 2019, Intel Corporation. All rights reserved.<BR>
+#
+#  SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+##
+
+[Defines]
+  INF_VERSION                    = 0x00010005
+  BASE_NAME                      = BaseUefiTianoCustomDecompressLib
+  MODULE_UNI_FILE                = BaseUefiDecompressLib.uni
+  FILE_GUID                      = d774c4d9-c121-4da3-a5e2-0f317e3c630c
+  MODULE_TYPE                    = BASE
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = UefiDecompressLib
+  CONSTRUCTOR                    = TianoDecompressLibConstructor
+
+#
+# The following information is for reference only and not required by the build tools.
+#
+#  VALID_ARCHITECTURES           = IA32 X64 EBC
+#
+
+[Sources]
+  BaseUefiDecompressLibInternals.h
+  BaseUefiDecompressLib.c
+  BaseUefiTianoCustomDecompressLib.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+
+[LibraryClasses]
+  BaseLib
+  DebugLib
+  BaseMemoryLib
+  ExtractGuidedSectionLib
+
+[Guids]
+  gTianoCustomDecompressGuid      ## PRODUCES  ## UNDEFINED # specifies tiano custom decompress algorithm.
diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index 28d4a966c2..6c563375ee 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -759,10 +759,15 @@ [Guids]
   # GUID defined in Windows UEFI Firmware Update Platform doc
   #
   ## Include/IndustryStandard/WindowsUxCapsule.h
   gWindowsUxCapsuleGuid          = { 0x3b8c8162, 0x188c, 0x46a4, { 0xae, 0xc9, 0xbe, 0x43, 0xf1, 0xd6, 0x56, 0x97}}
 
+  #
+  # GUID indicates the tiano custom compress/decompress algorithm.
+  #
+  gTianoCustomDecompressGuid     = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}
+
 [Guids.IA32, Guids.X64]
   ## Include/Guid/Cper.h
   gEfiIa32X64ErrorTypeCacheCheckGuid = { 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..a2ff12fe75 100644
--- a/MdePkg/MdePkg.dsc
+++ b/MdePkg/MdePkg.dsc
@@ -55,10 +55,11 @@ [Components]
   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/BaseUefiTianoCustomDecompressLib.inf
   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

Re: [edk2-devel] [patch v2 1/3] MdePkg: Merge TianoCustomDecompress algorithm into

[Liming Gao]

Reviewed-by: Liming Gao <liming.gao@intel.com>

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of Dandan Bi
> Sent: Wednesday, May 15, 2019 10:20 AM
> To: devel@edk2.groups.io
> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Gao, Liming <liming.gao@intel.com>
> Subject: [edk2-devel] [patch v2 1/3] MdePkg: Merge TianoCustomDecompress algorithm into
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1722
> 
> We plan to merge the BaseUefiTianoCustomDecompressLib
> in MdeModulePkg into the BaseUefDecompressLib in MdePkg.
> In order to reduce the duplicated codes and maintain
> easily.
> This patch adds a new fdf file in BaseUefDecompressLib
> (BaseUefiTianoCustomDecompressLib.inf) to keep the same
> functionality and usage model with the one in MdeModulePkg,
> and then update consumer to use this new one one and
> remove the one in MdeModulePkg finally.
> 
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> Reviewed-by: Liming Gao <liming.gao@intel.com>
> ---
>  .../BaseUefiDecompressLib.c                   |  72 ++++--
>  .../BaseUefiDecompressLib.uni                 |   6 +-
>  .../BaseUefiDecompressLibInternals.h          |  44 +++-
>  .../BaseUefiTianoCustomDecompressLib.c        | 213 ++++++++++++++++++
>  .../BaseUefiTianoCustomDecompressLib.inf      |  42 ++++
>  MdePkg/MdePkg.dec                             |   5 +
>  MdePkg/MdePkg.dsc                             |   1 +
>  7 files changed, 366 insertions(+), 17 deletions(-)
>  create mode 100644 MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.c
>  create mode 100644 MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.inf
> 
> diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
> b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
> index 8e502b0fdb..28b4bf9d8b 100644
> --- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
> +++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
> @@ -1,21 +1,14 @@
>  /** @file
>    UEFI Decompress Library implementation refer to UEFI specification.
> 
> -  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
> +  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
>    Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
>    SPDX-License-Identifier: BSD-2-Clause-Patent
> 
>  **/
> 
> -
> -#include <Base.h>
> -#include <Library/BaseLib.h>
> -#include <Library/DebugLib.h>
> -#include <Library/BaseMemoryLib.h>
> -#include <Library/UefiDecompressLib.h>
> -
>  #include "BaseUefiDecompressLibInternals.h"
> 
>  /**
>    Read NumOfBit of bits from source into mBitBuf.
> 
> @@ -732,29 +725,31 @@ UefiDecompressGetInfo (
>    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 ASSERT().
> +  If the Version is not 1 or 2, then ASSERT().
> 
>    @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 the
>                        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 Destination.
>    @retval  RETURN_INVALID_PARAMETER
>                            The source buffer specified by Source is corrupted
>                            (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;
> @@ -762,10 +757,11 @@ UefiDecompress (
>    UINT8            *Dst;
> 
>    ASSERT (Source != NULL);
>    ASSERT (Destination != NULL);
>    ASSERT (Scratch != NULL);
> +  ASSERT (Version == 1 || Version == 2);
> 
>    Src     = Source;
>    Dst     = Destination;
> 
>    Sd = (SCRATCH_DATA *) Scratch;
> @@ -784,12 +780,22 @@ UefiDecompress (
>    SetMem (Sd, sizeof (SCRATCH_DATA), 0);
> 
>    //
>    // The length of the field 'Position Set Code Length Array Size' in Block Header.
>    // For UEFI 2.0 de/compression algorithm(Version 1), mPBit = 4
> -  //
> -  Sd->mPBit     = 4;
> +  // For Tiano de/compression algorithm(Version 2), mPBit = 5
> +  //
> +  switch (Version) {
> +    case 1 :
> +      Sd->mPBit = 4;
> +      break;
> +    case 2 :
> +      Sd->mPBit = 5;
> +      break;
> +    default:
> +      ASSERT (FALSE);
> +  }
>    Sd->mSrcBase  = (UINT8 *)Src;
>    Sd->mDstBase  = Dst;
>    //
>    // CompSize and OrigSize are calculated in bytes
>    //
> @@ -813,5 +819,45 @@ 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 allowed to
> +  call any memory allocation services in its implementation.  It is the caller'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 ASSERT().
> +
> +  @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 the
> +                      required scratch buffer size is 0.
> +
> +  @retval  RETURN_SUCCESS Decompression completed successfully, and
> +                          the uncompressed buffer is returned in Destination.
> +  @retval  RETURN_INVALID_PARAMETER
> +                          The source buffer specified by Source is corrupted
> +                          (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);
> +}
> 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.<BR>
> +// Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
>  //
>  // 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/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
> b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
> index 9821c19c7b..0bfb503337 100644
> --- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
> +++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
> @@ -1,16 +1,21 @@
>  /** @file
>    Internal data structure defintions for Base UEFI Decompress Library.
> 
> -  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
> +  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
>    SPDX-License-Identifier: BSD-2-Clause-Patent
> 
>  **/
> 
>  #ifndef __BASE_UEFI_DECOMPRESS_LIB_INTERNALS_H__
>  #define __BASE_UEFI_DECOMPRESS_LIB_INTERNALS_H__
> 
> +#include <Base.h>
> +#include <Library/BaseLib.h>
> +#include <Library/DebugLib.h>
> +#include <Library/BaseMemoryLib.h>
> +#include <Library/UefiDecompressLib.h>
>  //
>  // Decompression algorithm begins here
>  //
>  #define BITBUFSIZ 32
>  #define MAXMATCH  256
> @@ -56,10 +61,11 @@ typedef struct {
>    UINT16  mPTTable[256];
> 
>    ///
>    /// The length of the field 'Position Set Code Length Array Size' in Block Header.
>    /// For UEFI 2.0 de/compression algorithm, mPBit = 4.
> +  /// For Tiano de/compression algorithm, mPBit = 5.
>    ///
>    UINT8   mPBit;
>  } SCRATCH_DATA;
> 
>  /**
> @@ -200,6 +206,42 @@ DecodeC (
>  VOID
>  Decode (
>    SCRATCH_DATA  *Sd
>    );
> 
> +/**
> +  Decompresses a 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 allowed to
> +  call any memory allocation services in its implementation.  It is the caller'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 ASSERT().
> +
> +  @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 the
> +                      required scratch buffer size is 0.
> +
> +  @retval  RETURN_SUCCESS Decompression completed successfully, and
> +                          the uncompressed buffer is returned in Destination.
> +  @retval  RETURN_INVALID_PARAMETER
> +                          The source buffer specified by Source is corrupted
> +                          (not in a valid compressed format).
> +**/
> +RETURN_STATUS
> +UefiTianoDecompress (
> +  IN CONST VOID  *Source,
> +  IN OUT VOID    *Destination,
> +  IN OUT VOID    *Scratch,
> +  IN UINT32      Version
> +  );
>  #endif
> diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.c
> b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.c
> new file mode 100644
> index 0000000000..5a73933d2a
> --- /dev/null
> +++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.c
> @@ -0,0 +1,213 @@
> +/** @file
> +  UEFI Decompress Library implementation refer to UEFI specification.
> +
> +  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
> +  Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#include <PiPei.h>
> +#include <Library/ExtractGuidedSectionLib.h>
> +#include "BaseUefiDecompressLibInternals.h"
> +
> +/**
> +  Examines a GUIDed section and returns the size of the decoded buffer and 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 supports,
> +  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, required as scratch space
> +                                 if the buffer specified by InputSection were decoded.
> +  @param[out] SectionAttribute   A pointer to the attributes of the GUIDed section. See the Attributes
> +                                 field of EFI_GUID_DEFINED_SECTION in the PI Specification.
> +
> +  @retval  RETURN_SUCCESS            The information about InputSection was returned.
> +  @retval  RETURN_UNSUPPORTED        The section specified by InputSection 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 != NULL);
> +
> +  if (InputSection == 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 = ((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 = ((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 supports, 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 buffer, 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 result of a decode operation.
> +  @param[in] ScratchBuffer  A caller allocated buffer that may be required by this function
> +                            as a scratch buffer to perform the decode operation.
> +  @param[out] AuthenticationStatus
> +                            A pointer to the authentication status of the decoded output buffer.
> +                            See the definition of authentication status in 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 InputSection 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 != NULL);
> +  ASSERT (InputSection != NULL);
> +
> +  if (IS_SECTION2 (InputSection)) {
> +    if (!CompareGuid (
> +        &gTianoCustomDecompressGuid,
> +        &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)->SectionDefinitionGuid))) {
> +      return RETURN_INVALID_PARAMETER;
> +    }
> +
> +    //
> +    // Set Authentication to Zero.
> +    //
> +    *AuthenticationStatus = 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 = 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/BaseUefiTianoCustomDecompressLib.inf
> b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.inf
> new file mode 100644
> index 0000000000..280a5f307d
> --- /dev/null
> +++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.inf
> @@ -0,0 +1,42 @@
> +## @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 - 2019, Intel Corporation. All rights reserved.<BR>
> +#
> +#  SPDX-License-Identifier: BSD-2-Clause-Patent
> +#
> +##
> +
> +[Defines]
> +  INF_VERSION                    = 0x00010005
> +  BASE_NAME                      = BaseUefiTianoCustomDecompressLib
> +  MODULE_UNI_FILE                = BaseUefiDecompressLib.uni
> +  FILE_GUID                      = d774c4d9-c121-4da3-a5e2-0f317e3c630c
> +  MODULE_TYPE                    = BASE
> +  VERSION_STRING                 = 1.0
> +  LIBRARY_CLASS                  = UefiDecompressLib
> +  CONSTRUCTOR                    = TianoDecompressLibConstructor
> +
> +#
> +# The following information is for reference only and not required by the build tools.
> +#
> +#  VALID_ARCHITECTURES           = IA32 X64 EBC
> +#
> +
> +[Sources]
> +  BaseUefiDecompressLibInternals.h
> +  BaseUefiDecompressLib.c
> +  BaseUefiTianoCustomDecompressLib.c
> +
> +[Packages]
> +  MdePkg/MdePkg.dec
> +
> +[LibraryClasses]
> +  BaseLib
> +  DebugLib
> +  BaseMemoryLib
> +  ExtractGuidedSectionLib
> +
> +[Guids]
> +  gTianoCustomDecompressGuid      ## PRODUCES  ## UNDEFINED # specifies tiano custom decompress algorithm.
> diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
> index 28d4a966c2..6c563375ee 100644
> --- a/MdePkg/MdePkg.dec
> +++ b/MdePkg/MdePkg.dec
> @@ -759,10 +759,15 @@ [Guids]
>    # GUID defined in Windows UEFI Firmware Update Platform doc
>    #
>    ## Include/IndustryStandard/WindowsUxCapsule.h
>    gWindowsUxCapsuleGuid          = { 0x3b8c8162, 0x188c, 0x46a4, { 0xae, 0xc9, 0xbe, 0x43, 0xf1, 0xd6, 0x56, 0x97}}
> 
> +  #
> +  # GUID indicates the tiano custom compress/decompress algorithm.
> +  #
> +  gTianoCustomDecompressGuid     = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}
> +
>  [Guids.IA32, Guids.X64]
>    ## Include/Guid/Cper.h
>    gEfiIa32X64ErrorTypeCacheCheckGuid = { 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..a2ff12fe75 100644
> --- a/MdePkg/MdePkg.dsc
> +++ b/MdePkg/MdePkg.dsc
> @@ -55,10 +55,11 @@ [Components]
>    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/BaseUefiTianoCustomDecompressLib.inf
>    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
> 
> 
> 

[patch v2 2/3] Nt32Pkg: Update UefiDecompressLib instance path

[Dandan Bi]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1722

Since we will merger the BaseUefiTianoCustomDecompressLib
in MdeModulePkg into BaseUefiDecompressLib in MdePkg and
remove the one in MdeModulePkg. So here update the Platform
to use the UefiDecompressLib instance in MdePkg.

Cc: Ray Ni <ray.ni@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 Nt32Pkg/Nt32Pkg.dsc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Nt32Pkg/Nt32Pkg.dsc b/Nt32Pkg/Nt32Pkg.dsc
index 306b7c7a2d..71079f098e 100644
--- a/Nt32Pkg/Nt32Pkg.dsc
+++ b/Nt32Pkg/Nt32Pkg.dsc
@@ -118,11 +118,11 @@ [LibraryClasses]
   UefiRuntimeLib|MdePkg/Library/UefiRuntimeLib/UefiRuntimeLib.inf
   UefiLib|MdePkg/Library/UefiLib/UefiLib.inf
   UefiHiiServicesLib|MdeModulePkg/Library/UefiHiiServicesLib/UefiHiiServicesLib.inf
   HiiLib|MdeModulePkg/Library/UefiHiiLib/UefiHiiLib.inf
   DevicePathLib|MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLibDevicePathProtocol.inf
-  UefiDecompressLib|MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
+  UefiDecompressLib|MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.inf
   PeiServicesTablePointerLib|MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointerLib.inf
   PeiServicesLib|MdePkg/Library/PeiServicesLib/PeiServicesLib.inf
   DxeServicesLib|MdePkg/Library/DxeServicesLib/DxeServicesLib.inf
   DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.inf
   UefiBootManagerLib|MdeModulePkg/Library/UefiBootManagerLib/UefiBootManagerLib.inf
-- 
2.18.0.windows.1

Re: [edk2-devel] [patch v2 2/3] Nt32Pkg: Update UefiDecompressLib instance path

[Wu, Hao A]

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Dandan Bi
> Sent: Wednesday, May 15, 2019 10:20 AM
> To: devel@edk2.groups.io
> Cc: Ni, Ray; Wu, Hao A
> Subject: [edk2-devel] [patch v2 2/3] Nt32Pkg: Update UefiDecompressLib
> instance path
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1722
> 
> Since we will merger the BaseUefiTianoCustomDecompressLib
> in MdeModulePkg into BaseUefiDecompressLib in MdePkg and
> remove the one in MdeModulePkg. So here update the Platform
> to use the UefiDecompressLib instance in MdePkg.
> 
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Hao A Wu <hao.a.wu@intel.com>
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  Nt32Pkg/Nt32Pkg.dsc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Nt32Pkg/Nt32Pkg.dsc b/Nt32Pkg/Nt32Pkg.dsc
> index 306b7c7a2d..71079f098e 100644
> --- a/Nt32Pkg/Nt32Pkg.dsc
> +++ b/Nt32Pkg/Nt32Pkg.dsc
> @@ -118,11 +118,11 @@ [LibraryClasses]
>    UefiRuntimeLib|MdePkg/Library/UefiRuntimeLib/UefiRuntimeLib.inf
>    UefiLib|MdePkg/Library/UefiLib/UefiLib.inf
> 
> UefiHiiServicesLib|MdeModulePkg/Library/UefiHiiServicesLib/UefiHiiServicesLi
> b.inf
>    HiiLib|MdeModulePkg/Library/UefiHiiLib/UefiHiiLib.inf
> 
> DevicePathLib|MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevi
> cePathLibDevicePathProtocol.inf
> -
> UefiDecompressLib|MdeModulePkg/Library/BaseUefiTianoCustomDecompress
> Lib/BaseUefiTianoCustomDecompressLib.inf
> +
> UefiDecompressLib|MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCu
> stomDecompressLib.inf

Reviewed-by: Hao A Wu <hao.a.wu@intel.com>

Best Regards,
Hao Wu

> 
> PeiServicesTablePointerLib|MdePkg/Library/PeiServicesTablePointerLib/PeiSer
> vicesTablePointerLib.inf
>    PeiServicesLib|MdePkg/Library/PeiServicesLib/PeiServicesLib.inf
>    DxeServicesLib|MdePkg/Library/DxeServicesLib/DxeServicesLib.inf
> 
> DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLi
> b.inf
> 
> UefiBootManagerLib|MdeModulePkg/Library/UefiBootManagerLib/UefiBootM
> anagerLib.inf
> --
> 2.18.0.windows.1
> 
> 
> 

[patch v2 3/3] MdeModulePkg/Library: Remove BaseUefiTianoCustomDecompressLib

[Dandan Bi]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1722

Since we have merged this one into MdePkg,
remove it now.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 MdeModulePkg/Include/Guid/TianoDecompress.h   |   22 -
 .../BaseUefiTianoCustomDecompressLib.c        | 1063 -----------------
 .../BaseUefiTianoCustomDecompressLib.inf      |   43 -
 ...aseUefiTianoCustomDecompressLibInternals.h |  214 ----
 .../BaseUefiTianoDecompressLib.uni            |   16 -
 MdeModulePkg/MdeModulePkg.dec                 |    4 -
 MdeModulePkg/MdeModulePkg.dsc                 |    1 -
 7 files changed, 1363 deletions(-)
 delete mode 100644 MdeModulePkg/Include/Guid/TianoDecompress.h
 delete mode 100644 MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.c
 delete mode 100644 MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
 delete mode 100644 MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLibInternals.h
 delete mode 100644 MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoDecompressLib.uni

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.<BR>
-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, 0x47, 0x79 } }
-
-extern GUID gTianoCustomDecompressGuid;
-
-#endif
diff --git a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.c b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.c
deleted file mode 100644
index 38b66b1906..0000000000
--- a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.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.<BR>
-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 = (UINT32) LShiftU64 (((UINT64)Sd->mBitBuf), NumOfBits);
-
-  //
-  // Copy data needed in bytes into mSbuBitBuf
-  //
-  while (NumOfBits > Sd->mBitCount) {
-    NumOfBits = (UINT16) (NumOfBits - Sd->mBitCount);
-    Sd->mBitBuf |= (UINT32) LShiftU64 (((UINT64)Sd->mSubBitBuf), NumOfBits);
-
-    if (Sd->mCompSize > 0) {
-      //
-      // Get 1 byte into SubBitBuf
-      //
-      Sd->mCompSize--;
-      Sd->mSubBitBuf  = 0;
-      Sd->mSubBitBuf  = Sd->mSrcBase[Sd->mInBuf++];
-      Sd->mBitCount   = 8;
-
-    } else {
-      //
-      // No more bits from the source, just pad zero bit.
-      //
-      Sd->mSubBitBuf  = 0;
-      Sd->mBitCount   = 8;
-
-    }
-  }
-
-  //
-  // Calculate additional bit count read to update mBitCount
-  //
-  Sd->mBitCount = (UINT16) (Sd->mBitCount - NumOfBits);
-
-  //
-  // Copy NumOfBits of bits from mSubBitBuf into mBitBuf
-  //
-  Sd->mBitBuf |= 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 = (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 <= 16);
-
-  for (Index = 0; Index <= 16; Index++) {
-    Count[Index] = 0;
-  }
-
-  for (Index = 0; Index < NumOfChar; Index++) {
-    if (BitLen[Index] > 16) {
-      return (UINT16) BAD_TABLE;
-    }
-    Count[BitLen[Index]]++;
-  }
-
-  Start[0] = 0;
-  Start[1] = 0;
-
-  for (Index = 1; Index <= 16; Index++) {
-    WordOfStart = Start[Index];
-    WordOfCount = Count[Index];
-    Start[Index + 1] = (UINT16) (WordOfStart + (WordOfCount << (16 - Index)));
-  }
-
-  if (Start[17] != 0) {
-    /*(1U << 16)*/
-    return (UINT16) BAD_TABLE;
-  }
-
-  JuBits = (UINT16) (16 - TableBits);
-
-  Weight[0] = 0;
-  for (Index = 1; Index <= TableBits; Index++) {
-    Start[Index] >>= JuBits;
-    Weight[Index] = (UINT16) (1U << (TableBits - Index));
-  }
-
-  while (Index <= 16) {
-    Weight[Index] = (UINT16) (1U << (16 - Index));
-    Index++;
-  }
-
-  Index = (UINT16) (Start[TableBits + 1] >> JuBits);
-
-  if (Index != 0) {
-    Index3 = (UINT16) (1U << TableBits);
-    if (Index < Index3) {
-      SetMem16 (Table + Index, (Index3 - Index) * sizeof (*Table), 0);
-    }
-  }
-
-  Avail = NumOfChar;
-  Mask  = (UINT16) (1U << (15 - TableBits));
-  MaxTableLength = (UINT16) (1U << TableBits);
-
-  for (Char = 0; Char < NumOfChar; Char++) {
-
-    Len = BitLen[Char];
-    if (Len == 0 || Len >= 17) {
-      continue;
-    }
-
-    NextCode = (UINT16) (Start[Len] + Weight[Len]);
-
-    if (Len <= TableBits) {
-
-      for (Index = Start[Len]; Index < NextCode; Index++) {
-        if (Index >= MaxTableLength) {
-          return (UINT16) BAD_TABLE;
-        }
-        Table[Index] = Char;
-      }
-
-    } else {
-
-      Index3  = Start[Len];
-      Pointer = &Table[Index3 >> JuBits];
-      Index   = (UINT16) (Len - TableBits);
-
-      while (Index != 0) {
-        if (*Pointer == 0 && Avail < (2 * NC - 1)) {
-          Sd->mRight[Avail] = Sd->mLeft[Avail] = 0;
-          *Pointer = Avail++;
-        }
-
-        if (*Pointer < (2 * NC - 1)) {
-          if ((Index3 & Mask) != 0) {
-            Pointer = &Sd->mRight[*Pointer];
-          } else {
-            Pointer = &Sd->mLeft[*Pointer];
-          }
-        }
-
-        Index3 <<= 1;
-        Index--;
-      }
-
-      *Pointer = Char;
-
-    }
-
-    Start[Len] = 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 = Sd->mPTTable[Sd->mBitBuf >> (BITBUFSIZ - 8)];
-
-  if (Val >= MAXNP) {
-    Mask = 1U << (BITBUFSIZ - 1 - 8);
-
-    do {
-
-      if ((Sd->mBitBuf & Mask) != 0) {
-        Val = Sd->mRight[Val];
-      } else {
-        Val = Sd->mLeft[Val];
-      }
-
-      Mask >>= 1;
-    } while (Val >= MAXNP);
-  }
-  //
-  // Advance what we have read
-  //
-  FillBuf (Sd, Sd->mPTLen[Val]);
-
-  Pos = Val;
-  if (Val > 1) {
-    Pos = (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 <= NPT);
-  //
-  // Read Extra Set Code Length Array size
-  //
-  Number = (UINT16) GetBits (Sd, nbit);
-
-  if (Number == 0) {
-    //
-    // This represents only Huffman code used
-    //
-    CharC = (UINT16) GetBits (Sd, nbit);
-
-    for (Index = 0; Index < 256; Index++) {
-      Sd->mPTTable[Index] = CharC;
-    }
-
-    SetMem (Sd->mPTLen, nn, 0);
-
-    return 0;
-  }
-
-  Index = 0;
-
-  while (Index < Number && Index < NPT) {
-
-    CharC = (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 = Code length - 4.
-    //
-    if (CharC == 7) {
-      Mask = 1U << (BITBUFSIZ - 1 - 3);
-      while (Mask & Sd->mBitBuf) {
-        Mask >>= 1;
-        CharC += 1;
-      }
-    }
-
-    FillBuf (Sd, (UINT16) ((CharC < 7) ? 3 : CharC - 3));
-
-    Sd->mPTLen[Index++] = (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 == Special) {
-      CharC = (UINT16) GetBits (Sd, 2);
-      while ((INT16) (--CharC) >= 0 && Index < NPT) {
-        Sd->mPTLen[Index++] = 0;
-      }
-    }
-  }
-
-  while (Index < nn && Index < NPT) {
-    Sd->mPTLen[Index++] = 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 = (UINT16) GetBits (Sd, CBIT);
-
-  if (Number == 0) {
-    //
-    // This represents only Huffman code used
-    //
-    CharC = (UINT16) GetBits (Sd, CBIT);
-
-    SetMem (Sd->mCLen, NC, 0);
-
-    for (Index = 0; Index < 4096; Index++) {
-      Sd->mCTable[Index] = CharC;
-    }
-
-    return ;
-  }
-
-  Index = 0;
-  while (Index < Number && Index < NC) {
-    CharC = Sd->mPTTable[Sd->mBitBuf >> (BITBUFSIZ - 8)];
-    if (CharC >= NT) {
-      Mask = 1U << (BITBUFSIZ - 1 - 8);
-
-      do {
-
-        if (Mask & Sd->mBitBuf) {
-          CharC = Sd->mRight[CharC];
-        } else {
-          CharC = Sd->mLeft[CharC];
-        }
-
-        Mask >>= 1;
-
-      } while (CharC >= NT);
-    }
-    //
-    // Advance what we have read
-    //
-    FillBuf (Sd, Sd->mPTLen[CharC]);
-
-    if (CharC <= 2) {
-
-      if (CharC == 0) {
-        CharC = 1;
-      } else if (CharC == 1) {
-        CharC = (UINT16) (GetBits (Sd, 4) + 3);
-      } else if (CharC == 2) {
-        CharC = (UINT16) (GetBits (Sd, CBIT) + 20);
-      }
-
-      while ((INT16) (--CharC) >= 0 && Index < NC) {
-        Sd->mCLen[Index++] = 0;
-      }
-
-    } else {
-
-      Sd->mCLen[Index++] = (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 block 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 == 0) {
-    //
-    // Starting a new block
-    // Read BlockSize from block header
-    //
-    Sd->mBlockSize    = (UINT16) GetBits (Sd, 16);
-
-    //
-    // Read in the Extra Set Code Length Array,
-    // Generate the Huffman code mapping table for Extra Set.
-    //
-    Sd->mBadTableFlag = ReadPTLen (Sd, NT, TBIT, 3);
-    if (Sd->mBadTableFlag != 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 = ReadPTLen (Sd, MAXNP, Sd->mPBit, (UINT16) (-1));
-    if (Sd->mBadTableFlag != 0) {
-      return 0;
-    }
-  }
-
-  //
-  // Get one code according to Code&Set Huffman Table
-  //
-  Sd->mBlockSize--;
-  Index2 = Sd->mCTable[Sd->mBitBuf >> (BITBUFSIZ - 12)];
-
-  if (Index2 >= NC) {
-    Mask = 1U << (BITBUFSIZ - 1 - 12);
-
-    do {
-      if ((Sd->mBitBuf & Mask) != 0) {
-        Index2 = Sd->mRight[Index2];
-      } else {
-        Index2 = Sd->mLeft[Index2];
-      }
-
-      Mask >>= 1;
-    } while (Index2 >= 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 = (UINT16) (-1);
-
-  DataIdx     = 0;
-
-  for (;;) {
-    //
-    // Get one code from mBitBuf
-    //
-    CharC = DecodeC (Sd);
-    if (Sd->mBadTableFlag != 0) {
-      goto Done;
-    }
-
-    if (CharC < 256) {
-      //
-      // Process an Original character
-      //
-      if (Sd->mOutBuf >= Sd->mOrigSize) {
-        goto Done;
-      } else {
-        //
-        // Write orignal character into mDstBase
-        //
-        Sd->mDstBase[Sd->mOutBuf++] = (UINT8) CharC;
-      }
-
-    } else {
-      //
-      // Process a Pointer
-      //
-      CharC       = (UINT16) (CharC - (BIT8 - THRESHOLD));
-
-      //
-      // Get string length
-      //
-      BytesRemain = CharC;
-
-      //
-      // Locate string position
-      //
-      DataIdx     = Sd->mOutBuf - DecodeP (Sd) - 1;
-
-      //
-      // Write BytesRemain of bytes into mDstBase
-      //
-      BytesRemain--;
-      while ((INT16) (BytesRemain) >= 0) {
-        if (Sd->mOutBuf >= Sd->mOrigSize) {
-          goto Done ;
-        }
-        if (DataIdx >= Sd->mOrigSize) {
-          Sd->mBadTableFlag = (UINT16) BAD_TABLE;
-          goto Done ;
-        }
-        Sd->mDstBase[Sd->mOutBuf++] = Sd->mDstBase[DataIdx++];
-
-        BytesRemain--;
-      }
-      //
-      // Once mOutBuf is fully filled, directly return
-      //
-      if (Sd->mOutBuf >= 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 buffer 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 is returned
-  in ScratchSize, and RETURN_SUCCESS is returned.
-  This function does not have scratch buffer available to perform a thorough
-  checking of the validity of the source data.  It just retrieves the "Original 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 data.
-  @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 buffer 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 of
-                          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 != NULL);
-  ASSERT (DestinationSize != NULL);
-  ASSERT (ScratchSize != NULL);
-
-  if (SourceSize < 8) {
-    return RETURN_INVALID_PARAMETER;
-  }
-
-  CompressedSize   = ReadUnaligned32 ((UINT32 *)Source);
-  if (SourceSize < (CompressedSize + 8) || (CompressedSize + 8) < 8) {
-    return RETURN_INVALID_PARAMETER;
-  }
-
-  *ScratchSize  = sizeof (SCRATCH_DATA);
-  *DestinationSize = 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 allowed to
-  call any memory allocation services in its implementation.  It is the caller'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 ASSERT().
-
-  @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 the
-                      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 Destination.
-  @retval  RETURN_INVALID_PARAMETER
-                          The source buffer specified by Source is corrupted
-                          (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 != NULL);
-  ASSERT (Destination != NULL);
-  ASSERT (Scratch != NULL);
-
-  Src     = Source;
-  Dst     = Destination;
-
-  Sd = (SCRATCH_DATA *) Scratch;
-
-  CompSize  = Src[0] + (Src[1] << 8) + (Src[2] << 16) + (Src[3] << 24);
-  OrigSize  = Src[4] + (Src[5] << 8) + (Src[6] << 16) + (Src[7] << 24);
-
-  //
-  // If compressed file size is 0, return
-  //
-  if (OrigSize == 0) {
-    return RETURN_SUCCESS;
-  }
-
-  Src = Src + 8;
-
-  SetMem (Sd, sizeof (SCRATCH_DATA), 0);
-
-  //
-  // The length of the field 'Position Set Code Length Array Size' in Block Header.
-  // For UEFI 2.0 de/compression algorithm(Version 1), mPBit = 4
-  // For Tiano de/compression algorithm(Version 2), mPBit = 5
-  //
-  switch (Version) {
-    case 1 :
-      Sd->mPBit = 4;
-      break;
-    case 2 :
-      Sd->mPBit = 5;
-      break;
-    default:
-      ASSERT (FALSE);
-  }
-  Sd->mSrcBase  = (UINT8 *)Src;
-  Sd->mDstBase  = Dst;
-  //
-  // CompSize and OrigSize are calculated in bytes
-  //
-  Sd->mCompSize = CompSize;
-  Sd->mOrigSize = OrigSize;
-
-  //
-  // Fill the first BITBUFSIZ bits
-  //
-  FillBuf (Sd, BITBUFSIZ);
-
-  //
-  // Decompress it
-  //
-  Decode (Sd);
-
-  if (Sd->mBadTableFlag != 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 allowed to
-  call any memory allocation services in its implementation.  It is the caller'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 ASSERT().
-
-  @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 the
-                      required scratch buffer size is 0.
-
-  @retval  RETURN_SUCCESS Decompression completed successfully, and
-                          the uncompressed buffer is returned in Destination.
-  @retval  RETURN_INVALID_PARAMETER
-                          The source buffer specified by Source is corrupted
-                          (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 and 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 supports,
-  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, required as scratch space
-                                 if the buffer specified by InputSection were decoded.
-  @param[out] SectionAttribute   A pointer to the attributes of the GUIDed section. See the Attributes
-                                 field of EFI_GUID_DEFINED_SECTION in the PI Specification.
-
-  @retval  RETURN_SUCCESS            The information about InputSection was returned.
-  @retval  RETURN_UNSUPPORTED        The section specified by InputSection 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 != NULL);
-
-  if (InputSection == 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 = ((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 = ((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 supports, 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 buffer, 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 result of a decode operation.
-  @param[in] ScratchBuffer  A caller allocated buffer that may be required by this function
-                            as a scratch buffer to perform the decode operation.
-  @param[out] AuthenticationStatus
-                            A pointer to the authentication status of the decoded output buffer.
-                            See the definition of authentication status in 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 InputSection 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 != NULL);
-  ASSERT (InputSection != NULL);
-
-  if (IS_SECTION2 (InputSection)) {
-    if (!CompareGuid (
-        &gTianoCustomDecompressGuid,
-        &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)->SectionDefinitionGuid))) {
-      return RETURN_INVALID_PARAMETER;
-    }
-
-    //
-    // Set Authentication to Zero.
-    //
-    *AuthenticationStatus = 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 = 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/BaseUefiTianoCustomDecompressLib.inf b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
deleted file mode 100644
index c9c19d6d3c..0000000000
--- a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
+++ /dev/null
@@ -1,43 +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 - 2018, Intel Corporation. All rights reserved.<BR>
-#
-#  SPDX-License-Identifier: BSD-2-Clause-Patent
-#
-##
-
-[Defines]
-  INF_VERSION                    = 0x00010005
-  BASE_NAME                      = BaseUefiTianoDecompressLib
-  MODULE_UNI_FILE                = BaseUefiTianoDecompressLib.uni
-  FILE_GUID                      = d774c4d9-c121-4da3-a5e2-0f317e3c630c
-  MODULE_TYPE                    = BASE
-  VERSION_STRING                 = 1.0
-  LIBRARY_CLASS                  = UefiDecompressLib
-  CONSTRUCTOR                    = TianoDecompressLibConstructor
-
-#
-# The following information is for reference only and not required by the build tools.
-#
-#  VALID_ARCHITECTURES           = IA32 X64 EBC
-#
-
-[Sources]
-  BaseUefiTianoCustomDecompressLibInternals.h
-  BaseUefiTianoCustomDecompressLib.c
-
-[Packages]
-  MdePkg/MdePkg.dec
-  MdeModulePkg/MdeModulePkg.dec
-
-[LibraryClasses]
-  BaseLib
-  DebugLib
-  BaseMemoryLib
-  ExtractGuidedSectionLib
-
-[Guids]
-  gTianoCustomDecompressGuid      ## PRODUCES  ## UNDEFINED # specifies tiano custom decompress algorithm.
-
diff --git a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLibInternals.h b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLibInternals.h
deleted file mode 100644
index 846abdb78e..0000000000
--- a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLibInternals.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.<BR>
-  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 <PiPei.h>
-
-#include <Guid/TianoDecompress.h>
-#include <Library/BaseLib.h>
-#include <Library/UefiDecompressLib.h>
-#include <Library/DebugLib.h>
-#include <Library/BaseMemoryLib.h>
-#include <Library/ExtractGuidedSectionLib.h>
-
-//
-// 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 Block Header.
-  /// For UEFI 2.0 de/compression algorithm, mPBit = 4
-  /// For Tiano de/compression algorithm, mPBit = 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 block 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/BaseUefiTianoDecompressLib.uni b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoDecompressLib.uni
deleted file mode 100644
index c384dacbef..0000000000
--- a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoDecompressLib.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.<BR>
-//
-// 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 b2fab4a65e..0a9fcddecc 100644
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -371,14 +371,10 @@ [Guids]
   ## GUID indicates the LZMA custom compress/decompress algorithm.
   #  Include/Guid/LzmaDecompress.h
   gLzmaCustomDecompressGuid      = { 0xEE4E5898, 0x3914, 0x4259, { 0x9D, 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF }}
   gLzmaF86CustomDecompressGuid     = { 0xD42AE6BD, 0x1352, 0x4bfb, { 0x90, 0x9A, 0xCA, 0x72, 0xA6, 0xEA, 0xE8, 0x89 }}
 
-  ## GUID indicates the tiano custom compress/decompress algorithm.
-  #  Include/Guid/TianoDecompress.h
-  gTianoCustomDecompressGuid     = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}
-
   ## Include/Guid/TtyTerm.h
   gEfiTtyTermGuid                = { 0x7d916d80, 0x5bb1, 0x458c, {0xa4, 0x8f, 0xe2, 0x5f, 0xdd, 0x51, 0xef, 0x94 }}
 
   ## Include/Guid/HiiBootMaintenanceFormset.h
   gEfiIfrBootMaintenanceGuid      = { 0xb2dedc91, 0xd59f, 0x48d2, { 0x89, 0x8a, 0x12, 0x49, 0xc, 0x74, 0xa4, 0xe0 }}
diff --git a/MdeModulePkg/MdeModulePkg.dsc b/MdeModulePkg/MdeModulePkg.dsc
index a8b9d8d027..ac7111dea1 100644
--- a/MdeModulePkg/MdeModulePkg.dsc
+++ b/MdeModulePkg/MdeModulePkg.dsc
@@ -312,11 +312,10 @@ [Components]
   MdeModulePkg/Library/FrameBufferBltLib/FrameBufferBltLib.inf
   MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverableDeviceRegistrationLib.inf
   MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf
   MdeModulePkg/Library/DisplayUpdateProgressLibGraphics/DisplayUpdateProgressLibGraphics.inf
   MdeModulePkg/Library/DisplayUpdateProgressLibText/DisplayUpdateProgressLibText.inf
-  MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
 
   MdeModulePkg/Universal/BdsDxe/BdsDxe.inf
   MdeModulePkg/Application/BootManagerMenuApp/BootManagerMenuApp.inf
   MdeModulePkg/Application/UiApp/UiApp.inf{
     <LibraryClasses>
-- 
2.18.0.windows.1

Re: [edk2-devel] [patch v2 3/3] MdeModulePkg/Library: Remove BaseUefiTianoCustomDecompressLib

[Wu, Hao A]

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Dandan Bi
> Sent: Wednesday, May 15, 2019 10:20 AM
> To: devel@edk2.groups.io
> Cc: Gao, Liming; Wang, Jian J; Wu, Hao A
> Subject: [edk2-devel] [patch v2 3/3] MdeModulePkg/Library: Remove
> BaseUefiTianoCustomDecompressLib
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1722
> 
> Since we have merged this one into MdePkg,
> remove it now.

Reviewed-by: Hao A Wu <hao.a.wu@intel.com>

Best Regards,
Hao Wu

> 
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao A Wu <hao.a.wu@intel.com>
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  MdeModulePkg/Include/Guid/TianoDecompress.h   |   22 -
>  .../BaseUefiTianoCustomDecompressLib.c        | 1063 -----------------
>  .../BaseUefiTianoCustomDecompressLib.inf      |   43 -
>  ...aseUefiTianoCustomDecompressLibInternals.h |  214 ----
>  .../BaseUefiTianoDecompressLib.uni            |   16 -
>  MdeModulePkg/MdeModulePkg.dec                 |    4 -
>  MdeModulePkg/MdeModulePkg.dsc                 |    1 -
>  7 files changed, 1363 deletions(-)
>  delete mode 100644 MdeModulePkg/Include/Guid/TianoDecompress.h
>  delete mode 100644
> MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoC
> ustomDecompressLib.c
>  delete mode 100644
> MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoC
> ustomDecompressLib.inf
>  delete mode 100644
> MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoC
> ustomDecompressLibInternals.h
>  delete mode 100644
> MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoD
> ecompressLib.uni
> 
> 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.<BR>
> -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, 0x47,
> 0x79 } }
> -
> -extern GUID gTianoCustomDecompressGuid;
> -
> -#endif
> diff --git
> a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> CustomDecompressLib.c
> b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> CustomDecompressLib.c
> deleted file mode 100644
> index 38b66b1906..0000000000
> ---
> a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> CustomDecompressLib.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.<BR>
> -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 = (UINT32) LShiftU64 (((UINT64)Sd->mBitBuf), NumOfBits);
> -
> -  //
> -  // Copy data needed in bytes into mSbuBitBuf
> -  //
> -  while (NumOfBits > Sd->mBitCount) {
> -    NumOfBits = (UINT16) (NumOfBits - Sd->mBitCount);
> -    Sd->mBitBuf |= (UINT32) LShiftU64 (((UINT64)Sd->mSubBitBuf), NumOfBits);
> -
> -    if (Sd->mCompSize > 0) {
> -      //
> -      // Get 1 byte into SubBitBuf
> -      //
> -      Sd->mCompSize--;
> -      Sd->mSubBitBuf  = 0;
> -      Sd->mSubBitBuf  = Sd->mSrcBase[Sd->mInBuf++];
> -      Sd->mBitCount   = 8;
> -
> -    } else {
> -      //
> -      // No more bits from the source, just pad zero bit.
> -      //
> -      Sd->mSubBitBuf  = 0;
> -      Sd->mBitCount   = 8;
> -
> -    }
> -  }
> -
> -  //
> -  // Calculate additional bit count read to update mBitCount
> -  //
> -  Sd->mBitCount = (UINT16) (Sd->mBitCount - NumOfBits);
> -
> -  //
> -  // Copy NumOfBits of bits from mSubBitBuf into mBitBuf
> -  //
> -  Sd->mBitBuf |= 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 = (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 <= 16);
> -
> -  for (Index = 0; Index <= 16; Index++) {
> -    Count[Index] = 0;
> -  }
> -
> -  for (Index = 0; Index < NumOfChar; Index++) {
> -    if (BitLen[Index] > 16) {
> -      return (UINT16) BAD_TABLE;
> -    }
> -    Count[BitLen[Index]]++;
> -  }
> -
> -  Start[0] = 0;
> -  Start[1] = 0;
> -
> -  for (Index = 1; Index <= 16; Index++) {
> -    WordOfStart = Start[Index];
> -    WordOfCount = Count[Index];
> -    Start[Index + 1] = (UINT16) (WordOfStart + (WordOfCount << (16 - Index)));
> -  }
> -
> -  if (Start[17] != 0) {
> -    /*(1U << 16)*/
> -    return (UINT16) BAD_TABLE;
> -  }
> -
> -  JuBits = (UINT16) (16 - TableBits);
> -
> -  Weight[0] = 0;
> -  for (Index = 1; Index <= TableBits; Index++) {
> -    Start[Index] >>= JuBits;
> -    Weight[Index] = (UINT16) (1U << (TableBits - Index));
> -  }
> -
> -  while (Index <= 16) {
> -    Weight[Index] = (UINT16) (1U << (16 - Index));
> -    Index++;
> -  }
> -
> -  Index = (UINT16) (Start[TableBits + 1] >> JuBits);
> -
> -  if (Index != 0) {
> -    Index3 = (UINT16) (1U << TableBits);
> -    if (Index < Index3) {
> -      SetMem16 (Table + Index, (Index3 - Index) * sizeof (*Table), 0);
> -    }
> -  }
> -
> -  Avail = NumOfChar;
> -  Mask  = (UINT16) (1U << (15 - TableBits));
> -  MaxTableLength = (UINT16) (1U << TableBits);
> -
> -  for (Char = 0; Char < NumOfChar; Char++) {
> -
> -    Len = BitLen[Char];
> -    if (Len == 0 || Len >= 17) {
> -      continue;
> -    }
> -
> -    NextCode = (UINT16) (Start[Len] + Weight[Len]);
> -
> -    if (Len <= TableBits) {
> -
> -      for (Index = Start[Len]; Index < NextCode; Index++) {
> -        if (Index >= MaxTableLength) {
> -          return (UINT16) BAD_TABLE;
> -        }
> -        Table[Index] = Char;
> -      }
> -
> -    } else {
> -
> -      Index3  = Start[Len];
> -      Pointer = &Table[Index3 >> JuBits];
> -      Index   = (UINT16) (Len - TableBits);
> -
> -      while (Index != 0) {
> -        if (*Pointer == 0 && Avail < (2 * NC - 1)) {
> -          Sd->mRight[Avail] = Sd->mLeft[Avail] = 0;
> -          *Pointer = Avail++;
> -        }
> -
> -        if (*Pointer < (2 * NC - 1)) {
> -          if ((Index3 & Mask) != 0) {
> -            Pointer = &Sd->mRight[*Pointer];
> -          } else {
> -            Pointer = &Sd->mLeft[*Pointer];
> -          }
> -        }
> -
> -        Index3 <<= 1;
> -        Index--;
> -      }
> -
> -      *Pointer = Char;
> -
> -    }
> -
> -    Start[Len] = 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 = Sd->mPTTable[Sd->mBitBuf >> (BITBUFSIZ - 8)];
> -
> -  if (Val >= MAXNP) {
> -    Mask = 1U << (BITBUFSIZ - 1 - 8);
> -
> -    do {
> -
> -      if ((Sd->mBitBuf & Mask) != 0) {
> -        Val = Sd->mRight[Val];
> -      } else {
> -        Val = Sd->mLeft[Val];
> -      }
> -
> -      Mask >>= 1;
> -    } while (Val >= MAXNP);
> -  }
> -  //
> -  // Advance what we have read
> -  //
> -  FillBuf (Sd, Sd->mPTLen[Val]);
> -
> -  Pos = Val;
> -  if (Val > 1) {
> -    Pos = (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 <= NPT);
> -  //
> -  // Read Extra Set Code Length Array size
> -  //
> -  Number = (UINT16) GetBits (Sd, nbit);
> -
> -  if (Number == 0) {
> -    //
> -    // This represents only Huffman code used
> -    //
> -    CharC = (UINT16) GetBits (Sd, nbit);
> -
> -    for (Index = 0; Index < 256; Index++) {
> -      Sd->mPTTable[Index] = CharC;
> -    }
> -
> -    SetMem (Sd->mPTLen, nn, 0);
> -
> -    return 0;
> -  }
> -
> -  Index = 0;
> -
> -  while (Index < Number && Index < NPT) {
> -
> -    CharC = (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 = Code length - 4.
> -    //
> -    if (CharC == 7) {
> -      Mask = 1U << (BITBUFSIZ - 1 - 3);
> -      while (Mask & Sd->mBitBuf) {
> -        Mask >>= 1;
> -        CharC += 1;
> -      }
> -    }
> -
> -    FillBuf (Sd, (UINT16) ((CharC < 7) ? 3 : CharC - 3));
> -
> -    Sd->mPTLen[Index++] = (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 == Special) {
> -      CharC = (UINT16) GetBits (Sd, 2);
> -      while ((INT16) (--CharC) >= 0 && Index < NPT) {
> -        Sd->mPTLen[Index++] = 0;
> -      }
> -    }
> -  }
> -
> -  while (Index < nn && Index < NPT) {
> -    Sd->mPTLen[Index++] = 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 = (UINT16) GetBits (Sd, CBIT);
> -
> -  if (Number == 0) {
> -    //
> -    // This represents only Huffman code used
> -    //
> -    CharC = (UINT16) GetBits (Sd, CBIT);
> -
> -    SetMem (Sd->mCLen, NC, 0);
> -
> -    for (Index = 0; Index < 4096; Index++) {
> -      Sd->mCTable[Index] = CharC;
> -    }
> -
> -    return ;
> -  }
> -
> -  Index = 0;
> -  while (Index < Number && Index < NC) {
> -    CharC = Sd->mPTTable[Sd->mBitBuf >> (BITBUFSIZ - 8)];
> -    if (CharC >= NT) {
> -      Mask = 1U << (BITBUFSIZ - 1 - 8);
> -
> -      do {
> -
> -        if (Mask & Sd->mBitBuf) {
> -          CharC = Sd->mRight[CharC];
> -        } else {
> -          CharC = Sd->mLeft[CharC];
> -        }
> -
> -        Mask >>= 1;
> -
> -      } while (CharC >= NT);
> -    }
> -    //
> -    // Advance what we have read
> -    //
> -    FillBuf (Sd, Sd->mPTLen[CharC]);
> -
> -    if (CharC <= 2) {
> -
> -      if (CharC == 0) {
> -        CharC = 1;
> -      } else if (CharC == 1) {
> -        CharC = (UINT16) (GetBits (Sd, 4) + 3);
> -      } else if (CharC == 2) {
> -        CharC = (UINT16) (GetBits (Sd, CBIT) + 20);
> -      }
> -
> -      while ((INT16) (--CharC) >= 0 && Index < NC) {
> -        Sd->mCLen[Index++] = 0;
> -      }
> -
> -    } else {
> -
> -      Sd->mCLen[Index++] = (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 block
> 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 == 0) {
> -    //
> -    // Starting a new block
> -    // Read BlockSize from block header
> -    //
> -    Sd->mBlockSize    = (UINT16) GetBits (Sd, 16);
> -
> -    //
> -    // Read in the Extra Set Code Length Array,
> -    // Generate the Huffman code mapping table for Extra Set.
> -    //
> -    Sd->mBadTableFlag = ReadPTLen (Sd, NT, TBIT, 3);
> -    if (Sd->mBadTableFlag != 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 = ReadPTLen (Sd, MAXNP, Sd->mPBit, (UINT16) (-1));
> -    if (Sd->mBadTableFlag != 0) {
> -      return 0;
> -    }
> -  }
> -
> -  //
> -  // Get one code according to Code&Set Huffman Table
> -  //
> -  Sd->mBlockSize--;
> -  Index2 = Sd->mCTable[Sd->mBitBuf >> (BITBUFSIZ - 12)];
> -
> -  if (Index2 >= NC) {
> -    Mask = 1U << (BITBUFSIZ - 1 - 12);
> -
> -    do {
> -      if ((Sd->mBitBuf & Mask) != 0) {
> -        Index2 = Sd->mRight[Index2];
> -      } else {
> -        Index2 = Sd->mLeft[Index2];
> -      }
> -
> -      Mask >>= 1;
> -    } while (Index2 >= 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 = (UINT16) (-1);
> -
> -  DataIdx     = 0;
> -
> -  for (;;) {
> -    //
> -    // Get one code from mBitBuf
> -    //
> -    CharC = DecodeC (Sd);
> -    if (Sd->mBadTableFlag != 0) {
> -      goto Done;
> -    }
> -
> -    if (CharC < 256) {
> -      //
> -      // Process an Original character
> -      //
> -      if (Sd->mOutBuf >= Sd->mOrigSize) {
> -        goto Done;
> -      } else {
> -        //
> -        // Write orignal character into mDstBase
> -        //
> -        Sd->mDstBase[Sd->mOutBuf++] = (UINT8) CharC;
> -      }
> -
> -    } else {
> -      //
> -      // Process a Pointer
> -      //
> -      CharC       = (UINT16) (CharC - (BIT8 - THRESHOLD));
> -
> -      //
> -      // Get string length
> -      //
> -      BytesRemain = CharC;
> -
> -      //
> -      // Locate string position
> -      //
> -      DataIdx     = Sd->mOutBuf - DecodeP (Sd) - 1;
> -
> -      //
> -      // Write BytesRemain of bytes into mDstBase
> -      //
> -      BytesRemain--;
> -      while ((INT16) (BytesRemain) >= 0) {
> -        if (Sd->mOutBuf >= Sd->mOrigSize) {
> -          goto Done ;
> -        }
> -        if (DataIdx >= Sd->mOrigSize) {
> -          Sd->mBadTableFlag = (UINT16) BAD_TABLE;
> -          goto Done ;
> -        }
> -        Sd->mDstBase[Sd->mOutBuf++] = Sd->mDstBase[DataIdx++];
> -
> -        BytesRemain--;
> -      }
> -      //
> -      // Once mOutBuf is fully filled, directly return
> -      //
> -      if (Sd->mOutBuf >= 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 buffer 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 is returned
> -  in ScratchSize, and RETURN_SUCCESS is returned.
> -  This function does not have scratch buffer available to perform a thorough
> -  checking of the validity of the source data.  It just retrieves the "Original 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 data.
> -  @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 buffer 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 of
> -                          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 != NULL);
> -  ASSERT (DestinationSize != NULL);
> -  ASSERT (ScratchSize != NULL);
> -
> -  if (SourceSize < 8) {
> -    return RETURN_INVALID_PARAMETER;
> -  }
> -
> -  CompressedSize   = ReadUnaligned32 ((UINT32 *)Source);
> -  if (SourceSize < (CompressedSize + 8) || (CompressedSize + 8) < 8) {
> -    return RETURN_INVALID_PARAMETER;
> -  }
> -
> -  *ScratchSize  = sizeof (SCRATCH_DATA);
> -  *DestinationSize = 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 allowed
> to
> -  call any memory allocation services in its implementation.  It is the caller'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 ASSERT().
> -
> -  @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 the
> -                      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 Destination.
> -  @retval  RETURN_INVALID_PARAMETER
> -                          The source buffer specified by Source is corrupted
> -                          (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 != NULL);
> -  ASSERT (Destination != NULL);
> -  ASSERT (Scratch != NULL);
> -
> -  Src     = Source;
> -  Dst     = Destination;
> -
> -  Sd = (SCRATCH_DATA *) Scratch;
> -
> -  CompSize  = Src[0] + (Src[1] << 8) + (Src[2] << 16) + (Src[3] << 24);
> -  OrigSize  = Src[4] + (Src[5] << 8) + (Src[6] << 16) + (Src[7] << 24);
> -
> -  //
> -  // If compressed file size is 0, return
> -  //
> -  if (OrigSize == 0) {
> -    return RETURN_SUCCESS;
> -  }
> -
> -  Src = Src + 8;
> -
> -  SetMem (Sd, sizeof (SCRATCH_DATA), 0);
> -
> -  //
> -  // The length of the field 'Position Set Code Length Array Size' in Block
> Header.
> -  // For UEFI 2.0 de/compression algorithm(Version 1), mPBit = 4
> -  // For Tiano de/compression algorithm(Version 2), mPBit = 5
> -  //
> -  switch (Version) {
> -    case 1 :
> -      Sd->mPBit = 4;
> -      break;
> -    case 2 :
> -      Sd->mPBit = 5;
> -      break;
> -    default:
> -      ASSERT (FALSE);
> -  }
> -  Sd->mSrcBase  = (UINT8 *)Src;
> -  Sd->mDstBase  = Dst;
> -  //
> -  // CompSize and OrigSize are calculated in bytes
> -  //
> -  Sd->mCompSize = CompSize;
> -  Sd->mOrigSize = OrigSize;
> -
> -  //
> -  // Fill the first BITBUFSIZ bits
> -  //
> -  FillBuf (Sd, BITBUFSIZ);
> -
> -  //
> -  // Decompress it
> -  //
> -  Decode (Sd);
> -
> -  if (Sd->mBadTableFlag != 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 allowed
> to
> -  call any memory allocation services in its implementation.  It is the caller'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 ASSERT().
> -
> -  @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 the
> -                      required scratch buffer size is 0.
> -
> -  @retval  RETURN_SUCCESS Decompression completed successfully, and
> -                          the uncompressed buffer is returned in Destination.
> -  @retval  RETURN_INVALID_PARAMETER
> -                          The source buffer specified by Source is corrupted
> -                          (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 and
> 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 supports,
> -  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, required as
> scratch space
> -                                 if the buffer specified by InputSection were decoded.
> -  @param[out] SectionAttribute   A pointer to the attributes of the GUIDed
> section. See the Attributes
> -                                 field of EFI_GUID_DEFINED_SECTION in the PI
> Specification.
> -
> -  @retval  RETURN_SUCCESS            The information about InputSection was
> returned.
> -  @retval  RETURN_UNSUPPORTED        The section specified by InputSection
> 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 != NULL);
> -
> -  if (InputSection == 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 = ((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 = ((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 supports,
> 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 buffer,
> 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 result of a
> decode operation.
> -  @param[in] ScratchBuffer  A caller allocated buffer that may be required by
> this function
> -                            as a scratch buffer to perform the decode operation.
> -  @param[out] AuthenticationStatus
> -                            A pointer to the authentication status of the decoded output
> buffer.
> -                            See the definition of authentication status in 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 InputSection
> 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 != NULL);
> -  ASSERT (InputSection != NULL);
> -
> -  if (IS_SECTION2 (InputSection)) {
> -    if (!CompareGuid (
> -        &gTianoCustomDecompressGuid,
> -        &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)-
> >SectionDefinitionGuid))) {
> -      return RETURN_INVALID_PARAMETER;
> -    }
> -
> -    //
> -    // Set Authentication to Zero.
> -    //
> -    *AuthenticationStatus = 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 = 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/BaseUefiTiano
> CustomDecompressLib.inf
> b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> CustomDecompressLib.inf
> deleted file mode 100644
> index c9c19d6d3c..0000000000
> ---
> a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> CustomDecompressLib.inf
> +++ /dev/null
> @@ -1,43 +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 - 2018, Intel Corporation. All rights reserved.<BR>
> -#
> -#  SPDX-License-Identifier: BSD-2-Clause-Patent
> -#
> -##
> -
> -[Defines]
> -  INF_VERSION                    = 0x00010005
> -  BASE_NAME                      = BaseUefiTianoDecompressLib
> -  MODULE_UNI_FILE                = BaseUefiTianoDecompressLib.uni
> -  FILE_GUID                      = d774c4d9-c121-4da3-a5e2-0f317e3c630c
> -  MODULE_TYPE                    = BASE
> -  VERSION_STRING                 = 1.0
> -  LIBRARY_CLASS                  = UefiDecompressLib
> -  CONSTRUCTOR                    = TianoDecompressLibConstructor
> -
> -#
> -# The following information is for reference only and not required by the build
> tools.
> -#
> -#  VALID_ARCHITECTURES           = IA32 X64 EBC
> -#
> -
> -[Sources]
> -  BaseUefiTianoCustomDecompressLibInternals.h
> -  BaseUefiTianoCustomDecompressLib.c
> -
> -[Packages]
> -  MdePkg/MdePkg.dec
> -  MdeModulePkg/MdeModulePkg.dec
> -
> -[LibraryClasses]
> -  BaseLib
> -  DebugLib
> -  BaseMemoryLib
> -  ExtractGuidedSectionLib
> -
> -[Guids]
> -  gTianoCustomDecompressGuid      ## PRODUCES  ## UNDEFINED # specifies
> tiano custom decompress algorithm.
> -
> diff --git
> a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> CustomDecompressLibInternals.h
> b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> CustomDecompressLibInternals.h
> deleted file mode 100644
> index 846abdb78e..0000000000
> ---
> a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> CustomDecompressLibInternals.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.<BR>
> -  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 <PiPei.h>
> -
> -#include <Guid/TianoDecompress.h>
> -#include <Library/BaseLib.h>
> -#include <Library/UefiDecompressLib.h>
> -#include <Library/DebugLib.h>
> -#include <Library/BaseMemoryLib.h>
> -#include <Library/ExtractGuidedSectionLib.h>
> -
> -//
> -// 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 Block
> Header.
> -  /// For UEFI 2.0 de/compression algorithm, mPBit = 4
> -  /// For Tiano de/compression algorithm, mPBit = 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 block
> 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/BaseUefiTiano
> DecompressLib.uni
> b/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> DecompressLib.uni
> deleted file mode 100644
> index c384dacbef..0000000000
> ---
> a/MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTiano
> DecompressLib.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.<BR>
> -//
> -// 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 b2fab4a65e..0a9fcddecc 100644
> --- a/MdeModulePkg/MdeModulePkg.dec
> +++ b/MdeModulePkg/MdeModulePkg.dec
> @@ -371,14 +371,10 @@ [Guids]
>    ## GUID indicates the LZMA custom compress/decompress algorithm.
>    #  Include/Guid/LzmaDecompress.h
>    gLzmaCustomDecompressGuid      = { 0xEE4E5898, 0x3914, 0x4259, { 0x9D,
> 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF }}
>    gLzmaF86CustomDecompressGuid     = { 0xD42AE6BD, 0x1352, 0x4bfb, { 0x90,
> 0x9A, 0xCA, 0x72, 0xA6, 0xEA, 0xE8, 0x89 }}
> 
> -  ## GUID indicates the tiano custom compress/decompress algorithm.
> -  #  Include/Guid/TianoDecompress.h
> -  gTianoCustomDecompressGuid     = { 0xA31280AD, 0x481E, 0x41B6, { 0x95,
> 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}
> -
>    ## Include/Guid/TtyTerm.h
>    gEfiTtyTermGuid                = { 0x7d916d80, 0x5bb1, 0x458c, {0xa4, 0x8f, 0xe2,
> 0x5f, 0xdd, 0x51, 0xef, 0x94 }}
> 
>    ## Include/Guid/HiiBootMaintenanceFormset.h
>    gEfiIfrBootMaintenanceGuid      = { 0xb2dedc91, 0xd59f, 0x48d2, { 0x89, 0x8a,
> 0x12, 0x49, 0xc, 0x74, 0xa4, 0xe0 }}
> diff --git a/MdeModulePkg/MdeModulePkg.dsc
> b/MdeModulePkg/MdeModulePkg.dsc
> index a8b9d8d027..ac7111dea1 100644
> --- a/MdeModulePkg/MdeModulePkg.dsc
> +++ b/MdeModulePkg/MdeModulePkg.dsc
> @@ -312,11 +312,10 @@ [Components]
>    MdeModulePkg/Library/FrameBufferBltLib/FrameBufferBltLib.inf
> 
> MdeModulePkg/Library/NonDiscoverableDeviceRegistrationLib/NonDiscoverab
> leDeviceRegistrationLib.inf
>    MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf
> 
> MdeModulePkg/Library/DisplayUpdateProgressLibGraphics/DisplayUpdateProg
> ressLibGraphics.inf
> 
> MdeModulePkg/Library/DisplayUpdateProgressLibText/DisplayUpdateProgress
> LibText.inf
> -
> MdeModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoC
> ustomDecompressLib.inf
> 
>    MdeModulePkg/Universal/BdsDxe/BdsDxe.inf
> 
> MdeModulePkg/Application/BootManagerMenuApp/BootManagerMenuApp.in
> f
>    MdeModulePkg/Application/UiApp/UiApp.inf{
>      <LibraryClasses>
> --
> 2.18.0.windows.1
> 
> 
>