EdkCompatibilityPkg: Fix typos in comments

[mirror_edk2.git] / EdkCompatibilityPkg / Sample / Tools / Source / Common / Decompress.h

/*++\r
\r
Copyright (c) 2004 - 2006, Intel Corporation. All rights reserved.<BR>\r
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
Module Name:\r
\r
  Decompress.h\r
\r
Abstract:\r
\r
  Header file for decompression routine.\r
  Providing both EFI and Tiano decompress algorithms.\r
  \r
--*/\r
\r
#ifndef _DECOMPRESS_H_\r
#define _DECOMPRESS_H_\r
\r
EFI_STATUS\r
EFIAPI\r
EfiGetInfo (\r
  IN      VOID                    *Source,\r
  IN      UINT32                  SrcSize,\r
  OUT     UINT32                  *DstSize,\r
  OUT     UINT32                  *ScratchSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The implementation is same as that  of EFI_DECOMPRESS_PROTOCOL.GetInfo().\r
\r
Arguments:\r
\r
  This        - The protocol instance pointer\r
  Source      - The source buffer containing the compressed data.\r
  SrcSize     - The size of source buffer\r
  DstSize     - The size of destination buffer.\r
  ScratchSize - The size of scratch buffer.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - The size of destination buffer and the size of scratch buffer are successfully retrieved.\r
  EFI_INVALID_PARAMETER - The source data is corrupted\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
EfiDecompress (\r
  IN      VOID                    *Source,\r
  IN      UINT32                  SrcSize,\r
  IN OUT  VOID                    *Destination,\r
  IN      UINT32                  DstSize,\r
  IN OUT  VOID                    *Scratch,\r
  IN      UINT32                  ScratchSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The implementation is same as that of EFI_DECOMPRESS_PROTOCOL.Decompress().\r
\r
Arguments:\r
\r
  This        - The protocol instance pointer\r
  Source      - The source buffer containing the compressed data.\r
  SrcSize     - The size of source buffer\r
  Destination - The destination buffer to store the decompressed data\r
  DstSize     - The size of destination buffer.\r
  Scratch     - The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
  ScratchSize - The size of scratch buffer.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Decompression is successfull\r
  EFI_INVALID_PARAMETER - The source data is corrupted\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TianoGetInfo (\r
  IN      VOID                          *Source,\r
  IN      UINT32                        SrcSize,\r
  OUT     UINT32                        *DstSize,\r
  OUT     UINT32                        *ScratchSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The implementation is same as that of EFI_TIANO_DECOMPRESS_PROTOCOL.GetInfo().\r
\r
Arguments:\r
\r
  This        - The protocol instance pointer\r
  Source      - The source buffer containing the compressed data.\r
  SrcSize     - The size of source buffer\r
  DstSize     - The size of destination buffer.\r
  ScratchSize - The size of scratch buffer.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - The size of destination buffer and the size of scratch buffer are successfully retrieved.\r
  EFI_INVALID_PARAMETER - The source data is corrupted\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
TianoDecompress (\r
  IN      VOID                          *Source,\r
  IN      UINT32                        SrcSize,\r
  IN OUT  VOID                          *Destination,\r
  IN      UINT32                        DstSize,\r
  IN OUT  VOID                          *Scratch,\r
  IN      UINT32                        ScratchSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The implementation is same as that  of EFI_TIANO_DECOMPRESS_PROTOCOL.Decompress().\r
\r
Arguments:\r
\r
  This        - The protocol instance pointer\r
  Source      - The source buffer containing the compressed data.\r
  SrcSize     - The size of source buffer\r
  Destination - The destination buffer to store the decompressed data\r
  DstSize     - The size of destination buffer.\r
  Scratch     - The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
  ScratchSize - The size of scratch buffer.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Decompression is successfull\r
  EFI_INVALID_PARAMETER - The source data is corrupted\r
\r
--*/\r
;\r
\r
typedef\r
EFI_STATUS\r
(*GETINFO_FUNCTION) (\r
  IN      VOID    *Source,\r
  IN      UINT32  SrcSize,\r
  OUT     UINT32  *DstSize,\r
  OUT     UINT32  *ScratchSize\r
  );\r
\r
typedef\r
EFI_STATUS\r
(*DECOMPRESS_FUNCTION) (\r
  IN      VOID    *Source,\r
  IN      UINT32  SrcSize,\r
  IN OUT  VOID    *Destination,\r
  IN      UINT32  DstSize,\r
  IN OUT  VOID    *Scratch,\r
  IN      UINT32  ScratchSize\r
  );\r
\r
#endif\r