batman-adv: Fix kerneldoc parsing of return description (62fe710f) · Commits · EulixOS / Software / Kernel

net/batman-adv/bat_iv_ogm.c

+9 −9

Original line number	Diff line number	Diff line
		@@ -88,7 +88,7 @@ static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value)
		* in the given ring buffer
		* @lq_recv: pointer to the ring buffer
		*
		* Returns computed average value.
		* Return: computed average value.
		*/
		static u8 batadv_ring_buffer_avg(const u8 lq_recv[])
		{
		@@ -132,7 +132,7 @@ static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
		* @orig_node: the orig_node that has to be changed
		* @max_if_num: the current amount of interfaces
		*
		* Returns 0 on success, a negative error code otherwise.
		* Return: 0 on success, a negative error code otherwise.
		*/
		static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
		int max_if_num)
		@@ -180,7 +180,7 @@ static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node,
		* @max_if_num: the current amount of interfaces
		* @del_if_num: the index of the interface being removed
		*
		* Returns 0 on success, a negative error code otherwise.
		* Return: 0 on success, a negative error code otherwise.
		*/
		static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
		int max_if_num, int del_if_num)
		@@ -246,7 +246,7 @@ static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
		* @bat_priv: the bat priv with all the soft interface information
		* @addr: mac address of the originator
		*
		* Returns the originator object corresponding to the passed mac address or NULL
		* Return: the originator object corresponding to the passed mac address or NULL
		* on failure.
		* If the object does not exists it is created an initialised.
		*/
		@@ -522,7 +522,7 @@ static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
		* @if_outgoing: interface for which the retransmission should be considered
		* @forw_packet: the forwarded packet which should be checked
		*
		* Returns true if new_packet can be aggregated with forw_packet
		* Return: true if new_packet can be aggregated with forw_packet
		*/
		static bool
		batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet,
		@@ -1125,7 +1125,7 @@ batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv,
		* @if_incoming: interface where the packet was received
		* @if_outgoing: interface for which the retransmission should be considered
		*
		* Returns 1 if the link can be considered bidirectional, 0 otherwise
		* Return: 1 if the link can be considered bidirectional, 0 otherwise
		*/
		static int batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
		struct batadv_orig_node *orig_neigh_node,
		@@ -1269,7 +1269,7 @@ static int batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node,
		* @if_incoming: interface on which the OGM packet was received
		* @if_outgoing: interface for which the retransmission should be considered
		*
		* Returns duplicate status as enum batadv_dup_status
		* Return: duplicate status as enum batadv_dup_status
		*/
		static enum batadv_dup_status
		batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr,
		@@ -1929,7 +1929,7 @@ static void batadv_iv_neigh_print(struct batadv_priv *bat_priv,
		* @neigh2: the second neighbor object of the comparison
		* @if_outgoing2: outgoing interface for the second neighbor
		*
		* Returns a value less, equal to or greater than 0 if the metric via neigh1 is
		* Return: a value less, equal to or greater than 0 if the metric via neigh1 is
		* lower, the same as or higher than the metric via neigh2
		*/
		static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
		@@ -1970,7 +1970,7 @@ static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
		* @neigh2: the second neighbor object of the comparison
		* @if_outgoing2: outgoing interface for the second neighbor
		*
		* Returns true if the metric via neigh1 is equally good or better than
		* Return: true if the metric via neigh1 is equally good or better than
		* the metric via neigh2, false otherwise.
		*/
		static bool

net/batman-adv/bitarray.c

+1 −1

Original line number	Diff line number	Diff line
		@@ -31,7 +31,7 @@ static void batadv_bitmap_shift_left(unsigned long *seq_bits, s32 n)

		/* receive and process one packet within the sequence number window.
		*
		* returns:
		* Return:
		* 1 if the window was moved (either new or very old)
		* 0 if the window was not moved/shifted.
		*/

net/batman-adv/bitarray.h

+8 −3

Original line number	Diff line number	Diff line
		@@ -24,7 +24,10 @@
		#include <linux/compiler.h>
		#include <linux/types.h>

		/* Returns 1 if the corresponding bit in the given seq_bits indicates true
		/**
		* batadv_test_bit
		*
		* 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.
		*/
		static inline int batadv_test_bit(const unsigned long *seq_bits,
		@@ -48,8 +51,10 @@ static inline void batadv_set_bit(unsigned long *seq_bits, s32 n)
		set_bit(n, seq_bits); /* turn the position on */
		}

		/* receive and process one packet, returns 1 if received seq_num is considered
		* new, 0 if old
		/**
		* 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);

net/batman-adv/bridge_loop_avoidance.c

+48 −20

Original line number	Diff line number	Diff line
		@@ -58,7 +58,11 @@ static void
		batadv_bla_send_announce(struct batadv_priv *bat_priv,
		struct batadv_bla_backbone_gw *backbone_gw);

		/* return the index of the claim */
		/**
		* batadv_choose_claim
		*
		* Return: the index of the claim
		*/
		static inline u32 batadv_choose_claim(const void *data, u32 size)
		{
		struct batadv_bla_claim claim = (struct batadv_bla_claim )data;
		@@ -70,7 +74,11 @@ static inline u32 batadv_choose_claim(const void *data, u32 size)
		return hash % size;
		}

		/* return the index of the backbone gateway */
		/**
		* batadv_choose_backbone_gw
		*
		* Return: the index of the backbone gateway
		*/
		static inline u32 batadv_choose_backbone_gw(const void *data, u32 size)
		{
		const struct batadv_bla_claim claim = (struct batadv_bla_claim )data;
		@@ -145,8 +153,9 @@ static void batadv_claim_free_ref(struct batadv_bla_claim *claim)
		* @bat_priv: the bat priv with all the soft interface information
		* @data: search data (may be local/static data)
		*
		* looks for a claim in the hash, and returns it if found
		* or NULL otherwise.
		* looks for a claim in the hash
		*
		* Return: claim if found or NULL otherwise.
		*/
		static struct batadv_bla_claim
		batadv_claim_hash_find(struct batadv_priv bat_priv,
		@@ -186,7 +195,7 @@ static struct batadv_bla_claim
		* @addr: the address of the originator
		* @vid: the VLAN ID
		*
		* Returns claim if found or NULL otherwise.
		* Return: claim if found or NULL otherwise.
		*/
		static struct batadv_bla_backbone_gw *
		batadv_backbone_hash_find(struct batadv_priv bat_priv, u8 addr,
		@@ -666,7 +675,11 @@ static void batadv_bla_del_claim(struct batadv_priv *bat_priv,
		batadv_claim_free_ref(claim);
		}

		/* check for ANNOUNCE frame, return 1 if handled */
		/**
		* batadv_handle_announce - check for ANNOUNCE frame
		*
		* Return: 1 if handled
		*/
		static int batadv_handle_announce(struct batadv_priv bat_priv, u8 an_addr,
		u8 *backbone_addr, unsigned short vid)
		{
		@@ -716,7 +729,11 @@ static int batadv_handle_announce(struct batadv_priv bat_priv, u8 an_addr,
		return 1;
		}

		/* check for REQUEST frame, return 1 if handled */
		/**
		* batadv_handle_request - check for REQUEST frame
		*
		* Return: 1 if handled
		*/
		static int batadv_handle_request(struct batadv_priv *bat_priv,
		struct batadv_hard_iface *primary_if,
		u8 backbone_addr, struct ethhdr ethhdr,
		@@ -740,7 +757,11 @@ static int batadv_handle_request(struct batadv_priv *bat_priv,
		return 1;
		}

		/* check for UNCLAIM frame, return 1 if handled */
		/**
		* batadv_handle_unclaim - check for UNCLAIM frame
		*
		* Return: 1 if handled
		*/
		static int batadv_handle_unclaim(struct batadv_priv *bat_priv,
		struct batadv_hard_iface *primary_if,
		u8 backbone_addr, u8 claim_addr,
		@@ -769,7 +790,11 @@ static int batadv_handle_unclaim(struct batadv_priv *bat_priv,
		return 1;
		}

		/* check for CLAIM frame, return 1 if handled */
		/**
		* batadv_handle_claim - check for CLAIM frame
		*
		* Return: 1 if handled
		*/
		static int batadv_handle_claim(struct batadv_priv *bat_priv,
		struct batadv_hard_iface *primary_if,
		u8 backbone_addr, u8 claim_addr,
		@@ -809,7 +834,7 @@ static int batadv_handle_claim(struct batadv_priv *bat_priv,
		* This function also applies the group ID of the sender
		* if it is in the same mesh.
		*
		* returns:
		* Return:
		* 2 - if it is a claim packet and on the same group
		* 1 - if is a claim packet from another group
		* 0 - if it is not a claim packet
		@@ -880,7 +905,7 @@ static int batadv_check_claim_group(struct batadv_priv *bat_priv,
		*
		* Check if this is a claim frame, and process it accordingly.
		*
		* returns 1 if it was a claim frame, otherwise return 0 to
		* Return: 1 if it was a claim frame, otherwise return 0 to
		* tell the callee that it can use the frame on its own.
		*/
		static int batadv_bla_process_claim(struct batadv_priv *bat_priv,
		@@ -1397,7 +1422,7 @@ int batadv_bla_check_bcast_duplist(struct batadv_priv *bat_priv,
		*
		* Check if the originator is a gateway for the VLAN identified by vid.
		*
		* Returns true if orig is a backbone for this vid, false otherwise.
		* Return: true if orig is a backbone for this vid, false otherwise.
		*/
		bool batadv_bla_is_backbone_gw_orig(struct batadv_priv bat_priv, u8 orig,
		unsigned short vid)
		@@ -1436,9 +1461,10 @@ bool batadv_bla_is_backbone_gw_orig(struct batadv_priv bat_priv, u8 orig,
		* @orig_node: the orig_node of the frame
		* @hdr_size: maximum length of the frame
		*
		* bla_is_backbone_gw inspects the skb for the VLAN ID and returns 1
		* if the orig_node is also a gateway on the soft interface, otherwise it
		* returns 0.
		* bla_is_backbone_gw inspects the skb for the VLAN ID
		*
		* Return: 1 if the orig_node is also a gateway on the soft interface, otherwise
		* it returns 0.
		*/
		int batadv_bla_is_backbone_gw(struct sk_buff *skb,
		struct batadv_orig_node *orig_node, int hdr_size)
		@@ -1498,8 +1524,9 @@ void batadv_bla_free(struct batadv_priv *bat_priv)
		* * we have to race for a claim
		* * if the frame is allowed on the LAN
		*
		* in these cases, the skb is further handled by this function and
		* returns 1, otherwise it returns 0 and the caller shall further
		* in these cases, the skb is further handled by this function
		*
		* Return: 1 if handled, otherwise it returns 0 and the caller shall further
		* process the skb.
		*/
		int batadv_bla_rx(struct batadv_priv bat_priv, struct sk_buff skb,
		@@ -1592,11 +1619,12 @@ int batadv_bla_rx(struct batadv_priv bat_priv, struct sk_buff skb,
		* * a claim was received which has to be processed
		* * the frame is allowed on the mesh
		*
		* in these cases, the skb is further handled by this function and
		* returns 1, otherwise it returns 0 and the caller shall further
		* process the skb.
		* in these cases, the skb is further handled by this function.
		*
		* This call might reallocate skb data.
		*
		* Return: 1 if handled, otherwise it returns 0 and the caller shall further
		* process the skb.
		*/
		int batadv_bla_tx(struct batadv_priv bat_priv, struct sk_buff skb,
		unsigned short vid)

net/batman-adv/distributed-arp-table.c

+19 −18

Original line number	Diff line number	Diff line
		@@ -76,7 +76,7 @@ static void batadv_dat_entry_free_ref(struct batadv_dat_entry *dat_entry)
		* batadv_dat_to_purge - check whether a dat_entry has to be purged or not
		* @dat_entry: the entry to check
		*
		* Returns true if the entry has to be purged now, false otherwise.
		* Return: true if the entry has to be purged now, false otherwise.
		*/
		static bool batadv_dat_to_purge(struct batadv_dat_entry *dat_entry)
		{
		@@ -151,7 +151,7 @@ static void batadv_dat_purge(struct work_struct *work)
		* @node: node in the local table
		* @data2: second object to compare the node to
		*
		* Returns 1 if the two entries are the same, 0 otherwise.
		* Return: 1 if the two entries are the same, 0 otherwise.
		*/
		static int batadv_compare_dat(const struct hlist_node node, const void data2)
		{
		@@ -166,7 +166,7 @@ static int batadv_compare_dat(const struct hlist_node node, const void data2)
		* @skb: ARP packet
		* @hdr_size: size of the possible header before the ARP packet
		*
		* Returns the value of the hw_src field in the ARP packet.
		* Return: the value of the hw_src field in the ARP packet.
		*/
		static u8 batadv_arp_hw_src(struct sk_buff skb, int hdr_size)
		{
		@@ -183,7 +183,7 @@ static u8 batadv_arp_hw_src(struct sk_buff skb, int hdr_size)
		* @skb: ARP packet
		* @hdr_size: size of the possible header before the ARP packet
		*
		* Returns the value of the ip_src field in the ARP packet.
		* Return: the value of the ip_src field in the ARP packet.
		*/
		static __be32 batadv_arp_ip_src(struct sk_buff *skb, int hdr_size)
		{
		@@ -195,7 +195,7 @@ static __be32 batadv_arp_ip_src(struct sk_buff *skb, int hdr_size)
		* @skb: ARP packet
		* @hdr_size: size of the possible header before the ARP packet
		*
		* Returns the value of the hw_dst field in the ARP packet.
		* Return: the value of the hw_dst field in the ARP packet.
		*/
		static u8 batadv_arp_hw_dst(struct sk_buff skb, int hdr_size)
		{
		@@ -207,7 +207,7 @@ static u8 batadv_arp_hw_dst(struct sk_buff skb, int hdr_size)
		* @skb: ARP packet
		* @hdr_size: size of the possible header before the ARP packet
		*
		* Returns the value of the ip_dst field in the ARP packet.
		* Return: the value of the ip_dst field in the ARP packet.
		*/
		static __be32 batadv_arp_ip_dst(struct sk_buff *skb, int hdr_size)
		{
		@@ -219,7 +219,7 @@ static __be32 batadv_arp_ip_dst(struct sk_buff *skb, int hdr_size)
		* @data: data to hash
		* @size: size of the hash table
		*
		* Returns the selected index in the hash table for the given data.
		* Return: the selected index in the hash table for the given data.
		*/
		static u32 batadv_hash_dat(const void *data, u32 size)
		{
		@@ -256,7 +256,7 @@ static u32 batadv_hash_dat(const void *data, u32 size)
		* @ip: search key
		* @vid: VLAN identifier
		*
		* Returns the dat_entry if found, NULL otherwise.
		* Return: the dat_entry if found, NULL otherwise.
		*/
		static struct batadv_dat_entry *
		batadv_dat_entry_hash_find(struct batadv_priv *bat_priv, __be32 ip,
		@@ -440,7 +440,7 @@ static void batadv_dbg_arp(struct batadv_priv bat_priv, struct sk_buff skb,
		* @candidate: orig_node under evaluation
		* @max_orig_node: last selected candidate
		*
		* Returns true if the node has been elected as next candidate or false
		* Return: true if the node has been elected as next candidate or false
		* otherwise.
		*/
		static bool batadv_is_orig_node_eligible(struct batadv_dat_candidate *res,
		@@ -558,7 +558,7 @@ static void batadv_choose_next_candidate(struct batadv_priv *bat_priv,
		* closest values (from the LEFT, with wrap around if needed) then the hash
		* value of the key. ip_dst is the key.
		*
		* Returns the candidate array of size BATADV_DAT_CANDIDATE_NUM.
		* Return: the candidate array of size BATADV_DAT_CANDIDATE_NUM.
		*/
		static struct batadv_dat_candidate *
		batadv_dat_select_candidates(struct batadv_priv *bat_priv, __be32 ip_dst)
		@@ -602,7 +602,7 @@ batadv_dat_select_candidates(struct batadv_priv *bat_priv, __be32 ip_dst)
		* This function copies the skb with pskb_copy() and is sent as unicast packet
		* to each of the selected candidates.
		*
		* Returns true if the packet is sent to at least one candidate, false
		* Return: true if the packet is sent to at least one candidate, false
		* otherwise.
		*/
		static bool batadv_dat_send_data(struct batadv_priv *bat_priv,
		@@ -831,7 +831,7 @@ int batadv_dat_cache_seq_print_text(struct seq_file seq, void offset)
		* @skb: packet to analyse
		* @hdr_size: size of the possible header before the ARP packet in the skb
		*
		* Returns the ARP type if the skb contains a valid ARP packet, 0 otherwise.
		* Return: the ARP type if the skb contains a valid ARP packet, 0 otherwise.
		*/
		static u16 batadv_arp_get_type(struct batadv_priv *bat_priv,
		struct sk_buff *skb, int hdr_size)
		@@ -904,8 +904,9 @@ static u16 batadv_arp_get_type(struct batadv_priv *bat_priv,
		* @skb: the buffer containing the packet to extract the VID from
		* @hdr_size: the size of the batman-adv header encapsulating the packet
		*
		* If the packet embedded in the skb is vlan tagged this function returns the
		* VID with the BATADV_VLAN_HAS_TAG flag. Otherwise BATADV_NO_FLAGS is returned.
		* Return: If the packet embedded in the skb is vlan tagged this function
		* returns the VID with the BATADV_VLAN_HAS_TAG flag. Otherwise BATADV_NO_FLAGS
		* is returned.
		*/
		static unsigned short batadv_dat_get_vid(struct sk_buff skb, int hdr_size)
		{
		@@ -930,7 +931,7 @@ static unsigned short batadv_dat_get_vid(struct sk_buff skb, int hdr_size)
		* @bat_priv: the bat priv with all the soft interface information
		* @skb: packet to check
		*
		* Returns true if the message has been sent to the dht candidates, false
		* Return: true if the message has been sent to the dht candidates, false
		* otherwise. In case of a positive return value the message has to be enqueued
		* to permit the fallback.
		*/
		@@ -1020,7 +1021,7 @@ bool batadv_dat_snoop_outgoing_arp_request(struct batadv_priv *bat_priv,
		* @skb: packet to check
		* @hdr_size: size of the encapsulation header
		*
		* Returns true if the request has been answered, false otherwise.
		* Return: true if the request has been answered, false otherwise.
		*/
		bool batadv_dat_snoop_incoming_arp_request(struct batadv_priv *bat_priv,
		struct sk_buff *skb, int hdr_size)
		@@ -1143,7 +1144,7 @@ void batadv_dat_snoop_outgoing_arp_reply(struct batadv_priv *bat_priv,
		* @skb: packet to check
		* @hdr_size: size of the encapsulation header
		*
		* Returns true if the packet was snooped and consumed by DAT. False if the
		* Return: true if the packet was snooped and consumed by DAT. False if the
		* packet has to be delivered to the interface
		*/
		bool batadv_dat_snoop_incoming_arp_reply(struct batadv_priv *bat_priv,
		@@ -1200,7 +1201,7 @@ bool batadv_dat_snoop_incoming_arp_reply(struct batadv_priv *bat_priv,
		* @bat_priv: the bat priv with all the soft interface information
		* @forw_packet: the broadcast packet
		*
		* Returns true if the node can drop the packet, false otherwise.
		* Return: true if the node can drop the packet, false otherwise.
		*/
		bool batadv_dat_drop_broadcast_packet(struct batadv_priv *bat_priv,
		struct batadv_forw_packet *forw_packet)