Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7e9a8c2c authored by Sven Eckelmann's avatar Sven Eckelmann Committed by Simon Wunderlich
Browse files

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: default avatarSven Eckelmann <sven@narfation.org>
Signed-off-by: default avatarSimon Wunderlich <sw@simonwunderlich.de>
parent 6a3038f0

net/batman-adv/bat_algo.c

+4 −3
Original line number Diff line number Diff line
@@ -38,7 +38,8 @@ char batadv_routing_algo[20] = "BATMAN_IV"; 
static struct hlist_head batadv_algo_list;



/**

 * batadv_algo_init - Initialize batman-adv algorithm management data structures

 * batadv_algo_init() - Initialize batman-adv algorithm management data

 *  structures

 */

void batadv_algo_init(void)

{
@@ -149,7 +150,7 @@ module_param_cb(routing_algo, &batadv_param_ops_ra, &batadv_param_string_ra, 
		0644);



/**

 * batadv_algo_dump_entry - fill in information about one supported routing

 * batadv_algo_dump_entry() - fill in information about one supported routing

 *  algorithm

 * @msg: netlink message to be sent back

 * @portid: Port to reply to
@@ -180,7 +181,7 @@ static int batadv_algo_dump_entry(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_algo_dump - fill in information about supported routing

 * batadv_algo_dump() - fill in information about supported routing

 *  algorithms

 * @msg: netlink message to be sent back

 * @cb: Parameters to the netlink request

net/batman-adv/bat_iv_ogm.c

+41 −39
Original line number Diff line number Diff line
@@ -87,7 +87,7 @@ enum batadv_dup_status { 
};



/**

 * batadv_ring_buffer_set - update the ring buffer with the given value

 * batadv_ring_buffer_set() - update the ring buffer with the given value

 * @lq_recv: pointer to the ring buffer

 * @lq_index: index to store the value at

 * @value: value to store in the ring buffer
@@ -99,7 +99,7 @@ static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value) 
}



/**

 * batadv_ring_buffer_avg - compute the average of all non-zero values stored

 * batadv_ring_buffer_avg() - compute the average of all non-zero values stored

 * in the given ring buffer

 * @lq_recv: pointer to the ring buffer

 *
@@ -131,7 +131,7 @@ static u8 batadv_ring_buffer_avg(const u8 lq_recv[]) 
}



/**

 * batadv_iv_ogm_orig_free - free the private resources allocated for this

 * batadv_iv_ogm_orig_free() - free the private resources allocated for this

 *  orig_node

 * @orig_node: the orig_node for which the resources have to be free'd

 */
@@ -142,8 +142,8 @@ static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node) 
}



