BaseTools/Source/C/Common/Crc32.h

   1 /** @file
   2 Header file for CalcuateCrc32 routine
   3
   4 Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>
   5 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 #ifndef _CRC32_H
  16 #define _CRC32_H
  17
  18 #include <Common/UefiBaseTypes.h>
  19
  20 EFI_STATUS
  21 CalculateCrc32 (
  22   IN  UINT8                             *Data,
  23   IN  UINTN                             DataSize,
  24   IN OUT UINT32                         *CrcOut
  25   )
  26 /*++
  27
  28 Routine Description:
  29
  30   The CalculateCrc32 routine.
  31
  32 Arguments:
  33
  34   Data        - The buffer contaning the data to be processed
  35   DataSize    - The size of data to be processed
  36   CrcOut      - A pointer to the caller allocated UINT32 that on
  37                 contains the CRC32 checksum of Data
  38
  39 Returns:
  40
  41   EFI_SUCCESS               - Calculation is successful.
  42   EFI_INVALID_PARAMETER     - Data / CrcOut = NULL, or DataSize = 0
  43
  44 --*/
  45 ;
  46
  47 #endif