summaryrefslogtreecommitdiffstats
path: root/BaseTools/Source/C/Common/Crc32.h
blob: 3f6b5b35fc3618c0798976a7d19712fd63a7e510 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
/** @file
Header file for CalculateCrc32 routine

Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#ifndef _CRC32_H
#define _CRC32_H

#include <Common/UefiBaseTypes.h>

/**
  The CalculateCrc32 routine.

  @param Data        The buffer containing the data to be processed
  @param DataSize    The size of data to be processed
  @param CrcOut      A pointer to the caller allocated UINT32 that on
                    contains the CRC32 checksum of Data

  @retval EFI_SUCCESS               - Calculation is successful.
  @retval EFI_INVALID_PARAMETER     - Data / CrcOut = NULL, or DataSize = 0
**/
EFI_STATUS
CalculateCrc32 (
  IN  UINT8                             *Data,
  IN  UINTN                             DataSize,
  IN OUT UINT32                         *CrcOut
  )
;

#endif