clang-format: ext4
[lwext4.git] / lwext4 / ext4_crc32c.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_crc32c.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 #include <ext4_config.h>
43 #include <stdint.h>
44
45 /**@brief       CRC32C algorithm.
46  * @param       crc input feed
47  * @param       buffer input buffer
48  * @param       length input buffer length (bytes)
49  * @return      updated crc32c value*/
50 uint32_t ext4_crc32c(uint32_t crc, const void *buffer, uint32_t length);
51
52
53 #endif /* LWEXT4_EXT4_CRC32C_H_ */
54
55 /**
56  * @}
57  */
58