summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven Eckelmann <sven@narfation.org>2017-12-02 13:51:47 -0500
committerSimon Wunderlich <sw@simonwunderlich.de>2017-12-15 11:29:20 -0500
commit7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419 (patch)
treea32a07bc993013e2a88a75322ae4bb89e93a3049
parent6a3038f07c59152fb640a3cd274afdf909640e4b (diff)
batman-adv: Use parentheses in function kernel-doc
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>
-rw-r--r--net/batman-adv/bat_algo.c7
-rw-r--r--net/batman-adv/bat_iv_ogm.c80
-rw-r--r--net/batman-adv/bat_v.c48
-rw-r--r--net/batman-adv/bat_v_elp.c24
-rw-r--r--net/batman-adv/bat_v_ogm.c34
-rw-r--r--net/batman-adv/bitarray.c2
-rw-r--r--net/batman-adv/bitarray.h2
-rw-r--r--net/batman-adv/bridge_loop_avoidance.c109
-rw-r--r--net/batman-adv/bridge_loop_avoidance.h4
-rw-r--r--net/batman-adv/debugfs.c12
-rw-r--r--net/batman-adv/distributed-arp-table.c77
-rw-r--r--net/batman-adv/distributed-arp-table.h6
-rw-r--r--net/batman-adv/fragmentation.c20
-rw-r--r--net/batman-adv/fragmentation.h2
-rw-r--r--net/batman-adv/gateway_client.c24
-rw-r--r--net/batman-adv/gateway_common.c18
-rw-r--r--net/batman-adv/hard-interface.c26
-rw-r--r--net/batman-adv/hard-interface.h2
-rw-r--r--net/batman-adv/hash.h2
-rw-r--r--net/batman-adv/icmp_socket.c4
-rw-r--r--net/batman-adv/main.c16
-rw-r--r--net/batman-adv/main.h6
-rw-r--r--net/batman-adv/multicast.c78
-rw-r--r--net/batman-adv/netlink.c22
-rw-r--r--net/batman-adv/network-coding.c120
-rw-r--r--net/batman-adv/originator.c76
-rw-r--r--net/batman-adv/routing.c24
-rw-r--r--net/batman-adv/send.c45
-rw-r--r--net/batman-adv/send.h4
-rw-r--r--net/batman-adv/soft-interface.c41
-rw-r--r--net/batman-adv/sysfs.c20
-rw-r--r--net/batman-adv/tp_meter.c70
-rw-r--r--net/batman-adv/translation-table.c189
-rw-r--r--net/batman-adv/tvlv.c38
34 files changed, 633 insertions, 619 deletions
diff --git a/net/batman-adv/bat_algo.c b/net/batman-adv/bat_algo.c
index fa306b25a78b..aed7ced059df 100644
--- a/net/batman-adv/bat_algo.c
+++ b/net/batman-adv/bat_algo.c
@@ -38,7 +38,8 @@ char batadv_routing_algo[20] = "BATMAN_IV";
38static struct hlist_head batadv_algo_list; 38static struct hlist_head batadv_algo_list;
39 39
40/** 40/**
41 * batadv_algo_init - Initialize batman-adv algorithm management data structures 41 * batadv_algo_init() - Initialize batman-adv algorithm management data
42 * structures
42 */ 43 */
43void batadv_algo_init(void) 44void batadv_algo_init(void)
44{ 45{
@@ -149,7 +150,7 @@ module_param_cb(routing_algo, &batadv_param_ops_ra, &batadv_param_string_ra,
149 0644); 150 0644);
150 151
151/** 152/**
152 * batadv_algo_dump_entry - fill in information about one supported routing 153 * batadv_algo_dump_entry() - fill in information about one supported routing
153 * algorithm 154 * algorithm
154 * @msg: netlink message to be sent back 155 * @msg: netlink message to be sent back
155 * @portid: Port to reply to 156 * @portid: Port to reply to
@@ -180,7 +181,7 @@ static int batadv_algo_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
180} 181}
181 182
182/** 183/**
183 * batadv_algo_dump - fill in information about supported routing 184 * batadv_algo_dump() - fill in information about supported routing
184 * algorithms 185 * algorithms
185 * @msg: netlink message to be sent back 186 * @msg: netlink message to be sent back
186 * @cb: Parameters to the netlink request 187 * @cb: Parameters to the netlink request
diff --git a/net/batman-adv/bat_iv_ogm.c b/net/batman-adv/bat_iv_ogm.c
index 27d9c8adf2ca..1fc67aa8d7df 100644
--- a/net/batman-adv/bat_iv_ogm.c
+++ b/net/batman-adv/bat_iv_ogm.c
@@ -87,7 +87,7 @@ enum batadv_dup_status {
87}; 87};
88 88
89/** 89/**
90 * batadv_ring_buffer_set - update the ring buffer with the given value 90 * batadv_ring_buffer_set() - update the ring buffer with the given value
91 * @lq_recv: pointer to the ring buffer 91 * @lq_recv: pointer to the ring buffer
92 * @lq_index: index to store the value at 92 * @lq_index: index to store the value at
93 * @value: value to store in the ring buffer 93 * @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)
99} 99}
100 100
101/** 101/**
102 * batadv_ring_buffer_avg - compute the average of all non-zero values stored 102 * batadv_ring_buffer_avg() - compute the average of all non-zero values stored
103 * in the given ring buffer 103 * in the given ring buffer
104 * @lq_recv: pointer to the ring buffer 104 * @lq_recv: pointer to the ring buffer
105 * 105 *
@@ -131,7 +131,7 @@ static u8 batadv_ring_buffer_avg(const u8 lq_recv[])
131} 131}
132 132
133/** 133/**
134 * batadv_iv_ogm_orig_free - free the private resources allocated for this 134 * batadv_iv_ogm_orig_free() - free the private resources allocated for this
135 * orig_node 135 * orig_node
136 * @orig_node: the orig_node for which the resources have to be free'd 136 * @orig_node: the orig_node for which the resources have to be free'd
137 */ 137 */
@@ -142,8 +142,8 @@ static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
142} 142}
143 143
144/** 144/**
145 * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to 145 * batadv_iv_ogm_orig_add_if() - change the private structures of the orig_node
146 * include the new hard-interface 146 * to include the new hard-interface
147 * @orig_node: the orig_node that has to be changed 147 * @orig_node: the orig_node that has to be changed
148 * @max_if_num: the current amount of interfaces 148 * @max_if_num: the current amount of interfaces
149 * 149 *
@@ -187,7 +187,7 @@ unlock:
187} 187}
188 188
189/** 189/**
190 * batadv_iv_ogm_drop_bcast_own_entry - drop section of bcast_own 190 * batadv_iv_ogm_drop_bcast_own_entry() - drop section of bcast_own
191 * @orig_node: the orig_node that has to be changed 191 * @orig_node: the orig_node that has to be changed
192 * @max_if_num: the current amount of interfaces 192 * @max_if_num: the current amount of interfaces
193 * @del_if_num: the index of the interface being removed 193 * @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,
225} 225}
226 226
227/** 227/**
228 * batadv_iv_ogm_drop_bcast_own_sum_entry - drop section of bcast_own_sum 228 * batadv_iv_ogm_drop_bcast_own_sum_entry() - drop section of bcast_own_sum
229 * @orig_node: the orig_node that has to be changed 229 * @orig_node: the orig_node that has to be changed
230 * @max_if_num: the current amount of interfaces 230 * @max_if_num: the current amount of interfaces
231 * @del_if_num: the index of the interface being removed 231 * @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,
260} 260}
261 261
262/** 262/**
263 * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to 263 * batadv_iv_ogm_orig_del_if() - change the private structures of the orig_node
264 * exclude the removed interface 264 * to exclude the removed interface
265 * @orig_node: the orig_node that has to be changed 265 * @orig_node: the orig_node that has to be changed
266 * @max_if_num: the current amount of interfaces 266 * @max_if_num: the current amount of interfaces
267 * @del_if_num: the index of the interface being removed 267 * @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,
291} 291}
292 292
293/** 293/**
294 * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator 294 * batadv_iv_ogm_orig_get() - retrieve or create (if does not exist) an
295 * originator
295 * @bat_priv: the bat priv with all the soft interface information 296 * @bat_priv: the bat priv with all the soft interface information
296 * @addr: mac address of the originator 297 * @addr: mac address of the originator
297 * 298 *
@@ -448,7 +449,7 @@ static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv)
448} 449}
449 450
450/** 451/**
451 * batadv_iv_ogm_aggr_packet - checks if there is another OGM attached 452 * batadv_iv_ogm_aggr_packet() - checks if there is another OGM attached
452 * @buff_pos: current position in the skb 453 * @buff_pos: current position in the skb
453 * @packet_len: total length of the skb 454 * @packet_len: total length of the skb
454 * @tvlv_len: tvlv length of the previously considered OGM 455 * @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)
558} 559}
559 560
560/** 561/**
561 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an 562 * batadv_iv_ogm_can_aggregate() - find out if an OGM can be aggregated on an
562 * existing forward packet 563 * existing forward packet
563 * @new_bat_ogm_packet: OGM packet to be aggregated 564 * @new_bat_ogm_packet: OGM packet to be aggregated
564 * @bat_priv: the bat priv with all the soft interface information 565 * @bat_priv: the bat priv with all the soft interface information
@@ -661,7 +662,7 @@ out:
661} 662}
662 663
663/** 664/**
664 * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this 665 * batadv_iv_ogm_aggregate_new() - create a new aggregated packet and add this
665 * packet to it. 666 * packet to it.
666 * @packet_buff: pointer to the OGM 667 * @packet_buff: pointer to the OGM
667 * @packet_len: (total) length of the OGM 668 * @packet_len: (total) length of the OGM
@@ -744,7 +745,7 @@ static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr,
744} 745}
745 746
746/** 747/**
747 * batadv_iv_ogm_queue_add - queue up an OGM for transmission 748 * batadv_iv_ogm_queue_add() - queue up an OGM for transmission
748 * @bat_priv: the bat priv with all the soft interface information 749 * @bat_priv: the bat priv with all the soft interface information
749 * @packet_buff: pointer to the OGM 750 * @packet_buff: pointer to the OGM
750 * @packet_len: (total) length of the OGM 751 * @packet_len: (total) length of the OGM
@@ -870,8 +871,8 @@ static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node,
870} 871}
871 872
872/** 873/**
873 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for 874 * batadv_iv_ogm_slide_own_bcast_window() - bitshift own OGM broadcast windows
874 * the given interface 875 * for the given interface
875 * @hard_iface: the interface for which the windows have to be shifted 876 * @hard_iface: the interface for which the windows have to be shifted
876 */ 877 */
877static void 878static void
@@ -988,7 +989,7 @@ out:
988} 989}
989 990
990/** 991/**
991 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an 992 * batadv_iv_ogm_orig_update() - use OGM to update corresponding data in an
992 * originator 993 * originator
993 * @bat_priv: the bat priv with all the soft interface information 994 * @bat_priv: the bat priv with all the soft interface information
994 * @orig_node: the orig node who originally emitted the ogm packet 995 * @orig_node: the orig node who originally emitted the ogm packet
@@ -1153,7 +1154,7 @@ out:
1153} 1154}
1154 1155
1155/** 1156/**
1156 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet 1157 * batadv_iv_ogm_calc_tq() - calculate tq for current received ogm packet
1157 * @orig_node: the orig node who originally emitted the ogm packet 1158 * @orig_node: the orig node who originally emitted the ogm packet
1158 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet 1159 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet
1159 * @batadv_ogm_packet: the ogm packet 1160 * @batadv_ogm_packet: the ogm packet
@@ -1299,7 +1300,7 @@ out:
1299} 1300}
1300 1301
1301/** 1302/**
1302 * batadv_iv_ogm_update_seqnos - process a batman packet for all interfaces, 1303 * batadv_iv_ogm_update_seqnos() - process a batman packet for all interfaces,
1303 * adjust the sequence number and find out whether it is a duplicate 1304 * adjust the sequence number and find out whether it is a duplicate
1304 * @ethhdr: ethernet header of the packet 1305 * @ethhdr: ethernet header of the packet
1305 * @batadv_ogm_packet: OGM packet to be considered 1306 * @batadv_ogm_packet: OGM packet to be considered
@@ -1402,7 +1403,8 @@ out:
1402} 1403}
1403 1404
1404/** 1405/**
1405 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if 1406 * batadv_iv_ogm_process_per_outif() - process a batman iv OGM for an outgoing
1407 * interface
1406 * @skb: the skb containing the OGM 1408 * @skb: the skb containing the OGM
1407 * @ogm_offset: offset from skb->data to start of ogm header 1409 * @ogm_offset: offset from skb->data to start of ogm header
1408 * @orig_node: the (cached) orig node for the originator of this OGM 1410 * @orig_node: the (cached) orig node for the originator of this OGM
@@ -1609,7 +1611,7 @@ out:
1609} 1611}
1610 1612
1611/** 1613/**
1612 * batadv_iv_ogm_process - process an incoming batman iv OGM 1614 * batadv_iv_ogm_process() - process an incoming batman iv OGM
1613 * @skb: the skb containing the OGM 1615 * @skb: the skb containing the OGM
1614 * @ogm_offset: offset to the OGM which should be processed (for aggregates) 1616 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
1615 * @if_incoming: the interface where this packet was receved 1617 * @if_incoming: the interface where this packet was receved
@@ -1862,7 +1864,7 @@ free_skb:
1862 1864
1863#ifdef CONFIG_BATMAN_ADV_DEBUGFS 1865#ifdef CONFIG_BATMAN_ADV_DEBUGFS
1864/** 1866/**
1865 * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table 1867 * batadv_iv_ogm_orig_print_neigh() - print neighbors for the originator table
1866 * @orig_node: the orig_node for which the neighbors are printed 1868 * @orig_node: the orig_node for which the neighbors are printed
1867 * @if_outgoing: outgoing interface for these entries 1869 * @if_outgoing: outgoing interface for these entries
1868 * @seq: debugfs table seq_file struct 1870 * @seq: debugfs table seq_file struct
@@ -1891,7 +1893,7 @@ batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node,
1891} 1893}
1892 1894
1893/** 1895/**
1894 * batadv_iv_ogm_orig_print - print the originator table 1896 * batadv_iv_ogm_orig_print() - print the originator table
1895 * @bat_priv: the bat priv with all the soft interface information 1897 * @bat_priv: the bat priv with all the soft interface information
1896 * @seq: debugfs table seq_file struct 1898 * @seq: debugfs table seq_file struct
1897 * @if_outgoing: the outgoing interface for which this should be printed 1899 * @if_outgoing: the outgoing interface for which this should be printed
@@ -1961,7 +1963,7 @@ next:
1961#endif 1963#endif
1962 1964
1963/** 1965/**
1964 * batadv_iv_ogm_neigh_get_tq_avg - Get the TQ average for a neighbour on a 1966 * batadv_iv_ogm_neigh_get_tq_avg() - Get the TQ average for a neighbour on a
1965 * given outgoing interface. 1967 * given outgoing interface.
1966 * @neigh_node: Neighbour of interest 1968 * @neigh_node: Neighbour of interest
1967 * @if_outgoing: Outgoing interface of interest 1969 * @if_outgoing: Outgoing interface of interest
@@ -1987,7 +1989,7 @@ batadv_iv_ogm_neigh_get_tq_avg(struct batadv_neigh_node *neigh_node,
1987} 1989}
1988 1990
1989/** 1991/**
1990 * batadv_iv_ogm_orig_dump_subentry - Dump an originator subentry into a 1992 * batadv_iv_ogm_orig_dump_subentry() - Dump an originator subentry into a
1991 * message 1993 * message
1992 * @msg: Netlink message to dump into 1994 * @msg: Netlink message to dump into
1993 * @portid: Port making netlink request 1995 * @portid: Port making netlink request
@@ -2049,7 +2051,7 @@ batadv_iv_ogm_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq,
2049} 2051}
2050 2052
2051/** 2053/**
2052 * batadv_iv_ogm_orig_dump_entry - Dump an originator entry into a message 2054 * batadv_iv_ogm_orig_dump_entry() - Dump an originator entry into a message
2053 * @msg: Netlink message to dump into 2055 * @msg: Netlink message to dump into
2054 * @portid: Port making netlink request 2056 * @portid: Port making netlink request
2055 * @seq: Sequence number of netlink message 2057 * @seq: Sequence number of netlink message
@@ -2111,7 +2113,7 @@ batadv_iv_ogm_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
2111} 2113}
2112 2114
2113/** 2115/**
2114 * batadv_iv_ogm_orig_dump_bucket - Dump an originator bucket into a 2116 * batadv_iv_ogm_orig_dump_bucket() - Dump an originator bucket into a
2115 * message 2117 * message
2116 * @msg: Netlink message to dump into 2118 * @msg: Netlink message to dump into
2117 * @portid: Port making netlink request 2119 * @portid: Port making netlink request
@@ -2154,7 +2156,7 @@ batadv_iv_ogm_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
2154} 2156}
2155 2157
2156/** 2158/**
2157 * batadv_iv_ogm_orig_dump - Dump the originators into a message 2159 * batadv_iv_ogm_orig_dump() - Dump the originators into a message
2158 * @msg: Netlink message to dump into 2160 * @msg: Netlink message to dump into
2159 * @cb: Control block containing additional options 2161 * @cb: Control block containing additional options
2160 * @bat_priv: The bat priv with all the soft interface information 2162 * @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,
2191 2193
2192#ifdef CONFIG_BATMAN_ADV_DEBUGFS 2194#ifdef CONFIG_BATMAN_ADV_DEBUGFS
2193/** 2195/**
2194 * batadv_iv_hardif_neigh_print - print a single hop neighbour node 2196 * batadv_iv_hardif_neigh_print() - print a single hop neighbour node
2195 * @seq: neighbour table seq_file struct 2197 * @seq: neighbour table seq_file struct
2196 * @hardif_neigh: hardif neighbour information 2198 * @hardif_neigh: hardif neighbour information
2197 */ 2199 */
@@ -2210,7 +2212,7 @@ batadv_iv_hardif_neigh_print(struct seq_file *seq,
2210} 2212}
2211 2213
2212/** 2214/**
2213 * batadv_iv_ogm_neigh_print - print the single hop neighbour list 2215 * batadv_iv_ogm_neigh_print() - print the single hop neighbour list
2214 * @bat_priv: the bat priv with all the soft interface information 2216 * @bat_priv: the bat priv with all the soft interface information
2215 * @seq: neighbour table seq_file struct 2217 * @seq: neighbour table seq_file struct
2216 */ 2218 */
@@ -2243,7 +2245,7 @@ static void batadv_iv_neigh_print(struct batadv_priv *bat_priv,
2243#endif 2245#endif
2244 2246
2245/** 2247/**
2246 * batadv_iv_ogm_neigh_diff - calculate tq difference of two neighbors 2248 * batadv_iv_ogm_neigh_diff() - calculate tq difference of two neighbors
2247 * @neigh1: the first neighbor object of the comparison 2249 * @neigh1: the first neighbor object of the comparison
2248 * @if_outgoing1: outgoing interface for the first neighbor 2250 * @if_outgoing1: outgoing interface for the first neighbor
2249 * @neigh2: the second neighbor object of the comparison 2251 * @neigh2: the second neighbor object of the comparison
@@ -2288,7 +2290,7 @@ out:
2288} 2290}
2289 2291
2290/** 2292/**
2291 * batadv_iv_ogm_neigh_dump_neigh - Dump a neighbour into a netlink message 2293 * batadv_iv_ogm_neigh_dump_neigh() - Dump a neighbour into a netlink message
2292 * @msg: Netlink message to dump into 2294 * @msg: Netlink message to dump into
2293 * @portid: Port making netlink request 2295 * @portid: Port making netlink request
2294 * @seq: Sequence number of netlink message 2296 * @seq: Sequence number of netlink message
@@ -2327,7 +2329,7 @@ batadv_iv_ogm_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq,
2327} 2329}
2328 2330
2329/** 2331/**
2330 * batadv_iv_ogm_neigh_dump_hardif - Dump the neighbours of a hard interface 2332 * batadv_iv_ogm_neigh_dump_hardif() - Dump the neighbours of a hard interface
2331 * into a message 2333 * into a message
2332 * @msg: Netlink message to dump into 2334 * @msg: Netlink message to dump into
2333 * @portid: Port making netlink request 2335 * @portid: Port making netlink request
@@ -2366,7 +2368,7 @@ batadv_iv_ogm_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq,
2366} 2368}
2367 2369
2368/** 2370/**
2369 * batadv_iv_ogm_neigh_dump - Dump the neighbours into a message 2371 * batadv_iv_ogm_neigh_dump() - Dump the neighbours into a message
2370 * @msg: Netlink message to dump into 2372 * @msg: Netlink message to dump into
2371 * @cb: Control block containing additional options 2373 * @cb: Control block containing additional options
2372 * @bat_priv: The bat priv with all the soft interface information 2374 * @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,
2418} 2420}
2419 2421
2420/** 2422/**
2421 * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors 2423 * batadv_iv_ogm_neigh_cmp() - compare the metrics of two neighbors
2422 * @neigh1: the first neighbor object of the comparison 2424 * @neigh1: the first neighbor object of the comparison
2423 * @if_outgoing1: outgoing interface for the first neighbor 2425 * @if_outgoing1: outgoing interface for the first neighbor
2424 * @neigh2: the second neighbor object of the comparison 2426 * @neigh2: the second neighbor object of the comparison
@@ -2444,7 +2446,7 @@ static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
2444} 2446}
2445 2447
2446/** 2448/**
2447 * batadv_iv_ogm_neigh_is_sob - check if neigh1 is similarly good or better 2449 * batadv_iv_ogm_neigh_is_sob() - check if neigh1 is similarly good or better
2448 * than neigh2 from the metric prospective 2450 * than neigh2 from the metric prospective
2449 * @neigh1: the first neighbor object of the comparison 2451 * @neigh1: the first neighbor object of the comparison
2450 * @if_outgoing1: outgoing interface for the first neighbor 2452 * @if_outgoing1: outgoing interface for the first neighbor
@@ -2479,7 +2481,7 @@ static void batadv_iv_iface_activate(struct batadv_hard_iface *hard_iface)
2479} 2481}
2480 2482
2481/** 2483/**
2482 * batadv_iv_init_sel_class - initialize GW selection class 2484 * batadv_iv_init_sel_class() - initialize GW selection class
2483 * @bat_priv: the bat priv with all the soft interface information 2485 * @bat_priv: the bat priv with all the soft interface information
2484 */ 2486 */
2485static void batadv_iv_init_sel_class(struct batadv_priv *bat_priv) 2487static 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,
2704#endif 2706#endif
2705 2707
2706/** 2708/**
2707 * batadv_iv_gw_dump_entry - Dump a gateway into a message 2709 * batadv_iv_gw_dump_entry() - Dump a gateway into a message
2708 * @msg: Netlink message to dump into 2710 * @msg: Netlink message to dump into
2709 * @portid: Port making netlink request 2711 * @portid: Port making netlink request
2710 * @seq: Sequence number of netlink message 2712 * @seq: Sequence number of netlink message
@@ -2775,7 +2777,7 @@ out:
2775} 2777}
2776 2778
2777/** 2779/**
2778 * batadv_iv_gw_dump - Dump gateways into a message 2780 * batadv_iv_gw_dump() - Dump gateways into a message
2779 * @msg: Netlink message to dump into 2781 * @msg: Netlink message to dump into
2780 * @cb: Control block containing additional options 2782 * @cb: Control block containing additional options
2781 * @bat_priv: The bat priv with all the soft interface information 2783 * @bat_priv: The bat priv with all the soft interface information
diff --git a/net/batman-adv/bat_v.c b/net/batman-adv/bat_v.c
index 16709552c21e..14ec3677c391 100644
--- a/net/batman-adv/bat_v.c
+++ b/net/batman-adv/bat_v.c
@@ -100,7 +100,7 @@ static void batadv_v_primary_iface_set(struct batadv_hard_iface *hard_iface)
100} 100}
101 101
102/** 102/**
103 * batadv_v_iface_update_mac - react to hard-interface MAC address change 103 * batadv_v_iface_update_mac() - react to hard-interface MAC address change
104 * @hard_iface: the modified interface 104 * @hard_iface: the modified interface
105 * 105 *
106 * If the modified interface is the primary one, update the originator 106 * 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)
131 131
132#ifdef CONFIG_BATMAN_ADV_DEBUGFS 132#ifdef CONFIG_BATMAN_ADV_DEBUGFS
133/** 133/**
134 * batadv_v_orig_print_neigh - print neighbors for the originator table 134 * batadv_v_orig_print_neigh() - print neighbors for the originator table
135 * @orig_node: the orig_node for which the neighbors are printed 135 * @orig_node: the orig_node for which the neighbors are printed
136 * @if_outgoing: outgoing interface for these entries 136 * @if_outgoing: outgoing interface for these entries
137 * @seq: debugfs table seq_file struct 137 * @seq: debugfs table seq_file struct
@@ -161,7 +161,7 @@ batadv_v_orig_print_neigh(struct batadv_orig_node *orig_node,
161} 161}
162 162
163/** 163/**
164 * batadv_v_hardif_neigh_print - print a single ELP neighbour node 164 * batadv_v_hardif_neigh_print() - print a single ELP neighbour node
165 * @seq: neighbour table seq_file struct 165 * @seq: neighbour table seq_file struct
166 * @hardif_neigh: hardif neighbour information 166 * @hardif_neigh: hardif neighbour information
167 */ 167 */
@@ -182,7 +182,7 @@ batadv_v_hardif_neigh_print(struct seq_file *seq,
182} 182}
183 183
184/** 184/**
185 * batadv_v_neigh_print - print the single hop neighbour list 185 * batadv_v_neigh_print() - print the single hop neighbour list
186 * @bat_priv: the bat priv with all the soft interface information 186 * @bat_priv: the bat priv with all the soft interface information
187 * @seq: neighbour table seq_file struct 187 * @seq: neighbour table seq_file struct
188 */ 188 */
@@ -216,7 +216,7 @@ static void batadv_v_neigh_print(struct batadv_priv *bat_priv,
216#endif 216#endif
217 217
218/** 218/**
219 * batadv_v_neigh_dump_neigh - Dump a neighbour into a message 219 * batadv_v_neigh_dump_neigh() - Dump a neighbour into a message
220 * @msg: Netlink message to dump into 220 * @msg: Netlink message to dump into
221 * @portid: Port making netlink request 221 * @portid: Port making netlink request
222 * @seq: Sequence number of netlink message 222 * @seq: Sequence number of netlink message
@@ -259,7 +259,7 @@ batadv_v_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq,
259} 259}
260 260
261/** 261/**
262 * batadv_v_neigh_dump_hardif - Dump the neighbours of a hard interface into 262 * batadv_v_neigh_dump_hardif() - Dump the neighbours of a hard interface into
263 * a message 263 * a message
264 * @msg: Netlink message to dump into 264 * @msg: Netlink message to dump into
265 * @portid: Port making netlink request 265 * @portid: Port making netlink request
@@ -297,7 +297,7 @@ batadv_v_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq,
297} 297}
298 298
299/** 299/**
300 * batadv_v_neigh_dump - Dump the neighbours of a hard interface into a 300 * batadv_v_neigh_dump() - Dump the neighbours of a hard interface into a
301 * message 301 * message
302 * @msg: Netlink message to dump into 302 * @msg: Netlink message to dump into
303 * @cb: Control block containing additional options 303 * @cb: Control block containing additional options
@@ -349,7 +349,7 @@ batadv_v_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb,
349 349
350#ifdef CONFIG_BATMAN_ADV_DEBUGFS 350#ifdef CONFIG_BATMAN_ADV_DEBUGFS
351/** 351/**
352 * batadv_v_orig_print - print the originator table 352 * batadv_v_orig_print() - print the originator table
353 * @bat_priv: the bat priv with all the soft interface information 353 * @bat_priv: the bat priv with all the soft interface information
354 * @seq: debugfs table seq_file struct 354 * @seq: debugfs table seq_file struct
355 * @if_outgoing: the outgoing interface for which this should be printed 355 * @if_outgoing: the outgoing interface for which this should be printed
@@ -417,8 +417,7 @@ next:
417#endif 417#endif
418 418
419/** 419/**
420 * batadv_v_orig_dump_subentry - Dump an originator subentry into a 420 * batadv_v_orig_dump_subentry() - Dump an originator subentry into a message
421 * message
422 * @msg: Netlink message to dump into 421 * @msg: Netlink message to dump into
423 * @portid: Port making netlink request 422 * @portid: Port making netlink request
424 * @seq: Sequence number of netlink message 423 * @seq: Sequence number of netlink message
@@ -484,7 +483,7 @@ batadv_v_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq,
484} 483}
485 484
486/** 485/**
487 * batadv_v_orig_dump_entry - Dump an originator entry into a message 486 * batadv_v_orig_dump_entry() - Dump an originator entry into a message
488 * @msg: Netlink message to dump into 487 * @msg: Netlink message to dump into
489 * @portid: Port making netlink request 488 * @portid: Port making netlink request
490 * @seq: Sequence number of netlink message 489 * @seq: Sequence number of netlink message
@@ -537,8 +536,7 @@ batadv_v_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
537} 536}
538 537
539/** 538/**
540 * batadv_v_orig_dump_bucket - Dump an originator bucket into a 539 * batadv_v_orig_dump_bucket() - Dump an originator bucket into a message
541 * message
542 * @msg: Netlink message to dump into 540 * @msg: Netlink message to dump into
543 * @portid: Port making netlink request 541 * @portid: Port making netlink request
544 * @seq: Sequence number of netlink message 542 * @seq: Sequence number of netlink message
@@ -579,7 +577,7 @@ batadv_v_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
579} 577}
580 578
581/** 579/**
582 * batadv_v_orig_dump - Dump the originators into a message 580 * batadv_v_orig_dump() - Dump the originators into a message
583 * @msg: Netlink message to dump into 581 * @msg: Netlink message to dump into
584 * @cb: Control block containing additional options 582 * @cb: Control block containing additional options
585 * @bat_priv: The bat priv with all the soft interface information 583 * @bat_priv: The bat priv with all the soft interface information
@@ -669,7 +667,7 @@ err_ifinfo1:
669} 667}
670 668
671/** 669/**
672 * batadv_v_init_sel_class - initialize GW selection class 670 * batadv_v_init_sel_class() - initialize GW selection class
673 * @bat_priv: the bat priv with all the soft interface information 671 * @bat_priv: the bat priv with all the soft interface information
674 */ 672 */
675static void batadv_v_init_sel_class(struct batadv_priv *bat_priv) 673static 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)
705} 703}
706 704
707/** 705/**
708 * batadv_v_gw_throughput_get - retrieve the GW-bandwidth for a given GW 706 * batadv_v_gw_throughput_get() - retrieve the GW-bandwidth for a given GW
709 * @gw_node: the GW to retrieve the metric for 707 * @gw_node: the GW to retrieve the metric for
710 * @bw: the pointer where the metric will be stored. The metric is computed as 708 * @bw: the pointer where the metric will be stored. The metric is computed as
711 * the minimum between the GW advertised throughput and the path throughput to 709 * the minimum between the GW advertised throughput and the path throughput to
@@ -748,7 +746,7 @@ out:
748} 746}
749 747
750/** 748/**
751 * batadv_v_gw_get_best_gw_node - retrieve the best GW node 749 * batadv_v_gw_get_best_gw_node() - retrieve the best GW node
752 * @bat_priv: the bat priv with all the soft interface information 750 * @bat_priv: the bat priv with all the soft interface information
753 * 751 *
754 * Return: the GW node having the best GW-metric, NULL if no GW is known 752 * Return: the GW node having the best GW-metric, NULL if no GW is known
@@ -786,7 +784,7 @@ next:
786} 784}
787 785
788/** 786/**
789 * batadv_v_gw_is_eligible - check if a originator would be selected as GW 787 * batadv_v_gw_is_eligible() - check if a originator would be selected as GW
790 * @bat_priv: the bat priv with all the soft interface information 788 * @bat_priv: the bat priv with all the soft interface information
791 * @curr_gw_orig: originator representing the currently selected GW 789 * @curr_gw_orig: originator representing the currently selected GW
792 * @orig_node: the originator representing the new candidate 790 * @orig_node: the originator representing the new candidate
@@ -885,7 +883,7 @@ out:
885} 883}
886 884
887/** 885/**
888 * batadv_v_gw_print - print the gateway list 886 * batadv_v_gw_print() - print the gateway list
889 * @bat_priv: the bat priv with all the soft interface information 887 * @bat_priv: the bat priv with all the soft interface information
890 * @seq: gateway table seq_file struct 888 * @seq: gateway table seq_file struct
891 */ 889 */
@@ -914,7 +912,7 @@ static void batadv_v_gw_print(struct batadv_priv *bat_priv,
914#endif 912#endif
915 913
916/** 914/**
917 * batadv_v_gw_dump_entry - Dump a gateway into a message 915 * batadv_v_gw_dump_entry() - Dump a gateway into a message
918 * @msg: Netlink message to dump into 916 * @msg: Netlink message to dump into
919 * @portid: Port making netlink request 917 * @portid: Port making netlink request
920 * @seq: Sequence number of netlink message 918 * @seq: Sequence number of netlink message
@@ -1005,7 +1003,7 @@ out:
1005} 1003}
1006 1004
1007/** 1005/**
1008 * batadv_v_gw_dump - Dump gateways into a message 1006 * batadv_v_gw_dump() - Dump gateways into a message
1009 * @msg: Netlink message to dump into 1007 * @msg: Netlink message to dump into
1010 * @cb: Control block containing additional options 1008 * @cb: Control block containing additional options
1011 * @bat_priv: The bat priv with all the soft interface information 1009 * @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 = {
1075}; 1073};
1076 1074
1077/** 1075/**
1078 * batadv_v_hardif_init - initialize the algorithm specific fields in the 1076 * batadv_v_hardif_init() - initialize the algorithm specific fields in the
1079 * hard-interface object 1077 * hard-interface object
1080 * @hard_iface: the hard-interface to initialize 1078 * @hard_iface: the hard-interface to initialize
1081 */ 1079 */
@@ -1089,7 +1087,7 @@ void batadv_v_hardif_init(struct batadv_hard_iface *hard_iface)
1089} 1087}
1090 1088
1091/** 1089/**
1092 * batadv_v_mesh_init - initialize the B.A.T.M.A.N. V private resources for a 1090 * batadv_v_mesh_init() - initialize the B.A.T.M.A.N. V private resources for a
1093 * mesh 1091 * mesh
1094 * @bat_priv: the object representing the mesh interface to initialise 1092 * @bat_priv: the object representing the mesh interface to initialise
1095 * 1093 *
@@ -1107,7 +1105,7 @@ int batadv_v_mesh_init(struct batadv_priv *bat_priv)
1107} 1105}
1108 1106
1109/** 1107/**
1110 * batadv_v_mesh_free - free the B.A.T.M.A.N. V private resources for a mesh 1108 * batadv_v_mesh_free() - free the B.A.T.M.A.N. V private resources for a mesh
1111 * @bat_priv: the object representing the mesh interface to free 1109 * @bat_priv: the object representing the mesh interface to free
1112 */ 1110 */
1113void batadv_v_mesh_free(struct batadv_priv *bat_priv) 1111void batadv_v_mesh_free(struct batadv_priv *bat_priv)
@@ -1116,7 +1114,7 @@ void batadv_v_mesh_free(struct batadv_priv *bat_priv)
1116} 1114}
1117 1115
1118/** 1116/**
1119 * batadv_v_init - B.A.T.M.A.N. V initialization function 1117 * batadv_v_init() - B.A.T.M.A.N. V initialization function
1120 * 1118 *
1121 * Description: Takes care of initializing all the subcomponents. 1119 * Description: Takes care of initializing all the subcomponents.
1122 * It is invoked upon module load only. 1120 * It is invoked upon module load only.
diff --git a/net/batman-adv/bat_v_elp.c b/net/batman-adv/bat_v_elp.c
index 92b56bb5686d..59ae96cef596 100644
--- a/net/batman-adv/bat_v_elp.c
+++ b/net/batman-adv/bat_v_elp.c
@@ -53,7 +53,7 @@
53#include "send.h" 53#include "send.h"
54 54
55/** 55/**
56 * batadv_v_elp_start_timer - restart timer for ELP periodic work 56 * batadv_v_elp_start_timer() - restart timer for ELP periodic work
57 * @hard_iface: the interface for which the timer has to be reset 57 * @hard_iface: the interface for which the timer has to be reset
58 */ 58 */
59static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface) 59static 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)
68} 68}
69 69
70/** 70/**
71 * batadv_v_elp_get_throughput - get the throughput towards a neighbour 71 * batadv_v_elp_get_throughput() - get the throughput towards a neighbour
72 * @neigh: the neighbour for which the throughput has to be obtained 72 * @neigh: the neighbour for which the throughput has to be obtained
73 * 73 *
74 * Return: The throughput towards the given neighbour in multiples of 100kpbs 74 * Return: The throughput towards the given neighbour in multiples of 100kpbs
@@ -154,8 +154,8 @@ default_throughput:
154} 154}
155 155
156/** 156/**
157 * batadv_v_elp_throughput_metric_update - worker updating the throughput metric 157 * batadv_v_elp_throughput_metric_update() - worker updating the throughput
158 * of a single hop neighbour 158 * metric of a single hop neighbour
159 * @work: the work queue item 159 * @work: the work queue item
160 */ 160 */
161void batadv_v_elp_throughput_metric_update(struct work_struct *work) 161void 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)
178} 178}
179 179
180/** 180/**
181 * batadv_v_elp_wifi_neigh_probe - send link probing packets to a neighbour 181 * batadv_v_elp_wifi_neigh_probe() - send link probing packets to a neighbour
182 * @neigh: the neighbour to probe 182 * @neigh: the neighbour to probe
183 * 183 *
184 * Sends a predefined number of unicast wifi packets to a given neighbour in 184 * 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)
241} 241}
242 242
243/** 243/**
244 * batadv_v_elp_periodic_work - ELP periodic task per interface 244 * batadv_v_elp_periodic_work() - ELP periodic task per interface
245 * @work: work queue item 245 * @work: work queue item
246 * 246 *
247 * Emits broadcast ELP message in regular intervals. 247 * Emits broadcast ELP message in regular intervals.
@@ -328,7 +328,7 @@ out:
328} 328}
329 329
330/** 330/**
331 * batadv_v_elp_iface_enable - setup the ELP interface private resources 331 * batadv_v_elp_iface_enable() - setup the ELP interface private resources
332 * @hard_iface: interface for which the data has to be prepared 332 * @hard_iface: interface for which the data has to be prepared
333 * 333 *
334 * Return: 0 on success or a -ENOMEM in case of failure. 334 * Return: 0 on success or a -ENOMEM in case of failure.
@@ -376,7 +376,7 @@ out:
376} 376}
377 377
378/** 378/**
379 * batadv_v_elp_iface_disable - release ELP interface private resources 379 * batadv_v_elp_iface_disable() - release ELP interface private resources
380 * @hard_iface: interface for which the resources have to be released 380 * @hard_iface: interface for which the resources have to be released
381 */ 381 */
382void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface) 382void 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)
388} 388}
389 389
390/** 390/**
391 * batadv_v_elp_iface_activate - update the ELP buffer belonging to the given 391 * batadv_v_elp_iface_activate() - update the ELP buffer belonging to the given
392 * hard-interface 392 * hard-interface
393 * @primary_iface: the new primary interface 393 * @primary_iface: the new primary interface
394 * @hard_iface: interface holding the to-be-updated buffer 394 * @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,
409} 409}
410 410
411/** 411/**
412 * batadv_v_elp_primary_iface_set - change internal data to reflect the new 412 * batadv_v_elp_primary_iface_set() - change internal data to reflect the new
413 * primary interface 413 * primary interface
414 * @primary_iface: the new primary interface 414 * @primary_iface: the new primary interface
415 */ 415 */
@@ -429,7 +429,7 @@ void batadv_v_elp_primary_iface_set(struct batadv_hard_iface *primary_iface)
429} 429}
430 430
431/** 431/**
432 * batadv_v_elp_neigh_update - update an ELP neighbour node 432 * batadv_v_elp_neigh_update() - update an ELP neighbour node
433 * @bat_priv: the bat priv with all the soft interface information 433 * @bat_priv: the bat priv with all the soft interface information
434 * @neigh_addr: the neighbour interface address 434 * @neigh_addr: the neighbour interface address
435 * @if_incoming: the interface the packet was received through 435 * @if_incoming: the interface the packet was received through
@@ -489,7 +489,7 @@ orig_free:
489} 489}
490 490
491/** 491/**
492 * batadv_v_elp_packet_recv - main ELP packet handler 492 * batadv_v_elp_packet_recv() - main ELP packet handler
493 * @skb: the received packet 493 * @skb: the received packet
494 * @if_incoming: the interface this packet was received through 494 * @if_incoming: the interface this packet was received through
495 * 495 *
diff --git a/net/batman-adv/bat_v_ogm.c b/net/batman-adv/bat_v_ogm.c
index 7055a9483788..e415974c540d 100644
--- a/net/batman-adv/bat_v_ogm.c
+++ b/net/batman-adv/bat_v_ogm.c
@@ -52,7 +52,7 @@
52#include "tvlv.h" 52#include "tvlv.h"
53 53
54/** 54/**
55 * batadv_v_ogm_orig_get - retrieve and possibly create an originator node 55 * batadv_v_ogm_orig_get() - retrieve and possibly create an originator node
56 * @bat_priv: the bat priv with all the soft interface information 56 * @bat_priv: the bat priv with all the soft interface information
57 * @addr: the address of the originator 57 * @addr: the address of the originator
58 * 58 *
@@ -89,7 +89,7 @@ struct batadv_orig_node *batadv_v_ogm_orig_get(struct batadv_priv *bat_priv,
89} 89}
90 90
91/** 91/**
92 * batadv_v_ogm_start_timer - restart the OGM sending timer 92 * batadv_v_ogm_start_timer() - restart the OGM sending timer
93 * @bat_priv: the bat priv with all the soft interface information 93 * @bat_priv: the bat priv with all the soft interface information
94 */ 94 */
95static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv) 95static 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)
108} 108}
109 109
110/** 110/**
111 * batadv_v_ogm_send_to_if - send a batman ogm using a given interface 111 * batadv_v_ogm_send_to_if() - send a batman ogm using a given interface
112 * @skb: the OGM to send 112 * @skb: the OGM to send
113 * @hard_iface: the interface to use to send the OGM 113 * @hard_iface: the interface to use to send the OGM
114 */ 114 */
@@ -128,7 +128,7 @@ static void batadv_v_ogm_send_to_if(struct sk_buff *skb,
128} 128}
129 129
130/** 130/**
131 * batadv_v_ogm_send - periodic worker broadcasting the own OGM 131 * batadv_v_ogm_send() - periodic worker broadcasting the own OGM
132 * @work: work queue item 132 * @work: work queue item
133 */ 133 */
134static void batadv_v_ogm_send(struct work_struct *work) 134static void batadv_v_ogm_send(struct work_struct *work)
@@ -236,7 +236,7 @@ out:
236} 236}
237 237
238/** 238/**
239 * batadv_v_ogm_iface_enable - prepare an interface for B.A.T.M.A.N. V 239 * batadv_v_ogm_iface_enable() - prepare an interface for B.A.T.M.A.N. V
240 * @hard_iface: the interface to prepare 240 * @hard_iface: the interface to prepare
241 * 241 *
242 * Takes care of scheduling own OGM sending routine for this interface. 242 * 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)
253} 253}
254 254
255/** 255/**
256 * batadv_v_ogm_primary_iface_set - set a new primary interface 256 * batadv_v_ogm_primary_iface_set() - set a new primary interface
257 * @primary_iface: the new primary interface 257 * @primary_iface: the new primary interface
258 */ 258 */
259void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface) 259void 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)
269} 269}
270 270
271/** 271/**
272 * batadv_v_forward_penalty - apply a penalty to the throughput metric forwarded 272 * batadv_v_forward_penalty() - apply a penalty to the throughput metric
273 * with B.A.T.M.A.N. V OGMs 273 * forwarded with B.A.T.M.A.N. V OGMs
274 * @bat_priv: the bat priv with all the soft interface information 274 * @bat_priv: the bat priv with all the soft interface information
275 * @if_incoming: the interface where the OGM has been received 275 * @if_incoming: the interface where the OGM has been received
276 * @if_outgoing: the interface where the OGM has to be forwarded to 276 * @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,
315} 315}
316 316
317/** 317/**
318 * batadv_v_ogm_forward - check conditions and forward an OGM to the given 318 * batadv_v_ogm_forward() - check conditions and forward an OGM to the given
319 * outgoing interface 319 * outgoing interface
320 * @bat_priv: the bat priv with all the soft interface information 320 * @bat_priv: the bat priv with all the soft interface information
321 * @ogm_received: previously received OGM to be forwarded 321 * @ogm_received: previously received OGM to be forwarded
@@ -406,7 +406,7 @@ out:
406} 406}
407 407
408/** 408/**
409 * batadv_v_ogm_metric_update - update route metric based on OGM 409 * batadv_v_ogm_metric_update() - update route metric based on OGM
410 * @bat_priv: the bat priv with all the soft interface information 410 * @bat_priv: the bat priv with all the soft interface information
411 * @ogm2: OGM2 structure 411 * @ogm2: OGM2 structure
412 * @orig_node: Originator structure for which the OGM has been received 412 * @orig_node: Originator structure for which the OGM has been received
@@ -491,7 +491,7 @@ out:
491} 491}
492 492
493/** 493/**
494 * batadv_v_ogm_route_update - update routes based on OGM 494 * batadv_v_ogm_route_update() - update routes based on OGM
495 * @bat_priv: the bat priv with all the soft interface information 495 * @bat_priv: the bat priv with all the soft interface information
496 * @ethhdr: the Ethernet header of the OGM2 496 * @ethhdr: the Ethernet header of the OGM2
497 * @ogm2: OGM2 structure 497 * @ogm2: OGM2 structure
@@ -591,7 +591,7 @@ out:
591} 591}
592 592
593/** 593/**
594 * batadv_v_ogm_process_per_outif - process a batman v OGM for an outgoing if 594 * batadv_v_ogm_process_per_outif() - process a batman v OGM for an outgoing if
595 * @bat_priv: the bat priv with all the soft interface information 595 * @bat_priv: the bat priv with all the soft interface information
596 * @ethhdr: the Ethernet header of the OGM2 596 * @ethhdr: the Ethernet header of the OGM2
597 * @ogm2: OGM2 structure 597 * @ogm2: OGM2 structure
@@ -640,7 +640,7 @@ batadv_v_ogm_process_per_outif(struct batadv_priv *bat_priv,
640} 640}
641 641
642/** 642/**
643 * batadv_v_ogm_aggr_packet - checks if there is another OGM aggregated 643 * batadv_v_ogm_aggr_packet() - checks if there is another OGM aggregated
644 * @buff_pos: current position in the skb 644 * @buff_pos: current position in the skb
645 * @packet_len: total length of the skb 645 * @packet_len: total length of the skb
646 * @tvlv_len: tvlv length of the previously considered OGM 646 * @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,
660} 660}
661 661
662/** 662/**
663 * batadv_v_ogm_process - process an incoming batman v OGM 663 * batadv_v_ogm_process() - process an incoming batman v OGM
664 * @skb: the skb containing the OGM 664 * @skb: the skb containing the OGM
665 * @ogm_offset: offset to the OGM which should be processed (for aggregates) 665 * @ogm_offset: offset to the OGM which should be processed (for aggregates)
666 * @if_incoming: the interface where this packet was receved 666 * @if_incoming: the interface where this packet was receved
@@ -788,7 +788,7 @@ out:
788} 788}
789 789
790/** 790/**
791 * batadv_v_ogm_packet_recv - OGM2 receiving handler 791 * batadv_v_ogm_packet_recv() - OGM2 receiving handler
792 * @skb: the received OGM 792 * @skb: the received OGM
793 * @if_incoming: the interface where this OGM has been received 793 * @if_incoming: the interface where this OGM has been received
794 * 794 *
@@ -852,7 +852,7 @@ free_skb:
852} 852}
853 853
854/** 854/**
855 * batadv_v_ogm_init - initialise the OGM2 engine 855 * batadv_v_ogm_init() - initialise the OGM2 engine
856 * @bat_priv: the bat priv with all the soft interface information 856 * @bat_priv: the bat priv with all the soft interface information
857 * 857 *
858 * Return: 0 on success or a negative error code in case of failure 858 * 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)
885} 885}
886 886
887/** 887/**
888 * batadv_v_ogm_free - free OGM private resources 888 * batadv_v_ogm_free() - free OGM private resources
889 * @bat_priv: the bat priv with all the soft interface information 889 * @bat_priv: the bat priv with all the soft interface information
890 */ 890 */
891void batadv_v_ogm_free(struct batadv_priv *bat_priv) 891void batadv_v_ogm_free(struct batadv_priv *bat_priv)
diff --git a/net/batman-adv/bitarray.c b/net/batman-adv/bitarray.c
index 125817c389e5..bdc1ef06e05b 100644
--- a/net/batman-adv/bitarray.c
+++ b/net/batman-adv/bitarray.c
@@ -33,7 +33,7 @@ static void batadv_bitmap_shift_left(unsigned long *seq_bits, s32 n)
33} 33}
34 34
35/** 35/**
36 * batadv_bit_get_packet - receive and process one packet within the sequence 36 * batadv_bit_get_packet() - receive and process one packet within the sequence
37 * number window 37 * number window
38 * @priv: the bat priv with all the soft interface information 38 * @priv: the bat priv with all the soft interface information
39 * @seq_bits: pointer to the sequence number receive packet 39 * @seq_bits: pointer to the sequence number receive packet
diff --git a/net/batman-adv/bitarray.h b/net/batman-adv/bitarray.h
index 8cb2c874f5d3..0508353fa28d 100644
--- a/net/batman-adv/bitarray.h
+++ b/net/batman-adv/bitarray.h
@@ -27,7 +27,7 @@
27#include <linux/types.h> 27#include <linux/types.h>
28 28
29/** 29/**
30 * batadv_test_bit - check if bit is set in the current window 30 * batadv_test_bit() - check if bit is set in the current window
31 * 31 *
32 * @seq_bits: pointer to the sequence number receive packet 32 * @seq_bits: pointer to the sequence number receive packet
33 * @last_seqno: latest sequence number in seq_bits 33 * @last_seqno: latest sequence number in seq_bits
diff --git a/net/batman-adv/bridge_loop_avoidance.c b/net/batman-adv/bridge_loop_avoidance.c
index ce124a21fce5..e647450e5d0f 100644
--- a/net/batman-adv/bridge_loop_avoidance.c
+++ b/net/batman-adv/bridge_loop_avoidance.c
@@ -70,7 +70,7 @@ batadv_bla_send_announce(struct batadv_priv *bat_priv,
70 struct batadv_bla_backbone_gw *backbone_gw); 70 struct batadv_bla_backbone_gw *backbone_gw);
71 71
72/** 72/**
73 * batadv_choose_claim - choose the right bucket for a claim. 73 * batadv_choose_claim() - choose the right bucket for a claim.
74 * @data: data to hash 74 * @data: data to hash
75 * @size: size of the hash table 75 * @size: size of the hash table
76 * 76 *
@@ -88,7 +88,7 @@ static inline u32 batadv_choose_claim(const void *data, u32 size)
88} 88}
89 89
90/** 90/**
91 * batadv_choose_backbone_gw - choose the right bucket for a backbone gateway. 91 * batadv_choose_backbone_gw() - choose the right bucket for a backbone gateway.
92 * @data: data to hash 92 * @data: data to hash
93 * @size: size of the hash table 93 * @size: size of the hash table
94 * 94 *
@@ -106,7 +106,7 @@ static inline u32 batadv_choose_backbone_gw(const void *data, u32 size)
106} 106}
107 107
108/** 108/**
109 * batadv_compare_backbone_gw - compare address and vid of two backbone gws 109 * batadv_compare_backbone_gw() - compare address and vid of two backbone gws
110 * @node: list node of the first entry to compare 110 * @node: list node of the first entry to compare
111 * @data2: pointer to the second backbone gateway 111 * @data2: pointer to the second backbone gateway
112 * 112 *
@@ -130,7 +130,7 @@ static bool batadv_compare_backbone_gw(const struct hlist_node *node,
130} 130}
131 131
132/** 132/**
133 * batadv_compare_claim - compare address and vid of two claims 133 * batadv_compare_claim() - compare address and vid of two claims
134 * @node: list node of the first entry to compare 134 * @node: list node of the first entry to compare
135 * @data2: pointer to the second claims 135 * @data2: pointer to the second claims
136 * 136 *
@@ -154,7 +154,7 @@ static bool batadv_compare_claim(const struct hlist_node *node,
154} 154}
155 155
156/** 156/**
157 * batadv_backbone_gw_release - release backbone gw from lists and queue for 157 * batadv_backbone_gw_release() - release backbone gw from lists and queue for
158 * free after rcu grace period 158 * free after rcu grace period
159 * @ref: kref pointer of the backbone gw 159 * @ref: kref pointer of the backbone gw
160 */ 160 */
@@ -169,7 +169,7 @@ static void batadv_backbone_gw_release(struct kref *ref)
169} 169}
170 170
171/** 171/**
172 * batadv_backbone_gw_put - decrement the backbone gw refcounter and possibly 172 * batadv_backbone_gw_put() - decrement the backbone gw refcounter and possibly
173 * release it 173 * release it
174 * @backbone_gw: backbone gateway to be free'd 174 * @backbone_gw: backbone gateway to be free'd
175 */ 175 */
@@ -179,8 +179,8 @@ static void batadv_backbone_gw_put(struct batadv_bla_backbone_gw *backbone_gw)
179} 179}
180 180
181/** 181/**
182 * batadv_claim_release - release claim from lists and queue for free after rcu 182 * batadv_claim_release() - release claim from lists and queue for free after
183 * grace period 183 * rcu grace period
184 * @ref: kref pointer of the claim 184 * @ref: kref pointer of the claim
185 */ 185 */
186static void batadv_claim_release(struct kref *ref) 186static void batadv_claim_release(struct kref *ref)
@@ -205,8 +205,7 @@ static void batadv_claim_release(struct kref *ref)
205} 205}
206 206
207/** 207/**
208 * batadv_claim_put - decrement the claim refcounter and possibly 208 * batadv_claim_put() - decrement the claim refcounter and possibly release it
209 * release it
210 * @claim: claim to be free'd 209 * @claim: claim to be free'd
211 */ 210 */
212static void batadv_claim_put(struct batadv_bla_claim *claim) 211static void batadv_claim_put(struct batadv_bla_claim *claim)
@@ -215,7 +214,7 @@ static void batadv_claim_put(struct batadv_bla_claim *claim)
215} 214}
216 215
217/** 216/**
218 * batadv_claim_hash_find - looks for a claim in the claim hash 217 * batadv_claim_hash_find() - looks for a claim in the claim hash
219 * @bat_priv: the bat priv with all the soft interface information 218 * @bat_priv: the bat priv with all the soft interface information
220 * @data: search data (may be local/static data) 219 * @data: search data (may be local/static data)
221 * 220 *
@@ -254,7 +253,7 @@ batadv_claim_hash_find(struct batadv_priv *bat_priv,
254} 253}
255 254
256/** 255/**
257 * batadv_backbone_hash_find - looks for a backbone gateway in the hash 256 * batadv_backbone_hash_find() - looks for a backbone gateway in the hash
258 * @bat_priv: the bat priv with all the soft interface information 257 * @bat_priv: the bat priv with all the soft interface information
259 * @addr: the address of the originator 258 * @addr: the address of the originator
260 * @vid: the VLAN ID 259 * @vid: the VLAN ID
@@ -298,7 +297,7 @@ batadv_backbone_hash_find(struct batadv_priv *bat_priv, u8 *addr,
298} 297}
299 298
300/** 299/**
301 * batadv_bla_del_backbone_claims - delete all claims for a backbone 300 * batadv_bla_del_backbone_claims() - delete all claims for a backbone
302 * @backbone_gw: backbone gateway where the claims should be removed 301 * @backbone_gw: backbone gateway where the claims should be removed
303 */ 302 */
304static void 303static void
@@ -338,7 +337,7 @@ batadv_bla_del_backbone_claims(struct batadv_bla_backbone_gw *backbone_gw)
338} 337}
339 338
340/** 339/**
341 * batadv_bla_send_claim - sends a claim frame according to the provided info 340 * batadv_bla_send_claim() - sends a claim frame according to the provided info
342 * @bat_priv: the bat priv with all the soft interface information 341 * @bat_priv: the bat priv with all the soft interface information
343 * @mac: the mac address to be announced within the claim 342 * @mac: the mac address to be announced within the claim
344 * @vid: the VLAN ID 343 * @vid: the VLAN ID
@@ -458,7 +457,7 @@ out:
458} 457}
459 458
460/** 459/**
461 * batadv_bla_loopdetect_report - worker for reporting the loop 460 * batadv_bla_loopdetect_report() - worker for reporting the loop
462 * @work: work queue item 461 * @work: work queue item
463 * 462 *
464 * Throws an uevent, as the loopdetect check function can't do that itself 463 * 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)
488} 487}
489 488
490/** 489/**
491 * batadv_bla_get_backbone_gw - finds or creates a backbone gateway 490 * batadv_bla_get_backbone_gw() - finds or creates a backbone gateway
492 * @bat_priv: the bat priv with all the soft interface information 491 * @bat_priv: the bat priv with all the soft interface information
493 * @orig: the mac address of the originator 492 * @orig: the mac address of the originator
494 * @vid: the VLAN ID 493 * @vid: the VLAN ID
@@ -561,7 +560,7 @@ batadv_bla_get_backbone_gw(struct batadv_priv *bat_priv, u8 *orig,
561} 560}
562 561
563/** 562/**
564 * batadv_bla_update_own_backbone_gw - updates the own backbone gw for a VLAN 563 * batadv_bla_update_own_backbone_gw() - updates the own backbone gw for a VLAN
565 * @bat_priv: the bat priv with all the soft interface information 564 * @bat_priv: the bat priv with all the soft interface information
566 * @primary_if: the selected primary interface 565 * @primary_if: the selected primary interface
567 * @vid: VLAN identifier 566 * @vid: VLAN identifier
@@ -587,7 +586,7 @@ batadv_bla_update_own_backbone_gw(struct batadv_priv *bat_priv,
587} 586}
588 587
589/** 588/**
590 * batadv_bla_answer_request - answer a bla request by sending own claims 589 * batadv_bla_answer_request() - answer a bla request by sending own claims
591 * @bat_priv: the bat priv with all the soft interface information 590 * @bat_priv: the bat priv with all the soft interface information
592 * @primary_if: interface where the request came on 591 * @primary_if: interface where the request came on
593 * @vid: the vid where the request came on 592 * @vid: the vid where the request came on
@@ -637,7 +636,7 @@ static void batadv_bla_answer_request(struct batadv_priv *bat_priv,
637} 636}
638 637
639/** 638/**
640 * batadv_bla_send_request - send a request to repeat claims 639 * batadv_bla_send_request() - send a request to repeat claims
641 * @backbone_gw: the backbone gateway from whom we are out of sync 640 * @backbone_gw: the backbone gateway from whom we are out of sync
642 * 641 *
643 * When the crc is wrong, ask the backbone gateway for a full table update. 642 * 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)
664} 663}
665 664
666/** 665/**
667 * batadv_bla_send_announce - Send an announcement frame 666 * batadv_bla_send_announce() - Send an announcement frame
668 * @bat_priv: the bat priv with all the soft interface information 667 * @bat_priv: the bat priv with all the soft interface information
669 * @backbone_gw: our backbone gateway which should be announced 668 * @backbone_gw: our backbone gateway which should be announced
670 */ 669 */
@@ -685,7 +684,7 @@ static void batadv_bla_send_announce(struct batadv_priv *bat_priv,
685} 684}
686 685
687/** 686/**
688 * batadv_bla_add_claim - Adds a claim in the claim hash 687 * batadv_bla_add_claim() - Adds a claim in the claim hash
689 * @bat_priv: the bat priv with all the soft interface information 688 * @bat_priv: the bat priv with all the soft interface information
690 * @mac: the mac address of the claim 689 * @mac: the mac address of the claim
691 * @vid: the VLAN ID of the frame 690 * @vid: the VLAN ID of the frame
@@ -775,7 +774,7 @@ claim_free_ref:
775} 774}
776 775
777/** 776/**
778 * batadv_bla_claim_get_backbone_gw - Get valid reference for backbone_gw of 777 * batadv_bla_claim_get_backbone_gw() - Get valid reference for backbone_gw of
779 * claim 778 * claim
780 * @claim: claim whose backbone_gw should be returned 779 * @claim: claim whose backbone_gw should be returned
781 * 780 *
@@ -795,7 +794,7 @@ batadv_bla_claim_get_backbone_gw(struct batadv_bla_claim *claim)
795} 794}
796 795
797/** 796/**
798 * batadv_bla_del_claim - delete a claim from the claim hash 797 * batadv_bla_del_claim() - delete a claim from the claim hash
799 * @bat_priv: the bat priv with all the soft interface information 798 * @bat_priv: the bat priv with all the soft interface information
800 * @mac: mac address of the claim to be removed 799 * @mac: mac address of the claim to be removed
801 * @vid: VLAN id for the claim to be removed 800 * @vid: VLAN id for the claim to be removed
@@ -823,7 +822,7 @@ static void batadv_bla_del_claim(struct batadv_priv *bat_priv,
823} 822}
824 823
825/** 824/**
826 * batadv_handle_announce - check for ANNOUNCE frame 825 * batadv_handle_announce() - check for ANNOUNCE frame
827 * @bat_priv: the bat priv with all the soft interface information 826 * @bat_priv: the bat priv with all the soft interface information
828 * @an_addr: announcement mac address (ARP Sender HW address) 827 * @an_addr: announcement mac address (ARP Sender HW address)
829 * @backbone_addr: originator address of the sender (Ethernet source MAC) 828 * @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,
881} 880}
882 881
883/** 882/**
884 * batadv_handle_request - check for REQUEST frame 883 * batadv_handle_request() - check for REQUEST frame
885 * @bat_priv: the bat priv with all the soft interface information 884 * @bat_priv: the bat priv with all the soft interface information
886 * @primary_if: the primary hard interface of this batman soft interface 885 * @primary_if: the primary hard interface of this batman soft interface
887 * @backbone_addr: backbone address to be requested (ARP sender HW MAC) 886 * @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,
914} 913}
915 914
916/** 915/**
917 * batadv_handle_unclaim - check for UNCLAIM frame 916 * batadv_handle_unclaim() - check for UNCLAIM frame
918 * @bat_priv: the bat priv with all the soft interface information 917 * @bat_priv: the bat priv with all the soft interface information
919 * @primary_if: the primary hard interface of this batman soft interface 918 * @primary_if: the primary hard interface of this batman soft interface
920 * @backbone_addr: originator address of the backbone (Ethernet source) 919 * @backbone_addr: originator address of the backbone (Ethernet source)
@@ -952,7 +951,7 @@ static bool batadv_handle_unclaim(struct batadv_priv *bat_priv,
952} 951}
953 952
954/** 953/**
955 * batadv_handle_claim - check for CLAIM frame 954 * batadv_handle_claim() - check for CLAIM frame
956 * @bat_priv: the bat priv with all the soft interface information 955 * @bat_priv: the bat priv with all the soft interface information
957 * @primary_if: the primary hard interface of this batman soft interface 956 * @primary_if: the primary hard interface of this batman soft interface
958 * @backbone_addr: originator address of the backbone (Ethernet Source) 957 * @backbone_addr: originator address of the backbone (Ethernet Source)
@@ -989,7 +988,7 @@ static bool batadv_handle_claim(struct batadv_priv *bat_priv,
989} 988}
990 989
991/** 990/**
992 * batadv_check_claim_group - check for claim group membership 991 * batadv_check_claim_group() - check for claim group membership
993 * @bat_priv: the bat priv with all the soft interface information 992 * @bat_priv: the bat priv with all the soft interface information
994 * @primary_if: the primary interface of this batman interface 993 * @primary_if: the primary interface of this batman interface
995 * @hw_src: the Hardware source in the ARP Header 994 * @hw_src: the Hardware source in the ARP Header
@@ -1064,7 +1063,7 @@ static int batadv_check_claim_group(struct batadv_priv *bat_priv,
1064} 1063}
1065 1064
1066/** 1065/**
1067 * batadv_bla_process_claim - Check if this is a claim frame, and process it 1066 * batadv_bla_process_claim() - Check if this is a claim frame, and process it
1068 * @bat_priv: the bat priv with all the soft interface information 1067 * @bat_priv: the bat priv with all the soft interface information
1069 * @primary_if: the primary hard interface of this batman soft interface 1068 * @primary_if: the primary hard interface of this batman soft interface
1070 * @skb: the frame to be checked 1069 * @skb: the frame to be checked
@@ -1206,7 +1205,7 @@ static bool batadv_bla_process_claim(struct batadv_priv *bat_priv,
1206} 1205}
1207 1206
1208/** 1207/**
1209 * batadv_bla_purge_backbone_gw - Remove backbone gateways after a timeout or 1208 * batadv_bla_purge_backbone_gw() - Remove backbone gateways after a timeout or
1210 * immediately 1209 * immediately
1211 * @bat_priv: the bat priv with all the soft interface information 1210 * @bat_priv: the bat priv with all the soft interface information
1212 * @now: whether the whole hash shall be wiped now 1211 * @now: whether the whole hash shall be wiped now
@@ -1259,7 +1258,7 @@ purge_now:
1259} 1258}
1260 1259
1261/** 1260/**
1262 * batadv_bla_purge_claims - Remove claims after a timeout or immediately 1261 * batadv_bla_purge_claims() - Remove claims after a timeout or immediately
1263 * @bat_priv: the bat priv with all the soft interface information 1262 * @bat_priv: the bat priv with all the soft interface information
1264 * @primary_if: the selected primary interface, may be NULL if now is set 1263 * @primary_if: the selected primary interface, may be NULL if now is set
1265 * @now: whether the whole hash shall be wiped now 1264 * @now: whether the whole hash shall be wiped now
@@ -1317,7 +1316,7 @@ skip:
1317} 1316}
1318 1317
1319/** 1318/**
1320 * batadv_bla_update_orig_address - Update the backbone gateways when the own 1319 * batadv_bla_update_orig_address() - Update the backbone gateways when the own
1321 * originator address changes 1320 * originator address changes
1322 * @bat_priv: the bat priv with all the soft interface information 1321 * @bat_priv: the bat priv with all the soft interface information
1323 * @primary_if: the new selected primary_if 1322 * @primary_if: the new selected primary_if
@@ -1373,7 +1372,7 @@ void batadv_bla_update_orig_address(struct batadv_priv *bat_priv,
1373} 1372}
1374 1373
1375/** 1374/**
1376 * batadv_bla_send_loopdetect - send a loopdetect frame 1375 * batadv_bla_send_loopdetect() - send a loopdetect frame
1377 * @bat_priv: the bat priv with all the soft interface information 1376 * @bat_priv: the bat priv with all the soft interface information
1378 * @backbone_gw: the backbone gateway for which a loop should be detected 1377 * @backbone_gw: the backbone gateway for which a loop should be detected
1379 * 1378 *
@@ -1393,7 +1392,7 @@ batadv_bla_send_loopdetect(struct batadv_priv *bat_priv,
1393} 1392}
1394 1393
1395/** 1394/**
1396 * batadv_bla_status_update - purge bla interfaces if necessary 1395 * batadv_bla_status_update() - purge bla interfaces if necessary
1397 * @net_dev: the soft interface net device 1396 * @net_dev: the soft interface net device
1398 */ 1397 */
1399void batadv_bla_status_update(struct net_device *net_dev) 1398void batadv_bla_status_update(struct net_device *net_dev)
@@ -1413,7 +1412,7 @@ void batadv_bla_status_update(struct net_device *net_dev)
1413} 1412}
1414 1413
1415/** 1414/**
1416 * batadv_bla_periodic_work - performs periodic bla work 1415 * batadv_bla_periodic_work() - performs periodic bla work
1417 * @work: kernel work struct 1416 * @work: kernel work struct
1418 * 1417 *
1419 * periodic work to do: 1418 * periodic work to do:
@@ -1518,7 +1517,7 @@ static struct lock_class_key batadv_claim_hash_lock_class_key;
1518static struct lock_class_key batadv_backbone_hash_lock_class_key; 1517static struct lock_class_key batadv_backbone_hash_lock_class_key;
1519 1518
1520/** 1519/**
1521 * batadv_bla_init - initialize all bla structures 1520 * batadv_bla_init() - initialize all bla structures
1522 * @bat_priv: the bat priv with all the soft interface information 1521 * @bat_priv: the bat priv with all the soft interface information
1523 * 1522 *
1524 * Return: 0 on success, < 0 on error. 1523 * Return: 0 on success, < 0 on error.
@@ -1580,7 +1579,7 @@ int batadv_bla_init(struct batadv_priv *bat_priv)
1580} 1579}
1581 1580
1582/** 1581/**
1583 * batadv_bla_check_bcast_duplist - Check if a frame is in the broadcast dup. 1582 * batadv_bla_check_bcast_duplist() - Check if a frame is in the broadcast dup.
1584 * @bat_priv: the bat priv with all the soft interface information 1583 * @bat_priv: the bat priv with all the soft interface information
1585 * @skb: contains the bcast_packet to be checked 1584 * @skb: contains the bcast_packet to be checked
1586 * 1585 *
@@ -1653,7 +1652,7 @@ out:
1653} 1652}
1654 1653
1655/** 1654/**
1656 * batadv_bla_is_backbone_gw_orig - Check if the originator is a gateway for 1655 * batadv_bla_is_backbone_gw_orig() - Check if the originator is a gateway for
1657 * the VLAN identified by vid. 1656 * the VLAN identified by vid.
1658 * @bat_priv: the bat priv with all the soft interface information 1657 * @bat_priv: the bat priv with all the soft interface information
1659 * @orig: originator mac address 1658 * @orig: originator mac address
@@ -1693,7 +1692,7 @@ bool batadv_bla_is_backbone_gw_orig(struct batadv_priv *bat_priv, u8 *orig,
1693} 1692}
1694 1693
1695/** 1694/**
1696 * batadv_bla_is_backbone_gw - check if originator is a backbone gw for a VLAN. 1695 * batadv_bla_is_backbone_gw() - check if originator is a backbone gw for a VLAN
1697 * @skb: the frame to be checked 1696 * @skb: the frame to be checked
1698 * @orig_node: the orig_node of the frame 1697 * @orig_node: the orig_node of the frame
1699 * @hdr_size: maximum length of the frame 1698 * @hdr_size: maximum length of the frame
@@ -1727,7 +1726,7 @@ bool batadv_bla_is_backbone_gw(struct sk_buff *skb,
1727} 1726}
1728 1727
1729/** 1728/**
1730 * batadv_bla_free - free all bla structures 1729 * batadv_bla_free() - free all bla structures
1731 * @bat_priv: the bat priv with all the soft interface information 1730 * @bat_priv: the bat priv with all the soft interface information
1732 * 1731 *
1733 * for softinterface free or module unload 1732 * for softinterface free or module unload
@@ -1754,7 +1753,7 @@ void batadv_bla_free(struct batadv_priv *bat_priv)
1754} 1753}
1755 1754
1756/** 1755/**
1757 * batadv_bla_loopdetect_check - check and handle a detected loop 1756 * batadv_bla_loopdetect_check() - check and handle a detected loop
1758 * @bat_priv: the bat priv with all the soft interface information 1757 * @bat_priv: the bat priv with all the soft interface information
1759 * @skb: the packet to check 1758 * @skb: the packet to check
1760 * @primary_if: interface where the request came on 1759 * @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,
1803} 1802}
1804 1803
1805/** 1804/**
1806 * batadv_bla_rx - check packets coming from the mesh. 1805 * batadv_bla_rx() - check packets coming from the mesh.
1807 * @bat_priv: the bat priv with all the soft interface information 1806 * @bat_priv: the bat priv with all the soft interface information
1808 * @skb: the frame to be checked 1807 * @skb: the frame to be checked
1809 * @vid: the VLAN ID of the frame 1808 * @vid: the VLAN ID of the frame
@@ -1915,7 +1914,7 @@ out:
1915} 1914}
1916 1915
1917/** 1916/**
1918 * batadv_bla_tx - check packets going into the mesh 1917 * batadv_bla_tx() - check packets going into the mesh
1919 * @bat_priv: the bat priv with all the soft interface information 1918 * @bat_priv: the bat priv with all the soft interface information
1920 * @skb: the frame to be checked 1919 * @skb: the frame to be checked
1921 * @vid: the VLAN ID of the frame 1920 * @vid: the VLAN ID of the frame
@@ -2023,7 +2022,7 @@ out:
2023 2022
2024#ifdef CONFIG_BATMAN_ADV_DEBUGFS 2023#ifdef CONFIG_BATMAN_ADV_DEBUGFS
2025/** 2024/**
2026 * batadv_bla_claim_table_seq_print_text - print the claim table in a seq file 2025 * batadv_bla_claim_table_seq_print_text() - print the claim table in a seq file
2027 * @seq: seq file to print on 2026 * @seq: seq file to print on
2028 * @offset: not used 2027 * @offset: not used
2029 * 2028 *
@@ -2085,7 +2084,7 @@ out:
2085#endif 2084#endif
2086 2085
2087/** 2086/**
2088 * batadv_bla_claim_dump_entry - dump one entry of the claim table 2087 * batadv_bla_claim_dump_entry() - dump one entry of the claim table
2089 * to a netlink socket 2088 * to a netlink socket
2090 * @msg: buffer for the message 2089 * @msg: buffer for the message
2091 * @portid: netlink port 2090 * @portid: netlink port
@@ -2144,7 +2143,7 @@ out:
2144} 2143}
2145 2144
2146/** 2145/**
2147 * batadv_bla_claim_dump_bucket - dump one bucket of the claim table 2146 * batadv_bla_claim_dump_bucket() - dump one bucket of the claim table
2148 * to a netlink socket 2147 * to a netlink socket
2149 * @msg: buffer for the message 2148 * @msg: buffer for the message
2150 * @portid: netlink port 2149 * @portid: netlink port
@@ -2181,7 +2180,7 @@ unlock:
2181} 2180}
2182 2181
2183/** 2182/**
2184 * batadv_bla_claim_dump - dump claim table to a netlink socket 2183 * batadv_bla_claim_dump() - dump claim table to a netlink socket
2185 * @msg: buffer for the message 2184 * @msg: buffer for the message
2186 * @cb: callback structure containing arguments 2185 * @cb: callback structure containing arguments
2187 * 2186 *
@@ -2248,8 +2247,8 @@ out:
2248 2247
2249#ifdef CONFIG_BATMAN_ADV_DEBUGFS 2248#ifdef CONFIG_BATMAN_ADV_DEBUGFS
2250/** 2249/**
2251 * batadv_bla_backbone_table_seq_print_text - print the backbone table in a seq 2250 * batadv_bla_backbone_table_seq_print_text() - print the backbone table in a
2252 * file 2251 * seq file
2253 * @seq: seq file to print on 2252 * @seq: seq file to print on
2254 * @offset: not used 2253 * @offset: not used
2255 * 2254 *
@@ -2313,8 +2312,8 @@ out:
2313#endif 2312#endif
2314 2313
2315/** 2314/**
2316 * batadv_bla_backbone_dump_entry - dump one entry of the backbone table 2315 * batadv_bla_backbone_dump_entry() - dump one entry of the backbone table to a
2317 * to a netlink socket 2316 * netlink socket
2318 * @msg: buffer for the message 2317 * @msg: buffer for the message
2319 * @portid: netlink port 2318 * @portid: netlink port
2320 * @seq: Sequence number of netlink message 2319 * @seq: Sequence number of netlink message
@@ -2374,8 +2373,8 @@ out:
2374} 2373}
2375 2374
2376/** 2375/**
2377 * batadv_bla_backbone_dump_bucket - dump one bucket of the backbone table 2376 * batadv_bla_backbone_dump_bucket() - dump one bucket of the backbone table to
2378 * to a netlink socket 2377 * a netlink socket
2379 * @msg: buffer for the message 2378 * @msg: buffer for the message
2380 * @portid: netlink port 2379 * @portid: netlink port
2381 * @seq: Sequence number of netlink message 2380 * @seq: Sequence number of netlink message
@@ -2411,7 +2410,7 @@ unlock:
2411} 2410}
2412 2411
2413/** 2412/**
2414 * batadv_bla_backbone_dump - dump backbone table to a netlink socket 2413 * batadv_bla_backbone_dump() - dump backbone table to a netlink socket
2415 * @msg: buffer for the message 2414 * @msg: buffer for the message
2416 * @cb: callback structure containing arguments 2415 * @cb: callback structure containing arguments
2417 * 2416 *
@@ -2478,7 +2477,7 @@ out:
2478 2477
2479#ifdef CONFIG_BATMAN_ADV_DAT 2478#ifdef CONFIG_BATMAN_ADV_DAT
2480/** 2479/**
2481 * batadv_bla_check_claim - check if address is claimed 2480 * batadv_bla_check_claim() - check if address is claimed
2482 * 2481 *
2483 * @bat_priv: the bat priv with all the soft interface information 2482 * @bat_priv: the bat priv with all the soft interface information
2484 * @addr: mac address of which the claim status is checked 2483 * @addr: mac address of which the claim status is checked
diff --git a/net/batman-adv/bridge_loop_avoidance.h b/net/batman-adv/bridge_loop_avoidance.h
index b568cec819c5..b27571abcd2f 100644
--- a/net/batman-adv/bridge_loop_avoidance.h
+++ b/net/batman-adv/bridge_loop_avoidance.h
@@ -31,8 +31,8 @@ struct seq_file;
31struct sk_buff; 31struct sk_buff;
32 32
33/** 33/**
34 * batadv_bla_is_loopdetect_mac - check if the mac address is from a loop detect 34 * batadv_bla_is_loopdetect_mac() - check if the mac address is from a loop
35 * frame sent by bridge loop avoidance 35 * detect frame sent by bridge loop avoidance
36 * @mac: mac address to check 36 * @mac: mac address to check
37 * 37 *
38 * Return: true if the it looks like a loop detect frame 38 * Return: true if the it looks like a loop detect frame
diff --git a/net/batman-adv/debugfs.c b/net/batman-adv/debugfs.c
index fddf16a3dc89..97d6eb45cbf2 100644
--- a/net/batman-adv/debugfs.c
+++ b/net/batman-adv/debugfs.c
@@ -66,8 +66,8 @@ static int batadv_originators_open(struct inode *inode, struct file *file)
66} 66}
67 67
68/** 68/**
69 * batadv_originators_hardif_open - handles debugfs output for the 69 * batadv_originators_hardif_open() - handles debugfs output for the originator
70 * originator table of an hard interface 70 * table of an hard interface
71 * @inode: inode pointer to debugfs file 71 * @inode: inode pointer to debugfs file
72 * @file: pointer to the seq_file 72 * @file: pointer to the seq_file
73 * 73 *
@@ -117,7 +117,7 @@ static int batadv_bla_backbone_table_open(struct inode *inode,
117 117
118#ifdef CONFIG_BATMAN_ADV_DAT 118#ifdef CONFIG_BATMAN_ADV_DAT
119/** 119/**
120 * batadv_dat_cache_open - Prepare file handler for reads from dat_chache 120 * batadv_dat_cache_open() - Prepare file handler for reads from dat_chache
121 * @inode: inode which was opened 121 * @inode: inode which was opened
122 * @file: file handle to be initialized 122 * @file: file handle to be initialized
123 * 123 *
@@ -154,7 +154,7 @@ static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
154 154
155#ifdef CONFIG_BATMAN_ADV_MCAST 155#ifdef CONFIG_BATMAN_ADV_MCAST
156/** 156/**
157 * batadv_mcast_flags_open - prepare file handler for reads from mcast_flags 157 * batadv_mcast_flags_open() - prepare file handler for reads from mcast_flags
158 * @inode: inode which was opened 158 * @inode: inode which was opened
159 * @file: file handle to be initialized 159 * @file: file handle to be initialized
160 * 160 *
@@ -296,7 +296,7 @@ void batadv_debugfs_destroy(void)
296} 296}
297 297
298/** 298/**
299 * batadv_debugfs_add_hardif - creates the base directory for a hard interface 299 * batadv_debugfs_add_hardif() - creates the base directory for a hard interface
300 * in debugfs. 300 * in debugfs.
301 * @hard_iface: hard interface which should be added. 301 * @hard_iface: hard interface which should be added.
302 * 302 *
@@ -338,7 +338,7 @@ out:
338} 338}
339 339
340/** 340/**
341 * batadv_debugfs_del_hardif - delete the base directory for a hard interface 341 * batadv_debugfs_del_hardif() - delete the base directory for a hard interface
342 * in debugfs. 342 * in debugfs.
343 * @hard_iface: hard interface which is deleted. 343 * @hard_iface: hard interface which is deleted.
344 */ 344 */
diff --git a/net/batman-adv/distributed-arp-table.c b/net/batman-adv/distributed-arp-table.c
index f704bbc76e2a..9703c791ffc5 100644
--- a/net/batman-adv/distributed-arp-table.c
+++ b/net/batman-adv/distributed-arp-table.c
@@ -56,7 +56,7 @@
56static void batadv_dat_purge(struct work_struct *work); 56static void batadv_dat_purge(struct work_struct *work);
57 57
58/** 58/**
59 * batadv_dat_start_timer - initialise the DAT periodic worker 59 * batadv_dat_start_timer() - initialise the DAT periodic worker
60 * @bat_priv: the bat priv with all the soft interface information 60 * @bat_priv: the bat priv with all the soft interface information
61 */ 61 */
62static void batadv_dat_start_timer(struct batadv_priv *bat_priv) 62static 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)
67} 67}
68 68
69/** 69/**
70 * batadv_dat_entry_release - release dat_entry from lists and queue for free 70 * batadv_dat_entry_release() - release dat_entry from lists and queue for free
71 * after rcu grace period 71 * after rcu grace period
72 * @ref: kref pointer of the dat_entry 72 * @ref: kref pointer of the dat_entry
73 */ 73 */
@@ -81,7 +81,7 @@ static void batadv_dat_entry_release(struct kref *ref)
81} 81}
82 82
83/** 83/**
84 * batadv_dat_entry_put - decrement the dat_entry refcounter and possibly 84 * batadv_dat_entry_put() - decrement the dat_entry refcounter and possibly
85 * release it 85 * release it
86 * @dat_entry: dat_entry to be free'd 86 * @dat_entry: dat_entry to be free'd
87 */ 87 */
@@ -91,7 +91,7 @@ static void batadv_dat_entry_put(struct batadv_dat_entry *dat_entry)
91} 91}
92 92
93/** 93/**
94 * batadv_dat_to_purge - check whether a dat_entry has to be purged or not 94 * batadv_dat_to_purge() - check whether a dat_entry has to be purged or not
95 * @dat_entry: the entry to check 95 * @dat_entry: the entry to check
96 * 96 *
97 * Return: true if the entry has to be purged now, false otherwise. 97 * 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)
103} 103}
104 104
105/** 105/**
106 * __batadv_dat_purge - delete entries from the DAT local storage 106 * __batadv_dat_purge() - delete entries from the DAT local storage
107 * @bat_priv: the bat priv with all the soft interface information 107 * @bat_priv: the bat priv with all the soft interface information
108 * @to_purge: function in charge to decide whether an entry has to be purged or 108 * @to_purge: function in charge to decide whether an entry has to be purged or
109 * not. This function takes the dat_entry as argument and has to 109 * 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,
146} 146}
147 147
148/** 148/**
149 * batadv_dat_purge - periodic task that deletes old entries from the local DAT 149 * batadv_dat_purge() - periodic task that deletes old entries from the local
150 * hash table 150 * DAT hash table
151 * @work: kernel work struct 151 * @work: kernel work struct
152 */ 152 */
153static void batadv_dat_purge(struct work_struct *work) 153static void batadv_dat_purge(struct work_struct *work)
@@ -165,7 +165,7 @@ static void batadv_dat_purge(struct work_struct *work)
165} 165}
166 166
167/** 167/**
168 * batadv_compare_dat - comparing function used in the local DAT hash table 168 * batadv_compare_dat() - comparing function used in the local DAT hash table
169 * @node: node in the local table 169 * @node: node in the local table
170 * @data2: second object to compare the node to 170 * @data2: second object to compare the node to
171 * 171 *
@@ -180,7 +180,7 @@ static bool batadv_compare_dat(const struct hlist_node *node, const void *data2)
180} 180}
181 181
182/** 182/**
183 * batadv_arp_hw_src - extract the hw_src field from an ARP packet 183 * batadv_arp_hw_src() - extract the hw_src field from an ARP packet
184 * @skb: ARP packet 184 * @skb: ARP packet
185 * @hdr_size: size of the possible header before the ARP packet 185 * @hdr_size: size of the possible header before the ARP packet
186 * 186 *
@@ -197,7 +197,7 @@ static u8 *batadv_arp_hw_src(struct sk_buff *skb, int hdr_size)
197} 197}
198 198
199/** 199/**
200 * batadv_arp_ip_src - extract the ip_src field from an ARP packet 200 * batadv_arp_ip_src() - extract the ip_src field from an ARP packet
201 * @skb: ARP packet 201 * @skb: ARP packet
202 * @hdr_size: size of the possible header before the ARP packet 202 * @hdr_size: size of the possible header before the ARP packet
203 * 203 *
@@ -209,7 +209,7 @@ static __be32 batadv_arp_ip_src(struct sk_buff *skb, int hdr_size)
209} 209}
210 210
211/** 211/**
212 * batadv_arp_hw_dst - extract the hw_dst field from an ARP packet 212 * batadv_arp_hw_dst() - extract the hw_dst field from an ARP packet
213 * @skb: ARP packet 213 * @skb: ARP packet
214 * @hdr_size: size of the possible header before the ARP packet 214 * @hdr_size: size of the possible header before the ARP packet
215 * 215 *
@@ -221,7 +221,7 @@ static u8 *batadv_arp_hw_dst(struct sk_buff *skb, int hdr_size)
221} 221}
222 222
223/** 223/**
224 * batadv_arp_ip_dst - extract the ip_dst field from an ARP packet 224 * batadv_arp_ip_dst() - extract the ip_dst field from an ARP packet
225 * @skb: ARP packet 225 * @skb: ARP packet
226 * @hdr_size: size of the possible header before the ARP packet 226 * @hdr_size: size of the possible header before the ARP packet
227 * 227 *
@@ -233,7 +233,7 @@ static __be32 batadv_arp_ip_dst(struct sk_buff *skb, int hdr_size)
233} 233}
234 234
235/** 235/**
236 * batadv_hash_dat - compute the hash value for an IP address 236 * batadv_hash_dat() - compute the hash value for an IP address
237 * @data: data to hash 237 * @data: data to hash
238 * @size: size of the hash table 238 * @size: size of the hash table
239 * 239 *
@@ -268,7 +268,7 @@ static u32 batadv_hash_dat(const void *data, u32 size)
268} 268}
269 269
270/** 270/**
271 * batadv_dat_entry_hash_find - look for a given dat_entry in the local hash 271 * batadv_dat_entry_hash_find() - look for a given dat_entry in the local hash
272 * table 272 * table
273 * @bat_priv: the bat priv with all the soft interface information 273 * @bat_priv: the bat priv with all the soft interface information
274 * @ip: search key 274 * @ip: search key
@@ -311,7 +311,7 @@ batadv_dat_entry_hash_find(struct batadv_priv *bat_priv, __be32 ip,
311} 311}
312 312
313/** 313/**
314 * batadv_dat_entry_add - add a new dat entry or update it if already exists 314 * batadv_dat_entry_add() - add a new dat entry or update it if already exists
315 * @bat_priv: the bat priv with all the soft interface information 315 * @bat_priv: the bat priv with all the soft interface information
316 * @ip: ipv4 to add/edit 316 * @ip: ipv4 to add/edit
317 * @mac_addr: mac address to assign to the given ipv4 317 * @mac_addr: mac address to assign to the given ipv4
@@ -368,7 +368,8 @@ out:
368#ifdef CONFIG_BATMAN_ADV_DEBUG 368#ifdef CONFIG_BATMAN_ADV_DEBUG
369 369
370/** 370/**
371 * batadv_dbg_arp - print a debug message containing all the ARP packet details 371 * batadv_dbg_arp() - print a debug message containing all the ARP packet
372 * details
372 * @bat_priv: the bat priv with all the soft interface information 373 * @bat_priv: the bat priv with all the soft interface information
373 * @skb: ARP packet 374 * @skb: ARP packet
374 * @hdr_size: size of the possible header before the ARP packet 375 * @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,
449#endif /* CONFIG_BATMAN_ADV_DEBUG */ 450#endif /* CONFIG_BATMAN_ADV_DEBUG */
450 451
451/** 452/**
452 * batadv_is_orig_node_eligible - check whether a node can be a DHT candidate 453 * batadv_is_orig_node_eligible() - check whether a node can be a DHT candidate
453 * @res: the array with the already selected candidates 454 * @res: the array with the already selected candidates
454 * @select: number of already selected candidates 455 * @select: number of already selected candidates
455 * @tmp_max: address of the currently evaluated node 456 * @tmp_max: address of the currently evaluated node
@@ -503,7 +504,7 @@ out:
503} 504}
504 505
505/** 506/**
506 * batadv_choose_next_candidate - select the next DHT candidate 507 * batadv_choose_next_candidate() - select the next DHT candidate
507 * @bat_priv: the bat priv with all the soft interface information 508 * @bat_priv: the bat priv with all the soft interface information
508 * @cands: candidates array 509 * @cands: candidates array
509 * @select: number of candidates already present in the array 510 * @select: number of candidates already present in the array
@@ -567,8 +568,8 @@ static void batadv_choose_next_candidate(struct batadv_priv *bat_priv,
567} 568}
568 569
569/** 570/**
570 * batadv_dat_select_candidates - select the nodes which the DHT message has to 571 * batadv_dat_select_candidates() - select the nodes which the DHT message has
571 * be sent to 572 * to be sent to
572 * @bat_priv: the bat priv with all the soft interface information 573 * @bat_priv: the bat priv with all the soft interface information
573 * @ip_dst: ipv4 to look up in the DHT 574 * @ip_dst: ipv4 to look up in the DHT
574 * @vid: VLAN identifier 575 * @vid: VLAN identifier
@@ -613,7 +614,7 @@ batadv_dat_select_candidates(struct batadv_priv *bat_priv, __be32 ip_dst,
613} 614}
614 615
615/** 616/**
616 * batadv_dat_send_data - send a payload to the selected candidates 617 * batadv_dat_send_data() - send a payload to the selected candidates
617 * @bat_priv: the bat priv with all the soft interface information 618 * @bat_priv: the bat priv with all the soft interface information
618 * @skb: payload to send 619 * @skb: payload to send
619 * @ip: the DHT key 620 * @ip: the DHT key
@@ -689,7 +690,7 @@ out:
689} 690}
690 691
691/** 692/**
692 * batadv_dat_tvlv_container_update - update the dat tvlv container after dat 693 * batadv_dat_tvlv_container_update() - update the dat tvlv container after dat
693 * setting change 694 * setting change
694 * @bat_priv: the bat priv with all the soft interface information 695 * @bat_priv: the bat priv with all the soft interface information
695 */ 696 */
@@ -711,7 +712,7 @@ static void batadv_dat_tvlv_container_update(struct batadv_priv *bat_priv)
711} 712}
712 713
713/** 714/**
714 * batadv_dat_status_update - update the dat tvlv container after dat 715 * batadv_dat_status_update() - update the dat tvlv container after dat
715 * setting change 716 * setting change
716 * @net_dev: the soft interface net device 717 * @net_dev: the soft interface net device
717 */ 718 */
@@ -723,7 +724,7 @@ void batadv_dat_status_update(struct net_device *net_dev)
723} 724}
724 725
725/** 726/**
726 * batadv_dat_tvlv_ogm_handler_v1 - process incoming dat tvlv container 727 * batadv_dat_tvlv_ogm_handler_v1() - process incoming dat tvlv container
727 * @bat_priv: the bat priv with all the soft interface information 728 * @bat_priv: the bat priv with all the soft interface information
728 * @orig: the orig_node of the ogm 729 * @orig: the orig_node of the ogm
729 * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) 730 * @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,
742} 743}
743 744
744/** 745/**
745 * batadv_dat_hash_free - free the local DAT hash table 746 * batadv_dat_hash_free() - free the local DAT hash table
746 * @bat_priv: the bat priv with all the soft interface information 747 * @bat_priv: the bat priv with all the soft interface information
747 */ 748 */
748static void batadv_dat_hash_free(struct batadv_priv *bat_priv) 749static 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)
758} 759}
759 760
760/** 761/**
761 * batadv_dat_init - initialise the DAT internals 762 * batadv_dat_init() - initialise the DAT internals
762 * @bat_priv: the bat priv with all the soft interface information 763 * @bat_priv: the bat priv with all the soft interface information
763 * 764 *
764 * Return: 0 in case of success, a negative error code otherwise 765 * Return: 0 in case of success, a negative error code otherwise
@@ -783,7 +784,7 @@ int batadv_dat_init(struct batadv_priv *bat_priv)
783} 784}
784 785
785/** 786/**
786 * batadv_dat_free - free the DAT internals 787 * batadv_dat_free() - free the DAT internals
787 * @bat_priv: the bat priv with all the soft interface information 788 * @bat_priv: the bat priv with all the soft interface information
788 */ 789 */
789void batadv_dat_free(struct batadv_priv *bat_priv) 790void batadv_dat_free(struct batadv_priv *bat_priv)
@@ -798,7 +799,7 @@ void batadv_dat_free(struct batadv_priv *bat_priv)
798 799
799#ifdef CONFIG_BATMAN_ADV_DEBUGFS 800#ifdef CONFIG_BATMAN_ADV_DEBUGFS
800/** 801/**
801 * batadv_dat_cache_seq_print_text - print the local DAT hash table 802 * batadv_dat_cache_seq_print_text() - print the local DAT hash table
802 * @seq: seq file to print on 803 * @seq: seq file to print on
803 * @offset: not used 804 * @offset: not used
804 * 805 *
@@ -851,7 +852,7 @@ out:
851#endif 852#endif
852 853
853/** 854/**
854 * batadv_arp_get_type - parse an ARP packet and gets the type 855 * batadv_arp_get_type() - parse an ARP packet and gets the type
855 * @bat_priv: the bat priv with all the soft interface information 856 * @bat_priv: the bat priv with all the soft interface information
856 * @skb: packet to analyse 857 * @skb: packet to analyse
857 * @hdr_size: size of the possible header before the ARP packet in the skb 858 * @hdr_size: size of the possible header before the ARP packet in the skb
@@ -925,7 +926,7 @@ out:
925} 926}
926 927
927/** 928/**
928 * batadv_dat_get_vid - extract the VLAN identifier from skb if any 929 * batadv_dat_get_vid() - extract the VLAN identifier from skb if any
929 * @skb: the buffer containing the packet to extract the VID from 930 * @skb: the buffer containing the packet to extract the VID from
930 * @hdr_size: the size of the batman-adv header encapsulating the packet 931 * @hdr_size: the size of the batman-adv header encapsulating the packet
931 * 932 *
@@ -951,7 +952,7 @@ static unsigned short batadv_dat_get_vid(struct sk_buff *skb, int *hdr_size)
951} 952}
952 953
953/** 954/**
954 * batadv_dat_arp_create_reply - create an ARP Reply 955 * batadv_dat_arp_create_reply() - create an ARP Reply
955 * @bat_priv: the bat priv with all the soft interface information 956 * @bat_priv: the bat priv with all the soft interface information
956 * @ip_src: ARP sender IP 957 * @ip_src: ARP sender IP
957 * @ip_dst: ARP target IP 958 * @ip_dst: ARP target IP
@@ -986,7 +987,7 @@ batadv_dat_arp_create_reply(struct batadv_priv *bat_priv, __be32 ip_src,
986} 987}
987 988
988/** 989/**
989 * batadv_dat_snoop_outgoing_arp_request - snoop the ARP request and try to 990 * batadv_dat_snoop_outgoing_arp_request() - snoop the ARP request and try to
990 * answer using DAT 991 * answer using DAT
991 * @bat_priv: the bat priv with all the soft interface information 992 * @bat_priv: the bat priv with all the soft interface information
992 * @skb: packet to check 993 * @skb: packet to check
@@ -1084,7 +1085,7 @@ out:
1084} 1085}
1085 1086
1086/** 1087/**
1087 * batadv_dat_snoop_incoming_arp_request - snoop the ARP request and try to 1088 * batadv_dat_snoop_incoming_arp_request() - snoop the ARP request and try to
1088 * answer using the local DAT storage 1089 * answer using the local DAT storage
1089 * @bat_priv: the bat priv with all the soft interface information 1090 * @bat_priv: the bat priv with all the soft interface information
1090 * @skb: packet to check 1091 * @skb: packet to check
@@ -1154,7 +1155,7 @@ out:
1154} 1155}
1155 1156
1156/** 1157/**
1157 * batadv_dat_snoop_outgoing_arp_reply - snoop the ARP reply and fill the DHT 1158 * batadv_dat_snoop_outgoing_arp_reply() - snoop the ARP reply and fill the DHT
1158 * @bat_priv: the bat priv with all the soft interface information 1159 * @bat_priv: the bat priv with all the soft interface information
1159 * @skb: packet to check 1160 * @skb: packet to check
1160 */ 1161 */
@@ -1194,8 +1195,8 @@ void batadv_dat_snoop_outgoing_arp_reply(struct batadv_priv *bat_priv,
1194} 1195}
1195 1196
1196/** 1197/**
1197 * batadv_dat_snoop_incoming_arp_reply - snoop the ARP reply and fill the local 1198 * batadv_dat_snoop_incoming_arp_reply() - snoop the ARP reply and fill the
1198 * DAT storage only 1199 * local DAT storage only
1199 * @bat_priv: the bat priv with all the soft interface information 1200 * @bat_priv: the bat priv with all the soft interface information
1200 * @skb: packet to check 1201 * @skb: packet to check
1201 * @hdr_size: size of the encapsulation header 1202 * @hdr_size: size of the encapsulation header
@@ -1283,8 +1284,8 @@ out:
1283} 1284}
1284 1285
1285/** 1286/**
1286 * batadv_dat_drop_broadcast_packet - check if an ARP request has to be dropped 1287 * batadv_dat_drop_broadcast_packet() - check if an ARP request has to be
1287 * (because the node has already obtained the reply via DAT) or not 1288 * dropped (because the node has already obtained the reply via DAT) or not
1288 * @bat_priv: the bat priv with all the soft interface information 1289 * @bat_priv: the bat priv with all the soft interface information
1289 * @forw_packet: the broadcast packet 1290 * @forw_packet: the broadcast packet
1290 * 1291 *
diff --git a/net/batman-adv/distributed-arp-table.h b/net/batman-adv/distributed-arp-table.h
index d81a05a6e6f9..3d47bedaf661 100644
--- a/net/batman-adv/distributed-arp-table.h
+++ b/net/batman-adv/distributed-arp-table.h
@@ -49,7 +49,7 @@ bool batadv_dat_drop_broadcast_packet(struct batadv_priv *bat_priv,
49 struct batadv_forw_packet *forw_packet); 49 struct batadv_forw_packet *forw_packet);
50 50
51/** 51/**
52 * batadv_dat_init_orig_node_addr - assign a DAT address to the orig_node 52 * batadv_dat_init_orig_node_addr() - assign a DAT address to the orig_node
53 * @orig_node: the node to assign the DAT address to 53 * @orig_node: the node to assign the DAT address to
54 */ 54 */
55static inline void 55static inline void
@@ -62,7 +62,7 @@ batadv_dat_init_orig_node_addr(struct batadv_orig_node *orig_node)
62} 62}
63 63
64/** 64/**
65 * batadv_dat_init_own_addr - assign a DAT address to the node itself 65 * batadv_dat_init_own_addr() - assign a DAT address to the node itself
66 * @bat_priv: the bat priv with all the soft interface information 66 * @bat_priv: the bat priv with all the soft interface information
67 * @primary_if: a pointer to the primary interface 67 * @primary_if: a pointer to the primary interface
68 */ 68 */
@@ -83,7 +83,7 @@ void batadv_dat_free(struct batadv_priv *bat_priv);
83int batadv_dat_cache_seq_print_text(struct seq_file *seq, void *offset); 83int batadv_dat_cache_seq_print_text(struct seq_file *seq, void *offset);
84 84
85/** 85/**
86 * batadv_dat_inc_counter - increment the correct DAT packet counter 86 * batadv_dat_inc_counter() - increment the correct DAT packet counter
87 * @bat_priv: the bat priv with all the soft interface information 87 * @bat_priv: the bat priv with all the soft interface information
88 * @subtype: the 4addr subtype of the packet to be counted 88 * @subtype: the 4addr subtype of the packet to be counted
89 * 89 *
diff --git a/net/batman-adv/fragmentation.c b/net/batman-adv/fragmentation.c
index 741c6b91664e..36f8a84153bf 100644
--- a/net/batman-adv/fragmentation.c
+++ b/net/batman-adv/fragmentation.c
@@ -42,7 +42,7 @@
42#include "soft-interface.h" 42#include "soft-interface.h"
43 43
44/** 44/**
45 * batadv_frag_clear_chain - delete entries in the fragment buffer chain 45 * batadv_frag_clear_chain() - delete entries in the fragment buffer chain
46 * @head: head of chain with entries. 46 * @head: head of chain with entries.
47 * @dropped: whether the chain is cleared because all fragments are dropped 47 * @dropped: whether the chain is cleared because all fragments are dropped
48 * 48 *
@@ -66,7 +66,7 @@ static void batadv_frag_clear_chain(struct hlist_head *head, bool dropped)
66} 66}
67 67
68/** 68/**
69 * batadv_frag_purge_orig - free fragments associated to an orig 69 * batadv_frag_purge_orig() - free fragments associated to an orig
70 * @orig_node: originator to free fragments from 70 * @orig_node: originator to free fragments from
71 * @check_cb: optional function to tell if an entry should be purged 71 * @check_cb: optional function to tell if an entry should be purged
72 */ 72 */
@@ -90,7 +90,7 @@ void batadv_frag_purge_orig(struct batadv_orig_node *orig_node,
90} 90}
91 91
92/** 92/**
93 * batadv_frag_size_limit - maximum possible size of packet to be fragmented 93 * batadv_frag_size_limit() - maximum possible size of packet to be fragmented
94 * 94 *
95 * Return: the maximum size of payload that can be fragmented. 95 * Return: the maximum size of payload that can be fragmented.
96 */ 96 */
@@ -105,7 +105,7 @@ static int batadv_frag_size_limit(void)
105} 105}
106 106
107/** 107/**
108 * batadv_frag_init_chain - check and prepare fragment chain for new fragment 108 * batadv_frag_init_chain() - check and prepare fragment chain for new fragment
109 * @chain: chain in fragments table to init 109 * @chain: chain in fragments table to init
110 * @seqno: sequence number of the received fragment 110 * @seqno: sequence number of the received fragment
111 * 111 *
@@ -135,7 +135,7 @@ static bool batadv_frag_init_chain(struct batadv_frag_table_entry *chain,
135} 135}
136 136
137/** 137/**
138 * batadv_frag_insert_packet - insert a fragment into a fragment chain 138 * batadv_frag_insert_packet() - insert a fragment into a fragment chain
139 * @orig_node: originator that the fragment was received from 139 * @orig_node: originator that the fragment was received from
140 * @skb: skb to insert 140 * @skb: skb to insert
141 * @chain_out: list head to attach complete chains of fragments to 141 * @chain_out: list head to attach complete chains of fragments to
@@ -249,7 +249,7 @@ err:
249} 249}
250 250
251/** 251/**
252 * batadv_frag_merge_packets - merge a chain of fragments 252 * batadv_frag_merge_packets() - merge a chain of fragments
253 * @chain: head of chain with fragments 253 * @chain: head of chain with fragments
254 * 254 *
255 * Expand the first skb in the chain and copy the content of the remaining 255 * Expand the first skb in the chain and copy the content of the remaining
@@ -307,7 +307,7 @@ free:
307} 307}
308 308
309/** 309/**
310 * batadv_frag_skb_buffer - buffer fragment for later merge 310 * batadv_frag_skb_buffer() - buffer fragment for later merge
311 * @skb: skb to buffer 311 * @skb: skb to buffer
312 * @orig_node_src: originator that the skb is received from 312 * @orig_node_src: originator that the skb is received from
313 * 313 *
@@ -347,7 +347,7 @@ out_err:
347} 347}
348 348
349/** 349/**
350 * batadv_frag_skb_fwd - forward fragments that would exceed MTU when merged 350 * batadv_frag_skb_fwd() - forward fragments that would exceed MTU when merged
351 * @skb: skb to forward 351 * @skb: skb to forward
352 * @recv_if: interface that the skb is received on 352 * @recv_if: interface that the skb is received on
353 * @orig_node_src: originator that the skb is received from 353 * @orig_node_src: originator that the skb is received from
@@ -401,7 +401,7 @@ out:
401} 401}
402 402
403/** 403/**
404 * batadv_frag_create - create a fragment from skb 404 * batadv_frag_create() - create a fragment from skb
405 * @skb: skb to create fragment from 405 * @skb: skb to create fragment from
406 * @frag_head: header to use in new fragment 406 * @frag_head: header to use in new fragment
407 * @fragment_size: size of new fragment 407 * @fragment_size: size of new fragment
@@ -439,7 +439,7 @@ err:
439} 439}
440 440
441/** 441/**
442 * batadv_frag_send_packet - create up to 16 fragments from the passed skb 442 * batadv_frag_send_packet() - create up to 16 fragments from the passed skb
443 * @skb: skb to create fragments from 443 * @skb: skb to create fragments from
444 * @orig_node: final destination of the created fragments 444 * @orig_node: final destination of the created fragments
445 * @neigh_node: next-hop of the created fragments 445 * @neigh_node: next-hop of the created fragments
diff --git a/net/batman-adv/fragmentation.h b/net/batman-adv/fragmentation.h
index 30ffa992fcfc..138b22a1836a 100644
--- a/net/batman-adv/fragmentation.h
+++ b/net/batman-adv/fragmentation.h
@@ -40,7 +40,7 @@ int batadv_frag_send_packet(struct sk_buff *skb,
40 struct batadv_neigh_node *neigh_node); 40 struct batadv_neigh_node *neigh_node);
41 41
42/** 42/**
43 * batadv_frag_check_entry - check if a list of fragments has timed out 43 * batadv_frag_check_entry() - check if a list of fragments has timed out
44 * @frags_entry: table entry to check 44 * @frags_entry: table entry to check
45 * 45 *
46 * Return: true if the frags entry has timed out, false otherwise. 46 * Return: true if the frags entry has timed out, false otherwise.
diff --git a/net/batman-adv/gateway_client.c b/net/batman-adv/gateway_client.c
index 21db0165175b..6731f7dabeb9 100644
--- a/net/batman-adv/gateway_client.c
+++ b/net/batman-adv/gateway_client.c
@@ -69,8 +69,8 @@
69#define BATADV_DHCP_CHADDR_OFFSET 28 69#define BATADV_DHCP_CHADDR_OFFSET 28
70 70
71/** 71/**
72 * batadv_gw_node_release - release gw_node from lists and queue for free after 72 * batadv_gw_node_release() - release gw_node from lists and queue for free
73 * rcu grace period 73 * after rcu grace period
74 * @ref: kref pointer of the gw_node 74 * @ref: kref pointer of the gw_node
75 */ 75 */
76static void batadv_gw_node_release(struct kref *ref) 76static void batadv_gw_node_release(struct kref *ref)
@@ -84,7 +84,8 @@ static void batadv_gw_node_release(struct kref *ref)
84} 84}
85 85
86/** 86/**
87 * batadv_gw_node_put - decrement the gw_node refcounter and possibly release it 87 * batadv_gw_node_put() - decrement the gw_node refcounter and possibly release
88 * it
88 * @gw_node: gateway node to free 89 * @gw_node: gateway node to free
89 */ 90 */
90void batadv_gw_node_put(struct batadv_gw_node *gw_node) 91void batadv_gw_node_put(struct batadv_gw_node *gw_node)
@@ -156,7 +157,7 @@ static void batadv_gw_select(struct batadv_priv *bat_priv,
156} 157}
157 158
158/** 159/**
159 * batadv_gw_reselect - force a gateway reselection 160 * batadv_gw_reselect() - force a gateway reselection
160 * @bat_priv: the bat priv with all the soft interface information 161 * @bat_priv: the bat priv with all the soft interface information
161 * 162 *
162 * Set a flag to remind the GW component to perform a new gateway reselection. 163 * 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)
172} 173}
173 174
174/** 175/**
175 * batadv_gw_check_client_stop - check if client mode has been switched off 176 * batadv_gw_check_client_stop() - check if client mode has been switched off
176 * @bat_priv: the bat priv with all the soft interface information 177 * @bat_priv: the bat priv with all the soft interface information
177 * 178 *
178 * This function assumes the caller has checked that the gw state *is actually 179 * This function assumes the caller has checked that the gw state *is actually
@@ -322,7 +323,7 @@ out:
322} 323}
323 324
324/** 325/**
325 * batadv_gw_node_add - add gateway node to list of available gateways 326 * batadv_gw_node_add() - add gateway node to list of available gateways
326 * @bat_priv: the bat priv with all the soft interface information 327 * @bat_priv: the bat priv with all the soft interface information
327 * @orig_node: originator announcing gateway capabilities 328 * @orig_node: originator announcing gateway capabilities
328 * @gateway: announced bandwidth information 329 * @gateway: announced bandwidth information
@@ -365,7 +366,7 @@ static void batadv_gw_node_add(struct batadv_priv *bat_priv,
365} 366}
366 367
367/** 368/**
368 * batadv_gw_node_get - retrieve gateway node from list of available gateways 369 * batadv_gw_node_get() - retrieve gateway node from list of available gateways
369 * @bat_priv: the bat priv with all the soft interface information 370 * @bat_priv: the bat priv with all the soft interface information
370 * @orig_node: originator announcing gateway capabilities 371 * @orig_node: originator announcing gateway capabilities
371 * 372 *
@@ -394,7 +395,7 @@ struct batadv_gw_node *batadv_gw_node_get(struct batadv_priv *bat_priv,
394} 395}
395 396
396/** 397/**
397 * batadv_gw_node_update - update list of available gateways with changed 398 * batadv_gw_node_update() - update list of available gateways with changed
398 * bandwidth information 399 * bandwidth information
399 * @bat_priv: the bat priv with all the soft interface information 400 * @bat_priv: the bat priv with all the soft interface information
400 * @orig_node: originator announcing gateway capabilities 401 * @orig_node: originator announcing gateway capabilities
@@ -515,7 +516,7 @@ int batadv_gw_client_seq_print_text(struct seq_file *seq, void *offset)
515#endif 516#endif
516 517
517/** 518/**
518 * batadv_gw_dump - Dump gateways into a message 519 * batadv_gw_dump() - Dump gateways into a message
519 * @msg: Netlink message to dump into 520 * @msg: Netlink message to dump into
520 * @cb: Control block containing additional options 521 * @cb: Control block containing additional options
521 * 522 *
@@ -568,7 +569,7 @@ out:
568} 569}
569 570
570/** 571/**
571 * batadv_gw_dhcp_recipient_get - check if a packet is a DHCP message 572 * batadv_gw_dhcp_recipient_get() - check if a packet is a DHCP message
572 * @skb: the packet to check 573 * @skb: the packet to check
573 * @header_len: a pointer to the batman-adv header size 574 * @header_len: a pointer to the batman-adv header size
574 * @chaddr: buffer where the client address will be stored. Valid 575 * @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,
687} 688}
688 689
689/** 690/**
690 * batadv_gw_out_of_range - check if the dhcp request destination is the best gw 691 * batadv_gw_out_of_range() - check if the dhcp request destination is the best
692 * gateway
691 * @bat_priv: the bat priv with all the soft interface information 693 * @bat_priv: the bat priv with all the soft interface information
692 * @skb: the outgoing packet 694 * @skb: the outgoing packet
693 * 695 *
diff --git a/net/batman-adv/gateway_common.c b/net/batman-adv/gateway_common.c
index a7039503d88e..1c58727835ca 100644
--- a/net/batman-adv/gateway_common.c
+++ b/net/batman-adv/gateway_common.c
@@ -34,8 +34,8 @@
34#include "tvlv.h" 34#include "tvlv.h"
35 35
36/** 36/**
37 * batadv_parse_throughput - parse supplied string buffer to extract throughput 37 * batadv_parse_throughput() - parse supplied string buffer to extract
38 * information 38 * throughput information
39 * @net_dev: the soft interface net device 39 * @net_dev: the soft interface net device
40 * @buff: string buffer to parse 40 * @buff: string buffer to parse
41 * @description: text shown when throughput string cannot be parsed 41 * @description: text shown when throughput string cannot be parsed
@@ -101,8 +101,8 @@ bool batadv_parse_throughput(struct net_device *net_dev, char *buff,
101} 101}
102 102
103/** 103/**
104 * batadv_parse_gw_bandwidth - parse supplied string buffer to extract download 104 * batadv_parse_gw_bandwidth() - parse supplied string buffer to extract
105 * and upload bandwidth information 105 * download and upload bandwidth information
106 * @net_dev: the soft interface net device 106 * @net_dev: the soft interface net device
107 * @buff: string buffer to parse 107 * @buff: string buffer to parse
108 * @down: pointer holding the returned download bandwidth information 108 * @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,
137} 137}
138 138
139/** 139/**
140 * batadv_gw_tvlv_container_update - update the gw tvlv container after gateway 140 * batadv_gw_tvlv_container_update() - update the gw tvlv container after
141 * setting change 141 * gateway setting change
142 * @bat_priv: the bat priv with all the soft interface information 142 * @bat_priv: the bat priv with all the soft interface information
143 */ 143 */
144void batadv_gw_tvlv_container_update(struct batadv_priv *bat_priv) 144void 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,
208} 208}
209 209
210/** 210/**
211 * batadv_gw_tvlv_ogm_handler_v1 - process incoming gateway tvlv container 211 * batadv_gw_tvlv_ogm_handler_v1() - process incoming gateway tvlv container
212 * @bat_priv: the bat priv with all the soft interface information 212 * @bat_priv: the bat priv with all the soft interface information
213 * @orig: the orig_node of the ogm 213 * @orig: the orig_node of the ogm
214 * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) 214 * @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,
249} 249}
250 250
251/** 251/**
252 * batadv_gw_init - initialise the gateway handling internals 252 * batadv_gw_init() - initialise the gateway handling internals
253 * @bat_priv: the bat priv with all the soft interface information 253 * @bat_priv: the bat priv with all the soft interface information
254 */ 254 */
255void batadv_gw_init(struct batadv_priv *bat_priv) 255void batadv_gw_init(struct batadv_priv *bat_priv)
@@ -265,7 +265,7 @@ void batadv_gw_init(struct batadv_priv *bat_priv)
265} 265}
266 266
267/** 267/**
268 * batadv_gw_free - free the gateway handling internals 268 * batadv_gw_free() - free the gateway handling internals
269 * @bat_priv: the bat priv with all the soft interface information 269 * @bat_priv: the bat priv with all the soft interface information
270 */ 270 */
271void batadv_gw_free(struct batadv_priv *bat_priv) 271void batadv_gw_free(struct batadv_priv *bat_priv)
diff --git a/net/batman-adv/hard-interface.c b/net/batman-adv/hard-interface.c
index 394e69b77535..33425a022026 100644
--- a/net/batman-adv/hard-interface.c
+++ b/net/batman-adv/hard-interface.c
@@ -53,7 +53,7 @@
53#include "translation-table.h" 53#include "translation-table.h"
54 54
55/** 55/**
56 * batadv_hardif_release - release hard interface from lists and queue for 56 * batadv_hardif_release() - release hard interface from lists and queue for
57 * free after rcu grace period 57 * free after rcu grace period
58 * @ref: kref pointer of the hard interface 58 * @ref: kref pointer of the hard interface
59 */ 59 */
@@ -87,7 +87,7 @@ out:
87} 87}
88 88
89/** 89/**
90 * batadv_getlink_net - return link net namespace (of use fallback) 90 * batadv_getlink_net() - return link net namespace (of use fallback)
91 * @netdev: net_device to check 91 * @netdev: net_device to check
92 * @fallback_net: return in case get_link_net is not available for @netdev 92 * @fallback_net: return in case get_link_net is not available for @netdev
93 * 93 *
@@ -106,7 +106,7 @@ static struct net *batadv_getlink_net(const struct net_device *netdev,
106} 106}
107 107
108/** 108/**
109 * batadv_mutual_parents - check if two devices are each others parent 109 * batadv_mutual_parents() - check if two devices are each others parent
110 * @dev1: 1st net dev 110 * @dev1: 1st net dev
111 * @net1: 1st devices netns 111 * @net1: 1st devices netns
112 * @dev2: 2nd net dev 112 * @dev2: 2nd net dev
@@ -139,7 +139,7 @@ static bool batadv_mutual_parents(const struct net_device *dev1,
139} 139}
140 140
141/** 141/**
142 * batadv_is_on_batman_iface - check if a device is a batman iface descendant 142 * batadv_is_on_batman_iface() - check if a device is a batman iface descendant
143 * @net_dev: the device to check 143 * @net_dev: the device to check
144 * 144 *
145 * If the user creates any virtual device on top of a batman-adv interface, it 145 * 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)
203} 203}
204 204
205/** 205/**
206 * batadv_get_real_netdevice - check if the given netdev struct is a virtual 206 * batadv_get_real_netdevice() - check if the given netdev struct is a virtual
207 * interface on top of another 'real' interface 207 * interface on top of another 'real' interface
208 * @netdev: the device to check 208 * @netdev: the device to check
209 * 209 *
@@ -247,7 +247,7 @@ out:
247} 247}
248 248
249/** 249/**
250 * batadv_get_real_netdev - check if the given net_device struct is a virtual 250 * batadv_get_real_netdev() - check if the given net_device struct is a virtual
251 * interface on top of another 'real' interface 251 * interface on top of another 'real' interface
252 * @net_device: the device to check 252 * @net_device: the device to check
253 * 253 *
@@ -266,7 +266,7 @@ struct net_device *batadv_get_real_netdev(struct net_device *net_device)
266} 266}
267 267
268/** 268/**
269 * batadv_is_wext_netdev - check if the given net_device struct is a 269 * batadv_is_wext_netdev() - check if the given net_device struct is a
270 * wext wifi interface 270 * wext wifi interface
271 * @net_device: the device to check 271 * @net_device: the device to check
272 * 272 *
@@ -290,7 +290,7 @@ static bool batadv_is_wext_netdev(struct net_device *net_device)
290} 290}
291 291
292/** 292/**
293 * batadv_is_cfg80211_netdev - check if the given net_device struct is a 293 * batadv_is_cfg80211_netdev() - check if the given net_device struct is a
294 * cfg80211 wifi interface 294 * cfg80211 wifi interface
295 * @net_device: the device to check 295 * @net_device: the device to check
296 * 296 *
@@ -310,7 +310,7 @@ static bool batadv_is_cfg80211_netdev(struct net_device *net_device)
310} 310}
311 311
312/** 312/**
313 * batadv_wifi_flags_evaluate - calculate wifi flags for net_device 313 * batadv_wifi_flags_evaluate() - calculate wifi flags for net_device
314 * @net_device: the device to check 314 * @net_device: the device to check
315 * 315 *
316 * Return: batadv_hard_iface_wifi_flags flags of the device 316 * Return: batadv_hard_iface_wifi_flags flags of the device
@@ -345,7 +345,7 @@ out:
345} 345}
346 346
347/** 347/**
348 * batadv_is_cfg80211_hardif - check if the given hardif is a cfg80211 wifi 348 * batadv_is_cfg80211_hardif() - check if the given hardif is a cfg80211 wifi
349 * interface 349 * interface
350 * @hard_iface: the device to check 350 * @hard_iface: the device to check
351 * 351 *
@@ -363,7 +363,7 @@ bool batadv_is_cfg80211_hardif(struct batadv_hard_iface *hard_iface)
363} 363}
364 364
365/** 365/**
366 * batadv_is_wifi_hardif - check if the given hardif is a wifi interface 366 * batadv_is_wifi_hardif() - check if the given hardif is a wifi interface
367 * @hard_iface: the device to check 367 * @hard_iface: the device to check
368 * 368 *
369 * Return: true if the net device is a 802.11 wireless device, false otherwise. 369 * 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)
377} 377}
378 378
379/** 379/**
380 * batadv_hardif_no_broadcast - check whether (re)broadcast is necessary 380 * batadv_hardif_no_broadcast() - check whether (re)broadcast is necessary
381 * @if_outgoing: the outgoing interface checked and considered for (re)broadcast 381 * @if_outgoing: the outgoing interface checked and considered for (re)broadcast
382 * @orig_addr: the originator of this packet 382 * @orig_addr: the originator of this packet
383 * @orig_neigh: originator address of the forwarder we just got the packet from 383 * @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)
668} 668}
669 669
670/** 670/**
671 * batadv_master_del_slave - remove hard_iface from the current master interface 671 * batadv_master_del_slave() - remove hard_iface from the current master iface
672 * @slave: the interface enslaved in another master 672 * @slave: the interface enslaved in another master
673 * @master: the master from which slave has to be removed 673 * @master: the master from which slave has to be removed
674 * 674 *
diff --git a/net/batman-adv/hard-interface.h b/net/batman-adv/hard-interface.h
index ac7311a91f9d..a7f9036f0e3a 100644
--- a/net/batman-adv/hard-interface.h
+++ b/net/batman-adv/hard-interface.h
@@ -83,7 +83,7 @@ int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing,
83 u8 *orig_addr, u8 *orig_neigh); 83 u8 *orig_addr, u8 *orig_neigh);
84 84
85/** 85/**
86 * batadv_hardif_put - decrement the hard interface refcounter and possibly 86 * batadv_hardif_put() - decrement the hard interface refcounter and possibly
87 * release it 87 * release it
88 * @hard_iface: the hard interface to free 88 * @hard_iface: the hard interface to free
89 */ 89 */
diff --git a/net/batman-adv/hash.h b/net/batman-adv/hash.h
index 81cf54eb2fad..c92fde593959 100644
--- a/net/batman-adv/hash.h
+++ b/net/batman-adv/hash.h
@@ -63,7 +63,7 @@ void batadv_hash_set_lock_class(struct batadv_hashtable *hash,
63void batadv_hash_destroy(struct batadv_hashtable *hash); 63void batadv_hash_destroy(struct batadv_hashtable *hash);
64 64
65/** 65/**
66 * batadv_hash_add - adds data to the hashtable 66 * batadv_hash_add() - adds data to the hashtable
67 * @hash: storage hash table 67 * @hash: storage hash table
68 * @compare: callback to determine if 2 hash elements are identical 68 * @compare: callback to determine if 2 hash elements are identical
69 * @choose: callback calculating the hash index 69 * @choose: callback calculating the hash index
diff --git a/net/batman-adv/icmp_socket.c b/net/batman-adv/icmp_socket.c
index 71ba58cc51fa..8af5d30e59b1 100644
--- a/net/batman-adv/icmp_socket.c
+++ b/net/batman-adv/icmp_socket.c
@@ -335,7 +335,7 @@ err:
335} 335}
336 336
337/** 337/**
338 * batadv_socket_add_packet - schedule an icmp packet to be sent to 338 * batadv_socket_add_packet() - schedule an icmp packet to be sent to
339 * userspace on an icmp socket. 339 * userspace on an icmp socket.
340 * @socket_client: the socket this packet belongs to 340 * @socket_client: the socket this packet belongs to
341 * @icmph: pointer to the header of the icmp packet 341 * @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,
392} 392}
393 393
394/** 394/**
395 * batadv_socket_receive_packet - schedule an icmp packet to be received 395 * batadv_socket_receive_packet() - schedule an icmp packet to be received
396 * locally and sent to userspace. 396 * locally and sent to userspace.
397 * @icmph: pointer to the header of the icmp packet 397 * @icmph: pointer to the header of the icmp packet
398 * @icmp_len: total length of the icmp packet 398 * @icmp_len: total length of the icmp packet
diff --git a/net/batman-adv/main.c b/net/batman-adv/main.c
index 6f6c500e8aa8..e6e1f5eae494 100644
--- a/net/batman-adv/main.c
+++ b/net/batman-adv/main.c
@@ -256,8 +256,8 @@ void batadv_mesh_free(struct net_device *soft_iface)
256} 256}
257 257
258/** 258/**
259 * batadv_is_my_mac - check if the given mac address belongs to any of the real 259 * batadv_is_my_mac() - check if the given mac address belongs to any of the
260 * interfaces in the current mesh 260 * real interfaces in the current mesh
261 * @bat_priv: the bat priv with all the soft interface information 261 * @bat_priv: the bat priv with all the soft interface information
262 * @addr: the address to check 262 * @addr: the address to check
263 * 263 *
@@ -287,7 +287,7 @@ bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr)
287 287
288#ifdef CONFIG_BATMAN_ADV_DEBUGFS 288#ifdef CONFIG_BATMAN_ADV_DEBUGFS
289/** 289/**
290 * batadv_seq_print_text_primary_if_get - called from debugfs table printing 290 * batadv_seq_print_text_primary_if_get() - called from debugfs table printing
291 * function that requires the primary interface 291 * function that requires the primary interface
292 * @seq: debugfs table seq_file struct 292 * @seq: debugfs table seq_file struct
293 * 293 *
@@ -324,7 +324,7 @@ out:
324#endif 324#endif
325 325
326/** 326/**
327 * batadv_max_header_len - calculate maximum encapsulation overhead for a 327 * batadv_max_header_len() - calculate maximum encapsulation overhead for a
328 * payload packet 328 * payload packet
329 * 329 *
330 * Return: the maximum encapsulation overhead in bytes. 330 * Return: the maximum encapsulation overhead in bytes.
@@ -349,7 +349,7 @@ int batadv_max_header_len(void)
349} 349}
350 350
351/** 351/**
352 * batadv_skb_set_priority - sets skb priority according to packet content 352 * batadv_skb_set_priority() - sets skb priority according to packet content
353 * @skb: the packet to be sent 353 * @skb: the packet to be sent
354 * @offset: offset to the packet content 354 * @offset: offset to the packet content
355 * 355 *
@@ -559,7 +559,7 @@ void batadv_recv_handler_unregister(u8 packet_type)
559} 559}
560 560
561/** 561/**
562 * batadv_skb_crc32 - calculate CRC32 of the whole packet and skip bytes in 562 * batadv_skb_crc32() - calculate CRC32 of the whole packet and skip bytes in
563 * the header 563 * the header
564 * @skb: skb pointing to fragmented socket buffers 564 * @skb: skb pointing to fragmented socket buffers
565 * @payload_ptr: Pointer to position inside the head buffer of the skb 565 * @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)
592} 592}
593 593
594/** 594/**
595 * batadv_get_vid - extract the VLAN identifier from skb if any 595 * batadv_get_vid() - extract the VLAN identifier from skb if any
596 * @skb: the buffer containing the packet 596 * @skb: the buffer containing the packet
597 * @header_len: length of the batman header preceding the ethernet header 597 * @header_len: length of the batman header preceding the ethernet header
598 * 598 *
@@ -619,7 +619,7 @@ unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len)
619} 619}
620 620
621/** 621/**
622 * batadv_vlan_ap_isola_get - return the AP isolation status for the given vlan 622 * batadv_vlan_ap_isola_get() - return AP isolation status for the given vlan
623 * @bat_priv: the bat priv with all the soft interface information 623 * @bat_priv: the bat priv with all the soft interface information
624 * @vid: the VLAN identifier for which the AP isolation attributed as to be 624 * @vid: the VLAN identifier for which the AP isolation attributed as to be
625 * looked up 625 * looked up
diff --git a/net/batman-adv/main.h b/net/batman-adv/main.h
index 4bdb39ab3b20..7f6a3123e1a4 100644
--- a/net/batman-adv/main.h
+++ b/net/batman-adv/main.h
@@ -203,7 +203,7 @@ struct seq_file;
203struct sk_buff; 203struct sk_buff;
204 204
205/** 205/**
206 * batadv_print_vid - return printable version of vid information 206 * batadv_print_vid() - return printable version of vid information
207 * @vid: the VLAN identifier 207 * @vid: the VLAN identifier
208 * 208 *
209 * Return: -1 when no VLAN is used, VLAN id otherwise 209 * Return: -1 when no VLAN is used, VLAN id otherwise
@@ -239,7 +239,7 @@ void batadv_recv_handler_unregister(u8 packet_type);
239__be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr); 239__be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
240 240
241/** 241/**
242 * batadv_compare_eth - Compare two not u16 aligned Ethernet addresses 242 * batadv_compare_eth() - Compare two not u16 aligned Ethernet addresses
243 * @data1: Pointer to a six-byte array containing the Ethernet address 243 * @data1: Pointer to a six-byte array containing the Ethernet address
244 * @data2: Pointer other six-byte array containing the Ethernet address 244 * @data2: Pointer other six-byte array containing the Ethernet address
245 * 245 *
@@ -253,7 +253,7 @@ static inline bool batadv_compare_eth(const void *data1, const void *data2)
253} 253}
254 254
255/** 255/**
256 * batadv_has_timed_out - compares current time (jiffies) and timestamp + 256 * batadv_has_timed_out() - compares current time (jiffies) and timestamp +
257 * timeout 257 * timeout
258 * @timestamp: base value to compare with (in jiffies) 258 * @timestamp: base value to compare with (in jiffies)
259 * @timeout: added to base value before comparing (in milliseconds) 259 * @timeout: added to base value before comparing (in milliseconds)
diff --git a/net/batman-adv/multicast.c b/net/batman-adv/multicast.c
index d8617c2794db..8a503c526b90 100644
--- a/net/batman-adv/multicast.c
+++ b/net/batman-adv/multicast.c
@@ -66,7 +66,7 @@
66static void batadv_mcast_mla_update(struct work_struct *work); 66static void batadv_mcast_mla_update(struct work_struct *work);
67 67
68/** 68/**
69 * batadv_mcast_start_timer - schedule the multicast periodic worker 69 * batadv_mcast_start_timer() - schedule the multicast periodic worker
70 * @bat_priv: the bat priv with all the soft interface information 70 * @bat_priv: the bat priv with all the soft interface information
71 */ 71 */
72static void batadv_mcast_start_timer(struct batadv_priv *bat_priv) 72static 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)
76} 76}
77 77
78/** 78/**
79 * batadv_mcast_get_bridge - get the bridge on top of the softif if it exists 79 * batadv_mcast_get_bridge() - get the bridge on top of the softif if it exists
80 * @soft_iface: netdev struct of the mesh interface 80 * @soft_iface: netdev struct of the mesh interface
81 * 81 *
82 * If the given soft interface has a bridge on top then the refcount 82 * 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)
102} 102}
103 103
104/** 104/**
105 * batadv_mcast_mla_softif_get - get softif multicast listeners 105 * batadv_mcast_mla_softif_get() - get softif multicast listeners
106 * @dev: the device to collect multicast addresses from 106 * @dev: the device to collect multicast addresses from
107 * @mcast_list: a list to put found addresses into 107 * @mcast_list: a list to put found addresses into
108 * 108 *
@@ -148,7 +148,7 @@ static int batadv_mcast_mla_softif_get(struct net_device *dev,
148} 148}
149 149
150/** 150/**
151 * batadv_mcast_mla_is_duplicate - check whether an address is in a list 151 * batadv_mcast_mla_is_duplicate() - check whether an address is in a list
152 * @mcast_addr: the multicast address to check 152 * @mcast_addr: the multicast address to check
153 * @mcast_list: the list with multicast addresses to search in 153 * @mcast_list: the list with multicast addresses to search in
154 * 154 *
@@ -168,7 +168,7 @@ static bool batadv_mcast_mla_is_duplicate(u8 *mcast_addr,
168} 168}
169 169
170/** 170/**
171 * batadv_mcast_mla_br_addr_cpy - copy a bridge multicast address 171 * batadv_mcast_mla_br_addr_cpy() - copy a bridge multicast address
172 * @dst: destination to write to - a multicast MAC address 172 * @dst: destination to write to - a multicast MAC address
173 * @src: source to read from - a multicast IP address 173 * @src: source to read from - a multicast IP address
174 * 174 *
@@ -192,7 +192,7 @@ static void batadv_mcast_mla_br_addr_cpy(char *dst, const struct br_ip *src)
192} 192}
193 193
194/** 194/**
195 * batadv_mcast_mla_bridge_get - get bridged-in multicast listeners 195 * batadv_mcast_mla_bridge_get() - get bridged-in multicast listeners
196 * @dev: a bridge slave whose bridge to collect multicast addresses from 196 * @dev: a bridge slave whose bridge to collect multicast addresses from
197 * @mcast_list: a list to put found addresses into 197 * @mcast_list: a list to put found addresses into
198 * 198 *
@@ -245,7 +245,7 @@ out:
245} 245}
246 246
247/** 247/**
248 * batadv_mcast_mla_list_free - free a list of multicast addresses 248 * batadv_mcast_mla_list_free() - free a list of multicast addresses
249 * @mcast_list: the list to free 249 * @mcast_list: the list to free
250 * 250 *
251 * Removes and frees all items in the given mcast_list. 251 * 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)
262} 262}
263 263
264/** 264/**
265 * batadv_mcast_mla_tt_retract - clean up multicast listener announcements 265 * batadv_mcast_mla_tt_retract() - clean up multicast listener announcements
266 * @bat_priv: the bat priv with all the soft interface information 266 * @bat_priv: the bat priv with all the soft interface information
267 * @mcast_list: a list of addresses which should _not_ be removed 267 * @mcast_list: a list of addresses which should _not_ be removed
268 * 268 *
@@ -298,7 +298,7 @@ static void batadv_mcast_mla_tt_retract(struct batadv_priv *bat_priv,
298} 298}
299 299
300/** 300/**
301 * batadv_mcast_mla_tt_add - add multicast listener announcements 301 * batadv_mcast_mla_tt_add() - add multicast listener announcements
302 * @bat_priv: the bat priv with all the soft interface information 302 * @bat_priv: the bat priv with all the soft interface information
303 * @mcast_list: a list of addresses which are going to get added 303 * @mcast_list: a list of addresses which are going to get added
304 * 304 *
@@ -334,7 +334,7 @@ static void batadv_mcast_mla_tt_add(struct batadv_priv *bat_priv,
334} 334}
335 335
336/** 336/**
337 * batadv_mcast_has_bridge - check whether the soft-iface is bridged 337 * batadv_mcast_has_bridge() - check whether the soft-iface is bridged
338 * @bat_priv: the bat priv with all the soft interface information 338 * @bat_priv: the bat priv with all the soft interface information
339 * 339 *
340 * Checks whether there is a bridge on top of our soft interface. 340 * 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)
355} 355}
356 356
357/** 357/**
358 * batadv_mcast_querier_log - debug output regarding the querier status on link 358 * batadv_mcast_querier_log() - debug output regarding the querier status on
359 * link
359 * @bat_priv: the bat priv with all the soft interface information 360 * @bat_priv: the bat priv with all the soft interface information
360 * @str_proto: a string for the querier protocol (e.g. "IGMP" or "MLD") 361 * @str_proto: a string for the querier protocol (e.g. "IGMP" or "MLD")
361 * @old_state: the previous querier state on our link 362 * @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,
406} 407}
407 408
408/** 409/**
409 * batadv_mcast_bridge_log - debug output for topology changes in bridged setups 410 * batadv_mcast_bridge_log() - debug output for topology changes in bridged
411 * setups
410 * @bat_priv: the bat priv with all the soft interface information 412 * @bat_priv: the bat priv with all the soft interface information
411 * @bridged: a flag about whether the soft interface is currently bridged or not 413 * @bridged: a flag about whether the soft interface is currently bridged or not
412 * @querier_ipv4: (maybe) new status of a potential, selected IGMP querier 414 * @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,
445} 447}
446 448
447/** 449/**
448 * batadv_mcast_flags_logs - output debug information about mcast flag changes 450 * batadv_mcast_flags_logs() - output debug information about mcast flag changes
449 * @bat_priv: the bat priv with all the soft interface information 451 * @bat_priv: the bat priv with all the soft interface information
450 * @flags: flags indicating the new multicast state 452 * @flags: flags indicating the new multicast state
451 * 453 *
@@ -471,7 +473,7 @@ static void batadv_mcast_flags_log(struct batadv_priv *bat_priv, u8 flags)
471} 473}
472 474
473/** 475/**
474 * batadv_mcast_mla_tvlv_update - update multicast tvlv 476 * batadv_mcast_mla_tvlv_update() - update multicast tvlv
475 * @bat_priv: the bat priv with all the soft interface information 477 * @bat_priv: the bat priv with all the soft interface information
476 * 478 *
477 * Updates the own multicast tvlv with our current multicast related settings, 479 * Updates the own multicast tvlv with our current multicast related settings,
@@ -546,7 +548,7 @@ update:
546} 548}
547 549
548/** 550/**
549 * __batadv_mcast_mla_update - update the own MLAs 551 * __batadv_mcast_mla_update() - update the own MLAs
550 * @bat_priv: the bat priv with all the soft interface information 552 * @bat_priv: the bat priv with all the soft interface information
551 * 553 *
552 * Updates the own multicast listener announcements in the translation 554 * Updates the own multicast listener announcements in the translation
@@ -583,7 +585,7 @@ out:
583} 585}
584 586
585/** 587/**
586 * batadv_mcast_mla_update - update the own MLAs 588 * batadv_mcast_mla_update() - update the own MLAs
587 * @work: kernel work struct 589 * @work: kernel work struct
588 * 590 *
589 * Updates the own multicast listener announcements in the translation 591 * Updates the own multicast listener announcements in the translation
@@ -606,7 +608,7 @@ static void batadv_mcast_mla_update(struct work_struct *work)
606} 608}
607 609
608/** 610/**
609 * batadv_mcast_is_report_ipv4 - check for IGMP reports 611 * batadv_mcast_is_report_ipv4() - check for IGMP reports
610 * @skb: the ethernet frame destined for the mesh 612 * @skb: the ethernet frame destined for the mesh
611 * 613 *
612 * This call might reallocate skb data. 614 * This call might reallocate skb data.
@@ -631,7 +633,8 @@ static bool batadv_mcast_is_report_ipv4(struct sk_buff *skb)
631} 633}
632 634
633/** 635/**
634 * batadv_mcast_forw_mode_check_ipv4 - check for optimized forwarding potential 636 * batadv_mcast_forw_mode_check_ipv4() - check for optimized forwarding
637 * potential
635 * @bat_priv: the bat priv with all the soft interface information 638 * @bat_priv: the bat priv with all the soft interface information
636 * @skb: the IPv4 packet to check 639 * @skb: the IPv4 packet to check
637 * @is_unsnoopable: stores whether the destination is snoopable 640 * @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,
672} 675}
673 676
674/** 677/**
675 * batadv_mcast_is_report_ipv6 - check for MLD reports 678 * batadv_mcast_is_report_ipv6() - check for MLD reports
676 * @skb: the ethernet frame destined for the mesh 679 * @skb: the ethernet frame destined for the mesh
677 * 680 *
678 * This call might reallocate skb data. 681 * This call might reallocate skb data.
@@ -696,7 +699,8 @@ static bool batadv_mcast_is_report_ipv6(struct sk_buff *skb)
696} 699}
697 700
698/** 701/**
699 * batadv_mcast_forw_mode_check_ipv6 - check for optimized forwarding potential 702 * batadv_mcast_forw_mode_check_ipv6() - check for optimized forwarding
703 * potential
700 * @bat_priv: the bat priv with all the soft interface information 704 * @bat_priv: the bat priv with all the soft interface information
701 * @skb: the IPv6 packet to check 705 * @skb: the IPv6 packet to check
702 * @is_unsnoopable: stores whether the destination is snoopable 706 * @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,
737} 741}
738 742
739/** 743/**
740 * batadv_mcast_forw_mode_check - check for optimized forwarding potential 744 * batadv_mcast_forw_mode_check() - check for optimized forwarding potential
741 * @bat_priv: the bat priv with all the soft interface information 745 * @bat_priv: the bat priv with all the soft interface information
742 * @skb: the multicast frame to check 746 * @skb: the multicast frame to check
743 * @is_unsnoopable: stores whether the destination is snoopable 747 * @is_unsnoopable: stores whether the destination is snoopable
@@ -775,7 +779,7 @@ static int batadv_mcast_forw_mode_check(struct batadv_priv *bat_priv,
775} 779}
776 780
777/** 781/**
778 * batadv_mcast_forw_want_all_ip_count - count nodes with unspecific mcast 782 * batadv_mcast_forw_want_all_ip_count() - count nodes with unspecific mcast
779 * interest 783 * interest
780 * @bat_priv: the bat priv with all the soft interface information 784 * @bat_priv: the bat priv with all the soft interface information
781 * @ethhdr: ethernet header of a packet 785 * @ethhdr: ethernet header of a packet
@@ -799,7 +803,7 @@ static int batadv_mcast_forw_want_all_ip_count(struct batadv_priv *bat_priv,
799} 803}
800 804
801/** 805/**
802 * batadv_mcast_forw_tt_node_get - get a multicast tt node 806 * batadv_mcast_forw_tt_node_get() - get a multicast tt node
803 * @bat_priv: the bat priv with all the soft interface information 807 * @bat_priv: the bat priv with all the soft interface information
804 * @ethhdr: the ether header containing the multicast destination 808 * @ethhdr: the ether header containing the multicast destination
805 * 809 *
@@ -815,7 +819,7 @@ batadv_mcast_forw_tt_node_get(struct batadv_priv *bat_priv,
815} 819}
816 820
817/** 821/**
818 * batadv_mcast_forw_ipv4_node_get - get a node with an ipv4 flag 822 * batadv_mcast_forw_ipv4_node_get() - get a node with an ipv4 flag
819 * @bat_priv: the bat priv with all the soft interface information 823 * @bat_priv: the bat priv with all the soft interface information
820 * 824 *
821 * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 flag set and 825 * 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)
842} 846}
843 847
844/** 848/**
845 * batadv_mcast_forw_ipv6_node_get - get a node with an ipv6 flag 849 * batadv_mcast_forw_ipv6_node_get() - get a node with an ipv6 flag
846 * @bat_priv: the bat priv with all the soft interface information 850 * @bat_priv: the bat priv with all the soft interface information
847 * 851 *
848 * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV6 flag set 852 * 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)
869} 873}
870 874
871/** 875/**
872 * batadv_mcast_forw_ip_node_get - get a node with an ipv4/ipv6 flag 876 * batadv_mcast_forw_ip_node_get() - get a node with an ipv4/ipv6 flag
873 * @bat_priv: the bat priv with all the soft interface information 877 * @bat_priv: the bat priv with all the soft interface information
874 * @ethhdr: an ethernet header to determine the protocol family from 878 * @ethhdr: an ethernet header to determine the protocol family from
875 * 879 *
@@ -893,7 +897,7 @@ batadv_mcast_forw_ip_node_get(struct batadv_priv *bat_priv,
893} 897}
894 898
895/** 899/**
896 * batadv_mcast_forw_unsnoop_node_get - get a node with an unsnoopable flag 900 * batadv_mcast_forw_unsnoop_node_get() - get a node with an unsnoopable flag
897 * @bat_priv: the bat priv with all the soft interface information 901 * @bat_priv: the bat priv with all the soft interface information
898 * 902 *
899 * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_UNSNOOPABLES flag 903 * 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)
920} 924}
921 925
922/** 926/**
923 * batadv_mcast_forw_mode - check on how to forward a multicast packet 927 * batadv_mcast_forw_mode() - check on how to forward a multicast packet
924 * @bat_priv: the bat priv with all the soft interface information 928 * @bat_priv: the bat priv with all the soft interface information
925 * @skb: The multicast packet to check 929 * @skb: The multicast packet to check
926 * @orig: an originator to be set to forward the skb to 930 * @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,
974} 978}
975 979
976/** 980/**
977 * batadv_mcast_want_unsnoop_update - update unsnoop counter and list 981 * batadv_mcast_want_unsnoop_update() - update unsnoop counter and list
978 * @bat_priv: the bat priv with all the soft interface information 982 * @bat_priv: the bat priv with all the soft interface information
979 * @orig: the orig_node which multicast state might have changed of 983 * @orig: the orig_node which multicast state might have changed of
980 * @mcast_flags: flags indicating the new multicast state 984 * @mcast_flags: flags indicating the new multicast state
@@ -1019,7 +1023,7 @@ static void batadv_mcast_want_unsnoop_update(struct batadv_priv *bat_priv,
1019} 1023}
1020 1024
1021/** 1025/**
1022 * batadv_mcast_want_ipv4_update - update want-all-ipv4 counter and list 1026 * batadv_mcast_want_ipv4_update() - update want-all-ipv4 counter and list
1023 * @bat_priv: the bat priv with all the soft interface information 1027 * @bat_priv: the bat priv with all the soft interface information
1024 * @orig: the orig_node which multicast state might have changed of 1028 * @orig: the orig_node which multicast state might have changed of
1025 * @mcast_flags: flags indicating the new multicast state 1029 * @mcast_flags: flags indicating the new multicast state
@@ -1064,7 +1068,7 @@ static void batadv_mcast_want_ipv4_update(struct batadv_priv *bat_priv,
1064} 1068}
1065 1069
1066/** 1070/**
1067 * batadv_mcast_want_ipv6_update - update want-all-ipv6 counter and list 1071 * batadv_mcast_want_ipv6_update() - update want-all-ipv6 counter and list
1068 * @bat_priv: the bat priv with all the soft interface information 1072 * @bat_priv: the bat priv with all the soft interface information
1069 * @orig: the orig_node which multicast state might have changed of 1073 * @orig: the orig_node which multicast state might have changed of
1070 * @mcast_flags: flags indicating the new multicast state 1074 * @mcast_flags: flags indicating the new multicast state
@@ -1109,7 +1113,7 @@ static void batadv_mcast_want_ipv6_update(struct batadv_priv *bat_priv,
1109} 1113}
1110 1114
1111/** 1115/**
1112 * batadv_mcast_tvlv_ogm_handler - process incoming multicast tvlv container 1116 * batadv_mcast_tvlv_ogm_handler() - process incoming multicast tvlv container
1113 * @bat_priv: the bat priv with all the soft interface information 1117 * @bat_priv: the bat priv with all the soft interface information
1114 * @orig: the orig_node of the ogm 1118 * @orig: the orig_node of the ogm
1115 * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) 1119 * @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,
1165} 1169}
1166 1170
1167/** 1171/**
1168 * batadv_mcast_init - initialize the multicast optimizations structures 1172 * batadv_mcast_init() - initialize the multicast optimizations structures
1169 * @bat_priv: the bat priv with all the soft interface information 1173 * @bat_priv: the bat priv with all the soft interface information
1170 */ 1174 */
1171void batadv_mcast_init(struct batadv_priv *bat_priv) 1175void batadv_mcast_init(struct batadv_priv *bat_priv)
@@ -1180,7 +1184,7 @@ void batadv_mcast_init(struct batadv_priv *bat_priv)
1180 1184
1181#ifdef CONFIG_BATMAN_ADV_DEBUGFS 1185#ifdef CONFIG_BATMAN_ADV_DEBUGFS
1182/** 1186/**
1183 * batadv_mcast_flags_print_header - print own mcast flags to debugfs table 1187 * batadv_mcast_flags_print_header() - print own mcast flags to debugfs table
1184 * @bat_priv: the bat priv with all the soft interface information 1188 * @bat_priv: the bat priv with all the soft interface information
1185 * @seq: debugfs table seq_file struct 1189 * @seq: debugfs table seq_file struct
1186 * 1190 *
@@ -1221,7 +1225,7 @@ static void batadv_mcast_flags_print_header(struct batadv_priv *bat_priv,
1221} 1225}
1222 1226
1223/** 1227/**
1224 * batadv_mcast_flags_seq_print_text - print the mcast flags of other nodes 1228 * batadv_mcast_flags_seq_print_text() - print the mcast flags of other nodes
1225 * @seq: seq file to print on 1229 * @seq: seq file to print on
1226 * @offset: not used 1230 * @offset: not used
1227 * 1231 *
@@ -1282,7 +1286,7 @@ int batadv_mcast_flags_seq_print_text(struct seq_file *seq, void *offset)
1282#endif 1286#endif
1283 1287
1284/** 1288/**
1285 * batadv_mcast_free - free the multicast optimizations structures 1289 * batadv_mcast_free() - free the multicast optimizations structures
1286 * @bat_priv: the bat priv with all the soft interface information 1290 * @bat_priv: the bat priv with all the soft interface information
1287 */ 1291 */
1288void batadv_mcast_free(struct batadv_priv *bat_priv) 1292void batadv_mcast_free(struct batadv_priv *bat_priv)
@@ -1297,7 +1301,7 @@ void batadv_mcast_free(struct batadv_priv *bat_priv)
1297} 1301}
1298 1302
1299/** 1303/**
1300 * batadv_mcast_purge_orig - reset originator global mcast state modifications 1304 * batadv_mcast_purge_orig() - reset originator global mcast state modifications
1301 * @orig: the originator which is going to get purged 1305 * @orig: the originator which is going to get purged
1302 */ 1306 */
1303void batadv_mcast_purge_orig(struct batadv_orig_node *orig) 1307void batadv_mcast_purge_orig(struct batadv_orig_node *orig)
diff --git a/net/batman-adv/netlink.c b/net/batman-adv/netlink.c
index f7281685633c..103d4bdcdbdb 100644
--- a/net/batman-adv/netlink.c
+++ b/net/batman-adv/netlink.c
@@ -100,7 +100,7 @@ static const struct nla_policy batadv_netlink_policy[NUM_BATADV_ATTR] = {
100}; 100};
101 101
102/** 102/**
103 * batadv_netlink_get_ifindex - Extract an interface index from a message 103 * batadv_netlink_get_ifindex() - Extract an interface index from a message
104 * @nlh: Message header 104 * @nlh: Message header
105 * @attrtype: Attribute which holds an interface index 105 * @attrtype: Attribute which holds an interface index
106 * 106 *
@@ -115,7 +115,7 @@ batadv_netlink_get_ifindex(const struct nlmsghdr *nlh, int attrtype)
115} 115}
116 116
117/** 117/**
118 * batadv_netlink_mesh_info_put - fill in generic information about mesh 118 * batadv_netlink_mesh_info_put() - fill in generic information about mesh
119 * interface 119 * interface
120 * @msg: netlink message to be sent back 120 * @msg: netlink message to be sent back
121 * @soft_iface: interface for which the data should be taken 121 * @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)
170} 170}
171 171
172/** 172/**
173 * batadv_netlink_get_mesh_info - handle incoming BATADV_CMD_GET_MESH_INFO 173 * batadv_netlink_get_mesh_info() - handle incoming BATADV_CMD_GET_MESH_INFO
174 * netlink request 174 * netlink request
175 * @skb: received netlink message 175 * @skb: received netlink message
176 * @info: receiver information 176 * @info: receiver information
@@ -231,7 +231,7 @@ batadv_netlink_get_mesh_info(struct sk_buff *skb, struct genl_info *info)
231} 231}
232 232
233/** 233/**
234 * batadv_netlink_tp_meter_put - Fill information of started tp_meter session 234 * batadv_netlink_tp_meter_put() - Fill information of started tp_meter session
235 * @msg: netlink message to be sent back 235 * @msg: netlink message to be sent back
236 * @cookie: tp meter session cookie 236 * @cookie: tp meter session cookie
237 * 237 *
@@ -247,7 +247,7 @@ batadv_netlink_tp_meter_put(struct sk_buff *msg, u32 cookie)
247} 247}
248 248
249/** 249/**
250 * batadv_netlink_tpmeter_notify - send tp_meter result via netlink to client 250 * batadv_netlink_tpmeter_notify() - send tp_meter result via netlink to client
251 * @bat_priv: the bat priv with all the soft interface information 251 * @bat_priv: the bat priv with all the soft interface information
252 * @dst: destination of tp_meter session 252 * @dst: destination of tp_meter session
253 * @result: reason for tp meter session stop 253 * @result: reason for tp meter session stop
@@ -310,7 +310,7 @@ err_genlmsg:
310} 310}
311 311
312/** 312/**
313 * batadv_netlink_tp_meter_start - Start a new tp_meter session 313 * batadv_netlink_tp_meter_start() - Start a new tp_meter session
314 * @skb: received netlink message 314 * @skb: received netlink message
315 * @info: receiver information 315 * @info: receiver information
316 * 316 *
@@ -387,7 +387,7 @@ batadv_netlink_tp_meter_start(struct sk_buff *skb, struct genl_info *info)
387} 387}
388 388
389/** 389/**
390 * batadv_netlink_tp_meter_start - Cancel a running tp_meter session 390 * batadv_netlink_tp_meter_start() - Cancel a running tp_meter session
391 * @skb: received netlink message 391 * @skb: received netlink message
392 * @info: receiver information 392 * @info: receiver information
393 * 393 *
@@ -432,7 +432,7 @@ out:
432} 432}
433 433
434/** 434/**
435 * batadv_netlink_dump_hardif_entry - Dump one hard interface into a message 435 * batadv_netlink_dump_hardif_entry() - Dump one hard interface into a message
436 * @msg: Netlink message to dump into 436 * @msg: Netlink message to dump into
437 * @portid: Port making netlink request 437 * @portid: Port making netlink request
438 * @seq: Sequence number of netlink message 438 * @seq: Sequence number of netlink message
@@ -474,7 +474,7 @@ batadv_netlink_dump_hardif_entry(struct sk_buff *msg, u32 portid, u32 seq,
474} 474}
475 475
476/** 476/**
477 * batadv_netlink_dump_hardifs - Dump all hard interface into a messages 477 * batadv_netlink_dump_hardifs() - Dump all hard interface into a messages
478 * @msg: Netlink message to dump into 478 * @msg: Netlink message to dump into
479 * @cb: Parameters from query 479 * @cb: Parameters from query
480 * 480 *
@@ -621,7 +621,7 @@ struct genl_family batadv_netlink_family __ro_after_init = {
621}; 621};
622 622
623/** 623/**
624 * batadv_netlink_register - register batadv genl netlink family 624 * batadv_netlink_register() - register batadv genl netlink family
625 */ 625 */
626void __init batadv_netlink_register(void) 626void __init batadv_netlink_register(void)
627{ 627{
@@ -633,7 +633,7 @@ void __init batadv_netlink_register(void)
633} 633}
634 634
635/** 635/**
636 * batadv_netlink_unregister - unregister batadv genl netlink family 636 * batadv_netlink_unregister() - unregister batadv genl netlink family
637 */ 637 */
638void batadv_netlink_unregister(void) 638void batadv_netlink_unregister(void)
639{ 639{
diff --git a/net/batman-adv/network-coding.c b/net/batman-adv/network-coding.c
index bd421408d9e7..3758be7fd881 100644
--- a/net/batman-adv/network-coding.c
+++ b/net/batman-adv/network-coding.c
@@ -67,7 +67,7 @@ static int batadv_nc_recv_coded_packet(struct sk_buff *skb,
67 struct batadv_hard_iface *recv_if); 67 struct batadv_hard_iface *recv_if);
68 68
69/** 69/**
70 * batadv_nc_init - one-time initialization for network coding 70 * batadv_nc_init() - one-time initialization for network coding
71 * 71 *
72 * Return: 0 on success or negative error number in case of failure 72 * Return: 0 on success or negative error number in case of failure
73 */ 73 */
@@ -83,7 +83,7 @@ int __init batadv_nc_init(void)
83} 83}
84 84
85/** 85/**
86 * batadv_nc_start_timer - initialise the nc periodic worker 86 * batadv_nc_start_timer() - initialise the nc periodic worker
87 * @bat_priv: the bat priv with all the soft interface information 87 * @bat_priv: the bat priv with all the soft interface information
88 */ 88 */
89static void batadv_nc_start_timer(struct batadv_priv *bat_priv) 89static 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)
93} 93}
94 94
95/** 95/**
96 * batadv_nc_tvlv_container_update - update the network coding tvlv container 96 * batadv_nc_tvlv_container_update() - update the network coding tvlv container
97 * after network coding setting change 97 * after network coding setting change
98 * @bat_priv: the bat priv with all the soft interface information 98 * @bat_priv: the bat priv with all the soft interface information
99 */ 99 */
@@ -115,7 +115,7 @@ static void batadv_nc_tvlv_container_update(struct batadv_priv *bat_priv)
115} 115}
116 116
117/** 117/**
118 * batadv_nc_status_update - update the network coding tvlv container after 118 * batadv_nc_status_update() - update the network coding tvlv container after
119 * network coding setting change 119 * network coding setting change
120 * @net_dev: the soft interface net device 120 * @net_dev: the soft interface net device
121 */ 121 */
@@ -127,7 +127,7 @@ void batadv_nc_status_update(struct net_device *net_dev)
127} 127}
128 128
129/** 129/**
130 * batadv_nc_tvlv_ogm_handler_v1 - process incoming nc tvlv container 130 * batadv_nc_tvlv_ogm_handler_v1() - process incoming nc tvlv container
131 * @bat_priv: the bat priv with all the soft interface information 131 * @bat_priv: the bat priv with all the soft interface information
132 * @orig: the orig_node of the ogm 132 * @orig: the orig_node of the ogm
133 * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) 133 * @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,
146} 146}
147 147
148/** 148/**
149 * batadv_nc_mesh_init - initialise coding hash table and start house keeping 149 * batadv_nc_mesh_init() - initialise coding hash table and start house keeping
150 * @bat_priv: the bat priv with all the soft interface information 150 * @bat_priv: the bat priv with all the soft interface information
151 * 151 *
152 * Return: 0 on success or negative error number in case of failure 152 * Return: 0 on success or negative error number in case of failure
@@ -187,7 +187,7 @@ err:
187} 187}
188 188
189/** 189/**
190 * batadv_nc_init_bat_priv - initialise the nc specific bat_priv variables 190 * batadv_nc_init_bat_priv() - initialise the nc specific bat_priv variables
191 * @bat_priv: the bat priv with all the soft interface information 191 * @bat_priv: the bat priv with all the soft interface information
192 */ 192 */
193void batadv_nc_init_bat_priv(struct batadv_priv *bat_priv) 193void 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)
199} 199}
200 200
201/** 201/**
202 * batadv_nc_init_orig - initialise the nc fields of an orig_node 202 * batadv_nc_init_orig() - initialise the nc fields of an orig_node
203 * @orig_node: the orig_node which is going to be initialised 203 * @orig_node: the orig_node which is going to be initialised
204 */ 204 */
205void batadv_nc_init_orig(struct batadv_orig_node *orig_node) 205void 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)
211} 211}
212 212
213/** 213/**
214 * batadv_nc_node_release - release nc_node from lists and queue for free after 214 * batadv_nc_node_release() - release nc_node from lists and queue for free
215 * rcu grace period 215 * after rcu grace period
216 * @ref: kref pointer of the nc_node 216 * @ref: kref pointer of the nc_node
217 */ 217 */
218static void batadv_nc_node_release(struct kref *ref) 218static void batadv_nc_node_release(struct kref *ref)
@@ -226,7 +226,7 @@ static void batadv_nc_node_release(struct kref *ref)
226} 226}
227 227
228/** 228/**
229 * batadv_nc_node_put - decrement the nc_node refcounter and possibly 229 * batadv_nc_node_put() - decrement the nc_node refcounter and possibly
230 * release it 230 * release it
231 * @nc_node: nc_node to be free'd 231 * @nc_node: nc_node to be free'd
232 */ 232 */
@@ -236,8 +236,8 @@ static void batadv_nc_node_put(struct batadv_nc_node *nc_node)
236} 236}
237 237
238/** 238/**
239 * batadv_nc_path_release - release nc_path from lists and queue for free after 239 * batadv_nc_path_release() - release nc_path from lists and queue for free
240 * rcu grace period 240 * after rcu grace period
241 * @ref: kref pointer of the nc_path 241 * @ref: kref pointer of the nc_path
242 */ 242 */
243static void batadv_nc_path_release(struct kref *ref) 243static void batadv_nc_path_release(struct kref *ref)
@@ -250,7 +250,7 @@ static void batadv_nc_path_release(struct kref *ref)
250} 250}
251 251
252/** 252/**
253 * batadv_nc_path_put - decrement the nc_path refcounter and possibly 253 * batadv_nc_path_put() - decrement the nc_path refcounter and possibly
254 * release it 254 * release it
255 * @nc_path: nc_path to be free'd 255 * @nc_path: nc_path to be free'd
256 */ 256 */
@@ -260,7 +260,7 @@ static void batadv_nc_path_put(struct batadv_nc_path *nc_path)
260} 260}
261 261
262/** 262/**
263 * batadv_nc_packet_free - frees nc packet 263 * batadv_nc_packet_free() - frees nc packet
264 * @nc_packet: the nc packet to free 264 * @nc_packet: the nc packet to free
265 * @dropped: whether the packet is freed because is is dropped 265 * @dropped: whether the packet is freed because is is dropped
266 */ 266 */
@@ -277,7 +277,7 @@ static void batadv_nc_packet_free(struct batadv_nc_packet *nc_packet,
277} 277}
278 278
279/** 279/**
280 * batadv_nc_to_purge_nc_node - checks whether an nc node has to be purged 280 * batadv_nc_to_purge_nc_node() - checks whether an nc node has to be purged
281 * @bat_priv: the bat priv with all the soft interface information 281 * @bat_priv: the bat priv with all the soft interface information
282 * @nc_node: the nc node to check 282 * @nc_node: the nc node to check
283 * 283 *
@@ -293,7 +293,7 @@ static bool batadv_nc_to_purge_nc_node(struct batadv_priv *bat_priv,
293} 293}
294 294
295/** 295/**
296 * batadv_nc_to_purge_nc_path_coding - checks whether an nc path has timed out 296 * batadv_nc_to_purge_nc_path_coding() - checks whether an nc path has timed out
297 * @bat_priv: the bat priv with all the soft interface information 297 * @bat_priv: the bat priv with all the soft interface information
298 * @nc_path: the nc path to check 298 * @nc_path: the nc path to check
299 * 299 *
@@ -313,7 +313,8 @@ static bool batadv_nc_to_purge_nc_path_coding(struct batadv_priv *bat_priv,
313} 313}
314 314
315/** 315/**
316 * batadv_nc_to_purge_nc_path_decoding - checks whether an nc path has timed out 316 * batadv_nc_to_purge_nc_path_decoding() - checks whether an nc path has timed
317 * out
317 * @bat_priv: the bat priv with all the soft interface information 318 * @bat_priv: the bat priv with all the soft interface information
318 * @nc_path: the nc path to check 319 * @nc_path: the nc path to check
319 * 320 *
@@ -333,7 +334,7 @@ static bool batadv_nc_to_purge_nc_path_decoding(struct batadv_priv *bat_priv,
333} 334}
334 335
335/** 336/**
336 * batadv_nc_purge_orig_nc_nodes - go through list of nc nodes and purge stale 337 * batadv_nc_purge_orig_nc_nodes() - go through list of nc nodes and purge stale
337 * entries 338 * entries
338 * @bat_priv: the bat priv with all the soft interface information 339 * @bat_priv: the bat priv with all the soft interface information
339 * @list: list of nc nodes 340 * @list: list of nc nodes
@@ -371,7 +372,7 @@ batadv_nc_purge_orig_nc_nodes(struct batadv_priv *bat_priv,
371} 372}
372 373
373/** 374/**
374 * batadv_nc_purge_orig - purges all nc node data attached of the given 375 * batadv_nc_purge_orig() - purges all nc node data attached of the given
375 * originator 376 * originator
376 * @bat_priv: the bat priv with all the soft interface information 377 * @bat_priv: the bat priv with all the soft interface information
377 * @orig_node: orig_node with the nc node entries to be purged 378 * @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,
397} 398}
398 399
399/** 400/**
400 * batadv_nc_purge_orig_hash - traverse entire originator hash to check if they 401 * batadv_nc_purge_orig_hash() - traverse entire originator hash to check if
401 * have timed out nc nodes 402 * they have timed out nc nodes
402 * @bat_priv: the bat priv with all the soft interface information 403 * @bat_priv: the bat priv with all the soft interface information
403 */ 404 */
404static void batadv_nc_purge_orig_hash(struct batadv_priv *bat_priv) 405static 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)
424} 425}
425 426
426/** 427/**
427 * batadv_nc_purge_paths - traverse all nc paths part of the hash and remove 428 * batadv_nc_purge_paths() - traverse all nc paths part of the hash and remove
428 * unused ones 429 * unused ones
429 * @bat_priv: the bat priv with all the soft interface information 430 * @bat_priv: the bat priv with all the soft interface information
430 * @hash: hash table containing the nc paths to check 431 * @hash: hash table containing the nc paths to check
@@ -483,7 +484,7 @@ static void batadv_nc_purge_paths(struct batadv_priv *bat_priv,
483} 484}
484 485
485/** 486/**
486 * batadv_nc_hash_key_gen - computes the nc_path hash key 487 * batadv_nc_hash_key_gen() - computes the nc_path hash key
487 * @key: buffer to hold the final hash key 488 * @key: buffer to hold the final hash key
488 * @src: source ethernet mac address going into the hash key 489 * @src: source ethernet mac address going into the hash key
489 * @dst: destination ethernet mac address going into the hash key 490 * @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,
496} 497}
497 498
498/** 499/**
499 * batadv_nc_hash_choose - compute the hash value for an nc path 500 * batadv_nc_hash_choose() - compute the hash value for an nc path
500 * @data: data to hash 501 * @data: data to hash
501 * @size: size of the hash table 502 * @size: size of the hash table
502 * 503 *
@@ -514,7 +515,7 @@ static u32 batadv_nc_hash_choose(const void *data, u32 size)
514} 515}
515 516
516/** 517/**
517 * batadv_nc_hash_compare - comparing function used in the network coding hash 518 * batadv_nc_hash_compare() - comparing function used in the network coding hash
518 * tables 519 * tables
519 * @node: node in the local table 520 * @node: node in the local table
520 * @data2: second object to compare the node to 521 * @data2: second object to compare the node to
@@ -540,7 +541,7 @@ static bool batadv_nc_hash_compare(const struct hlist_node *node,
540} 541}
541 542
542/** 543/**
543 * batadv_nc_hash_find - search for an existing nc path and return it 544 * batadv_nc_hash_find() - search for an existing nc path and return it
544 * @hash: hash table containing the nc path 545 * @hash: hash table containing the nc path
545 * @data: search key 546 * @data: search key
546 * 547 *
@@ -577,7 +578,7 @@ batadv_nc_hash_find(struct batadv_hashtable *hash,
577} 578}
578 579
579/** 580/**
580 * batadv_nc_send_packet - send non-coded packet and free nc_packet struct 581 * batadv_nc_send_packet() - send non-coded packet and free nc_packet struct
581 * @nc_packet: the nc packet to send 582 * @nc_packet: the nc packet to send
582 */ 583 */
583static void batadv_nc_send_packet(struct batadv_nc_packet *nc_packet) 584static 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)
588} 589}
589 590
590/** 591/**
591 * batadv_nc_sniffed_purge - Checks timestamp of given sniffed nc_packet. 592 * batadv_nc_sniffed_purge() - Checks timestamp of given sniffed nc_packet.
592 * @bat_priv: the bat priv with all the soft interface information 593 * @bat_priv: the bat priv with all the soft interface information
593 * @nc_path: the nc path the packet belongs to 594 * @nc_path: the nc path the packet belongs to
594 * @nc_packet: the nc packet to be checked 595 * @nc_packet: the nc packet to be checked
@@ -627,7 +628,7 @@ out:
627} 628}
628 629
629/** 630/**
630 * batadv_nc_fwd_flush - Checks the timestamp of the given nc packet. 631 * batadv_nc_fwd_flush() - Checks the timestamp of the given nc packet.
631 * @bat_priv: the bat priv with all the soft interface information 632 * @bat_priv: the bat priv with all the soft interface information
632 * @nc_path: the nc path the packet belongs to 633 * @nc_path: the nc path the packet belongs to
633 * @nc_packet: the nc packet to be checked 634 * @nc_packet: the nc packet to be checked
@@ -665,8 +666,8 @@ static bool batadv_nc_fwd_flush(struct batadv_priv *bat_priv,
665} 666}
666 667
667/** 668/**
668 * batadv_nc_process_nc_paths - traverse given nc packet pool and free timed out 669 * batadv_nc_process_nc_paths() - traverse given nc packet pool and free timed
669 * nc packets 670 * out nc packets
670 * @bat_priv: the bat priv with all the soft interface information 671 * @bat_priv: the bat priv with all the soft interface information
671 * @hash: to be processed hash table 672 * @hash: to be processed hash table
672 * @process_fn: Function called to process given nc packet. Should return true 673 * @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,
711} 712}
712 713
713/** 714/**
714 * batadv_nc_worker - periodic task for house keeping related to network coding 715 * batadv_nc_worker() - periodic task for house keeping related to network
716 * coding
715 * @work: kernel work struct 717 * @work: kernel work struct
716 */ 718 */
717static void batadv_nc_worker(struct work_struct *work) 719static void batadv_nc_worker(struct work_struct *work)
@@ -751,8 +753,8 @@ static void batadv_nc_worker(struct work_struct *work)
751} 753}
752 754
753/** 755/**
754 * batadv_can_nc_with_orig - checks whether the given orig node is suitable for 756 * batadv_can_nc_with_orig() - checks whether the given orig node is suitable
755 * coding or not 757 * for coding or not
756 * @bat_priv: the bat priv with all the soft interface information 758 * @bat_priv: the bat priv with all the soft interface information
757 * @orig_node: neighboring orig node which may be used as nc candidate 759 * @orig_node: neighboring orig node which may be used as nc candidate
758 * @ogm_packet: incoming ogm packet also used for the checks 760 * @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,
792} 794}
793 795
794/** 796/**
795 * batadv_nc_find_nc_node - search for an existing nc node and return it 797 * batadv_nc_find_nc_node() - search for an existing nc node and return it
796 * @orig_node: orig node originating the ogm packet 798 * @orig_node: orig node originating the ogm packet
797 * @orig_neigh_node: neighboring orig node from which we received the ogm packet 799 * @orig_neigh_node: neighboring orig node from which we received the ogm packet
798 * (can be equal to orig_node) 800 * (can be equal to orig_node)
@@ -832,7 +834,7 @@ batadv_nc_find_nc_node(struct batadv_orig_node *orig_node,
832} 834}
833 835
834/** 836/**
835 * batadv_nc_get_nc_node - retrieves an nc node or creates the entry if it was 837 * batadv_nc_get_nc_node() - retrieves an nc node or creates the entry if it was
836 * not found 838 * not found
837 * @bat_priv: the bat priv with all the soft interface information 839 * @bat_priv: the bat priv with all the soft interface information
838 * @orig_node: orig node originating the ogm packet 840 * @orig_node: orig node originating the ogm packet
@@ -892,7 +894,7 @@ batadv_nc_get_nc_node(struct batadv_priv *bat_priv,
892} 894}
893 895
894/** 896/**
895 * batadv_nc_update_nc_node - updates stored incoming and outgoing nc node 897 * batadv_nc_update_nc_node() - updates stored incoming and outgoing nc node
896 * structs (best called on incoming OGMs) 898 * structs (best called on incoming OGMs)
897 * @bat_priv: the bat priv with all the soft interface information 899 * @bat_priv: the bat priv with all the soft interface information
898 * @orig_node: orig node originating the ogm packet 900 * @orig_node: orig node originating the ogm packet
@@ -947,7 +949,7 @@ out:
947} 949}
948 950
949/** 951/**
950 * batadv_nc_get_path - get existing nc_path or allocate a new one 952 * batadv_nc_get_path() - get existing nc_path or allocate a new one
951 * @bat_priv: the bat priv with all the soft interface information 953 * @bat_priv: the bat priv with all the soft interface information
952 * @hash: hash table containing the nc path 954 * @hash: hash table containing the nc path
953 * @src: ethernet source address - first half of the nc path search key 955 * @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,
1008} 1010}
1009 1011
1010/** 1012/**
1011 * batadv_nc_random_weight_tq - scale the receivers TQ-value to avoid unfair 1013 * batadv_nc_random_weight_tq() - scale the receivers TQ-value to avoid unfair
1012 * selection of a receiver with slightly lower TQ than the other 1014 * selection of a receiver with slightly lower TQ than the other
1013 * @tq: to be weighted tq value 1015 * @tq: to be weighted tq value
1014 * 1016 *
@@ -1031,7 +1033,7 @@ static u8 batadv_nc_random_weight_tq(u8 tq)
1031} 1033}
1032 1034
1033/** 1035/**
1034 * batadv_nc_memxor - XOR destination with source 1036 * batadv_nc_memxor() - XOR destination with source
1035 * @dst: byte array to XOR into 1037 * @dst: byte array to XOR into
1036 * @src: byte array to XOR from 1038 * @src: byte array to XOR from
1037 * @len: length of destination array 1039 * @len: length of destination array
@@ -1045,7 +1047,7 @@ static void batadv_nc_memxor(char *dst, const char *src, unsigned int len)
1045} 1047}
1046 1048
1047/** 1049/**
1048 * batadv_nc_code_packets - code a received unicast_packet with an nc packet 1050 * batadv_nc_code_packets() - code a received unicast_packet with an nc packet
1049 * into a coded_packet and send it 1051 * into a coded_packet and send it
1050 * @bat_priv: the bat priv with all the soft interface information 1052 * @bat_priv: the bat priv with all the soft interface information
1051 * @skb: data skb to forward 1053 * @skb: data skb to forward
@@ -1238,7 +1240,7 @@ out:
1238} 1240}
1239 1241
1240/** 1242/**
1241 * batadv_nc_skb_coding_possible - true if a decoded skb is available at dst. 1243 * batadv_nc_skb_coding_possible() - true if a decoded skb is available at dst.
1242 * @skb: data skb to forward 1244 * @skb: data skb to forward
1243 * @dst: destination mac address of the other skb to code with 1245 * @dst: destination mac address of the other skb to code with
1244 * @src: source mac address of skb 1246 * @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)
1262} 1264}
1263 1265
1264/** 1266/**
1265 * batadv_nc_path_search - Find the coding path matching in_nc_node and 1267 * batadv_nc_path_search() - Find the coding path matching in_nc_node and
1266 * out_nc_node to retrieve a buffered packet that can be used for coding. 1268 * out_nc_node to retrieve a buffered packet that can be used for coding.
1267 * @bat_priv: the bat priv with all the soft interface information 1269 * @bat_priv: the bat priv with all the soft interface information
1268 * @in_nc_node: pointer to skb next hop's neighbor nc node 1270 * @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,
1330} 1332}
1331 1333
1332/** 1334/**
1333 * batadv_nc_skb_src_search - Loops through the list of neighoring nodes of the 1335 * batadv_nc_skb_src_search() - Loops through the list of neighoring nodes of
1334 * skb's sender (may be equal to the originator). 1336 * the skb's sender (may be equal to the originator).
1335 * @bat_priv: the bat priv with all the soft interface information 1337 * @bat_priv: the bat priv with all the soft interface information
1336 * @skb: data skb to forward 1338 * @skb: data skb to forward
1337 * @eth_dst: next hop mac address of skb 1339 * @eth_dst: next hop mac address of skb
@@ -1376,7 +1378,7 @@ batadv_nc_skb_src_search(struct batadv_priv *bat_priv,
1376} 1378}
1377 1379
1378/** 1380/**
1379 * batadv_nc_skb_store_before_coding - set the ethernet src and dst of the 1381 * batadv_nc_skb_store_before_coding() - set the ethernet src and dst of the
1380 * unicast skb before it is stored for use in later decoding 1382 * unicast skb before it is stored for use in later decoding
1381 * @bat_priv: the bat priv with all the soft interface information 1383 * @bat_priv: the bat priv with all the soft interface information
1382 * @skb: data skb to store 1384 * @skb: data skb to store
@@ -1411,7 +1413,7 @@ static void batadv_nc_skb_store_before_coding(struct batadv_priv *bat_priv,
1411} 1413}
1412 1414
1413/** 1415/**
1414 * batadv_nc_skb_dst_search - Loops through list of neighboring nodes to dst. 1416 * batadv_nc_skb_dst_search() - Loops through list of neighboring nodes to dst.
1415 * @skb: data skb to forward 1417 * @skb: data skb to forward
1416 * @neigh_node: next hop to forward packet to 1418 * @neigh_node: next hop to forward packet to
1417 * @ethhdr: pointer to the ethernet header inside the skb 1419 * @ethhdr: pointer to the ethernet header inside the skb
@@ -1469,7 +1471,7 @@ static bool batadv_nc_skb_dst_search(struct sk_buff *skb,
1469} 1471}
1470 1472
1471/** 1473/**
1472 * batadv_nc_skb_add_to_path - buffer skb for later encoding / decoding 1474 * batadv_nc_skb_add_to_path() - buffer skb for later encoding / decoding
1473 * @skb: skb to add to path 1475 * @skb: skb to add to path
1474 * @nc_path: path to add skb to 1476 * @nc_path: path to add skb to
1475 * @neigh_node: next hop to forward packet to 1477 * @neigh_node: next hop to forward packet to
@@ -1504,7 +1506,7 @@ static bool batadv_nc_skb_add_to_path(struct sk_buff *skb,
1504} 1506}
1505 1507
1506/** 1508/**
1507 * batadv_nc_skb_forward - try to code a packet or add it to the coding packet 1509 * batadv_nc_skb_forward() - try to code a packet or add it to the coding packet
1508 * buffer 1510 * buffer
1509 * @skb: data skb to forward 1511 * @skb: data skb to forward
1510 * @neigh_node: next hop to forward packet to 1512 * @neigh_node: next hop to forward packet to
@@ -1561,8 +1563,8 @@ out:
1561} 1563}
1562 1564
1563/** 1565/**
1564 * batadv_nc_skb_store_for_decoding - save a clone of the skb which can be used 1566 * batadv_nc_skb_store_for_decoding() - save a clone of the skb which can be
1565 * when decoding coded packets 1567 * used when decoding coded packets
1566 * @bat_priv: the bat priv with all the soft interface information 1568 * @bat_priv: the bat priv with all the soft interface information
1567 * @skb: data skb to store 1569 * @skb: data skb to store
1568 */ 1570 */
@@ -1622,7 +1624,7 @@ out:
1622} 1624}
1623 1625
1624/** 1626/**
1625 * batadv_nc_skb_store_sniffed_unicast - check if a received unicast packet 1627 * batadv_nc_skb_store_sniffed_unicast() - check if a received unicast packet
1626 * should be saved in the decoding buffer and, if so, store it there 1628 * should be saved in the decoding buffer and, if so, store it there
1627 * @bat_priv: the bat priv with all the soft interface information 1629 * @bat_priv: the bat priv with all the soft interface information
1628 * @skb: unicast skb to store 1630 * @skb: unicast skb to store
@@ -1642,7 +1644,7 @@ void batadv_nc_skb_store_sniffed_unicast(struct batadv_priv *bat_priv,
1642} 1644}
1643 1645
1644/** 1646/**
1645 * batadv_nc_skb_decode_packet - decode given skb using the decode data stored 1647 * batadv_nc_skb_decode_packet() - decode given skb using the decode data stored
1646 * in nc_packet 1648 * in nc_packet
1647 * @bat_priv: the bat priv with all the soft interface information 1649 * @bat_priv: the bat priv with all the soft interface information
1648 * @skb: unicast skb to decode 1650 * @skb: unicast skb to decode
@@ -1736,7 +1738,7 @@ batadv_nc_skb_decode_packet(struct batadv_priv *bat_priv, struct sk_buff *skb,
1736} 1738}
1737 1739
1738/** 1740/**
1739 * batadv_nc_find_decoding_packet - search through buffered decoding data to 1741 * batadv_nc_find_decoding_packet() - search through buffered decoding data to
1740 * find the data needed to decode the coded packet 1742 * find the data needed to decode the coded packet
1741 * @bat_priv: the bat priv with all the soft interface information 1743 * @bat_priv: the bat priv with all the soft interface information
1742 * @ethhdr: pointer to the ethernet header inside the coded packet 1744 * @ethhdr: pointer to the ethernet header inside the coded packet
@@ -1801,7 +1803,7 @@ batadv_nc_find_decoding_packet(struct batadv_priv *bat_priv,
1801} 1803}
1802 1804
1803/** 1805/**
1804 * batadv_nc_recv_coded_packet - try to decode coded packet and enqueue the 1806 * batadv_nc_recv_coded_packet() - try to decode coded packet and enqueue the
1805 * resulting unicast packet 1807 * resulting unicast packet
1806 * @skb: incoming coded packet 1808 * @skb: incoming coded packet
1807 * @recv_if: pointer to interface this packet was received on 1809 * @recv_if: pointer to interface this packet was received on
@@ -1876,7 +1878,7 @@ free_skb:
1876} 1878}
1877 1879
1878/** 1880/**
1879 * batadv_nc_mesh_free - clean up network coding memory 1881 * batadv_nc_mesh_free() - clean up network coding memory
1880 * @bat_priv: the bat priv with all the soft interface information 1882 * @bat_priv: the bat priv with all the soft interface information
1881 */ 1883 */
1882void batadv_nc_mesh_free(struct batadv_priv *bat_priv) 1884void batadv_nc_mesh_free(struct batadv_priv *bat_priv)
@@ -1893,7 +1895,7 @@ void batadv_nc_mesh_free(struct batadv_priv *bat_priv)
1893 1895
1894#ifdef CONFIG_BATMAN_ADV_DEBUGFS 1896#ifdef CONFIG_BATMAN_ADV_DEBUGFS
1895/** 1897/**
1896 * batadv_nc_nodes_seq_print_text - print the nc node information 1898 * batadv_nc_nodes_seq_print_text() - print the nc node information
1897 * @seq: seq file to print on 1899 * @seq: seq file to print on
1898 * @offset: not used 1900 * @offset: not used
1899 * 1901 *
@@ -1956,7 +1958,7 @@ out:
1956} 1958}
1957 1959
1958/** 1960/**
1959 * batadv_nc_init_debugfs - create nc folder and related files in debugfs 1961 * batadv_nc_init_debugfs() - create nc folder and related files in debugfs
1960 * @bat_priv: the bat priv with all the soft interface information 1962 * @bat_priv: the bat priv with all the soft interface information
1961 * 1963 *
1962 * Return: 0 on success or negative error number in case of failure 1964 * Return: 0 on success or negative error number in case of failure
diff --git a/net/batman-adv/originator.c b/net/batman-adv/originator.c
index 007b6bd8df95..412a603b2fda 100644
--- a/net/batman-adv/originator.c
+++ b/net/batman-adv/originator.c
@@ -91,7 +91,7 @@ batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data)
91static void batadv_purge_orig(struct work_struct *work); 91static void batadv_purge_orig(struct work_struct *work);
92 92
93/** 93/**
94 * batadv_compare_orig - comparing function used in the originator hash table 94 * batadv_compare_orig() - comparing function used in the originator hash table
95 * @node: node in the local table 95 * @node: node in the local table
96 * @data2: second object to compare the node to 96 * @data2: second object to compare the node to
97 * 97 *
@@ -106,7 +106,7 @@ bool batadv_compare_orig(const struct hlist_node *node, const void *data2)
106} 106}
107 107
108/** 108/**
109 * batadv_orig_node_vlan_get - get an orig_node_vlan object 109 * batadv_orig_node_vlan_get() - get an orig_node_vlan object
110 * @orig_node: the originator serving the VLAN 110 * @orig_node: the originator serving the VLAN
111 * @vid: the VLAN identifier 111 * @vid: the VLAN identifier
112 * 112 *
@@ -137,7 +137,7 @@ batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
137} 137}
138 138
139/** 139/**
140 * batadv_orig_node_vlan_new - search and possibly create an orig_node_vlan 140 * batadv_orig_node_vlan_new() - search and possibly create an orig_node_vlan
141 * object 141 * object
142 * @orig_node: the originator serving the VLAN 142 * @orig_node: the originator serving the VLAN
143 * @vid: the VLAN identifier 143 * @vid: the VLAN identifier
@@ -178,7 +178,7 @@ out:
178} 178}
179 179
180/** 180/**
181 * batadv_orig_node_vlan_release - release originator-vlan object from lists 181 * batadv_orig_node_vlan_release() - release originator-vlan object from lists
182 * and queue for free after rcu grace period 182 * and queue for free after rcu grace period
183 * @ref: kref pointer of the originator-vlan object 183 * @ref: kref pointer of the originator-vlan object
184 */ 184 */
@@ -192,7 +192,7 @@ static void batadv_orig_node_vlan_release(struct kref *ref)
192} 192}
193 193
194/** 194/**
195 * batadv_orig_node_vlan_put - decrement the refcounter and possibly release 195 * batadv_orig_node_vlan_put() - decrement the refcounter and possibly release
196 * the originator-vlan object 196 * the originator-vlan object
197 * @orig_vlan: the originator-vlan object to release 197 * @orig_vlan: the originator-vlan object to release
198 */ 198 */
@@ -226,7 +226,7 @@ err:
226} 226}
227 227
228/** 228/**
229 * batadv_neigh_ifinfo_release - release neigh_ifinfo from lists and queue for 229 * batadv_neigh_ifinfo_release() - release neigh_ifinfo from lists and queue for
230 * free after rcu grace period 230 * free after rcu grace period
231 * @ref: kref pointer of the neigh_ifinfo 231 * @ref: kref pointer of the neigh_ifinfo
232 */ 232 */
@@ -243,7 +243,7 @@ static void batadv_neigh_ifinfo_release(struct kref *ref)
243} 243}
244 244
245/** 245/**
246 * batadv_neigh_ifinfo_put - decrement the refcounter and possibly release 246 * batadv_neigh_ifinfo_put() - decrement the refcounter and possibly release
247 * the neigh_ifinfo 247 * the neigh_ifinfo
248 * @neigh_ifinfo: the neigh_ifinfo object to release 248 * @neigh_ifinfo: the neigh_ifinfo object to release
249 */ 249 */
@@ -253,7 +253,7 @@ void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo)
253} 253}
254 254
255/** 255/**
256 * batadv_hardif_neigh_release - release hardif neigh node from lists and 256 * batadv_hardif_neigh_release() - release hardif neigh node from lists and
257 * queue for free after rcu grace period 257 * queue for free after rcu grace period
258 * @ref: kref pointer of the neigh_node 258 * @ref: kref pointer of the neigh_node
259 */ 259 */
@@ -273,7 +273,7 @@ static void batadv_hardif_neigh_release(struct kref *ref)
273} 273}
274 274
275/** 275/**
276 * batadv_hardif_neigh_put - decrement the hardif neighbors refcounter 276 * batadv_hardif_neigh_put() - decrement the hardif neighbors refcounter
277 * and possibly release it 277 * and possibly release it
278 * @hardif_neigh: hardif neigh neighbor to free 278 * @hardif_neigh: hardif neigh neighbor to free
279 */ 279 */
@@ -283,7 +283,7 @@ void batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh)
283} 283}
284 284
285/** 285/**
286 * batadv_neigh_node_release - release neigh_node from lists and queue for 286 * batadv_neigh_node_release() - release neigh_node from lists and queue for
287 * free after rcu grace period 287 * free after rcu grace period
288 * @ref: kref pointer of the neigh_node 288 * @ref: kref pointer of the neigh_node
289 */ 289 */
@@ -308,7 +308,7 @@ static void batadv_neigh_node_release(struct kref *ref)
308} 308}
309 309
310/** 310/**
311 * batadv_neigh_node_put - decrement the neighbors refcounter and possibly 311 * batadv_neigh_node_put() - decrement the neighbors refcounter and possibly
312 * release it 312 * release it
313 * @neigh_node: neigh neighbor to free 313 * @neigh_node: neigh neighbor to free
314 */ 314 */
@@ -318,7 +318,7 @@ void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node)
318} 318}
319 319
320/** 320/**
321 * batadv_orig_router_get - router to the originator depending on iface 321 * batadv_orig_router_get() - router to the originator depending on iface
322 * @orig_node: the orig node for the router 322 * @orig_node: the orig node for the router
323 * @if_outgoing: the interface where the payload packet has been received or 323 * @if_outgoing: the interface where the payload packet has been received or
324 * the OGM should be sent to 324 * the OGM should be sent to
@@ -351,7 +351,7 @@ batadv_orig_router_get(struct batadv_orig_node *orig_node,
351} 351}
352 352
353/** 353/**
354 * batadv_orig_ifinfo_get - find the ifinfo from an orig_node 354 * batadv_orig_ifinfo_get() - find the ifinfo from an orig_node
355 * @orig_node: the orig node to be queried 355 * @orig_node: the orig node to be queried
356 * @if_outgoing: the interface for which the ifinfo should be acquired 356 * @if_outgoing: the interface for which the ifinfo should be acquired
357 * 357 *
@@ -383,7 +383,7 @@ batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
383} 383}
384 384
385/** 385/**
386 * batadv_orig_ifinfo_new - search and possibly create an orig_ifinfo object 386 * batadv_orig_ifinfo_new() - search and possibly create an orig_ifinfo object
387 * @orig_node: the orig node to be queried 387 * @orig_node: the orig node to be queried
388 * @if_outgoing: the interface for which the ifinfo should be acquired 388 * @if_outgoing: the interface for which the ifinfo should be acquired
389 * 389 *
@@ -429,7 +429,7 @@ out:
429} 429}
430 430
431/** 431/**
432 * batadv_neigh_ifinfo_get - find the ifinfo from an neigh_node 432 * batadv_neigh_ifinfo_get() - find the ifinfo from an neigh_node
433 * @neigh: the neigh node to be queried 433 * @neigh: the neigh node to be queried
434 * @if_outgoing: the interface for which the ifinfo should be acquired 434 * @if_outgoing: the interface for which the ifinfo should be acquired
435 * 435 *
@@ -462,7 +462,7 @@ batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
462} 462}
463 463
464/** 464/**
465 * batadv_neigh_ifinfo_new - search and possibly create an neigh_ifinfo object 465 * batadv_neigh_ifinfo_new() - search and possibly create an neigh_ifinfo object
466 * @neigh: the neigh node to be queried 466 * @neigh: the neigh node to be queried
467 * @if_outgoing: the interface for which the ifinfo should be acquired 467 * @if_outgoing: the interface for which the ifinfo should be acquired
468 * 468 *
@@ -505,7 +505,7 @@ out:
505} 505}
506 506
507/** 507/**
508 * batadv_neigh_node_get - retrieve a neighbour from the list 508 * batadv_neigh_node_get() - retrieve a neighbour from the list
509 * @orig_node: originator which the neighbour belongs to 509 * @orig_node: originator which the neighbour belongs to
510 * @hard_iface: the interface where this neighbour is connected to 510 * @hard_iface: the interface where this neighbour is connected to
511 * @addr: the address of the neighbour 511 * @addr: the address of the neighbour
@@ -542,7 +542,7 @@ batadv_neigh_node_get(const struct batadv_orig_node *orig_node,
542} 542}
543 543
544/** 544/**
545 * batadv_hardif_neigh_create - create a hardif neighbour node 545 * batadv_hardif_neigh_create() - create a hardif neighbour node
546 * @hard_iface: the interface this neighbour is connected to 546 * @hard_iface: the interface this neighbour is connected to
547 * @neigh_addr: the interface address of the neighbour to retrieve 547 * @neigh_addr: the interface address of the neighbour to retrieve
548 * @orig_node: originator object representing the neighbour 548 * @orig_node: originator object representing the neighbour
@@ -588,7 +588,7 @@ out:
588} 588}
589 589
590/** 590/**
591 * batadv_hardif_neigh_get_or_create - retrieve or create a hardif neighbour 591 * batadv_hardif_neigh_get_or_create() - retrieve or create a hardif neighbour
592 * node 592 * node
593 * @hard_iface: the interface this neighbour is connected to 593 * @hard_iface: the interface this neighbour is connected to
594 * @neigh_addr: the interface address of the neighbour to retrieve 594 * @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,
612} 612}
613 613
614/** 614/**
615 * batadv_hardif_neigh_get - retrieve a hardif neighbour from the list 615 * batadv_hardif_neigh_get() - retrieve a hardif neighbour from the list
616 * @hard_iface: the interface where this neighbour is connected to 616 * @hard_iface: the interface where this neighbour is connected to
617 * @neigh_addr: the address of the neighbour 617 * @neigh_addr: the address of the neighbour
618 * 618 *
@@ -644,7 +644,7 @@ batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
644} 644}
645 645
646/** 646/**
647 * batadv_neigh_node_create - create a neigh node object 647 * batadv_neigh_node_create() - create a neigh node object
648 * @orig_node: originator object representing the neighbour 648 * @orig_node: originator object representing the neighbour
649 * @hard_iface: the interface where the neighbour is connected to 649 * @hard_iface: the interface where the neighbour is connected to
650 * @neigh_addr: the mac address of the neighbour interface 650 * @neigh_addr: the mac address of the neighbour interface
@@ -709,7 +709,7 @@ out:
709} 709}
710 710
711/** 711/**
712 * batadv_neigh_node_get_or_create - retrieve or create a neigh node object 712 * batadv_neigh_node_get_or_create() - retrieve or create a neigh node object
713 * @orig_node: originator object representing the neighbour 713 * @orig_node: originator object representing the neighbour
714 * @hard_iface: the interface where the neighbour is connected to 714 * @hard_iface: the interface where the neighbour is connected to
715 * @neigh_addr: the mac address of the neighbour interface 715 * @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,
733 733
734#ifdef CONFIG_BATMAN_ADV_DEBUGFS 734#ifdef CONFIG_BATMAN_ADV_DEBUGFS
735/** 735/**
736 * batadv_hardif_neigh_seq_print_text - print the single hop neighbour list 736 * batadv_hardif_neigh_seq_print_text() - print the single hop neighbour list
737 * @seq: neighbour table seq_file struct 737 * @seq: neighbour table seq_file struct
738 * @offset: not used 738 * @offset: not used
739 * 739 *
@@ -768,8 +768,8 @@ int batadv_hardif_neigh_seq_print_text(struct seq_file *seq, void *offset)
768#endif 768#endif
769 769
770/** 770/**
771 * batadv_hardif_neigh_dump - Dump to netlink the neighbor infos for a specific 771 * batadv_hardif_neigh_dump() - Dump to netlink the neighbor infos for a
772 * outgoing interface 772 * specific outgoing interface
773 * @msg: message to dump into 773 * @msg: message to dump into
774 * @cb: parameters for the dump 774 * @cb: parameters for the dump
775 * 775 *
@@ -845,7 +845,7 @@ int batadv_hardif_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb)
845} 845}
846 846
847/** 847/**
848 * batadv_orig_ifinfo_release - release orig_ifinfo from lists and queue for 848 * batadv_orig_ifinfo_release() - release orig_ifinfo from lists and queue for
849 * free after rcu grace period 849 * free after rcu grace period
850 * @ref: kref pointer of the orig_ifinfo 850 * @ref: kref pointer of the orig_ifinfo
851 */ 851 */
@@ -868,7 +868,7 @@ static void batadv_orig_ifinfo_release(struct kref *ref)
868} 868}
869 869
870/** 870/**
871 * batadv_orig_ifinfo_put - decrement the refcounter and possibly release 871 * batadv_orig_ifinfo_put() - decrement the refcounter and possibly release
872 * the orig_ifinfo 872 * the orig_ifinfo
873 * @orig_ifinfo: the orig_ifinfo object to release 873 * @orig_ifinfo: the orig_ifinfo object to release
874 */ 874 */
@@ -878,7 +878,7 @@ void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo)
878} 878}
879 879
880/** 880/**
881 * batadv_orig_node_free_rcu - free the orig_node 881 * batadv_orig_node_free_rcu() - free the orig_node
882 * @rcu: rcu pointer of the orig_node 882 * @rcu: rcu pointer of the orig_node
883 */ 883 */
884static void batadv_orig_node_free_rcu(struct rcu_head *rcu) 884static 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)
899} 899}
900 900
901/** 901/**
902 * batadv_orig_node_release - release orig_node from lists and queue for 902 * batadv_orig_node_release() - release orig_node from lists and queue for
903 * free after rcu grace period 903 * free after rcu grace period
904 * @ref: kref pointer of the orig_node 904 * @ref: kref pointer of the orig_node
905 */ 905 */
@@ -950,7 +950,7 @@ static void batadv_orig_node_release(struct kref *ref)
950} 950}
951 951
952/** 952/**
953 * batadv_orig_node_put - decrement the orig node refcounter and possibly 953 * batadv_orig_node_put() - decrement the orig node refcounter and possibly
954 * release it 954 * release it
955 * @orig_node: the orig node to free 955 * @orig_node: the orig node to free
956 */ 956 */
@@ -992,7 +992,7 @@ void batadv_originator_free(struct batadv_priv *bat_priv)
992} 992}
993 993
994/** 994/**
995 * batadv_orig_node_new - creates a new orig_node 995 * batadv_orig_node_new() - creates a new orig_node
996 * @bat_priv: the bat priv with all the soft interface information 996 * @bat_priv: the bat priv with all the soft interface information
997 * @addr: the mac address of the originator 997 * @addr: the mac address of the originator
998 * 998 *
@@ -1071,7 +1071,7 @@ free_orig_node:
1071} 1071}
1072 1072
1073/** 1073/**
1074 * batadv_purge_neigh_ifinfo - purge obsolete ifinfo entries from neighbor 1074 * batadv_purge_neigh_ifinfo() - purge obsolete ifinfo entries from neighbor
1075 * @bat_priv: the bat priv with all the soft interface information 1075 * @bat_priv: the bat priv with all the soft interface information
1076 * @neigh: orig node which is to be checked 1076 * @neigh: orig node which is to be checked
1077 */ 1077 */
@@ -1112,7 +1112,7 @@ batadv_purge_neigh_ifinfo(struct batadv_priv *bat_priv,
1112} 1112}
1113 1113
1114/** 1114/**
1115 * batadv_purge_orig_ifinfo - purge obsolete ifinfo entries from originator 1115 * batadv_purge_orig_ifinfo() - purge obsolete ifinfo entries from originator
1116 * @bat_priv: the bat priv with all the soft interface information 1116 * @bat_priv: the bat priv with all the soft interface information
1117 * @orig_node: orig node which is to be checked 1117 * @orig_node: orig node which is to be checked
1118 * 1118 *
@@ -1164,7 +1164,7 @@ batadv_purge_orig_ifinfo(struct batadv_priv *bat_priv,
1164} 1164}
1165 1165
1166/** 1166/**
1167 * batadv_purge_orig_neighbors - purges neighbors from originator 1167 * batadv_purge_orig_neighbors() - purges neighbors from originator
1168 * @bat_priv: the bat priv with all the soft interface information 1168 * @bat_priv: the bat priv with all the soft interface information
1169 * @orig_node: orig node which is to be checked 1169 * @orig_node: orig node which is to be checked
1170 * 1170 *
@@ -1222,7 +1222,7 @@ batadv_purge_orig_neighbors(struct batadv_priv *bat_priv,
1222} 1222}
1223 1223
1224/** 1224/**
1225 * batadv_find_best_neighbor - finds the best neighbor after purging 1225 * batadv_find_best_neighbor() - finds the best neighbor after purging
1226 * @bat_priv: the bat priv with all the soft interface information 1226 * @bat_priv: the bat priv with all the soft interface information
1227 * @orig_node: orig node which is to be checked 1227 * @orig_node: orig node which is to be checked
1228 * @if_outgoing: the interface for which the metric should be compared 1228 * @if_outgoing: the interface for which the metric should be compared
@@ -1257,7 +1257,7 @@ batadv_find_best_neighbor(struct batadv_priv *bat_priv,
1257} 1257}
1258 1258
1259/** 1259/**
1260 * batadv_purge_orig_node - purges obsolete information from an orig_node 1260 * batadv_purge_orig_node() - purges obsolete information from an orig_node
1261 * @bat_priv: the bat priv with all the soft interface information 1261 * @bat_priv: the bat priv with all the soft interface information
1262 * @orig_node: orig node which is to be checked 1262 * @orig_node: orig node which is to be checked
1263 * 1263 *
@@ -1409,7 +1409,7 @@ int batadv_orig_seq_print_text(struct seq_file *seq, void *offset)
1409} 1409}
1410 1410
1411/** 1411/**
1412 * batadv_orig_hardif_seq_print_text - writes originator infos for a specific 1412 * batadv_orig_hardif_seq_print_text() - writes originator infos for a specific
1413 * outgoing interface 1413 * outgoing interface
1414 * @seq: debugfs table seq_file struct 1414 * @seq: debugfs table seq_file struct
1415 * @offset: not used 1415 * @offset: not used
@@ -1456,7 +1456,7 @@ out:
1456#endif 1456#endif
1457 1457
1458/** 1458/**
1459 * batadv_orig_dump - Dump to netlink the originator infos for a specific 1459 * batadv_orig_dump() - Dump to netlink the originator infos for a specific
1460 * outgoing interface 1460 * outgoing interface
1461 * @msg: message to dump into 1461 * @msg: message to dump into
1462 * @cb: parameters for the dump 1462 * @cb: parameters for the dump
diff --git a/net/batman-adv/routing.c b/net/batman-adv/routing.c
index 86b0ea1e5c1c..01820be4ae5a 100644
--- a/net/batman-adv/routing.c
+++ b/net/batman-adv/routing.c
@@ -55,7 +55,7 @@ static int batadv_route_unicast_packet(struct sk_buff *skb,
55 struct batadv_hard_iface *recv_if); 55 struct batadv_hard_iface *recv_if);
56 56
57/** 57/**
58 * _batadv_update_route - set the router for this originator 58 * _batadv_update_route() - set the router for this originator
59 * @bat_priv: the bat priv with all the soft interface information 59 * @bat_priv: the bat priv with all the soft interface information
60 * @orig_node: orig node which is to be configured 60 * @orig_node: orig node which is to be configured
61 * @recv_if: the receive interface for which this route is set 61 * @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,
119} 119}
120 120
121/** 121/**
122 * batadv_update_route - set the router for this originator 122 * batadv_update_route() - set the router for this originator
123 * @bat_priv: the bat priv with all the soft interface information 123 * @bat_priv: the bat priv with all the soft interface information
124 * @orig_node: orig node which is to be configured 124 * @orig_node: orig node which is to be configured
125 * @recv_if: the receive interface for which this route is set 125 * @recv_if: the receive interface for which this route is set
@@ -146,7 +146,7 @@ out:
146} 146}
147 147
148/** 148/**
149 * batadv_window_protected - checks whether the host restarted and is in the 149 * batadv_window_protected() - checks whether the host restarted and is in the
150 * protection time. 150 * protection time.
151 * @bat_priv: the bat priv with all the soft interface information 151 * @bat_priv: the bat priv with all the soft interface information
152 * @seq_num_diff: difference between the current/received sequence number and 152 * @seq_num_diff: difference between the current/received sequence number and
@@ -213,7 +213,7 @@ bool batadv_check_management_packet(struct sk_buff *skb,
213} 213}
214 214
215/** 215/**
216 * batadv_recv_my_icmp_packet - receive an icmp packet locally 216 * batadv_recv_my_icmp_packet() - receive an icmp packet locally
217 * @bat_priv: the bat priv with all the soft interface information 217 * @bat_priv: the bat priv with all the soft interface information
218 * @skb: icmp packet to process 218 * @skb: icmp packet to process
219 * 219 *
@@ -441,7 +441,7 @@ free_skb:
441} 441}
442 442
443/** 443/**
444 * batadv_check_unicast_packet - Check for malformed unicast packets 444 * batadv_check_unicast_packet() - Check for malformed unicast packets
445 * @bat_priv: the bat priv with all the soft interface information 445 * @bat_priv: the bat priv with all the soft interface information
446 * @skb: packet to check 446 * @skb: packet to check
447 * @hdr_size: size of header to pull 447 * @hdr_size: size of header to pull
@@ -479,7 +479,7 @@ static int batadv_check_unicast_packet(struct batadv_priv *bat_priv,
479} 479}
480 480
481/** 481/**
482 * batadv_last_bonding_get - Get last_bonding_candidate of orig_node 482 * batadv_last_bonding_get() - Get last_bonding_candidate of orig_node
483 * @orig_node: originator node whose last bonding candidate should be retrieved 483 * @orig_node: originator node whose last bonding candidate should be retrieved
484 * 484 *
485 * Return: last bonding candidate of router or NULL if not found 485 * 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)
502} 502}
503 503
504/** 504/**
505 * batadv_last_bonding_replace - Replace last_bonding_candidate of orig_node 505 * batadv_last_bonding_replace() - Replace last_bonding_candidate of orig_node
506 * @orig_node: originator node whose bonding candidates should be replaced 506 * @orig_node: originator node whose bonding candidates should be replaced
507 * @new_candidate: new bonding candidate or NULL 507 * @new_candidate: new bonding candidate or NULL
508 */ 508 */
@@ -525,7 +525,7 @@ batadv_last_bonding_replace(struct batadv_orig_node *orig_node,
525} 525}
526 526
527/** 527/**
528 * batadv_find_router - find a suitable router for this originator 528 * batadv_find_router() - find a suitable router for this originator
529 * @bat_priv: the bat priv with all the soft interface information 529 * @bat_priv: the bat priv with all the soft interface information
530 * @orig_node: the destination node 530 * @orig_node: the destination node
531 * @recv_if: pointer to interface this packet was received on 531 * @recv_if: pointer to interface this packet was received on
@@ -742,7 +742,7 @@ free_skb:
742} 742}
743 743
744/** 744/**
745 * batadv_reroute_unicast_packet - update the unicast header for re-routing 745 * batadv_reroute_unicast_packet() - update the unicast header for re-routing
746 * @bat_priv: the bat priv with all the soft interface information 746 * @bat_priv: the bat priv with all the soft interface information
747 * @unicast_packet: the unicast header to be updated 747 * @unicast_packet: the unicast header to be updated
748 * @dst_addr: the payload destination 748 * @dst_addr: the payload destination
@@ -905,7 +905,7 @@ static bool batadv_check_unicast_ttvn(struct batadv_priv *bat_priv,
905} 905}
906 906
907/** 907/**
908 * batadv_recv_unhandled_unicast_packet - receive and process packets which 908 * batadv_recv_unhandled_unicast_packet() - receive and process packets which
909 * are in the unicast number space but not yet known to the implementation 909 * are in the unicast number space but not yet known to the implementation
910 * @skb: unicast tvlv packet to process 910 * @skb: unicast tvlv packet to process
911 * @recv_if: pointer to interface this packet was received on 911 * @recv_if: pointer to interface this packet was received on
@@ -1037,7 +1037,7 @@ free_skb:
1037} 1037}
1038 1038
1039/** 1039/**
1040 * batadv_recv_unicast_tvlv - receive and process unicast tvlv packets 1040 * batadv_recv_unicast_tvlv() - receive and process unicast tvlv packets
1041 * @skb: unicast tvlv packet to process 1041 * @skb: unicast tvlv packet to process
1042 * @recv_if: pointer to interface this packet was received on 1042 * @recv_if: pointer to interface this packet was received on
1043 * 1043 *
@@ -1091,7 +1091,7 @@ free_skb:
1091} 1091}
1092 1092
1093/** 1093/**
1094 * batadv_recv_frag_packet - process received fragment 1094 * batadv_recv_frag_packet() - process received fragment
1095 * @skb: the received fragment 1095 * @skb: the received fragment
1096 * @recv_if: interface that the skb is received on 1096 * @recv_if: interface that the skb is received on
1097 * 1097 *
diff --git a/net/batman-adv/send.c b/net/batman-adv/send.c
index c53b11d41d8b..0700b3dfb595 100644
--- a/net/batman-adv/send.c
+++ b/net/batman-adv/send.c
@@ -55,7 +55,7 @@
55static void batadv_send_outstanding_bcast_packet(struct work_struct *work); 55static void batadv_send_outstanding_bcast_packet(struct work_struct *work);
56 56
57/** 57/**
58 * batadv_send_skb_packet - send an already prepared packet 58 * batadv_send_skb_packet() - send an already prepared packet
59 * @skb: the packet to send 59 * @skb: the packet to send
60 * @hard_iface: the interface to use to send the broadcast packet 60 * @hard_iface: the interface to use to send the broadcast packet
61 * @dst_addr: the payload destination 61 * @dst_addr: the payload destination
@@ -154,7 +154,7 @@ int batadv_send_unicast_skb(struct sk_buff *skb,
154} 154}
155 155
156/** 156/**
157 * batadv_send_skb_to_orig - Lookup next-hop and transmit skb. 157 * batadv_send_skb_to_orig() - Lookup next-hop and transmit skb.
158 * @skb: Packet to be transmitted. 158 * @skb: Packet to be transmitted.
159 * @orig_node: Final destination of the packet. 159 * @orig_node: Final destination of the packet.
160 * @recv_if: Interface used when receiving the packet (can be NULL). 160 * @recv_if: Interface used when receiving the packet (can be NULL).
@@ -217,7 +217,7 @@ free_skb:
217} 217}
218 218
219/** 219/**
220 * batadv_send_skb_push_fill_unicast - extend the buffer and initialize the 220 * batadv_send_skb_push_fill_unicast() - extend the buffer and initialize the
221 * common fields for unicast packets 221 * common fields for unicast packets
222 * @skb: the skb carrying the unicast header to initialize 222 * @skb: the skb carrying the unicast header to initialize
223 * @hdr_size: amount of bytes to push at the beginning of the skb 223 * @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,
250} 250}
251 251
252/** 252/**
253 * batadv_send_skb_prepare_unicast - encapsulate an skb with a unicast header 253 * batadv_send_skb_prepare_unicast() - encapsulate an skb with a unicast header
254 * @skb: the skb containing the payload to encapsulate 254 * @skb: the skb containing the payload to encapsulate
255 * @orig_node: the destination node 255 * @orig_node: the destination node
256 * 256 *
@@ -265,7 +265,7 @@ static bool batadv_send_skb_prepare_unicast(struct sk_buff *skb,
265} 265}
266 266
267/** 267/**
268 * batadv_send_skb_prepare_unicast_4addr - encapsulate an skb with a 268 * batadv_send_skb_prepare_unicast_4addr() - encapsulate an skb with a
269 * unicast 4addr header 269 * unicast 4addr header
270 * @bat_priv: the bat priv with all the soft interface information 270 * @bat_priv: the bat priv with all the soft interface information
271 * @skb: the skb containing the payload to encapsulate 271 * @skb: the skb containing the payload to encapsulate
@@ -309,7 +309,7 @@ out:
309} 309}
310 310
311/** 311/**
312 * batadv_send_skb_unicast - encapsulate and send an skb via unicast 312 * batadv_send_skb_unicast() - encapsulate and send an skb via unicast
313 * @bat_priv: the bat priv with all the soft interface information 313 * @bat_priv: the bat priv with all the soft interface information
314 * @skb: payload to send 314 * @skb: payload to send
315 * @packet_type: the batman unicast packet type to use 315 * @packet_type: the batman unicast packet type to use
@@ -379,7 +379,7 @@ out:
379} 379}
380 380
381/** 381/**
382 * batadv_send_skb_via_tt_generic - send an skb via TT lookup 382 * batadv_send_skb_via_tt_generic() - send an skb via TT lookup
383 * @bat_priv: the bat priv with all the soft interface information 383 * @bat_priv: the bat priv with all the soft interface information
384 * @skb: payload to send 384 * @skb: payload to send
385 * @packet_type: the batman unicast packet type to use 385 * @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,
426} 426}
427 427
428/** 428/**
429 * batadv_send_skb_via_gw - send an skb via gateway lookup 429 * batadv_send_skb_via_gw() - send an skb via gateway lookup
430 * @bat_priv: the bat priv with all the soft interface information 430 * @bat_priv: the bat priv with all the soft interface information
431 * @skb: payload to send 431 * @skb: payload to send
432 * @vid: the vid to be used to search the translation table 432 * @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,
453} 453}
454 454
455/** 455/**
456 * batadv_forw_packet_free - free a forwarding packet 456 * batadv_forw_packet_free() - free a forwarding packet
457 * @forw_packet: The packet to free 457 * @forw_packet: The packet to free
458 * @dropped: whether the packet is freed because is is dropped 458 * @dropped: whether the packet is freed because is is dropped
459 * 459 *
@@ -478,7 +478,7 @@ void batadv_forw_packet_free(struct batadv_forw_packet *forw_packet,
478} 478}
479 479
480/** 480/**
481 * batadv_forw_packet_alloc - allocate a forwarding packet 481 * batadv_forw_packet_alloc() - allocate a forwarding packet
482 * @if_incoming: The (optional) if_incoming to be grabbed 482 * @if_incoming: The (optional) if_incoming to be grabbed
483 * @if_outgoing: The (optional) if_outgoing to be grabbed 483 * @if_outgoing: The (optional) if_outgoing to be grabbed
484 * @queue_left: The (optional) queue counter to decrease 484 * @queue_left: The (optional) queue counter to decrease
@@ -544,7 +544,7 @@ err:
544} 544}
545 545
546/** 546/**
547 * batadv_forw_packet_was_stolen - check whether someone stole this packet 547 * batadv_forw_packet_was_stolen() - check whether someone stole this packet
548 * @forw_packet: the forwarding packet to check 548 * @forw_packet: the forwarding packet to check
549 * 549 *
550 * This function checks whether the given forwarding packet was claimed by 550 * 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)
559} 559}
560 560
561/** 561/**
562 * batadv_forw_packet_steal - claim a forw_packet for free() 562 * batadv_forw_packet_steal() - claim a forw_packet for free()
563 * @forw_packet: the forwarding packet to steal 563 * @forw_packet: the forwarding packet to steal
564 * @lock: a key to the store to steal from (e.g. forw_{bat,bcast}_list_lock) 564 * @lock: a key to the store to steal from (e.g. forw_{bat,bcast}_list_lock)
565 * 565 *
@@ -590,7 +590,7 @@ bool batadv_forw_packet_steal(struct batadv_forw_packet *forw_packet,
590} 590}
591 591
592/** 592/**
593 * batadv_forw_packet_list_steal - claim a list of forward packets for free() 593 * batadv_forw_packet_list_steal() - claim a list of forward packets for free()
594 * @forw_list: the to be stolen forward packets 594 * @forw_list: the to be stolen forward packets
595 * @cleanup_list: a backup pointer, to be able to dispose the packet later 595 * @cleanup_list: a backup pointer, to be able to dispose the packet later
596 * @hard_iface: the interface to steal forward packets from 596 * @hard_iface: the interface to steal forward packets from
@@ -626,7 +626,7 @@ batadv_forw_packet_list_steal(struct hlist_head *forw_list,
626} 626}
627 627
628/** 628/**
629 * batadv_forw_packet_list_free - free a list of forward packets 629 * batadv_forw_packet_list_free() - free a list of forward packets
630 * @head: a list of to be freed forw_packets 630 * @head: a list of to be freed forw_packets
631 * 631 *
632 * This function cancels the scheduling of any packet in the provided list, 632 * 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)
650} 650}
651 651
652/** 652/**
653 * batadv_forw_packet_queue - try to queue a forwarding packet 653 * batadv_forw_packet_queue() - try to queue a forwarding packet
654 * @forw_packet: the forwarding packet to queue 654 * @forw_packet: the forwarding packet to queue
655 * @lock: a key to the store (e.g. forw_{bat,bcast}_list_lock) 655 * @lock: a key to the store (e.g. forw_{bat,bcast}_list_lock)
656 * @head: the shelve to queue it on (e.g. forw_{bat,bcast}_list) 656 * @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,
694} 694}
695 695
696/** 696/**
697 * batadv_forw_packet_bcast_queue - try to queue a broadcast packet 697 * batadv_forw_packet_bcast_queue() - try to queue a broadcast packet
698 * @bat_priv: the bat priv with all the soft interface information 698 * @bat_priv: the bat priv with all the soft interface information
699 * @forw_packet: the forwarding packet to queue 699 * @forw_packet: the forwarding packet to queue
700 * @send_time: timestamp (jiffies) when the packet is to be sent 700 * @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,
713} 713}
714 714
715/** 715/**
716 * batadv_forw_packet_ogmv1_queue - try to queue an OGMv1 packet 716 * batadv_forw_packet_ogmv1_queue() - try to queue an OGMv1 packet
717 * @bat_priv: the bat priv with all the soft interface information 717 * @bat_priv: the bat priv with all the soft interface information
718 * @forw_packet: the forwarding packet to queue 718 * @forw_packet: the forwarding packet to queue
719 * @send_time: timestamp (jiffies) when the packet is to be sent 719 * @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,
731} 731}
732 732
733/** 733/**
734 * batadv_add_bcast_packet_to_list - queue broadcast packet for multiple sends 734 * batadv_add_bcast_packet_to_list() - queue broadcast packet for multiple sends
735 * @bat_priv: the bat priv with all the soft interface information 735 * @bat_priv: the bat priv with all the soft interface information
736 * @skb: broadcast packet to add 736 * @skb: broadcast packet to add
737 * @delay: number of jiffies to wait before sending 737 * @delay: number of jiffies to wait before sending
@@ -791,7 +791,7 @@ err:
791} 791}
792 792
793/** 793/**
794 * batadv_forw_packet_bcasts_left - check if a retransmission is necessary 794 * batadv_forw_packet_bcasts_left() - check if a retransmission is necessary
795 * @forw_packet: the forwarding packet to check 795 * @forw_packet: the forwarding packet to check
796 * @hard_iface: the interface to check on 796 * @hard_iface: the interface to check on
797 * 797 *
@@ -819,7 +819,8 @@ batadv_forw_packet_bcasts_left(struct batadv_forw_packet *forw_packet,
819} 819}
820 820
821/** 821/**
822 * batadv_forw_packet_bcasts_inc - increment retransmission counter of a packet 822 * batadv_forw_packet_bcasts_inc() - increment retransmission counter of a
823 * packet
823 * @forw_packet: the packet to increase the counter for 824 * @forw_packet: the packet to increase the counter for
824 */ 825 */
825static void 826static void
@@ -829,7 +830,7 @@ batadv_forw_packet_bcasts_inc(struct batadv_forw_packet *forw_packet)
829} 830}
830 831
831/** 832/**
832 * batadv_forw_packet_is_rebroadcast - check packet for previous transmissions 833 * batadv_forw_packet_is_rebroadcast() - check packet for previous transmissions
833 * @forw_packet: the packet to check 834 * @forw_packet: the packet to check
834 * 835 *
835 * Return: True if this packet was transmitted before, false otherwise. 836 * Return: True if this packet was transmitted before, false otherwise.
@@ -954,7 +955,7 @@ out:
954} 955}
955 956
956/** 957/**
957 * batadv_purge_outstanding_packets - stop/purge scheduled bcast/OGMv1 packets 958 * batadv_purge_outstanding_packets() - stop/purge scheduled bcast/OGMv1 packets
958 * @bat_priv: the bat priv with all the soft interface information 959 * @bat_priv: the bat priv with all the soft interface information
959 * @hard_iface: the hard interface to cancel and purge bcast/ogm packets on 960 * @hard_iface: the hard interface to cancel and purge bcast/ogm packets on
960 * 961 *
diff --git a/net/batman-adv/send.h b/net/batman-adv/send.h
index eb36820e41bc..8c7399dd06ca 100644
--- a/net/batman-adv/send.h
+++ b/net/batman-adv/send.h
@@ -77,7 +77,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb,
77 unsigned short vid); 77 unsigned short vid);
78 78
79/** 79/**
80 * batadv_send_skb_via_tt - send an skb via TT lookup 80 * batadv_send_skb_via_tt() - send an skb via TT lookup
81 * @bat_priv: the bat priv with all the soft interface information 81 * @bat_priv: the bat priv with all the soft interface information
82 * @skb: the payload to send 82 * @skb: the payload to send
83 * @dst_hint: can be used to override the destination contained in the skb 83 * @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,
98} 98}
99 99
100/** 100/**
101 * batadv_send_skb_via_tt_4addr - send an skb via TT lookup 101 * batadv_send_skb_via_tt_4addr() - send an skb via TT lookup
102 * @bat_priv: the bat priv with all the soft interface information 102 * @bat_priv: the bat priv with all the soft interface information
103 * @skb: the payload to send 103 * @skb: the payload to send
104 * @packet_subtype: the unicast 4addr packet subtype to use 104 * @packet_subtype: the unicast 4addr packet subtype to use
diff --git a/net/batman-adv/soft-interface.c b/net/batman-adv/soft-interface.c
index ba8fd06eee7e..9b66e0edc741 100644
--- a/net/batman-adv/soft-interface.c
+++ b/net/batman-adv/soft-interface.c
@@ -97,7 +97,7 @@ static int batadv_interface_release(struct net_device *dev)
97} 97}
98 98
99/** 99/**
100 * batadv_sum_counter - Sum the cpu-local counters for index 'idx' 100 * batadv_sum_counter() - Sum the cpu-local counters for index 'idx'
101 * @bat_priv: the bat priv with all the soft interface information 101 * @bat_priv: the bat priv with all the soft interface information
102 * @idx: index of counter to sum up 102 * @idx: index of counter to sum up
103 * 103 *
@@ -170,7 +170,7 @@ static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu)
170} 170}
171 171
172/** 172/**
173 * batadv_interface_set_rx_mode - set the rx mode of a device 173 * batadv_interface_set_rx_mode() - set the rx mode of a device
174 * @dev: registered network device to modify 174 * @dev: registered network device to modify
175 * 175 *
176 * We do not actually need to set any rx filters for the virtual batman 176 * We do not actually need to set any rx filters for the virtual batman
@@ -390,7 +390,7 @@ end:
390} 390}
391 391
392/** 392/**
393 * batadv_interface_rx - receive ethernet frame on local batman-adv interface 393 * batadv_interface_rx() - receive ethernet frame on local batman-adv interface
394 * @soft_iface: local interface which will receive the ethernet frame 394 * @soft_iface: local interface which will receive the ethernet frame
395 * @skb: ethernet frame for @soft_iface 395 * @skb: ethernet frame for @soft_iface
396 * @hdr_size: size of already parsed batman-adv header 396 * @hdr_size: size of already parsed batman-adv header
@@ -502,8 +502,8 @@ out:
502} 502}
503 503
504/** 504/**
505 * batadv_softif_vlan_release - release vlan from lists and queue for free after 505 * batadv_softif_vlan_release() - release vlan from lists and queue for free
506 * rcu grace period 506 * after rcu grace period
507 * @ref: kref pointer of the vlan object 507 * @ref: kref pointer of the vlan object
508 */ 508 */
509static void batadv_softif_vlan_release(struct kref *ref) 509static void batadv_softif_vlan_release(struct kref *ref)
@@ -520,7 +520,7 @@ static void batadv_softif_vlan_release(struct kref *ref)
520} 520}
521 521
522/** 522/**
523 * batadv_softif_vlan_put - decrease the vlan object refcounter and 523 * batadv_softif_vlan_put() - decrease the vlan object refcounter and
524 * possibly release it 524 * possibly release it
525 * @vlan: the vlan object to release 525 * @vlan: the vlan object to release
526 */ 526 */
@@ -533,7 +533,7 @@ void batadv_softif_vlan_put(struct batadv_softif_vlan *vlan)
533} 533}
534 534
535/** 535/**
536 * batadv_softif_vlan_get - get the vlan object for a specific vid 536 * batadv_softif_vlan_get() - get the vlan object for a specific vid
537 * @bat_priv: the bat priv with all the soft interface information 537 * @bat_priv: the bat priv with all the soft interface information
538 * @vid: the identifier of the vlan object to retrieve 538 * @vid: the identifier of the vlan object to retrieve
539 * 539 *
@@ -562,7 +562,7 @@ struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv,
562} 562}
563 563
564/** 564/**
565 * batadv_softif_create_vlan - allocate the needed resources for a new vlan 565 * batadv_softif_create_vlan() - allocate the needed resources for a new vlan
566 * @bat_priv: the bat priv with all the soft interface information 566 * @bat_priv: the bat priv with all the soft interface information
567 * @vid: the VLAN identifier 567 * @vid: the VLAN identifier
568 * 568 *
@@ -614,7 +614,7 @@ int batadv_softif_create_vlan(struct batadv_priv *bat_priv, unsigned short vid)
614} 614}
615 615
616/** 616/**
617 * batadv_softif_destroy_vlan - remove and destroy a softif_vlan object 617 * batadv_softif_destroy_vlan() - remove and destroy a softif_vlan object
618 * @bat_priv: the bat priv with all the soft interface information 618 * @bat_priv: the bat priv with all the soft interface information
619 * @vlan: the object to remove 619 * @vlan: the object to remove
620 */ 620 */
@@ -632,7 +632,7 @@ static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv,
632} 632}
633 633
634/** 634/**
635 * batadv_interface_add_vid - ndo_add_vid API implementation 635 * batadv_interface_add_vid() - ndo_add_vid API implementation
636 * @dev: the netdev of the mesh interface 636 * @dev: the netdev of the mesh interface
637 * @proto: protocol of the the vlan id 637 * @proto: protocol of the the vlan id
638 * @vid: identifier of the new vlan 638 * @vid: identifier of the new vlan
@@ -690,7 +690,7 @@ static int batadv_interface_add_vid(struct net_device *dev, __be16 proto,
690} 690}
691 691
692/** 692/**
693 * batadv_interface_kill_vid - ndo_kill_vid API implementation 693 * batadv_interface_kill_vid() - ndo_kill_vid API implementation
694 * @dev: the netdev of the mesh interface 694 * @dev: the netdev of the mesh interface
695 * @proto: protocol of the the vlan id 695 * @proto: protocol of the the vlan id
696 * @vid: identifier of the deleted vlan 696 * @vid: identifier of the deleted vlan
@@ -733,7 +733,7 @@ static struct lock_class_key batadv_netdev_xmit_lock_key;
733static struct lock_class_key batadv_netdev_addr_lock_key; 733static struct lock_class_key batadv_netdev_addr_lock_key;
734 734
735/** 735/**
736 * batadv_set_lockdep_class_one - Set lockdep class for a single tx queue 736 * batadv_set_lockdep_class_one() - Set lockdep class for a single tx queue
737 * @dev: device which owns the tx queue 737 * @dev: device which owns the tx queue
738 * @txq: tx queue to modify 738 * @txq: tx queue to modify
739 * @_unused: always NULL 739 * @_unused: always NULL
@@ -746,7 +746,7 @@ static void batadv_set_lockdep_class_one(struct net_device *dev,
746} 746}
747 747
748/** 748/**
749 * batadv_set_lockdep_class - Set txq and addr_list lockdep class 749 * batadv_set_lockdep_class() - Set txq and addr_list lockdep class
750 * @dev: network device to modify 750 * @dev: network device to modify
751 */ 751 */
752static void batadv_set_lockdep_class(struct net_device *dev) 752static void batadv_set_lockdep_class(struct net_device *dev)
@@ -756,7 +756,7 @@ static void batadv_set_lockdep_class(struct net_device *dev)
756} 756}
757 757
758/** 758/**
759 * batadv_softif_init_late - late stage initialization of soft interface 759 * batadv_softif_init_late() - late stage initialization of soft interface
760 * @dev: registered network device to modify 760 * @dev: registered network device to modify
761 * 761 *
762 * Return: error code on failures 762 * Return: error code on failures
@@ -861,7 +861,7 @@ free_bat_counters:
861} 861}
862 862
863/** 863/**
864 * batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface 864 * batadv_softif_slave_add() - Add a slave interface to a batadv_soft_interface
865 * @dev: batadv_soft_interface used as master interface 865 * @dev: batadv_soft_interface used as master interface
866 * @slave_dev: net_device which should become the slave interface 866 * @slave_dev: net_device which should become the slave interface
867 * @extack: extended ACK report struct 867 * @extack: extended ACK report struct
@@ -889,7 +889,7 @@ out:
889} 889}
890 890
891/** 891/**
892 * batadv_softif_slave_del - Delete a slave iface from a batadv_soft_interface 892 * batadv_softif_slave_del() - Delete a slave iface from a batadv_soft_interface
893 * @dev: batadv_soft_interface used as master interface 893 * @dev: batadv_soft_interface used as master interface
894 * @slave_dev: net_device which should be removed from the master interface 894 * @slave_dev: net_device which should be removed from the master interface
895 * 895 *
@@ -1024,7 +1024,7 @@ static const struct ethtool_ops batadv_ethtool_ops = {
1024}; 1024};
1025 1025
1026/** 1026/**
1027 * batadv_softif_free - Deconstructor of batadv_soft_interface 1027 * batadv_softif_free() - Deconstructor of batadv_soft_interface
1028 * @dev: Device to cleanup and remove 1028 * @dev: Device to cleanup and remove
1029 */ 1029 */
1030static void batadv_softif_free(struct net_device *dev) 1030static void batadv_softif_free(struct net_device *dev)
@@ -1040,7 +1040,7 @@ static void batadv_softif_free(struct net_device *dev)
1040} 1040}
1041 1041
1042/** 1042/**
1043 * batadv_softif_init_early - early stage initialization of soft interface 1043 * batadv_softif_init_early() - early stage initialization of soft interface
1044 * @dev: registered network device to modify 1044 * @dev: registered network device to modify
1045 */ 1045 */
1046static void batadv_softif_init_early(struct net_device *dev) 1046static 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)
1090} 1090}
1091 1091
1092/** 1092/**
1093 * batadv_softif_destroy_sysfs - deletion of batadv_soft_interface via sysfs 1093 * batadv_softif_destroy_sysfs() - deletion of batadv_soft_interface via sysfs
1094 * @soft_iface: the to-be-removed batman-adv interface 1094 * @soft_iface: the to-be-removed batman-adv interface
1095 */ 1095 */
1096void batadv_softif_destroy_sysfs(struct net_device *soft_iface) 1096void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
@@ -1112,7 +1112,8 @@ void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
1112} 1112}
1113 1113
1114/** 1114/**
1115 * batadv_softif_destroy_netlink - deletion of batadv_soft_interface via netlink 1115 * batadv_softif_destroy_netlink() - deletion of batadv_soft_interface via
1116 * netlink
1116 * @soft_iface: the to-be-removed batman-adv interface 1117 * @soft_iface: the to-be-removed batman-adv interface
1117 * @head: list pointer 1118 * @head: list pointer
1118 */ 1119 */
diff --git a/net/batman-adv/sysfs.c b/net/batman-adv/sysfs.c
index 227a072dc1d3..8e2b7c7d2358 100644
--- a/net/batman-adv/sysfs.c
+++ b/net/batman-adv/sysfs.c
@@ -65,7 +65,7 @@ static struct batadv_priv *batadv_kobj_to_batpriv(struct kobject *obj)
65} 65}
66 66
67/** 67/**
68 * batadv_vlan_kobj_to_batpriv - convert a vlan kobj in the associated batpriv 68 * batadv_vlan_kobj_to_batpriv() - convert a vlan kobj in the associated batpriv
69 * @obj: kobject to covert 69 * @obj: kobject to covert
70 * 70 *
71 * Return: the associated batadv_priv struct. 71 * Return: the associated batadv_priv struct.
@@ -85,7 +85,7 @@ static struct batadv_priv *batadv_vlan_kobj_to_batpriv(struct kobject *obj)
85} 85}
86 86
87/** 87/**
88 * batadv_kobj_to_vlan - convert a kobj in the associated softif_vlan struct 88 * batadv_kobj_to_vlan() - convert a kobj in the associated softif_vlan struct
89 * @bat_priv: the bat priv with all the soft interface information 89 * @bat_priv: the bat priv with all the soft interface information
90 * @obj: kobject to covert 90 * @obj: kobject to covert
91 * 91 *
@@ -600,7 +600,7 @@ static ssize_t batadv_store_gw_bwidth(struct kobject *kobj,
600} 600}
601 601
602/** 602/**
603 * batadv_show_isolation_mark - print the current isolation mark/mask 603 * batadv_show_isolation_mark() - print the current isolation mark/mask
604 * @kobj: kobject representing the private mesh sysfs directory 604 * @kobj: kobject representing the private mesh sysfs directory
605 * @attr: the batman-adv attribute the user is interacting with 605 * @attr: the batman-adv attribute the user is interacting with
606 * @buff: the buffer that will contain the data to send back to the user 606 * @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,
618} 618}
619 619
620/** 620/**
621 * batadv_store_isolation_mark - parse and store the isolation mark/mask entered 621 * batadv_store_isolation_mark() - parse and store the isolation mark/mask
622 * by the user 622 * entered by the user
623 * @kobj: kobject representing the private mesh sysfs directory 623 * @kobj: kobject representing the private mesh sysfs directory
624 * @attr: the batman-adv attribute the user is interacting with 624 * @attr: the batman-adv attribute the user is interacting with
625 * @buff: the buffer containing the user data 625 * @buff: the buffer containing the user data
@@ -790,7 +790,7 @@ void batadv_sysfs_del_meshif(struct net_device *dev)
790} 790}
791 791
792/** 792/**
793 * batadv_sysfs_add_vlan - add all the needed sysfs objects for the new vlan 793 * batadv_sysfs_add_vlan() - add all the needed sysfs objects for the new vlan
794 * @dev: netdev of the mesh interface 794 * @dev: netdev of the mesh interface
795 * @vlan: private data of the newly added VLAN interface 795 * @vlan: private data of the newly added VLAN interface
796 * 796 *
@@ -851,7 +851,7 @@ out:
851} 851}
852 852
853/** 853/**
854 * batadv_sysfs_del_vlan - remove all the sysfs objects for a given VLAN 854 * batadv_sysfs_del_vlan() - remove all the sysfs objects for a given VLAN
855 * @bat_priv: the bat priv with all the soft interface information 855 * @bat_priv: the bat priv with all the soft interface information
856 * @vlan: the private data of the VLAN to destroy 856 * @vlan: the private data of the VLAN to destroy
857 */ 857 */
@@ -896,7 +896,7 @@ static ssize_t batadv_show_mesh_iface(struct kobject *kobj,
896} 896}
897 897
898/** 898/**
899 * batadv_store_mesh_iface_finish - store new hardif mesh_iface state 899 * batadv_store_mesh_iface_finish() - store new hardif mesh_iface state
900 * @net_dev: netdevice to add/remove to/from batman-adv soft-interface 900 * @net_dev: netdevice to add/remove to/from batman-adv soft-interface
901 * @ifname: name of soft-interface to modify 901 * @ifname: name of soft-interface to modify
902 * 902 *
@@ -949,7 +949,7 @@ out:
949} 949}
950 950
951/** 951/**
952 * batadv_store_mesh_iface_work - store new hardif mesh_iface state 952 * batadv_store_mesh_iface_work() - store new hardif mesh_iface state
953 * @work: work queue item 953 * @work: work queue item
954 * 954 *
955 * Changes the parts of the hard+soft interface which can not be modified under 955 * 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,
1045#ifdef CONFIG_BATMAN_ADV_BATMAN_V 1045#ifdef CONFIG_BATMAN_ADV_BATMAN_V
1046 1046
1047/** 1047/**
1048 * batadv_store_throughput_override - parse and store throughput override 1048 * batadv_store_throughput_override() - parse and store throughput override
1049 * entered by the user 1049 * entered by the user
1050 * @kobj: kobject representing the private mesh sysfs directory 1050 * @kobj: kobject representing the private mesh sysfs directory
1051 * @attr: the batman-adv attribute the user is interacting with 1051 * @attr: the batman-adv attribute the user is interacting with
diff --git a/net/batman-adv/tp_meter.c b/net/batman-adv/tp_meter.c
index fe9eb2970ec9..b443b9d28918 100644
--- a/net/batman-adv/tp_meter.c
+++ b/net/batman-adv/tp_meter.c
@@ -98,7 +98,7 @@
98static u8 batadv_tp_prerandom[4096] __read_mostly; 98static u8 batadv_tp_prerandom[4096] __read_mostly;
99 99
100/** 100/**
101 * batadv_tp_session_cookie - generate session cookie based on session ids 101 * batadv_tp_session_cookie() - generate session cookie based on session ids
102 * @session: TP session identifier 102 * @session: TP session identifier
103 * @icmp_uid: icmp pseudo uid of the tp session 103 * @icmp_uid: icmp pseudo uid of the tp session
104 * 104 *
@@ -116,7 +116,7 @@ static u32 batadv_tp_session_cookie(const u8 session[2], u8 icmp_uid)
116} 116}
117 117
118/** 118/**
119 * batadv_tp_cwnd - compute the new cwnd size 119 * batadv_tp_cwnd() - compute the new cwnd size
120 * @base: base cwnd size value 120 * @base: base cwnd size value
121 * @increment: the value to add to base to get the new size 121 * @increment: the value to add to base to get the new size
122 * @min: minumim cwnd value (usually MSS) 122 * @min: minumim cwnd value (usually MSS)
@@ -141,7 +141,7 @@ static u32 batadv_tp_cwnd(u32 base, u32 increment, u32 min)
141} 141}
142 142
143/** 143/**
144 * batadv_tp_updated_cwnd - update the Congestion Windows 144 * batadv_tp_updated_cwnd() - update the Congestion Windows
145 * @tp_vars: the private data of the current TP meter session 145 * @tp_vars: the private data of the current TP meter session
146 * @mss: maximum segment size of transmission 146 * @mss: maximum segment size of transmission
147 * 147 *
@@ -177,7 +177,7 @@ static void batadv_tp_update_cwnd(struct batadv_tp_vars *tp_vars, u32 mss)
177} 177}
178 178
179/** 179/**
180 * batadv_tp_update_rto - calculate new retransmission timeout 180 * batadv_tp_update_rto() - calculate new retransmission timeout
181 * @tp_vars: the private data of the current TP meter session 181 * @tp_vars: the private data of the current TP meter session
182 * @new_rtt: new roundtrip time in msec 182 * @new_rtt: new roundtrip time in msec
183 */ 183 */
@@ -213,7 +213,7 @@ static void batadv_tp_update_rto(struct batadv_tp_vars *tp_vars,
213} 213}
214 214
215/** 215/**
216 * batadv_tp_batctl_notify - send client status result to client 216 * batadv_tp_batctl_notify() - send client status result to client
217 * @reason: reason for tp meter session stop 217 * @reason: reason for tp meter session stop
218 * @dst: destination of tp_meter session 218 * @dst: destination of tp_meter session
219 * @bat_priv: the bat priv with all the soft interface information 219 * @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,
245} 245}
246 246
247/** 247/**
248 * batadv_tp_batctl_error_notify - send client error result to client 248 * batadv_tp_batctl_error_notify() - send client error result to client
249 * @reason: reason for tp meter session stop 249 * @reason: reason for tp meter session stop
250 * @dst: destination of tp_meter session 250 * @dst: destination of tp_meter session
251 * @bat_priv: the bat priv with all the soft interface information 251 * @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,
260} 260}
261 261
262/** 262/**
263 * batadv_tp_list_find - find a tp_vars object in the global list 263 * batadv_tp_list_find() - find a tp_vars object in the global list
264 * @bat_priv: the bat priv with all the soft interface information 264 * @bat_priv: the bat priv with all the soft interface information
265 * @dst: the other endpoint MAC address to look for 265 * @dst: the other endpoint MAC address to look for
266 * 266 *
@@ -295,7 +295,8 @@ static struct batadv_tp_vars *batadv_tp_list_find(struct batadv_priv *bat_priv,
295} 295}
296 296
297/** 297/**
298 * batadv_tp_list_find_session - find tp_vars session object in the global list 298 * batadv_tp_list_find_session() - find tp_vars session object in the global
299 * list
299 * @bat_priv: the bat priv with all the soft interface information 300 * @bat_priv: the bat priv with all the soft interface information
300 * @dst: the other endpoint MAC address to look for 301 * @dst: the other endpoint MAC address to look for
301 * @session: session identifier 302 * @session: session identifier
@@ -336,7 +337,7 @@ batadv_tp_list_find_session(struct batadv_priv *bat_priv, const u8 *dst,
336} 337}
337 338
338/** 339/**
339 * batadv_tp_vars_release - release batadv_tp_vars from lists and queue for 340 * batadv_tp_vars_release() - release batadv_tp_vars from lists and queue for
340 * free after rcu grace period 341 * free after rcu grace period
341 * @ref: kref pointer of the batadv_tp_vars 342 * @ref: kref pointer of the batadv_tp_vars
342 */ 343 */
@@ -361,7 +362,7 @@ static void batadv_tp_vars_release(struct kref *ref)
361} 362}
362 363
363/** 364/**
364 * batadv_tp_vars_put - decrement the batadv_tp_vars refcounter and possibly 365 * batadv_tp_vars_put() - decrement the batadv_tp_vars refcounter and possibly
365 * release it 366 * release it
366 * @tp_vars: the private data of the current TP meter session to be free'd 367 * @tp_vars: the private data of the current TP meter session to be free'd
367 */ 368 */
@@ -371,7 +372,7 @@ static void batadv_tp_vars_put(struct batadv_tp_vars *tp_vars)
371} 372}
372 373
373/** 374/**
374 * batadv_tp_sender_cleanup - cleanup sender data and drop and timer 375 * batadv_tp_sender_cleanup() - cleanup sender data and drop and timer
375 * @bat_priv: the bat priv with all the soft interface information 376 * @bat_priv: the bat priv with all the soft interface information
376 * @tp_vars: the private data of the current TP meter session to cleanup 377 * @tp_vars: the private data of the current TP meter session to cleanup
377 */ 378 */
@@ -401,7 +402,7 @@ static void batadv_tp_sender_cleanup(struct batadv_priv *bat_priv,
401} 402}
402 403
403/** 404/**
404 * batadv_tp_sender_end - print info about ended session and inform client 405 * batadv_tp_sender_end() - print info about ended session and inform client
405 * @bat_priv: the bat priv with all the soft interface information 406 * @bat_priv: the bat priv with all the soft interface information
406 * @tp_vars: the private data of the current TP meter session 407 * @tp_vars: the private data of the current TP meter session
407 */ 408 */
@@ -434,7 +435,7 @@ static void batadv_tp_sender_end(struct batadv_priv *bat_priv,
434} 435}
435 436
436/** 437/**
437 * batadv_tp_sender_shutdown - let sender thread/timer stop gracefully 438 * batadv_tp_sender_shutdown() - let sender thread/timer stop gracefully
438 * @tp_vars: the private data of the current TP meter session 439 * @tp_vars: the private data of the current TP meter session
439 * @reason: reason for tp meter session stop 440 * @reason: reason for tp meter session stop
440 */ 441 */
@@ -448,7 +449,7 @@ static void batadv_tp_sender_shutdown(struct batadv_tp_vars *tp_vars,
448} 449}
449 450
450/** 451/**
451 * batadv_tp_sender_finish - stop sender session after test_length was reached 452 * batadv_tp_sender_finish() - stop sender session after test_length was reached
452 * @work: delayed work reference of the related tp_vars 453 * @work: delayed work reference of the related tp_vars
453 */ 454 */
454static void batadv_tp_sender_finish(struct work_struct *work) 455static void batadv_tp_sender_finish(struct work_struct *work)
@@ -464,7 +465,7 @@ static void batadv_tp_sender_finish(struct work_struct *work)
464} 465}
465 466
466/** 467/**
467 * batadv_tp_reset_sender_timer - reschedule the sender timer 468 * batadv_tp_reset_sender_timer() - reschedule the sender timer
468 * @tp_vars: the private TP meter data for this session 469 * @tp_vars: the private TP meter data for this session
469 * 470 *
470 * Reschedule the timer using tp_vars->rto as delay 471 * 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)
482} 483}
483 484
484/** 485/**
485 * batadv_tp_sender_timeout - timer that fires in case of packet loss 486 * batadv_tp_sender_timeout() - timer that fires in case of packet loss
486 * @arg: address of the related tp_vars 487 * @arg: address of the related tp_vars
487 * 488 *
488 * If fired it means that there was packet loss. 489 * If fired it means that there was packet loss.
@@ -532,7 +533,7 @@ static void batadv_tp_sender_timeout(struct timer_list *t)
532} 533}
533 534
534/** 535/**
535 * batadv_tp_fill_prerandom - Fill buffer with prefetched random bytes 536 * batadv_tp_fill_prerandom() - Fill buffer with prefetched random bytes
536 * @tp_vars: the private TP meter data for this session 537 * @tp_vars: the private TP meter data for this session
537 * @buf: Buffer to fill with bytes 538 * @buf: Buffer to fill with bytes
538 * @nbytes: amount of pseudorandom bytes 539 * @nbytes: amount of pseudorandom bytes
@@ -564,7 +565,7 @@ static void batadv_tp_fill_prerandom(struct batadv_tp_vars *tp_vars,
564} 565}
565 566
566/** 567/**
567 * batadv_tp_send_msg - send a single message 568 * batadv_tp_send_msg() - send a single message
568 * @tp_vars: the private TP meter data for this session 569 * @tp_vars: the private TP meter data for this session
569 * @src: source mac address 570 * @src: source mac address
570 * @orig_node: the originator of the destination 571 * @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,
624} 625}
625 626
626/** 627/**
627 * batadv_tp_recv_ack - ACK receiving function 628 * batadv_tp_recv_ack() - ACK receiving function
628 * @bat_priv: the bat priv with all the soft interface information 629 * @bat_priv: the bat priv with all the soft interface information
629 * @skb: the buffer containing the received packet 630 * @skb: the buffer containing the received packet
630 * 631 *
@@ -766,7 +767,7 @@ out:
766} 767}
767 768
768/** 769/**
769 * batadv_tp_avail - check if congestion window is not full 770 * batadv_tp_avail() - check if congestion window is not full
770 * @tp_vars: the private data of the current TP meter session 771 * @tp_vars: the private data of the current TP meter session
771 * @payload_len: size of the payload of a single message 772 * @payload_len: size of the payload of a single message
772 * 773 *
@@ -784,7 +785,7 @@ static bool batadv_tp_avail(struct batadv_tp_vars *tp_vars,
784} 785}
785 786
786/** 787/**
787 * batadv_tp_wait_available - wait until congestion window becomes free or 788 * batadv_tp_wait_available() - wait until congestion window becomes free or
788 * timeout is reached 789 * timeout is reached
789 * @tp_vars: the private data of the current TP meter session 790 * @tp_vars: the private data of the current TP meter session
790 * @plen: size of the payload of a single message 791 * @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)
806} 807}
807 808
808/** 809/**
809 * batadv_tp_send - main sending thread of a tp meter session 810 * batadv_tp_send() - main sending thread of a tp meter session
810 * @arg: address of the related tp_vars 811 * @arg: address of the related tp_vars
811 * 812 *
812 * Return: nothing, this function never returns 813 * Return: nothing, this function never returns
@@ -905,7 +906,8 @@ out:
905} 906}
906 907
907/** 908/**
908 * batadv_tp_start_kthread - start new thread which manages the tp meter sender 909 * batadv_tp_start_kthread() - start new thread which manages the tp meter
910 * sender
909 * @tp_vars: the private data of the current TP meter session 911 * @tp_vars: the private data of the current TP meter session
910 */ 912 */
911static void batadv_tp_start_kthread(struct batadv_tp_vars *tp_vars) 913static 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)
936} 938}
937 939
938/** 940/**
939 * batadv_tp_start - start a new tp meter session 941 * batadv_tp_start() - start a new tp meter session
940 * @bat_priv: the bat priv with all the soft interface information 942 * @bat_priv: the bat priv with all the soft interface information
941 * @dst: the receiver MAC address 943 * @dst: the receiver MAC address
942 * @test_length: test length in milliseconds 944 * @test_length: test length in milliseconds
@@ -1061,7 +1063,7 @@ void batadv_tp_start(struct batadv_priv *bat_priv, const u8 *dst,
1061} 1063}
1062 1064
1063/** 1065/**
1064 * batadv_tp_stop - stop currently running tp meter session 1066 * batadv_tp_stop() - stop currently running tp meter session
1065 * @bat_priv: the bat priv with all the soft interface information 1067 * @bat_priv: the bat priv with all the soft interface information
1066 * @dst: the receiver MAC address 1068 * @dst: the receiver MAC address
1067 * @return_value: reason for tp meter session stop 1069 * @return_value: reason for tp meter session stop
@@ -1093,7 +1095,7 @@ out:
1093} 1095}
1094 1096
1095/** 1097/**
1096 * batadv_tp_reset_receiver_timer - reset the receiver shutdown timer 1098 * batadv_tp_reset_receiver_timer() - reset the receiver shutdown timer
1097 * @tp_vars: the private data of the current TP meter session 1099 * @tp_vars: the private data of the current TP meter session
1098 * 1100 *
1099 * start the receiver shutdown timer or reset it if already started 1101 * 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)
1105} 1107}
1106 1108
1107/** 1109/**
1108 * batadv_tp_receiver_shutdown - stop a tp meter receiver when timeout is 1110 * batadv_tp_receiver_shutdown() - stop a tp meter receiver when timeout is
1109 * reached without received ack 1111 * reached without received ack
1110 * @arg: address of the related tp_vars 1112 * @arg: address of the related tp_vars
1111 */ 1113 */
@@ -1150,7 +1152,7 @@ static void batadv_tp_receiver_shutdown(struct timer_list *t)
1150} 1152}
1151 1153
1152/** 1154/**
1153 * batadv_tp_send_ack - send an ACK packet 1155 * batadv_tp_send_ack() - send an ACK packet
1154 * @bat_priv: the bat priv with all the soft interface information 1156 * @bat_priv: the bat priv with all the soft interface information
1155 * @dst: the mac address of the destination originator 1157 * @dst: the mac address of the destination originator
1156 * @seq: the sequence number to ACK 1158 * @seq: the sequence number to ACK
@@ -1222,7 +1224,7 @@ out:
1222} 1224}
1223 1225
1224/** 1226/**
1225 * batadv_tp_handle_out_of_order - store an out of order packet 1227 * batadv_tp_handle_out_of_order() - store an out of order packet
1226 * @tp_vars: the private data of the current TP meter session 1228 * @tp_vars: the private data of the current TP meter session
1227 * @skb: the buffer containing the received packet 1229 * @skb: the buffer containing the received packet
1228 * 1230 *
@@ -1298,7 +1300,7 @@ out:
1298} 1300}
1299 1301
1300/** 1302/**
1301 * batadv_tp_ack_unordered - update number received bytes in current stream 1303 * batadv_tp_ack_unordered() - update number received bytes in current stream
1302 * without gaps 1304 * without gaps
1303 * @tp_vars: the private data of the current TP meter session 1305 * @tp_vars: the private data of the current TP meter session
1304 */ 1306 */
@@ -1331,7 +1333,7 @@ static void batadv_tp_ack_unordered(struct batadv_tp_vars *tp_vars)
1331} 1333}
1332 1334
1333/** 1335/**
1334 * batadv_tp_init_recv - return matching or create new receiver tp_vars 1336 * batadv_tp_init_recv() - return matching or create new receiver tp_vars
1335 * @bat_priv: the bat priv with all the soft interface information 1337 * @bat_priv: the bat priv with all the soft interface information
1336 * @icmp: received icmp tp msg 1338 * @icmp: received icmp tp msg
1337 * 1339 *
@@ -1384,7 +1386,7 @@ out_unlock:
1384} 1386}
1385 1387
1386/** 1388/**
1387 * batadv_tp_recv_msg - process a single data message 1389 * batadv_tp_recv_msg() - process a single data message
1388 * @bat_priv: the bat priv with all the soft interface information 1390 * @bat_priv: the bat priv with all the soft interface information
1389 * @skb: the buffer containing the received packet 1391 * @skb: the buffer containing the received packet
1390 * 1392 *
@@ -1469,7 +1471,7 @@ out:
1469} 1471}
1470 1472
1471/** 1473/**
1472 * batadv_tp_meter_recv - main TP Meter receiving function 1474 * batadv_tp_meter_recv() - main TP Meter receiving function
1473 * @bat_priv: the bat priv with all the soft interface information 1475 * @bat_priv: the bat priv with all the soft interface information
1474 * @skb: the buffer containing the received packet 1476 * @skb: the buffer containing the received packet
1475 */ 1477 */
@@ -1495,7 +1497,7 @@ void batadv_tp_meter_recv(struct batadv_priv *bat_priv, struct sk_buff *skb)
1495} 1497}
1496 1498
1497/** 1499/**
1498 * batadv_tp_meter_init - initialize global tp_meter structures 1500 * batadv_tp_meter_init() - initialize global tp_meter structures
1499 */ 1501 */
1500void __init batadv_tp_meter_init(void) 1502void __init batadv_tp_meter_init(void)
1501{ 1503{
diff --git a/net/batman-adv/translation-table.c b/net/batman-adv/translation-table.c
index b4b20ad1ed9a..8b583d3e86e6 100644
--- a/net/batman-adv/translation-table.c
+++ b/net/batman-adv/translation-table.c
@@ -88,7 +88,7 @@ static void batadv_tt_global_del(struct batadv_priv *bat_priv,
88 bool roaming); 88 bool roaming);
89 89
90/** 90/**
91 * batadv_compare_tt - check if two TT entries are the same 91 * batadv_compare_tt() - check if two TT entries are the same
92 * @node: the list element pointer of the first TT entry 92 * @node: the list element pointer of the first TT entry
93 * @data2: pointer to the tt_common_entry of the second TT entry 93 * @data2: pointer to the tt_common_entry of the second TT entry
94 * 94 *
@@ -107,7 +107,7 @@ static bool batadv_compare_tt(const struct hlist_node *node, const void *data2)
107} 107}
108 108
109/** 109/**
110 * batadv_choose_tt - return the index of the tt entry in the hash table 110 * batadv_choose_tt() - return the index of the tt entry in the hash table
111 * @data: pointer to the tt_common_entry object to map 111 * @data: pointer to the tt_common_entry object to map
112 * @size: the size of the hash table 112 * @size: the size of the hash table
113 * 113 *
@@ -127,7 +127,7 @@ static inline u32 batadv_choose_tt(const void *data, u32 size)
127} 127}
128 128
129/** 129/**
130 * batadv_tt_hash_find - look for a client in the given hash table 130 * batadv_tt_hash_find() - look for a client in the given hash table
131 * @hash: the hash table to search 131 * @hash: the hash table to search
132 * @addr: the mac address of the client to look for 132 * @addr: the mac address of the client to look for
133 * @vid: VLAN identifier 133 * @vid: VLAN identifier
@@ -172,7 +172,7 @@ batadv_tt_hash_find(struct batadv_hashtable *hash, const u8 *addr,
172} 172}
173 173
174/** 174/**
175 * batadv_tt_local_hash_find - search the local table for a given client 175 * batadv_tt_local_hash_find() - search the local table for a given client
176 * @bat_priv: the bat priv with all the soft interface information 176 * @bat_priv: the bat priv with all the soft interface information
177 * @addr: the mac address of the client to look for 177 * @addr: the mac address of the client to look for
178 * @vid: VLAN identifier 178 * @vid: VLAN identifier
@@ -197,7 +197,7 @@ batadv_tt_local_hash_find(struct batadv_priv *bat_priv, const u8 *addr,
197} 197}
198 198
199/** 199/**
200 * batadv_tt_global_hash_find - search the global table for a given client 200 * batadv_tt_global_hash_find() - search the global table for a given client
201 * @bat_priv: the bat priv with all the soft interface information 201 * @bat_priv: the bat priv with all the soft interface information
202 * @addr: the mac address of the client to look for 202 * @addr: the mac address of the client to look for
203 * @vid: VLAN identifier 203 * @vid: VLAN identifier
@@ -222,7 +222,7 @@ batadv_tt_global_hash_find(struct batadv_priv *bat_priv, const u8 *addr,
222} 222}
223 223
224/** 224/**
225 * batadv_tt_local_entry_free_rcu - free the tt_local_entry 225 * batadv_tt_local_entry_free_rcu() - free the tt_local_entry
226 * @rcu: rcu pointer of the tt_local_entry 226 * @rcu: rcu pointer of the tt_local_entry
227 */ 227 */
228static void batadv_tt_local_entry_free_rcu(struct rcu_head *rcu) 228static 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)
236} 236}
237 237
238/** 238/**
239 * batadv_tt_local_entry_release - release tt_local_entry from lists and queue 239 * batadv_tt_local_entry_release() - release tt_local_entry from lists and queue
240 * for free after rcu grace period 240 * for free after rcu grace period
241 * @ref: kref pointer of the nc_node 241 * @ref: kref pointer of the nc_node
242 */ 242 */
@@ -253,7 +253,7 @@ static void batadv_tt_local_entry_release(struct kref *ref)
253} 253}
254 254
255/** 255/**
256 * batadv_tt_local_entry_put - decrement the tt_local_entry refcounter and 256 * batadv_tt_local_entry_put() - decrement the tt_local_entry refcounter and
257 * possibly release it 257 * possibly release it
258 * @tt_local_entry: tt_local_entry to be free'd 258 * @tt_local_entry: tt_local_entry to be free'd
259 */ 259 */
@@ -265,7 +265,7 @@ batadv_tt_local_entry_put(struct batadv_tt_local_entry *tt_local_entry)
265} 265}
266 266
267/** 267/**
268 * batadv_tt_global_entry_free_rcu - free the tt_global_entry 268 * batadv_tt_global_entry_free_rcu() - free the tt_global_entry
269 * @rcu: rcu pointer of the tt_global_entry 269 * @rcu: rcu pointer of the tt_global_entry
270 */ 270 */
271static void batadv_tt_global_entry_free_rcu(struct rcu_head *rcu) 271static 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)
279} 279}
280 280
281/** 281/**
282 * batadv_tt_global_entry_release - release tt_global_entry from lists and queue 282 * batadv_tt_global_entry_release() - release tt_global_entry from lists and
283 * for free after rcu grace period 283 * queue for free after rcu grace period
284 * @ref: kref pointer of the nc_node 284 * @ref: kref pointer of the nc_node
285 */ 285 */
286static void batadv_tt_global_entry_release(struct kref *ref) 286static void batadv_tt_global_entry_release(struct kref *ref)
@@ -296,7 +296,7 @@ static void batadv_tt_global_entry_release(struct kref *ref)
296} 296}
297 297
298/** 298/**
299 * batadv_tt_global_entry_put - decrement the tt_global_entry refcounter and 299 * batadv_tt_global_entry_put() - decrement the tt_global_entry refcounter and
300 * possibly release it 300 * possibly release it
301 * @tt_global_entry: tt_global_entry to be free'd 301 * @tt_global_entry: tt_global_entry to be free'd
302 */ 302 */
@@ -308,7 +308,7 @@ batadv_tt_global_entry_put(struct batadv_tt_global_entry *tt_global_entry)
308} 308}
309 309
310/** 310/**
311 * batadv_tt_global_hash_count - count the number of orig entries 311 * batadv_tt_global_hash_count() - count the number of orig entries
312 * @bat_priv: the bat priv with all the soft interface information 312 * @bat_priv: the bat priv with all the soft interface information
313 * @addr: the mac address of the client to count entries for 313 * @addr: the mac address of the client to count entries for
314 * @vid: VLAN identifier 314 * @vid: VLAN identifier
@@ -333,8 +333,8 @@ int batadv_tt_global_hash_count(struct batadv_priv *bat_priv,
333} 333}
334 334
335/** 335/**
336 * batadv_tt_local_size_mod - change the size by v of the local table identified 336 * batadv_tt_local_size_mod() - change the size by v of the local table
337 * by vid 337 * identified by vid
338 * @bat_priv: the bat priv with all the soft interface information 338 * @bat_priv: the bat priv with all the soft interface information
339 * @vid: the VLAN identifier of the sub-table to change 339 * @vid: the VLAN identifier of the sub-table to change
340 * @v: the amount to sum to the local table size 340 * @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,
354} 354}
355 355
356/** 356/**
357 * batadv_tt_local_size_inc - increase by one the local table size for the given 357 * batadv_tt_local_size_inc() - increase by one the local table size for the
358 * vid 358 * given vid
359 * @bat_priv: the bat priv with all the soft interface information 359 * @bat_priv: the bat priv with all the soft interface information
360 * @vid: the VLAN identifier 360 * @vid: the VLAN identifier
361 */ 361 */
@@ -366,8 +366,8 @@ static void batadv_tt_local_size_inc(struct batadv_priv *bat_priv,
366} 366}
367 367
368/** 368/**
369 * batadv_tt_local_size_dec - decrease by one the local table size for the given 369 * batadv_tt_local_size_dec() - decrease by one the local table size for the
370 * vid 370 * given vid
371 * @bat_priv: the bat priv with all the soft interface information 371 * @bat_priv: the bat priv with all the soft interface information
372 * @vid: the VLAN identifier 372 * @vid: the VLAN identifier
373 */ 373 */
@@ -378,7 +378,7 @@ static void batadv_tt_local_size_dec(struct batadv_priv *bat_priv,
378} 378}
379 379
380/** 380/**
381 * batadv_tt_global_size_mod - change the size by v of the global table 381 * batadv_tt_global_size_mod() - change the size by v of the global table
382 * for orig_node identified by vid 382 * for orig_node identified by vid
383 * @orig_node: the originator for which the table has to be modified 383 * @orig_node: the originator for which the table has to be modified
384 * @vid: the VLAN identifier 384 * @vid: the VLAN identifier
@@ -406,7 +406,7 @@ static void batadv_tt_global_size_mod(struct batadv_orig_node *orig_node,
406} 406}
407 407
408/** 408/**
409 * batadv_tt_global_size_inc - increase by one the global table size for the 409 * batadv_tt_global_size_inc() - increase by one the global table size for the
410 * given vid 410 * given vid
411 * @orig_node: the originator which global table size has to be decreased 411 * @orig_node: the originator which global table size has to be decreased
412 * @vid: the vlan identifier 412 * @vid: the vlan identifier
@@ -418,7 +418,7 @@ static void batadv_tt_global_size_inc(struct batadv_orig_node *orig_node,
418} 418}
419 419
420/** 420/**
421 * batadv_tt_global_size_dec - decrease by one the global table size for the 421 * batadv_tt_global_size_dec() - decrease by one the global table size for the
422 * given vid 422 * given vid
423 * @orig_node: the originator which global table size has to be decreased 423 * @orig_node: the originator which global table size has to be decreased
424 * @vid: the vlan identifier 424 * @vid: the vlan identifier
@@ -430,7 +430,7 @@ static void batadv_tt_global_size_dec(struct batadv_orig_node *orig_node,
430} 430}
431 431
432/** 432/**
433 * batadv_tt_orig_list_entry_free_rcu - free the orig_entry 433 * batadv_tt_orig_list_entry_free_rcu() - free the orig_entry
434 * @rcu: rcu pointer of the orig_entry 434 * @rcu: rcu pointer of the orig_entry
435 */ 435 */
436static void batadv_tt_orig_list_entry_free_rcu(struct rcu_head *rcu) 436static 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)
443} 443}
444 444
445/** 445/**
446 * batadv_tt_orig_list_entry_release - release tt orig entry from lists and 446 * batadv_tt_orig_list_entry_release() - release tt orig entry from lists and
447 * queue for free after rcu grace period 447 * queue for free after rcu grace period
448 * @ref: kref pointer of the tt orig entry 448 * @ref: kref pointer of the tt orig entry
449 */ 449 */
@@ -459,7 +459,7 @@ static void batadv_tt_orig_list_entry_release(struct kref *ref)
459} 459}
460 460
461/** 461/**
462 * batadv_tt_orig_list_entry_put - decrement the tt orig entry refcounter and 462 * batadv_tt_orig_list_entry_put() - decrement the tt orig entry refcounter and
463 * possibly release it 463 * possibly release it
464 * @orig_entry: tt orig entry to be free'd 464 * @orig_entry: tt orig entry to be free'd
465 */ 465 */
@@ -470,7 +470,7 @@ batadv_tt_orig_list_entry_put(struct batadv_tt_orig_list_entry *orig_entry)
470} 470}
471 471
472/** 472/**
473 * batadv_tt_local_event - store a local TT event (ADD/DEL) 473 * batadv_tt_local_event() - store a local TT event (ADD/DEL)
474 * @bat_priv: the bat priv with all the soft interface information 474 * @bat_priv: the bat priv with all the soft interface information
475 * @tt_local_entry: the TT entry involved in the event 475 * @tt_local_entry: the TT entry involved in the event
476 * @event_flags: flags to store in the event structure 476 * @event_flags: flags to store in the event structure
@@ -545,7 +545,7 @@ unlock:
545} 545}
546 546
547/** 547/**
548 * batadv_tt_len - compute length in bytes of given number of tt changes 548 * batadv_tt_len() - compute length in bytes of given number of tt changes
549 * @changes_num: number of tt changes 549 * @changes_num: number of tt changes
550 * 550 *
551 * Return: computed length in bytes. 551 * Return: computed length in bytes.
@@ -556,7 +556,7 @@ static int batadv_tt_len(int changes_num)
556} 556}
557 557
558/** 558/**
559 * batadv_tt_entries - compute the number of entries fitting in tt_len bytes 559 * batadv_tt_entries() - compute the number of entries fitting in tt_len bytes
560 * @tt_len: available space 560 * @tt_len: available space
561 * 561 *
562 * Return: the number of entries. 562 * Return: the number of entries.
@@ -567,8 +567,8 @@ static u16 batadv_tt_entries(u16 tt_len)
567} 567}
568 568
569/** 569/**
570 * batadv_tt_local_table_transmit_size - calculates the local translation table 570 * batadv_tt_local_table_transmit_size() - calculates the local translation
571 * size when transmitted over the air 571 * table size when transmitted over the air
572 * @bat_priv: the bat priv with all the soft interface information 572 * @bat_priv: the bat priv with all the soft interface information
573 * 573 *
574 * Return: local translation table size in bytes. 574 * Return: local translation table size in bytes.
@@ -627,7 +627,7 @@ static void batadv_tt_global_free(struct batadv_priv *bat_priv,
627} 627}
628 628
629/** 629/**
630 * batadv_tt_local_add - add a new client to the local table or update an 630 * batadv_tt_local_add() - add a new client to the local table or update an
631 * existing client 631 * existing client
632 * @soft_iface: netdev struct of the mesh interface 632 * @soft_iface: netdev struct of the mesh interface
633 * @addr: the mac address of the client to add 633 * @addr: the mac address of the client to add
@@ -832,7 +832,7 @@ out:
832} 832}
833 833
834/** 834/**
835 * batadv_tt_prepare_tvlv_global_data - prepare the TVLV TT header to send 835 * batadv_tt_prepare_tvlv_global_data() - prepare the TVLV TT header to send
836 * within a TT Response directed to another node 836 * within a TT Response directed to another node
837 * @orig_node: originator for which the TT data has to be prepared 837 * @orig_node: originator for which the TT data has to be prepared
838 * @tt_data: uninitialised pointer to the address of the TVLV buffer 838 * @tt_data: uninitialised pointer to the address of the TVLV buffer
@@ -905,8 +905,8 @@ out:
905} 905}
906 906
907/** 907/**
908 * batadv_tt_prepare_tvlv_local_data - allocate and prepare the TT TVLV for this 908 * batadv_tt_prepare_tvlv_local_data() - allocate and prepare the TT TVLV for
909 * node 909 * this node
910 * @bat_priv: the bat priv with all the soft interface information 910 * @bat_priv: the bat priv with all the soft interface information
911 * @tt_data: uninitialised pointer to the address of the TVLV buffer 911 * @tt_data: uninitialised pointer to the address of the TVLV buffer
912 * @tt_change: uninitialised pointer to the address of the area where the TT 912 * @tt_change: uninitialised pointer to the address of the area where the TT
@@ -979,8 +979,8 @@ out:
979} 979}
980 980
981/** 981/**
982 * batadv_tt_tvlv_container_update - update the translation table tvlv container 982 * batadv_tt_tvlv_container_update() - update the translation table tvlv
983 * after local tt changes have been committed 983 * container after local tt changes have been committed
984 * @bat_priv: the bat priv with all the soft interface information 984 * @bat_priv: the bat priv with all the soft interface information
985 */ 985 */
986static void batadv_tt_tvlv_container_update(struct batadv_priv *bat_priv) 986static void batadv_tt_tvlv_container_update(struct batadv_priv *bat_priv)
@@ -1125,7 +1125,7 @@ out:
1125#endif 1125#endif
1126 1126
1127/** 1127/**
1128 * batadv_tt_local_dump_entry - Dump one TT local entry into a message 1128 * batadv_tt_local_dump_entry() - Dump one TT local entry into a message
1129 * @msg :Netlink message to dump into 1129 * @msg :Netlink message to dump into
1130 * @portid: Port making netlink request 1130 * @portid: Port making netlink request
1131 * @seq: Sequence number of netlink message 1131 * @seq: Sequence number of netlink message
@@ -1181,7 +1181,7 @@ batadv_tt_local_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
1181} 1181}
1182 1182
1183/** 1183/**
1184 * batadv_tt_local_dump_bucket - Dump one TT local bucket into a message 1184 * batadv_tt_local_dump_bucket() - Dump one TT local bucket into a message
1185 * @msg: Netlink message to dump into 1185 * @msg: Netlink message to dump into
1186 * @portid: Port making netlink request 1186 * @portid: Port making netlink request
1187 * @seq: Sequence number of netlink message 1187 * @seq: Sequence number of netlink message
@@ -1218,7 +1218,7 @@ batadv_tt_local_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
1218} 1218}
1219 1219
1220/** 1220/**
1221 * batadv_tt_local_dump - Dump TT local entries into a message 1221 * batadv_tt_local_dump() - Dump TT local entries into a message
1222 * @msg: Netlink message to dump into 1222 * @msg: Netlink message to dump into
1223 * @cb: Parameters from query 1223 * @cb: Parameters from query
1224 * 1224 *
@@ -1302,7 +1302,7 @@ batadv_tt_local_set_pending(struct batadv_priv *bat_priv,
1302} 1302}
1303 1303
1304/** 1304/**
1305 * batadv_tt_local_remove - logically remove an entry from the local table 1305 * batadv_tt_local_remove() - logically remove an entry from the local table
1306 * @bat_priv: the bat priv with all the soft interface information 1306 * @bat_priv: the bat priv with all the soft interface information
1307 * @addr: the MAC address of the client to remove 1307 * @addr: the MAC address of the client to remove
1308 * @vid: VLAN identifier 1308 * @vid: VLAN identifier
@@ -1364,7 +1364,7 @@ out:
1364} 1364}
1365 1365
1366/** 1366/**
1367 * batadv_tt_local_purge_list - purge inactive tt local entries 1367 * batadv_tt_local_purge_list() - purge inactive tt local entries
1368 * @bat_priv: the bat priv with all the soft interface information 1368 * @bat_priv: the bat priv with all the soft interface information
1369 * @head: pointer to the list containing the local tt entries 1369 * @head: pointer to the list containing the local tt entries
1370 * @timeout: parameter deciding whether a given tt local entry is considered 1370 * @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,
1399} 1399}
1400 1400
1401/** 1401/**
1402 * batadv_tt_local_purge - purge inactive tt local entries 1402 * batadv_tt_local_purge() - purge inactive tt local entries
1403 * @bat_priv: the bat priv with all the soft interface information 1403 * @bat_priv: the bat priv with all the soft interface information
1404 * @timeout: parameter deciding whether a given tt local entry is considered 1404 * @timeout: parameter deciding whether a given tt local entry is considered
1405 * inactive or not 1405 * inactive or not
@@ -1492,7 +1492,7 @@ static void batadv_tt_changes_list_free(struct batadv_priv *bat_priv)
1492} 1492}
1493 1493
1494/** 1494/**
1495 * batadv_tt_global_orig_entry_find - find a TT orig_list_entry 1495 * batadv_tt_global_orig_entry_find() - find a TT orig_list_entry
1496 * @entry: the TT global entry where the orig_list_entry has to be 1496 * @entry: the TT global entry where the orig_list_entry has to be
1497 * extracted from 1497 * extracted from
1498 * @orig_node: the originator for which the orig_list_entry has to be found 1498 * @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,
1526} 1526}
1527 1527
1528/** 1528/**
1529 * batadv_tt_global_entry_has_orig - check if a TT global entry is also handled 1529 * batadv_tt_global_entry_has_orig() - check if a TT global entry is also
1530 * by a given originator 1530 * handled by a given originator
1531 * @entry: the TT global entry to check 1531 * @entry: the TT global entry to check
1532 * @orig_node: the originator to search in the list 1532 * @orig_node: the originator to search in the list
1533 * 1533 *
@@ -1552,7 +1552,7 @@ batadv_tt_global_entry_has_orig(const struct batadv_tt_global_entry *entry,
1552} 1552}
1553 1553
1554/** 1554/**
1555 * batadv_tt_global_sync_flags - update TT sync flags 1555 * batadv_tt_global_sync_flags() - update TT sync flags
1556 * @tt_global: the TT global entry to update sync flags in 1556 * @tt_global: the TT global entry to update sync flags in
1557 * 1557 *
1558 * Updates the sync flag bits in the tt_global flag attribute with a logical 1558 * 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)
1576} 1576}
1577 1577
1578/** 1578/**
1579 * batadv_tt_global_orig_entry_add - add or update a TT orig entry 1579 * batadv_tt_global_orig_entry_add() - add or update a TT orig entry
1580 * @tt_global: the TT global entry to add an orig entry in 1580 * @tt_global: the TT global entry to add an orig entry in
1581 * @orig_node: the originator to add an orig entry for 1581 * @orig_node: the originator to add an orig entry for
1582 * @ttvn: translation table version number of this changeset 1582 * @ttvn: translation table version number of this changeset
@@ -1626,7 +1626,7 @@ out:
1626} 1626}
1627 1627
1628/** 1628/**
1629 * batadv_tt_global_add - add a new TT global entry or update an existing one 1629 * batadv_tt_global_add() - add a new TT global entry or update an existing one
1630 * @bat_priv: the bat priv with all the soft interface information 1630 * @bat_priv: the bat priv with all the soft interface information
1631 * @orig_node: the originator announcing the client 1631 * @orig_node: the originator announcing the client
1632 * @tt_addr: the mac address of the non-mesh client 1632 * @tt_addr: the mac address of the non-mesh client
@@ -1798,7 +1798,7 @@ out:
1798} 1798}
1799 1799
1800/** 1800/**
1801 * batadv_transtable_best_orig - Get best originator list entry from tt entry 1801 * batadv_transtable_best_orig() - Get best originator list entry from tt entry
1802 * @bat_priv: the bat priv with all the soft interface information 1802 * @bat_priv: the bat priv with all the soft interface information
1803 * @tt_global_entry: global translation table entry to be analyzed 1803 * @tt_global_entry: global translation table entry to be analyzed
1804 * 1804 *
@@ -1844,8 +1844,8 @@ batadv_transtable_best_orig(struct batadv_priv *bat_priv,
1844 1844
1845#ifdef CONFIG_BATMAN_ADV_DEBUGFS 1845#ifdef CONFIG_BATMAN_ADV_DEBUGFS
1846/** 1846/**
1847 * batadv_tt_global_print_entry - print all orig nodes who announce the address 1847 * batadv_tt_global_print_entry() - print all orig nodes who announce the
1848 * for this global entry 1848 * address for this global entry
1849 * @bat_priv: the bat priv with all the soft interface information 1849 * @bat_priv: the bat priv with all the soft interface information
1850 * @tt_global_entry: global translation table entry to be printed 1850 * @tt_global_entry: global translation table entry to be printed
1851 * @seq: debugfs table seq_file struct 1851 * @seq: debugfs table seq_file struct
@@ -1969,7 +1969,7 @@ out:
1969#endif 1969#endif
1970 1970
1971/** 1971/**
1972 * batadv_tt_global_dump_subentry - Dump all TT local entries into a message 1972 * batadv_tt_global_dump_subentry() - Dump all TT local entries into a message
1973 * @msg: Netlink message to dump into 1973 * @msg: Netlink message to dump into
1974 * @portid: Port making netlink request 1974 * @portid: Port making netlink request
1975 * @seq: Sequence number of netlink message 1975 * @seq: Sequence number of netlink message
@@ -2030,7 +2030,7 @@ batadv_tt_global_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq,
2030} 2030}
2031 2031
2032/** 2032/**
2033 * batadv_tt_global_dump_entry - Dump one TT global entry into a message 2033 * batadv_tt_global_dump_entry() - Dump one TT global entry into a message
2034 * @msg: Netlink message to dump into 2034 * @msg: Netlink message to dump into
2035 * @portid: Port making netlink request 2035 * @portid: Port making netlink request
2036 * @seq: Sequence number of netlink message 2036 * @seq: Sequence number of netlink message
@@ -2075,7 +2075,7 @@ batadv_tt_global_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
2075} 2075}
2076 2076
2077/** 2077/**
2078 * batadv_tt_global_dump_bucket - Dump one TT local bucket into a message 2078 * batadv_tt_global_dump_bucket() - Dump one TT local bucket into a message
2079 * @msg: Netlink message to dump into 2079 * @msg: Netlink message to dump into
2080 * @portid: Port making netlink request 2080 * @portid: Port making netlink request
2081 * @seq: Sequence number of netlink message 2081 * @seq: Sequence number of netlink message
@@ -2114,7 +2114,7 @@ batadv_tt_global_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
2114} 2114}
2115 2115
2116/** 2116/**
2117 * batadv_tt_global_dump - Dump TT global entries into a message 2117 * batadv_tt_global_dump() - Dump TT global entries into a message
2118 * @msg: Netlink message to dump into 2118 * @msg: Netlink message to dump into
2119 * @cb: Parameters from query 2119 * @cb: Parameters from query
2120 * 2120 *
@@ -2182,7 +2182,7 @@ int batadv_tt_global_dump(struct sk_buff *msg, struct netlink_callback *cb)
2182} 2182}
2183 2183
2184/** 2184/**
2185 * _batadv_tt_global_del_orig_entry - remove and free an orig_entry 2185 * _batadv_tt_global_del_orig_entry() - remove and free an orig_entry
2186 * @tt_global_entry: the global entry to remove the orig_entry from 2186 * @tt_global_entry: the global entry to remove the orig_entry from
2187 * @orig_entry: the orig entry to remove and free 2187 * @orig_entry: the orig entry to remove and free
2188 * 2188 *
@@ -2224,7 +2224,7 @@ batadv_tt_global_del_orig_list(struct batadv_tt_global_entry *tt_global_entry)
2224} 2224}
2225 2225
2226/** 2226/**
2227 * batadv_tt_global_del_orig_node - remove orig_node from a global tt entry 2227 * batadv_tt_global_del_orig_node() - remove orig_node from a global tt entry
2228 * @bat_priv: the bat priv with all the soft interface information 2228 * @bat_priv: the bat priv with all the soft interface information
2229 * @tt_global_entry: the global entry to remove the orig_node from 2229 * @tt_global_entry: the global entry to remove the orig_node from
2230 * @orig_node: the originator announcing the client 2230 * @orig_node: the originator announcing the client
@@ -2303,7 +2303,7 @@ batadv_tt_global_del_roaming(struct batadv_priv *bat_priv,
2303} 2303}
2304 2304
2305/** 2305/**
2306 * batadv_tt_global_del - remove a client from the global table 2306 * batadv_tt_global_del() - remove a client from the global table
2307 * @bat_priv: the bat priv with all the soft interface information 2307 * @bat_priv: the bat priv with all the soft interface information
2308 * @orig_node: an originator serving this client 2308 * @orig_node: an originator serving this client
2309 * @addr: the mac address of the client 2309 * @addr: the mac address of the client
@@ -2369,8 +2369,8 @@ out:
2369} 2369}
2370 2370
2371/** 2371/**
2372 * batadv_tt_global_del_orig - remove all the TT global entries belonging to the 2372 * batadv_tt_global_del_orig() - remove all the TT global entries belonging to
2373 * given originator matching the provided vid 2373 * the given originator matching the provided vid
2374 * @bat_priv: the bat priv with all the soft interface information 2374 * @bat_priv: the bat priv with all the soft interface information
2375 * @orig_node: the originator owning the entries to remove 2375 * @orig_node: the originator owning the entries to remove
2376 * @match_vid: the VLAN identifier to match. If negative all the entries will be 2376 * @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,
2541} 2541}
2542 2542
2543/** 2543/**
2544 * batadv_transtable_search - get the mesh destination for a given client 2544 * batadv_transtable_search() - get the mesh destination for a given client
2545 * @bat_priv: the bat priv with all the soft interface information 2545 * @bat_priv: the bat priv with all the soft interface information
2546 * @src: mac address of the source client 2546 * @src: mac address of the source client
2547 * @addr: mac address of the destination client 2547 * @addr: mac address of the destination client
@@ -2601,7 +2601,7 @@ out:
2601} 2601}
2602 2602
2603/** 2603/**
2604 * batadv_tt_global_crc - calculates the checksum of the local table belonging 2604 * batadv_tt_global_crc() - calculates the checksum of the local table belonging
2605 * to the given orig_node 2605 * to the given orig_node
2606 * @bat_priv: the bat priv with all the soft interface information 2606 * @bat_priv: the bat priv with all the soft interface information
2607 * @orig_node: originator for which the CRC should be computed 2607 * @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,
2696} 2696}
2697 2697
2698/** 2698/**
2699 * batadv_tt_local_crc - calculates the checksum of the local table 2699 * batadv_tt_local_crc() - calculates the checksum of the local table
2700 * @bat_priv: the bat priv with all the soft interface information 2700 * @bat_priv: the bat priv with all the soft interface information
2701 * @vid: VLAN identifier for which the CRC32 has to be computed 2701 * @vid: VLAN identifier for which the CRC32 has to be computed
2702 * 2702 *
@@ -2753,7 +2753,7 @@ static u32 batadv_tt_local_crc(struct batadv_priv *bat_priv,
2753} 2753}
2754 2754
2755/** 2755/**
2756 * batadv_tt_req_node_release - free tt_req node entry 2756 * batadv_tt_req_node_release() - free tt_req node entry
2757 * @ref: kref pointer of the tt req_node entry 2757 * @ref: kref pointer of the tt req_node entry
2758 */ 2758 */
2759static void batadv_tt_req_node_release(struct kref *ref) 2759static void batadv_tt_req_node_release(struct kref *ref)
@@ -2766,7 +2766,7 @@ static void batadv_tt_req_node_release(struct kref *ref)
2766} 2766}
2767 2767
2768/** 2768/**
2769 * batadv_tt_req_node_put - decrement the tt_req_node refcounter and 2769 * batadv_tt_req_node_put() - decrement the tt_req_node refcounter and
2770 * possibly release it 2770 * possibly release it
2771 * @tt_req_node: tt_req_node to be free'd 2771 * @tt_req_node: tt_req_node to be free'd
2772 */ 2772 */
@@ -2828,7 +2828,7 @@ static void batadv_tt_req_purge(struct batadv_priv *bat_priv)
2828} 2828}
2829 2829
2830/** 2830/**
2831 * batadv_tt_req_node_new - search and possibly create a tt_req_node object 2831 * batadv_tt_req_node_new() - search and possibly create a tt_req_node object
2832 * @bat_priv: the bat priv with all the soft interface information 2832 * @bat_priv: the bat priv with all the soft interface information
2833 * @orig_node: orig node this request is being issued for 2833 * @orig_node: orig node this request is being issued for
2834 * 2834 *
@@ -2865,7 +2865,7 @@ unlock:
2865} 2865}
2866 2866
2867/** 2867/**
2868 * batadv_tt_local_valid - verify that given tt entry is a valid one 2868 * batadv_tt_local_valid() - verify that given tt entry is a valid one
2869 * @entry_ptr: to be checked local tt entry 2869 * @entry_ptr: to be checked local tt entry
2870 * @data_ptr: not used but definition required to satisfy the callback prototype 2870 * @data_ptr: not used but definition required to satisfy the callback prototype
2871 * 2871 *
@@ -2899,7 +2899,7 @@ static bool batadv_tt_global_valid(const void *entry_ptr,
2899} 2899}
2900 2900
2901/** 2901/**
2902 * batadv_tt_tvlv_generate - fill the tvlv buff with the tt entries from the 2902 * batadv_tt_tvlv_generate() - fill the tvlv buff with the tt entries from the
2903 * specified tt hash 2903 * specified tt hash
2904 * @bat_priv: the bat priv with all the soft interface information 2904 * @bat_priv: the bat priv with all the soft interface information
2905 * @hash: hash table containing the tt entries 2905 * @hash: hash table containing the tt entries
@@ -2950,7 +2950,7 @@ static void batadv_tt_tvlv_generate(struct batadv_priv *bat_priv,
2950} 2950}
2951 2951
2952/** 2952/**
2953 * batadv_tt_global_check_crc - check if all the CRCs are correct 2953 * batadv_tt_global_check_crc() - check if all the CRCs are correct
2954 * @orig_node: originator for which the CRCs have to be checked 2954 * @orig_node: originator for which the CRCs have to be checked
2955 * @tt_vlan: pointer to the first tvlv VLAN entry 2955 * @tt_vlan: pointer to the first tvlv VLAN entry
2956 * @num_vlan: number of tvlv VLAN entries 2956 * @num_vlan: number of tvlv VLAN entries
@@ -3007,7 +3007,7 @@ static bool batadv_tt_global_check_crc(struct batadv_orig_node *orig_node,
3007} 3007}
3008 3008
3009/** 3009/**
3010 * batadv_tt_local_update_crc - update all the local CRCs 3010 * batadv_tt_local_update_crc() - update all the local CRCs
3011 * @bat_priv: the bat priv with all the soft interface information 3011 * @bat_priv: the bat priv with all the soft interface information
3012 */ 3012 */
3013static void batadv_tt_local_update_crc(struct batadv_priv *bat_priv) 3013static 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)
3023} 3023}
3024 3024
3025/** 3025/**
3026 * batadv_tt_global_update_crc - update all the global CRCs for this orig_node 3026 * batadv_tt_global_update_crc() - update all the global CRCs for this orig_node
3027 * @bat_priv: the bat priv with all the soft interface information 3027 * @bat_priv: the bat priv with all the soft interface information
3028 * @orig_node: the orig_node for which the CRCs have to be updated 3028 * @orig_node: the orig_node for which the CRCs have to be updated
3029 */ 3029 */
@@ -3050,7 +3050,7 @@ static void batadv_tt_global_update_crc(struct batadv_priv *bat_priv,
3050} 3050}
3051 3051
3052/** 3052/**
3053 * batadv_send_tt_request - send a TT Request message to a given node 3053 * batadv_send_tt_request() - send a TT Request message to a given node
3054 * @bat_priv: the bat priv with all the soft interface information 3054 * @bat_priv: the bat priv with all the soft interface information
3055 * @dst_orig_node: the destination of the message 3055 * @dst_orig_node: the destination of the message
3056 * @ttvn: the version number that the source of the message is looking for 3056 * @ttvn: the version number that the source of the message is looking for
@@ -3139,7 +3139,7 @@ out:
3139} 3139}
3140 3140
3141/** 3141/**
3142 * batadv_send_other_tt_response - send reply to tt request concerning another 3142 * batadv_send_other_tt_response() - send reply to tt request concerning another
3143 * node's translation table 3143 * node's translation table
3144 * @bat_priv: the bat priv with all the soft interface information 3144 * @bat_priv: the bat priv with all the soft interface information
3145 * @tt_data: tt data containing the tt request information 3145 * @tt_data: tt data containing the tt request information
@@ -3272,8 +3272,8 @@ out:
3272} 3272}
3273 3273
3274/** 3274/**
3275 * batadv_send_my_tt_response - send reply to tt request concerning this node's 3275 * batadv_send_my_tt_response() - send reply to tt request concerning this
3276 * translation table 3276 * node's translation table
3277 * @bat_priv: the bat priv with all the soft interface information 3277 * @bat_priv: the bat priv with all the soft interface information
3278 * @tt_data: tt data containing the tt request information 3278 * @tt_data: tt data containing the tt request information
3279 * @req_src: mac address of tt request sender 3279 * @req_src: mac address of tt request sender
@@ -3390,7 +3390,7 @@ out:
3390} 3390}
3391 3391
3392/** 3392/**
3393 * batadv_send_tt_response - send reply to tt request 3393 * batadv_send_tt_response() - send reply to tt request
3394 * @bat_priv: the bat priv with all the soft interface information 3394 * @bat_priv: the bat priv with all the soft interface information
3395 * @tt_data: tt data containing the tt request information 3395 * @tt_data: tt data containing the tt request information
3396 * @req_src: mac address of tt request sender 3396 * @req_src: mac address of tt request sender
@@ -3486,7 +3486,7 @@ static void batadv_tt_update_changes(struct batadv_priv *bat_priv,
3486} 3486}
3487 3487
3488/** 3488/**
3489 * batadv_is_my_client - check if a client is served by the local node 3489 * batadv_is_my_client() - check if a client is served by the local node
3490 * @bat_priv: the bat priv with all the soft interface information 3490 * @bat_priv: the bat priv with all the soft interface information
3491 * @addr: the mac address of the client to check 3491 * @addr: the mac address of the client to check
3492 * @vid: VLAN identifier 3492 * @vid: VLAN identifier
@@ -3516,7 +3516,7 @@ out:
3516} 3516}
3517 3517
3518/** 3518/**
3519 * batadv_handle_tt_response - process incoming tt reply 3519 * batadv_handle_tt_response() - process incoming tt reply
3520 * @bat_priv: the bat priv with all the soft interface information 3520 * @bat_priv: the bat priv with all the soft interface information
3521 * @tt_data: tt data containing the tt request information 3521 * @tt_data: tt data containing the tt request information
3522 * @resp_src: mac address of tt reply sender 3522 * @resp_src: mac address of tt reply sender
@@ -3609,7 +3609,7 @@ static void batadv_tt_roam_purge(struct batadv_priv *bat_priv)
3609} 3609}
3610 3610
3611/** 3611/**
3612 * batadv_tt_check_roam_count - check if a client has roamed too frequently 3612 * batadv_tt_check_roam_count() - check if a client has roamed too frequently
3613 * @bat_priv: the bat priv with all the soft interface information 3613 * @bat_priv: the bat priv with all the soft interface information
3614 * @client: mac address of the roaming client 3614 * @client: mac address of the roaming client
3615 * 3615 *
@@ -3664,7 +3664,7 @@ unlock:
3664} 3664}
3665 3665
3666/** 3666/**
3667 * batadv_send_roam_adv - send a roaming advertisement message 3667 * batadv_send_roam_adv() - send a roaming advertisement message
3668 * @bat_priv: the bat priv with all the soft interface information 3668 * @bat_priv: the bat priv with all the soft interface information
3669 * @client: mac address of the roaming client 3669 * @client: mac address of the roaming client
3670 * @vid: VLAN identifier 3670 * @vid: VLAN identifier
@@ -3746,7 +3746,7 @@ void batadv_tt_free(struct batadv_priv *bat_priv)
3746} 3746}
3747 3747
3748/** 3748/**
3749 * batadv_tt_local_set_flags - set or unset the specified flags on the local 3749 * batadv_tt_local_set_flags() - set or unset the specified flags on the local
3750 * table and possibly count them in the TT size 3750 * table and possibly count them in the TT size
3751 * @bat_priv: the bat priv with all the soft interface information 3751 * @bat_priv: the bat priv with all the soft interface information
3752 * @flags: the flag to switch 3752 * @flags: the flag to switch
@@ -3832,7 +3832,7 @@ static void batadv_tt_local_purge_pending_clients(struct batadv_priv *bat_priv)
3832} 3832}
3833 3833
3834/** 3834/**
3835 * batadv_tt_local_commit_changes_nolock - commit all pending local tt changes 3835 * batadv_tt_local_commit_changes_nolock() - commit all pending local tt changes
3836 * which have been queued in the time since the last commit 3836 * which have been queued in the time since the last commit
3837 * @bat_priv: the bat priv with all the soft interface information 3837 * @bat_priv: the bat priv with all the soft interface information
3838 * 3838 *
@@ -3865,7 +3865,7 @@ static void batadv_tt_local_commit_changes_nolock(struct batadv_priv *bat_priv)
3865} 3865}
3866 3866
3867/** 3867/**
3868 * batadv_tt_local_commit_changes - commit all pending local tt changes which 3868 * batadv_tt_local_commit_changes() - commit all pending local tt changes which
3869 * have been queued in the time since the last commit 3869 * have been queued in the time since the last commit
3870 * @bat_priv: the bat priv with all the soft interface information 3870 * @bat_priv: the bat priv with all the soft interface information
3871 */ 3871 */
@@ -3911,7 +3911,7 @@ vlan_put:
3911} 3911}
3912 3912
3913/** 3913/**
3914 * batadv_tt_update_orig - update global translation table with new tt 3914 * batadv_tt_update_orig() - update global translation table with new tt
3915 * information received via ogms 3915 * information received via ogms
3916 * @bat_priv: the bat priv with all the soft interface information 3916 * @bat_priv: the bat priv with all the soft interface information
3917 * @orig_node: the orig_node of the ogm 3917 * @orig_node: the orig_node of the ogm
@@ -3996,7 +3996,7 @@ request_table:
3996} 3996}
3997 3997
3998/** 3998/**
3999 * batadv_tt_global_client_is_roaming - check if a client is marked as roaming 3999 * batadv_tt_global_client_is_roaming() - check if a client is marked as roaming
4000 * @bat_priv: the bat priv with all the soft interface information 4000 * @bat_priv: the bat priv with all the soft interface information
4001 * @addr: the mac address of the client to check 4001 * @addr: the mac address of the client to check
4002 * @vid: VLAN identifier 4002 * @vid: VLAN identifier
@@ -4022,7 +4022,7 @@ out:
4022} 4022}
4023 4023
4024/** 4024/**
4025 * batadv_tt_local_client_is_roaming - tells whether the client is roaming 4025 * batadv_tt_local_client_is_roaming() - tells whether the client is roaming
4026 * @bat_priv: the bat priv with all the soft interface information 4026 * @bat_priv: the bat priv with all the soft interface information
4027 * @addr: the mac address of the local client to query 4027 * @addr: the mac address of the local client to query
4028 * @vid: VLAN identifier 4028 * @vid: VLAN identifier
@@ -4071,7 +4071,7 @@ bool batadv_tt_add_temporary_global_entry(struct batadv_priv *bat_priv,
4071} 4071}
4072 4072
4073/** 4073/**
4074 * batadv_tt_local_resize_to_mtu - resize the local translation table fit the 4074 * batadv_tt_local_resize_to_mtu() - resize the local translation table fit the
4075 * maximum packet size that can be transported through the mesh 4075 * maximum packet size that can be transported through the mesh
4076 * @soft_iface: netdev struct of the mesh interface 4076 * @soft_iface: netdev struct of the mesh interface
4077 * 4077 *
@@ -4112,7 +4112,7 @@ void batadv_tt_local_resize_to_mtu(struct net_device *soft_iface)
4112} 4112}
4113 4113
4114/** 4114/**
4115 * batadv_tt_tvlv_ogm_handler_v1 - process incoming tt tvlv container 4115 * batadv_tt_tvlv_ogm_handler_v1() - process incoming tt tvlv container
4116 * @bat_priv: the bat priv with all the soft interface information 4116 * @bat_priv: the bat priv with all the soft interface information
4117 * @orig: the orig_node of the ogm 4117 * @orig: the orig_node of the ogm
4118 * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) 4118 * @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,
4151} 4151}
4152 4152
4153/** 4153/**
4154 * batadv_tt_tvlv_unicast_handler_v1 - process incoming (unicast) tt tvlv 4154 * batadv_tt_tvlv_unicast_handler_v1() - process incoming (unicast) tt tvlv
4155 * container 4155 * container
4156 * @bat_priv: the bat priv with all the soft interface information 4156 * @bat_priv: the bat priv with all the soft interface information
4157 * @src: mac address of tt tvlv sender 4157 * @src: mac address of tt tvlv sender
@@ -4233,7 +4233,8 @@ static int batadv_tt_tvlv_unicast_handler_v1(struct batadv_priv *bat_priv,
4233} 4233}
4234 4234
4235/** 4235/**
4236 * batadv_roam_tvlv_unicast_handler_v1 - process incoming tt roam tvlv container 4236 * batadv_roam_tvlv_unicast_handler_v1() - process incoming tt roam tvlv
4237 * container
4237 * @bat_priv: the bat priv with all the soft interface information 4238 * @bat_priv: the bat priv with all the soft interface information
4238 * @src: mac address of tt tvlv sender 4239 * @src: mac address of tt tvlv sender
4239 * @dst: mac address of tt tvlv recipient 4240 * @dst: mac address of tt tvlv recipient
@@ -4283,7 +4284,7 @@ out:
4283} 4284}
4284 4285
4285/** 4286/**
4286 * batadv_tt_init - initialise the translation table internals 4287 * batadv_tt_init() - initialise the translation table internals
4287 * @bat_priv: the bat priv with all the soft interface information 4288 * @bat_priv: the bat priv with all the soft interface information
4288 * 4289 *
4289 * Return: 0 on success or negative error number in case of failure. 4290 * 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)
4319} 4320}
4320 4321
4321/** 4322/**
4322 * batadv_tt_global_is_isolated - check if a client is marked as isolated 4323 * batadv_tt_global_is_isolated() - check if a client is marked as isolated
4323 * @bat_priv: the bat priv with all the soft interface information 4324 * @bat_priv: the bat priv with all the soft interface information
4324 * @addr: the mac address of the client 4325 * @addr: the mac address of the client
4325 * @vid: the identifier of the VLAN where this client is connected 4326 * @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,
4345} 4346}
4346 4347
4347/** 4348/**
4348 * batadv_tt_cache_init - Initialize tt memory object cache 4349 * batadv_tt_cache_init() - Initialize tt memory object cache
4349 * 4350 *
4350 * Return: 0 on success or negative error number in case of failure. 4351 * Return: 0 on success or negative error number in case of failure.
4351 */ 4352 */
@@ -4414,7 +4415,7 @@ err_tt_tl_destroy:
4414} 4415}
4415 4416
4416/** 4417/**
4417 * batadv_tt_cache_destroy - Destroy tt memory object cache 4418 * batadv_tt_cache_destroy() - Destroy tt memory object cache
4418 */ 4419 */
4419void batadv_tt_cache_destroy(void) 4420void batadv_tt_cache_destroy(void)
4420{ 4421{
diff --git a/net/batman-adv/tvlv.c b/net/batman-adv/tvlv.c
index d956c2a0e9cb..e189f026974c 100644
--- a/net/batman-adv/tvlv.c
+++ b/net/batman-adv/tvlv.c
@@ -43,7 +43,7 @@
43#include "tvlv.h" 43#include "tvlv.h"
44 44
45/** 45/**
46 * batadv_tvlv_handler_release - release tvlv handler from lists and queue for 46 * batadv_tvlv_handler_release() - release tvlv handler from lists and queue for
47 * free after rcu grace period 47 * free after rcu grace period
48 * @ref: kref pointer of the tvlv 48 * @ref: kref pointer of the tvlv
49 */ 49 */
@@ -56,7 +56,7 @@ static void batadv_tvlv_handler_release(struct kref *ref)
56} 56}
57 57
58/** 58/**
59 * batadv_tvlv_handler_put - decrement the tvlv container refcounter and 59 * batadv_tvlv_handler_put() - decrement the tvlv container refcounter and
60 * possibly release it 60 * possibly release it
61 * @tvlv_handler: the tvlv handler to free 61 * @tvlv_handler: the tvlv handler to free
62 */ 62 */
@@ -66,7 +66,7 @@ static void batadv_tvlv_handler_put(struct batadv_tvlv_handler *tvlv_handler)
66} 66}
67 67
68/** 68/**
69 * batadv_tvlv_handler_get - retrieve tvlv handler from the tvlv handler list 69 * batadv_tvlv_handler_get() - retrieve tvlv handler from the tvlv handler list
70 * based on the provided type and version (both need to match) 70 * based on the provided type and version (both need to match)
71 * @bat_priv: the bat priv with all the soft interface information 71 * @bat_priv: the bat priv with all the soft interface information
72 * @type: tvlv handler type to look for 72 * @type: tvlv handler type to look for
@@ -100,7 +100,7 @@ batadv_tvlv_handler_get(struct batadv_priv *bat_priv, u8 type, u8 version)
100} 100}
101 101
102/** 102/**
103 * batadv_tvlv_container_release - release tvlv from lists and free 103 * batadv_tvlv_container_release() - release tvlv from lists and free
104 * @ref: kref pointer of the tvlv 104 * @ref: kref pointer of the tvlv
105 */ 105 */
106static void batadv_tvlv_container_release(struct kref *ref) 106static void batadv_tvlv_container_release(struct kref *ref)
@@ -112,7 +112,7 @@ static void batadv_tvlv_container_release(struct kref *ref)
112} 112}
113 113
114/** 114/**
115 * batadv_tvlv_container_put - decrement the tvlv container refcounter and 115 * batadv_tvlv_container_put() - decrement the tvlv container refcounter and
116 * possibly release it 116 * possibly release it
117 * @tvlv: the tvlv container to free 117 * @tvlv: the tvlv container to free
118 */ 118 */
@@ -122,7 +122,7 @@ static void batadv_tvlv_container_put(struct batadv_tvlv_container *tvlv)
122} 122}
123 123
124/** 124/**
125 * batadv_tvlv_container_get - retrieve tvlv container from the tvlv container 125 * batadv_tvlv_container_get() - retrieve tvlv container from the tvlv container
126 * list based on the provided type and version (both need to match) 126 * list based on the provided type and version (both need to match)
127 * @bat_priv: the bat priv with all the soft interface information 127 * @bat_priv: the bat priv with all the soft interface information
128 * @type: tvlv container type to look for 128 * @type: tvlv container type to look for
@@ -156,7 +156,7 @@ batadv_tvlv_container_get(struct batadv_priv *bat_priv, u8 type, u8 version)
156} 156}
157 157
158/** 158/**
159 * batadv_tvlv_container_list_size - calculate the size of the tvlv container 159 * batadv_tvlv_container_list_size() - calculate the size of the tvlv container
160 * list entries 160 * list entries
161 * @bat_priv: the bat priv with all the soft interface information 161 * @bat_priv: the bat priv with all the soft interface information
162 * 162 *
@@ -181,8 +181,8 @@ static u16 batadv_tvlv_container_list_size(struct batadv_priv *bat_priv)
181} 181}
182 182
183/** 183/**
184 * batadv_tvlv_container_remove - remove tvlv container from the tvlv container 184 * batadv_tvlv_container_remove() - remove tvlv container from the tvlv
185 * list 185 * container list
186 * @bat_priv: the bat priv with all the soft interface information 186 * @bat_priv: the bat priv with all the soft interface information
187 * @tvlv: the to be removed tvlv container 187 * @tvlv: the to be removed tvlv container
188 * 188 *
@@ -205,7 +205,7 @@ static void batadv_tvlv_container_remove(struct batadv_priv *bat_priv,
205} 205}
206 206
207/** 207/**
208 * batadv_tvlv_container_unregister - unregister tvlv container based on the 208 * batadv_tvlv_container_unregister() - unregister tvlv container based on the
209 * provided type and version (both need to match) 209 * provided type and version (both need to match)
210 * @bat_priv: the bat priv with all the soft interface information 210 * @bat_priv: the bat priv with all the soft interface information
211 * @type: tvlv container type to unregister 211 * @type: tvlv container type to unregister
@@ -223,7 +223,7 @@ void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv,
223} 223}
224 224
225/** 225/**
226 * batadv_tvlv_container_register - register tvlv type, version and content 226 * batadv_tvlv_container_register() - register tvlv type, version and content
227 * to be propagated with each (primary interface) OGM 227 * to be propagated with each (primary interface) OGM
228 * @bat_priv: the bat priv with all the soft interface information 228 * @bat_priv: the bat priv with all the soft interface information
229 * @type: tvlv container type 229 * @type: tvlv container type
@@ -268,7 +268,7 @@ void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
268} 268}
269 269
270/** 270/**
271 * batadv_tvlv_realloc_packet_buff - reallocate packet buffer to accommodate 271 * batadv_tvlv_realloc_packet_buff() - reallocate packet buffer to accommodate
272 * requested packet size 272 * requested packet size
273 * @packet_buff: packet buffer 273 * @packet_buff: packet buffer
274 * @packet_buff_len: packet buffer size 274 * @packet_buff_len: packet buffer size
@@ -301,7 +301,7 @@ static bool batadv_tvlv_realloc_packet_buff(unsigned char **packet_buff,
301} 301}
302 302
303/** 303/**
304 * batadv_tvlv_container_ogm_append - append tvlv container content to given 304 * batadv_tvlv_container_ogm_append() - append tvlv container content to given
305 * OGM packet buffer 305 * OGM packet buffer
306 * @bat_priv: the bat priv with all the soft interface information 306 * @bat_priv: the bat priv with all the soft interface information
307 * @packet_buff: ogm packet buffer 307 * @packet_buff: ogm packet buffer
@@ -354,7 +354,7 @@ end:
354} 354}
355 355
356/** 356/**
357 * batadv_tvlv_call_handler - parse the given tvlv buffer to call the 357 * batadv_tvlv_call_handler() - parse the given tvlv buffer to call the
358 * appropriate handlers 358 * appropriate handlers
359 * @bat_priv: the bat priv with all the soft interface information 359 * @bat_priv: the bat priv with all the soft interface information
360 * @tvlv_handler: tvlv callback function handling the tvlv content 360 * @tvlv_handler: tvlv callback function handling the tvlv content
@@ -408,7 +408,7 @@ static int batadv_tvlv_call_handler(struct batadv_priv *bat_priv,
408} 408}
409 409
410/** 410/**
411 * batadv_tvlv_containers_process - parse the given tvlv buffer to call the 411 * batadv_tvlv_containers_process() - parse the given tvlv buffer to call the
412 * appropriate handlers 412 * appropriate handlers
413 * @bat_priv: the bat priv with all the soft interface information 413 * @bat_priv: the bat priv with all the soft interface information
414 * @ogm_source: flag indicating whether the tvlv is an ogm or a unicast packet 414 * @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,
475} 475}
476 476
477/** 477/**
478 * batadv_tvlv_ogm_receive - process an incoming ogm and call the appropriate 478 * batadv_tvlv_ogm_receive() - process an incoming ogm and call the appropriate
479 * handlers 479 * handlers
480 * @bat_priv: the bat priv with all the soft interface information 480 * @bat_priv: the bat priv with all the soft interface information
481 * @batadv_ogm_packet: ogm packet containing the tvlv containers 481 * @batadv_ogm_packet: ogm packet containing the tvlv containers
@@ -502,7 +502,7 @@ void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv,
502} 502}
503 503
504/** 504/**
505 * batadv_tvlv_handler_register - register tvlv handler based on the provided 505 * batadv_tvlv_handler_register() - register tvlv handler based on the provided
506 * type and version (both need to match) for ogm tvlv payload and/or unicast 506 * type and version (both need to match) for ogm tvlv payload and/or unicast
507 * payload 507 * payload
508 * @bat_priv: the bat priv with all the soft interface information 508 * @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,
557} 557}
558 558
559/** 559/**
560 * batadv_tvlv_handler_unregister - unregister tvlv handler based on the 560 * batadv_tvlv_handler_unregister() - unregister tvlv handler based on the
561 * provided type and version (both need to match) 561 * provided type and version (both need to match)
562 * @bat_priv: the bat priv with all the soft interface information 562 * @bat_priv: the bat priv with all the soft interface information
563 * @type: tvlv handler type to be unregistered 563 * @type: tvlv handler type to be unregistered
@@ -580,7 +580,7 @@ void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv,
580} 580}
581 581
582/** 582/**
583 * batadv_tvlv_unicast_send - send a unicast packet with tvlv payload to the 583 * batadv_tvlv_unicast_send() - send a unicast packet with tvlv payload to the
584 * specified host 584 * specified host
585 * @bat_priv: the bat priv with all the soft interface information 585 * @bat_priv: the bat priv with all the soft interface information
586 * @src: source mac address of the unicast packet 586 * @src: source mac address of the unicast packet