GitHub-Mirror/Star64_linux
2
0
Fork 0
mirror of https://github.com/Fishwaldo/Star64_linux.git synced 2025-06-29 01:51:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

batman-adv: Use parentheses in function kernel-doc

Browse source 
The documentation describing kernel-doc comments for functions ("How to
format kernel-doc comments") uses parentheses at the end of the function
name. Using this format allows to use a consistent style when adding
documentation to a function and when referencing this function in a
different kernel-doc section.

Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
This commit is contained in:
Sven Eckelmann 2017-12-02 19:51:47 +01:00 • committed by Simon Wunderlich
parent 6a3038f07c
commit 7e9a8c2ce7
34 changed files with 633 additions and 619 deletions
Download patch file Download diff file Expand all files Collapse all files

7
net/batman-adv/bat_algo.c
View file

@ -38,7 +38,8 @@ char batadv_routing_algo[20] = "BATMAN_IV";
static struct hlist_head batadv_algo_list; static struct hlist_head batadv_algo_list;
/** /**
* batadv_algo_init - Initialize batman-adv algorithm management data structures * batadv_algo_init() - Initialize batman-adv algorithm management data
* structures
*/ */
void batadv_algo_init(void) void batadv_algo_init(void)
{ {
@ -149,7 +150,7 @@ module_param_cb(routing_algo, &batadv_param_ops_ra, &batadv_param_string_ra,
0644); 0644);
/** /**
* batadv_algo_dump_entry - fill in information about one supported routing * batadv_algo_dump_entry() - fill in information about one supported routing
* algorithm * algorithm
* @msg: netlink message to be sent back * @msg: netlink message to be sent back
* @portid: Port to reply to * @portid: Port to reply to
@ -180,7 +181,7 @@ static int batadv_algo_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_algo_dump - fill in information about supported routing * batadv_algo_dump() - fill in information about supported routing
* algorithms * algorithms
* @msg: netlink message to be sent back * @msg: netlink message to be sent back
* @cb: Parameters to the netlink request * @cb: Parameters to the netlink request

80
net/batman-adv/bat_iv_ogm.c
View file

@ -87,7 +87,7 @@ enum batadv_dup_status {
}; };
/** /**
* batadv_ring_buffer_set - update the ring buffer with the given value * batadv_ring_buffer_set() - update the ring buffer with the given value
* @lq_recv: pointer to the ring buffer * @lq_recv: pointer to the ring buffer
* @lq_index: index to store the value at * @lq_index: index to store the value at
* @value: value to store in the ring buffer * @value: value to store in the ring buffer
@ -99,7 +99,7 @@ static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value)
} }
/** /**
* batadv_ring_buffer_avg - compute the average of all non-zero values stored * batadv_ring_buffer_avg() - compute the average of all non-zero values stored
* in the given ring buffer * in the given ring buffer
* @lq_recv: pointer to the ring buffer * @lq_recv: pointer to the ring buffer
* *
@ -131,7 +131,7 @@ static u8 batadv_ring_buffer_avg(const u8 lq_recv[])
} }
/** /**
* batadv_iv_ogm_orig_free - free the private resources allocated for this * batadv_iv_ogm_orig_free() - free the private resources allocated for this
* orig_node * orig_node
* @orig_node: the orig_node for which the resources have to be free'd * @orig_node: the orig_node for which the resources have to be free'd
*/ */
@ -142,8 +142,8 @@ static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
} }
/** /**
* batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to * batadv_iv_ogm_orig_add_if() - change the private structures of the orig_node
* include the new hard-interface * to include the new hard-interface
* @orig_node: the orig_node that has to be changed * @orig_node: the orig_node that has to be changed
* @max_if_num: the current amount of interfaces * @max_if_num: the current amount of interfaces
* *
@ -187,7 +187,7 @@ unlock:
} }
/** /**
* batadv_iv_ogm_drop_bcast_own_entry - drop section of bcast_own * batadv_iv_ogm_drop_bcast_own_entry() - drop section of bcast_own
* @orig_node: the orig_node that has to be changed * @orig_node: the orig_node that has to be changed
* @max_if_num: the current amount of interfaces * @max_if_num: the current amount of interfaces
* @del_if_num: the index of the interface being removed * @del_if_num: the index of the interface being removed
@ -225,7 +225,7 @@ batadv_iv_ogm_drop_bcast_own_entry(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_iv_ogm_drop_bcast_own_sum_entry - drop section of bcast_own_sum * batadv_iv_ogm_drop_bcast_own_sum_entry() - drop section of bcast_own_sum
* @orig_node: the orig_node that has to be changed * @orig_node: the orig_node that has to be changed
* @max_if_num: the current amount of interfaces * @max_if_num: the current amount of interfaces
* @del_if_num: the index of the interface being removed * @del_if_num: the index of the interface being removed
@ -260,8 +260,8 @@ batadv_iv_ogm_drop_bcast_own_sum_entry(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to * batadv_iv_ogm_orig_del_if() - change the private structures of the orig_node
* exclude the removed interface * to exclude the removed interface
* @orig_node: the orig_node that has to be changed * @orig_node: the orig_node that has to be changed
* @max_if_num: the current amount of interfaces * @max_if_num: the current amount of interfaces
* @del_if_num: the index of the interface being removed * @del_if_num: the index of the interface being removed
@ -291,7 +291,8 @@ static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator * batadv_iv_ogm_orig_get() - retrieve or create (if does not exist) an
* originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: mac address of the originator * @addr: mac address of the originator
* *
@ -448,7 +449,7 @@ static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv)
} }
/** /**
* batadv_iv_ogm_aggr_packet - checks if there is another OGM attached * batadv_iv_ogm_aggr_packet() - checks if there is another OGM attached
* @buff_pos: current position in the skb * @buff_pos: current position in the skb
* @packet_len: total length of the skb * @packet_len: total length of the skb
* @tvlv_len: tvlv length of the previously considered OGM * @tvlv_len: tvlv length of the previously considered OGM
@ -558,7 +559,7 @@ static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet)
} }
/** /**
* batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an * batadv_iv_ogm_can_aggregate() - find out if an OGM can be aggregated on an
* existing forward packet * existing forward packet
* @new_bat_ogm_packet: OGM packet to be aggregated * @new_bat_ogm_packet: OGM packet to be aggregated
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
@ -661,7 +662,7 @@ out:
} }
/** /**
* batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this * batadv_iv_ogm_aggregate_new() - create a new aggregated packet and add this
* packet to it. * packet to it.
* @packet_buff: pointer to the OGM * @packet_buff: pointer to the OGM
* @packet_len: (total) length of the OGM * @packet_len: (total) length of the OGM
@ -744,7 +745,7 @@ static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
} }
/** /**
* batadv_iv_ogm_queue_add - queue up an OGM for transmission * batadv_iv_ogm_queue_add() - queue up an OGM for transmission
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @packet_buff: pointer to the OGM * @packet_buff: pointer to the OGM
* @packet_len: (total) length of the OGM * @packet_len: (total) length of the OGM
@ -870,8 +871,8 @@ static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for * batadv_iv_ogm_slide_own_bcast_window() - bitshift own OGM broadcast windows
* the given interface * for the given interface
* @hard_iface: the interface for which the windows have to be shifted * @hard_iface: the interface for which the windows have to be shifted
*/ */
static void static void
@ -988,7 +989,7 @@ out:
} }
/** /**
* batadv_iv_ogm_orig_update - use OGM to update corresponding data in an * batadv_iv_ogm_orig_update() - use OGM to update corresponding data in an
* originator * originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: the orig node who originally emitted the ogm packet * @orig_node: the orig node who originally emitted the ogm packet
@ -1153,7 +1154,7 @@ out:
} }
/** /**
* batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet * batadv_iv_ogm_calc_tq() - calculate tq for current received ogm packet
* @orig_node: the orig node who originally emitted the ogm packet * @orig_node: the orig node who originally emitted the ogm packet
* @orig_neigh_node: the orig node struct of the neighbor who sent the packet * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
* @batadv_ogm_packet: the ogm packet * @batadv_ogm_packet: the ogm packet
@ -1299,7 +1300,7 @@ out:
} }
/** /**
* batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces, * batadv_iv_ogm_update_seqnos() - process a batman packet for all interfaces,
* adjust the sequence number and find out whether it is a duplicate * adjust the sequence number and find out whether it is a duplicate
* @ethhdr: ethernet header of the packet * @ethhdr: ethernet header of the packet
* @batadv_ogm_packet: OGM packet to be considered * @batadv_ogm_packet: OGM packet to be considered
@ -1402,7 +1403,8 @@ out:
} }
/** /**
* batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if * batadv_iv_ogm_process_per_outif() - process a batman iv OGM for an outgoing
* interface
* @skb: the skb containing the OGM * @skb: the skb containing the OGM
* @ogm_offset: offset from skb->data to start of ogm header * @ogm_offset: offset from skb->data to start of ogm header
* @orig_node: the (cached) orig node for the originator of this OGM * @orig_node: the (cached) orig node for the originator of this OGM
@ -1609,7 +1611,7 @@ out:
} }
/** /**
* batadv_iv_ogm_process - process an incoming batman iv OGM * batadv_iv_ogm_process() - process an incoming batman iv OGM
* @skb: the skb containing the OGM * @skb: the skb containing the OGM
* @ogm_offset: offset to the OGM which should be processed (for aggregates) * @ogm_offset: offset to the OGM which should be processed (for aggregates)
* @if_incoming: the interface where this packet was receved * @if_incoming: the interface where this packet was receved
@ -1862,7 +1864,7 @@ free_skb:
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table * batadv_iv_ogm_orig_print_neigh() - print neighbors for the originator table
* @orig_node: the orig_node for which the neighbors are printed * @orig_node: the orig_node for which the neighbors are printed
* @if_outgoing: outgoing interface for these entries * @if_outgoing: outgoing interface for these entries
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
@ -1891,7 +1893,7 @@ batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_iv_ogm_orig_print - print the originator table * batadv_iv_ogm_orig_print() - print the originator table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
* @if_outgoing: the outgoing interface for which this should be printed * @if_outgoing: the outgoing interface for which this should be printed
@ -1961,7 +1963,7 @@ next:
#endif #endif
/** /**
* batadv_iv_ogm_neigh_get_tq_avg - Get the TQ average for a neighbour on a * batadv_iv_ogm_neigh_get_tq_avg() - Get the TQ average for a neighbour on a
* given outgoing interface. * given outgoing interface.
* @neigh_node: Neighbour of interest * @neigh_node: Neighbour of interest
* @if_outgoing: Outgoing interface of interest * @if_outgoing: Outgoing interface of interest
@ -1987,7 +1989,7 @@ batadv_iv_ogm_neigh_get_tq_avg(struct batadv_neigh_node *neigh_node,
} }
/** /**
* batadv_iv_ogm_orig_dump_subentry - Dump an originator subentry into a * batadv_iv_ogm_orig_dump_subentry() - Dump an originator subentry into a
* message * message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
@ -2049,7 +2051,7 @@ batadv_iv_ogm_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_iv_ogm_orig_dump_entry - Dump an originator entry into a message * batadv_iv_ogm_orig_dump_entry() - Dump an originator entry into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -2111,7 +2113,7 @@ batadv_iv_ogm_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_iv_ogm_orig_dump_bucket - Dump an originator bucket into a * batadv_iv_ogm_orig_dump_bucket() - Dump an originator bucket into a
* message * message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
@ -2154,7 +2156,7 @@ batadv_iv_ogm_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_iv_ogm_orig_dump - Dump the originators into a message * batadv_iv_ogm_orig_dump() - Dump the originators into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
* @bat_priv: The bat priv with all the soft interface information * @bat_priv: The bat priv with all the soft interface information
@ -2191,7 +2193,7 @@ batadv_iv_ogm_orig_dump(struct sk_buff *msg, struct netlink_callback *cb,
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_iv_hardif_neigh_print - print a single hop neighbour node * batadv_iv_hardif_neigh_print() - print a single hop neighbour node
* @seq: neighbour table seq_file struct * @seq: neighbour table seq_file struct
* @hardif_neigh: hardif neighbour information * @hardif_neigh: hardif neighbour information
*/ */
@ -2210,7 +2212,7 @@ batadv_iv_hardif_neigh_print(struct seq_file *seq,
} }
/** /**
* batadv_iv_ogm_neigh_print - print the single hop neighbour list * batadv_iv_ogm_neigh_print() - print the single hop neighbour list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq: neighbour table seq_file struct * @seq: neighbour table seq_file struct
*/ */
@ -2243,7 +2245,7 @@ static void batadv_iv_neigh_print(struct batadv_priv *bat_priv,
#endif #endif
/** /**
* batadv_iv_ogm_neigh_diff - calculate tq difference of two neighbors * batadv_iv_ogm_neigh_diff() - calculate tq difference of two neighbors
* @neigh1: the first neighbor object of the comparison * @neigh1: the first neighbor object of the comparison
* @if_outgoing1: outgoing interface for the first neighbor * @if_outgoing1: outgoing interface for the first neighbor
* @neigh2: the second neighbor object of the comparison * @neigh2: the second neighbor object of the comparison
@ -2288,7 +2290,7 @@ out:
} }
/** /**
* batadv_iv_ogm_neigh_dump_neigh - Dump a neighbour into a netlink message * batadv_iv_ogm_neigh_dump_neigh() - Dump a neighbour into a netlink message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -2327,7 +2329,7 @@ batadv_iv_ogm_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_iv_ogm_neigh_dump_hardif - Dump the neighbours of a hard interface * batadv_iv_ogm_neigh_dump_hardif() - Dump the neighbours of a hard interface
* into a message * into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
@ -2366,7 +2368,7 @@ batadv_iv_ogm_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_iv_ogm_neigh_dump - Dump the neighbours into a message * batadv_iv_ogm_neigh_dump() - Dump the neighbours into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
* @bat_priv: The bat priv with all the soft interface information * @bat_priv: The bat priv with all the soft interface information
@ -2418,7 +2420,7 @@ batadv_iv_ogm_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb,
} }
/** /**
* batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors * batadv_iv_ogm_neigh_cmp() - compare the metrics of two neighbors
* @neigh1: the first neighbor object of the comparison * @neigh1: the first neighbor object of the comparison
* @if_outgoing1: outgoing interface for the first neighbor * @if_outgoing1: outgoing interface for the first neighbor
* @neigh2: the second neighbor object of the comparison * @neigh2: the second neighbor object of the comparison
@ -2444,7 +2446,7 @@ static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
} }
/** /**
* batadv_iv_ogm_neigh_is_sob - check if neigh1 is similarly good or better * batadv_iv_ogm_neigh_is_sob() - check if neigh1 is similarly good or better
* than neigh2 from the metric prospective * than neigh2 from the metric prospective
* @neigh1: the first neighbor object of the comparison * @neigh1: the first neighbor object of the comparison
* @if_outgoing1: outgoing interface for the first neighbor * @if_outgoing1: outgoing interface for the first neighbor
@ -2479,7 +2481,7 @@ static void batadv_iv_iface_activate(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_iv_init_sel_class - initialize GW selection class * batadv_iv_init_sel_class() - initialize GW selection class
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_iv_init_sel_class(struct batadv_priv *bat_priv) static void batadv_iv_init_sel_class(struct batadv_priv *bat_priv)
@ -2704,7 +2706,7 @@ static void batadv_iv_gw_print(struct batadv_priv *bat_priv,
#endif #endif
/** /**
* batadv_iv_gw_dump_entry - Dump a gateway into a message * batadv_iv_gw_dump_entry() - Dump a gateway into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -2775,7 +2777,7 @@ out:
} }
/** /**
* batadv_iv_gw_dump - Dump gateways into a message * batadv_iv_gw_dump() - Dump gateways into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
* @bat_priv: The bat priv with all the soft interface information * @bat_priv: The bat priv with all the soft interface information

48
net/batman-adv/bat_v.c
View file

@ -100,7 +100,7 @@ static void batadv_v_primary_iface_set(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_iface_update_mac - react to hard-interface MAC address change * batadv_v_iface_update_mac() - react to hard-interface MAC address change
* @hard_iface: the modified interface * @hard_iface: the modified interface
* *
* If the modified interface is the primary one, update the originator * If the modified interface is the primary one, update the originator
@ -131,7 +131,7 @@ batadv_v_hardif_neigh_init(struct batadv_hardif_neigh_node *hardif_neigh)
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_v_orig_print_neigh - print neighbors for the originator table * batadv_v_orig_print_neigh() - print neighbors for the originator table
* @orig_node: the orig_node for which the neighbors are printed * @orig_node: the orig_node for which the neighbors are printed
* @if_outgoing: outgoing interface for these entries * @if_outgoing: outgoing interface for these entries
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
@ -161,7 +161,7 @@ batadv_v_orig_print_neigh(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_v_hardif_neigh_print - print a single ELP neighbour node * batadv_v_hardif_neigh_print() - print a single ELP neighbour node
* @seq: neighbour table seq_file struct * @seq: neighbour table seq_file struct
* @hardif_neigh: hardif neighbour information * @hardif_neigh: hardif neighbour information
*/ */
@ -182,7 +182,7 @@ batadv_v_hardif_neigh_print(struct seq_file *seq,
} }
/** /**
* batadv_v_neigh_print - print the single hop neighbour list * batadv_v_neigh_print() - print the single hop neighbour list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq: neighbour table seq_file struct * @seq: neighbour table seq_file struct
*/ */
@ -216,7 +216,7 @@ static void batadv_v_neigh_print(struct batadv_priv *bat_priv,
#endif #endif
/** /**
* batadv_v_neigh_dump_neigh - Dump a neighbour into a message * batadv_v_neigh_dump_neigh() - Dump a neighbour into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -259,7 +259,7 @@ batadv_v_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_neigh_dump_hardif - Dump the neighbours of a hard interface into * batadv_v_neigh_dump_hardif() - Dump the neighbours of a hard interface into
* a message * a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
@ -297,7 +297,7 @@ batadv_v_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_neigh_dump - Dump the neighbours of a hard interface into a * batadv_v_neigh_dump() - Dump the neighbours of a hard interface into a
* message * message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
@ -349,7 +349,7 @@ batadv_v_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb,
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_v_orig_print - print the originator table * batadv_v_orig_print() - print the originator table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
* @if_outgoing: the outgoing interface for which this should be printed * @if_outgoing: the outgoing interface for which this should be printed
@ -417,8 +417,7 @@ next:
#endif #endif
/** /**
* batadv_v_orig_dump_subentry - Dump an originator subentry into a * batadv_v_orig_dump_subentry() - Dump an originator subentry into a message
* message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -484,7 +483,7 @@ batadv_v_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_orig_dump_entry - Dump an originator entry into a message * batadv_v_orig_dump_entry() - Dump an originator entry into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -537,8 +536,7 @@ batadv_v_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_orig_dump_bucket - Dump an originator bucket into a * batadv_v_orig_dump_bucket() - Dump an originator bucket into a message
* message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -579,7 +577,7 @@ batadv_v_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_orig_dump - Dump the originators into a message * batadv_v_orig_dump() - Dump the originators into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
* @bat_priv: The bat priv with all the soft interface information * @bat_priv: The bat priv with all the soft interface information
@ -669,7 +667,7 @@ err_ifinfo1:
} }
/** /**
* batadv_v_init_sel_class - initialize GW selection class * batadv_v_init_sel_class() - initialize GW selection class
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_v_init_sel_class(struct batadv_priv *bat_priv) static void batadv_v_init_sel_class(struct batadv_priv *bat_priv)
@ -705,7 +703,7 @@ static ssize_t batadv_v_show_sel_class(struct batadv_priv *bat_priv, char *buff)
} }
/** /**
* batadv_v_gw_throughput_get - retrieve the GW-bandwidth for a given GW * batadv_v_gw_throughput_get() - retrieve the GW-bandwidth for a given GW
* @gw_node: the GW to retrieve the metric for * @gw_node: the GW to retrieve the metric for
* @bw: the pointer where the metric will be stored. The metric is computed as * @bw: the pointer where the metric will be stored. The metric is computed as
* the minimum between the GW advertised throughput and the path throughput to * the minimum between the GW advertised throughput and the path throughput to
@ -748,7 +746,7 @@ out:
} }
/** /**
* batadv_v_gw_get_best_gw_node - retrieve the best GW node * batadv_v_gw_get_best_gw_node() - retrieve the best GW node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: the GW node having the best GW-metric, NULL if no GW is known * Return: the GW node having the best GW-metric, NULL if no GW is known
@ -786,7 +784,7 @@ next:
} }
/** /**
* batadv_v_gw_is_eligible - check if a originator would be selected as GW * batadv_v_gw_is_eligible() - check if a originator would be selected as GW
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @curr_gw_orig: originator representing the currently selected GW * @curr_gw_orig: originator representing the currently selected GW
* @orig_node: the originator representing the new candidate * @orig_node: the originator representing the new candidate
@ -885,7 +883,7 @@ out:
} }
/** /**
* batadv_v_gw_print - print the gateway list * batadv_v_gw_print() - print the gateway list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq: gateway table seq_file struct * @seq: gateway table seq_file struct
*/ */
@ -914,7 +912,7 @@ static void batadv_v_gw_print(struct batadv_priv *bat_priv,
#endif #endif
/** /**
* batadv_v_gw_dump_entry - Dump a gateway into a message * batadv_v_gw_dump_entry() - Dump a gateway into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -1005,7 +1003,7 @@ out:
} }
/** /**
* batadv_v_gw_dump - Dump gateways into a message * batadv_v_gw_dump() - Dump gateways into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
* @bat_priv: The bat priv with all the soft interface information * @bat_priv: The bat priv with all the soft interface information
@ -1075,7 +1073,7 @@ static struct batadv_algo_ops batadv_batman_v __read_mostly = {
}; };
/** /**
* batadv_v_hardif_init - initialize the algorithm specific fields in the * batadv_v_hardif_init() - initialize the algorithm specific fields in the
* hard-interface object * hard-interface object
* @hard_iface: the hard-interface to initialize * @hard_iface: the hard-interface to initialize
*/ */
@ -1089,7 +1087,7 @@ void batadv_v_hardif_init(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_mesh_init - initialize the B.A.T.M.A.N. V private resources for a * batadv_v_mesh_init() - initialize the B.A.T.M.A.N. V private resources for a
* mesh * mesh
* @bat_priv: the object representing the mesh interface to initialise * @bat_priv: the object representing the mesh interface to initialise
* *
@ -1107,7 +1105,7 @@ int batadv_v_mesh_init(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_v_mesh_free - free the B.A.T.M.A.N. V private resources for a mesh * batadv_v_mesh_free() - free the B.A.T.M.A.N. V private resources for a mesh
* @bat_priv: the object representing the mesh interface to free * @bat_priv: the object representing the mesh interface to free
*/ */
void batadv_v_mesh_free(struct batadv_priv *bat_priv) void batadv_v_mesh_free(struct batadv_priv *bat_priv)
@ -1116,7 +1114,7 @@ void batadv_v_mesh_free(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_v_init - B.A.T.M.A.N. V initialization function * batadv_v_init() - B.A.T.M.A.N. V initialization function
* *
* Description: Takes care of initializing all the subcomponents. * Description: Takes care of initializing all the subcomponents.
* It is invoked upon module load only. * It is invoked upon module load only.

24
net/batman-adv/bat_v_elp.c
View file

@ -53,7 +53,7 @@
#include "send.h" #include "send.h"
/** /**
* batadv_v_elp_start_timer - restart timer for ELP periodic work * batadv_v_elp_start_timer() - restart timer for ELP periodic work
* @hard_iface: the interface for which the timer has to be reset * @hard_iface: the interface for which the timer has to be reset
*/ */
static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface) static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)
@ -68,7 +68,7 @@ static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_elp_get_throughput - get the throughput towards a neighbour * batadv_v_elp_get_throughput() - get the throughput towards a neighbour
* @neigh: the neighbour for which the throughput has to be obtained * @neigh: the neighbour for which the throughput has to be obtained
* *
* Return: The throughput towards the given neighbour in multiples of 100kpbs * Return: The throughput towards the given neighbour in multiples of 100kpbs
@ -154,8 +154,8 @@ default_throughput:
} }
/** /**
* batadv_v_elp_throughput_metric_update - worker updating the throughput metric * batadv_v_elp_throughput_metric_update() - worker updating the throughput
* of a single hop neighbour * metric of a single hop neighbour
* @work: the work queue item * @work: the work queue item
*/ */
void batadv_v_elp_throughput_metric_update(struct work_struct *work) void batadv_v_elp_throughput_metric_update(struct work_struct *work)
@ -178,7 +178,7 @@ void batadv_v_elp_throughput_metric_update(struct work_struct *work)
} }
/** /**
* batadv_v_elp_wifi_neigh_probe - send link probing packets to a neighbour * batadv_v_elp_wifi_neigh_probe() - send link probing packets to a neighbour
* @neigh: the neighbour to probe * @neigh: the neighbour to probe
* *
* Sends a predefined number of unicast wifi packets to a given neighbour in * Sends a predefined number of unicast wifi packets to a given neighbour in
@ -241,7 +241,7 @@ batadv_v_elp_wifi_neigh_probe(struct batadv_hardif_neigh_node *neigh)
} }
/** /**
* batadv_v_elp_periodic_work - ELP periodic task per interface * batadv_v_elp_periodic_work() - ELP periodic task per interface
* @work: work queue item * @work: work queue item
* *
* Emits broadcast ELP message in regular intervals. * Emits broadcast ELP message in regular intervals.
@ -328,7 +328,7 @@ out:
} }
/** /**
* batadv_v_elp_iface_enable - setup the ELP interface private resources * batadv_v_elp_iface_enable() - setup the ELP interface private resources
* @hard_iface: interface for which the data has to be prepared * @hard_iface: interface for which the data has to be prepared
* *
* Return: 0 on success or a -ENOMEM in case of failure. * Return: 0 on success or a -ENOMEM in case of failure.
@ -376,7 +376,7 @@ out:
} }
/** /**
* batadv_v_elp_iface_disable - release ELP interface private resources * batadv_v_elp_iface_disable() - release ELP interface private resources
* @hard_iface: interface for which the resources have to be released * @hard_iface: interface for which the resources have to be released
*/ */
void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface) void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)
@ -388,7 +388,7 @@ void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_elp_iface_activate - update the ELP buffer belonging to the given * batadv_v_elp_iface_activate() - update the ELP buffer belonging to the given
* hard-interface * hard-interface
* @primary_iface: the new primary interface * @primary_iface: the new primary interface
* @hard_iface: interface holding the to-be-updated buffer * @hard_iface: interface holding the to-be-updated buffer
@ -409,7 +409,7 @@ void batadv_v_elp_iface_activate(struct batadv_hard_iface *primary_iface,
} }
/** /**
* batadv_v_elp_primary_iface_set - change internal data to reflect the new * batadv_v_elp_primary_iface_set() - change internal data to reflect the new
* primary interface * primary interface
* @primary_iface: the new primary interface * @primary_iface: the new primary interface
*/ */
@ -429,7 +429,7 @@ void batadv_v_elp_primary_iface_set(struct batadv_hard_iface *primary_iface)
} }
/** /**
* batadv_v_elp_neigh_update - update an ELP neighbour node * batadv_v_elp_neigh_update() - update an ELP neighbour node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @neigh_addr: the neighbour interface address * @neigh_addr: the neighbour interface address
* @if_incoming: the interface the packet was received through * @if_incoming: the interface the packet was received through
@ -489,7 +489,7 @@ orig_free:
} }
/** /**
* batadv_v_elp_packet_recv - main ELP packet handler * batadv_v_elp_packet_recv() - main ELP packet handler
* @skb: the received packet * @skb: the received packet
* @if_incoming: the interface this packet was received through * @if_incoming: the interface this packet was received through
* *

34
net/batman-adv/bat_v_ogm.c
View file

@ -52,7 +52,7 @@
#include "tvlv.h" #include "tvlv.h"
/** /**
* batadv_v_ogm_orig_get - retrieve and possibly create an originator node * batadv_v_ogm_orig_get() - retrieve and possibly create an originator node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the address of the originator * @addr: the address of the originator
* *
@ -89,7 +89,7 @@ struct batadv_orig_node *batadv_v_ogm_orig_get(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_v_ogm_start_timer - restart the OGM sending timer * batadv_v_ogm_start_timer() - restart the OGM sending timer
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv) static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv)
@ -108,7 +108,7 @@ static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_v_ogm_send_to_if - send a batman ogm using a given interface * batadv_v_ogm_send_to_if() - send a batman ogm using a given interface
* @skb: the OGM to send * @skb: the OGM to send
* @hard_iface: the interface to use to send the OGM * @hard_iface: the interface to use to send the OGM
*/ */
@ -128,7 +128,7 @@ static void batadv_v_ogm_send_to_if(struct sk_buff *skb,
} }
/** /**
* batadv_v_ogm_send - periodic worker broadcasting the own OGM * batadv_v_ogm_send() - periodic worker broadcasting the own OGM
* @work: work queue item * @work: work queue item
*/ */
static void batadv_v_ogm_send(struct work_struct *work) static void batadv_v_ogm_send(struct work_struct *work)
@ -236,7 +236,7 @@ out:
} }
/** /**
* batadv_v_ogm_iface_enable - prepare an interface for B.A.T.M.A.N. V * batadv_v_ogm_iface_enable() - prepare an interface for B.A.T.M.A.N. V
* @hard_iface: the interface to prepare * @hard_iface: the interface to prepare
* *
* Takes care of scheduling own OGM sending routine for this interface. * Takes care of scheduling own OGM sending routine for this interface.
@ -253,7 +253,7 @@ int batadv_v_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_ogm_primary_iface_set - set a new primary interface * batadv_v_ogm_primary_iface_set() - set a new primary interface
* @primary_iface: the new primary interface * @primary_iface: the new primary interface
*/ */
void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface) void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface)
@ -269,8 +269,8 @@ void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface)
} }
/** /**
* batadv_v_forward_penalty - apply a penalty to the throughput metric forwarded * batadv_v_forward_penalty() - apply a penalty to the throughput metric
* with B.A.T.M.A.N. V OGMs * forwarded with B.A.T.M.A.N. V OGMs
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @if_incoming: the interface where the OGM has been received * @if_incoming: the interface where the OGM has been received
* @if_outgoing: the interface where the OGM has to be forwarded to * @if_outgoing: the interface where the OGM has to be forwarded to
@ -315,7 +315,7 @@ static u32 batadv_v_forward_penalty(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_v_ogm_forward - check conditions and forward an OGM to the given * batadv_v_ogm_forward() - check conditions and forward an OGM to the given
* outgoing interface * outgoing interface
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ogm_received: previously received OGM to be forwarded * @ogm_received: previously received OGM to be forwarded
@ -406,7 +406,7 @@ out:
} }
/** /**
* batadv_v_ogm_metric_update - update route metric based on OGM * batadv_v_ogm_metric_update() - update route metric based on OGM
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ogm2: OGM2 structure * @ogm2: OGM2 structure
* @orig_node: Originator structure for which the OGM has been received * @orig_node: Originator structure for which the OGM has been received
@ -491,7 +491,7 @@ out:
} }
/** /**
* batadv_v_ogm_route_update - update routes based on OGM * batadv_v_ogm_route_update() - update routes based on OGM
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ethhdr: the Ethernet header of the OGM2 * @ethhdr: the Ethernet header of the OGM2
* @ogm2: OGM2 structure * @ogm2: OGM2 structure
@ -591,7 +591,7 @@ out:
} }
/** /**
* batadv_v_ogm_process_per_outif - process a batman v OGM for an outgoing if * batadv_v_ogm_process_per_outif() - process a batman v OGM for an outgoing if
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ethhdr: the Ethernet header of the OGM2 * @ethhdr: the Ethernet header of the OGM2
* @ogm2: OGM2 structure * @ogm2: OGM2 structure
@ -640,7 +640,7 @@ batadv_v_ogm_process_per_outif(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_v_ogm_aggr_packet - checks if there is another OGM aggregated * batadv_v_ogm_aggr_packet() - checks if there is another OGM aggregated
* @buff_pos: current position in the skb * @buff_pos: current position in the skb
* @packet_len: total length of the skb * @packet_len: total length of the skb
* @tvlv_len: tvlv length of the previously considered OGM * @tvlv_len: tvlv length of the previously considered OGM
@ -660,7 +660,7 @@ static bool batadv_v_ogm_aggr_packet(int buff_pos, int packet_len,
} }
/** /**
* batadv_v_ogm_process - process an incoming batman v OGM * batadv_v_ogm_process() - process an incoming batman v OGM
* @skb: the skb containing the OGM * @skb: the skb containing the OGM
* @ogm_offset: offset to the OGM which should be processed (for aggregates) * @ogm_offset: offset to the OGM which should be processed (for aggregates)
* @if_incoming: the interface where this packet was receved * @if_incoming: the interface where this packet was receved
@ -788,7 +788,7 @@ out:
} }
/** /**
* batadv_v_ogm_packet_recv - OGM2 receiving handler * batadv_v_ogm_packet_recv() - OGM2 receiving handler
* @skb: the received OGM * @skb: the received OGM
* @if_incoming: the interface where this OGM has been received * @if_incoming: the interface where this OGM has been received
* *
@ -852,7 +852,7 @@ free_skb:
} }
/** /**
* batadv_v_ogm_init - initialise the OGM2 engine * batadv_v_ogm_init() - initialise the OGM2 engine
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: 0 on success or a negative error code in case of failure * Return: 0 on success or a negative error code in case of failure
@ -885,7 +885,7 @@ int batadv_v_ogm_init(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_v_ogm_free - free OGM private resources * batadv_v_ogm_free() - free OGM private resources
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_v_ogm_free(struct batadv_priv *bat_priv) void batadv_v_ogm_free(struct batadv_priv *bat_priv)

2
net/batman-adv/bitarray.c
View file

@ -33,7 +33,7 @@ static void batadv_bitmap_shift_left(unsigned long *seq_bits, s32 n)
} }
/** /**
* batadv_bit_get_packet - receive and process one packet within the sequence * batadv_bit_get_packet() - receive and process one packet within the sequence
* number window * number window
* @priv: the bat priv with all the soft interface information * @priv: the bat priv with all the soft interface information
* @seq_bits: pointer to the sequence number receive packet * @seq_bits: pointer to the sequence number receive packet

2
net/batman-adv/bitarray.h
View file

@ -27,7 +27,7 @@
#include <linux/types.h> #include <linux/types.h>
/** /**
* batadv_test_bit - check if bit is set in the current window * batadv_test_bit() - check if bit is set in the current window
* *
* @seq_bits: pointer to the sequence number receive packet * @seq_bits: pointer to the sequence number receive packet
* @last_seqno: latest sequence number in seq_bits * @last_seqno: latest sequence number in seq_bits

109
net/batman-adv/bridge_loop_avoidance.c
View file

@ -70,7 +70,7 @@ batadv_bla_send_announce(struct batadv_priv *bat_priv,
struct batadv_bla_backbone_gw *backbone_gw); struct batadv_bla_backbone_gw *backbone_gw);
/** /**
* batadv_choose_claim - choose the right bucket for a claim. * batadv_choose_claim() - choose the right bucket for a claim.
* @data: data to hash * @data: data to hash
* @size: size of the hash table * @size: size of the hash table
* *
@ -88,7 +88,7 @@ static inline u32 batadv_choose_claim(const void *data, u32 size)
} }
/** /**
* batadv_choose_backbone_gw - choose the right bucket for a backbone gateway. * batadv_choose_backbone_gw() - choose the right bucket for a backbone gateway.
* @data: data to hash * @data: data to hash
* @size: size of the hash table * @size: size of the hash table
* *
@ -106,7 +106,7 @@ static inline u32 batadv_choose_backbone_gw(const void *data, u32 size)
} }
/** /**
* batadv_compare_backbone_gw - compare address and vid of two backbone gws * batadv_compare_backbone_gw() - compare address and vid of two backbone gws
* @node: list node of the first entry to compare * @node: list node of the first entry to compare
* @data2: pointer to the second backbone gateway * @data2: pointer to the second backbone gateway
* *
@ -130,7 +130,7 @@ static bool batadv_compare_backbone_gw(const struct hlist_node *node,
} }
/** /**
* batadv_compare_claim - compare address and vid of two claims * batadv_compare_claim() - compare address and vid of two claims
* @node: list node of the first entry to compare * @node: list node of the first entry to compare
* @data2: pointer to the second claims * @data2: pointer to the second claims
* *
@ -154,7 +154,7 @@ static bool batadv_compare_claim(const struct hlist_node *node,
} }
/** /**
* batadv_backbone_gw_release - release backbone gw from lists and queue for * batadv_backbone_gw_release() - release backbone gw from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the backbone gw * @ref: kref pointer of the backbone gw
*/ */
@ -169,7 +169,7 @@ static void batadv_backbone_gw_release(struct kref *ref)
} }
/** /**
* batadv_backbone_gw_put - decrement the backbone gw refcounter and possibly * batadv_backbone_gw_put() - decrement the backbone gw refcounter and possibly
* release it * release it
* @backbone_gw: backbone gateway to be free'd * @backbone_gw: backbone gateway to be free'd
*/ */
@ -179,8 +179,8 @@ static void batadv_backbone_gw_put(struct batadv_bla_backbone_gw *backbone_gw)
} }
/** /**
* batadv_claim_release - release claim from lists and queue for free after rcu * batadv_claim_release() - release claim from lists and queue for free after
* grace period * rcu grace period
* @ref: kref pointer of the claim * @ref: kref pointer of the claim
*/ */
static void batadv_claim_release(struct kref *ref) static void batadv_claim_release(struct kref *ref)
@ -205,8 +205,7 @@ static void batadv_claim_release(struct kref *ref)
} }
/** /**
* batadv_claim_put - decrement the claim refcounter and possibly * batadv_claim_put() - decrement the claim refcounter and possibly release it
* release it
* @claim: claim to be free'd * @claim: claim to be free'd
*/ */
static void batadv_claim_put(struct batadv_bla_claim *claim) static void batadv_claim_put(struct batadv_bla_claim *claim)
@ -215,7 +214,7 @@ static void batadv_claim_put(struct batadv_bla_claim *claim)
} }
/** /**
* batadv_claim_hash_find - looks for a claim in the claim hash * batadv_claim_hash_find() - looks for a claim in the claim hash
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @data: search data (may be local/static data) * @data: search data (may be local/static data)
* *
@ -254,7 +253,7 @@ batadv_claim_hash_find(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_backbone_hash_find - looks for a backbone gateway in the hash * batadv_backbone_hash_find() - looks for a backbone gateway in the hash
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the address of the originator * @addr: the address of the originator
* @vid: the VLAN ID * @vid: the VLAN ID
@ -298,7 +297,7 @@ batadv_backbone_hash_find(struct batadv_priv *bat_priv, u8 *addr,
} }
/** /**
* batadv_bla_del_backbone_claims - delete all claims for a backbone * batadv_bla_del_backbone_claims() - delete all claims for a backbone
* @backbone_gw: backbone gateway where the claims should be removed * @backbone_gw: backbone gateway where the claims should be removed
*/ */
static void static void
@ -338,7 +337,7 @@ batadv_bla_del_backbone_claims(struct batadv_bla_backbone_gw *backbone_gw)
} }
/** /**
* batadv_bla_send_claim - sends a claim frame according to the provided info * batadv_bla_send_claim() - sends a claim frame according to the provided info
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @mac: the mac address to be announced within the claim * @mac: the mac address to be announced within the claim
* @vid: the VLAN ID * @vid: the VLAN ID
@ -458,7 +457,7 @@ out:
} }
/** /**
* batadv_bla_loopdetect_report - worker for reporting the loop * batadv_bla_loopdetect_report() - worker for reporting the loop
* @work: work queue item * @work: work queue item
* *
* Throws an uevent, as the loopdetect check function can't do that itself * Throws an uevent, as the loopdetect check function can't do that itself
@ -488,7 +487,7 @@ static void batadv_bla_loopdetect_report(struct work_struct *work)
} }
/** /**
* batadv_bla_get_backbone_gw - finds or creates a backbone gateway * batadv_bla_get_backbone_gw() - finds or creates a backbone gateway
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the mac address of the originator * @orig: the mac address of the originator
* @vid: the VLAN ID * @vid: the VLAN ID
@ -561,7 +560,7 @@ batadv_bla_get_backbone_gw(struct batadv_priv *bat_priv, u8 *orig,
} }
/** /**
* batadv_bla_update_own_backbone_gw - updates the own backbone gw for a VLAN * batadv_bla_update_own_backbone_gw() - updates the own backbone gw for a VLAN
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: the selected primary interface * @primary_if: the selected primary interface
* @vid: VLAN identifier * @vid: VLAN identifier
@ -587,7 +586,7 @@ batadv_bla_update_own_backbone_gw(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_bla_answer_request - answer a bla request by sending own claims * batadv_bla_answer_request() - answer a bla request by sending own claims
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: interface where the request came on * @primary_if: interface where the request came on
* @vid: the vid where the request came on * @vid: the vid where the request came on
@ -637,7 +636,7 @@ static void batadv_bla_answer_request(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_bla_send_request - send a request to repeat claims * batadv_bla_send_request() - send a request to repeat claims
* @backbone_gw: the backbone gateway from whom we are out of sync * @backbone_gw: the backbone gateway from whom we are out of sync
* *
* When the crc is wrong, ask the backbone gateway for a full table update. * When the crc is wrong, ask the backbone gateway for a full table update.
@ -664,7 +663,7 @@ static void batadv_bla_send_request(struct batadv_bla_backbone_gw *backbone_gw)
} }
/** /**
* batadv_bla_send_announce - Send an announcement frame * batadv_bla_send_announce() - Send an announcement frame
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @backbone_gw: our backbone gateway which should be announced * @backbone_gw: our backbone gateway which should be announced
*/ */
@ -685,7 +684,7 @@ static void batadv_bla_send_announce(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_bla_add_claim - Adds a claim in the claim hash * batadv_bla_add_claim() - Adds a claim in the claim hash
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @mac: the mac address of the claim * @mac: the mac address of the claim
* @vid: the VLAN ID of the frame * @vid: the VLAN ID of the frame
@ -775,7 +774,7 @@ claim_free_ref:
} }
/** /**
* batadv_bla_claim_get_backbone_gw - Get valid reference for backbone_gw of * batadv_bla_claim_get_backbone_gw() - Get valid reference for backbone_gw of
* claim * claim
* @claim: claim whose backbone_gw should be returned * @claim: claim whose backbone_gw should be returned
* *
@ -795,7 +794,7 @@ batadv_bla_claim_get_backbone_gw(struct batadv_bla_claim *claim)
} }
/** /**
* batadv_bla_del_claim - delete a claim from the claim hash * batadv_bla_del_claim() - delete a claim from the claim hash
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @mac: mac address of the claim to be removed * @mac: mac address of the claim to be removed
* @vid: VLAN id for the claim to be removed * @vid: VLAN id for the claim to be removed
@ -823,7 +822,7 @@ static void batadv_bla_del_claim(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_handle_announce - check for ANNOUNCE frame * batadv_handle_announce() - check for ANNOUNCE frame
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @an_addr: announcement mac address (ARP Sender HW address) * @an_addr: announcement mac address (ARP Sender HW address)
* @backbone_addr: originator address of the sender (Ethernet source MAC) * @backbone_addr: originator address of the sender (Ethernet source MAC)
@ -881,7 +880,7 @@ static bool batadv_handle_announce(struct batadv_priv *bat_priv, u8 *an_addr,
} }
/** /**
* batadv_handle_request - check for REQUEST frame * batadv_handle_request() - check for REQUEST frame
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: the primary hard interface of this batman soft interface * @primary_if: the primary hard interface of this batman soft interface
* @backbone_addr: backbone address to be requested (ARP sender HW MAC) * @backbone_addr: backbone address to be requested (ARP sender HW MAC)
@ -914,7 +913,7 @@ static bool batadv_handle_request(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_handle_unclaim - check for UNCLAIM frame * batadv_handle_unclaim() - check for UNCLAIM frame
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: the primary hard interface of this batman soft interface * @primary_if: the primary hard interface of this batman soft interface
* @backbone_addr: originator address of the backbone (Ethernet source) * @backbone_addr: originator address of the backbone (Ethernet source)
@ -952,7 +951,7 @@ static bool batadv_handle_unclaim(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_handle_claim - check for CLAIM frame * batadv_handle_claim() - check for CLAIM frame
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: the primary hard interface of this batman soft interface * @primary_if: the primary hard interface of this batman soft interface
* @backbone_addr: originator address of the backbone (Ethernet Source) * @backbone_addr: originator address of the backbone (Ethernet Source)
@ -989,7 +988,7 @@ static bool batadv_handle_claim(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_check_claim_group - check for claim group membership * batadv_check_claim_group() - check for claim group membership
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: the primary interface of this batman interface * @primary_if: the primary interface of this batman interface
* @hw_src: the Hardware source in the ARP Header * @hw_src: the Hardware source in the ARP Header
@ -1064,7 +1063,7 @@ static int batadv_check_claim_group(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_bla_process_claim - Check if this is a claim frame, and process it * batadv_bla_process_claim() - Check if this is a claim frame, and process it
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: the primary hard interface of this batman soft interface * @primary_if: the primary hard interface of this batman soft interface
* @skb: the frame to be checked * @skb: the frame to be checked
@ -1206,7 +1205,7 @@ static bool batadv_bla_process_claim(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_bla_purge_backbone_gw - Remove backbone gateways after a timeout or * batadv_bla_purge_backbone_gw() - Remove backbone gateways after a timeout or
* immediately * immediately
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @now: whether the whole hash shall be wiped now * @now: whether the whole hash shall be wiped now
@ -1259,7 +1258,7 @@ purge_now:
} }
/** /**
* batadv_bla_purge_claims - Remove claims after a timeout or immediately * batadv_bla_purge_claims() - Remove claims after a timeout or immediately
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: the selected primary interface, may be NULL if now is set * @primary_if: the selected primary interface, may be NULL if now is set
* @now: whether the whole hash shall be wiped now * @now: whether the whole hash shall be wiped now
@ -1317,7 +1316,7 @@ skip:
} }
/** /**
* batadv_bla_update_orig_address - Update the backbone gateways when the own * batadv_bla_update_orig_address() - Update the backbone gateways when the own
* originator address changes * originator address changes
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: the new selected primary_if * @primary_if: the new selected primary_if
@ -1373,7 +1372,7 @@ void batadv_bla_update_orig_address(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_bla_send_loopdetect - send a loopdetect frame * batadv_bla_send_loopdetect() - send a loopdetect frame
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @backbone_gw: the backbone gateway for which a loop should be detected * @backbone_gw: the backbone gateway for which a loop should be detected
* *
@ -1393,7 +1392,7 @@ batadv_bla_send_loopdetect(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_bla_status_update - purge bla interfaces if necessary * batadv_bla_status_update() - purge bla interfaces if necessary
* @net_dev: the soft interface net device * @net_dev: the soft interface net device
*/ */
void batadv_bla_status_update(struct net_device *net_dev) void batadv_bla_status_update(struct net_device *net_dev)
@ -1413,7 +1412,7 @@ void batadv_bla_status_update(struct net_device *net_dev)
} }
/** /**
* batadv_bla_periodic_work - performs periodic bla work * batadv_bla_periodic_work() - performs periodic bla work
* @work: kernel work struct * @work: kernel work struct
* *
* periodic work to do: * periodic work to do:
@ -1518,7 +1517,7 @@ static struct lock_class_key batadv_claim_hash_lock_class_key;
static struct lock_class_key batadv_backbone_hash_lock_class_key; static struct lock_class_key batadv_backbone_hash_lock_class_key;
/** /**
* batadv_bla_init - initialize all bla structures * batadv_bla_init() - initialize all bla structures
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: 0 on success, < 0 on error. * Return: 0 on success, < 0 on error.
@ -1580,7 +1579,7 @@ int batadv_bla_init(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_bla_check_bcast_duplist - Check if a frame is in the broadcast dup. * batadv_bla_check_bcast_duplist() - Check if a frame is in the broadcast dup.
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: contains the bcast_packet to be checked * @skb: contains the bcast_packet to be checked
* *
@ -1653,7 +1652,7 @@ out:
} }
/** /**
* batadv_bla_is_backbone_gw_orig - Check if the originator is a gateway for * batadv_bla_is_backbone_gw_orig() - Check if the originator is a gateway for
* the VLAN identified by vid. * the VLAN identified by vid.
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: originator mac address * @orig: originator mac address
@ -1693,7 +1692,7 @@ bool batadv_bla_is_backbone_gw_orig(struct batadv_priv *bat_priv, u8 *orig,
} }
/** /**
* batadv_bla_is_backbone_gw - check if originator is a backbone gw for a VLAN. * batadv_bla_is_backbone_gw() - check if originator is a backbone gw for a VLAN
* @skb: the frame to be checked * @skb: the frame to be checked
* @orig_node: the orig_node of the frame * @orig_node: the orig_node of the frame
* @hdr_size: maximum length of the frame * @hdr_size: maximum length of the frame
@ -1727,7 +1726,7 @@ bool batadv_bla_is_backbone_gw(struct sk_buff *skb,
} }
/** /**
* batadv_bla_free - free all bla structures * batadv_bla_free() - free all bla structures
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* for softinterface free or module unload * for softinterface free or module unload
@ -1754,7 +1753,7 @@ void batadv_bla_free(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_bla_loopdetect_check - check and handle a detected loop * batadv_bla_loopdetect_check() - check and handle a detected loop
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the packet to check * @skb: the packet to check
* @primary_if: interface where the request came on * @primary_if: interface where the request came on
@ -1803,7 +1802,7 @@ batadv_bla_loopdetect_check(struct batadv_priv *bat_priv, struct sk_buff *skb,
} }
/** /**
* batadv_bla_rx - check packets coming from the mesh. * batadv_bla_rx() - check packets coming from the mesh.
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the frame to be checked * @skb: the frame to be checked
* @vid: the VLAN ID of the frame * @vid: the VLAN ID of the frame
@ -1915,7 +1914,7 @@ out:
} }
/** /**
* batadv_bla_tx - check packets going into the mesh * batadv_bla_tx() - check packets going into the mesh
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the frame to be checked * @skb: the frame to be checked
* @vid: the VLAN ID of the frame * @vid: the VLAN ID of the frame
@ -2023,7 +2022,7 @@ out:
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_bla_claim_table_seq_print_text - print the claim table in a seq file * batadv_bla_claim_table_seq_print_text() - print the claim table in a seq file
* @seq: seq file to print on * @seq: seq file to print on
* @offset: not used * @offset: not used
* *
@ -2085,7 +2084,7 @@ out:
#endif #endif
/** /**
* batadv_bla_claim_dump_entry - dump one entry of the claim table * batadv_bla_claim_dump_entry() - dump one entry of the claim table
* to a netlink socket * to a netlink socket
* @msg: buffer for the message * @msg: buffer for the message
* @portid: netlink port * @portid: netlink port
@ -2144,7 +2143,7 @@ out:
} }
/** /**
* batadv_bla_claim_dump_bucket - dump one bucket of the claim table * batadv_bla_claim_dump_bucket() - dump one bucket of the claim table
* to a netlink socket * to a netlink socket
* @msg: buffer for the message * @msg: buffer for the message
* @portid: netlink port * @portid: netlink port
@ -2181,7 +2180,7 @@ unlock:
} }
/** /**
* batadv_bla_claim_dump - dump claim table to a netlink socket * batadv_bla_claim_dump() - dump claim table to a netlink socket
* @msg: buffer for the message * @msg: buffer for the message
* @cb: callback structure containing arguments * @cb: callback structure containing arguments
* *
@ -2248,8 +2247,8 @@ out:
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_bla_backbone_table_seq_print_text - print the backbone table in a seq * batadv_bla_backbone_table_seq_print_text() - print the backbone table in a
* file * seq file
* @seq: seq file to print on * @seq: seq file to print on
* @offset: not used * @offset: not used
* *
@ -2313,8 +2312,8 @@ out:
#endif #endif
/** /**
* batadv_bla_backbone_dump_entry - dump one entry of the backbone table * batadv_bla_backbone_dump_entry() - dump one entry of the backbone table to a
* to a netlink socket * netlink socket
* @msg: buffer for the message * @msg: buffer for the message
* @portid: netlink port * @portid: netlink port
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -2374,8 +2373,8 @@ out:
} }
/** /**
* batadv_bla_backbone_dump_bucket - dump one bucket of the backbone table * batadv_bla_backbone_dump_bucket() - dump one bucket of the backbone table to
* to a netlink socket * a netlink socket
* @msg: buffer for the message * @msg: buffer for the message
* @portid: netlink port * @portid: netlink port
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -2411,7 +2410,7 @@ unlock:
} }
/** /**
* batadv_bla_backbone_dump - dump backbone table to a netlink socket * batadv_bla_backbone_dump() - dump backbone table to a netlink socket
* @msg: buffer for the message * @msg: buffer for the message
* @cb: callback structure containing arguments * @cb: callback structure containing arguments
* *
@ -2478,7 +2477,7 @@ out:
#ifdef CONFIG_BATMAN_ADV_DAT #ifdef CONFIG_BATMAN_ADV_DAT
/** /**
* batadv_bla_check_claim - check if address is claimed * batadv_bla_check_claim() - check if address is claimed
* *
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: mac address of which the claim status is checked * @addr: mac address of which the claim status is checked

4
net/batman-adv/bridge_loop_avoidance.h
View file

@ -31,8 +31,8 @@ struct seq_file;
struct sk_buff; struct sk_buff;
/** /**
* batadv_bla_is_loopdetect_mac - check if the mac address is from a loop detect * batadv_bla_is_loopdetect_mac() - check if the mac address is from a loop
* frame sent by bridge loop avoidance * detect frame sent by bridge loop avoidance
* @mac: mac address to check * @mac: mac address to check
* *
* Return: true if the it looks like a loop detect frame * Return: true if the it looks like a loop detect frame

12
net/batman-adv/debugfs.c
View file

@ -66,8 +66,8 @@ static int batadv_originators_open(struct inode *inode, struct file *file)
} }
/** /**
* batadv_originators_hardif_open - handles debugfs output for the * batadv_originators_hardif_open() - handles debugfs output for the originator
* originator table of an hard interface * table of an hard interface
* @inode: inode pointer to debugfs file * @inode: inode pointer to debugfs file
* @file: pointer to the seq_file * @file: pointer to the seq_file
* *
@ -117,7 +117,7 @@ static int batadv_bla_backbone_table_open(struct inode *inode,
#ifdef CONFIG_BATMAN_ADV_DAT #ifdef CONFIG_BATMAN_ADV_DAT
/** /**
* batadv_dat_cache_open - Prepare file handler for reads from dat_chache * batadv_dat_cache_open() - Prepare file handler for reads from dat_chache
* @inode: inode which was opened * @inode: inode which was opened
* @file: file handle to be initialized * @file: file handle to be initialized
* *
@ -154,7 +154,7 @@ static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
#ifdef CONFIG_BATMAN_ADV_MCAST #ifdef CONFIG_BATMAN_ADV_MCAST
/** /**
* batadv_mcast_flags_open - prepare file handler for reads from mcast_flags * batadv_mcast_flags_open() - prepare file handler for reads from mcast_flags
* @inode: inode which was opened * @inode: inode which was opened
* @file: file handle to be initialized * @file: file handle to be initialized
* *
@ -296,7 +296,7 @@ void batadv_debugfs_destroy(void)
} }
/** /**
* batadv_debugfs_add_hardif - creates the base directory for a hard interface * batadv_debugfs_add_hardif() - creates the base directory for a hard interface
* in debugfs. * in debugfs.
* @hard_iface: hard interface which should be added. * @hard_iface: hard interface which should be added.
* *
@ -338,7 +338,7 @@ out:
} }
/** /**
* batadv_debugfs_del_hardif - delete the base directory for a hard interface * batadv_debugfs_del_hardif() - delete the base directory for a hard interface
* in debugfs. * in debugfs.
* @hard_iface: hard interface which is deleted. * @hard_iface: hard interface which is deleted.
*/ */

