BaseTools/Source/C/Common/Crc32.h

   1 /** @file
   2 Header file for CalculateCrc32 routine
   3
   4 Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _CRC32_H
  10 #define _CRC32_H
  11
  12 #include <Common/UefiBaseTypes.h>
  13
  14 EFI_STATUS
  15 CalculateCrc32 (
  16   IN  UINT8                             *Data,
  17   IN  UINTN                             DataSize,
  18   IN OUT UINT32                         *CrcOut
  19   )
  20 /*++
  21
  22 Routine Description:
  23
  24   The CalculateCrc32 routine.
  25
  26 Arguments:
  27
  28   Data        - The buffer containing the data to be processed
  29   DataSize    - The size of data to be processed
  30   CrcOut      - A pointer to the caller allocated UINT32 that on
  31                 contains the CRC32 checksum of Data
  32
  33 Returns:
  34
  35   EFI_SUCCESS               - Calculation is successful.
  36   EFI_INVALID_PARAMETER     - Data / CrcOut = NULL, or DataSize = 0
  37
  38 --*/
  39 ;
  40
  41 #endif