clang-format: lwext4 modules
[lwext4.git] / lwext4 / ext4_hash.h
1 /*\r
2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)\r
3  * All rights reserved.\r
4  *\r
5  * Redistribution and use in source and binary forms, with or without\r
6  * modification, are permitted provided that the following conditions\r
7  * are met:\r
8  *\r
9  * - Redistributions of source code must retain the above copyright\r
10  *   notice, this list of conditions and the following disclaimer.\r
11  * - Redistributions in binary form must reproduce the above copyright\r
12  *   notice, this list of conditions and the following disclaimer in the\r
13  *   documentation and/or other materials provided with the distribution.\r
14  * - The name of the author may not be used to endorse or promote products\r
15  *   derived from this software without specific prior written permission.\r
16  *\r
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR\r
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\r
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.\r
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,\r
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\r
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
27  */\r
28 \r
29 /** @addtogroup lwext4\r
30  * @{\r
31  */\r
32 /**\r
33  * @file  ext4_hash.h\r
34  * @brief Directory indexing hash functions.\r
35  */\r
36 \r
37 #ifndef EXT4_HASH_H_\r
38 #define EXT4_HASH_H_\r
39 \r
40 #include <ext4_config.h>\r
41 \r
42 #include <stdint.h>\r
43 \r
44 /**@brief   Directory entry name hash function.\r
45  * @param   name entry name\r
46  * @param   len entry name length\r
47  * @param   hash_seed (from superblock)\r
48  * @param   hash version (from superblock)\r
49  * @param   hash_minor output value\r
50  * @param   hash_major output value\r
51  * @return  standard error code*/\r
52 int ext2_htree_hash(const char *name, int len, const uint32_t *hash_seed,\r
53                     int hash_version, uint32_t *hash_major,\r
54                     uint32_t *hash_minor);\r
55 \r
56 #endif /* EXT4_HASH_H_ */\r
57 \r
58 /**\r
59  * @}\r
60  */\r