Fixed comments to follow coding standard.

[mirror_edk2.git] / MdePkg / Library / BaseCustomDecompressLibNull / BaseCustomDecompressLibNull.c

/** @file\r
  Null implementation of the custom decompress library\r
\r
  Copyright (c) 2006 - 2007, 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 <Base.h>\r
#include <Library/CustomDecompressLib.h>\r
\r
\r
/**
  The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().\r

  @param[in]     Source           The source buffer containing the compressed data.
  @param[in]     SourceSize       The size of source buffer
  @param[out]    DestinationSize  The size of destination buffer.
  @param[out]    ScratchSize      The size of scratch buffer.

  @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

**/\r
RETURN_STATUS\r
EFIAPI\r
CustomDecompressGetInfo (\r
  IN  CONST VOID  *Source,\r
  IN  UINT32      SourceSize,\r
  OUT UINT32      *DestinationSize,\r
  OUT UINT32      *ScratchSize\r
  )\r
{\r
  return RETURN_UNSUPPORTED;\r
}\r
\r
\r
/**
  The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().\r

  @param[in]     Source           The source buffer containing the compressed data.
  @param[in]     Destination      The destination buffer to store the decompressed data
  @param[out]    Scratch          The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r


  @retval  RETURN_SUCCESS            Decompression is successfull\r
  @retval  RETURN_INVALID_PARAMETER The source data is corrupted

**/\r
RETURN_STATUS\r
EFIAPI\r
CustomDecompress (\r
  IN CONST VOID  *Source,\r
  IN OUT VOID    *Destination,\r
  IN OUT VOID    *Scratch\r
  )\r
{\r
  return RETURN_UNSUPPORTED;\r
}\r