Tools/Source/TianoTools/Common/Crc32.h

   1 /*++
   2
   3 Copyright (c) 2004, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   Crc32.h
  15
  16 Abstract:
  17
  18   Header file for CalcuateCrc32 routine
  19
  20 --*/
  21
  22 #ifndef _CRC32_H
  23 #define _CRC32_H
  24
  25 #include <Common/UefiBaseTypes.h>
  26
  27 EFI_STATUS
  28 CalculateCrc32 (
  29   IN  UINT8                             *Data,
  30   IN  UINTN                             DataSize,
  31   IN OUT UINT32                         *CrcOut
  32   )
  33 /*++
  34
  35 Routine Description:
  36
  37   The CalculateCrc32 routine.
  38
  39 Arguments:
  40
  41   Data        - The buffer contaning the data to be processed
  42   DataSize    - The size of data to be processed
  43   CrcOut      - A pointer to the caller allocated UINT32 that on
  44                 contains the CRC32 checksum of Data
  45
  46 Returns:
  47
  48   EFI_SUCCESS               - Calculation is successful.
  49   EFI_INVALID_PARAMETER     - Data / CrcOut = NULL, or DataSize = 0
  50
  51 --*/
  52 ;
  53
  54 #endif