batman-adv: Fix kerneldoc of main functions (7afcbbef) · Commits · EulixOS / Software / Kernel

net/batman-adv/bitarray.c

+9 −3

Original line number	Diff line number	Diff line
		@@ -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,

+5 −6

Original line number	Diff line number	Diff line
		@@ -25,7 +25,11 @@
		#include <linux/types.h>

		/**
		* batadv_test_bit
		* batadv_test_bit - check if bit is set in the current window
		*
		* @seq_bits: pointer to the sequence number receive packet
		* @last_seqno: latest sequence number in seq_bits
		* @curr_seqno: sequence number to test for
		*
		* Return: 1 if the corresponding bit in the given seq_bits indicates true
		* and curr_seqno is within range of last_seqno. Otherwise returns 0.
		@@ -51,11 +55,6 @@ static inline void batadv_set_bit(unsigned long *seq_bits, s32 n)
		set_bit(n, seq_bits); /* turn the position on */
		}

		/**
		* batadv_bit_get_packet - receive and process one packet
		*
		* Return: 1 if received seq_num is considered new, 0 if old
		*/
		int batadv_bit_get_packet(void priv, unsigned long seq_bits, s32 seq_num_diff,
		int set_mark);

+6 −0

Original line number	Diff line number	Diff line
		@@ -281,6 +281,8 @@ static int batadv_originators_open(struct inode inode, struct file file)
		* originator table of an hard interface
		* @inode: inode pointer to debugfs file
		* @file: pointer to the seq_file
		*
		* Return: 0 on success or negative error number in case of failure
		*/
		static int batadv_originators_hardif_open(struct inode *inode,
		struct file *file)
		@@ -329,6 +331,8 @@ static int batadv_bla_backbone_table_open(struct inode *inode,
		* batadv_dat_cache_open - Prepare file handler for reads from dat_chache
		* @inode: inode which was opened
		* @file: file handle to be initialized
		*
		* Return: 0 on success or negative error number in case of failure
		*/
		static int batadv_dat_cache_open(struct inode inode, struct file file)
		{
		@@ -483,6 +487,8 @@ void batadv_debugfs_destroy(void)
		* batadv_debugfs_add_hardif - creates the base directory for a hard interface
		* in debugfs.
		* @hard_iface: hard interface which should be added.
		*
		* Return: 0 on success or negative error number in case of failure
		*/
		int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
		{

+2 −0

Original line number	Diff line number	Diff line
		@@ -599,6 +599,8 @@ int batadv_algo_seq_print_text(struct seq_file seq, void offset)
		*
		* payload_ptr must always point to an address in the skb head buffer and not to
		* a fragment.
		*
		* Return: big endian crc32c of the checksummed data
		*/
		__be32 batadv_skb_crc32(struct sk_buff skb, u8 payload_ptr)
		{

+4 −0

Original line number	Diff line number	Diff line
		@@ -275,6 +275,8 @@ static inline void _batadv_dbg(int type __always_unused,

		/**
		* batadv_compare_eth - Compare two not u16 aligned Ethernet addresses
		* @data1: Pointer to a six-byte array containing the Ethernet address
		* @data2: Pointer other six-byte array containing the Ethernet address
		*
		* note: can't use ether_addr_equal() as it requires aligned memory
		*
		@@ -331,6 +333,8 @@ static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,

		/**
		* batadv_sum_counter - Sum the cpu-local counters for index 'idx'
		* @bat_priv: the bat priv with all the soft interface information
		* @idx: index of counter to sum up
		*
		* Return: sum of all cpu-local counters
		*/