include/ext4_crc32.h

   1 /*
   2  * Copyright (c) 2014 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  * All rights reserved.
   4  *
   5  * Based on FreeBSD.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * - Redistributions of source code must retain the above copyright
  12  *   notice, this list of conditions and the following disclaimer.
  13  * - Redistributions in binary form must reproduce the above copyright
  14  *   notice, this list of conditions and the following disclaimer in the
  15  *   documentation and/or other materials provided with the distribution.
  16  * - The name of the author may not be used to endorse or promote products
  17  *   derived from this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 /** @addtogroup lwext4
  32  * @{
  33  */
  34 /**
  35  * @file  ext4_crc32.h
  36  * @brief Crc32c routine. Taken from FreeBSD kernel.
  37  */
  38
  39 #ifndef LWEXT4_EXT4_CRC32C_H_
  40 #define LWEXT4_EXT4_CRC32C_H_
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 #include "ext4_config.h"
  47
  48 #include <stdint.h>
  49
  50 /**@brief       CRC32 algorithm.
  51  * @param       crc input feed
  52  * @param       buf input buffer
  53  * @param       size input buffer length (bytes)
  54  * @return      updated crc32 value*/
  55 uint32_t ext4_crc32(uint32_t crc, const void *buf, uint32_t size);
  56
  57 /**@brief       CRC32C algorithm.
  58  * @param       crc input feed
  59  * @param       buf input buffer
  60  * @param       length input buffer length (bytes)
  61  * @return      updated crc32c value*/
  62 uint32_t ext4_crc32c(uint32_t crc, const void *buf, uint32_t size);
  63
  64 #ifdef __cplusplus
  65 }
  66 #endif
  67
  68 #endif /* LWEXT4_EXT4_CRC32C_H_ */
  69
  70 /**
  71  * @}
  72  */