77
net/batman-adv/distributed-arp-table.c
View file

@ -56,7 +56,7 @@
static void batadv_dat_purge(struct work_struct *work); static void batadv_dat_purge(struct work_struct *work);
/** /**
* batadv_dat_start_timer - initialise the DAT periodic worker * batadv_dat_start_timer() - initialise the DAT periodic worker
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_dat_start_timer(struct batadv_priv *bat_priv) static void batadv_dat_start_timer(struct batadv_priv *bat_priv)
@ -67,7 +67,7 @@ static void batadv_dat_start_timer(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_dat_entry_release - release dat_entry from lists and queue for free * batadv_dat_entry_release() - release dat_entry from lists and queue for free
* after rcu grace period * after rcu grace period
* @ref: kref pointer of the dat_entry * @ref: kref pointer of the dat_entry
*/ */
@ -81,7 +81,7 @@ static void batadv_dat_entry_release(struct kref *ref)
} }
/** /**
* batadv_dat_entry_put - decrement the dat_entry refcounter and possibly * batadv_dat_entry_put() - decrement the dat_entry refcounter and possibly
* release it * release it
* @dat_entry: dat_entry to be free'd * @dat_entry: dat_entry to be free'd
*/ */
@ -91,7 +91,7 @@ static void batadv_dat_entry_put(struct batadv_dat_entry *dat_entry)
} }
/** /**
* batadv_dat_to_purge - check whether a dat_entry has to be purged or not * batadv_dat_to_purge() - check whether a dat_entry has to be purged or not
* @dat_entry: the entry to check * @dat_entry: the entry to check
* *
* Return: true if the entry has to be purged now, false otherwise. * Return: true if the entry has to be purged now, false otherwise.
@ -103,7 +103,7 @@ static bool batadv_dat_to_purge(struct batadv_dat_entry *dat_entry)
} }
/** /**
* __batadv_dat_purge - delete entries from the DAT local storage * __batadv_dat_purge() - delete entries from the DAT local storage
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @to_purge: function in charge to decide whether an entry has to be purged or * @to_purge: function in charge to decide whether an entry has to be purged or
* not. This function takes the dat_entry as argument and has to * not. This function takes the dat_entry as argument and has to
@ -146,8 +146,8 @@ static void __batadv_dat_purge(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_dat_purge - periodic task that deletes old entries from the local DAT * batadv_dat_purge() - periodic task that deletes old entries from the local
* hash table * DAT hash table
* @work: kernel work struct * @work: kernel work struct
*/ */
static void batadv_dat_purge(struct work_struct *work) static void batadv_dat_purge(struct work_struct *work)
@ -165,7 +165,7 @@ static void batadv_dat_purge(struct work_struct *work)
} }
/** /**
* batadv_compare_dat - comparing function used in the local DAT hash table * batadv_compare_dat() - comparing function used in the local DAT hash table
* @node: node in the local table * @node: node in the local table
* @data2: second object to compare the node to * @data2: second object to compare the node to
* *
@ -180,7 +180,7 @@ static bool batadv_compare_dat(const struct hlist_node *node, const void *data2)
} }
/** /**
* batadv_arp_hw_src - extract the hw_src field from an ARP packet * batadv_arp_hw_src() - extract the hw_src field from an ARP packet
* @skb: ARP packet * @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet * @hdr_size: size of the possible header before the ARP packet
* *
@ -197,7 +197,7 @@ static u8 *batadv_arp_hw_src(struct sk_buff *skb, int hdr_size)
} }
/** /**
* batadv_arp_ip_src - extract the ip_src field from an ARP packet * batadv_arp_ip_src() - extract the ip_src field from an ARP packet
* @skb: ARP packet * @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet * @hdr_size: size of the possible header before the ARP packet
* *
@ -209,7 +209,7 @@ static __be32 batadv_arp_ip_src(struct sk_buff *skb, int hdr_size)
} }
/** /**
* batadv_arp_hw_dst - extract the hw_dst field from an ARP packet * batadv_arp_hw_dst() - extract the hw_dst field from an ARP packet
* @skb: ARP packet * @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet * @hdr_size: size of the possible header before the ARP packet
* *
@ -221,7 +221,7 @@ static u8 *batadv_arp_hw_dst(struct sk_buff *skb, int hdr_size)
} }
/** /**
* batadv_arp_ip_dst - extract the ip_dst field from an ARP packet * batadv_arp_ip_dst() - extract the ip_dst field from an ARP packet
* @skb: ARP packet * @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet * @hdr_size: size of the possible header before the ARP packet
* *
@ -233,7 +233,7 @@ static __be32 batadv_arp_ip_dst(struct sk_buff *skb, int hdr_size)
} }
/** /**
* batadv_hash_dat - compute the hash value for an IP address * batadv_hash_dat() - compute the hash value for an IP address
* @data: data to hash * @data: data to hash
* @size: size of the hash table * @size: size of the hash table
* *
@ -268,7 +268,7 @@ static u32 batadv_hash_dat(const void *data, u32 size)
} }
/** /**
* batadv_dat_entry_hash_find - look for a given dat_entry in the local hash * batadv_dat_entry_hash_find() - look for a given dat_entry in the local hash
* table * table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ip: search key * @ip: search key
@ -311,7 +311,7 @@ batadv_dat_entry_hash_find(struct batadv_priv *bat_priv, __be32 ip,
} }
/** /**
* batadv_dat_entry_add - add a new dat entry or update it if already exists * batadv_dat_entry_add() - add a new dat entry or update it if already exists
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ip: ipv4 to add/edit * @ip: ipv4 to add/edit
* @mac_addr: mac address to assign to the given ipv4 * @mac_addr: mac address to assign to the given ipv4
@ -368,7 +368,8 @@ out:
#ifdef CONFIG_BATMAN_ADV_DEBUG #ifdef CONFIG_BATMAN_ADV_DEBUG
/** /**
* batadv_dbg_arp - print a debug message containing all the ARP packet details * batadv_dbg_arp() - print a debug message containing all the ARP packet
* details
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: ARP packet * @skb: ARP packet
* @hdr_size: size of the possible header before the ARP packet * @hdr_size: size of the possible header before the ARP packet
@ -449,7 +450,7 @@ static void batadv_dbg_arp(struct batadv_priv *bat_priv, struct sk_buff *skb,
#endif /* CONFIG_BATMAN_ADV_DEBUG */ #endif /* CONFIG_BATMAN_ADV_DEBUG */
/** /**
* batadv_is_orig_node_eligible - check whether a node can be a DHT candidate * batadv_is_orig_node_eligible() - check whether a node can be a DHT candidate
* @res: the array with the already selected candidates * @res: the array with the already selected candidates
* @select: number of already selected candidates * @select: number of already selected candidates
* @tmp_max: address of the currently evaluated node * @tmp_max: address of the currently evaluated node
@ -503,7 +504,7 @@ out:
} }
/** /**
* batadv_choose_next_candidate - select the next DHT candidate * batadv_choose_next_candidate() - select the next DHT candidate
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @cands: candidates array * @cands: candidates array
* @select: number of candidates already present in the array * @select: number of candidates already present in the array
@ -567,8 +568,8 @@ static void batadv_choose_next_candidate(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_dat_select_candidates - select the nodes which the DHT message has to * batadv_dat_select_candidates() - select the nodes which the DHT message has
* be sent to * to be sent to
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ip_dst: ipv4 to look up in the DHT * @ip_dst: ipv4 to look up in the DHT
* @vid: VLAN identifier * @vid: VLAN identifier
@ -613,7 +614,7 @@ batadv_dat_select_candidates(struct batadv_priv *bat_priv, __be32 ip_dst,
} }
/** /**
* batadv_dat_send_data - send a payload to the selected candidates * batadv_dat_send_data() - send a payload to the selected candidates
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: payload to send * @skb: payload to send
* @ip: the DHT key * @ip: the DHT key
@ -689,7 +690,7 @@ out:
} }
/** /**
* batadv_dat_tvlv_container_update - update the dat tvlv container after dat * batadv_dat_tvlv_container_update() - update the dat tvlv container after dat
* setting change * setting change
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
@ -711,7 +712,7 @@ static void batadv_dat_tvlv_container_update(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_dat_status_update - update the dat tvlv container after dat * batadv_dat_status_update() - update the dat tvlv container after dat
* setting change * setting change
* @net_dev: the soft interface net device * @net_dev: the soft interface net device
*/ */
@ -723,7 +724,7 @@ void batadv_dat_status_update(struct net_device *net_dev)
} }
/** /**
* batadv_dat_tvlv_ogm_handler_v1 - process incoming dat tvlv container * batadv_dat_tvlv_ogm_handler_v1() - process incoming dat tvlv container
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node of the ogm * @orig: the orig_node of the ogm
* @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
@ -742,7 +743,7 @@ static void batadv_dat_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_dat_hash_free - free the local DAT hash table * batadv_dat_hash_free() - free the local DAT hash table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_dat_hash_free(struct batadv_priv *bat_priv) static void batadv_dat_hash_free(struct batadv_priv *bat_priv)
@ -758,7 +759,7 @@ static void batadv_dat_hash_free(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_dat_init - initialise the DAT internals * batadv_dat_init() - initialise the DAT internals
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: 0 in case of success, a negative error code otherwise * Return: 0 in case of success, a negative error code otherwise
@ -783,7 +784,7 @@ int batadv_dat_init(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_dat_free - free the DAT internals * batadv_dat_free() - free the DAT internals
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_dat_free(struct batadv_priv *bat_priv) void batadv_dat_free(struct batadv_priv *bat_priv)
@ -798,7 +799,7 @@ void batadv_dat_free(struct batadv_priv *bat_priv)
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_dat_cache_seq_print_text - print the local DAT hash table * batadv_dat_cache_seq_print_text() - print the local DAT hash table
* @seq: seq file to print on * @seq: seq file to print on
* @offset: not used * @offset: not used
* *
@ -851,7 +852,7 @@ out:
#endif #endif
/** /**
* batadv_arp_get_type - parse an ARP packet and gets the type * batadv_arp_get_type() - parse an ARP packet and gets the type
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: packet to analyse * @skb: packet to analyse
* @hdr_size: size of the possible header before the ARP packet in the skb * @hdr_size: size of the possible header before the ARP packet in the skb
@ -925,7 +926,7 @@ out:
} }
/** /**
* batadv_dat_get_vid - extract the VLAN identifier from skb if any * batadv_dat_get_vid() - extract the VLAN identifier from skb if any
* @skb: the buffer containing the packet to extract the VID from * @skb: the buffer containing the packet to extract the VID from
* @hdr_size: the size of the batman-adv header encapsulating the packet * @hdr_size: the size of the batman-adv header encapsulating the packet
* *
@ -951,7 +952,7 @@ static unsigned short batadv_dat_get_vid(struct sk_buff *skb, int *hdr_size)
} }
/** /**
* batadv_dat_arp_create_reply - create an ARP Reply * batadv_dat_arp_create_reply() - create an ARP Reply
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ip_src: ARP sender IP * @ip_src: ARP sender IP
* @ip_dst: ARP target IP * @ip_dst: ARP target IP
@ -986,7 +987,7 @@ batadv_dat_arp_create_reply(struct batadv_priv *bat_priv, __be32 ip_src,
} }
/** /**
* batadv_dat_snoop_outgoing_arp_request - snoop the ARP request and try to * batadv_dat_snoop_outgoing_arp_request() - snoop the ARP request and try to
* answer using DAT * answer using DAT
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check * @skb: packet to check
@ -1084,7 +1085,7 @@ out:
} }
/** /**
* batadv_dat_snoop_incoming_arp_request - snoop the ARP request and try to * batadv_dat_snoop_incoming_arp_request() - snoop the ARP request and try to
* answer using the local DAT storage * answer using the local DAT storage
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check * @skb: packet to check
@ -1154,7 +1155,7 @@ out:
} }
/** /**
* batadv_dat_snoop_outgoing_arp_reply - snoop the ARP reply and fill the DHT * batadv_dat_snoop_outgoing_arp_reply() - snoop the ARP reply and fill the DHT
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check * @skb: packet to check
*/ */
@ -1194,8 +1195,8 @@ void batadv_dat_snoop_outgoing_arp_reply(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_dat_snoop_incoming_arp_reply - snoop the ARP reply and fill the local * batadv_dat_snoop_incoming_arp_reply() - snoop the ARP reply and fill the
* DAT storage only * local DAT storage only
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check * @skb: packet to check
* @hdr_size: size of the encapsulation header * @hdr_size: size of the encapsulation header
@ -1283,8 +1284,8 @@ out:
} }
/** /**
* batadv_dat_drop_broadcast_packet - check if an ARP request has to be dropped * batadv_dat_drop_broadcast_packet() - check if an ARP request has to be
* (because the node has already obtained the reply via DAT) or not * dropped (because the node has already obtained the reply via DAT) or not
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @forw_packet: the broadcast packet * @forw_packet: the broadcast packet
* *

6
net/batman-adv/distributed-arp-table.h
View file

@ -49,7 +49,7 @@ bool batadv_dat_drop_broadcast_packet(struct batadv_priv *bat_priv,
struct batadv_forw_packet *forw_packet); struct batadv_forw_packet *forw_packet);
/** /**
* batadv_dat_init_orig_node_addr - assign a DAT address to the orig_node * batadv_dat_init_orig_node_addr() - assign a DAT address to the orig_node
* @orig_node: the node to assign the DAT address to * @orig_node: the node to assign the DAT address to
*/ */
static inline void static inline void
@ -62,7 +62,7 @@ batadv_dat_init_orig_node_addr(struct batadv_orig_node *orig_node)
} }
/** /**
* batadv_dat_init_own_addr - assign a DAT address to the node itself * batadv_dat_init_own_addr() - assign a DAT address to the node itself
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: a pointer to the primary interface * @primary_if: a pointer to the primary interface
*/ */
@ -83,7 +83,7 @@ void batadv_dat_free(struct batadv_priv *bat_priv);
int batadv_dat_cache_seq_print_text(struct seq_file *seq, void *offset); int batadv_dat_cache_seq_print_text(struct seq_file *seq, void *offset);
/** /**
* batadv_dat_inc_counter - increment the correct DAT packet counter * batadv_dat_inc_counter() - increment the correct DAT packet counter
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @subtype: the 4addr subtype of the packet to be counted * @subtype: the 4addr subtype of the packet to be counted
* *

20
net/batman-adv/fragmentation.c
View file

@ -42,7 +42,7 @@
#include "soft-interface.h" #include "soft-interface.h"
/** /**
* batadv_frag_clear_chain - delete entries in the fragment buffer chain * batadv_frag_clear_chain() - delete entries in the fragment buffer chain
* @head: head of chain with entries. * @head: head of chain with entries.
* @dropped: whether the chain is cleared because all fragments are dropped * @dropped: whether the chain is cleared because all fragments are dropped
* *
@ -66,7 +66,7 @@ static void batadv_frag_clear_chain(struct hlist_head *head, bool dropped)
} }
/** /**
* batadv_frag_purge_orig - free fragments associated to an orig * batadv_frag_purge_orig() - free fragments associated to an orig
* @orig_node: originator to free fragments from * @orig_node: originator to free fragments from
* @check_cb: optional function to tell if an entry should be purged * @check_cb: optional function to tell if an entry should be purged
*/ */
@ -90,7 +90,7 @@ void batadv_frag_purge_orig(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_frag_size_limit - maximum possible size of packet to be fragmented * batadv_frag_size_limit() - maximum possible size of packet to be fragmented
* *
* Return: the maximum size of payload that can be fragmented. * Return: the maximum size of payload that can be fragmented.
*/ */
@ -105,7 +105,7 @@ static int batadv_frag_size_limit(void)
} }
/** /**
* batadv_frag_init_chain - check and prepare fragment chain for new fragment * batadv_frag_init_chain() - check and prepare fragment chain for new fragment
* @chain: chain in fragments table to init * @chain: chain in fragments table to init
* @seqno: sequence number of the received fragment * @seqno: sequence number of the received fragment
* *
@ -135,7 +135,7 @@ static bool batadv_frag_init_chain(struct batadv_frag_table_entry *chain,
} }
/** /**
* batadv_frag_insert_packet - insert a fragment into a fragment chain * batadv_frag_insert_packet() - insert a fragment into a fragment chain
* @orig_node: originator that the fragment was received from * @orig_node: originator that the fragment was received from
* @skb: skb to insert * @skb: skb to insert
* @chain_out: list head to attach complete chains of fragments to * @chain_out: list head to attach complete chains of fragments to
@ -249,7 +249,7 @@ err:
} }
/** /**
* batadv_frag_merge_packets - merge a chain of fragments * batadv_frag_merge_packets() - merge a chain of fragments
* @chain: head of chain with fragments * @chain: head of chain with fragments
* *
* Expand the first skb in the chain and copy the content of the remaining * Expand the first skb in the chain and copy the content of the remaining
@ -307,7 +307,7 @@ free:
} }
/** /**
* batadv_frag_skb_buffer - buffer fragment for later merge * batadv_frag_skb_buffer() - buffer fragment for later merge
* @skb: skb to buffer * @skb: skb to buffer
* @orig_node_src: originator that the skb is received from * @orig_node_src: originator that the skb is received from
* *
@ -347,7 +347,7 @@ out_err:
} }
/** /**
* batadv_frag_skb_fwd - forward fragments that would exceed MTU when merged * batadv_frag_skb_fwd() - forward fragments that would exceed MTU when merged
* @skb: skb to forward * @skb: skb to forward
* @recv_if: interface that the skb is received on * @recv_if: interface that the skb is received on
* @orig_node_src: originator that the skb is received from * @orig_node_src: originator that the skb is received from
@ -401,7 +401,7 @@ out:
} }
/** /**
* batadv_frag_create - create a fragment from skb * batadv_frag_create() - create a fragment from skb
* @skb: skb to create fragment from * @skb: skb to create fragment from
* @frag_head: header to use in new fragment * @frag_head: header to use in new fragment
* @fragment_size: size of new fragment * @fragment_size: size of new fragment
@ -439,7 +439,7 @@ err:
} }
/** /**
* batadv_frag_send_packet - create up to 16 fragments from the passed skb * batadv_frag_send_packet() - create up to 16 fragments from the passed skb
* @skb: skb to create fragments from * @skb: skb to create fragments from
* @orig_node: final destination of the created fragments * @orig_node: final destination of the created fragments
* @neigh_node: next-hop of the created fragments * @neigh_node: next-hop of the created fragments

2
net/batman-adv/fragmentation.h
View file

@ -40,7 +40,7 @@ int batadv_frag_send_packet(struct sk_buff *skb,
struct batadv_neigh_node *neigh_node); struct batadv_neigh_node *neigh_node);
/** /**
* batadv_frag_check_entry - check if a list of fragments has timed out * batadv_frag_check_entry() - check if a list of fragments has timed out
* @frags_entry: table entry to check * @frags_entry: table entry to check
* *
* Return: true if the frags entry has timed out, false otherwise. * Return: true if the frags entry has timed out, false otherwise.

24
net/batman-adv/gateway_client.c
View file

@ -69,8 +69,8 @@
#define BATADV_DHCP_CHADDR_OFFSET 28 #define BATADV_DHCP_CHADDR_OFFSET 28
/** /**
* batadv_gw_node_release - release gw_node from lists and queue for free after * batadv_gw_node_release() - release gw_node from lists and queue for free
* rcu grace period * after rcu grace period
* @ref: kref pointer of the gw_node * @ref: kref pointer of the gw_node
*/ */
static void batadv_gw_node_release(struct kref *ref) static void batadv_gw_node_release(struct kref *ref)
@ -84,7 +84,8 @@ static void batadv_gw_node_release(struct kref *ref)
} }
/** /**
* batadv_gw_node_put - decrement the gw_node refcounter and possibly release it * batadv_gw_node_put() - decrement the gw_node refcounter and possibly release
* it
* @gw_node: gateway node to free * @gw_node: gateway node to free
*/ */
void batadv_gw_node_put(struct batadv_gw_node *gw_node) void batadv_gw_node_put(struct batadv_gw_node *gw_node)
@ -156,7 +157,7 @@ static void batadv_gw_select(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_gw_reselect - force a gateway reselection * batadv_gw_reselect() - force a gateway reselection
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Set a flag to remind the GW component to perform a new gateway reselection. * Set a flag to remind the GW component to perform a new gateway reselection.
@ -172,7 +173,7 @@ void batadv_gw_reselect(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_gw_check_client_stop - check if client mode has been switched off * batadv_gw_check_client_stop() - check if client mode has been switched off
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* This function assumes the caller has checked that the gw state *is actually * This function assumes the caller has checked that the gw state *is actually
@ -322,7 +323,7 @@ out:
} }
/** /**
* batadv_gw_node_add - add gateway node to list of available gateways * batadv_gw_node_add() - add gateway node to list of available gateways
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: originator announcing gateway capabilities * @orig_node: originator announcing gateway capabilities
* @gateway: announced bandwidth information * @gateway: announced bandwidth information
@ -365,7 +366,7 @@ static void batadv_gw_node_add(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_gw_node_get - retrieve gateway node from list of available gateways * batadv_gw_node_get() - retrieve gateway node from list of available gateways
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: originator announcing gateway capabilities * @orig_node: originator announcing gateway capabilities
* *
@ -394,7 +395,7 @@ struct batadv_gw_node *batadv_gw_node_get(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_gw_node_update - update list of available gateways with changed * batadv_gw_node_update() - update list of available gateways with changed
* bandwidth information * bandwidth information
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: originator announcing gateway capabilities * @orig_node: originator announcing gateway capabilities
@ -515,7 +516,7 @@ int batadv_gw_client_seq_print_text(struct seq_file *seq, void *offset)
#endif #endif
/** /**
* batadv_gw_dump - Dump gateways into a message * batadv_gw_dump() - Dump gateways into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
* *
@ -568,7 +569,7 @@ out:
} }
/** /**
* batadv_gw_dhcp_recipient_get - check if a packet is a DHCP message * batadv_gw_dhcp_recipient_get() - check if a packet is a DHCP message
* @skb: the packet to check * @skb: the packet to check
* @header_len: a pointer to the batman-adv header size * @header_len: a pointer to the batman-adv header size
* @chaddr: buffer where the client address will be stored. Valid * @chaddr: buffer where the client address will be stored. Valid
@ -687,7 +688,8 @@ batadv_gw_dhcp_recipient_get(struct sk_buff *skb, unsigned int *header_len,
} }
/** /**
* batadv_gw_out_of_range - check if the dhcp request destination is the best gw * batadv_gw_out_of_range() - check if the dhcp request destination is the best
* gateway
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the outgoing packet * @skb: the outgoing packet
* *

18
net/batman-adv/gateway_common.c
View file

@ -34,8 +34,8 @@
#include "tvlv.h" #include "tvlv.h"
/** /**
* batadv_parse_throughput - parse supplied string buffer to extract throughput * batadv_parse_throughput() - parse supplied string buffer to extract
* information * throughput information
* @net_dev: the soft interface net device * @net_dev: the soft interface net device
* @buff: string buffer to parse * @buff: string buffer to parse
* @description: text shown when throughput string cannot be parsed * @description: text shown when throughput string cannot be parsed
@ -101,8 +101,8 @@ bool batadv_parse_throughput(struct net_device *net_dev, char *buff,
} }
/** /**
* batadv_parse_gw_bandwidth - parse supplied string buffer to extract download * batadv_parse_gw_bandwidth() - parse supplied string buffer to extract
* and upload bandwidth information * download and upload bandwidth information
* @net_dev: the soft interface net device * @net_dev: the soft interface net device
* @buff: string buffer to parse * @buff: string buffer to parse
* @down: pointer holding the returned download bandwidth information * @down: pointer holding the returned download bandwidth information
@ -137,8 +137,8 @@ static bool batadv_parse_gw_bandwidth(struct net_device *net_dev, char *buff,
} }
/** /**
* batadv_gw_tvlv_container_update - update the gw tvlv container after gateway * batadv_gw_tvlv_container_update() - update the gw tvlv container after
* setting change * gateway setting change
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_gw_tvlv_container_update(struct batadv_priv *bat_priv) void batadv_gw_tvlv_container_update(struct batadv_priv *bat_priv)
@ -208,7 +208,7 @@ ssize_t batadv_gw_bandwidth_set(struct net_device *net_dev, char *buff,
} }
/** /**
* batadv_gw_tvlv_ogm_handler_v1 - process incoming gateway tvlv container * batadv_gw_tvlv_ogm_handler_v1() - process incoming gateway tvlv container
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node of the ogm * @orig: the orig_node of the ogm
* @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
@ -249,7 +249,7 @@ static void batadv_gw_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_gw_init - initialise the gateway handling internals * batadv_gw_init() - initialise the gateway handling internals
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_gw_init(struct batadv_priv *bat_priv) void batadv_gw_init(struct batadv_priv *bat_priv)
@ -265,7 +265,7 @@ void batadv_gw_init(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_gw_free - free the gateway handling internals * batadv_gw_free() - free the gateway handling internals
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_gw_free(struct batadv_priv *bat_priv) void batadv_gw_free(struct batadv_priv *bat_priv)

26
net/batman-adv/hard-interface.c
View file

@ -53,7 +53,7 @@
#include "translation-table.h" #include "translation-table.h"
/** /**
* batadv_hardif_release - release hard interface from lists and queue for * batadv_hardif_release() - release hard interface from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the hard interface * @ref: kref pointer of the hard interface
*/ */
@ -87,7 +87,7 @@ out:
} }
/** /**
* batadv_getlink_net - return link net namespace (of use fallback) * batadv_getlink_net() - return link net namespace (of use fallback)
* @netdev: net_device to check * @netdev: net_device to check
* @fallback_net: return in case get_link_net is not available for @netdev * @fallback_net: return in case get_link_net is not available for @netdev
* *
@ -106,7 +106,7 @@ static struct net *batadv_getlink_net(const struct net_device *netdev,
} }
/** /**
* batadv_mutual_parents - check if two devices are each others parent * batadv_mutual_parents() - check if two devices are each others parent
* @dev1: 1st net dev * @dev1: 1st net dev
* @net1: 1st devices netns * @net1: 1st devices netns
* @dev2: 2nd net dev * @dev2: 2nd net dev
@ -139,7 +139,7 @@ static bool batadv_mutual_parents(const struct net_device *dev1,
} }
/** /**
* batadv_is_on_batman_iface - check if a device is a batman iface descendant * batadv_is_on_batman_iface() - check if a device is a batman iface descendant
* @net_dev: the device to check * @net_dev: the device to check
* *
* If the user creates any virtual device on top of a batman-adv interface, it * If the user creates any virtual device on top of a batman-adv interface, it
@ -203,7 +203,7 @@ static bool batadv_is_valid_iface(const struct net_device *net_dev)
} }
/** /**
* batadv_get_real_netdevice - check if the given netdev struct is a virtual * batadv_get_real_netdevice() - check if the given netdev struct is a virtual
* interface on top of another 'real' interface * interface on top of another 'real' interface
* @netdev: the device to check * @netdev: the device to check
* *
@ -247,7 +247,7 @@ out:
} }
/** /**
* batadv_get_real_netdev - check if the given net_device struct is a virtual * batadv_get_real_netdev() - check if the given net_device struct is a virtual
* interface on top of another 'real' interface * interface on top of another 'real' interface
* @net_device: the device to check * @net_device: the device to check
* *
@ -266,7 +266,7 @@ struct net_device *batadv_get_real_netdev(struct net_device *net_device)
} }
/** /**
* batadv_is_wext_netdev - check if the given net_device struct is a * batadv_is_wext_netdev() - check if the given net_device struct is a
* wext wifi interface * wext wifi interface
* @net_device: the device to check * @net_device: the device to check
* *
@ -290,7 +290,7 @@ static bool batadv_is_wext_netdev(struct net_device *net_device)
} }
/** /**
* batadv_is_cfg80211_netdev - check if the given net_device struct is a * batadv_is_cfg80211_netdev() - check if the given net_device struct is a
* cfg80211 wifi interface * cfg80211 wifi interface
* @net_device: the device to check * @net_device: the device to check
* *
@ -310,7 +310,7 @@ static bool batadv_is_cfg80211_netdev(struct net_device *net_device)
} }
/** /**
* batadv_wifi_flags_evaluate - calculate wifi flags for net_device * batadv_wifi_flags_evaluate() - calculate wifi flags for net_device
* @net_device: the device to check * @net_device: the device to check
* *
* Return: batadv_hard_iface_wifi_flags flags of the device * Return: batadv_hard_iface_wifi_flags flags of the device
@ -345,7 +345,7 @@ out:
} }
/** /**
* batadv_is_cfg80211_hardif - check if the given hardif is a cfg80211 wifi * batadv_is_cfg80211_hardif() - check if the given hardif is a cfg80211 wifi
* interface * interface
* @hard_iface: the device to check * @hard_iface: the device to check
* *
@ -363,7 +363,7 @@ bool batadv_is_cfg80211_hardif(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_is_wifi_hardif - check if the given hardif is a wifi interface * batadv_is_wifi_hardif() - check if the given hardif is a wifi interface
* @hard_iface: the device to check * @hard_iface: the device to check
* *
* Return: true if the net device is a 802.11 wireless device, false otherwise. * Return: true if the net device is a 802.11 wireless device, false otherwise.
@ -377,7 +377,7 @@ bool batadv_is_wifi_hardif(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_hardif_no_broadcast - check whether (re)broadcast is necessary * batadv_hardif_no_broadcast() - check whether (re)broadcast is necessary
* @if_outgoing: the outgoing interface checked and considered for (re)broadcast * @if_outgoing: the outgoing interface checked and considered for (re)broadcast
* @orig_addr: the originator of this packet * @orig_addr: the originator of this packet
* @orig_neigh: originator address of the forwarder we just got the packet from * @orig_neigh: originator address of the forwarder we just got the packet from
@ -668,7 +668,7 @@ batadv_hardif_deactivate_interface(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_master_del_slave - remove hard_iface from the current master interface * batadv_master_del_slave() - remove hard_iface from the current master iface
* @slave: the interface enslaved in another master * @slave: the interface enslaved in another master
* @master: the master from which slave has to be removed * @master: the master from which slave has to be removed
* *

2
net/batman-adv/hard-interface.h
View file

@ -83,7 +83,7 @@ int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing,
u8 *orig_addr, u8 *orig_neigh); u8 *orig_addr, u8 *orig_neigh);
/** /**
* batadv_hardif_put - decrement the hard interface refcounter and possibly * batadv_hardif_put() - decrement the hard interface refcounter and possibly
* release it * release it
* @hard_iface: the hard interface to free * @hard_iface: the hard interface to free
*/ */