/**

 * batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to

 *  include the new hard-interface

 * batadv_iv_ogm_orig_add_if() - change the private structures of the orig_node

 *  to include the new hard-interface

 * @orig_node: the orig_node that has to be changed

 * @max_if_num: the current amount of interfaces

 *
@@ -187,7 +187,7 @@ static int batadv_iv_ogm_orig_add_if(struct batadv_orig_node *orig_node, 
}



/**

 * batadv_iv_ogm_drop_bcast_own_entry - drop section of bcast_own

 * batadv_iv_ogm_drop_bcast_own_entry() - drop section of bcast_own

 * @orig_node: the orig_node that has to be changed

 * @max_if_num: the current amount of interfaces

 * @del_if_num: the index of the interface being removed
@@ -225,7 +225,7 @@ batadv_iv_ogm_drop_bcast_own_entry(struct batadv_orig_node *orig_node, 
}



/**

 * batadv_iv_ogm_drop_bcast_own_sum_entry - drop section of bcast_own_sum

 * batadv_iv_ogm_drop_bcast_own_sum_entry() - drop section of bcast_own_sum

 * @orig_node: the orig_node that has to be changed

 * @max_if_num: the current amount of interfaces

 * @del_if_num: the index of the interface being removed
@@ -260,8 +260,8 @@ batadv_iv_ogm_drop_bcast_own_sum_entry(struct batadv_orig_node *orig_node, 
}



/**

 * batadv_iv_ogm_orig_del_if - change the private structures of the orig_node to

 *  exclude the removed interface

 * batadv_iv_ogm_orig_del_if() - change the private structures of the orig_node

 *  to exclude the removed interface

 * @orig_node: the orig_node that has to be changed

 * @max_if_num: the current amount of interfaces

 * @del_if_num: the index of the interface being removed
@@ -291,7 +291,8 @@ static int batadv_iv_ogm_orig_del_if(struct batadv_orig_node *orig_node, 
}



/**

 * batadv_iv_ogm_orig_get - retrieve or create (if does not exist) an originator

 * batadv_iv_ogm_orig_get() - retrieve or create (if does not exist) an

 *  originator

 * @bat_priv: the bat priv with all the soft interface information

 * @addr: mac address of the originator

 *
@@ -448,7 +449,7 @@ static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv) 
}



/**

 * batadv_iv_ogm_aggr_packet - checks if there is another OGM attached

 * batadv_iv_ogm_aggr_packet() - checks if there is another OGM attached

 * @buff_pos: current position in the skb

 * @packet_len: total length of the skb

 * @tvlv_len: tvlv length of the previously considered OGM
@@ -558,7 +559,7 @@ static void batadv_iv_ogm_emit(struct batadv_forw_packet *forw_packet) 
}



/**

 * batadv_iv_ogm_can_aggregate - find out if an OGM can be aggregated on an

 * batadv_iv_ogm_can_aggregate() - find out if an OGM can be aggregated on an

 *  existing forward packet

 * @new_bat_ogm_packet: OGM packet to be aggregated

 * @bat_priv: the bat priv with all the soft interface information
@@ -661,7 +662,7 @@ batadv_iv_ogm_can_aggregate(const struct batadv_ogm_packet *new_bat_ogm_packet, 
}



/**

 * batadv_iv_ogm_aggregate_new - create a new aggregated packet and add this

 * batadv_iv_ogm_aggregate_new() - create a new aggregated packet and add this

 *  packet to it.

 * @packet_buff: pointer to the OGM

 * @packet_len: (total) length of the OGM
@@ -744,7 +745,7 @@ static void batadv_iv_ogm_aggregate(struct batadv_forw_packet *forw_packet_aggr, 
}



/**

 * batadv_iv_ogm_queue_add - queue up an OGM for transmission

 * batadv_iv_ogm_queue_add() - queue up an OGM for transmission

 * @bat_priv: the bat priv with all the soft interface information

 * @packet_buff: pointer to the OGM

 * @packet_len: (total) length of the OGM
@@ -870,8 +871,8 @@ static void batadv_iv_ogm_forward(struct batadv_orig_node *orig_node, 
}



/**

 * batadv_iv_ogm_slide_own_bcast_window - bitshift own OGM broadcast windows for

 * the given interface

 * batadv_iv_ogm_slide_own_bcast_window() - bitshift own OGM broadcast windows

 *  for the given interface

 * @hard_iface: the interface for which the windows have to be shifted

 */

static void
@@ -988,7 +989,7 @@ static void batadv_iv_ogm_schedule(struct batadv_hard_iface *hard_iface) 
}



