Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / LzmaCustomDecompressLib / GuidedSectionExtraction.c

/** @file\r
  LZMA Decompress GUIDed Section Extraction Library\r
\r
  Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <Uefi.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
#include <Pi/PiFirmwareFile.h>\r
#include <Guid/LzmaDecompress.h>\r
\r
#include "LzmaDecompress.h"\r
\r
\r
STATIC\r
RETURN_STATUS\r
EFIAPI\r
LzmaGuidedSectionGetCompressedLocation (\r
  IN  CONST VOID  *InputSection,\r
  OUT VOID        **LmzaCompressedData,\r
  OUT UINT32      *LmzaCompressedDataSize   OPTIONAL\r
  )\r
{\r
  if (!CompareGuid (\r
        &gLzmaCustomDecompressGuid, \r
        &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
    return RETURN_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Retrieve the size and attribute of the input section data.\r
  //\r
  *LmzaCompressedData =\r
    (VOID*) (\r
        (UINT8 *) InputSection +\r
        ((EFI_GUID_DEFINED_SECTION *) InputSection)->DataOffset\r
      );\r
  if (LmzaCompressedDataSize != NULL) {\r
    *LmzaCompressedDataSize =\r
      (UINT32)(\r
        (\r
          (*(UINT32 *) (((EFI_COMMON_SECTION_HEADER *) InputSection)->Size)) &\r
          0x00ffffff\r
        ) -\r
        ((EFI_GUID_DEFINED_SECTION *) InputSection)->DataOffset\r
      );\r
  }\r
\r
  return RETURN_SUCCESS;\r
}\r
\r
\r
/**\r
  The implementation of 'GetInfo' for Guided Section\r
  Extraction of LZMA compression.\r
\r
  @param  InputSection          Buffer containing the input GUIDed section to be processed. \r
  @param  OutputBufferSize      The size of OutputBuffer.\r
  @param  ScratchBufferSize     The size of ScratchBuffer.\r
  @param  SectionAttribute      The attribute of the input guided section.\r
\r
  @retval RETURN_SUCCESS            The size of destination buffer and the size of scratch buffer are successull retrieved.\r
  @retval RETURN_INVALID_PARAMETER  The source data is corrupted, or\r
                                    The GUID in InputSection does not match this instance guid.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
LzmaGuidedSectionGetInfo (\r
  IN  CONST VOID  *InputSection,\r
  OUT UINT32      *OutputBufferSize,\r
  OUT UINT32      *ScratchBufferSize,\r
  OUT UINT16      *SectionAttribute\r
  )\r
{\r
  RETURN_STATUS Status;\r
  VOID          *LzmaInput;\r
  UINT32        LzmaInputSize;\r
\r
  Status = LzmaGuidedSectionGetCompressedLocation(\r
    InputSection,\r
    &LzmaInput,\r
    &LzmaInputSize\r
    );\r
  if (RETURN_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  *SectionAttribute = ((EFI_GUID_DEFINED_SECTION *) InputSection)->Attributes;\r
\r
  return LzmaUefiDecompressGetInfo (\r
    LzmaInput,\r
    LzmaInputSize,\r
    OutputBufferSize,\r
    ScratchBufferSize\r
    );\r
}\r
\r
/**\r
  The implementation of Guided Section Extraction\r
  for LZMA compression.\r
\r
  @param  InputSection          Buffer containing the input GUIDed section to be processed. \r
  @param  OutputBuffer          OutputBuffer to point to the start of the section's contents.\r
                                if guided data is not prcessed. Otherwise,\r
                                OutputBuffer to contain the output data, which is allocated by the caller.\r
  @param  ScratchBuffer         A pointer to a caller-allocated buffer for function internal use. \r
  @param  AuthenticationStatus  A pointer to a caller-allocated UINT32 that indicates the\r
                                authentication status of the output buffer. \r
\r
  @retval RETURN_SUCCESS            Decompression is successfull\r
  @retval RETURN_INVALID_PARAMETER  The source data is corrupted, or\r
                                    The GUID in InputSection does not match this instance guid.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
LzmaGuidedSectionExtraction (\r
  IN CONST  VOID    *InputSection,\r
  OUT       VOID    **OutputBuffer,\r
  IN        VOID    *ScratchBuffer,        OPTIONAL\r
  OUT       UINT32  *AuthenticationStatus\r
  )\r
{\r
  RETURN_STATUS Status;\r
  VOID          *LzmaInput;\r
\r
  Status = LzmaGuidedSectionGetCompressedLocation(\r
    InputSection,\r
    &LzmaInput,\r
    NULL\r
    );\r
  if (RETURN_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Authentication is set to Zero, which may be ignored.\r
  //\r
  *AuthenticationStatus = 0;\r
\r
  return LzmaUefiDecompress (\r
    LzmaInput,\r
    *OutputBuffer,\r
    ScratchBuffer\r
    );\r
}\r
\r
\r
/**\r
  Register LzmaDecompress handler.\r
\r
  @retval  RETURN_SUCCESS            Register successfully.\r
  @retval  RETURN_OUT_OF_RESOURCES   No enough memory to store this handler.\r
**/\r
EFI_STATUS\r
EFIAPI\r
LzmaDecompressLibConstructor (\r
  )\r
{\r
  return ExtractGuidedSectionRegisterHandlers (\r
          &gLzmaCustomDecompressGuid,\r
          LzmaGuidedSectionGetInfo,\r
          LzmaGuidedSectionExtraction\r
          );      \r
}\r
\r