2
net/batman-adv/hash.h
View file

@ -63,7 +63,7 @@ void batadv_hash_set_lock_class(struct batadv_hashtable *hash,
void batadv_hash_destroy(struct batadv_hashtable *hash); void batadv_hash_destroy(struct batadv_hashtable *hash);
/** /**
* batadv_hash_add - adds data to the hashtable * batadv_hash_add() - adds data to the hashtable
* @hash: storage hash table * @hash: storage hash table
* @compare: callback to determine if 2 hash elements are identical * @compare: callback to determine if 2 hash elements are identical
* @choose: callback calculating the hash index * @choose: callback calculating the hash index

4
net/batman-adv/icmp_socket.c
View file

@ -335,7 +335,7 @@ err:
} }
/** /**
* batadv_socket_add_packet - schedule an icmp packet to be sent to * batadv_socket_add_packet() - schedule an icmp packet to be sent to
* userspace on an icmp socket. * userspace on an icmp socket.
* @socket_client: the socket this packet belongs to * @socket_client: the socket this packet belongs to
* @icmph: pointer to the header of the icmp packet * @icmph: pointer to the header of the icmp packet
@ -392,7 +392,7 @@ static void batadv_socket_add_packet(struct batadv_socket_client *socket_client,
} }
/** /**
* batadv_socket_receive_packet - schedule an icmp packet to be received * batadv_socket_receive_packet() - schedule an icmp packet to be received
* locally and sent to userspace. * locally and sent to userspace.
* @icmph: pointer to the header of the icmp packet * @icmph: pointer to the header of the icmp packet
* @icmp_len: total length of the icmp packet * @icmp_len: total length of the icmp packet

16
net/batman-adv/main.c
View file

@ -256,8 +256,8 @@ void batadv_mesh_free(struct net_device *soft_iface)
} }
/** /**
* batadv_is_my_mac - check if the given mac address belongs to any of the real * batadv_is_my_mac() - check if the given mac address belongs to any of the
* interfaces in the current mesh * real interfaces in the current mesh
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the address to check * @addr: the address to check
* *
@ -287,7 +287,7 @@ bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr)
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_seq_print_text_primary_if_get - called from debugfs table printing * batadv_seq_print_text_primary_if_get() - called from debugfs table printing
* function that requires the primary interface * function that requires the primary interface
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
* *
@ -324,7 +324,7 @@ out:
#endif #endif
/** /**
* batadv_max_header_len - calculate maximum encapsulation overhead for a * batadv_max_header_len() - calculate maximum encapsulation overhead for a
* payload packet * payload packet
* *
* Return: the maximum encapsulation overhead in bytes. * Return: the maximum encapsulation overhead in bytes.
@ -349,7 +349,7 @@ int batadv_max_header_len(void)
} }
/** /**
* batadv_skb_set_priority - sets skb priority according to packet content * batadv_skb_set_priority() - sets skb priority according to packet content
* @skb: the packet to be sent * @skb: the packet to be sent
* @offset: offset to the packet content * @offset: offset to the packet content
* *
@ -559,7 +559,7 @@ void batadv_recv_handler_unregister(u8 packet_type)
} }
/** /**
* batadv_skb_crc32 - calculate CRC32 of the whole packet and skip bytes in * batadv_skb_crc32() - calculate CRC32 of the whole packet and skip bytes in
* the header * the header
* @skb: skb pointing to fragmented socket buffers * @skb: skb pointing to fragmented socket buffers
* @payload_ptr: Pointer to position inside the head buffer of the skb * @payload_ptr: Pointer to position inside the head buffer of the skb
@ -592,7 +592,7 @@ __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr)
} }
/** /**
* batadv_get_vid - extract the VLAN identifier from skb if any * batadv_get_vid() - extract the VLAN identifier from skb if any
* @skb: the buffer containing the packet * @skb: the buffer containing the packet
* @header_len: length of the batman header preceding the ethernet header * @header_len: length of the batman header preceding the ethernet header
* *
@ -619,7 +619,7 @@ unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len)
} }
/** /**
* batadv_vlan_ap_isola_get - return the AP isolation status for the given vlan * batadv_vlan_ap_isola_get() - return AP isolation status for the given vlan
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: the VLAN identifier for which the AP isolation attributed as to be * @vid: the VLAN identifier for which the AP isolation attributed as to be
* looked up * looked up

6
net/batman-adv/main.h
View file

@ -203,7 +203,7 @@ struct seq_file;
struct sk_buff; struct sk_buff;
/** /**
* batadv_print_vid - return printable version of vid information * batadv_print_vid() - return printable version of vid information
* @vid: the VLAN identifier * @vid: the VLAN identifier
* *
* Return: -1 when no VLAN is used, VLAN id otherwise * Return: -1 when no VLAN is used, VLAN id otherwise
@ -239,7 +239,7 @@ void batadv_recv_handler_unregister(u8 packet_type);
__be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr); __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
/** /**
* batadv_compare_eth - Compare two not u16 aligned Ethernet addresses * batadv_compare_eth() - Compare two not u16 aligned Ethernet addresses
* @data1: Pointer to a six-byte array containing the Ethernet address * @data1: Pointer to a six-byte array containing the Ethernet address
* @data2: Pointer other six-byte array containing the Ethernet address * @data2: Pointer other six-byte array containing the Ethernet address
* *
@ -253,7 +253,7 @@ static inline bool batadv_compare_eth(const void *data1, const void *data2)
} }
/** /**
* batadv_has_timed_out - compares current time (jiffies) and timestamp + * batadv_has_timed_out() - compares current time (jiffies) and timestamp +
* timeout * timeout
* @timestamp: base value to compare with (in jiffies) * @timestamp: base value to compare with (in jiffies)
* @timeout: added to base value before comparing (in milliseconds) * @timeout: added to base value before comparing (in milliseconds)

78
net/batman-adv/multicast.c
View file

@ -66,7 +66,7 @@
static void batadv_mcast_mla_update(struct work_struct *work); static void batadv_mcast_mla_update(struct work_struct *work);
/** /**
* batadv_mcast_start_timer - schedule the multicast periodic worker * batadv_mcast_start_timer() - schedule the multicast periodic worker
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_mcast_start_timer(struct batadv_priv *bat_priv) static void batadv_mcast_start_timer(struct batadv_priv *bat_priv)
@ -76,7 +76,7 @@ static void batadv_mcast_start_timer(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_mcast_get_bridge - get the bridge on top of the softif if it exists * batadv_mcast_get_bridge() - get the bridge on top of the softif if it exists
* @soft_iface: netdev struct of the mesh interface * @soft_iface: netdev struct of the mesh interface
* *
* If the given soft interface has a bridge on top then the refcount * If the given soft interface has a bridge on top then the refcount
@ -102,7 +102,7 @@ static struct net_device *batadv_mcast_get_bridge(struct net_device *soft_iface)
} }
/** /**
* batadv_mcast_mla_softif_get - get softif multicast listeners * batadv_mcast_mla_softif_get() - get softif multicast listeners
* @dev: the device to collect multicast addresses from * @dev: the device to collect multicast addresses from
* @mcast_list: a list to put found addresses into * @mcast_list: a list to put found addresses into
* *
@ -148,7 +148,7 @@ static int batadv_mcast_mla_softif_get(struct net_device *dev,
} }
/** /**
* batadv_mcast_mla_is_duplicate - check whether an address is in a list * batadv_mcast_mla_is_duplicate() - check whether an address is in a list
* @mcast_addr: the multicast address to check * @mcast_addr: the multicast address to check
* @mcast_list: the list with multicast addresses to search in * @mcast_list: the list with multicast addresses to search in
* *
@ -168,7 +168,7 @@ static bool batadv_mcast_mla_is_duplicate(u8 *mcast_addr,
} }
/** /**
* batadv_mcast_mla_br_addr_cpy - copy a bridge multicast address * batadv_mcast_mla_br_addr_cpy() - copy a bridge multicast address
* @dst: destination to write to - a multicast MAC address * @dst: destination to write to - a multicast MAC address
* @src: source to read from - a multicast IP address * @src: source to read from - a multicast IP address
* *
@ -192,7 +192,7 @@ static void batadv_mcast_mla_br_addr_cpy(char *dst, const struct br_ip *src)
} }
/** /**
* batadv_mcast_mla_bridge_get - get bridged-in multicast listeners * batadv_mcast_mla_bridge_get() - get bridged-in multicast listeners
* @dev: a bridge slave whose bridge to collect multicast addresses from * @dev: a bridge slave whose bridge to collect multicast addresses from
* @mcast_list: a list to put found addresses into * @mcast_list: a list to put found addresses into
* *
@ -245,7 +245,7 @@ out:
} }
/** /**
* batadv_mcast_mla_list_free - free a list of multicast addresses * batadv_mcast_mla_list_free() - free a list of multicast addresses
* @mcast_list: the list to free * @mcast_list: the list to free
* *
* Removes and frees all items in the given mcast_list. * Removes and frees all items in the given mcast_list.
@ -262,7 +262,7 @@ static void batadv_mcast_mla_list_free(struct hlist_head *mcast_list)
} }
/** /**
* batadv_mcast_mla_tt_retract - clean up multicast listener announcements * batadv_mcast_mla_tt_retract() - clean up multicast listener announcements
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @mcast_list: a list of addresses which should _not_ be removed * @mcast_list: a list of addresses which should _not_ be removed
* *
@ -298,7 +298,7 @@ static void batadv_mcast_mla_tt_retract(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_mla_tt_add - add multicast listener announcements * batadv_mcast_mla_tt_add() - add multicast listener announcements
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @mcast_list: a list of addresses which are going to get added * @mcast_list: a list of addresses which are going to get added
* *
@ -334,7 +334,7 @@ static void batadv_mcast_mla_tt_add(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_has_bridge - check whether the soft-iface is bridged * batadv_mcast_has_bridge() - check whether the soft-iface is bridged
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Checks whether there is a bridge on top of our soft interface. * Checks whether there is a bridge on top of our soft interface.
@ -355,7 +355,8 @@ static bool batadv_mcast_has_bridge(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_mcast_querier_log - debug output regarding the querier status on link * batadv_mcast_querier_log() - debug output regarding the querier status on
* link
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @str_proto: a string for the querier protocol (e.g. "IGMP" or "MLD") * @str_proto: a string for the querier protocol (e.g. "IGMP" or "MLD")
* @old_state: the previous querier state on our link * @old_state: the previous querier state on our link
@ -406,7 +407,8 @@ batadv_mcast_querier_log(struct batadv_priv *bat_priv, char *str_proto,
} }
/** /**
* batadv_mcast_bridge_log - debug output for topology changes in bridged setups * batadv_mcast_bridge_log() - debug output for topology changes in bridged
* setups
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @bridged: a flag about whether the soft interface is currently bridged or not * @bridged: a flag about whether the soft interface is currently bridged or not
* @querier_ipv4: (maybe) new status of a potential, selected IGMP querier * @querier_ipv4: (maybe) new status of a potential, selected IGMP querier
@ -445,7 +447,7 @@ batadv_mcast_bridge_log(struct batadv_priv *bat_priv, bool bridged,
} }
/** /**
* batadv_mcast_flags_logs - output debug information about mcast flag changes * batadv_mcast_flags_logs() - output debug information about mcast flag changes
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @flags: flags indicating the new multicast state * @flags: flags indicating the new multicast state
* *
@ -471,7 +473,7 @@ static void batadv_mcast_flags_log(struct batadv_priv *bat_priv, u8 flags)
} }
/** /**
* batadv_mcast_mla_tvlv_update - update multicast tvlv * batadv_mcast_mla_tvlv_update() - update multicast tvlv
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Updates the own multicast tvlv with our current multicast related settings, * Updates the own multicast tvlv with our current multicast related settings,
@ -546,7 +548,7 @@ update:
} }
/** /**
* __batadv_mcast_mla_update - update the own MLAs * __batadv_mcast_mla_update() - update the own MLAs
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Updates the own multicast listener announcements in the translation * Updates the own multicast listener announcements in the translation
@ -583,7 +585,7 @@ out:
} }
/** /**
* batadv_mcast_mla_update - update the own MLAs * batadv_mcast_mla_update() - update the own MLAs
* @work: kernel work struct * @work: kernel work struct
* *
* Updates the own multicast listener announcements in the translation * Updates the own multicast listener announcements in the translation
@ -606,7 +608,7 @@ static void batadv_mcast_mla_update(struct work_struct *work)
} }
/** /**
* batadv_mcast_is_report_ipv4 - check for IGMP reports * batadv_mcast_is_report_ipv4() - check for IGMP reports
* @skb: the ethernet frame destined for the mesh * @skb: the ethernet frame destined for the mesh
* *
* This call might reallocate skb data. * This call might reallocate skb data.
@ -631,7 +633,8 @@ static bool batadv_mcast_is_report_ipv4(struct sk_buff *skb)
} }
/** /**
* batadv_mcast_forw_mode_check_ipv4 - check for optimized forwarding potential * batadv_mcast_forw_mode_check_ipv4() - check for optimized forwarding
* potential
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the IPv4 packet to check * @skb: the IPv4 packet to check
* @is_unsnoopable: stores whether the destination is snoopable * @is_unsnoopable: stores whether the destination is snoopable
@ -672,7 +675,7 @@ static int batadv_mcast_forw_mode_check_ipv4(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_is_report_ipv6 - check for MLD reports * batadv_mcast_is_report_ipv6() - check for MLD reports
* @skb: the ethernet frame destined for the mesh * @skb: the ethernet frame destined for the mesh
* *
* This call might reallocate skb data. * This call might reallocate skb data.
@ -696,7 +699,8 @@ static bool batadv_mcast_is_report_ipv6(struct sk_buff *skb)
} }
/** /**
* batadv_mcast_forw_mode_check_ipv6 - check for optimized forwarding potential * batadv_mcast_forw_mode_check_ipv6() - check for optimized forwarding
* potential
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the IPv6 packet to check * @skb: the IPv6 packet to check
* @is_unsnoopable: stores whether the destination is snoopable * @is_unsnoopable: stores whether the destination is snoopable
@ -737,7 +741,7 @@ static int batadv_mcast_forw_mode_check_ipv6(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_forw_mode_check - check for optimized forwarding potential * batadv_mcast_forw_mode_check() - check for optimized forwarding potential
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the multicast frame to check * @skb: the multicast frame to check
* @is_unsnoopable: stores whether the destination is snoopable * @is_unsnoopable: stores whether the destination is snoopable
@ -775,7 +779,7 @@ static int batadv_mcast_forw_mode_check(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_forw_want_all_ip_count - count nodes with unspecific mcast * batadv_mcast_forw_want_all_ip_count() - count nodes with unspecific mcast
* interest * interest
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ethhdr: ethernet header of a packet * @ethhdr: ethernet header of a packet
@ -799,7 +803,7 @@ static int batadv_mcast_forw_want_all_ip_count(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_forw_tt_node_get - get a multicast tt node * batadv_mcast_forw_tt_node_get() - get a multicast tt node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ethhdr: the ether header containing the multicast destination * @ethhdr: the ether header containing the multicast destination
* *
@ -815,7 +819,7 @@ batadv_mcast_forw_tt_node_get(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_forw_ipv4_node_get - get a node with an ipv4 flag * batadv_mcast_forw_ipv4_node_get() - get a node with an ipv4 flag
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 flag set and * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 flag set and
@ -842,7 +846,7 @@ batadv_mcast_forw_ipv4_node_get(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_mcast_forw_ipv6_node_get - get a node with an ipv6 flag * batadv_mcast_forw_ipv6_node_get() - get a node with an ipv6 flag
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV6 flag set * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV6 flag set
@ -869,7 +873,7 @@ batadv_mcast_forw_ipv6_node_get(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_mcast_forw_ip_node_get - get a node with an ipv4/ipv6 flag * batadv_mcast_forw_ip_node_get() - get a node with an ipv4/ipv6 flag
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ethhdr: an ethernet header to determine the protocol family from * @ethhdr: an ethernet header to determine the protocol family from
* *
@ -893,7 +897,7 @@ batadv_mcast_forw_ip_node_get(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_forw_unsnoop_node_get - get a node with an unsnoopable flag * batadv_mcast_forw_unsnoop_node_get() - get a node with an unsnoopable flag
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: an orig_node which has the BATADV_MCAST_WANT_ALL_UNSNOOPABLES flag * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_UNSNOOPABLES flag
@ -920,7 +924,7 @@ batadv_mcast_forw_unsnoop_node_get(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_mcast_forw_mode - check on how to forward a multicast packet * batadv_mcast_forw_mode() - check on how to forward a multicast packet
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: The multicast packet to check * @skb: The multicast packet to check
* @orig: an originator to be set to forward the skb to * @orig: an originator to be set to forward the skb to
@ -974,7 +978,7 @@ batadv_mcast_forw_mode(struct batadv_priv *bat_priv, struct sk_buff *skb,
} }
/** /**
* batadv_mcast_want_unsnoop_update - update unsnoop counter and list * batadv_mcast_want_unsnoop_update() - update unsnoop counter and list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node which multicast state might have changed of * @orig: the orig_node which multicast state might have changed of
* @mcast_flags: flags indicating the new multicast state * @mcast_flags: flags indicating the new multicast state
@ -1019,7 +1023,7 @@ static void batadv_mcast_want_unsnoop_update(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_want_ipv4_update - update want-all-ipv4 counter and list * batadv_mcast_want_ipv4_update() - update want-all-ipv4 counter and list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node which multicast state might have changed of * @orig: the orig_node which multicast state might have changed of
* @mcast_flags: flags indicating the new multicast state * @mcast_flags: flags indicating the new multicast state
@ -1064,7 +1068,7 @@ static void batadv_mcast_want_ipv4_update(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_want_ipv6_update - update want-all-ipv6 counter and list * batadv_mcast_want_ipv6_update() - update want-all-ipv6 counter and list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node which multicast state might have changed of * @orig: the orig_node which multicast state might have changed of
* @mcast_flags: flags indicating the new multicast state * @mcast_flags: flags indicating the new multicast state
@ -1109,7 +1113,7 @@ static void batadv_mcast_want_ipv6_update(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_tvlv_ogm_handler - process incoming multicast tvlv container * batadv_mcast_tvlv_ogm_handler() - process incoming multicast tvlv container
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node of the ogm * @orig: the orig_node of the ogm
* @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
@ -1165,7 +1169,7 @@ static void batadv_mcast_tvlv_ogm_handler(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_init - initialize the multicast optimizations structures * batadv_mcast_init() - initialize the multicast optimizations structures
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_mcast_init(struct batadv_priv *bat_priv) void batadv_mcast_init(struct batadv_priv *bat_priv)
@ -1180,7 +1184,7 @@ void batadv_mcast_init(struct batadv_priv *bat_priv)
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_mcast_flags_print_header - print own mcast flags to debugfs table * batadv_mcast_flags_print_header() - print own mcast flags to debugfs table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
* *
@ -1221,7 +1225,7 @@ static void batadv_mcast_flags_print_header(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_mcast_flags_seq_print_text - print the mcast flags of other nodes * batadv_mcast_flags_seq_print_text() - print the mcast flags of other nodes
* @seq: seq file to print on * @seq: seq file to print on
* @offset: not used * @offset: not used
* *
@ -1282,7 +1286,7 @@ int batadv_mcast_flags_seq_print_text(struct seq_file *seq, void *offset)
#endif #endif
/** /**
* batadv_mcast_free - free the multicast optimizations structures * batadv_mcast_free() - free the multicast optimizations structures
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_mcast_free(struct batadv_priv *bat_priv) void batadv_mcast_free(struct batadv_priv *bat_priv)
@ -1297,7 +1301,7 @@ void batadv_mcast_free(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_mcast_purge_orig - reset originator global mcast state modifications * batadv_mcast_purge_orig() - reset originator global mcast state modifications
* @orig: the originator which is going to get purged * @orig: the originator which is going to get purged
*/ */
void batadv_mcast_purge_orig(struct batadv_orig_node *orig) void batadv_mcast_purge_orig(struct batadv_orig_node *orig)

22
net/batman-adv/netlink.c
View file

@ -100,7 +100,7 @@ static const struct nla_policy batadv_netlink_policy[NUM_BATADV_ATTR] = {
}; };
/** /**
* batadv_netlink_get_ifindex - Extract an interface index from a message * batadv_netlink_get_ifindex() - Extract an interface index from a message
* @nlh: Message header * @nlh: Message header
* @attrtype: Attribute which holds an interface index * @attrtype: Attribute which holds an interface index
* *
@ -115,7 +115,7 @@ batadv_netlink_get_ifindex(const struct nlmsghdr *nlh, int attrtype)
} }
/** /**
* batadv_netlink_mesh_info_put - fill in generic information about mesh * batadv_netlink_mesh_info_put() - fill in generic information about mesh
* interface * interface
* @msg: netlink message to be sent back * @msg: netlink message to be sent back
* @soft_iface: interface for which the data should be taken * @soft_iface: interface for which the data should be taken
@ -170,7 +170,7 @@ batadv_netlink_mesh_info_put(struct sk_buff *msg, struct net_device *soft_iface)
} }
/** /**
* batadv_netlink_get_mesh_info - handle incoming BATADV_CMD_GET_MESH_INFO * batadv_netlink_get_mesh_info() - handle incoming BATADV_CMD_GET_MESH_INFO
* netlink request * netlink request
* @skb: received netlink message * @skb: received netlink message
* @info: receiver information * @info: receiver information
@ -231,7 +231,7 @@ batadv_netlink_get_mesh_info(struct sk_buff *skb, struct genl_info *info)
} }
/** /**
* batadv_netlink_tp_meter_put - Fill information of started tp_meter session * batadv_netlink_tp_meter_put() - Fill information of started tp_meter session
* @msg: netlink message to be sent back * @msg: netlink message to be sent back
* @cookie: tp meter session cookie * @cookie: tp meter session cookie
* *
@ -247,7 +247,7 @@ batadv_netlink_tp_meter_put(struct sk_buff *msg, u32 cookie)
} }
/** /**
* batadv_netlink_tpmeter_notify - send tp_meter result via netlink to client * batadv_netlink_tpmeter_notify() - send tp_meter result via netlink to client
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @dst: destination of tp_meter session * @dst: destination of tp_meter session
* @result: reason for tp meter session stop * @result: reason for tp meter session stop
@ -310,7 +310,7 @@ err_genlmsg:
} }
/** /**
* batadv_netlink_tp_meter_start - Start a new tp_meter session * batadv_netlink_tp_meter_start() - Start a new tp_meter session
* @skb: received netlink message * @skb: received netlink message
* @info: receiver information * @info: receiver information
* *
@ -387,7 +387,7 @@ batadv_netlink_tp_meter_start(struct sk_buff *skb, struct genl_info *info)
} }
/** /**
* batadv_netlink_tp_meter_start - Cancel a running tp_meter session * batadv_netlink_tp_meter_start() - Cancel a running tp_meter session
* @skb: received netlink message * @skb: received netlink message
* @info: receiver information * @info: receiver information
* *
@ -432,7 +432,7 @@ out:
} }
/** /**
* batadv_netlink_dump_hardif_entry - Dump one hard interface into a message * batadv_netlink_dump_hardif_entry() - Dump one hard interface into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -474,7 +474,7 @@ batadv_netlink_dump_hardif_entry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_netlink_dump_hardifs - Dump all hard interface into a messages * batadv_netlink_dump_hardifs() - Dump all hard interface into a messages
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Parameters from query * @cb: Parameters from query
* *
@ -621,7 +621,7 @@ struct genl_family batadv_netlink_family __ro_after_init = {
}; };
/** /**
* batadv_netlink_register - register batadv genl netlink family * batadv_netlink_register() - register batadv genl netlink family
*/ */
void __init batadv_netlink_register(void) void __init batadv_netlink_register(void)
{ {
@ -633,7 +633,7 @@ void __init batadv_netlink_register(void)
} }
/** /**
* batadv_netlink_unregister - unregister batadv genl netlink family * batadv_netlink_unregister() - unregister batadv genl netlink family
*/ */
void batadv_netlink_unregister(void) void batadv_netlink_unregister(void)
{ {

120
net/batman-adv/network-coding.c
View file

@ -67,7 +67,7 @@ static int batadv_nc_recv_coded_packet(struct sk_buff *skb,
struct batadv_hard_iface *recv_if); struct batadv_hard_iface *recv_if);
/** /**
* batadv_nc_init - one-time initialization for network coding * batadv_nc_init() - one-time initialization for network coding
* *
* Return: 0 on success or negative error number in case of failure * Return: 0 on success or negative error number in case of failure
*/ */
@ -83,7 +83,7 @@ int __init batadv_nc_init(void)
} }
/** /**
* batadv_nc_start_timer - initialise the nc periodic worker * batadv_nc_start_timer() - initialise the nc periodic worker
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_nc_start_timer(struct batadv_priv *bat_priv) static void batadv_nc_start_timer(struct batadv_priv *bat_priv)
@ -93,7 +93,7 @@ static void batadv_nc_start_timer(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_nc_tvlv_container_update - update the network coding tvlv container * batadv_nc_tvlv_container_update() - update the network coding tvlv container
* after network coding setting change * after network coding setting change
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
@ -115,7 +115,7 @@ static void batadv_nc_tvlv_container_update(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_nc_status_update - update the network coding tvlv container after * batadv_nc_status_update() - update the network coding tvlv container after
* network coding setting change * network coding setting change
* @net_dev: the soft interface net device * @net_dev: the soft interface net device
*/ */
@ -127,7 +127,7 @@ void batadv_nc_status_update(struct net_device *net_dev)
} }
/** /**
* batadv_nc_tvlv_ogm_handler_v1 - process incoming nc tvlv container * batadv_nc_tvlv_ogm_handler_v1() - process incoming nc tvlv container
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node of the ogm * @orig: the orig_node of the ogm
* @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
@ -146,7 +146,7 @@ static void batadv_nc_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_mesh_init - initialise coding hash table and start house keeping * batadv_nc_mesh_init() - initialise coding hash table and start house keeping
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: 0 on success or negative error number in case of failure * Return: 0 on success or negative error number in case of failure
@ -187,7 +187,7 @@ err:
} }
/** /**
* batadv_nc_init_bat_priv - initialise the nc specific bat_priv variables * batadv_nc_init_bat_priv() - initialise the nc specific bat_priv variables
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_nc_init_bat_priv(struct batadv_priv *bat_priv) void batadv_nc_init_bat_priv(struct batadv_priv *bat_priv)
@ -199,7 +199,7 @@ void batadv_nc_init_bat_priv(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_nc_init_orig - initialise the nc fields of an orig_node * batadv_nc_init_orig() - initialise the nc fields of an orig_node
* @orig_node: the orig_node which is going to be initialised * @orig_node: the orig_node which is going to be initialised
*/ */
void batadv_nc_init_orig(struct batadv_orig_node *orig_node) void batadv_nc_init_orig(struct batadv_orig_node *orig_node)
@ -211,8 +211,8 @@ void batadv_nc_init_orig(struct batadv_orig_node *orig_node)
} }
/** /**
* batadv_nc_node_release - release nc_node from lists and queue for free after * batadv_nc_node_release() - release nc_node from lists and queue for free
* rcu grace period * after rcu grace period
* @ref: kref pointer of the nc_node * @ref: kref pointer of the nc_node
*/ */
static void batadv_nc_node_release(struct kref *ref) static void batadv_nc_node_release(struct kref *ref)
@ -226,7 +226,7 @@ static void batadv_nc_node_release(struct kref *ref)
} }
/** /**
* batadv_nc_node_put - decrement the nc_node refcounter and possibly * batadv_nc_node_put() - decrement the nc_node refcounter and possibly
* release it * release it
* @nc_node: nc_node to be free'd * @nc_node: nc_node to be free'd
*/ */
@ -236,8 +236,8 @@ static void batadv_nc_node_put(struct batadv_nc_node *nc_node)
} }
/** /**
* batadv_nc_path_release - release nc_path from lists and queue for free after * batadv_nc_path_release() - release nc_path from lists and queue for free
* rcu grace period * after rcu grace period
* @ref: kref pointer of the nc_path * @ref: kref pointer of the nc_path
*/ */
static void batadv_nc_path_release(struct kref *ref) static void batadv_nc_path_release(struct kref *ref)
@ -250,7 +250,7 @@ static void batadv_nc_path_release(struct kref *ref)
} }
/** /**
* batadv_nc_path_put - decrement the nc_path refcounter and possibly * batadv_nc_path_put() - decrement the nc_path refcounter and possibly
* release it * release it
* @nc_path: nc_path to be free'd * @nc_path: nc_path to be free'd
*/ */
@ -260,7 +260,7 @@ static void batadv_nc_path_put(struct batadv_nc_path *nc_path)
} }
/** /**
* batadv_nc_packet_free - frees nc packet * batadv_nc_packet_free() - frees nc packet
* @nc_packet: the nc packet to free * @nc_packet: the nc packet to free
* @dropped: whether the packet is freed because is is dropped * @dropped: whether the packet is freed because is is dropped
*/ */
@ -277,7 +277,7 @@ static void batadv_nc_packet_free(struct batadv_nc_packet *nc_packet,
} }
/** /**
* batadv_nc_to_purge_nc_node - checks whether an nc node has to be purged * batadv_nc_to_purge_nc_node() - checks whether an nc node has to be purged
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @nc_node: the nc node to check * @nc_node: the nc node to check
* *
@ -293,7 +293,7 @@ static bool batadv_nc_to_purge_nc_node(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_to_purge_nc_path_coding - checks whether an nc path has timed out * batadv_nc_to_purge_nc_path_coding() - checks whether an nc path has timed out
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @nc_path: the nc path to check * @nc_path: the nc path to check
* *
@ -313,7 +313,8 @@ static bool batadv_nc_to_purge_nc_path_coding(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_to_purge_nc_path_decoding - checks whether an nc path has timed out * batadv_nc_to_purge_nc_path_decoding() - checks whether an nc path has timed
* out
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @nc_path: the nc path to check * @nc_path: the nc path to check
* *
@ -333,7 +334,7 @@ static bool batadv_nc_to_purge_nc_path_decoding(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_purge_orig_nc_nodes - go through list of nc nodes and purge stale * batadv_nc_purge_orig_nc_nodes() - go through list of nc nodes and purge stale
* entries * entries
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @list: list of nc nodes * @list: list of nc nodes
@ -371,7 +372,7 @@ batadv_nc_purge_orig_nc_nodes(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_purge_orig - purges all nc node data attached of the given * batadv_nc_purge_orig() - purges all nc node data attached of the given
* originator * originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig_node with the nc node entries to be purged * @orig_node: orig_node with the nc node entries to be purged
@ -397,8 +398,8 @@ void batadv_nc_purge_orig(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_purge_orig_hash - traverse entire originator hash to check if they * batadv_nc_purge_orig_hash() - traverse entire originator hash to check if
* have timed out nc nodes * they have timed out nc nodes
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_nc_purge_orig_hash(struct batadv_priv *bat_priv) static void batadv_nc_purge_orig_hash(struct batadv_priv *bat_priv)
@ -424,7 +425,7 @@ static void batadv_nc_purge_orig_hash(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_nc_purge_paths - traverse all nc paths part of the hash and remove * batadv_nc_purge_paths() - traverse all nc paths part of the hash and remove
* unused ones * unused ones
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @hash: hash table containing the nc paths to check * @hash: hash table containing the nc paths to check
@ -483,7 +484,7 @@ static void batadv_nc_purge_paths(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_hash_key_gen - computes the nc_path hash key * batadv_nc_hash_key_gen() - computes the nc_path hash key
* @key: buffer to hold the final hash key * @key: buffer to hold the final hash key
* @src: source ethernet mac address going into the hash key * @src: source ethernet mac address going into the hash key
* @dst: destination ethernet mac address going into the hash key * @dst: destination ethernet mac address going into the hash key
@ -496,7 +497,7 @@ static void batadv_nc_hash_key_gen(struct batadv_nc_path *key, const char *src,
} }
/** /**
* batadv_nc_hash_choose - compute the hash value for an nc path * batadv_nc_hash_choose() - compute the hash value for an nc path
* @data: data to hash * @data: data to hash
* @size: size of the hash table * @size: size of the hash table
* *
@ -514,7 +515,7 @@ static u32 batadv_nc_hash_choose(const void *data, u32 size)
} }
/** /**
* batadv_nc_hash_compare - comparing function used in the network coding hash * batadv_nc_hash_compare() - comparing function used in the network coding hash
* tables * tables
* @node: node in the local table * @node: node in the local table
* @data2: second object to compare the node to * @data2: second object to compare the node to
@ -540,7 +541,7 @@ static bool batadv_nc_hash_compare(const struct hlist_node *node,
} }
/** /**
* batadv_nc_hash_find - search for an existing nc path and return it * batadv_nc_hash_find() - search for an existing nc path and return it
* @hash: hash table containing the nc path * @hash: hash table containing the nc path
* @data: search key * @data: search key
* *
@ -577,7 +578,7 @@ batadv_nc_hash_find(struct batadv_hashtable *hash,
} }
/** /**
* batadv_nc_send_packet - send non-coded packet and free nc_packet struct * batadv_nc_send_packet() - send non-coded packet and free nc_packet struct
* @nc_packet: the nc packet to send * @nc_packet: the nc packet to send
*/ */
static void batadv_nc_send_packet(struct batadv_nc_packet *nc_packet) static void batadv_nc_send_packet(struct batadv_nc_packet *nc_packet)
@ -588,7 +589,7 @@ static void batadv_nc_send_packet(struct batadv_nc_packet *nc_packet)
} }
/** /**
* batadv_nc_sniffed_purge - Checks timestamp of given sniffed nc_packet. * batadv_nc_sniffed_purge() - Checks timestamp of given sniffed nc_packet.
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @nc_path: the nc path the packet belongs to * @nc_path: the nc path the packet belongs to
* @nc_packet: the nc packet to be checked * @nc_packet: the nc packet to be checked
@ -627,7 +628,7 @@ out:
} }
/** /**
* batadv_nc_fwd_flush - Checks the timestamp of the given nc packet. * batadv_nc_fwd_flush() - Checks the timestamp of the given nc packet.
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @nc_path: the nc path the packet belongs to * @nc_path: the nc path the packet belongs to
* @nc_packet: the nc packet to be checked * @nc_packet: the nc packet to be checked
@ -665,8 +666,8 @@ static bool batadv_nc_fwd_flush(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_process_nc_paths - traverse given nc packet pool and free timed out * batadv_nc_process_nc_paths() - traverse given nc packet pool and free timed
* nc packets * out nc packets
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @hash: to be processed hash table * @hash: to be processed hash table
* @process_fn: Function called to process given nc packet. Should return true * @process_fn: Function called to process given nc packet. Should return true
@ -711,7 +712,8 @@ batadv_nc_process_nc_paths(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_worker - periodic task for house keeping related to network coding * batadv_nc_worker() - periodic task for house keeping related to network
* coding
* @work: kernel work struct * @work: kernel work struct
*/ */
static void batadv_nc_worker(struct work_struct *work) static void batadv_nc_worker(struct work_struct *work)
@ -751,8 +753,8 @@ static void batadv_nc_worker(struct work_struct *work)
} }
/** /**
* batadv_can_nc_with_orig - checks whether the given orig node is suitable for * batadv_can_nc_with_orig() - checks whether the given orig node is suitable
* coding or not * for coding or not
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: neighboring orig node which may be used as nc candidate * @orig_node: neighboring orig node which may be used as nc candidate
* @ogm_packet: incoming ogm packet also used for the checks * @ogm_packet: incoming ogm packet also used for the checks
@ -792,7 +794,7 @@ static bool batadv_can_nc_with_orig(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_find_nc_node - search for an existing nc node and return it * batadv_nc_find_nc_node() - search for an existing nc node and return it
* @orig_node: orig node originating the ogm packet * @orig_node: orig node originating the ogm packet
* @orig_neigh_node: neighboring orig node from which we received the ogm packet * @orig_neigh_node: neighboring orig node from which we received the ogm packet
* (can be equal to orig_node) * (can be equal to orig_node)
@ -832,7 +834,7 @@ batadv_nc_find_nc_node(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_nc_get_nc_node - retrieves an nc node or creates the entry if it was * batadv_nc_get_nc_node() - retrieves an nc node or creates the entry if it was
* not found * not found
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node originating the ogm packet * @orig_node: orig node originating the ogm packet
@ -892,7 +894,7 @@ batadv_nc_get_nc_node(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_update_nc_node - updates stored incoming and outgoing nc node * batadv_nc_update_nc_node() - updates stored incoming and outgoing nc node
* structs (best called on incoming OGMs) * structs (best called on incoming OGMs)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node originating the ogm packet * @orig_node: orig node originating the ogm packet
@ -947,7 +949,7 @@ out:
} }
/** /**
* batadv_nc_get_path - get existing nc_path or allocate a new one * batadv_nc_get_path() - get existing nc_path or allocate a new one
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @hash: hash table containing the nc path * @hash: hash table containing the nc path
* @src: ethernet source address - first half of the nc path search key * @src: ethernet source address - first half of the nc path search key
@ -1008,7 +1010,7 @@ static struct batadv_nc_path *batadv_nc_get_path(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_random_weight_tq - scale the receivers TQ-value to avoid unfair * batadv_nc_random_weight_tq() - scale the receivers TQ-value to avoid unfair
* selection of a receiver with slightly lower TQ than the other * selection of a receiver with slightly lower TQ than the other
* @tq: to be weighted tq value * @tq: to be weighted tq value
* *
@ -1031,7 +1033,7 @@ static u8 batadv_nc_random_weight_tq(u8 tq)
} }
/** /**
* batadv_nc_memxor - XOR destination with source * batadv_nc_memxor() - XOR destination with source
* @dst: byte array to XOR into * @dst: byte array to XOR into
* @src: byte array to XOR from * @src: byte array to XOR from
* @len: length of destination array * @len: length of destination array
@ -1045,7 +1047,7 @@ static void batadv_nc_memxor(char *dst, const char *src, unsigned int len)
} }
/** /**
* batadv_nc_code_packets - code a received unicast_packet with an nc packet * batadv_nc_code_packets() - code a received unicast_packet with an nc packet
* into a coded_packet and send it * into a coded_packet and send it
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: data skb to forward * @skb: data skb to forward
@ -1238,7 +1240,7 @@ out:
} }
/** /**
* batadv_nc_skb_coding_possible - true if a decoded skb is available at dst. * batadv_nc_skb_coding_possible() - true if a decoded skb is available at dst.
* @skb: data skb to forward * @skb: data skb to forward
* @dst: destination mac address of the other skb to code with * @dst: destination mac address of the other skb to code with
* @src: source mac address of skb * @src: source mac address of skb
@ -1262,7 +1264,7 @@ static bool batadv_nc_skb_coding_possible(struct sk_buff *skb, u8 *dst, u8 *src)
} }
/** /**
* batadv_nc_path_search - Find the coding path matching in_nc_node and * batadv_nc_path_search() - Find the coding path matching in_nc_node and
* out_nc_node to retrieve a buffered packet that can be used for coding. * out_nc_node to retrieve a buffered packet that can be used for coding.
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @in_nc_node: pointer to skb next hop's neighbor nc node * @in_nc_node: pointer to skb next hop's neighbor nc node
@ -1330,8 +1332,8 @@ batadv_nc_path_search(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_skb_src_search - Loops through the list of neighoring nodes of the * batadv_nc_skb_src_search() - Loops through the list of neighoring nodes of
* skb's sender (may be equal to the originator). * the skb's sender (may be equal to the originator).
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: data skb to forward * @skb: data skb to forward
* @eth_dst: next hop mac address of skb * @eth_dst: next hop mac address of skb
@ -1376,7 +1378,7 @@ batadv_nc_skb_src_search(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_skb_store_before_coding - set the ethernet src and dst of the * batadv_nc_skb_store_before_coding() - set the ethernet src and dst of the
* unicast skb before it is stored for use in later decoding * unicast skb before it is stored for use in later decoding
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: data skb to store * @skb: data skb to store
@ -1411,7 +1413,7 @@ static void batadv_nc_skb_store_before_coding(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_skb_dst_search - Loops through list of neighboring nodes to dst. * batadv_nc_skb_dst_search() - Loops through list of neighboring nodes to dst.
* @skb: data skb to forward * @skb: data skb to forward
* @neigh_node: next hop to forward packet to * @neigh_node: next hop to forward packet to
* @ethhdr: pointer to the ethernet header inside the skb * @ethhdr: pointer to the ethernet header inside the skb
@ -1469,7 +1471,7 @@ static bool batadv_nc_skb_dst_search(struct sk_buff *skb,
} }
/** /**
* batadv_nc_skb_add_to_path - buffer skb for later encoding / decoding * batadv_nc_skb_add_to_path() - buffer skb for later encoding / decoding
* @skb: skb to add to path * @skb: skb to add to path
* @nc_path: path to add skb to * @nc_path: path to add skb to
* @neigh_node: next hop to forward packet to * @neigh_node: next hop to forward packet to
@ -1504,7 +1506,7 @@ static bool batadv_nc_skb_add_to_path(struct sk_buff *skb,
} }
/** /**
* batadv_nc_skb_forward - try to code a packet or add it to the coding packet * batadv_nc_skb_forward() - try to code a packet or add it to the coding packet
* buffer * buffer
* @skb: data skb to forward * @skb: data skb to forward
* @neigh_node: next hop to forward packet to * @neigh_node: next hop to forward packet to
@ -1561,8 +1563,8 @@ out:
} }
/** /**
* batadv_nc_skb_store_for_decoding - save a clone of the skb which can be used * batadv_nc_skb_store_for_decoding() - save a clone of the skb which can be
* when decoding coded packets * used when decoding coded packets
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: data skb to store * @skb: data skb to store
*/ */
@ -1622,7 +1624,7 @@ out:
} }
/** /**
* batadv_nc_skb_store_sniffed_unicast - check if a received unicast packet * batadv_nc_skb_store_sniffed_unicast() - check if a received unicast packet
* should be saved in the decoding buffer and, if so, store it there * should be saved in the decoding buffer and, if so, store it there
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: unicast skb to store * @skb: unicast skb to store
@ -1642,7 +1644,7 @@ void batadv_nc_skb_store_sniffed_unicast(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_skb_decode_packet - decode given skb using the decode data stored * batadv_nc_skb_decode_packet() - decode given skb using the decode data stored
* in nc_packet * in nc_packet
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: unicast skb to decode * @skb: unicast skb to decode
@ -1736,7 +1738,7 @@ batadv_nc_skb_decode_packet(struct batadv_priv *bat_priv, struct sk_buff *skb,
} }
/** /**
* batadv_nc_find_decoding_packet - search through buffered decoding data to * batadv_nc_find_decoding_packet() - search through buffered decoding data to
* find the data needed to decode the coded packet * find the data needed to decode the coded packet
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ethhdr: pointer to the ethernet header inside the coded packet * @ethhdr: pointer to the ethernet header inside the coded packet
@ -1801,7 +1803,7 @@ batadv_nc_find_decoding_packet(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_nc_recv_coded_packet - try to decode coded packet and enqueue the * batadv_nc_recv_coded_packet() - try to decode coded packet and enqueue the
* resulting unicast packet * resulting unicast packet
* @skb: incoming coded packet * @skb: incoming coded packet
* @recv_if: pointer to interface this packet was received on * @recv_if: pointer to interface this packet was received on
@ -1876,7 +1878,7 @@ free_skb:
} }
/** /**
* batadv_nc_mesh_free - clean up network coding memory * batadv_nc_mesh_free() - clean up network coding memory
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_nc_mesh_free(struct batadv_priv *bat_priv) void batadv_nc_mesh_free(struct batadv_priv *bat_priv)
@ -1893,7 +1895,7 @@ void batadv_nc_mesh_free(struct batadv_priv *bat_priv)
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_nc_nodes_seq_print_text - print the nc node information * batadv_nc_nodes_seq_print_text() - print the nc node information
* @seq: seq file to print on * @seq: seq file to print on
* @offset: not used * @offset: not used
* *
@ -1956,7 +1958,7 @@ out:
} }
/** /**
* batadv_nc_init_debugfs - create nc folder and related files in debugfs * batadv_nc_init_debugfs() - create nc folder and related files in debugfs
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: 0 on success or negative error number in case of failure * Return: 0 on success or negative error number in case of failure

76
net/batman-adv/originator.c
View file

@ -91,7 +91,7 @@ batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data)
static void batadv_purge_orig(struct work_struct *work); static void batadv_purge_orig(struct work_struct *work);
/** /**
* batadv_compare_orig - comparing function used in the originator hash table * batadv_compare_orig() - comparing function used in the originator hash table
* @node: node in the local table * @node: node in the local table
* @data2: second object to compare the node to * @data2: second object to compare the node to
* *
@ -106,7 +106,7 @@ bool batadv_compare_orig(const struct hlist_node *node, const void *data2)
} }
/** /**
* batadv_orig_node_vlan_get - get an orig_node_vlan object * batadv_orig_node_vlan_get() - get an orig_node_vlan object
* @orig_node: the originator serving the VLAN * @orig_node: the originator serving the VLAN
* @vid: the VLAN identifier * @vid: the VLAN identifier
* *
@ -137,7 +137,7 @@ batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_orig_node_vlan_new - search and possibly create an orig_node_vlan * batadv_orig_node_vlan_new() - search and possibly create an orig_node_vlan
* object * object
* @orig_node: the originator serving the VLAN * @orig_node: the originator serving the VLAN
* @vid: the VLAN identifier * @vid: the VLAN identifier
@ -178,7 +178,7 @@ out:
} }
/** /**
* batadv_orig_node_vlan_release - release originator-vlan object from lists * batadv_orig_node_vlan_release() - release originator-vlan object from lists
* and queue for free after rcu grace period * and queue for free after rcu grace period
* @ref: kref pointer of the originator-vlan object * @ref: kref pointer of the originator-vlan object
*/ */
@ -192,7 +192,7 @@ static void batadv_orig_node_vlan_release(struct kref *ref)
} }
/** /**
* batadv_orig_node_vlan_put - decrement the refcounter and possibly release * batadv_orig_node_vlan_put() - decrement the refcounter and possibly release
* the originator-vlan object * the originator-vlan object
* @orig_vlan: the originator-vlan object to release * @orig_vlan: the originator-vlan object to release
*/ */
@ -226,7 +226,7 @@ err:
} }
/** /**
* batadv_neigh_ifinfo_release - release neigh_ifinfo from lists and queue for * batadv_neigh_ifinfo_release() - release neigh_ifinfo from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the neigh_ifinfo * @ref: kref pointer of the neigh_ifinfo
*/ */
@ -243,7 +243,7 @@ static void batadv_neigh_ifinfo_release(struct kref *ref)
} }
/** /**
* batadv_neigh_ifinfo_put - decrement the refcounter and possibly release * batadv_neigh_ifinfo_put() - decrement the refcounter and possibly release
* the neigh_ifinfo * the neigh_ifinfo
* @neigh_ifinfo: the neigh_ifinfo object to release * @neigh_ifinfo: the neigh_ifinfo object to release
*/ */
@ -253,7 +253,7 @@ void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo)
} }
/** /**
* batadv_hardif_neigh_release - release hardif neigh node from lists and * batadv_hardif_neigh_release() - release hardif neigh node from lists and
* queue for free after rcu grace period * queue for free after rcu grace period
* @ref: kref pointer of the neigh_node * @ref: kref pointer of the neigh_node
*/ */
@ -273,7 +273,7 @@ static void batadv_hardif_neigh_release(struct kref *ref)
} }
/** /**
* batadv_hardif_neigh_put - decrement the hardif neighbors refcounter * batadv_hardif_neigh_put() - decrement the hardif neighbors refcounter
* and possibly release it * and possibly release it
* @hardif_neigh: hardif neigh neighbor to free * @hardif_neigh: hardif neigh neighbor to free
*/ */
@ -283,7 +283,7 @@ void batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh)
} }
/** /**
* batadv_neigh_node_release - release neigh_node from lists and queue for * batadv_neigh_node_release() - release neigh_node from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the neigh_node * @ref: kref pointer of the neigh_node
*/ */
@ -308,7 +308,7 @@ static void batadv_neigh_node_release(struct kref *ref)
} }
/** /**
* batadv_neigh_node_put - decrement the neighbors refcounter and possibly * batadv_neigh_node_put() - decrement the neighbors refcounter and possibly
* release it * release it
* @neigh_node: neigh neighbor to free * @neigh_node: neigh neighbor to free
*/ */
@ -318,7 +318,7 @@ void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node)
} }
/** /**
* batadv_orig_router_get - router to the originator depending on iface * batadv_orig_router_get() - router to the originator depending on iface
* @orig_node: the orig node for the router * @orig_node: the orig node for the router
* @if_outgoing: the interface where the payload packet has been received or * @if_outgoing: the interface where the payload packet has been received or
* the OGM should be sent to * the OGM should be sent to
@ -351,7 +351,7 @@ batadv_orig_router_get(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_orig_ifinfo_get - find the ifinfo from an orig_node * batadv_orig_ifinfo_get() - find the ifinfo from an orig_node
* @orig_node: the orig node to be queried * @orig_node: the orig node to be queried
* @if_outgoing: the interface for which the ifinfo should be acquired * @if_outgoing: the interface for which the ifinfo should be acquired
* *
@ -383,7 +383,7 @@ batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_orig_ifinfo_new - search and possibly create an orig_ifinfo object * batadv_orig_ifinfo_new() - search and possibly create an orig_ifinfo object
* @orig_node: the orig node to be queried * @orig_node: the orig node to be queried
* @if_outgoing: the interface for which the ifinfo should be acquired * @if_outgoing: the interface for which the ifinfo should be acquired
* *
@ -429,7 +429,7 @@ out:
} }
/** /**
* batadv_neigh_ifinfo_get - find the ifinfo from an neigh_node * batadv_neigh_ifinfo_get() - find the ifinfo from an neigh_node
* @neigh: the neigh node to be queried * @neigh: the neigh node to be queried
* @if_outgoing: the interface for which the ifinfo should be acquired * @if_outgoing: the interface for which the ifinfo should be acquired
* *
@ -462,7 +462,7 @@ batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
} }
/** /**
* batadv_neigh_ifinfo_new - search and possibly create an neigh_ifinfo object * batadv_neigh_ifinfo_new() - search and possibly create an neigh_ifinfo object
* @neigh: the neigh node to be queried * @neigh: the neigh node to be queried
* @if_outgoing: the interface for which the ifinfo should be acquired * @if_outgoing: the interface for which the ifinfo should be acquired
* *
@ -505,7 +505,7 @@ out:
} }
/** /**
* batadv_neigh_node_get - retrieve a neighbour from the list * batadv_neigh_node_get() - retrieve a neighbour from the list
* @orig_node: originator which the neighbour belongs to * @orig_node: originator which the neighbour belongs to
* @hard_iface: the interface where this neighbour is connected to * @hard_iface: the interface where this neighbour is connected to
* @addr: the address of the neighbour * @addr: the address of the neighbour
@ -542,7 +542,7 @@ batadv_neigh_node_get(const struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_hardif_neigh_create - create a hardif neighbour node * batadv_hardif_neigh_create() - create a hardif neighbour node
* @hard_iface: the interface this neighbour is connected to * @hard_iface: the interface this neighbour is connected to
* @neigh_addr: the interface address of the neighbour to retrieve * @neigh_addr: the interface address of the neighbour to retrieve
* @orig_node: originator object representing the neighbour * @orig_node: originator object representing the neighbour
@ -588,7 +588,7 @@ out:
} }
/** /**
* batadv_hardif_neigh_get_or_create - retrieve or create a hardif neighbour * batadv_hardif_neigh_get_or_create() - retrieve or create a hardif neighbour
* node * node
* @hard_iface: the interface this neighbour is connected to * @hard_iface: the interface this neighbour is connected to
* @neigh_addr: the interface address of the neighbour to retrieve * @neigh_addr: the interface address of the neighbour to retrieve
@ -612,7 +612,7 @@ batadv_hardif_neigh_get_or_create(struct batadv_hard_iface *hard_iface,
} }
/** /**
* batadv_hardif_neigh_get - retrieve a hardif neighbour from the list * batadv_hardif_neigh_get() - retrieve a hardif neighbour from the list
* @hard_iface: the interface where this neighbour is connected to * @hard_iface: the interface where this neighbour is connected to
* @neigh_addr: the address of the neighbour * @neigh_addr: the address of the neighbour
* *
@ -644,7 +644,7 @@ batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
} }
/** /**
* batadv_neigh_node_create - create a neigh node object * batadv_neigh_node_create() - create a neigh node object
* @orig_node: originator object representing the neighbour * @orig_node: originator object representing the neighbour
* @hard_iface: the interface where the neighbour is connected to * @hard_iface: the interface where the neighbour is connected to
* @neigh_addr: the mac address of the neighbour interface * @neigh_addr: the mac address of the neighbour interface
@ -709,7 +709,7 @@ out:
} }
/** /**
* batadv_neigh_node_get_or_create - retrieve or create a neigh node object * batadv_neigh_node_get_or_create() - retrieve or create a neigh node object
* @orig_node: originator object representing the neighbour * @orig_node: originator object representing the neighbour
* @hard_iface: the interface where the neighbour is connected to * @hard_iface: the interface where the neighbour is connected to
* @neigh_addr: the mac address of the neighbour interface * @neigh_addr: the mac address of the neighbour interface
@ -733,7 +733,7 @@ batadv_neigh_node_get_or_create(struct batadv_orig_node *orig_node,
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_hardif_neigh_seq_print_text - print the single hop neighbour list * batadv_hardif_neigh_seq_print_text() - print the single hop neighbour list
* @seq: neighbour table seq_file struct * @seq: neighbour table seq_file struct
* @offset: not used * @offset: not used
* *
@ -768,8 +768,8 @@ int batadv_hardif_neigh_seq_print_text(struct seq_file *seq, void *offset)
#endif #endif
/** /**
* batadv_hardif_neigh_dump - Dump to netlink the neighbor infos for a specific * batadv_hardif_neigh_dump() - Dump to netlink the neighbor infos for a
* outgoing interface * specific outgoing interface
* @msg: message to dump into * @msg: message to dump into
* @cb: parameters for the dump * @cb: parameters for the dump
* *
@ -845,7 +845,7 @@ int batadv_hardif_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb)
} }
/** /**
* batadv_orig_ifinfo_release - release orig_ifinfo from lists and queue for * batadv_orig_ifinfo_release() - release orig_ifinfo from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the orig_ifinfo * @ref: kref pointer of the orig_ifinfo
*/ */
@ -868,7 +868,7 @@ static void batadv_orig_ifinfo_release(struct kref *ref)
} }
/** /**
* batadv_orig_ifinfo_put - decrement the refcounter and possibly release * batadv_orig_ifinfo_put() - decrement the refcounter and possibly release
* the orig_ifinfo * the orig_ifinfo
* @orig_ifinfo: the orig_ifinfo object to release * @orig_ifinfo: the orig_ifinfo object to release
*/ */
@ -878,7 +878,7 @@ void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo)
} }
/** /**
* batadv_orig_node_free_rcu - free the orig_node * batadv_orig_node_free_rcu() - free the orig_node
* @rcu: rcu pointer of the orig_node * @rcu: rcu pointer of the orig_node
*/ */
static void batadv_orig_node_free_rcu(struct rcu_head *rcu) static void batadv_orig_node_free_rcu(struct rcu_head *rcu)
@ -899,7 +899,7 @@ static void batadv_orig_node_free_rcu(struct rcu_head *rcu)
} }
/** /**
* batadv_orig_node_release - release orig_node from lists and queue for * batadv_orig_node_release() - release orig_node from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the orig_node * @ref: kref pointer of the orig_node
*/ */
@ -950,7 +950,7 @@ static void batadv_orig_node_release(struct kref *ref)
} }
/** /**
* batadv_orig_node_put - decrement the orig node refcounter and possibly * batadv_orig_node_put() - decrement the orig node refcounter and possibly
* release it * release it
* @orig_node: the orig node to free * @orig_node: the orig node to free
*/ */
@ -992,7 +992,7 @@ void batadv_originator_free(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_orig_node_new - creates a new orig_node * batadv_orig_node_new() - creates a new orig_node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the mac address of the originator * @addr: the mac address of the originator
* *
@ -1071,7 +1071,7 @@ free_orig_node:
} }
/** /**
* batadv_purge_neigh_ifinfo - purge obsolete ifinfo entries from neighbor * batadv_purge_neigh_ifinfo() - purge obsolete ifinfo entries from neighbor
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @neigh: orig node which is to be checked * @neigh: orig node which is to be checked
*/ */
@ -1112,7 +1112,7 @@ batadv_purge_neigh_ifinfo(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_purge_orig_ifinfo - purge obsolete ifinfo entries from originator * batadv_purge_orig_ifinfo() - purge obsolete ifinfo entries from originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node which is to be checked * @orig_node: orig node which is to be checked
* *
@ -1164,7 +1164,7 @@ batadv_purge_orig_ifinfo(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_purge_orig_neighbors - purges neighbors from originator * batadv_purge_orig_neighbors() - purges neighbors from originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node which is to be checked * @orig_node: orig node which is to be checked
* *
@ -1222,7 +1222,7 @@ batadv_purge_orig_neighbors(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_find_best_neighbor - finds the best neighbor after purging * batadv_find_best_neighbor() - finds the best neighbor after purging
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node which is to be checked * @orig_node: orig node which is to be checked
* @if_outgoing: the interface for which the metric should be compared * @if_outgoing: the interface for which the metric should be compared
@ -1257,7 +1257,7 @@ batadv_find_best_neighbor(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_purge_orig_node - purges obsolete information from an orig_node * batadv_purge_orig_node() - purges obsolete information from an orig_node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node which is to be checked * @orig_node: orig node which is to be checked
* *
@ -1409,7 +1409,7 @@ int batadv_orig_seq_print_text(struct seq_file *seq, void *offset)
} }
/** /**
* batadv_orig_hardif_seq_print_text - writes originator infos for a specific * batadv_orig_hardif_seq_print_text() - writes originator infos for a specific
* outgoing interface * outgoing interface
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
* @offset: not used * @offset: not used
@ -1456,7 +1456,7 @@ out:
#endif #endif
/** /**
* batadv_orig_dump - Dump to netlink the originator infos for a specific * batadv_orig_dump() - Dump to netlink the originator infos for a specific
* outgoing interface * outgoing interface
* @msg: message to dump into * @msg: message to dump into
* @cb: parameters for the dump * @cb: parameters for the dump

24
net/batman-adv/routing.c
View file

@ -55,7 +55,7 @@ static int batadv_route_unicast_packet(struct sk_buff *skb,
struct batadv_hard_iface *recv_if); struct batadv_hard_iface *recv_if);
/** /**
* _batadv_update_route - set the router for this originator * _batadv_update_route() - set the router for this originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node which is to be configured * @orig_node: orig node which is to be configured
* @recv_if: the receive interface for which this route is set * @recv_if: the receive interface for which this route is set
@ -119,7 +119,7 @@ static void _batadv_update_route(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_update_route - set the router for this originator * batadv_update_route() - set the router for this originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node which is to be configured * @orig_node: orig node which is to be configured
* @recv_if: the receive interface for which this route is set * @recv_if: the receive interface for which this route is set
@ -146,7 +146,7 @@ out:
} }
/** /**
* batadv_window_protected - checks whether the host restarted and is in the * batadv_window_protected() - checks whether the host restarted and is in the
* protection time. * protection time.
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq_num_diff: difference between the current/received sequence number and * @seq_num_diff: difference between the current/received sequence number and
@ -213,7 +213,7 @@ bool batadv_check_management_packet(struct sk_buff *skb,
} }
/** /**
* batadv_recv_my_icmp_packet - receive an icmp packet locally * batadv_recv_my_icmp_packet() - receive an icmp packet locally
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: icmp packet to process * @skb: icmp packet to process
* *
@ -441,7 +441,7 @@ free_skb:
} }
/** /**
* batadv_check_unicast_packet - Check for malformed unicast packets * batadv_check_unicast_packet() - Check for malformed unicast packets
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check * @skb: packet to check
* @hdr_size: size of header to pull * @hdr_size: size of header to pull
@ -479,7 +479,7 @@ static int batadv_check_unicast_packet(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_last_bonding_get - Get last_bonding_candidate of orig_node * batadv_last_bonding_get() - Get last_bonding_candidate of orig_node
* @orig_node: originator node whose last bonding candidate should be retrieved * @orig_node: originator node whose last bonding candidate should be retrieved
* *
* Return: last bonding candidate of router or NULL if not found * Return: last bonding candidate of router or NULL if not found
@ -502,7 +502,7 @@ batadv_last_bonding_get(struct batadv_orig_node *orig_node)
} }
/** /**
* batadv_last_bonding_replace - Replace last_bonding_candidate of orig_node * batadv_last_bonding_replace() - Replace last_bonding_candidate of orig_node
* @orig_node: originator node whose bonding candidates should be replaced * @orig_node: originator node whose bonding candidates should be replaced
* @new_candidate: new bonding candidate or NULL * @new_candidate: new bonding candidate or NULL
*/ */
@ -525,7 +525,7 @@ batadv_last_bonding_replace(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_find_router - find a suitable router for this originator * batadv_find_router() - find a suitable router for this originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: the destination node * @orig_node: the destination node
* @recv_if: pointer to interface this packet was received on * @recv_if: pointer to interface this packet was received on
@ -742,7 +742,7 @@ free_skb:
} }
/** /**
* batadv_reroute_unicast_packet - update the unicast header for re-routing * batadv_reroute_unicast_packet() - update the unicast header for re-routing
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @unicast_packet: the unicast header to be updated * @unicast_packet: the unicast header to be updated
* @dst_addr: the payload destination * @dst_addr: the payload destination
@ -905,7 +905,7 @@ static bool batadv_check_unicast_ttvn(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_recv_unhandled_unicast_packet - receive and process packets which * batadv_recv_unhandled_unicast_packet() - receive and process packets which
* are in the unicast number space but not yet known to the implementation * are in the unicast number space but not yet known to the implementation
* @skb: unicast tvlv packet to process * @skb: unicast tvlv packet to process
* @recv_if: pointer to interface this packet was received on * @recv_if: pointer to interface this packet was received on
@ -1037,7 +1037,7 @@ free_skb:
} }
/** /**
* batadv_recv_unicast_tvlv - receive and process unicast tvlv packets * batadv_recv_unicast_tvlv() - receive and process unicast tvlv packets
* @skb: unicast tvlv packet to process * @skb: unicast tvlv packet to process
* @recv_if: pointer to interface this packet was received on * @recv_if: pointer to interface this packet was received on
* *
@ -1091,7 +1091,7 @@ free_skb:
} }
/** /**
* batadv_recv_frag_packet - process received fragment * batadv_recv_frag_packet() - process received fragment
* @skb: the received fragment * @skb: the received fragment
* @recv_if: interface that the skb is received on * @recv_if: interface that the skb is received on
* *

45
net/batman-adv/send.c
View file

@ -55,7 +55,7 @@
static void batadv_send_outstanding_bcast_packet(struct work_struct *work); static void batadv_send_outstanding_bcast_packet(struct work_struct *work);
/** /**
* batadv_send_skb_packet - send an already prepared packet * batadv_send_skb_packet() - send an already prepared packet
* @skb: the packet to send * @skb: the packet to send
* @hard_iface: the interface to use to send the broadcast packet * @hard_iface: the interface to use to send the broadcast packet
* @dst_addr: the payload destination * @dst_addr: the payload destination
@ -154,7 +154,7 @@ int batadv_send_unicast_skb(struct sk_buff *skb,
} }
/** /**
* batadv_send_skb_to_orig - Lookup next-hop and transmit skb. * batadv_send_skb_to_orig() - Lookup next-hop and transmit skb.
* @skb: Packet to be transmitted. * @skb: Packet to be transmitted.
* @orig_node: Final destination of the packet. * @orig_node: Final destination of the packet.
* @recv_if: Interface used when receiving the packet (can be NULL). * @recv_if: Interface used when receiving the packet (can be NULL).
@ -217,7 +217,7 @@ free_skb:
} }
/** /**
* batadv_send_skb_push_fill_unicast - extend the buffer and initialize the * batadv_send_skb_push_fill_unicast() - extend the buffer and initialize the
* common fields for unicast packets * common fields for unicast packets
* @skb: the skb carrying the unicast header to initialize * @skb: the skb carrying the unicast header to initialize
* @hdr_size: amount of bytes to push at the beginning of the skb * @hdr_size: amount of bytes to push at the beginning of the skb
@ -250,7 +250,7 @@ batadv_send_skb_push_fill_unicast(struct sk_buff *skb, int hdr_size,
} }
/** /**
* batadv_send_skb_prepare_unicast - encapsulate an skb with a unicast header * batadv_send_skb_prepare_unicast() - encapsulate an skb with a unicast header
* @skb: the skb containing the payload to encapsulate * @skb: the skb containing the payload to encapsulate
* @orig_node: the destination node * @orig_node: the destination node
* *
@ -265,7 +265,7 @@ static bool batadv_send_skb_prepare_unicast(struct sk_buff *skb,
} }
/** /**
* batadv_send_skb_prepare_unicast_4addr - encapsulate an skb with a * batadv_send_skb_prepare_unicast_4addr() - encapsulate an skb with a
* unicast 4addr header * unicast 4addr header
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the skb containing the payload to encapsulate * @skb: the skb containing the payload to encapsulate
@ -309,7 +309,7 @@ out:
} }
/** /**
* batadv_send_skb_unicast - encapsulate and send an skb via unicast * batadv_send_skb_unicast() - encapsulate and send an skb via unicast
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: payload to send * @skb: payload to send
* @packet_type: the batman unicast packet type to use * @packet_type: the batman unicast packet type to use
@ -379,7 +379,7 @@ out:
} }
/** /**
* batadv_send_skb_via_tt_generic - send an skb via TT lookup * batadv_send_skb_via_tt_generic() - send an skb via TT lookup
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: payload to send * @skb: payload to send
* @packet_type: the batman unicast packet type to use * @packet_type: the batman unicast packet type to use
@ -426,7 +426,7 @@ int batadv_send_skb_via_tt_generic(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_send_skb_via_gw - send an skb via gateway lookup * batadv_send_skb_via_gw() - send an skb via gateway lookup
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: payload to send * @skb: payload to send
* @vid: the vid to be used to search the translation table * @vid: the vid to be used to search the translation table
@ -453,7 +453,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb,
} }
/** /**
* batadv_forw_packet_free - free a forwarding packet * batadv_forw_packet_free() - free a forwarding packet
* @forw_packet: The packet to free * @forw_packet: The packet to free
* @dropped: whether the packet is freed because is is dropped * @dropped: whether the packet is freed because is is dropped
* *
@ -478,7 +478,7 @@ void batadv_forw_packet_free(struct batadv_forw_packet *forw_packet,
} }
/** /**
* batadv_forw_packet_alloc - allocate a forwarding packet * batadv_forw_packet_alloc() - allocate a forwarding packet
* @if_incoming: The (optional) if_incoming to be grabbed * @if_incoming: The (optional) if_incoming to be grabbed
* @if_outgoing: The (optional) if_outgoing to be grabbed * @if_outgoing: The (optional) if_outgoing to be grabbed
* @queue_left: The (optional) queue counter to decrease * @queue_left: The (optional) queue counter to decrease
@ -544,7 +544,7 @@ err:
} }
/** /**
* batadv_forw_packet_was_stolen - check whether someone stole this packet * batadv_forw_packet_was_stolen() - check whether someone stole this packet
* @forw_packet: the forwarding packet to check * @forw_packet: the forwarding packet to check
* *
* This function checks whether the given forwarding packet was claimed by * This function checks whether the given forwarding packet was claimed by
@ -559,7 +559,7 @@ batadv_forw_packet_was_stolen(struct batadv_forw_packet *forw_packet)
} }
/** /**
* batadv_forw_packet_steal - claim a forw_packet for free() * batadv_forw_packet_steal() - claim a forw_packet for free()
* @forw_packet: the forwarding packet to steal * @forw_packet: the forwarding packet to steal
* @lock: a key to the store to steal from (e.g. forw_{bat,bcast}_list_lock) * @lock: a key to the store to steal from (e.g. forw_{bat,bcast}_list_lock)
* *
@ -590,7 +590,7 @@ bool batadv_forw_packet_steal(struct batadv_forw_packet *forw_packet,
} }
/** /**
* batadv_forw_packet_list_steal - claim a list of forward packets for free() * batadv_forw_packet_list_steal() - claim a list of forward packets for free()
* @forw_list: the to be stolen forward packets * @forw_list: the to be stolen forward packets
* @cleanup_list: a backup pointer, to be able to dispose the packet later * @cleanup_list: a backup pointer, to be able to dispose the packet later
* @hard_iface: the interface to steal forward packets from * @hard_iface: the interface to steal forward packets from
@ -626,7 +626,7 @@ batadv_forw_packet_list_steal(struct hlist_head *forw_list,
} }
/** /**
* batadv_forw_packet_list_free - free a list of forward packets * batadv_forw_packet_list_free() - free a list of forward packets
* @head: a list of to be freed forw_packets * @head: a list of to be freed forw_packets
* *
* This function cancels the scheduling of any packet in the provided list, * This function cancels the scheduling of any packet in the provided list,
@ -650,7 +650,7 @@ static void batadv_forw_packet_list_free(struct hlist_head *head)
} }
/** /**
* batadv_forw_packet_queue - try to queue a forwarding packet * batadv_forw_packet_queue() - try to queue a forwarding packet
* @forw_packet: the forwarding packet to queue * @forw_packet: the forwarding packet to queue
* @lock: a key to the store (e.g. forw_{bat,bcast}_list_lock) * @lock: a key to the store (e.g. forw_{bat,bcast}_list_lock)
* @head: the shelve to queue it on (e.g. forw_{bat,bcast}_list) * @head: the shelve to queue it on (e.g. forw_{bat,bcast}_list)
@ -694,7 +694,7 @@ static void batadv_forw_packet_queue(struct batadv_forw_packet *forw_packet,
} }
/** /**
* batadv_forw_packet_bcast_queue - try to queue a broadcast packet * batadv_forw_packet_bcast_queue() - try to queue a broadcast packet
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @forw_packet: the forwarding packet to queue * @forw_packet: the forwarding packet to queue
* @send_time: timestamp (jiffies) when the packet is to be sent * @send_time: timestamp (jiffies) when the packet is to be sent
@ -713,7 +713,7 @@ batadv_forw_packet_bcast_queue(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_forw_packet_ogmv1_queue - try to queue an OGMv1 packet * batadv_forw_packet_ogmv1_queue() - try to queue an OGMv1 packet
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @forw_packet: the forwarding packet to queue * @forw_packet: the forwarding packet to queue
* @send_time: timestamp (jiffies) when the packet is to be sent * @send_time: timestamp (jiffies) when the packet is to be sent
@ -731,7 +731,7 @@ void batadv_forw_packet_ogmv1_queue(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_add_bcast_packet_to_list - queue broadcast packet for multiple sends * batadv_add_bcast_packet_to_list() - queue broadcast packet for multiple sends
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: broadcast packet to add * @skb: broadcast packet to add
* @delay: number of jiffies to wait before sending * @delay: number of jiffies to wait before sending
@ -791,7 +791,7 @@ err:
} }
/** /**
* batadv_forw_packet_bcasts_left - check if a retransmission is necessary * batadv_forw_packet_bcasts_left() - check if a retransmission is necessary
* @forw_packet: the forwarding packet to check * @forw_packet: the forwarding packet to check
* @hard_iface: the interface to check on * @hard_iface: the interface to check on
* *
@ -819,7 +819,8 @@ batadv_forw_packet_bcasts_left(struct batadv_forw_packet *forw_packet,
} }
/** /**
* batadv_forw_packet_bcasts_inc - increment retransmission counter of a packet * batadv_forw_packet_bcasts_inc() - increment retransmission counter of a
* packet
* @forw_packet: the packet to increase the counter for * @forw_packet: the packet to increase the counter for
*/ */
static void static void
@ -829,7 +830,7 @@ batadv_forw_packet_bcasts_inc(struct batadv_forw_packet *forw_packet)
} }
/** /**
* batadv_forw_packet_is_rebroadcast - check packet for previous transmissions * batadv_forw_packet_is_rebroadcast() - check packet for previous transmissions
* @forw_packet: the packet to check * @forw_packet: the packet to check
* *
* Return: True if this packet was transmitted before, false otherwise. * Return: True if this packet was transmitted before, false otherwise.
@ -954,7 +955,7 @@ out:
} }
/** /**
* batadv_purge_outstanding_packets - stop/purge scheduled bcast/OGMv1 packets * batadv_purge_outstanding_packets() - stop/purge scheduled bcast/OGMv1 packets
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @hard_iface: the hard interface to cancel and purge bcast/ogm packets on * @hard_iface: the hard interface to cancel and purge bcast/ogm packets on
* *

4
net/batman-adv/send.h
View file

@ -77,7 +77,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb,
unsigned short vid); unsigned short vid);
/** /**
* batadv_send_skb_via_tt - send an skb via TT lookup * batadv_send_skb_via_tt() - send an skb via TT lookup
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the payload to send * @skb: the payload to send
* @dst_hint: can be used to override the destination contained in the skb * @dst_hint: can be used to override the destination contained in the skb
@ -98,7 +98,7 @@ static inline int batadv_send_skb_via_tt(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_send_skb_via_tt_4addr - send an skb via TT lookup * batadv_send_skb_via_tt_4addr() - send an skb via TT lookup
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the payload to send * @skb: the payload to send
* @packet_subtype: the unicast 4addr packet subtype to use * @packet_subtype: the unicast 4addr packet subtype to use

41
net/batman-adv/soft-interface.c
View file

@ -97,7 +97,7 @@ static int batadv_interface_release(struct net_device *dev)
} }
/** /**
* batadv_sum_counter - Sum the cpu-local counters for index 'idx' * batadv_sum_counter() - Sum the cpu-local counters for index 'idx'
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @idx: index of counter to sum up * @idx: index of counter to sum up
* *
@ -170,7 +170,7 @@ static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu)
} }
/** /**
* batadv_interface_set_rx_mode - set the rx mode of a device * batadv_interface_set_rx_mode() - set the rx mode of a device
* @dev: registered network device to modify * @dev: registered network device to modify
* *
* We do not actually need to set any rx filters for the virtual batman * We do not actually need to set any rx filters for the virtual batman
@ -390,7 +390,7 @@ end:
} }
/** /**
* batadv_interface_rx - receive ethernet frame on local batman-adv interface * batadv_interface_rx() - receive ethernet frame on local batman-adv interface
* @soft_iface: local interface which will receive the ethernet frame * @soft_iface: local interface which will receive the ethernet frame
* @skb: ethernet frame for @soft_iface * @skb: ethernet frame for @soft_iface
* @hdr_size: size of already parsed batman-adv header * @hdr_size: size of already parsed batman-adv header
@ -502,8 +502,8 @@ out:
} }
/** /**
* batadv_softif_vlan_release - release vlan from lists and queue for free after * batadv_softif_vlan_release() - release vlan from lists and queue for free
* rcu grace period * after rcu grace period
* @ref: kref pointer of the vlan object * @ref: kref pointer of the vlan object
*/ */
static void batadv_softif_vlan_release(struct kref *ref) static void batadv_softif_vlan_release(struct kref *ref)
@ -520,7 +520,7 @@ static void batadv_softif_vlan_release(struct kref *ref)
} }
/** /**
* batadv_softif_vlan_put - decrease the vlan object refcounter and * batadv_softif_vlan_put() - decrease the vlan object refcounter and
* possibly release it * possibly release it
* @vlan: the vlan object to release * @vlan: the vlan object to release
*/ */
@ -533,7 +533,7 @@ void batadv_softif_vlan_put(struct batadv_softif_vlan *vlan)
} }
/** /**
* batadv_softif_vlan_get - get the vlan object for a specific vid * batadv_softif_vlan_get() - get the vlan object for a specific vid
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: the identifier of the vlan object to retrieve * @vid: the identifier of the vlan object to retrieve
* *
@ -562,7 +562,7 @@ struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_softif_create_vlan - allocate the needed resources for a new vlan * batadv_softif_create_vlan() - allocate the needed resources for a new vlan
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: the VLAN identifier * @vid: the VLAN identifier
* *
@ -614,7 +614,7 @@ int batadv_softif_create_vlan(struct batadv_priv *bat_priv, unsigned short vid)
} }
/** /**
* batadv_softif_destroy_vlan - remove and destroy a softif_vlan object * batadv_softif_destroy_vlan() - remove and destroy a softif_vlan object
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vlan: the object to remove * @vlan: the object to remove
*/ */
@ -632,7 +632,7 @@ static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_interface_add_vid - ndo_add_vid API implementation * batadv_interface_add_vid() - ndo_add_vid API implementation
* @dev: the netdev of the mesh interface * @dev: the netdev of the mesh interface
* @proto: protocol of the the vlan id * @proto: protocol of the the vlan id
* @vid: identifier of the new vlan * @vid: identifier of the new vlan
@ -690,7 +690,7 @@ static int batadv_interface_add_vid(struct net_device *dev, __be16 proto,
} }
/** /**
* batadv_interface_kill_vid - ndo_kill_vid API implementation * batadv_interface_kill_vid() - ndo_kill_vid API implementation
* @dev: the netdev of the mesh interface * @dev: the netdev of the mesh interface
* @proto: protocol of the the vlan id * @proto: protocol of the the vlan id
* @vid: identifier of the deleted vlan * @vid: identifier of the deleted vlan
@ -733,7 +733,7 @@ static struct lock_class_key batadv_netdev_xmit_lock_key;
static struct lock_class_key batadv_netdev_addr_lock_key; static struct lock_class_key batadv_netdev_addr_lock_key;
/** /**
* batadv_set_lockdep_class_one - Set lockdep class for a single tx queue * batadv_set_lockdep_class_one() - Set lockdep class for a single tx queue
* @dev: device which owns the tx queue * @dev: device which owns the tx queue
* @txq: tx queue to modify * @txq: tx queue to modify
* @_unused: always NULL * @_unused: always NULL
@ -746,7 +746,7 @@ static void batadv_set_lockdep_class_one(struct net_device *dev,
} }
/** /**
* batadv_set_lockdep_class - Set txq and addr_list lockdep class * batadv_set_lockdep_class() - Set txq and addr_list lockdep class
* @dev: network device to modify * @dev: network device to modify
*/ */
static void batadv_set_lockdep_class(struct net_device *dev) static void batadv_set_lockdep_class(struct net_device *dev)
@ -756,7 +756,7 @@ static void batadv_set_lockdep_class(struct net_device *dev)
} }
/** /**
* batadv_softif_init_late - late stage initialization of soft interface * batadv_softif_init_late() - late stage initialization of soft interface
* @dev: registered network device to modify * @dev: registered network device to modify
* *
* Return: error code on failures * Return: error code on failures
@ -861,7 +861,7 @@ free_bat_counters:
} }
/** /**
* batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface * batadv_softif_slave_add() - Add a slave interface to a batadv_soft_interface
* @dev: batadv_soft_interface used as master interface * @dev: batadv_soft_interface used as master interface
* @slave_dev: net_device which should become the slave interface * @slave_dev: net_device which should become the slave interface
* @extack: extended ACK report struct * @extack: extended ACK report struct
@ -889,7 +889,7 @@ out:
} }
/** /**
* batadv_softif_slave_del - Delete a slave iface from a batadv_soft_interface * batadv_softif_slave_del() - Delete a slave iface from a batadv_soft_interface
* @dev: batadv_soft_interface used as master interface * @dev: batadv_soft_interface used as master interface
* @slave_dev: net_device which should be removed from the master interface * @slave_dev: net_device which should be removed from the master interface
* *
@ -1024,7 +1024,7 @@ static const struct ethtool_ops batadv_ethtool_ops = {
}; };
/** /**
* batadv_softif_free - Deconstructor of batadv_soft_interface * batadv_softif_free() - Deconstructor of batadv_soft_interface
* @dev: Device to cleanup and remove * @dev: Device to cleanup and remove
*/ */
static void batadv_softif_free(struct net_device *dev) static void batadv_softif_free(struct net_device *dev)
@ -1040,7 +1040,7 @@ static void batadv_softif_free(struct net_device *dev)
} }
/** /**
* batadv_softif_init_early - early stage initialization of soft interface * batadv_softif_init_early() - early stage initialization of soft interface
* @dev: registered network device to modify * @dev: registered network device to modify
*/ */
static void batadv_softif_init_early(struct net_device *dev) static void batadv_softif_init_early(struct net_device *dev)
@ -1090,7 +1090,7 @@ struct net_device *batadv_softif_create(struct net *net, const char *name)
} }
/** /**
* batadv_softif_destroy_sysfs - deletion of batadv_soft_interface via sysfs * batadv_softif_destroy_sysfs() - deletion of batadv_soft_interface via sysfs
* @soft_iface: the to-be-removed batman-adv interface * @soft_iface: the to-be-removed batman-adv interface
*/ */
void batadv_softif_destroy_sysfs(struct net_device *soft_iface) void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
@ -1112,7 +1112,8 @@ void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
} }
/** /**
* batadv_softif_destroy_netlink - deletion of batadv_soft_interface via netlink * batadv_softif_destroy_netlink() - deletion of batadv_soft_interface via
* netlink
* @soft_iface: the to-be-removed batman-adv interface * @soft_iface: the to-be-removed batman-adv interface
* @head: list pointer * @head: list pointer
*/ */

