License header updated to match correct format.

[mirror_edk2.git] / BaseTools / Source / C / Common / Crc32.h

/** @file\r
Header file for CalcuateCrc32 routine\r
\r
Copyright (c) 2004 - 2014, 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
**/\r
\r
#ifndef _CRC32_H\r
#define _CRC32_H\r
\r
#include <Common/UefiBaseTypes.h>\r
\r
EFI_STATUS\r
CalculateCrc32 (\r
  IN  UINT8                             *Data,\r
  IN  UINTN                             DataSize,\r
  IN OUT UINT32                         *CrcOut\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The CalculateCrc32 routine.\r
\r
Arguments:\r
\r
  Data        - The buffer contaning the data to be processed\r
  DataSize    - The size of data to be processed\r
  CrcOut      - A pointer to the caller allocated UINT32 that on\r
                contains the CRC32 checksum of Data\r
\r
Returns:\r
\r
  EFI_SUCCESS               - Calculation is successful.\r
  EFI_INVALID_PARAMETER     - Data / CrcOut = NULL, or DataSize = 0\r
\r
--*/\r
;\r
\r
#endif\r