]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - net/batman-adv/bitarray.h
batman-adv: Fix kerneldoc parsing of return description
[mirror_ubuntu-bionic-kernel.git] / net / batman-adv / bitarray.h
1 /* Copyright (C) 2006-2015 B.A.T.M.A.N. contributors:
2 *
3 * Simon Wunderlich, Marek Lindner
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
16 */
17
18 #ifndef _NET_BATMAN_ADV_BITARRAY_H_
19 #define _NET_BATMAN_ADV_BITARRAY_H_
20
21 #include "main.h"
22
23 #include <linux/bitops.h>
24 #include <linux/compiler.h>
25 #include <linux/types.h>
26
27 /**
28 * batadv_test_bit
29 *
30 * Return: 1 if the corresponding bit in the given seq_bits indicates true
31 * and curr_seqno is within range of last_seqno. Otherwise returns 0.
32 */
33 static inline int batadv_test_bit(const unsigned long *seq_bits,
34 u32 last_seqno, u32 curr_seqno)
35 {
36 s32 diff;
37
38 diff = last_seqno - curr_seqno;
39 if (diff < 0 || diff >= BATADV_TQ_LOCAL_WINDOW_SIZE)
40 return 0;
41 return test_bit(diff, seq_bits) != 0;
42 }
43
44 /* turn corresponding bit on, so we can remember that we got the packet */
45 static inline void batadv_set_bit(unsigned long *seq_bits, s32 n)
46 {
47 /* if too old, just drop it */
48 if (n < 0 || n >= BATADV_TQ_LOCAL_WINDOW_SIZE)
49 return;
50
51 set_bit(n, seq_bits); /* turn the position on */
52 }
53
54 /**
55 * batadv_bit_get_packet - receive and process one packet
56 *
57 * Return: 1 if received seq_num is considered new, 0 if old
58 */
59 int batadv_bit_get_packet(void *priv, unsigned long *seq_bits, s32 seq_num_diff,
60 int set_mark);
61
62 #endif /* _NET_BATMAN_ADV_BITARRAY_H_ */