MdePkg/Library/BaseCustomDecompressLibNull/BaseCustomDecompressLibNull.c

   1 /** @file
   2   Null implementation of the custom decompress library
   3
   4   Copyright (c) 2006 - 2007, Intel Corporation.<BR>
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include <Base.h>
  16 #include <Library/CustomDecompressLib.h>
  17
  18
  19 /**
  20   The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().
  21
  22   @param[in]     Source           The source buffer containing the compressed data.
  23   @param[in]     SourceSize       The size of source buffer
  24   @param[out]    DestinationSize  The size of destination buffer.
  25   @param[out]    ScratchSize      The size of scratch buffer.
  26
  27   @retval  RETURN_SUCCESS           The size of destination buffer and the size of scratch buffer are successull retrieved.
  28   @retval  RETURN_INVALID_PARAMETER The source data is corrupted
  29
  30 **/
  31 RETURN_STATUS
  32 EFIAPI
  33 CustomDecompressGetInfo (
  34   IN  CONST GUID  *DecompressGuid,
  35   IN  CONST VOID  *Source,
  36   IN  UINT32      SourceSize,
  37   OUT UINT32      *DestinationSize,
  38   OUT UINT32      *ScratchSize
  39   )
  40 {
  41   return RETURN_UNSUPPORTED;
  42 }
  43
  44
  45 /**
  46   The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().
  47
  48   @param[in]     Source           The source buffer containing the compressed data.
  49   @param[in]     Destination      The destination buffer to store the decompressed data
  50   @param[out]    Scratch          The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.
  51
  52
  53   @retval  RETURN_SUCCESS            Decompression is successfull
  54   @retval  RETURN_INVALID_PARAMETER The source data is corrupted
  55
  56 **/
  57 RETURN_STATUS
  58 EFIAPI
  59 CustomDecompress (
  60   IN const GUID  *DecompressGuid,
  61   IN CONST VOID  *Source,
  62   IN OUT VOID    *Destination,
  63   IN OUT VOID    *Scratch
  64   )
  65 {
  66   return RETURN_UNSUPPORTED;
  67 }
  68
  69 /**
  70   Get decompress method guid list.
  71
  72   @param[in, out]  AlgorithmGuidTable   The decompress method guid list.
  73   @param[in, out]  NumberOfAlgorithms   The number of decompress methods.
  74
  75   @retval  RETURN_SUCCESS            Get all algorithmes list successfully..
  76 **/
  77 RETURN_STATUS
  78 EFIAPI
  79 CustomDecompressGetAlgorithms (
  80    IN OUT  GUID   **AlgorithmGuidTable,
  81    IN OUT  UINTN  *NumberOfAlgorithms
  82   )
  83 {
  84   *NumberOfAlgorithms = 0;
  85   return RETURN_SUCCESS;
  86 }