/**

 * batadv_iv_ogm_orig_update - use OGM to update corresponding data in an

 * batadv_iv_ogm_orig_update() - use OGM to update corresponding data in an

 *  originator

 * @bat_priv: the bat priv with all the soft interface information

 * @orig_node: the orig node who originally emitted the ogm packet
@@ -1153,7 +1154,7 @@ batadv_iv_ogm_orig_update(struct batadv_priv *bat_priv, 
}



/**

 * batadv_iv_ogm_calc_tq - calculate tq for current received ogm packet

 * batadv_iv_ogm_calc_tq() - calculate tq for current received ogm packet

 * @orig_node: the orig node who originally emitted the ogm packet

 * @orig_neigh_node: the orig node struct of the neighbor who sent the packet

 * @batadv_ogm_packet: the ogm packet
@@ -1299,7 +1300,7 @@ static bool batadv_iv_ogm_calc_tq(struct batadv_orig_node *orig_node, 
}



/**

 * batadv_iv_ogm_update_seqnos -  process a batman packet for all interfaces,

 * batadv_iv_ogm_update_seqnos() -  process a batman packet for all interfaces,

 *  adjust the sequence number and find out whether it is a duplicate

 * @ethhdr: ethernet header of the packet

 * @batadv_ogm_packet: OGM packet to be considered
@@ -1402,7 +1403,8 @@ batadv_iv_ogm_update_seqnos(const struct ethhdr *ethhdr, 
}



/**

 * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if

 * batadv_iv_ogm_process_per_outif() - process a batman iv OGM for an outgoing

 *  interface

 * @skb: the skb containing the OGM

 * @ogm_offset: offset from skb->data to start of ogm header

 * @orig_node: the (cached) orig node for the originator of this OGM
@@ -1609,7 +1611,7 @@ batadv_iv_ogm_process_per_outif(const struct sk_buff *skb, int ogm_offset, 
}



/**

 * batadv_iv_ogm_process - process an incoming batman iv OGM

 * batadv_iv_ogm_process() - process an incoming batman iv OGM

 * @skb: the skb containing the OGM

 * @ogm_offset: offset to the OGM which should be processed (for aggregates)

 * @if_incoming: the interface where this packet was receved
@@ -1862,7 +1864,7 @@ static int batadv_iv_ogm_receive(struct sk_buff *skb, 


#ifdef CONFIG_BATMAN_ADV_DEBUGFS

/**

 * batadv_iv_ogm_orig_print_neigh - print neighbors for the originator table

 * batadv_iv_ogm_orig_print_neigh() - print neighbors for the originator table

 * @orig_node: the orig_node for which the neighbors are printed

 * @if_outgoing: outgoing interface for these entries

 * @seq: debugfs table seq_file struct
@@ -1891,7 +1893,7 @@ batadv_iv_ogm_orig_print_neigh(struct batadv_orig_node *orig_node, 
}



/**

 * batadv_iv_ogm_orig_print - print the originator table

 * batadv_iv_ogm_orig_print() - print the originator table

 * @bat_priv: the bat priv with all the soft interface information

 * @seq: debugfs table seq_file struct

 * @if_outgoing: the outgoing interface for which this should be printed
@@ -1961,7 +1963,7 @@ static void batadv_iv_ogm_orig_print(struct batadv_priv *bat_priv, 
#endif



/**

 * batadv_iv_ogm_neigh_get_tq_avg - Get the TQ average for a neighbour on a

 * batadv_iv_ogm_neigh_get_tq_avg() - Get the TQ average for a neighbour on a

 *  given outgoing interface.

 * @neigh_node: Neighbour of interest

 * @if_outgoing: Outgoing interface of interest
@@ -1987,7 +1989,7 @@ batadv_iv_ogm_neigh_get_tq_avg(struct batadv_neigh_node *neigh_node, 
}



/**

 * batadv_iv_ogm_orig_dump_subentry - Dump an originator subentry into a

 * batadv_iv_ogm_orig_dump_subentry() - Dump an originator subentry into a

 *  message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request
@@ -2049,7 +2051,7 @@ batadv_iv_ogm_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_iv_ogm_orig_dump_entry - Dump an originator entry into a message

 * batadv_iv_ogm_orig_dump_entry() - Dump an originator entry into a message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request

 * @seq: Sequence number of netlink message
@@ -2111,7 +2113,7 @@ batadv_iv_ogm_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_iv_ogm_orig_dump_bucket - Dump an originator bucket into a

 * batadv_iv_ogm_orig_dump_bucket() - Dump an originator bucket into a

 *  message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request
@@ -2154,7 +2156,7 @@ batadv_iv_ogm_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_iv_ogm_orig_dump - Dump the originators into a message

 * batadv_iv_ogm_orig_dump() - Dump the originators into a message

 * @msg: Netlink message to dump into

 * @cb: Control block containing additional options

 * @bat_priv: The bat priv with all the soft interface information
@@ -2191,7 +2193,7 @@ batadv_iv_ogm_orig_dump(struct sk_buff *msg, struct netlink_callback *cb, 


#ifdef CONFIG_BATMAN_ADV_DEBUGFS

/**

 * batadv_iv_hardif_neigh_print - print a single hop neighbour node

 * batadv_iv_hardif_neigh_print() - print a single hop neighbour node

 * @seq: neighbour table seq_file struct

 * @hardif_neigh: hardif neighbour information

 */
@@ -2210,7 +2212,7 @@ batadv_iv_hardif_neigh_print(struct seq_file *seq, 
}