20
net/batman-adv/sysfs.c
View file

@ -65,7 +65,7 @@ static struct batadv_priv *batadv_kobj_to_batpriv(struct kobject *obj)
} }
/** /**
* batadv_vlan_kobj_to_batpriv - convert a vlan kobj in the associated batpriv * batadv_vlan_kobj_to_batpriv() - convert a vlan kobj in the associated batpriv
* @obj: kobject to covert * @obj: kobject to covert
* *
* Return: the associated batadv_priv struct. * Return: the associated batadv_priv struct.
@ -85,7 +85,7 @@ static struct batadv_priv *batadv_vlan_kobj_to_batpriv(struct kobject *obj)
} }
/** /**
* batadv_kobj_to_vlan - convert a kobj in the associated softif_vlan struct * batadv_kobj_to_vlan() - convert a kobj in the associated softif_vlan struct
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @obj: kobject to covert * @obj: kobject to covert
* *
@ -600,7 +600,7 @@ static ssize_t batadv_store_gw_bwidth(struct kobject *kobj,
} }
/** /**
* batadv_show_isolation_mark - print the current isolation mark/mask * batadv_show_isolation_mark() - print the current isolation mark/mask
* @kobj: kobject representing the private mesh sysfs directory * @kobj: kobject representing the private mesh sysfs directory
* @attr: the batman-adv attribute the user is interacting with * @attr: the batman-adv attribute the user is interacting with
* @buff: the buffer that will contain the data to send back to the user * @buff: the buffer that will contain the data to send back to the user
@ -618,8 +618,8 @@ static ssize_t batadv_show_isolation_mark(struct kobject *kobj,
} }
/** /**
* batadv_store_isolation_mark - parse and store the isolation mark/mask entered * batadv_store_isolation_mark() - parse and store the isolation mark/mask
* by the user * entered by the user
* @kobj: kobject representing the private mesh sysfs directory * @kobj: kobject representing the private mesh sysfs directory
* @attr: the batman-adv attribute the user is interacting with * @attr: the batman-adv attribute the user is interacting with
* @buff: the buffer containing the user data * @buff: the buffer containing the user data
@ -790,7 +790,7 @@ void batadv_sysfs_del_meshif(struct net_device *dev)
} }
/** /**
* batadv_sysfs_add_vlan - add all the needed sysfs objects for the new vlan * batadv_sysfs_add_vlan() - add all the needed sysfs objects for the new vlan
* @dev: netdev of the mesh interface * @dev: netdev of the mesh interface
* @vlan: private data of the newly added VLAN interface * @vlan: private data of the newly added VLAN interface
* *
@ -851,7 +851,7 @@ out:
} }
/** /**
* batadv_sysfs_del_vlan - remove all the sysfs objects for a given VLAN * batadv_sysfs_del_vlan() - remove all the sysfs objects for a given VLAN
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vlan: the private data of the VLAN to destroy * @vlan: the private data of the VLAN to destroy
*/ */
@ -896,7 +896,7 @@ static ssize_t batadv_show_mesh_iface(struct kobject *kobj,
} }
/** /**
* batadv_store_mesh_iface_finish - store new hardif mesh_iface state * batadv_store_mesh_iface_finish() - store new hardif mesh_iface state
* @net_dev: netdevice to add/remove to/from batman-adv soft-interface * @net_dev: netdevice to add/remove to/from batman-adv soft-interface
* @ifname: name of soft-interface to modify * @ifname: name of soft-interface to modify
* *
@ -949,7 +949,7 @@ out:
} }
/** /**
* batadv_store_mesh_iface_work - store new hardif mesh_iface state * batadv_store_mesh_iface_work() - store new hardif mesh_iface state
* @work: work queue item * @work: work queue item
* *
* Changes the parts of the hard+soft interface which can not be modified under * Changes the parts of the hard+soft interface which can not be modified under
@ -1045,7 +1045,7 @@ static ssize_t batadv_show_iface_status(struct kobject *kobj,
#ifdef CONFIG_BATMAN_ADV_BATMAN_V #ifdef CONFIG_BATMAN_ADV_BATMAN_V
/** /**
* batadv_store_throughput_override - parse and store throughput override * batadv_store_throughput_override() - parse and store throughput override
* entered by the user * entered by the user
* @kobj: kobject representing the private mesh sysfs directory * @kobj: kobject representing the private mesh sysfs directory
* @attr: the batman-adv attribute the user is interacting with * @attr: the batman-adv attribute the user is interacting with

70
net/batman-adv/tp_meter.c
View file

@ -98,7 +98,7 @@
static u8 batadv_tp_prerandom[4096] __read_mostly; static u8 batadv_tp_prerandom[4096] __read_mostly;
/** /**
* batadv_tp_session_cookie - generate session cookie based on session ids * batadv_tp_session_cookie() - generate session cookie based on session ids
* @session: TP session identifier * @session: TP session identifier
* @icmp_uid: icmp pseudo uid of the tp session * @icmp_uid: icmp pseudo uid of the tp session
* *
@ -116,7 +116,7 @@ static u32 batadv_tp_session_cookie(const u8 session[2], u8 icmp_uid)
} }
/** /**
* batadv_tp_cwnd - compute the new cwnd size * batadv_tp_cwnd() - compute the new cwnd size
* @base: base cwnd size value * @base: base cwnd size value
* @increment: the value to add to base to get the new size * @increment: the value to add to base to get the new size
* @min: minumim cwnd value (usually MSS) * @min: minumim cwnd value (usually MSS)
@ -141,7 +141,7 @@ static u32 batadv_tp_cwnd(u32 base, u32 increment, u32 min)
} }
/** /**
* batadv_tp_updated_cwnd - update the Congestion Windows * batadv_tp_updated_cwnd() - update the Congestion Windows
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
* @mss: maximum segment size of transmission * @mss: maximum segment size of transmission
* *
@ -177,7 +177,7 @@ static void batadv_tp_update_cwnd(struct batadv_tp_vars *tp_vars, u32 mss)
} }
/** /**
* batadv_tp_update_rto - calculate new retransmission timeout * batadv_tp_update_rto() - calculate new retransmission timeout
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
* @new_rtt: new roundtrip time in msec * @new_rtt: new roundtrip time in msec
*/ */
@ -213,7 +213,7 @@ static void batadv_tp_update_rto(struct batadv_tp_vars *tp_vars,
} }
/** /**
* batadv_tp_batctl_notify - send client status result to client * batadv_tp_batctl_notify() - send client status result to client
* @reason: reason for tp meter session stop * @reason: reason for tp meter session stop
* @dst: destination of tp_meter session * @dst: destination of tp_meter session
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
@ -245,7 +245,7 @@ static void batadv_tp_batctl_notify(enum batadv_tp_meter_reason reason,
} }
/** /**
* batadv_tp_batctl_error_notify - send client error result to client * batadv_tp_batctl_error_notify() - send client error result to client
* @reason: reason for tp meter session stop * @reason: reason for tp meter session stop
* @dst: destination of tp_meter session * @dst: destination of tp_meter session
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
@ -260,7 +260,7 @@ static void batadv_tp_batctl_error_notify(enum batadv_tp_meter_reason reason,
} }
/** /**
* batadv_tp_list_find - find a tp_vars object in the global list * batadv_tp_list_find() - find a tp_vars object in the global list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @dst: the other endpoint MAC address to look for * @dst: the other endpoint MAC address to look for
* *
@ -295,7 +295,8 @@ static struct batadv_tp_vars *batadv_tp_list_find(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tp_list_find_session - find tp_vars session object in the global list * batadv_tp_list_find_session() - find tp_vars session object in the global
* list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @dst: the other endpoint MAC address to look for * @dst: the other endpoint MAC address to look for
* @session: session identifier * @session: session identifier
@ -336,7 +337,7 @@ batadv_tp_list_find_session(struct batadv_priv *bat_priv, const u8 *dst,
} }
/** /**
* batadv_tp_vars_release - release batadv_tp_vars from lists and queue for * batadv_tp_vars_release() - release batadv_tp_vars from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the batadv_tp_vars * @ref: kref pointer of the batadv_tp_vars
*/ */
@ -361,7 +362,7 @@ static void batadv_tp_vars_release(struct kref *ref)
} }
/** /**
* batadv_tp_vars_put - decrement the batadv_tp_vars refcounter and possibly * batadv_tp_vars_put() - decrement the batadv_tp_vars refcounter and possibly
* release it * release it
* @tp_vars: the private data of the current TP meter session to be free'd * @tp_vars: the private data of the current TP meter session to be free'd
*/ */
@ -371,7 +372,7 @@ static void batadv_tp_vars_put(struct batadv_tp_vars *tp_vars)
} }
/** /**
* batadv_tp_sender_cleanup - cleanup sender data and drop and timer * batadv_tp_sender_cleanup() - cleanup sender data and drop and timer
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tp_vars: the private data of the current TP meter session to cleanup * @tp_vars: the private data of the current TP meter session to cleanup
*/ */
@ -401,7 +402,7 @@ static void batadv_tp_sender_cleanup(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tp_sender_end - print info about ended session and inform client * batadv_tp_sender_end() - print info about ended session and inform client
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
*/ */
@ -434,7 +435,7 @@ static void batadv_tp_sender_end(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tp_sender_shutdown - let sender thread/timer stop gracefully * batadv_tp_sender_shutdown() - let sender thread/timer stop gracefully
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
* @reason: reason for tp meter session stop * @reason: reason for tp meter session stop
*/ */
@ -448,7 +449,7 @@ static void batadv_tp_sender_shutdown(struct batadv_tp_vars *tp_vars,
} }
/** /**
* batadv_tp_sender_finish - stop sender session after test_length was reached * batadv_tp_sender_finish() - stop sender session after test_length was reached
* @work: delayed work reference of the related tp_vars * @work: delayed work reference of the related tp_vars
*/ */
static void batadv_tp_sender_finish(struct work_struct *work) static void batadv_tp_sender_finish(struct work_struct *work)
@ -464,7 +465,7 @@ static void batadv_tp_sender_finish(struct work_struct *work)
} }
/** /**
* batadv_tp_reset_sender_timer - reschedule the sender timer * batadv_tp_reset_sender_timer() - reschedule the sender timer
* @tp_vars: the private TP meter data for this session * @tp_vars: the private TP meter data for this session
* *
* Reschedule the timer using tp_vars->rto as delay * Reschedule the timer using tp_vars->rto as delay
@ -482,7 +483,7 @@ static void batadv_tp_reset_sender_timer(struct batadv_tp_vars *tp_vars)
} }
/** /**
* batadv_tp_sender_timeout - timer that fires in case of packet loss * batadv_tp_sender_timeout() - timer that fires in case of packet loss
* @arg: address of the related tp_vars * @arg: address of the related tp_vars
* *
* If fired it means that there was packet loss. * If fired it means that there was packet loss.
@ -532,7 +533,7 @@ static void batadv_tp_sender_timeout(struct timer_list *t)
} }
/** /**
* batadv_tp_fill_prerandom - Fill buffer with prefetched random bytes * batadv_tp_fill_prerandom() - Fill buffer with prefetched random bytes
* @tp_vars: the private TP meter data for this session * @tp_vars: the private TP meter data for this session
* @buf: Buffer to fill with bytes * @buf: Buffer to fill with bytes
* @nbytes: amount of pseudorandom bytes * @nbytes: amount of pseudorandom bytes
@ -564,7 +565,7 @@ static void batadv_tp_fill_prerandom(struct batadv_tp_vars *tp_vars,
} }
/** /**
* batadv_tp_send_msg - send a single message * batadv_tp_send_msg() - send a single message
* @tp_vars: the private TP meter data for this session * @tp_vars: the private TP meter data for this session
* @src: source mac address * @src: source mac address
* @orig_node: the originator of the destination * @orig_node: the originator of the destination
@ -624,7 +625,7 @@ static int batadv_tp_send_msg(struct batadv_tp_vars *tp_vars, const u8 *src,
} }
/** /**
* batadv_tp_recv_ack - ACK receiving function * batadv_tp_recv_ack() - ACK receiving function
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the buffer containing the received packet * @skb: the buffer containing the received packet
* *
@ -766,7 +767,7 @@ out:
} }
/** /**
* batadv_tp_avail - check if congestion window is not full * batadv_tp_avail() - check if congestion window is not full
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
* @payload_len: size of the payload of a single message * @payload_len: size of the payload of a single message
* *
@ -784,7 +785,7 @@ static bool batadv_tp_avail(struct batadv_tp_vars *tp_vars,
} }
/** /**
* batadv_tp_wait_available - wait until congestion window becomes free or * batadv_tp_wait_available() - wait until congestion window becomes free or
* timeout is reached * timeout is reached
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
* @plen: size of the payload of a single message * @plen: size of the payload of a single message
@ -806,7 +807,7 @@ static int batadv_tp_wait_available(struct batadv_tp_vars *tp_vars, size_t plen)
} }
/** /**
* batadv_tp_send - main sending thread of a tp meter session * batadv_tp_send() - main sending thread of a tp meter session
* @arg: address of the related tp_vars * @arg: address of the related tp_vars
* *
* Return: nothing, this function never returns * Return: nothing, this function never returns
@ -905,7 +906,8 @@ out:
} }
/** /**
* batadv_tp_start_kthread - start new thread which manages the tp meter sender * batadv_tp_start_kthread() - start new thread which manages the tp meter
* sender
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
*/ */
static void batadv_tp_start_kthread(struct batadv_tp_vars *tp_vars) static void batadv_tp_start_kthread(struct batadv_tp_vars *tp_vars)
@ -936,7 +938,7 @@ static void batadv_tp_start_kthread(struct batadv_tp_vars *tp_vars)
} }
/** /**
* batadv_tp_start - start a new tp meter session * batadv_tp_start() - start a new tp meter session
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @dst: the receiver MAC address * @dst: the receiver MAC address
* @test_length: test length in milliseconds * @test_length: test length in milliseconds
@ -1061,7 +1063,7 @@ void batadv_tp_start(struct batadv_priv *bat_priv, const u8 *dst,
} }
/** /**
* batadv_tp_stop - stop currently running tp meter session * batadv_tp_stop() - stop currently running tp meter session
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @dst: the receiver MAC address * @dst: the receiver MAC address
* @return_value: reason for tp meter session stop * @return_value: reason for tp meter session stop
@ -1093,7 +1095,7 @@ out:
} }
/** /**
* batadv_tp_reset_receiver_timer - reset the receiver shutdown timer * batadv_tp_reset_receiver_timer() - reset the receiver shutdown timer
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
* *
* start the receiver shutdown timer or reset it if already started * start the receiver shutdown timer or reset it if already started
@ -1105,7 +1107,7 @@ static void batadv_tp_reset_receiver_timer(struct batadv_tp_vars *tp_vars)
} }
/** /**
* batadv_tp_receiver_shutdown - stop a tp meter receiver when timeout is * batadv_tp_receiver_shutdown() - stop a tp meter receiver when timeout is
* reached without received ack * reached without received ack
* @arg: address of the related tp_vars * @arg: address of the related tp_vars
*/ */
@ -1150,7 +1152,7 @@ static void batadv_tp_receiver_shutdown(struct timer_list *t)
} }
/** /**
* batadv_tp_send_ack - send an ACK packet * batadv_tp_send_ack() - send an ACK packet
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @dst: the mac address of the destination originator * @dst: the mac address of the destination originator
* @seq: the sequence number to ACK * @seq: the sequence number to ACK
@ -1222,7 +1224,7 @@ out:
} }
/** /**
* batadv_tp_handle_out_of_order - store an out of order packet * batadv_tp_handle_out_of_order() - store an out of order packet
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
* @skb: the buffer containing the received packet * @skb: the buffer containing the received packet
* *
@ -1298,7 +1300,7 @@ out:
} }
/** /**
* batadv_tp_ack_unordered - update number received bytes in current stream * batadv_tp_ack_unordered() - update number received bytes in current stream
* without gaps * without gaps
* @tp_vars: the private data of the current TP meter session * @tp_vars: the private data of the current TP meter session
*/ */
@ -1331,7 +1333,7 @@ static void batadv_tp_ack_unordered(struct batadv_tp_vars *tp_vars)
} }
/** /**
* batadv_tp_init_recv - return matching or create new receiver tp_vars * batadv_tp_init_recv() - return matching or create new receiver tp_vars
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @icmp: received icmp tp msg * @icmp: received icmp tp msg
* *
@ -1384,7 +1386,7 @@ out_unlock:
} }
/** /**
* batadv_tp_recv_msg - process a single data message * batadv_tp_recv_msg() - process a single data message
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the buffer containing the received packet * @skb: the buffer containing the received packet
* *
@ -1469,7 +1471,7 @@ out:
} }
/** /**
* batadv_tp_meter_recv - main TP Meter receiving function * batadv_tp_meter_recv() - main TP Meter receiving function
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the buffer containing the received packet * @skb: the buffer containing the received packet
*/ */
@ -1495,7 +1497,7 @@ void batadv_tp_meter_recv(struct batadv_priv *bat_priv, struct sk_buff *skb)
} }
/** /**
* batadv_tp_meter_init - initialize global tp_meter structures * batadv_tp_meter_init() - initialize global tp_meter structures
*/ */
void __init batadv_tp_meter_init(void) void __init batadv_tp_meter_init(void)
{ {

189
net/batman-adv/translation-table.c
View file

@ -88,7 +88,7 @@ static void batadv_tt_global_del(struct batadv_priv *bat_priv,
bool roaming); bool roaming);
/** /**
* batadv_compare_tt - check if two TT entries are the same * batadv_compare_tt() - check if two TT entries are the same
* @node: the list element pointer of the first TT entry * @node: the list element pointer of the first TT entry
* @data2: pointer to the tt_common_entry of the second TT entry * @data2: pointer to the tt_common_entry of the second TT entry
* *
@ -107,7 +107,7 @@ static bool batadv_compare_tt(const struct hlist_node *node, const void *data2)
} }
/** /**
* batadv_choose_tt - return the index of the tt entry in the hash table * batadv_choose_tt() - return the index of the tt entry in the hash table
* @data: pointer to the tt_common_entry object to map * @data: pointer to the tt_common_entry object to map
* @size: the size of the hash table * @size: the size of the hash table
* *
@ -127,7 +127,7 @@ static inline u32 batadv_choose_tt(const void *data, u32 size)
} }
/** /**
* batadv_tt_hash_find - look for a client in the given hash table * batadv_tt_hash_find() - look for a client in the given hash table
* @hash: the hash table to search * @hash: the hash table to search
* @addr: the mac address of the client to look for * @addr: the mac address of the client to look for
* @vid: VLAN identifier * @vid: VLAN identifier
@ -172,7 +172,7 @@ batadv_tt_hash_find(struct batadv_hashtable *hash, const u8 *addr,
} }
/** /**
* batadv_tt_local_hash_find - search the local table for a given client * batadv_tt_local_hash_find() - search the local table for a given client
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the mac address of the client to look for * @addr: the mac address of the client to look for
* @vid: VLAN identifier * @vid: VLAN identifier
@ -197,7 +197,7 @@ batadv_tt_local_hash_find(struct batadv_priv *bat_priv, const u8 *addr,
} }
/** /**
* batadv_tt_global_hash_find - search the global table for a given client * batadv_tt_global_hash_find() - search the global table for a given client
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the mac address of the client to look for * @addr: the mac address of the client to look for
* @vid: VLAN identifier * @vid: VLAN identifier
@ -222,7 +222,7 @@ batadv_tt_global_hash_find(struct batadv_priv *bat_priv, const u8 *addr,
} }
/** /**
* batadv_tt_local_entry_free_rcu - free the tt_local_entry * batadv_tt_local_entry_free_rcu() - free the tt_local_entry
* @rcu: rcu pointer of the tt_local_entry * @rcu: rcu pointer of the tt_local_entry
*/ */
static void batadv_tt_local_entry_free_rcu(struct rcu_head *rcu) static void batadv_tt_local_entry_free_rcu(struct rcu_head *rcu)
@ -236,7 +236,7 @@ static void batadv_tt_local_entry_free_rcu(struct rcu_head *rcu)
} }
/** /**
* batadv_tt_local_entry_release - release tt_local_entry from lists and queue * batadv_tt_local_entry_release() - release tt_local_entry from lists and queue
* for free after rcu grace period * for free after rcu grace period
* @ref: kref pointer of the nc_node * @ref: kref pointer of the nc_node
*/ */
@ -253,7 +253,7 @@ static void batadv_tt_local_entry_release(struct kref *ref)
} }
/** /**
* batadv_tt_local_entry_put - decrement the tt_local_entry refcounter and * batadv_tt_local_entry_put() - decrement the tt_local_entry refcounter and
* possibly release it * possibly release it
* @tt_local_entry: tt_local_entry to be free'd * @tt_local_entry: tt_local_entry to be free'd
*/ */
@ -265,7 +265,7 @@ batadv_tt_local_entry_put(struct batadv_tt_local_entry *tt_local_entry)
} }
/** /**
* batadv_tt_global_entry_free_rcu - free the tt_global_entry * batadv_tt_global_entry_free_rcu() - free the tt_global_entry
* @rcu: rcu pointer of the tt_global_entry * @rcu: rcu pointer of the tt_global_entry
*/ */
static void batadv_tt_global_entry_free_rcu(struct rcu_head *rcu) static void batadv_tt_global_entry_free_rcu(struct rcu_head *rcu)
@ -279,8 +279,8 @@ static void batadv_tt_global_entry_free_rcu(struct rcu_head *rcu)
} }
/** /**
* batadv_tt_global_entry_release - release tt_global_entry from lists and queue * batadv_tt_global_entry_release() - release tt_global_entry from lists and
* for free after rcu grace period * queue for free after rcu grace period
* @ref: kref pointer of the nc_node * @ref: kref pointer of the nc_node
*/ */
static void batadv_tt_global_entry_release(struct kref *ref) static void batadv_tt_global_entry_release(struct kref *ref)
@ -296,7 +296,7 @@ static void batadv_tt_global_entry_release(struct kref *ref)
} }
/** /**
* batadv_tt_global_entry_put - decrement the tt_global_entry refcounter and * batadv_tt_global_entry_put() - decrement the tt_global_entry refcounter and
* possibly release it * possibly release it
* @tt_global_entry: tt_global_entry to be free'd * @tt_global_entry: tt_global_entry to be free'd
*/ */
@ -308,7 +308,7 @@ batadv_tt_global_entry_put(struct batadv_tt_global_entry *tt_global_entry)
} }
/** /**
* batadv_tt_global_hash_count - count the number of orig entries * batadv_tt_global_hash_count() - count the number of orig entries
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the mac address of the client to count entries for * @addr: the mac address of the client to count entries for
* @vid: VLAN identifier * @vid: VLAN identifier
@ -333,8 +333,8 @@ int batadv_tt_global_hash_count(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_local_size_mod - change the size by v of the local table identified * batadv_tt_local_size_mod() - change the size by v of the local table
* by vid * identified by vid
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: the VLAN identifier of the sub-table to change * @vid: the VLAN identifier of the sub-table to change
* @v: the amount to sum to the local table size * @v: the amount to sum to the local table size
@ -354,8 +354,8 @@ static void batadv_tt_local_size_mod(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_local_size_inc - increase by one the local table size for the given * batadv_tt_local_size_inc() - increase by one the local table size for the
* vid * given vid
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: the VLAN identifier * @vid: the VLAN identifier
*/ */
@ -366,8 +366,8 @@ static void batadv_tt_local_size_inc(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_local_size_dec - decrease by one the local table size for the given * batadv_tt_local_size_dec() - decrease by one the local table size for the
* vid * given vid
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: the VLAN identifier * @vid: the VLAN identifier
*/ */
@ -378,7 +378,7 @@ static void batadv_tt_local_size_dec(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_global_size_mod - change the size by v of the global table * batadv_tt_global_size_mod() - change the size by v of the global table
* for orig_node identified by vid * for orig_node identified by vid
* @orig_node: the originator for which the table has to be modified * @orig_node: the originator for which the table has to be modified
* @vid: the VLAN identifier * @vid: the VLAN identifier
@ -406,7 +406,7 @@ static void batadv_tt_global_size_mod(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_tt_global_size_inc - increase by one the global table size for the * batadv_tt_global_size_inc() - increase by one the global table size for the
* given vid * given vid
* @orig_node: the originator which global table size has to be decreased * @orig_node: the originator which global table size has to be decreased
* @vid: the vlan identifier * @vid: the vlan identifier
@ -418,7 +418,7 @@ static void batadv_tt_global_size_inc(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_tt_global_size_dec - decrease by one the global table size for the * batadv_tt_global_size_dec() - decrease by one the global table size for the
* given vid * given vid
* @orig_node: the originator which global table size has to be decreased * @orig_node: the originator which global table size has to be decreased
* @vid: the vlan identifier * @vid: the vlan identifier
@ -430,7 +430,7 @@ static void batadv_tt_global_size_dec(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_tt_orig_list_entry_free_rcu - free the orig_entry * batadv_tt_orig_list_entry_free_rcu() - free the orig_entry
* @rcu: rcu pointer of the orig_entry * @rcu: rcu pointer of the orig_entry
*/ */
static void batadv_tt_orig_list_entry_free_rcu(struct rcu_head *rcu) static void batadv_tt_orig_list_entry_free_rcu(struct rcu_head *rcu)
@ -443,7 +443,7 @@ static void batadv_tt_orig_list_entry_free_rcu(struct rcu_head *rcu)
} }
/** /**
* batadv_tt_orig_list_entry_release - release tt orig entry from lists and * batadv_tt_orig_list_entry_release() - release tt orig entry from lists and
* queue for free after rcu grace period * queue for free after rcu grace period
* @ref: kref pointer of the tt orig entry * @ref: kref pointer of the tt orig entry
*/ */
@ -459,7 +459,7 @@ static void batadv_tt_orig_list_entry_release(struct kref *ref)
} }
/** /**
* batadv_tt_orig_list_entry_put - decrement the tt orig entry refcounter and * batadv_tt_orig_list_entry_put() - decrement the tt orig entry refcounter and
* possibly release it * possibly release it
* @orig_entry: tt orig entry to be free'd * @orig_entry: tt orig entry to be free'd
*/ */
@ -470,7 +470,7 @@ batadv_tt_orig_list_entry_put(struct batadv_tt_orig_list_entry *orig_entry)
} }
/** /**
* batadv_tt_local_event - store a local TT event (ADD/DEL) * batadv_tt_local_event() - store a local TT event (ADD/DEL)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tt_local_entry: the TT entry involved in the event * @tt_local_entry: the TT entry involved in the event
* @event_flags: flags to store in the event structure * @event_flags: flags to store in the event structure
@ -545,7 +545,7 @@ unlock:
} }
/** /**
* batadv_tt_len - compute length in bytes of given number of tt changes * batadv_tt_len() - compute length in bytes of given number of tt changes
* @changes_num: number of tt changes * @changes_num: number of tt changes
* *
* Return: computed length in bytes. * Return: computed length in bytes.
@ -556,7 +556,7 @@ static int batadv_tt_len(int changes_num)
} }
/** /**
* batadv_tt_entries - compute the number of entries fitting in tt_len bytes * batadv_tt_entries() - compute the number of entries fitting in tt_len bytes
* @tt_len: available space * @tt_len: available space
* *
* Return: the number of entries. * Return: the number of entries.
@ -567,8 +567,8 @@ static u16 batadv_tt_entries(u16 tt_len)
} }
/** /**
* batadv_tt_local_table_transmit_size - calculates the local translation table * batadv_tt_local_table_transmit_size() - calculates the local translation
* size when transmitted over the air * table size when transmitted over the air
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: local translation table size in bytes. * Return: local translation table size in bytes.
@ -627,7 +627,7 @@ static void batadv_tt_global_free(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_local_add - add a new client to the local table or update an * batadv_tt_local_add() - add a new client to the local table or update an
* existing client * existing client
* @soft_iface: netdev struct of the mesh interface * @soft_iface: netdev struct of the mesh interface
* @addr: the mac address of the client to add * @addr: the mac address of the client to add
@ -832,7 +832,7 @@ out:
} }
/** /**
* batadv_tt_prepare_tvlv_global_data - prepare the TVLV TT header to send * batadv_tt_prepare_tvlv_global_data() - prepare the TVLV TT header to send
* within a TT Response directed to another node * within a TT Response directed to another node
* @orig_node: originator for which the TT data has to be prepared * @orig_node: originator for which the TT data has to be prepared
* @tt_data: uninitialised pointer to the address of the TVLV buffer * @tt_data: uninitialised pointer to the address of the TVLV buffer
@ -905,8 +905,8 @@ out:
} }
/** /**
* batadv_tt_prepare_tvlv_local_data - allocate and prepare the TT TVLV for this * batadv_tt_prepare_tvlv_local_data() - allocate and prepare the TT TVLV for
* node * this node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tt_data: uninitialised pointer to the address of the TVLV buffer * @tt_data: uninitialised pointer to the address of the TVLV buffer
* @tt_change: uninitialised pointer to the address of the area where the TT * @tt_change: uninitialised pointer to the address of the area where the TT
@ -979,8 +979,8 @@ out:
} }
/** /**
* batadv_tt_tvlv_container_update - update the translation table tvlv container * batadv_tt_tvlv_container_update() - update the translation table tvlv
* after local tt changes have been committed * container after local tt changes have been committed
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_tt_tvlv_container_update(struct batadv_priv *bat_priv) static void batadv_tt_tvlv_container_update(struct batadv_priv *bat_priv)
@ -1125,7 +1125,7 @@ out:
#endif #endif
/** /**
* batadv_tt_local_dump_entry - Dump one TT local entry into a message * batadv_tt_local_dump_entry() - Dump one TT local entry into a message
* @msg :Netlink message to dump into * @msg :Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -1181,7 +1181,7 @@ batadv_tt_local_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_tt_local_dump_bucket - Dump one TT local bucket into a message * batadv_tt_local_dump_bucket() - Dump one TT local bucket into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -1218,7 +1218,7 @@ batadv_tt_local_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_tt_local_dump - Dump TT local entries into a message * batadv_tt_local_dump() - Dump TT local entries into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Parameters from query * @cb: Parameters from query
* *
@ -1302,7 +1302,7 @@ batadv_tt_local_set_pending(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_local_remove - logically remove an entry from the local table * batadv_tt_local_remove() - logically remove an entry from the local table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the MAC address of the client to remove * @addr: the MAC address of the client to remove
* @vid: VLAN identifier * @vid: VLAN identifier
@ -1364,7 +1364,7 @@ out:
} }
/** /**
* batadv_tt_local_purge_list - purge inactive tt local entries * batadv_tt_local_purge_list() - purge inactive tt local entries
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @head: pointer to the list containing the local tt entries * @head: pointer to the list containing the local tt entries
* @timeout: parameter deciding whether a given tt local entry is considered * @timeout: parameter deciding whether a given tt local entry is considered
@ -1399,7 +1399,7 @@ static void batadv_tt_local_purge_list(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_local_purge - purge inactive tt local entries * batadv_tt_local_purge() - purge inactive tt local entries
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @timeout: parameter deciding whether a given tt local entry is considered * @timeout: parameter deciding whether a given tt local entry is considered
* inactive or not * inactive or not
@ -1492,7 +1492,7 @@ static void batadv_tt_changes_list_free(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tt_global_orig_entry_find - find a TT orig_list_entry * batadv_tt_global_orig_entry_find() - find a TT orig_list_entry
* @entry: the TT global entry where the orig_list_entry has to be * @entry: the TT global entry where the orig_list_entry has to be
* extracted from * extracted from
* @orig_node: the originator for which the orig_list_entry has to be found * @orig_node: the originator for which the orig_list_entry has to be found
@ -1526,8 +1526,8 @@ batadv_tt_global_orig_entry_find(const struct batadv_tt_global_entry *entry,
} }
/** /**
* batadv_tt_global_entry_has_orig - check if a TT global entry is also handled * batadv_tt_global_entry_has_orig() - check if a TT global entry is also
* by a given originator * handled by a given originator
* @entry: the TT global entry to check * @entry: the TT global entry to check
* @orig_node: the originator to search in the list * @orig_node: the originator to search in the list
* *
@ -1552,7 +1552,7 @@ batadv_tt_global_entry_has_orig(const struct batadv_tt_global_entry *entry,
} }
/** /**
* batadv_tt_global_sync_flags - update TT sync flags * batadv_tt_global_sync_flags() - update TT sync flags
* @tt_global: the TT global entry to update sync flags in * @tt_global: the TT global entry to update sync flags in
* *
* Updates the sync flag bits in the tt_global flag attribute with a logical * Updates the sync flag bits in the tt_global flag attribute with a logical
@ -1576,7 +1576,7 @@ batadv_tt_global_sync_flags(struct batadv_tt_global_entry *tt_global)
} }
/** /**
* batadv_tt_global_orig_entry_add - add or update a TT orig entry * batadv_tt_global_orig_entry_add() - add or update a TT orig entry
* @tt_global: the TT global entry to add an orig entry in * @tt_global: the TT global entry to add an orig entry in
* @orig_node: the originator to add an orig entry for * @orig_node: the originator to add an orig entry for
* @ttvn: translation table version number of this changeset * @ttvn: translation table version number of this changeset
@ -1626,7 +1626,7 @@ out:
} }
/** /**
* batadv_tt_global_add - add a new TT global entry or update an existing one * batadv_tt_global_add() - add a new TT global entry or update an existing one
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: the originator announcing the client * @orig_node: the originator announcing the client
* @tt_addr: the mac address of the non-mesh client * @tt_addr: the mac address of the non-mesh client
@ -1798,7 +1798,7 @@ out:
} }
/** /**
* batadv_transtable_best_orig - Get best originator list entry from tt entry * batadv_transtable_best_orig() - Get best originator list entry from tt entry
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tt_global_entry: global translation table entry to be analyzed * @tt_global_entry: global translation table entry to be analyzed
* *
@ -1844,8 +1844,8 @@ batadv_transtable_best_orig(struct batadv_priv *bat_priv,
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_tt_global_print_entry - print all orig nodes who announce the address * batadv_tt_global_print_entry() - print all orig nodes who announce the
* for this global entry * address for this global entry
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tt_global_entry: global translation table entry to be printed * @tt_global_entry: global translation table entry to be printed
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
@ -1969,7 +1969,7 @@ out:
#endif #endif
/** /**
* batadv_tt_global_dump_subentry - Dump all TT local entries into a message * batadv_tt_global_dump_subentry() - Dump all TT local entries into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -2030,7 +2030,7 @@ batadv_tt_global_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_tt_global_dump_entry - Dump one TT global entry into a message * batadv_tt_global_dump_entry() - Dump one TT global entry into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -2075,7 +2075,7 @@ batadv_tt_global_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_tt_global_dump_bucket - Dump one TT local bucket into a message * batadv_tt_global_dump_bucket() - Dump one TT local bucket into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
@ -2114,7 +2114,7 @@ batadv_tt_global_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_tt_global_dump - Dump TT global entries into a message * batadv_tt_global_dump() - Dump TT global entries into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Parameters from query * @cb: Parameters from query
* *
@ -2182,7 +2182,7 @@ int batadv_tt_global_dump(struct sk_buff *msg, struct netlink_callback *cb)
} }
/** /**
* _batadv_tt_global_del_orig_entry - remove and free an orig_entry * _batadv_tt_global_del_orig_entry() - remove and free an orig_entry
* @tt_global_entry: the global entry to remove the orig_entry from * @tt_global_entry: the global entry to remove the orig_entry from
* @orig_entry: the orig entry to remove and free * @orig_entry: the orig entry to remove and free
* *
@ -2224,7 +2224,7 @@ batadv_tt_global_del_orig_list(struct batadv_tt_global_entry *tt_global_entry)
} }
/** /**
* batadv_tt_global_del_orig_node - remove orig_node from a global tt entry * batadv_tt_global_del_orig_node() - remove orig_node from a global tt entry
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tt_global_entry: the global entry to remove the orig_node from * @tt_global_entry: the global entry to remove the orig_node from
* @orig_node: the originator announcing the client * @orig_node: the originator announcing the client
@ -2303,7 +2303,7 @@ batadv_tt_global_del_roaming(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_global_del - remove a client from the global table * batadv_tt_global_del() - remove a client from the global table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: an originator serving this client * @orig_node: an originator serving this client
* @addr: the mac address of the client * @addr: the mac address of the client
@ -2369,8 +2369,8 @@ out:
} }
/** /**
* batadv_tt_global_del_orig - remove all the TT global entries belonging to the * batadv_tt_global_del_orig() - remove all the TT global entries belonging to
* given originator matching the provided vid * the given originator matching the provided vid
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: the originator owning the entries to remove * @orig_node: the originator owning the entries to remove
* @match_vid: the VLAN identifier to match. If negative all the entries will be * @match_vid: the VLAN identifier to match. If negative all the entries will be
@ -2541,7 +2541,7 @@ _batadv_is_ap_isolated(struct batadv_tt_local_entry *tt_local_entry,
} }
/** /**
* batadv_transtable_search - get the mesh destination for a given client * batadv_transtable_search() - get the mesh destination for a given client
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @src: mac address of the source client * @src: mac address of the source client
* @addr: mac address of the destination client * @addr: mac address of the destination client
@ -2601,7 +2601,7 @@ out:
} }
/** /**
* batadv_tt_global_crc - calculates the checksum of the local table belonging * batadv_tt_global_crc() - calculates the checksum of the local table belonging
* to the given orig_node * to the given orig_node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: originator for which the CRC should be computed * @orig_node: originator for which the CRC should be computed
@ -2696,7 +2696,7 @@ static u32 batadv_tt_global_crc(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_local_crc - calculates the checksum of the local table * batadv_tt_local_crc() - calculates the checksum of the local table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: VLAN identifier for which the CRC32 has to be computed * @vid: VLAN identifier for which the CRC32 has to be computed
* *
@ -2753,7 +2753,7 @@ static u32 batadv_tt_local_crc(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_req_node_release - free tt_req node entry * batadv_tt_req_node_release() - free tt_req node entry
* @ref: kref pointer of the tt req_node entry * @ref: kref pointer of the tt req_node entry
*/ */
static void batadv_tt_req_node_release(struct kref *ref) static void batadv_tt_req_node_release(struct kref *ref)
@ -2766,7 +2766,7 @@ static void batadv_tt_req_node_release(struct kref *ref)
} }
/** /**
* batadv_tt_req_node_put - decrement the tt_req_node refcounter and * batadv_tt_req_node_put() - decrement the tt_req_node refcounter and
* possibly release it * possibly release it
* @tt_req_node: tt_req_node to be free'd * @tt_req_node: tt_req_node to be free'd
*/ */
@ -2828,7 +2828,7 @@ static void batadv_tt_req_purge(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tt_req_node_new - search and possibly create a tt_req_node object * batadv_tt_req_node_new() - search and possibly create a tt_req_node object
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node this request is being issued for * @orig_node: orig node this request is being issued for
* *
@ -2865,7 +2865,7 @@ unlock:
} }
/** /**
* batadv_tt_local_valid - verify that given tt entry is a valid one * batadv_tt_local_valid() - verify that given tt entry is a valid one
* @entry_ptr: to be checked local tt entry * @entry_ptr: to be checked local tt entry
* @data_ptr: not used but definition required to satisfy the callback prototype * @data_ptr: not used but definition required to satisfy the callback prototype
* *
@ -2899,7 +2899,7 @@ static bool batadv_tt_global_valid(const void *entry_ptr,
} }
/** /**
* batadv_tt_tvlv_generate - fill the tvlv buff with the tt entries from the * batadv_tt_tvlv_generate() - fill the tvlv buff with the tt entries from the
* specified tt hash * specified tt hash
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @hash: hash table containing the tt entries * @hash: hash table containing the tt entries
@ -2950,7 +2950,7 @@ static void batadv_tt_tvlv_generate(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_global_check_crc - check if all the CRCs are correct * batadv_tt_global_check_crc() - check if all the CRCs are correct
* @orig_node: originator for which the CRCs have to be checked * @orig_node: originator for which the CRCs have to be checked
* @tt_vlan: pointer to the first tvlv VLAN entry * @tt_vlan: pointer to the first tvlv VLAN entry
* @num_vlan: number of tvlv VLAN entries * @num_vlan: number of tvlv VLAN entries
@ -3007,7 +3007,7 @@ static bool batadv_tt_global_check_crc(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_tt_local_update_crc - update all the local CRCs * batadv_tt_local_update_crc() - update all the local CRCs
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_tt_local_update_crc(struct batadv_priv *bat_priv) static void batadv_tt_local_update_crc(struct batadv_priv *bat_priv)
@ -3023,7 +3023,7 @@ static void batadv_tt_local_update_crc(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tt_global_update_crc - update all the global CRCs for this orig_node * batadv_tt_global_update_crc() - update all the global CRCs for this orig_node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: the orig_node for which the CRCs have to be updated * @orig_node: the orig_node for which the CRCs have to be updated
*/ */
@ -3050,7 +3050,7 @@ static void batadv_tt_global_update_crc(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_send_tt_request - send a TT Request message to a given node * batadv_send_tt_request() - send a TT Request message to a given node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @dst_orig_node: the destination of the message * @dst_orig_node: the destination of the message
* @ttvn: the version number that the source of the message is looking for * @ttvn: the version number that the source of the message is looking for
@ -3139,7 +3139,7 @@ out:
} }
/** /**
* batadv_send_other_tt_response - send reply to tt request concerning another * batadv_send_other_tt_response() - send reply to tt request concerning another
* node's translation table * node's translation table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tt_data: tt data containing the tt request information * @tt_data: tt data containing the tt request information
@ -3272,8 +3272,8 @@ out:
} }
/** /**
* batadv_send_my_tt_response - send reply to tt request concerning this node's * batadv_send_my_tt_response() - send reply to tt request concerning this
* translation table * node's translation table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tt_data: tt data containing the tt request information * @tt_data: tt data containing the tt request information
* @req_src: mac address of tt request sender * @req_src: mac address of tt request sender
@ -3390,7 +3390,7 @@ out:
} }
/** /**
* batadv_send_tt_response - send reply to tt request * batadv_send_tt_response() - send reply to tt request
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tt_data: tt data containing the tt request information * @tt_data: tt data containing the tt request information
* @req_src: mac address of tt request sender * @req_src: mac address of tt request sender
@ -3486,7 +3486,7 @@ static void batadv_tt_update_changes(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_is_my_client - check if a client is served by the local node * batadv_is_my_client() - check if a client is served by the local node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the mac address of the client to check * @addr: the mac address of the client to check
* @vid: VLAN identifier * @vid: VLAN identifier
@ -3516,7 +3516,7 @@ out:
} }
/** /**
* batadv_handle_tt_response - process incoming tt reply * batadv_handle_tt_response() - process incoming tt reply
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tt_data: tt data containing the tt request information * @tt_data: tt data containing the tt request information
* @resp_src: mac address of tt reply sender * @resp_src: mac address of tt reply sender
@ -3609,7 +3609,7 @@ static void batadv_tt_roam_purge(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tt_check_roam_count - check if a client has roamed too frequently * batadv_tt_check_roam_count() - check if a client has roamed too frequently
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @client: mac address of the roaming client * @client: mac address of the roaming client
* *
@ -3664,7 +3664,7 @@ unlock:
} }
/** /**
* batadv_send_roam_adv - send a roaming advertisement message * batadv_send_roam_adv() - send a roaming advertisement message
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @client: mac address of the roaming client * @client: mac address of the roaming client
* @vid: VLAN identifier * @vid: VLAN identifier
@ -3746,7 +3746,7 @@ void batadv_tt_free(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tt_local_set_flags - set or unset the specified flags on the local * batadv_tt_local_set_flags() - set or unset the specified flags on the local
* table and possibly count them in the TT size * table and possibly count them in the TT size
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @flags: the flag to switch * @flags: the flag to switch
@ -3832,7 +3832,7 @@ static void batadv_tt_local_purge_pending_clients(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tt_local_commit_changes_nolock - commit all pending local tt changes * batadv_tt_local_commit_changes_nolock() - commit all pending local tt changes
* which have been queued in the time since the last commit * which have been queued in the time since the last commit
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
@ -3865,7 +3865,7 @@ static void batadv_tt_local_commit_changes_nolock(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tt_local_commit_changes - commit all pending local tt changes which * batadv_tt_local_commit_changes() - commit all pending local tt changes which
* have been queued in the time since the last commit * have been queued in the time since the last commit
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
@ -3911,7 +3911,7 @@ vlan_put:
} }
/** /**
* batadv_tt_update_orig - update global translation table with new tt * batadv_tt_update_orig() - update global translation table with new tt
* information received via ogms * information received via ogms
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: the orig_node of the ogm * @orig_node: the orig_node of the ogm
@ -3996,7 +3996,7 @@ request_table:
} }
/** /**
* batadv_tt_global_client_is_roaming - check if a client is marked as roaming * batadv_tt_global_client_is_roaming() - check if a client is marked as roaming
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the mac address of the client to check * @addr: the mac address of the client to check
* @vid: VLAN identifier * @vid: VLAN identifier
@ -4022,7 +4022,7 @@ out:
} }
/** /**
* batadv_tt_local_client_is_roaming - tells whether the client is roaming * batadv_tt_local_client_is_roaming() - tells whether the client is roaming
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the mac address of the local client to query * @addr: the mac address of the local client to query
* @vid: VLAN identifier * @vid: VLAN identifier
@ -4071,7 +4071,7 @@ bool batadv_tt_add_temporary_global_entry(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_local_resize_to_mtu - resize the local translation table fit the * batadv_tt_local_resize_to_mtu() - resize the local translation table fit the
* maximum packet size that can be transported through the mesh * maximum packet size that can be transported through the mesh
* @soft_iface: netdev struct of the mesh interface * @soft_iface: netdev struct of the mesh interface
* *
@ -4112,7 +4112,7 @@ void batadv_tt_local_resize_to_mtu(struct net_device *soft_iface)
} }
/** /**
* batadv_tt_tvlv_ogm_handler_v1 - process incoming tt tvlv container * batadv_tt_tvlv_ogm_handler_v1() - process incoming tt tvlv container
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node of the ogm * @orig: the orig_node of the ogm
* @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
@ -4151,7 +4151,7 @@ static void batadv_tt_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_tvlv_unicast_handler_v1 - process incoming (unicast) tt tvlv * batadv_tt_tvlv_unicast_handler_v1() - process incoming (unicast) tt tvlv
* container * container
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @src: mac address of tt tvlv sender * @src: mac address of tt tvlv sender
@ -4233,7 +4233,8 @@ static int batadv_tt_tvlv_unicast_handler_v1(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_roam_tvlv_unicast_handler_v1 - process incoming tt roam tvlv container * batadv_roam_tvlv_unicast_handler_v1() - process incoming tt roam tvlv
* container
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @src: mac address of tt tvlv sender * @src: mac address of tt tvlv sender
* @dst: mac address of tt tvlv recipient * @dst: mac address of tt tvlv recipient
@ -4283,7 +4284,7 @@ out:
} }
/** /**
* batadv_tt_init - initialise the translation table internals * batadv_tt_init() - initialise the translation table internals
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: 0 on success or negative error number in case of failure. * Return: 0 on success or negative error number in case of failure.
@ -4319,7 +4320,7 @@ int batadv_tt_init(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tt_global_is_isolated - check if a client is marked as isolated * batadv_tt_global_is_isolated() - check if a client is marked as isolated
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the mac address of the client * @addr: the mac address of the client
* @vid: the identifier of the VLAN where this client is connected * @vid: the identifier of the VLAN where this client is connected
@ -4345,7 +4346,7 @@ bool batadv_tt_global_is_isolated(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tt_cache_init - Initialize tt memory object cache * batadv_tt_cache_init() - Initialize tt memory object cache
* *
* Return: 0 on success or negative error number in case of failure. * Return: 0 on success or negative error number in case of failure.
*/ */
@ -4414,7 +4415,7 @@ err_tt_tl_destroy:
} }
/** /**
* batadv_tt_cache_destroy - Destroy tt memory object cache * batadv_tt_cache_destroy() - Destroy tt memory object cache
*/ */
void batadv_tt_cache_destroy(void) void batadv_tt_cache_destroy(void)
{ {

38
net/batman-adv/tvlv.c
View file

@ -43,7 +43,7 @@
#include "tvlv.h" #include "tvlv.h"
/** /**
* batadv_tvlv_handler_release - release tvlv handler from lists and queue for * batadv_tvlv_handler_release() - release tvlv handler from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the tvlv * @ref: kref pointer of the tvlv
*/ */
@ -56,7 +56,7 @@ static void batadv_tvlv_handler_release(struct kref *ref)
} }
/** /**
* batadv_tvlv_handler_put - decrement the tvlv container refcounter and * batadv_tvlv_handler_put() - decrement the tvlv container refcounter and
* possibly release it * possibly release it
* @tvlv_handler: the tvlv handler to free * @tvlv_handler: the tvlv handler to free
*/ */
@ -66,7 +66,7 @@ static void batadv_tvlv_handler_put(struct batadv_tvlv_handler *tvlv_handler)
} }
/** /**
* batadv_tvlv_handler_get - retrieve tvlv handler from the tvlv handler list * batadv_tvlv_handler_get() - retrieve tvlv handler from the tvlv handler list
* based on the provided type and version (both need to match) * based on the provided type and version (both need to match)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv handler type to look for * @type: tvlv handler type to look for
@ -100,7 +100,7 @@ batadv_tvlv_handler_get(struct batadv_priv *bat_priv, u8 type, u8 version)
} }
/** /**
* batadv_tvlv_container_release - release tvlv from lists and free * batadv_tvlv_container_release() - release tvlv from lists and free
* @ref: kref pointer of the tvlv * @ref: kref pointer of the tvlv
*/ */
static void batadv_tvlv_container_release(struct kref *ref) static void batadv_tvlv_container_release(struct kref *ref)
@ -112,7 +112,7 @@ static void batadv_tvlv_container_release(struct kref *ref)
} }
/** /**
* batadv_tvlv_container_put - decrement the tvlv container refcounter and * batadv_tvlv_container_put() - decrement the tvlv container refcounter and
* possibly release it * possibly release it
* @tvlv: the tvlv container to free * @tvlv: the tvlv container to free
*/ */
@ -122,7 +122,7 @@ static void batadv_tvlv_container_put(struct batadv_tvlv_container *tvlv)
} }
/** /**
* batadv_tvlv_container_get - retrieve tvlv container from the tvlv container * batadv_tvlv_container_get() - retrieve tvlv container from the tvlv container
* list based on the provided type and version (both need to match) * list based on the provided type and version (both need to match)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv container type to look for * @type: tvlv container type to look for
@ -156,7 +156,7 @@ batadv_tvlv_container_get(struct batadv_priv *bat_priv, u8 type, u8 version)
} }
/** /**
* batadv_tvlv_container_list_size - calculate the size of the tvlv container * batadv_tvlv_container_list_size() - calculate the size of the tvlv container
* list entries * list entries
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
@ -181,8 +181,8 @@ static u16 batadv_tvlv_container_list_size(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tvlv_container_remove - remove tvlv container from the tvlv container * batadv_tvlv_container_remove() - remove tvlv container from the tvlv
* list * container list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tvlv: the to be removed tvlv container * @tvlv: the to be removed tvlv container
* *
@ -205,7 +205,7 @@ static void batadv_tvlv_container_remove(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_container_unregister - unregister tvlv container based on the * batadv_tvlv_container_unregister() - unregister tvlv container based on the
* provided type and version (both need to match) * provided type and version (both need to match)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv container type to unregister * @type: tvlv container type to unregister
@ -223,7 +223,7 @@ void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_container_register - register tvlv type, version and content * batadv_tvlv_container_register() - register tvlv type, version and content
* to be propagated with each (primary interface) OGM * to be propagated with each (primary interface) OGM
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv container type * @type: tvlv container type
@ -268,7 +268,7 @@ void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_realloc_packet_buff - reallocate packet buffer to accommodate * batadv_tvlv_realloc_packet_buff() - reallocate packet buffer to accommodate
* requested packet size * requested packet size
* @packet_buff: packet buffer * @packet_buff: packet buffer
* @packet_buff_len: packet buffer size * @packet_buff_len: packet buffer size
@ -301,7 +301,7 @@ static bool batadv_tvlv_realloc_packet_buff(unsigned char **packet_buff,
} }
/** /**
* batadv_tvlv_container_ogm_append - append tvlv container content to given * batadv_tvlv_container_ogm_append() - append tvlv container content to given
* OGM packet buffer * OGM packet buffer
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @packet_buff: ogm packet buffer * @packet_buff: ogm packet buffer
@ -354,7 +354,7 @@ end:
} }
/** /**
* batadv_tvlv_call_handler - parse the given tvlv buffer to call the * batadv_tvlv_call_handler() - parse the given tvlv buffer to call the
* appropriate handlers * appropriate handlers
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tvlv_handler: tvlv callback function handling the tvlv content * @tvlv_handler: tvlv callback function handling the tvlv content
@ -408,7 +408,7 @@ static int batadv_tvlv_call_handler(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_containers_process - parse the given tvlv buffer to call the * batadv_tvlv_containers_process() - parse the given tvlv buffer to call the
* appropriate handlers * appropriate handlers
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ogm_source: flag indicating whether the tvlv is an ogm or a unicast packet * @ogm_source: flag indicating whether the tvlv is an ogm or a unicast packet
@ -475,7 +475,7 @@ int batadv_tvlv_containers_process(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_ogm_receive - process an incoming ogm and call the appropriate * batadv_tvlv_ogm_receive() - process an incoming ogm and call the appropriate
* handlers * handlers
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @batadv_ogm_packet: ogm packet containing the tvlv containers * @batadv_ogm_packet: ogm packet containing the tvlv containers
@ -502,7 +502,7 @@ void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_handler_register - register tvlv handler based on the provided * batadv_tvlv_handler_register() - register tvlv handler based on the provided
* type and version (both need to match) for ogm tvlv payload and/or unicast * type and version (both need to match) for ogm tvlv payload and/or unicast
* payload * payload
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
@ -557,7 +557,7 @@ void batadv_tvlv_handler_register(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_handler_unregister - unregister tvlv handler based on the * batadv_tvlv_handler_unregister() - unregister tvlv handler based on the
* provided type and version (both need to match) * provided type and version (both need to match)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv handler type to be unregistered * @type: tvlv handler type to be unregistered
@ -580,7 +580,7 @@ void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_unicast_send - send a unicast packet with tvlv payload to the * batadv_tvlv_unicast_send() - send a unicast packet with tvlv payload to the
* specified host * specified host
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @src: source mac address of the unicast packet * @src: source mac address of the unicast packet