crc32.h revision 1c94c0a63ba68be1a7b2c640e70d7a06464e4fca
/** @file
* innotek Portable Runtime - CRC32.
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___iprt_crc32_h
#define ___iprt_crc32_h
#include <iprt/cdefs.h>
#include <iprt/types.h>
__BEGIN_DECLS
/** @defgroup grp_rt_crc32 RTCrc32 - CRC32 Calculation
* @ingroup grp_rt
* @{
*/
/**
* Calculate CRC32 for a memory block.
*
* @returns CRC32 for the memory block.
* @param pv Pointer to the memory block.
* @param cb Size of the memory block in bytes.
*/
RTDECL(uint32_t) RTCrc32(const void *pv, size_t cb);
/**
* Start a multiblock CRC32 calculation.
*
* @returns Start CRC32.
*/
RTDECL(uint32_t) RTCrc32Start(void);
/**
* Processes a multiblock of a CRC32 calculation.
*
* @returns Intermediate CRC32 value.
* @param uCRC32 Current CRC32 intermediate value.
* @param pv The data block to process.
* @param cb The size of the data block in bytes.
*/
RTDECL(uint32_t) RTCrc32Process(uint32_t uCRC32, const void *pv, size_t cb);
/**
* Complete a multiblock CRC32 calculation.
*
* @returns CRC32 value.
* @param uCRC32 Current CRC32 intermediate value.
*/
RTDECL(uint32_t) RTCrc32Finish(uint32_t uCRC32);
/** @} */
__END_DECLS
#endif