/**

 * batadv_iv_ogm_neigh_print - print the single hop neighbour list

 * batadv_iv_ogm_neigh_print() - print the single hop neighbour list

 * @bat_priv: the bat priv with all the soft interface information

 * @seq: neighbour table seq_file struct

 */
@@ -2243,7 +2245,7 @@ static void batadv_iv_neigh_print(struct batadv_priv *bat_priv, 
#endif



/**

 * batadv_iv_ogm_neigh_diff - calculate tq difference of two neighbors

 * batadv_iv_ogm_neigh_diff() - calculate tq difference of two neighbors

 * @neigh1: the first neighbor object of the comparison

 * @if_outgoing1: outgoing interface for the first neighbor

 * @neigh2: the second neighbor object of the comparison
@@ -2288,7 +2290,7 @@ static bool batadv_iv_ogm_neigh_diff(struct batadv_neigh_node *neigh1, 
}



/**

 * batadv_iv_ogm_neigh_dump_neigh - Dump a neighbour into a netlink message

 * batadv_iv_ogm_neigh_dump_neigh() - Dump a neighbour into a netlink message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request

 * @seq: Sequence number of netlink message
@@ -2327,7 +2329,7 @@ batadv_iv_ogm_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_iv_ogm_neigh_dump_hardif - Dump the neighbours of a hard interface

 * batadv_iv_ogm_neigh_dump_hardif() - Dump the neighbours of a hard interface

 *  into a message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request
@@ -2366,7 +2368,7 @@ batadv_iv_ogm_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_iv_ogm_neigh_dump - Dump the neighbours into a message

 * batadv_iv_ogm_neigh_dump() - Dump the neighbours into a message

 * @msg: Netlink message to dump into

 * @cb: Control block containing additional options

 * @bat_priv: The bat priv with all the soft interface information
@@ -2418,7 +2420,7 @@ batadv_iv_ogm_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb, 
}



/**

 * batadv_iv_ogm_neigh_cmp - compare the metrics of two neighbors

 * batadv_iv_ogm_neigh_cmp() - compare the metrics of two neighbors

 * @neigh1: the first neighbor object of the comparison

 * @if_outgoing1: outgoing interface for the first neighbor

 * @neigh2: the second neighbor object of the comparison
@@ -2444,7 +2446,7 @@ static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1, 
}



/**

 * batadv_iv_ogm_neigh_is_sob - check if neigh1 is similarly good or better

 * batadv_iv_ogm_neigh_is_sob() - check if neigh1 is similarly good or better

 *  than neigh2 from the metric prospective

 * @neigh1: the first neighbor object of the comparison

 * @if_outgoing1: outgoing interface for the first neighbor
@@ -2479,7 +2481,7 @@ static void batadv_iv_iface_activate(struct batadv_hard_iface *hard_iface) 
}



/**

 * batadv_iv_init_sel_class - initialize GW selection class

 * batadv_iv_init_sel_class() - initialize GW selection class

 * @bat_priv: the bat priv with all the soft interface information

 */

static void batadv_iv_init_sel_class(struct batadv_priv *bat_priv)
@@ -2704,7 +2706,7 @@ static void batadv_iv_gw_print(struct batadv_priv *bat_priv, 
#endif



/**

 * batadv_iv_gw_dump_entry - Dump a gateway into a message

 * batadv_iv_gw_dump_entry() - Dump a gateway into a message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request

 * @seq: Sequence number of netlink message
@@ -2775,7 +2777,7 @@ static int batadv_iv_gw_dump_entry(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_iv_gw_dump - Dump gateways into a message

 * batadv_iv_gw_dump() - Dump gateways into a message

 * @msg: Netlink message to dump into

 * @cb: Control block containing additional options

 * @bat_priv: The bat priv with all the soft interface information

net/batman-adv/bat_v.c

+23 −25
Original line number Diff line number Diff line
@@ -100,7 +100,7 @@ static void batadv_v_primary_iface_set(struct batadv_hard_iface *hard_iface) 
}



/**

 * batadv_v_iface_update_mac - react to hard-interface MAC address change

 * batadv_v_iface_update_mac() - react to hard-interface MAC address change

 * @hard_iface: the modified interface

 *

 * If the modified interface is the primary one, update the originator
@@ -131,7 +131,7 @@ batadv_v_hardif_neigh_init(struct batadv_hardif_neigh_node *hardif_neigh) 


#ifdef CONFIG_BATMAN_ADV_DEBUGFS

/**

 * batadv_v_orig_print_neigh - print neighbors for the originator table

 * batadv_v_orig_print_neigh() - print neighbors for the originator table

 * @orig_node: the orig_node for which the neighbors are printed

 * @if_outgoing: outgoing interface for these entries

 * @seq: debugfs table seq_file struct
@@ -161,7 +161,7 @@ batadv_v_orig_print_neigh(struct batadv_orig_node *orig_node, 
}



/**

 * batadv_v_hardif_neigh_print - print a single ELP neighbour node

 * batadv_v_hardif_neigh_print() - print a single ELP neighbour node

 * @seq: neighbour table seq_file struct

 * @hardif_neigh: hardif neighbour information

 */
@@ -182,7 +182,7 @@ batadv_v_hardif_neigh_print(struct seq_file *seq, 
}



/**

 * batadv_v_neigh_print - print the single hop neighbour list

 * batadv_v_neigh_print() - print the single hop neighbour list

 * @bat_priv: the bat priv with all the soft interface information

 * @seq: neighbour table seq_file struct

 */
@@ -216,7 +216,7 @@ static void batadv_v_neigh_print(struct batadv_priv *bat_priv, 
#endif



/**

 * batadv_v_neigh_dump_neigh - Dump a neighbour into a message

 * batadv_v_neigh_dump_neigh() - Dump a neighbour into a message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request

 * @seq: Sequence number of netlink message
@@ -259,7 +259,7 @@ batadv_v_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_v_neigh_dump_hardif - Dump the  neighbours of a hard interface  into

 * batadv_v_neigh_dump_hardif() - Dump the  neighbours of a hard interface into

 *  a message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request
@@ -297,7 +297,7 @@ batadv_v_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_v_neigh_dump - Dump the neighbours of a hard interface  into a

 * batadv_v_neigh_dump() - Dump the neighbours of a hard interface  into a

 *  message

 * @msg: Netlink message to dump into

 * @cb: Control block containing additional options
@@ -349,7 +349,7 @@ batadv_v_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb, 


#ifdef CONFIG_BATMAN_ADV_DEBUGFS

/**

 * batadv_v_orig_print - print the originator table

 * batadv_v_orig_print() - print the originator table

 * @bat_priv: the bat priv with all the soft interface information

 * @seq: debugfs table seq_file struct

 * @if_outgoing: the outgoing interface for which this should be printed
@@ -417,8 +417,7 @@ static void batadv_v_orig_print(struct batadv_priv *bat_priv, 
#endif



/**

 * batadv_v_orig_dump_subentry - Dump an originator subentry into a

 *  message

 * batadv_v_orig_dump_subentry() - Dump an originator subentry into a message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request

 * @seq: Sequence number of netlink message
@@ -484,7 +483,7 @@ batadv_v_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_v_orig_dump_entry - Dump an originator entry into a message

 * batadv_v_orig_dump_entry() - Dump an originator entry into a message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request

 * @seq: Sequence number of netlink message
@@ -537,8 +536,7 @@ batadv_v_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_v_orig_dump_bucket - Dump an originator bucket into a

 *  message

 * batadv_v_orig_dump_bucket() - Dump an originator bucket into a message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request

 * @seq: Sequence number of netlink message
@@ -579,7 +577,7 @@ batadv_v_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_v_orig_dump - Dump the originators into a message

 * batadv_v_orig_dump() - Dump the originators into a message

 * @msg: Netlink message to dump into

 * @cb: Control block containing additional options

 * @bat_priv: The bat priv with all the soft interface information
@@ -669,7 +667,7 @@ static bool batadv_v_neigh_is_sob(struct batadv_neigh_node *neigh1, 
}



/**

 * batadv_v_init_sel_class - initialize GW selection class

 * batadv_v_init_sel_class() - initialize GW selection class

 * @bat_priv: the bat priv with all the soft interface information

 */

static void batadv_v_init_sel_class(struct batadv_priv *bat_priv)
@@ -705,7 +703,7 @@ static ssize_t batadv_v_show_sel_class(struct batadv_priv *bat_priv, char *buff) 
}



/**

 * batadv_v_gw_throughput_get - retrieve the GW-bandwidth for a given GW

 * batadv_v_gw_throughput_get() - retrieve the GW-bandwidth for a given GW

 * @gw_node: the GW to retrieve the metric for

 * @bw: the pointer where the metric will be stored. The metric is computed as

 *  the minimum between the GW advertised throughput and the path throughput to
@@ -748,7 +746,7 @@ static int batadv_v_gw_throughput_get(struct batadv_gw_node *gw_node, u32 *bw) 
}



/**

 * batadv_v_gw_get_best_gw_node - retrieve the best GW node

 * batadv_v_gw_get_best_gw_node() - retrieve the best GW node

 * @bat_priv: the bat priv with all the soft interface information

 *

 * Return: the GW node having the best GW-metric, NULL if no GW is known
@@ -786,7 +784,7 @@ batadv_v_gw_get_best_gw_node(struct batadv_priv *bat_priv) 
}



/**

 * batadv_v_gw_is_eligible - check if a originator would be selected as GW

 * batadv_v_gw_is_eligible() - check if a originator would be selected as GW

 * @bat_priv: the bat priv with all the soft interface information

 * @curr_gw_orig: originator representing the currently selected GW

 * @orig_node: the originator representing the new candidate
@@ -885,7 +883,7 @@ static int batadv_v_gw_write_buffer_text(struct batadv_priv *bat_priv, 
}



/**

 * batadv_v_gw_print - print the gateway list

 * batadv_v_gw_print() - print the gateway list

 * @bat_priv: the bat priv with all the soft interface information

 * @seq: gateway table seq_file struct

 */
@@ -914,7 +912,7 @@ static void batadv_v_gw_print(struct batadv_priv *bat_priv, 
#endif



/**

 * batadv_v_gw_dump_entry - Dump a gateway into a message

 * batadv_v_gw_dump_entry() - Dump a gateway into a message

 * @msg: Netlink message to dump into

 * @portid: Port making netlink request

 * @seq: Sequence number of netlink message
@@ -1005,7 +1003,7 @@ static int batadv_v_gw_dump_entry(struct sk_buff *msg, u32 portid, u32 seq, 
}



/**

 * batadv_v_gw_dump - Dump gateways into a message

 * batadv_v_gw_dump() - Dump gateways into a message

 * @msg: Netlink message to dump into

 * @cb: Control block containing additional options

 * @bat_priv: The bat priv with all the soft interface information
@@ -1075,7 +1073,7 @@ static struct batadv_algo_ops batadv_batman_v __read_mostly = { 
};



/**

 * batadv_v_hardif_init - initialize the algorithm specific fields in the

 * batadv_v_hardif_init() - initialize the algorithm specific fields in the

 *  hard-interface object

 * @hard_iface: the hard-interface to initialize

 */
@@ -1089,7 +1087,7 @@ void batadv_v_hardif_init(struct batadv_hard_iface *hard_iface) 
}



/**

 * batadv_v_mesh_init - initialize the B.A.T.M.A.N. V private resources for a

 * batadv_v_mesh_init() - initialize the B.A.T.M.A.N. V private resources for a

 *  mesh

 * @bat_priv: the object representing the mesh interface to initialise

 *
@@ -1107,7 +1105,7 @@ int batadv_v_mesh_init(struct batadv_priv *bat_priv) 
}



/**

 * batadv_v_mesh_free - free the B.A.T.M.A.N. V private resources for a mesh

 * batadv_v_mesh_free() - free the B.A.T.M.A.N. V private resources for a mesh

 * @bat_priv: the object representing the mesh interface to free

 */

void batadv_v_mesh_free(struct batadv_priv *bat_priv)
@@ -1116,7 +1114,7 @@ void batadv_v_mesh_free(struct batadv_priv *bat_priv) 
}



/**

 * batadv_v_init - B.A.T.M.A.N. V initialization function

 * batadv_v_init() - B.A.T.M.A.N. V initialization function

 *

 * Description: Takes care of initializing all the subcomponents.

 * It is invoked upon module load only.

net/batman-adv/bat_v_elp.c

+12 −12
Original line number Diff line number Diff line
@@ -53,7 +53,7 @@ 
#include "send.h"



/**

 * batadv_v_elp_start_timer - restart timer for ELP periodic work

 * batadv_v_elp_start_timer() - restart timer for ELP periodic work

 * @hard_iface: the interface for which the timer has to be reset

 */

static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)
@@ -68,7 +68,7 @@ static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface) 
}



