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 /*
  23 #include "TianoCommon.h"
  24 */
  25 #include <Base.h>
  26 #include <UefiBaseTypes.h>
  27
  28 #ifndef _CRC32_H
  29 #define _CRC32_H
  30 EFI_STATUS
  31 CalculateCrc32 (
  32   IN  UINT8                             *Data,
  33   IN  UINTN                             DataSize,
  34   IN OUT UINT32                         *CrcOut
  35   )
  36 ;
  37
  38 /*++
  39
  40 Routine Description:
  41
  42   The CalculateCrc32 routine.
  43
  44 Arguments:
  45
  46   Data        - The buffer contaning the data to be processed
  47   DataSize    - The size of data to be processed
  48   CrcOut      - A pointer to the caller allocated UINT32 that on
  49                 contains the CRC32 checksum of Data
  50
  51 Returns:
  52
  53   EFI_SUCCESS               - Calculation is successful.
  54   EFI_INVALID_PARAMETER     - Data / CrcOut = NULL, or DataSize = 0
  55
  56 --*/
  57 #endif