EdkCompatibilityPkg: Fix typos in comments

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / CustomizedDecompress / CustomizedDecompress.h

/*++\r
\r
Copyright (c) 2004, 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
  CustomizedDecompress.h\r
\r
Abstract:\r
\r
  Header file for Customized decompression routine\r
  \r
--*/\r
#ifndef _CUSTOMIZED_DECOMPRESS_LIB_H_\r
#define _CUSTOMIZED_DECOMPRESS_LIB_H_\r
\r
#include EFI_PROTOCOL_DEFINITION (CustomizedDecompress)\r
\r
EFI_STATUS\r
EFIAPI\r
CustomizedGetInfo (\r
  IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL     *This,\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 of Customized GetInfo().\r
\r
Arguments:\r
  This        - The EFI customized decompress protocol\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
  EFI_UNSUPPORTED       - Not supported\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
CustomizedDecompress (\r
  IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL     *This,\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 of Customized 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
  EFI_UNSUPPORTED       - Not supported\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
InstallCustomizedDecompress (\r
  EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL  **This\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Install customeized decompress protocol.\r
\r
Arguments:\r
\r
  This                  - The protocol that needs to be installed.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Always success\r
\r
--*/\r
;\r
#endif\r