/**

 * batadv_v_elp_get_throughput - get the throughput towards a neighbour

 * batadv_v_elp_get_throughput() - get the throughput towards a neighbour

 * @neigh: the neighbour for which the throughput has to be obtained

 *

 * Return: The throughput towards the given neighbour in multiples of 100kpbs
@@ -154,8 +154,8 @@ static u32 batadv_v_elp_get_throughput(struct batadv_hardif_neigh_node *neigh) 
}



/**

 * batadv_v_elp_throughput_metric_update - worker updating the throughput metric

 *  of a single hop neighbour

 * batadv_v_elp_throughput_metric_update() - worker updating the throughput

 *  metric of a single hop neighbour

 * @work: the work queue item

 */

void batadv_v_elp_throughput_metric_update(struct work_struct *work)
@@ -178,7 +178,7 @@ void batadv_v_elp_throughput_metric_update(struct work_struct *work) 
}



/**

 * batadv_v_elp_wifi_neigh_probe - send link probing packets to a neighbour

 * batadv_v_elp_wifi_neigh_probe() - send link probing packets to a neighbour

 * @neigh: the neighbour to probe

 *

 * Sends a predefined number of unicast wifi packets to a given neighbour in
@@ -241,7 +241,7 @@ batadv_v_elp_wifi_neigh_probe(struct batadv_hardif_neigh_node *neigh) 
}



/**

 * batadv_v_elp_periodic_work - ELP periodic task per interface

 * batadv_v_elp_periodic_work() - ELP periodic task per interface

 * @work: work queue item

 *

 * Emits broadcast ELP message in regular intervals.
@@ -328,7 +328,7 @@ static void batadv_v_elp_periodic_work(struct work_struct *work) 
}



/**

 * batadv_v_elp_iface_enable - setup the ELP interface private resources

 * batadv_v_elp_iface_enable() - setup the ELP interface private resources

 * @hard_iface: interface for which the data has to be prepared

 *

 * Return: 0 on success or a -ENOMEM in case of failure.
@@ -376,7 +376,7 @@ int batadv_v_elp_iface_enable(struct batadv_hard_iface *hard_iface) 
}



/**

 * batadv_v_elp_iface_disable - release ELP interface private resources

 * batadv_v_elp_iface_disable() - release ELP interface private resources

 * @hard_iface: interface for which the resources have to be released

 */

