summaryrefslogtreecommitdiff
path: root/net/batman-adv/bitarray.c
diff options
context:
space:
mode:
authorSven Eckelmann <sven@narfation.org>2015-10-31 14:29:29 +0300
committerAntonio Quartulli <a@unstable.cc>2016-02-02 07:40:31 +0300
commit7afcbbef6471130a1eb586fea0f5c06609b8341f (patch)
tree8ec74e3fa80fd8d79138299b7b6dfb98251307ab /net/batman-adv/bitarray.c
parent62fe710f6e2fdf4c337763bc0774cb3232fa2139 (diff)
downloadlinux-7afcbbef6471130a1eb586fea0f5c06609b8341f.tar.xz
batman-adv: Fix kerneldoc of main functions
Signed-off-by: Sven Eckelmann <sven@narfation.org> Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch> Signed-off-by: Antonio Quartulli <a@unstable.cc>
Diffstat (limited to 'net/batman-adv/bitarray.c')
-rw-r--r--net/batman-adv/bitarray.c12
1 files changed, 9 insertions, 3 deletions
diff --git a/net/batman-adv/bitarray.c b/net/batman-adv/bitarray.c
index 06bab5179bf9..3404195f2561 100644
--- a/net/batman-adv/bitarray.c
+++ b/net/batman-adv/bitarray.c
@@ -29,10 +29,16 @@ static void batadv_bitmap_shift_left(unsigned long *seq_bits, s32 n)
bitmap_shift_left(seq_bits, seq_bits, n, BATADV_TQ_LOCAL_WINDOW_SIZE);
}
-/* receive and process one packet within the sequence number window.
+/**
+ * batadv_bit_get_packet - receive and process one packet within the sequence
+ * number window
+ * @priv: the bat priv with all the soft interface information
+ * @seq_bits: pointer to the sequence number receive packet
+ * @seq_num_diff: difference between the current/received sequence number and
+ * the last sequence number
+ * @set_mark: whether this packet should be marked in seq_bits
*
- * Return:
- * 1 if the window was moved (either new or very old)
+ * Return: 1 if the window was moved (either new or very old),
* 0 if the window was not moved/shifted.
*/
int batadv_bit_get_packet(void *priv, unsigned long *seq_bits, s32 seq_num_diff,