void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)
@@ -388,7 +388,7 @@ void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface) 
}



/**

 * batadv_v_elp_iface_activate - update the ELP buffer belonging to the given

 * batadv_v_elp_iface_activate() - update the ELP buffer belonging to the given

 *  hard-interface

 * @primary_iface: the new primary interface

 * @hard_iface: interface holding the to-be-updated buffer
@@ -409,7 +409,7 @@ void batadv_v_elp_iface_activate(struct batadv_hard_iface *primary_iface, 
}



/**

 * batadv_v_elp_primary_iface_set - change internal data to reflect the new

 * batadv_v_elp_primary_iface_set() - change internal data to reflect the new

 *  primary interface

 * @primary_iface: the new primary interface

 */
@@ -429,7 +429,7 @@ void batadv_v_elp_primary_iface_set(struct batadv_hard_iface *primary_iface) 
}



/**

 * batadv_v_elp_neigh_update - update an ELP neighbour node

 * batadv_v_elp_neigh_update() - update an ELP neighbour node

 * @bat_priv: the bat priv with all the soft interface information

 * @neigh_addr: the neighbour interface address

 * @if_incoming: the interface the packet was received through
@@ -489,7 +489,7 @@ static void batadv_v_elp_neigh_update(struct batadv_priv *bat_priv, 
}



/**

 * batadv_v_elp_packet_recv - main ELP packet handler

 * batadv_v_elp_packet_recv() - main ELP packet handler

 * @skb: the received packet

 * @if_incoming: the interface this packet was received through

 *

net/batman-adv/bat_v_ogm.c

+17 −17

File changed.

Preview size limit exceeded, changes collapsed.