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

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
...@@ -38,7 +38,8 @@ char batadv_routing_algo[20] = "BATMAN_IV"; ...@@ -38,7 +38,8 @@ char batadv_routing_algo[20] = "BATMAN_IV";
static struct hlist_head batadv_algo_list; static struct hlist_head batadv_algo_list;
/** /**
* batadv_algo_init - Initialize batman-adv algorithm management data structures * batadv_algo_init() - Initialize batman-adv algorithm management data
* structures
*/ */
void batadv_algo_init(void) void batadv_algo_init(void)
{ {
...@@ -149,7 +150,7 @@ module_param_cb(routing_algo, &batadv_param_ops_ra, &batadv_param_string_ra, ...@@ -149,7 +150,7 @@ module_param_cb(routing_algo, &batadv_param_ops_ra, &batadv_param_string_ra,
0644); 0644);
/** /**
* batadv_algo_dump_entry - fill in information about one supported routing * batadv_algo_dump_entry() - fill in information about one supported routing
* algorithm * algorithm
* @msg: netlink message to be sent back * @msg: netlink message to be sent back
* @portid: Port to reply to * @portid: Port to reply to
...@@ -180,7 +181,7 @@ static int batadv_algo_dump_entry(struct sk_buff *msg, u32 portid, u32 seq, ...@@ -180,7 +181,7 @@ static int batadv_algo_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_algo_dump - fill in information about supported routing * batadv_algo_dump() - fill in information about supported routing
* algorithms * algorithms
* @msg: netlink message to be sent back * @msg: netlink message to be sent back
* @cb: Parameters to the netlink request * @cb: Parameters to the netlink request
......
This diff is collapsed.
...@@ -100,7 +100,7 @@ static void batadv_v_primary_iface_set(struct batadv_hard_iface *hard_iface) ...@@ -100,7 +100,7 @@ static void batadv_v_primary_iface_set(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_iface_update_mac - react to hard-interface MAC address change * batadv_v_iface_update_mac() - react to hard-interface MAC address change
* @hard_iface: the modified interface * @hard_iface: the modified interface
* *
* If the modified interface is the primary one, update the originator * If the modified interface is the primary one, update the originator
...@@ -131,7 +131,7 @@ batadv_v_hardif_neigh_init(struct batadv_hardif_neigh_node *hardif_neigh) ...@@ -131,7 +131,7 @@ batadv_v_hardif_neigh_init(struct batadv_hardif_neigh_node *hardif_neigh)
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_v_orig_print_neigh - print neighbors for the originator table * batadv_v_orig_print_neigh() - print neighbors for the originator table
* @orig_node: the orig_node for which the neighbors are printed * @orig_node: the orig_node for which the neighbors are printed
* @if_outgoing: outgoing interface for these entries * @if_outgoing: outgoing interface for these entries
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
...@@ -161,7 +161,7 @@ batadv_v_orig_print_neigh(struct batadv_orig_node *orig_node, ...@@ -161,7 +161,7 @@ batadv_v_orig_print_neigh(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_v_hardif_neigh_print - print a single ELP neighbour node * batadv_v_hardif_neigh_print() - print a single ELP neighbour node
* @seq: neighbour table seq_file struct * @seq: neighbour table seq_file struct
* @hardif_neigh: hardif neighbour information * @hardif_neigh: hardif neighbour information
*/ */
...@@ -182,7 +182,7 @@ batadv_v_hardif_neigh_print(struct seq_file *seq, ...@@ -182,7 +182,7 @@ batadv_v_hardif_neigh_print(struct seq_file *seq,
} }
/** /**
* batadv_v_neigh_print - print the single hop neighbour list * batadv_v_neigh_print() - print the single hop neighbour list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq: neighbour table seq_file struct * @seq: neighbour table seq_file struct
*/ */
...@@ -216,7 +216,7 @@ static void batadv_v_neigh_print(struct batadv_priv *bat_priv, ...@@ -216,7 +216,7 @@ static void batadv_v_neigh_print(struct batadv_priv *bat_priv,
#endif #endif
/** /**
* batadv_v_neigh_dump_neigh - Dump a neighbour into a message * batadv_v_neigh_dump_neigh() - Dump a neighbour into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
...@@ -259,7 +259,7 @@ batadv_v_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq, ...@@ -259,7 +259,7 @@ batadv_v_neigh_dump_neigh(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_neigh_dump_hardif - Dump the neighbours of a hard interface into * batadv_v_neigh_dump_hardif() - Dump the neighbours of a hard interface into
* a message * a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
...@@ -297,7 +297,7 @@ batadv_v_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq, ...@@ -297,7 +297,7 @@ batadv_v_neigh_dump_hardif(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_neigh_dump - Dump the neighbours of a hard interface into a * batadv_v_neigh_dump() - Dump the neighbours of a hard interface into a
* message * message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
...@@ -349,7 +349,7 @@ batadv_v_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb, ...@@ -349,7 +349,7 @@ batadv_v_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb,
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_v_orig_print - print the originator table * batadv_v_orig_print() - print the originator table
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
* @if_outgoing: the outgoing interface for which this should be printed * @if_outgoing: the outgoing interface for which this should be printed
...@@ -417,8 +417,7 @@ static void batadv_v_orig_print(struct batadv_priv *bat_priv, ...@@ -417,8 +417,7 @@ static void batadv_v_orig_print(struct batadv_priv *bat_priv,
#endif #endif
/** /**
* batadv_v_orig_dump_subentry - Dump an originator subentry into a * batadv_v_orig_dump_subentry() - Dump an originator subentry into a message
* message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
...@@ -484,7 +483,7 @@ batadv_v_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq, ...@@ -484,7 +483,7 @@ batadv_v_orig_dump_subentry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_orig_dump_entry - Dump an originator entry into a message * batadv_v_orig_dump_entry() - Dump an originator entry into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
...@@ -537,8 +536,7 @@ batadv_v_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq, ...@@ -537,8 +536,7 @@ batadv_v_orig_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_orig_dump_bucket - Dump an originator bucket into a * batadv_v_orig_dump_bucket() - Dump an originator bucket into a message
* message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
...@@ -579,7 +577,7 @@ batadv_v_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq, ...@@ -579,7 +577,7 @@ batadv_v_orig_dump_bucket(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_v_orig_dump - Dump the originators into a message * batadv_v_orig_dump() - Dump the originators into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
* @bat_priv: The bat priv with all the soft interface information * @bat_priv: The bat priv with all the soft interface information
...@@ -669,7 +667,7 @@ static bool batadv_v_neigh_is_sob(struct batadv_neigh_node *neigh1, ...@@ -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 * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_v_init_sel_class(struct batadv_priv *bat_priv) static void batadv_v_init_sel_class(struct batadv_priv *bat_priv)
...@@ -705,7 +703,7 @@ static ssize_t batadv_v_show_sel_class(struct batadv_priv *bat_priv, char *buff) ...@@ -705,7 +703,7 @@ static ssize_t batadv_v_show_sel_class(struct batadv_priv *bat_priv, char *buff)
} }
/** /**
* batadv_v_gw_throughput_get - retrieve the GW-bandwidth for a given GW * batadv_v_gw_throughput_get() - retrieve the GW-bandwidth for a given GW
* @gw_node: the GW to retrieve the metric for * @gw_node: the GW to retrieve the metric for
* @bw: the pointer where the metric will be stored. The metric is computed as * @bw: the pointer where the metric will be stored. The metric is computed as
* the minimum between the GW advertised throughput and the path throughput to * the minimum between the GW advertised throughput and the path throughput to
...@@ -748,7 +746,7 @@ static int batadv_v_gw_throughput_get(struct batadv_gw_node *gw_node, u32 *bw) ...@@ -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 * @bat_priv: the bat priv with all the soft interface information
* *
* Return: the GW node having the best GW-metric, NULL if no GW is known * Return: the GW node having the best GW-metric, NULL if no GW is known
...@@ -786,7 +784,7 @@ batadv_v_gw_get_best_gw_node(struct batadv_priv *bat_priv) ...@@ -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 * @bat_priv: the bat priv with all the soft interface information
* @curr_gw_orig: originator representing the currently selected GW * @curr_gw_orig: originator representing the currently selected GW
* @orig_node: the originator representing the new candidate * @orig_node: the originator representing the new candidate
...@@ -885,7 +883,7 @@ static int batadv_v_gw_write_buffer_text(struct batadv_priv *bat_priv, ...@@ -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 * @bat_priv: the bat priv with all the soft interface information
* @seq: gateway table seq_file struct * @seq: gateway table seq_file struct
*/ */
...@@ -914,7 +912,7 @@ static void batadv_v_gw_print(struct batadv_priv *bat_priv, ...@@ -914,7 +912,7 @@ static void batadv_v_gw_print(struct batadv_priv *bat_priv,
#endif #endif
/** /**
* batadv_v_gw_dump_entry - Dump a gateway into a message * batadv_v_gw_dump_entry() - Dump a gateway into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
...@@ -1005,7 +1003,7 @@ static int batadv_v_gw_dump_entry(struct sk_buff *msg, u32 portid, u32 seq, ...@@ -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 * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
* @bat_priv: The bat priv with all the soft interface information * @bat_priv: The bat priv with all the soft interface information
...@@ -1075,7 +1073,7 @@ static struct batadv_algo_ops batadv_batman_v __read_mostly = { ...@@ -1075,7 +1073,7 @@ static struct batadv_algo_ops batadv_batman_v __read_mostly = {
}; };
/** /**
* batadv_v_hardif_init - initialize the algorithm specific fields in the * batadv_v_hardif_init() - initialize the algorithm specific fields in the
* hard-interface object * hard-interface object
* @hard_iface: the hard-interface to initialize * @hard_iface: the hard-interface to initialize
*/ */
...@@ -1089,7 +1087,7 @@ void batadv_v_hardif_init(struct batadv_hard_iface *hard_iface) ...@@ -1089,7 +1087,7 @@ void batadv_v_hardif_init(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_mesh_init - initialize the B.A.T.M.A.N. V private resources for a * batadv_v_mesh_init() - initialize the B.A.T.M.A.N. V private resources for a
* mesh * mesh
* @bat_priv: the object representing the mesh interface to initialise * @bat_priv: the object representing the mesh interface to initialise
* *
...@@ -1107,7 +1105,7 @@ int batadv_v_mesh_init(struct batadv_priv *bat_priv) ...@@ -1107,7 +1105,7 @@ int batadv_v_mesh_init(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_v_mesh_free - free the B.A.T.M.A.N. V private resources for a mesh * batadv_v_mesh_free() - free the B.A.T.M.A.N. V private resources for a mesh
* @bat_priv: the object representing the mesh interface to free * @bat_priv: the object representing the mesh interface to free
*/ */
void batadv_v_mesh_free(struct batadv_priv *bat_priv) void batadv_v_mesh_free(struct batadv_priv *bat_priv)
...@@ -1116,7 +1114,7 @@ void batadv_v_mesh_free(struct batadv_priv *bat_priv) ...@@ -1116,7 +1114,7 @@ void batadv_v_mesh_free(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_v_init - B.A.T.M.A.N. V initialization function * batadv_v_init() - B.A.T.M.A.N. V initialization function
* *
* Description: Takes care of initializing all the subcomponents. * Description: Takes care of initializing all the subcomponents.
* It is invoked upon module load only. * It is invoked upon module load only.
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
#include "send.h" #include "send.h"
/** /**
* batadv_v_elp_start_timer - restart timer for ELP periodic work * batadv_v_elp_start_timer() - restart timer for ELP periodic work
* @hard_iface: the interface for which the timer has to be reset * @hard_iface: the interface for which the timer has to be reset
*/ */
static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface) static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)
...@@ -68,7 +68,7 @@ static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface) ...@@ -68,7 +68,7 @@ static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_elp_get_throughput - get the throughput towards a neighbour * batadv_v_elp_get_throughput() - get the throughput towards a neighbour
* @neigh: the neighbour for which the throughput has to be obtained * @neigh: the neighbour for which the throughput has to be obtained
* *
* Return: The throughput towards the given neighbour in multiples of 100kpbs * Return: The throughput towards the given neighbour in multiples of 100kpbs
...@@ -154,8 +154,8 @@ static u32 batadv_v_elp_get_throughput(struct batadv_hardif_neigh_node *neigh) ...@@ -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 * batadv_v_elp_throughput_metric_update() - worker updating the throughput
* of a single hop neighbour * metric of a single hop neighbour
* @work: the work queue item * @work: the work queue item
*/ */
void batadv_v_elp_throughput_metric_update(struct work_struct *work) void batadv_v_elp_throughput_metric_update(struct work_struct *work)
...@@ -178,7 +178,7 @@ void batadv_v_elp_throughput_metric_update(struct work_struct *work) ...@@ -178,7 +178,7 @@ void batadv_v_elp_throughput_metric_update(struct work_struct *work)
} }
/** /**
* batadv_v_elp_wifi_neigh_probe - send link probing packets to a neighbour * batadv_v_elp_wifi_neigh_probe() - send link probing packets to a neighbour
* @neigh: the neighbour to probe * @neigh: the neighbour to probe
* *
* Sends a predefined number of unicast wifi packets to a given neighbour in * Sends a predefined number of unicast wifi packets to a given neighbour in
...@@ -241,7 +241,7 @@ batadv_v_elp_wifi_neigh_probe(struct batadv_hardif_neigh_node *neigh) ...@@ -241,7 +241,7 @@ batadv_v_elp_wifi_neigh_probe(struct batadv_hardif_neigh_node *neigh)
} }
/** /**
* batadv_v_elp_periodic_work - ELP periodic task per interface * batadv_v_elp_periodic_work() - ELP periodic task per interface
* @work: work queue item * @work: work queue item
* *
* Emits broadcast ELP message in regular intervals. * Emits broadcast ELP message in regular intervals.
...@@ -328,7 +328,7 @@ static void batadv_v_elp_periodic_work(struct work_struct *work) ...@@ -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 * @hard_iface: interface for which the data has to be prepared
* *
* Return: 0 on success or a -ENOMEM in case of failure. * Return: 0 on success or a -ENOMEM in case of failure.
...@@ -376,7 +376,7 @@ int batadv_v_elp_iface_enable(struct batadv_hard_iface *hard_iface) ...@@ -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 * @hard_iface: interface for which the resources have to be released
*/ */
void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface) void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)
...@@ -388,7 +388,7 @@ void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface) ...@@ -388,7 +388,7 @@ void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_elp_iface_activate - update the ELP buffer belonging to the given * batadv_v_elp_iface_activate() - update the ELP buffer belonging to the given
* hard-interface * hard-interface
* @primary_iface: the new primary interface * @primary_iface: the new primary interface
* @hard_iface: interface holding the to-be-updated buffer * @hard_iface: interface holding the to-be-updated buffer
...@@ -409,7 +409,7 @@ void batadv_v_elp_iface_activate(struct batadv_hard_iface *primary_iface, ...@@ -409,7 +409,7 @@ void batadv_v_elp_iface_activate(struct batadv_hard_iface *primary_iface,
} }
/** /**
* batadv_v_elp_primary_iface_set - change internal data to reflect the new * batadv_v_elp_primary_iface_set() - change internal data to reflect the new
* primary interface * primary interface
* @primary_iface: the new primary interface * @primary_iface: the new primary interface
*/ */
...@@ -429,7 +429,7 @@ void batadv_v_elp_primary_iface_set(struct batadv_hard_iface *primary_iface) ...@@ -429,7 +429,7 @@ void batadv_v_elp_primary_iface_set(struct batadv_hard_iface *primary_iface)
} }
/** /**
* batadv_v_elp_neigh_update - update an ELP neighbour node * batadv_v_elp_neigh_update() - update an ELP neighbour node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @neigh_addr: the neighbour interface address * @neigh_addr: the neighbour interface address
* @if_incoming: the interface the packet was received through * @if_incoming: the interface the packet was received through
...@@ -489,7 +489,7 @@ static void batadv_v_elp_neigh_update(struct batadv_priv *bat_priv, ...@@ -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 * @skb: the received packet
* @if_incoming: the interface this packet was received through * @if_incoming: the interface this packet was received through
* *
......
...@@ -52,7 +52,7 @@ ...@@ -52,7 +52,7 @@
#include "tvlv.h" #include "tvlv.h"
/** /**
* batadv_v_ogm_orig_get - retrieve and possibly create an originator node * batadv_v_ogm_orig_get() - retrieve and possibly create an originator node
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the address of the originator * @addr: the address of the originator
* *
...@@ -89,7 +89,7 @@ struct batadv_orig_node *batadv_v_ogm_orig_get(struct batadv_priv *bat_priv, ...@@ -89,7 +89,7 @@ struct batadv_orig_node *batadv_v_ogm_orig_get(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_v_ogm_start_timer - restart the OGM sending timer * batadv_v_ogm_start_timer() - restart the OGM sending timer
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv) static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv)
...@@ -108,7 +108,7 @@ static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv) ...@@ -108,7 +108,7 @@ static void batadv_v_ogm_start_timer(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_v_ogm_send_to_if - send a batman ogm using a given interface * batadv_v_ogm_send_to_if() - send a batman ogm using a given interface
* @skb: the OGM to send * @skb: the OGM to send
* @hard_iface: the interface to use to send the OGM * @hard_iface: the interface to use to send the OGM
*/ */
...@@ -128,7 +128,7 @@ static void batadv_v_ogm_send_to_if(struct sk_buff *skb, ...@@ -128,7 +128,7 @@ static void batadv_v_ogm_send_to_if(struct sk_buff *skb,
} }
/** /**
* batadv_v_ogm_send - periodic worker broadcasting the own OGM * batadv_v_ogm_send() - periodic worker broadcasting the own OGM
* @work: work queue item * @work: work queue item
*/ */
static void batadv_v_ogm_send(struct work_struct *work) static void batadv_v_ogm_send(struct work_struct *work)
...@@ -236,7 +236,7 @@ static void batadv_v_ogm_send(struct work_struct *work) ...@@ -236,7 +236,7 @@ static void batadv_v_ogm_send(struct work_struct *work)
} }
/** /**
* batadv_v_ogm_iface_enable - prepare an interface for B.A.T.M.A.N. V * batadv_v_ogm_iface_enable() - prepare an interface for B.A.T.M.A.N. V
* @hard_iface: the interface to prepare * @hard_iface: the interface to prepare
* *
* Takes care of scheduling own OGM sending routine for this interface. * Takes care of scheduling own OGM sending routine for this interface.
...@@ -253,7 +253,7 @@ int batadv_v_ogm_iface_enable(struct batadv_hard_iface *hard_iface) ...@@ -253,7 +253,7 @@ int batadv_v_ogm_iface_enable(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_v_ogm_primary_iface_set - set a new primary interface * batadv_v_ogm_primary_iface_set() - set a new primary interface
* @primary_iface: the new primary interface * @primary_iface: the new primary interface
*/ */
void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface) void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface)
...@@ -269,8 +269,8 @@ void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface) ...@@ -269,8 +269,8 @@ void batadv_v_ogm_primary_iface_set(struct batadv_hard_iface *primary_iface)
} }
/** /**
* batadv_v_forward_penalty - apply a penalty to the throughput metric forwarded * batadv_v_forward_penalty() - apply a penalty to the throughput metric
* with B.A.T.M.A.N. V OGMs * forwarded with B.A.T.M.A.N. V OGMs
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @if_incoming: the interface where the OGM has been received * @if_incoming: the interface where the OGM has been received
* @if_outgoing: the interface where the OGM has to be forwarded to * @if_outgoing: the interface where the OGM has to be forwarded to
...@@ -315,7 +315,7 @@ static u32 batadv_v_forward_penalty(struct batadv_priv *bat_priv, ...@@ -315,7 +315,7 @@ static u32 batadv_v_forward_penalty(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_v_ogm_forward - check conditions and forward an OGM to the given * batadv_v_ogm_forward() - check conditions and forward an OGM to the given
* outgoing interface * outgoing interface
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ogm_received: previously received OGM to be forwarded * @ogm_received: previously received OGM to be forwarded
...@@ -406,7 +406,7 @@ static void batadv_v_ogm_forward(struct batadv_priv *bat_priv, ...@@ -406,7 +406,7 @@ static void batadv_v_ogm_forward(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_v_ogm_metric_update - update route metric based on OGM * batadv_v_ogm_metric_update() - update route metric based on OGM
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ogm2: OGM2 structure * @ogm2: OGM2 structure
* @orig_node: Originator structure for which the OGM has been received * @orig_node: Originator structure for which the OGM has been received
...@@ -491,7 +491,7 @@ static int batadv_v_ogm_metric_update(struct batadv_priv *bat_priv, ...@@ -491,7 +491,7 @@ static int batadv_v_ogm_metric_update(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_v_ogm_route_update - update routes based on OGM * batadv_v_ogm_route_update() - update routes based on OGM
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ethhdr: the Ethernet header of the OGM2 * @ethhdr: the Ethernet header of the OGM2
* @ogm2: OGM2 structure * @ogm2: OGM2 structure
...@@ -591,7 +591,7 @@ static bool batadv_v_ogm_route_update(struct batadv_priv *bat_priv, ...@@ -591,7 +591,7 @@ static bool batadv_v_ogm_route_update(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_v_ogm_process_per_outif - process a batman v OGM for an outgoing if * batadv_v_ogm_process_per_outif() - process a batman v OGM for an outgoing if
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ethhdr: the Ethernet header of the OGM2 * @ethhdr: the Ethernet header of the OGM2
* @ogm2: OGM2 structure * @ogm2: OGM2 structure
...@@ -640,7 +640,7 @@ batadv_v_ogm_process_per_outif(struct batadv_priv *bat_priv, ...@@ -640,7 +640,7 @@ batadv_v_ogm_process_per_outif(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_v_ogm_aggr_packet - checks if there is another OGM aggregated * batadv_v_ogm_aggr_packet() - checks if there is another OGM aggregated
* @buff_pos: current position in the skb * @buff_pos: current position in the skb
* @packet_len: total length of the skb * @packet_len: total length of the skb
* @tvlv_len: tvlv length of the previously considered OGM * @tvlv_len: tvlv length of the previously considered OGM
...@@ -660,7 +660,7 @@ static bool batadv_v_ogm_aggr_packet(int buff_pos, int packet_len, ...@@ -660,7 +660,7 @@ static bool batadv_v_ogm_aggr_packet(int buff_pos, int packet_len,
} }
/** /**
* batadv_v_ogm_process - process an incoming batman v OGM * batadv_v_ogm_process() - process an incoming batman v OGM
* @skb: the skb containing the OGM * @skb: the skb containing the OGM
* @ogm_offset: offset to the OGM which should be processed (for aggregates) * @ogm_offset: offset to the OGM which should be processed (for aggregates)
* @if_incoming: the interface where this packet was receved * @if_incoming: the interface where this packet was receved
...@@ -788,7 +788,7 @@ static void batadv_v_ogm_process(const struct sk_buff *skb, int ogm_offset, ...@@ -788,7 +788,7 @@ static void batadv_v_ogm_process(const struct sk_buff *skb, int ogm_offset,
} }
/** /**
* batadv_v_ogm_packet_recv - OGM2 receiving handler * batadv_v_ogm_packet_recv() - OGM2 receiving handler
* @skb: the received OGM * @skb: the received OGM
* @if_incoming: the interface where this OGM has been received * @if_incoming: the interface where this OGM has been received
* *
...@@ -852,7 +852,7 @@ int batadv_v_ogm_packet_recv(struct sk_buff *skb, ...@@ -852,7 +852,7 @@ int batadv_v_ogm_packet_recv(struct sk_buff *skb,
} }
/** /**
* batadv_v_ogm_init - initialise the OGM2 engine * batadv_v_ogm_init() - initialise the OGM2 engine
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Return: 0 on success or a negative error code in case of failure * Return: 0 on success or a negative error code in case of failure
...@@ -885,7 +885,7 @@ int batadv_v_ogm_init(struct batadv_priv *bat_priv) ...@@ -885,7 +885,7 @@ int batadv_v_ogm_init(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_v_ogm_free - free OGM private resources * batadv_v_ogm_free() - free OGM private resources
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_v_ogm_free(struct batadv_priv *bat_priv) void batadv_v_ogm_free(struct batadv_priv *bat_priv)
......
...@@ -33,7 +33,7 @@ static void batadv_bitmap_shift_left(unsigned long *seq_bits, s32 n) ...@@ -33,7 +33,7 @@ static void batadv_bitmap_shift_left(unsigned long *seq_bits, s32 n)
} }
/** /**
* batadv_bit_get_packet - receive and process one packet within the sequence * batadv_bit_get_packet() - receive and process one packet within the sequence
* number window * number window
* @priv: the bat priv with all the soft interface information * @priv: the bat priv with all the soft interface information
* @seq_bits: pointer to the sequence number receive packet * @seq_bits: pointer to the sequence number receive packet
......
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
#include <linux/types.h> #include <linux/types.h>
/** /**
* batadv_test_bit - check if bit is set in the current window * batadv_test_bit() - check if bit is set in the current window
* *
* @seq_bits: pointer to the sequence number receive packet * @seq_bits: pointer to the sequence number receive packet
* @last_seqno: latest sequence number in seq_bits * @last_seqno: latest sequence number in seq_bits
......
This diff is collapsed.
...@@ -31,8 +31,8 @@ struct seq_file; ...@@ -31,8 +31,8 @@ struct seq_file;
struct sk_buff; struct sk_buff;
/** /**
* batadv_bla_is_loopdetect_mac - check if the mac address is from a loop detect * batadv_bla_is_loopdetect_mac() - check if the mac address is from a loop
* frame sent by bridge loop avoidance * detect frame sent by bridge loop avoidance
* @mac: mac address to check * @mac: mac address to check
* *
* Return: true if the it looks like a loop detect frame * Return: true if the it looks like a loop detect frame
......
...@@ -66,8 +66,8 @@ static int batadv_originators_open(struct inode *inode, struct file *file) ...@@ -66,8 +66,8 @@ static int batadv_originators_open(struct inode *inode, struct file *file)
} }
/** /**
* batadv_originators_hardif_open - handles debugfs output for the * batadv_originators_hardif_open() - handles debugfs output for the originator
* originator table of an hard interface * table of an hard interface
* @inode: inode pointer to debugfs file * @inode: inode pointer to debugfs file
* @file: pointer to the seq_file * @file: pointer to the seq_file
* *
...@@ -117,7 +117,7 @@ static int batadv_bla_backbone_table_open(struct inode *inode, ...@@ -117,7 +117,7 @@ static int batadv_bla_backbone_table_open(struct inode *inode,
#ifdef CONFIG_BATMAN_ADV_DAT #ifdef CONFIG_BATMAN_ADV_DAT
/** /**
* batadv_dat_cache_open - Prepare file handler for reads from dat_chache * batadv_dat_cache_open() - Prepare file handler for reads from dat_chache
* @inode: inode which was opened * @inode: inode which was opened
* @file: file handle to be initialized * @file: file handle to be initialized
* *
...@@ -154,7 +154,7 @@ static int batadv_nc_nodes_open(struct inode *inode, struct file *file) ...@@ -154,7 +154,7 @@ static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
#ifdef CONFIG_BATMAN_ADV_MCAST #ifdef CONFIG_BATMAN_ADV_MCAST
/** /**
* batadv_mcast_flags_open - prepare file handler for reads from mcast_flags * batadv_mcast_flags_open() - prepare file handler for reads from mcast_flags
* @inode: inode which was opened * @inode: inode which was opened
* @file: file handle to be initialized * @file: file handle to be initialized
* *
...@@ -296,7 +296,7 @@ void batadv_debugfs_destroy(void) ...@@ -296,7 +296,7 @@ void batadv_debugfs_destroy(void)
} }
/** /**
* batadv_debugfs_add_hardif - creates the base directory for a hard interface * batadv_debugfs_add_hardif() - creates the base directory for a hard interface
* in debugfs. * in debugfs.
* @hard_iface: hard interface which should be added. * @hard_iface: hard interface which should be added.
* *
...@@ -338,7 +338,7 @@ int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface) ...@@ -338,7 +338,7 @@ int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_debugfs_del_hardif - delete the base directory for a hard interface * batadv_debugfs_del_hardif() - delete the base directory for a hard interface
* in debugfs. * in debugfs.
* @hard_iface: hard interface which is deleted. * @hard_iface: hard interface which is deleted.
*/ */
......
This diff is collapsed.
...@@ -49,7 +49,7 @@ bool batadv_dat_drop_broadcast_packet(struct batadv_priv *bat_priv, ...@@ -49,7 +49,7 @@ bool batadv_dat_drop_broadcast_packet(struct batadv_priv *bat_priv,
struct batadv_forw_packet *forw_packet); struct batadv_forw_packet *forw_packet);
/** /**
* batadv_dat_init_orig_node_addr - assign a DAT address to the orig_node * batadv_dat_init_orig_node_addr() - assign a DAT address to the orig_node
* @orig_node: the node to assign the DAT address to * @orig_node: the node to assign the DAT address to
*/ */
static inline void static inline void
...@@ -62,7 +62,7 @@ batadv_dat_init_orig_node_addr(struct batadv_orig_node *orig_node) ...@@ -62,7 +62,7 @@ batadv_dat_init_orig_node_addr(struct batadv_orig_node *orig_node)
} }
/** /**
* batadv_dat_init_own_addr - assign a DAT address to the node itself * batadv_dat_init_own_addr() - assign a DAT address to the node itself
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @primary_if: a pointer to the primary interface * @primary_if: a pointer to the primary interface
*/ */
...@@ -83,7 +83,7 @@ void batadv_dat_free(struct batadv_priv *bat_priv); ...@@ -83,7 +83,7 @@ void batadv_dat_free(struct batadv_priv *bat_priv);
int batadv_dat_cache_seq_print_text(struct seq_file *seq, void *offset); int batadv_dat_cache_seq_print_text(struct seq_file *seq, void *offset);
/** /**
* batadv_dat_inc_counter - increment the correct DAT packet counter * batadv_dat_inc_counter() - increment the correct DAT packet counter
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @subtype: the 4addr subtype of the packet to be counted * @subtype: the 4addr subtype of the packet to be counted
* *
......
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
#include "soft-interface.h" #include "soft-interface.h"
/** /**
* batadv_frag_clear_chain - delete entries in the fragment buffer chain * batadv_frag_clear_chain() - delete entries in the fragment buffer chain
* @head: head of chain with entries. * @head: head of chain with entries.
* @dropped: whether the chain is cleared because all fragments are dropped * @dropped: whether the chain is cleared because all fragments are dropped
* *
...@@ -66,7 +66,7 @@ static void batadv_frag_clear_chain(struct hlist_head *head, bool dropped) ...@@ -66,7 +66,7 @@ static void batadv_frag_clear_chain(struct hlist_head *head, bool dropped)
} }
/** /**
* batadv_frag_purge_orig - free fragments associated to an orig * batadv_frag_purge_orig() - free fragments associated to an orig
* @orig_node: originator to free fragments from * @orig_node: originator to free fragments from
* @check_cb: optional function to tell if an entry should be purged * @check_cb: optional function to tell if an entry should be purged
*/ */
...@@ -90,7 +90,7 @@ void batadv_frag_purge_orig(struct batadv_orig_node *orig_node, ...@@ -90,7 +90,7 @@ void batadv_frag_purge_orig(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_frag_size_limit - maximum possible size of packet to be fragmented * batadv_frag_size_limit() - maximum possible size of packet to be fragmented
* *
* Return: the maximum size of payload that can be fragmented. * Return: the maximum size of payload that can be fragmented.
*/ */
...@@ -105,7 +105,7 @@ static int batadv_frag_size_limit(void) ...@@ -105,7 +105,7 @@ static int batadv_frag_size_limit(void)
} }
/** /**
* batadv_frag_init_chain - check and prepare fragment chain for new fragment * batadv_frag_init_chain() - check and prepare fragment chain for new fragment
* @chain: chain in fragments table to init * @chain: chain in fragments table to init
* @seqno: sequence number of the received fragment * @seqno: sequence number of the received fragment
* *
...@@ -135,7 +135,7 @@ static bool batadv_frag_init_chain(struct batadv_frag_table_entry *chain, ...@@ -135,7 +135,7 @@ static bool batadv_frag_init_chain(struct batadv_frag_table_entry *chain,
} }
/** /**
* batadv_frag_insert_packet - insert a fragment into a fragment chain * batadv_frag_insert_packet() - insert a fragment into a fragment chain
* @orig_node: originator that the fragment was received from * @orig_node: originator that the fragment was received from
* @skb: skb to insert * @skb: skb to insert
* @chain_out: list head to attach complete chains of fragments to * @chain_out: list head to attach complete chains of fragments to
...@@ -249,7 +249,7 @@ static bool batadv_frag_insert_packet(struct batadv_orig_node *orig_node, ...@@ -249,7 +249,7 @@ static bool batadv_frag_insert_packet(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_frag_merge_packets - merge a chain of fragments * batadv_frag_merge_packets() - merge a chain of fragments
* @chain: head of chain with fragments * @chain: head of chain with fragments
* *
* Expand the first skb in the chain and copy the content of the remaining * Expand the first skb in the chain and copy the content of the remaining
...@@ -307,7 +307,7 @@ batadv_frag_merge_packets(struct hlist_head *chain) ...@@ -307,7 +307,7 @@ batadv_frag_merge_packets(struct hlist_head *chain)
} }
/** /**
* batadv_frag_skb_buffer - buffer fragment for later merge * batadv_frag_skb_buffer() - buffer fragment for later merge
* @skb: skb to buffer * @skb: skb to buffer
* @orig_node_src: originator that the skb is received from * @orig_node_src: originator that the skb is received from
* *
...@@ -347,7 +347,7 @@ bool batadv_frag_skb_buffer(struct sk_buff **skb, ...@@ -347,7 +347,7 @@ bool batadv_frag_skb_buffer(struct sk_buff **skb,
} }
/** /**
* batadv_frag_skb_fwd - forward fragments that would exceed MTU when merged * batadv_frag_skb_fwd() - forward fragments that would exceed MTU when merged
* @skb: skb to forward * @skb: skb to forward
* @recv_if: interface that the skb is received on * @recv_if: interface that the skb is received on
* @orig_node_src: originator that the skb is received from * @orig_node_src: originator that the skb is received from
...@@ -401,7 +401,7 @@ bool batadv_frag_skb_fwd(struct sk_buff *skb, ...@@ -401,7 +401,7 @@ bool batadv_frag_skb_fwd(struct sk_buff *skb,
} }
/** /**
* batadv_frag_create - create a fragment from skb * batadv_frag_create() - create a fragment from skb
* @skb: skb to create fragment from * @skb: skb to create fragment from
* @frag_head: header to use in new fragment * @frag_head: header to use in new fragment
* @fragment_size: size of new fragment * @fragment_size: size of new fragment
...@@ -439,7 +439,7 @@ static struct sk_buff *batadv_frag_create(struct sk_buff *skb, ...@@ -439,7 +439,7 @@ static struct sk_buff *batadv_frag_create(struct sk_buff *skb,
} }
/** /**
* batadv_frag_send_packet - create up to 16 fragments from the passed skb * batadv_frag_send_packet() - create up to 16 fragments from the passed skb
* @skb: skb to create fragments from * @skb: skb to create fragments from
* @orig_node: final destination of the created fragments * @orig_node: final destination of the created fragments
* @neigh_node: next-hop of the created fragments * @neigh_node: next-hop of the created fragments
......
...@@ -40,7 +40,7 @@ int batadv_frag_send_packet(struct sk_buff *skb, ...@@ -40,7 +40,7 @@ int batadv_frag_send_packet(struct sk_buff *skb,
struct batadv_neigh_node *neigh_node); struct batadv_neigh_node *neigh_node);
/** /**
* batadv_frag_check_entry - check if a list of fragments has timed out * batadv_frag_check_entry() - check if a list of fragments has timed out
* @frags_entry: table entry to check * @frags_entry: table entry to check
* *
* Return: true if the frags entry has timed out, false otherwise. * Return: true if the frags entry has timed out, false otherwise.
......
...@@ -69,8 +69,8 @@ ...@@ -69,8 +69,8 @@
#define BATADV_DHCP_CHADDR_OFFSET 28 #define BATADV_DHCP_CHADDR_OFFSET 28
/** /**
* batadv_gw_node_release - release gw_node from lists and queue for free after * batadv_gw_node_release() - release gw_node from lists and queue for free
* rcu grace period * after rcu grace period
* @ref: kref pointer of the gw_node * @ref: kref pointer of the gw_node
*/ */
static void batadv_gw_node_release(struct kref *ref) static void batadv_gw_node_release(struct kref *ref)
...@@ -84,7 +84,8 @@ static void batadv_gw_node_release(struct kref *ref) ...@@ -84,7 +84,8 @@ static void batadv_gw_node_release(struct kref *ref)
} }
/** /**
* batadv_gw_node_put - decrement the gw_node refcounter and possibly release it * batadv_gw_node_put() - decrement the gw_node refcounter and possibly release
* it
* @gw_node: gateway node to free * @gw_node: gateway node to free
*/ */
void batadv_gw_node_put(struct batadv_gw_node *gw_node) void batadv_gw_node_put(struct batadv_gw_node *gw_node)
...@@ -156,7 +157,7 @@ static void batadv_gw_select(struct batadv_priv *bat_priv, ...@@ -156,7 +157,7 @@ static void batadv_gw_select(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_gw_reselect - force a gateway reselection * batadv_gw_reselect() - force a gateway reselection
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* Set a flag to remind the GW component to perform a new gateway reselection. * Set a flag to remind the GW component to perform a new gateway reselection.
...@@ -172,7 +173,7 @@ void batadv_gw_reselect(struct batadv_priv *bat_priv) ...@@ -172,7 +173,7 @@ void batadv_gw_reselect(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_gw_check_client_stop - check if client mode has been switched off * batadv_gw_check_client_stop() - check if client mode has been switched off
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
* This function assumes the caller has checked that the gw state *is actually * This function assumes the caller has checked that the gw state *is actually
...@@ -322,7 +323,7 @@ void batadv_gw_check_election(struct batadv_priv *bat_priv, ...@@ -322,7 +323,7 @@ void batadv_gw_check_election(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_gw_node_add - add gateway node to list of available gateways * batadv_gw_node_add() - add gateway node to list of available gateways
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: originator announcing gateway capabilities * @orig_node: originator announcing gateway capabilities
* @gateway: announced bandwidth information * @gateway: announced bandwidth information
...@@ -365,7 +366,7 @@ static void batadv_gw_node_add(struct batadv_priv *bat_priv, ...@@ -365,7 +366,7 @@ static void batadv_gw_node_add(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_gw_node_get - retrieve gateway node from list of available gateways * batadv_gw_node_get() - retrieve gateway node from list of available gateways
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: originator announcing gateway capabilities * @orig_node: originator announcing gateway capabilities
* *
...@@ -394,7 +395,7 @@ struct batadv_gw_node *batadv_gw_node_get(struct batadv_priv *bat_priv, ...@@ -394,7 +395,7 @@ struct batadv_gw_node *batadv_gw_node_get(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_gw_node_update - update list of available gateways with changed * batadv_gw_node_update() - update list of available gateways with changed
* bandwidth information * bandwidth information
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: originator announcing gateway capabilities * @orig_node: originator announcing gateway capabilities
...@@ -515,7 +516,7 @@ int batadv_gw_client_seq_print_text(struct seq_file *seq, void *offset) ...@@ -515,7 +516,7 @@ int batadv_gw_client_seq_print_text(struct seq_file *seq, void *offset)
#endif #endif
/** /**
* batadv_gw_dump - Dump gateways into a message * batadv_gw_dump() - Dump gateways into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Control block containing additional options * @cb: Control block containing additional options
* *
...@@ -568,7 +569,7 @@ int batadv_gw_dump(struct sk_buff *msg, struct netlink_callback *cb) ...@@ -568,7 +569,7 @@ int batadv_gw_dump(struct sk_buff *msg, struct netlink_callback *cb)
} }
/** /**
* batadv_gw_dhcp_recipient_get - check if a packet is a DHCP message * batadv_gw_dhcp_recipient_get() - check if a packet is a DHCP message
* @skb: the packet to check * @skb: the packet to check
* @header_len: a pointer to the batman-adv header size * @header_len: a pointer to the batman-adv header size
* @chaddr: buffer where the client address will be stored. Valid * @chaddr: buffer where the client address will be stored. Valid
...@@ -687,7 +688,8 @@ batadv_gw_dhcp_recipient_get(struct sk_buff *skb, unsigned int *header_len, ...@@ -687,7 +688,8 @@ batadv_gw_dhcp_recipient_get(struct sk_buff *skb, unsigned int *header_len,
} }
/** /**
* batadv_gw_out_of_range - check if the dhcp request destination is the best gw * batadv_gw_out_of_range() - check if the dhcp request destination is the best
* gateway
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the outgoing packet * @skb: the outgoing packet
* *
......
...@@ -34,8 +34,8 @@ ...@@ -34,8 +34,8 @@
#include "tvlv.h" #include "tvlv.h"
/** /**
* batadv_parse_throughput - parse supplied string buffer to extract throughput * batadv_parse_throughput() - parse supplied string buffer to extract
* information * throughput information
* @net_dev: the soft interface net device * @net_dev: the soft interface net device
* @buff: string buffer to parse * @buff: string buffer to parse
* @description: text shown when throughput string cannot be parsed * @description: text shown when throughput string cannot be parsed
...@@ -101,8 +101,8 @@ bool batadv_parse_throughput(struct net_device *net_dev, char *buff, ...@@ -101,8 +101,8 @@ bool batadv_parse_throughput(struct net_device *net_dev, char *buff,
} }
/** /**
* batadv_parse_gw_bandwidth - parse supplied string buffer to extract download * batadv_parse_gw_bandwidth() - parse supplied string buffer to extract
* and upload bandwidth information * download and upload bandwidth information
* @net_dev: the soft interface net device * @net_dev: the soft interface net device
* @buff: string buffer to parse * @buff: string buffer to parse
* @down: pointer holding the returned download bandwidth information * @down: pointer holding the returned download bandwidth information
...@@ -137,8 +137,8 @@ static bool batadv_parse_gw_bandwidth(struct net_device *net_dev, char *buff, ...@@ -137,8 +137,8 @@ static bool batadv_parse_gw_bandwidth(struct net_device *net_dev, char *buff,
} }
/** /**
* batadv_gw_tvlv_container_update - update the gw tvlv container after gateway * batadv_gw_tvlv_container_update() - update the gw tvlv container after
* setting change * gateway setting change
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_gw_tvlv_container_update(struct batadv_priv *bat_priv) void batadv_gw_tvlv_container_update(struct batadv_priv *bat_priv)
...@@ -208,7 +208,7 @@ ssize_t batadv_gw_bandwidth_set(struct net_device *net_dev, char *buff, ...@@ -208,7 +208,7 @@ ssize_t batadv_gw_bandwidth_set(struct net_device *net_dev, char *buff,
} }
/** /**
* batadv_gw_tvlv_ogm_handler_v1 - process incoming gateway tvlv container * batadv_gw_tvlv_ogm_handler_v1() - process incoming gateway tvlv container
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig: the orig_node of the ogm * @orig: the orig_node of the ogm
* @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags) * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
...@@ -249,7 +249,7 @@ static void batadv_gw_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv, ...@@ -249,7 +249,7 @@ static void batadv_gw_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_gw_init - initialise the gateway handling internals * batadv_gw_init() - initialise the gateway handling internals
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_gw_init(struct batadv_priv *bat_priv) void batadv_gw_init(struct batadv_priv *bat_priv)
...@@ -265,7 +265,7 @@ void batadv_gw_init(struct batadv_priv *bat_priv) ...@@ -265,7 +265,7 @@ void batadv_gw_init(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_gw_free - free the gateway handling internals * batadv_gw_free() - free the gateway handling internals
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
*/ */
void batadv_gw_free(struct batadv_priv *bat_priv) void batadv_gw_free(struct batadv_priv *bat_priv)
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
#include "translation-table.h" #include "translation-table.h"
/** /**
* batadv_hardif_release - release hard interface from lists and queue for * batadv_hardif_release() - release hard interface from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the hard interface * @ref: kref pointer of the hard interface
*/ */
...@@ -87,7 +87,7 @@ batadv_hardif_get_by_netdev(const struct net_device *net_dev) ...@@ -87,7 +87,7 @@ batadv_hardif_get_by_netdev(const struct net_device *net_dev)
} }
/** /**
* batadv_getlink_net - return link net namespace (of use fallback) * batadv_getlink_net() - return link net namespace (of use fallback)
* @netdev: net_device to check * @netdev: net_device to check
* @fallback_net: return in case get_link_net is not available for @netdev * @fallback_net: return in case get_link_net is not available for @netdev
* *
...@@ -106,7 +106,7 @@ static struct net *batadv_getlink_net(const struct net_device *netdev, ...@@ -106,7 +106,7 @@ static struct net *batadv_getlink_net(const struct net_device *netdev,
} }
/** /**
* batadv_mutual_parents - check if two devices are each others parent * batadv_mutual_parents() - check if two devices are each others parent
* @dev1: 1st net dev * @dev1: 1st net dev
* @net1: 1st devices netns * @net1: 1st devices netns
* @dev2: 2nd net dev * @dev2: 2nd net dev
...@@ -139,7 +139,7 @@ static bool batadv_mutual_parents(const struct net_device *dev1, ...@@ -139,7 +139,7 @@ static bool batadv_mutual_parents(const struct net_device *dev1,
} }
/** /**
* batadv_is_on_batman_iface - check if a device is a batman iface descendant * batadv_is_on_batman_iface() - check if a device is a batman iface descendant
* @net_dev: the device to check * @net_dev: the device to check
* *
* If the user creates any virtual device on top of a batman-adv interface, it * If the user creates any virtual device on top of a batman-adv interface, it
...@@ -203,7 +203,7 @@ static bool batadv_is_valid_iface(const struct net_device *net_dev) ...@@ -203,7 +203,7 @@ static bool batadv_is_valid_iface(const struct net_device *net_dev)
} }
/** /**
* batadv_get_real_netdevice - check if the given netdev struct is a virtual * batadv_get_real_netdevice() - check if the given netdev struct is a virtual
* interface on top of another 'real' interface * interface on top of another 'real' interface
* @netdev: the device to check * @netdev: the device to check
* *
...@@ -247,7 +247,7 @@ static struct net_device *batadv_get_real_netdevice(struct net_device *netdev) ...@@ -247,7 +247,7 @@ static struct net_device *batadv_get_real_netdevice(struct net_device *netdev)
} }
/** /**
* batadv_get_real_netdev - check if the given net_device struct is a virtual * batadv_get_real_netdev() - check if the given net_device struct is a virtual
* interface on top of another 'real' interface * interface on top of another 'real' interface
* @net_device: the device to check * @net_device: the device to check
* *
...@@ -266,7 +266,7 @@ struct net_device *batadv_get_real_netdev(struct net_device *net_device) ...@@ -266,7 +266,7 @@ struct net_device *batadv_get_real_netdev(struct net_device *net_device)
} }
/** /**
* batadv_is_wext_netdev - check if the given net_device struct is a * batadv_is_wext_netdev() - check if the given net_device struct is a
* wext wifi interface * wext wifi interface
* @net_device: the device to check * @net_device: the device to check
* *
...@@ -290,7 +290,7 @@ static bool batadv_is_wext_netdev(struct net_device *net_device) ...@@ -290,7 +290,7 @@ static bool batadv_is_wext_netdev(struct net_device *net_device)
} }
/** /**
* batadv_is_cfg80211_netdev - check if the given net_device struct is a * batadv_is_cfg80211_netdev() - check if the given net_device struct is a
* cfg80211 wifi interface * cfg80211 wifi interface
* @net_device: the device to check * @net_device: the device to check
* *
...@@ -310,7 +310,7 @@ static bool batadv_is_cfg80211_netdev(struct net_device *net_device) ...@@ -310,7 +310,7 @@ static bool batadv_is_cfg80211_netdev(struct net_device *net_device)
} }
/** /**
* batadv_wifi_flags_evaluate - calculate wifi flags for net_device * batadv_wifi_flags_evaluate() - calculate wifi flags for net_device
* @net_device: the device to check * @net_device: the device to check
* *
* Return: batadv_hard_iface_wifi_flags flags of the device * Return: batadv_hard_iface_wifi_flags flags of the device
...@@ -345,7 +345,7 @@ static u32 batadv_wifi_flags_evaluate(struct net_device *net_device) ...@@ -345,7 +345,7 @@ static u32 batadv_wifi_flags_evaluate(struct net_device *net_device)
} }
/** /**
* batadv_is_cfg80211_hardif - check if the given hardif is a cfg80211 wifi * batadv_is_cfg80211_hardif() - check if the given hardif is a cfg80211 wifi
* interface * interface
* @hard_iface: the device to check * @hard_iface: the device to check
* *
...@@ -363,7 +363,7 @@ bool batadv_is_cfg80211_hardif(struct batadv_hard_iface *hard_iface) ...@@ -363,7 +363,7 @@ bool batadv_is_cfg80211_hardif(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_is_wifi_hardif - check if the given hardif is a wifi interface * batadv_is_wifi_hardif() - check if the given hardif is a wifi interface
* @hard_iface: the device to check * @hard_iface: the device to check
* *
* Return: true if the net device is a 802.11 wireless device, false otherwise. * Return: true if the net device is a 802.11 wireless device, false otherwise.
...@@ -377,7 +377,7 @@ bool batadv_is_wifi_hardif(struct batadv_hard_iface *hard_iface) ...@@ -377,7 +377,7 @@ bool batadv_is_wifi_hardif(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_hardif_no_broadcast - check whether (re)broadcast is necessary * batadv_hardif_no_broadcast() - check whether (re)broadcast is necessary
* @if_outgoing: the outgoing interface checked and considered for (re)broadcast * @if_outgoing: the outgoing interface checked and considered for (re)broadcast
* @orig_addr: the originator of this packet * @orig_addr: the originator of this packet
* @orig_neigh: originator address of the forwarder we just got the packet from * @orig_neigh: originator address of the forwarder we just got the packet from
...@@ -668,7 +668,7 @@ batadv_hardif_deactivate_interface(struct batadv_hard_iface *hard_iface) ...@@ -668,7 +668,7 @@ batadv_hardif_deactivate_interface(struct batadv_hard_iface *hard_iface)
} }
/** /**
* batadv_master_del_slave - remove hard_iface from the current master interface * batadv_master_del_slave() - remove hard_iface from the current master iface
* @slave: the interface enslaved in another master * @slave: the interface enslaved in another master
* @master: the master from which slave has to be removed * @master: the master from which slave has to be removed
* *
......
...@@ -83,7 +83,7 @@ int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing, ...@@ -83,7 +83,7 @@ int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing,
u8 *orig_addr, u8 *orig_neigh); u8 *orig_addr, u8 *orig_neigh);
/** /**
* batadv_hardif_put - decrement the hard interface refcounter and possibly * batadv_hardif_put() - decrement the hard interface refcounter and possibly
* release it * release it
* @hard_iface: the hard interface to free * @hard_iface: the hard interface to free
*/ */
......
...@@ -63,7 +63,7 @@ void batadv_hash_set_lock_class(struct batadv_hashtable *hash, ...@@ -63,7 +63,7 @@ void batadv_hash_set_lock_class(struct batadv_hashtable *hash,
void batadv_hash_destroy(struct batadv_hashtable *hash); void batadv_hash_destroy(struct batadv_hashtable *hash);
/** /**
* batadv_hash_add - adds data to the hashtable * batadv_hash_add() - adds data to the hashtable
* @hash: storage hash table * @hash: storage hash table
* @compare: callback to determine if 2 hash elements are identical * @compare: callback to determine if 2 hash elements are identical
* @choose: callback calculating the hash index * @choose: callback calculating the hash index
......
...@@ -335,7 +335,7 @@ int batadv_socket_setup(struct batadv_priv *bat_priv) ...@@ -335,7 +335,7 @@ int batadv_socket_setup(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_socket_add_packet - schedule an icmp packet to be sent to * batadv_socket_add_packet() - schedule an icmp packet to be sent to
* userspace on an icmp socket. * userspace on an icmp socket.
* @socket_client: the socket this packet belongs to * @socket_client: the socket this packet belongs to
* @icmph: pointer to the header of the icmp packet * @icmph: pointer to the header of the icmp packet
...@@ -392,7 +392,7 @@ static void batadv_socket_add_packet(struct batadv_socket_client *socket_client, ...@@ -392,7 +392,7 @@ static void batadv_socket_add_packet(struct batadv_socket_client *socket_client,
} }
/** /**
* batadv_socket_receive_packet - schedule an icmp packet to be received * batadv_socket_receive_packet() - schedule an icmp packet to be received
* locally and sent to userspace. * locally and sent to userspace.
* @icmph: pointer to the header of the icmp packet * @icmph: pointer to the header of the icmp packet
* @icmp_len: total length of the icmp packet * @icmp_len: total length of the icmp packet
......
...@@ -256,8 +256,8 @@ void batadv_mesh_free(struct net_device *soft_iface) ...@@ -256,8 +256,8 @@ void batadv_mesh_free(struct net_device *soft_iface)
} }
/** /**
* batadv_is_my_mac - check if the given mac address belongs to any of the real * batadv_is_my_mac() - check if the given mac address belongs to any of the
* interfaces in the current mesh * real interfaces in the current mesh
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @addr: the address to check * @addr: the address to check
* *
...@@ -287,7 +287,7 @@ bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr) ...@@ -287,7 +287,7 @@ bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr)
#ifdef CONFIG_BATMAN_ADV_DEBUGFS #ifdef CONFIG_BATMAN_ADV_DEBUGFS
/** /**
* batadv_seq_print_text_primary_if_get - called from debugfs table printing * batadv_seq_print_text_primary_if_get() - called from debugfs table printing
* function that requires the primary interface * function that requires the primary interface
* @seq: debugfs table seq_file struct * @seq: debugfs table seq_file struct
* *
...@@ -324,7 +324,7 @@ batadv_seq_print_text_primary_if_get(struct seq_file *seq) ...@@ -324,7 +324,7 @@ batadv_seq_print_text_primary_if_get(struct seq_file *seq)
#endif #endif
/** /**
* batadv_max_header_len - calculate maximum encapsulation overhead for a * batadv_max_header_len() - calculate maximum encapsulation overhead for a
* payload packet * payload packet
* *
* Return: the maximum encapsulation overhead in bytes. * Return: the maximum encapsulation overhead in bytes.
...@@ -349,7 +349,7 @@ int batadv_max_header_len(void) ...@@ -349,7 +349,7 @@ int batadv_max_header_len(void)
} }
/** /**
* batadv_skb_set_priority - sets skb priority according to packet content * batadv_skb_set_priority() - sets skb priority according to packet content
* @skb: the packet to be sent * @skb: the packet to be sent
* @offset: offset to the packet content * @offset: offset to the packet content
* *
...@@ -559,7 +559,7 @@ void batadv_recv_handler_unregister(u8 packet_type) ...@@ -559,7 +559,7 @@ void batadv_recv_handler_unregister(u8 packet_type)
} }
/** /**
* batadv_skb_crc32 - calculate CRC32 of the whole packet and skip bytes in * batadv_skb_crc32() - calculate CRC32 of the whole packet and skip bytes in
* the header * the header
* @skb: skb pointing to fragmented socket buffers * @skb: skb pointing to fragmented socket buffers
* @payload_ptr: Pointer to position inside the head buffer of the skb * @payload_ptr: Pointer to position inside the head buffer of the skb
...@@ -592,7 +592,7 @@ __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr) ...@@ -592,7 +592,7 @@ __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr)
} }
/** /**
* batadv_get_vid - extract the VLAN identifier from skb if any * batadv_get_vid() - extract the VLAN identifier from skb if any
* @skb: the buffer containing the packet * @skb: the buffer containing the packet
* @header_len: length of the batman header preceding the ethernet header * @header_len: length of the batman header preceding the ethernet header
* *
...@@ -619,7 +619,7 @@ unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len) ...@@ -619,7 +619,7 @@ unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len)
} }
/** /**
* batadv_vlan_ap_isola_get - return the AP isolation status for the given vlan * batadv_vlan_ap_isola_get() - return AP isolation status for the given vlan
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: the VLAN identifier for which the AP isolation attributed as to be * @vid: the VLAN identifier for which the AP isolation attributed as to be
* looked up * looked up
......
...@@ -203,7 +203,7 @@ struct seq_file; ...@@ -203,7 +203,7 @@ struct seq_file;
struct sk_buff; struct sk_buff;
/** /**
* batadv_print_vid - return printable version of vid information * batadv_print_vid() - return printable version of vid information
* @vid: the VLAN identifier * @vid: the VLAN identifier
* *
* Return: -1 when no VLAN is used, VLAN id otherwise * Return: -1 when no VLAN is used, VLAN id otherwise
...@@ -239,7 +239,7 @@ void batadv_recv_handler_unregister(u8 packet_type); ...@@ -239,7 +239,7 @@ void batadv_recv_handler_unregister(u8 packet_type);
__be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr); __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
/** /**
* batadv_compare_eth - Compare two not u16 aligned Ethernet addresses * batadv_compare_eth() - Compare two not u16 aligned Ethernet addresses
* @data1: Pointer to a six-byte array containing the Ethernet address * @data1: Pointer to a six-byte array containing the Ethernet address
* @data2: Pointer other six-byte array containing the Ethernet address * @data2: Pointer other six-byte array containing the Ethernet address
* *
...@@ -253,7 +253,7 @@ static inline bool batadv_compare_eth(const void *data1, const void *data2) ...@@ -253,7 +253,7 @@ static inline bool batadv_compare_eth(const void *data1, const void *data2)
} }
/** /**
* batadv_has_timed_out - compares current time (jiffies) and timestamp + * batadv_has_timed_out() - compares current time (jiffies) and timestamp +
* timeout * timeout
* @timestamp: base value to compare with (in jiffies) * @timestamp: base value to compare with (in jiffies)
* @timeout: added to base value before comparing (in milliseconds) * @timeout: added to base value before comparing (in milliseconds)
......
This diff is collapsed.
...@@ -100,7 +100,7 @@ static const struct nla_policy batadv_netlink_policy[NUM_BATADV_ATTR] = { ...@@ -100,7 +100,7 @@ static const struct nla_policy batadv_netlink_policy[NUM_BATADV_ATTR] = {
}; };
/** /**
* batadv_netlink_get_ifindex - Extract an interface index from a message * batadv_netlink_get_ifindex() - Extract an interface index from a message
* @nlh: Message header * @nlh: Message header
* @attrtype: Attribute which holds an interface index * @attrtype: Attribute which holds an interface index
* *
...@@ -115,7 +115,7 @@ batadv_netlink_get_ifindex(const struct nlmsghdr *nlh, int attrtype) ...@@ -115,7 +115,7 @@ batadv_netlink_get_ifindex(const struct nlmsghdr *nlh, int attrtype)
} }
/** /**
* batadv_netlink_mesh_info_put - fill in generic information about mesh * batadv_netlink_mesh_info_put() - fill in generic information about mesh
* interface * interface
* @msg: netlink message to be sent back * @msg: netlink message to be sent back
* @soft_iface: interface for which the data should be taken * @soft_iface: interface for which the data should be taken
...@@ -170,7 +170,7 @@ batadv_netlink_mesh_info_put(struct sk_buff *msg, struct net_device *soft_iface) ...@@ -170,7 +170,7 @@ batadv_netlink_mesh_info_put(struct sk_buff *msg, struct net_device *soft_iface)
} }
/** /**
* batadv_netlink_get_mesh_info - handle incoming BATADV_CMD_GET_MESH_INFO * batadv_netlink_get_mesh_info() - handle incoming BATADV_CMD_GET_MESH_INFO
* netlink request * netlink request
* @skb: received netlink message * @skb: received netlink message
* @info: receiver information * @info: receiver information
...@@ -231,7 +231,7 @@ batadv_netlink_get_mesh_info(struct sk_buff *skb, struct genl_info *info) ...@@ -231,7 +231,7 @@ batadv_netlink_get_mesh_info(struct sk_buff *skb, struct genl_info *info)
} }
/** /**
* batadv_netlink_tp_meter_put - Fill information of started tp_meter session * batadv_netlink_tp_meter_put() - Fill information of started tp_meter session
* @msg: netlink message to be sent back * @msg: netlink message to be sent back
* @cookie: tp meter session cookie * @cookie: tp meter session cookie
* *
...@@ -247,7 +247,7 @@ batadv_netlink_tp_meter_put(struct sk_buff *msg, u32 cookie) ...@@ -247,7 +247,7 @@ batadv_netlink_tp_meter_put(struct sk_buff *msg, u32 cookie)
} }
/** /**
* batadv_netlink_tpmeter_notify - send tp_meter result via netlink to client * batadv_netlink_tpmeter_notify() - send tp_meter result via netlink to client
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @dst: destination of tp_meter session * @dst: destination of tp_meter session
* @result: reason for tp meter session stop * @result: reason for tp meter session stop
...@@ -310,7 +310,7 @@ int batadv_netlink_tpmeter_notify(struct batadv_priv *bat_priv, const u8 *dst, ...@@ -310,7 +310,7 @@ int batadv_netlink_tpmeter_notify(struct batadv_priv *bat_priv, const u8 *dst,
} }
/** /**
* batadv_netlink_tp_meter_start - Start a new tp_meter session * batadv_netlink_tp_meter_start() - Start a new tp_meter session
* @skb: received netlink message * @skb: received netlink message
* @info: receiver information * @info: receiver information
* *
...@@ -387,7 +387,7 @@ batadv_netlink_tp_meter_start(struct sk_buff *skb, struct genl_info *info) ...@@ -387,7 +387,7 @@ batadv_netlink_tp_meter_start(struct sk_buff *skb, struct genl_info *info)
} }
/** /**
* batadv_netlink_tp_meter_start - Cancel a running tp_meter session * batadv_netlink_tp_meter_start() - Cancel a running tp_meter session
* @skb: received netlink message * @skb: received netlink message
* @info: receiver information * @info: receiver information
* *
...@@ -432,7 +432,7 @@ batadv_netlink_tp_meter_cancel(struct sk_buff *skb, struct genl_info *info) ...@@ -432,7 +432,7 @@ batadv_netlink_tp_meter_cancel(struct sk_buff *skb, struct genl_info *info)
} }
/** /**
* batadv_netlink_dump_hardif_entry - Dump one hard interface into a message * batadv_netlink_dump_hardif_entry() - Dump one hard interface into a message
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @portid: Port making netlink request * @portid: Port making netlink request
* @seq: Sequence number of netlink message * @seq: Sequence number of netlink message
...@@ -474,7 +474,7 @@ batadv_netlink_dump_hardif_entry(struct sk_buff *msg, u32 portid, u32 seq, ...@@ -474,7 +474,7 @@ batadv_netlink_dump_hardif_entry(struct sk_buff *msg, u32 portid, u32 seq,
} }
/** /**
* batadv_netlink_dump_hardifs - Dump all hard interface into a messages * batadv_netlink_dump_hardifs() - Dump all hard interface into a messages
* @msg: Netlink message to dump into * @msg: Netlink message to dump into
* @cb: Parameters from query * @cb: Parameters from query
* *
...@@ -621,7 +621,7 @@ struct genl_family batadv_netlink_family __ro_after_init = { ...@@ -621,7 +621,7 @@ struct genl_family batadv_netlink_family __ro_after_init = {
}; };
/** /**
* batadv_netlink_register - register batadv genl netlink family * batadv_netlink_register() - register batadv genl netlink family
*/ */
void __init batadv_netlink_register(void) void __init batadv_netlink_register(void)
{ {
...@@ -633,7 +633,7 @@ void __init batadv_netlink_register(void) ...@@ -633,7 +633,7 @@ void __init batadv_netlink_register(void)
} }
/** /**
* batadv_netlink_unregister - unregister batadv genl netlink family * batadv_netlink_unregister() - unregister batadv genl netlink family
*/ */
void batadv_netlink_unregister(void) void batadv_netlink_unregister(void)
{ {
......
This diff is collapsed.
This diff is collapsed.
...@@ -55,7 +55,7 @@ static int batadv_route_unicast_packet(struct sk_buff *skb, ...@@ -55,7 +55,7 @@ static int batadv_route_unicast_packet(struct sk_buff *skb,
struct batadv_hard_iface *recv_if); struct batadv_hard_iface *recv_if);
/** /**
* _batadv_update_route - set the router for this originator * _batadv_update_route() - set the router for this originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node which is to be configured * @orig_node: orig node which is to be configured
* @recv_if: the receive interface for which this route is set * @recv_if: the receive interface for which this route is set
...@@ -119,7 +119,7 @@ static void _batadv_update_route(struct batadv_priv *bat_priv, ...@@ -119,7 +119,7 @@ static void _batadv_update_route(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_update_route - set the router for this originator * batadv_update_route() - set the router for this originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: orig node which is to be configured * @orig_node: orig node which is to be configured
* @recv_if: the receive interface for which this route is set * @recv_if: the receive interface for which this route is set
...@@ -146,7 +146,7 @@ void batadv_update_route(struct batadv_priv *bat_priv, ...@@ -146,7 +146,7 @@ void batadv_update_route(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_window_protected - checks whether the host restarted and is in the * batadv_window_protected() - checks whether the host restarted and is in the
* protection time. * protection time.
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @seq_num_diff: difference between the current/received sequence number and * @seq_num_diff: difference between the current/received sequence number and
...@@ -213,7 +213,7 @@ bool batadv_check_management_packet(struct sk_buff *skb, ...@@ -213,7 +213,7 @@ bool batadv_check_management_packet(struct sk_buff *skb,
} }
/** /**
* batadv_recv_my_icmp_packet - receive an icmp packet locally * batadv_recv_my_icmp_packet() - receive an icmp packet locally
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: icmp packet to process * @skb: icmp packet to process
* *
...@@ -441,7 +441,7 @@ int batadv_recv_icmp_packet(struct sk_buff *skb, ...@@ -441,7 +441,7 @@ int batadv_recv_icmp_packet(struct sk_buff *skb,
} }
/** /**
* batadv_check_unicast_packet - Check for malformed unicast packets * batadv_check_unicast_packet() - Check for malformed unicast packets
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: packet to check * @skb: packet to check
* @hdr_size: size of header to pull * @hdr_size: size of header to pull
...@@ -479,7 +479,7 @@ static int batadv_check_unicast_packet(struct batadv_priv *bat_priv, ...@@ -479,7 +479,7 @@ static int batadv_check_unicast_packet(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_last_bonding_get - Get last_bonding_candidate of orig_node * batadv_last_bonding_get() - Get last_bonding_candidate of orig_node
* @orig_node: originator node whose last bonding candidate should be retrieved * @orig_node: originator node whose last bonding candidate should be retrieved
* *
* Return: last bonding candidate of router or NULL if not found * Return: last bonding candidate of router or NULL if not found
...@@ -502,7 +502,7 @@ batadv_last_bonding_get(struct batadv_orig_node *orig_node) ...@@ -502,7 +502,7 @@ batadv_last_bonding_get(struct batadv_orig_node *orig_node)
} }
/** /**
* batadv_last_bonding_replace - Replace last_bonding_candidate of orig_node * batadv_last_bonding_replace() - Replace last_bonding_candidate of orig_node
* @orig_node: originator node whose bonding candidates should be replaced * @orig_node: originator node whose bonding candidates should be replaced
* @new_candidate: new bonding candidate or NULL * @new_candidate: new bonding candidate or NULL
*/ */
...@@ -525,7 +525,7 @@ batadv_last_bonding_replace(struct batadv_orig_node *orig_node, ...@@ -525,7 +525,7 @@ batadv_last_bonding_replace(struct batadv_orig_node *orig_node,
} }
/** /**
* batadv_find_router - find a suitable router for this originator * batadv_find_router() - find a suitable router for this originator
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @orig_node: the destination node * @orig_node: the destination node
* @recv_if: pointer to interface this packet was received on * @recv_if: pointer to interface this packet was received on
...@@ -742,7 +742,7 @@ static int batadv_route_unicast_packet(struct sk_buff *skb, ...@@ -742,7 +742,7 @@ static int batadv_route_unicast_packet(struct sk_buff *skb,
} }
/** /**
* batadv_reroute_unicast_packet - update the unicast header for re-routing * batadv_reroute_unicast_packet() - update the unicast header for re-routing
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @unicast_packet: the unicast header to be updated * @unicast_packet: the unicast header to be updated
* @dst_addr: the payload destination * @dst_addr: the payload destination
...@@ -905,7 +905,7 @@ static bool batadv_check_unicast_ttvn(struct batadv_priv *bat_priv, ...@@ -905,7 +905,7 @@ static bool batadv_check_unicast_ttvn(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_recv_unhandled_unicast_packet - receive and process packets which * batadv_recv_unhandled_unicast_packet() - receive and process packets which
* are in the unicast number space but not yet known to the implementation * are in the unicast number space but not yet known to the implementation
* @skb: unicast tvlv packet to process * @skb: unicast tvlv packet to process
* @recv_if: pointer to interface this packet was received on * @recv_if: pointer to interface this packet was received on
...@@ -1037,7 +1037,7 @@ int batadv_recv_unicast_packet(struct sk_buff *skb, ...@@ -1037,7 +1037,7 @@ int batadv_recv_unicast_packet(struct sk_buff *skb,
} }
/** /**
* batadv_recv_unicast_tvlv - receive and process unicast tvlv packets * batadv_recv_unicast_tvlv() - receive and process unicast tvlv packets
* @skb: unicast tvlv packet to process * @skb: unicast tvlv packet to process
* @recv_if: pointer to interface this packet was received on * @recv_if: pointer to interface this packet was received on
* *
...@@ -1091,7 +1091,7 @@ int batadv_recv_unicast_tvlv(struct sk_buff *skb, ...@@ -1091,7 +1091,7 @@ int batadv_recv_unicast_tvlv(struct sk_buff *skb,
} }
/** /**
* batadv_recv_frag_packet - process received fragment * batadv_recv_frag_packet() - process received fragment
* @skb: the received fragment * @skb: the received fragment
* @recv_if: interface that the skb is received on * @recv_if: interface that the skb is received on
* *
......
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
static void batadv_send_outstanding_bcast_packet(struct work_struct *work); static void batadv_send_outstanding_bcast_packet(struct work_struct *work);
/** /**
* batadv_send_skb_packet - send an already prepared packet * batadv_send_skb_packet() - send an already prepared packet
* @skb: the packet to send * @skb: the packet to send
* @hard_iface: the interface to use to send the broadcast packet * @hard_iface: the interface to use to send the broadcast packet
* @dst_addr: the payload destination * @dst_addr: the payload destination
...@@ -154,7 +154,7 @@ int batadv_send_unicast_skb(struct sk_buff *skb, ...@@ -154,7 +154,7 @@ int batadv_send_unicast_skb(struct sk_buff *skb,
} }
/** /**
* batadv_send_skb_to_orig - Lookup next-hop and transmit skb. * batadv_send_skb_to_orig() - Lookup next-hop and transmit skb.
* @skb: Packet to be transmitted. * @skb: Packet to be transmitted.
* @orig_node: Final destination of the packet. * @orig_node: Final destination of the packet.
* @recv_if: Interface used when receiving the packet (can be NULL). * @recv_if: Interface used when receiving the packet (can be NULL).
...@@ -217,7 +217,7 @@ int batadv_send_skb_to_orig(struct sk_buff *skb, ...@@ -217,7 +217,7 @@ int batadv_send_skb_to_orig(struct sk_buff *skb,
} }
/** /**
* batadv_send_skb_push_fill_unicast - extend the buffer and initialize the * batadv_send_skb_push_fill_unicast() - extend the buffer and initialize the
* common fields for unicast packets * common fields for unicast packets
* @skb: the skb carrying the unicast header to initialize * @skb: the skb carrying the unicast header to initialize
* @hdr_size: amount of bytes to push at the beginning of the skb * @hdr_size: amount of bytes to push at the beginning of the skb
...@@ -250,7 +250,7 @@ batadv_send_skb_push_fill_unicast(struct sk_buff *skb, int hdr_size, ...@@ -250,7 +250,7 @@ batadv_send_skb_push_fill_unicast(struct sk_buff *skb, int hdr_size,
} }
/** /**
* batadv_send_skb_prepare_unicast - encapsulate an skb with a unicast header * batadv_send_skb_prepare_unicast() - encapsulate an skb with a unicast header
* @skb: the skb containing the payload to encapsulate * @skb: the skb containing the payload to encapsulate
* @orig_node: the destination node * @orig_node: the destination node
* *
...@@ -265,7 +265,7 @@ static bool batadv_send_skb_prepare_unicast(struct sk_buff *skb, ...@@ -265,7 +265,7 @@ static bool batadv_send_skb_prepare_unicast(struct sk_buff *skb,
} }
/** /**
* batadv_send_skb_prepare_unicast_4addr - encapsulate an skb with a * batadv_send_skb_prepare_unicast_4addr() - encapsulate an skb with a
* unicast 4addr header * unicast 4addr header
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the skb containing the payload to encapsulate * @skb: the skb containing the payload to encapsulate
...@@ -309,7 +309,7 @@ bool batadv_send_skb_prepare_unicast_4addr(struct batadv_priv *bat_priv, ...@@ -309,7 +309,7 @@ bool batadv_send_skb_prepare_unicast_4addr(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_send_skb_unicast - encapsulate and send an skb via unicast * batadv_send_skb_unicast() - encapsulate and send an skb via unicast
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: payload to send * @skb: payload to send
* @packet_type: the batman unicast packet type to use * @packet_type: the batman unicast packet type to use
...@@ -379,7 +379,7 @@ int batadv_send_skb_unicast(struct batadv_priv *bat_priv, ...@@ -379,7 +379,7 @@ int batadv_send_skb_unicast(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_send_skb_via_tt_generic - send an skb via TT lookup * batadv_send_skb_via_tt_generic() - send an skb via TT lookup
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: payload to send * @skb: payload to send
* @packet_type: the batman unicast packet type to use * @packet_type: the batman unicast packet type to use
...@@ -426,7 +426,7 @@ int batadv_send_skb_via_tt_generic(struct batadv_priv *bat_priv, ...@@ -426,7 +426,7 @@ int batadv_send_skb_via_tt_generic(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_send_skb_via_gw - send an skb via gateway lookup * batadv_send_skb_via_gw() - send an skb via gateway lookup
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: payload to send * @skb: payload to send
* @vid: the vid to be used to search the translation table * @vid: the vid to be used to search the translation table
...@@ -453,7 +453,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb, ...@@ -453,7 +453,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb,
} }
/** /**
* batadv_forw_packet_free - free a forwarding packet * batadv_forw_packet_free() - free a forwarding packet
* @forw_packet: The packet to free * @forw_packet: The packet to free
* @dropped: whether the packet is freed because is is dropped * @dropped: whether the packet is freed because is is dropped
* *
...@@ -478,7 +478,7 @@ void batadv_forw_packet_free(struct batadv_forw_packet *forw_packet, ...@@ -478,7 +478,7 @@ void batadv_forw_packet_free(struct batadv_forw_packet *forw_packet,
} }
/** /**
* batadv_forw_packet_alloc - allocate a forwarding packet * batadv_forw_packet_alloc() - allocate a forwarding packet
* @if_incoming: The (optional) if_incoming to be grabbed * @if_incoming: The (optional) if_incoming to be grabbed
* @if_outgoing: The (optional) if_outgoing to be grabbed * @if_outgoing: The (optional) if_outgoing to be grabbed
* @queue_left: The (optional) queue counter to decrease * @queue_left: The (optional) queue counter to decrease
...@@ -544,7 +544,7 @@ batadv_forw_packet_alloc(struct batadv_hard_iface *if_incoming, ...@@ -544,7 +544,7 @@ batadv_forw_packet_alloc(struct batadv_hard_iface *if_incoming,
} }
/** /**
* batadv_forw_packet_was_stolen - check whether someone stole this packet * batadv_forw_packet_was_stolen() - check whether someone stole this packet
* @forw_packet: the forwarding packet to check * @forw_packet: the forwarding packet to check
* *
* This function checks whether the given forwarding packet was claimed by * This function checks whether the given forwarding packet was claimed by
...@@ -559,7 +559,7 @@ batadv_forw_packet_was_stolen(struct batadv_forw_packet *forw_packet) ...@@ -559,7 +559,7 @@ batadv_forw_packet_was_stolen(struct batadv_forw_packet *forw_packet)
} }
/** /**
* batadv_forw_packet_steal - claim a forw_packet for free() * batadv_forw_packet_steal() - claim a forw_packet for free()
* @forw_packet: the forwarding packet to steal * @forw_packet: the forwarding packet to steal
* @lock: a key to the store to steal from (e.g. forw_{bat,bcast}_list_lock) * @lock: a key to the store to steal from (e.g. forw_{bat,bcast}_list_lock)
* *
...@@ -590,7 +590,7 @@ bool batadv_forw_packet_steal(struct batadv_forw_packet *forw_packet, ...@@ -590,7 +590,7 @@ bool batadv_forw_packet_steal(struct batadv_forw_packet *forw_packet,
} }
/** /**
* batadv_forw_packet_list_steal - claim a list of forward packets for free() * batadv_forw_packet_list_steal() - claim a list of forward packets for free()
* @forw_list: the to be stolen forward packets * @forw_list: the to be stolen forward packets
* @cleanup_list: a backup pointer, to be able to dispose the packet later * @cleanup_list: a backup pointer, to be able to dispose the packet later
* @hard_iface: the interface to steal forward packets from * @hard_iface: the interface to steal forward packets from
...@@ -626,7 +626,7 @@ batadv_forw_packet_list_steal(struct hlist_head *forw_list, ...@@ -626,7 +626,7 @@ batadv_forw_packet_list_steal(struct hlist_head *forw_list,
} }
/** /**
* batadv_forw_packet_list_free - free a list of forward packets * batadv_forw_packet_list_free() - free a list of forward packets
* @head: a list of to be freed forw_packets * @head: a list of to be freed forw_packets
* *
* This function cancels the scheduling of any packet in the provided list, * This function cancels the scheduling of any packet in the provided list,
...@@ -650,7 +650,7 @@ static void batadv_forw_packet_list_free(struct hlist_head *head) ...@@ -650,7 +650,7 @@ static void batadv_forw_packet_list_free(struct hlist_head *head)
} }
/** /**
* batadv_forw_packet_queue - try to queue a forwarding packet * batadv_forw_packet_queue() - try to queue a forwarding packet
* @forw_packet: the forwarding packet to queue * @forw_packet: the forwarding packet to queue
* @lock: a key to the store (e.g. forw_{bat,bcast}_list_lock) * @lock: a key to the store (e.g. forw_{bat,bcast}_list_lock)
* @head: the shelve to queue it on (e.g. forw_{bat,bcast}_list) * @head: the shelve to queue it on (e.g. forw_{bat,bcast}_list)
...@@ -694,7 +694,7 @@ static void batadv_forw_packet_queue(struct batadv_forw_packet *forw_packet, ...@@ -694,7 +694,7 @@ static void batadv_forw_packet_queue(struct batadv_forw_packet *forw_packet,
} }
/** /**
* batadv_forw_packet_bcast_queue - try to queue a broadcast packet * batadv_forw_packet_bcast_queue() - try to queue a broadcast packet
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @forw_packet: the forwarding packet to queue * @forw_packet: the forwarding packet to queue
* @send_time: timestamp (jiffies) when the packet is to be sent * @send_time: timestamp (jiffies) when the packet is to be sent
...@@ -713,7 +713,7 @@ batadv_forw_packet_bcast_queue(struct batadv_priv *bat_priv, ...@@ -713,7 +713,7 @@ batadv_forw_packet_bcast_queue(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_forw_packet_ogmv1_queue - try to queue an OGMv1 packet * batadv_forw_packet_ogmv1_queue() - try to queue an OGMv1 packet
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @forw_packet: the forwarding packet to queue * @forw_packet: the forwarding packet to queue
* @send_time: timestamp (jiffies) when the packet is to be sent * @send_time: timestamp (jiffies) when the packet is to be sent
...@@ -731,7 +731,7 @@ void batadv_forw_packet_ogmv1_queue(struct batadv_priv *bat_priv, ...@@ -731,7 +731,7 @@ void batadv_forw_packet_ogmv1_queue(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_add_bcast_packet_to_list - queue broadcast packet for multiple sends * batadv_add_bcast_packet_to_list() - queue broadcast packet for multiple sends
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: broadcast packet to add * @skb: broadcast packet to add
* @delay: number of jiffies to wait before sending * @delay: number of jiffies to wait before sending
...@@ -791,7 +791,7 @@ int batadv_add_bcast_packet_to_list(struct batadv_priv *bat_priv, ...@@ -791,7 +791,7 @@ int batadv_add_bcast_packet_to_list(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_forw_packet_bcasts_left - check if a retransmission is necessary * batadv_forw_packet_bcasts_left() - check if a retransmission is necessary
* @forw_packet: the forwarding packet to check * @forw_packet: the forwarding packet to check
* @hard_iface: the interface to check on * @hard_iface: the interface to check on
* *
...@@ -819,7 +819,8 @@ batadv_forw_packet_bcasts_left(struct batadv_forw_packet *forw_packet, ...@@ -819,7 +819,8 @@ batadv_forw_packet_bcasts_left(struct batadv_forw_packet *forw_packet,
} }
/** /**
* batadv_forw_packet_bcasts_inc - increment retransmission counter of a packet * batadv_forw_packet_bcasts_inc() - increment retransmission counter of a
* packet
* @forw_packet: the packet to increase the counter for * @forw_packet: the packet to increase the counter for
*/ */
static void static void
...@@ -829,7 +830,7 @@ batadv_forw_packet_bcasts_inc(struct batadv_forw_packet *forw_packet) ...@@ -829,7 +830,7 @@ batadv_forw_packet_bcasts_inc(struct batadv_forw_packet *forw_packet)
} }
/** /**
* batadv_forw_packet_is_rebroadcast - check packet for previous transmissions * batadv_forw_packet_is_rebroadcast() - check packet for previous transmissions
* @forw_packet: the packet to check * @forw_packet: the packet to check
* *
* Return: True if this packet was transmitted before, false otherwise. * Return: True if this packet was transmitted before, false otherwise.
...@@ -954,7 +955,7 @@ static void batadv_send_outstanding_bcast_packet(struct work_struct *work) ...@@ -954,7 +955,7 @@ static void batadv_send_outstanding_bcast_packet(struct work_struct *work)
} }
/** /**
* batadv_purge_outstanding_packets - stop/purge scheduled bcast/OGMv1 packets * batadv_purge_outstanding_packets() - stop/purge scheduled bcast/OGMv1 packets
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @hard_iface: the hard interface to cancel and purge bcast/ogm packets on * @hard_iface: the hard interface to cancel and purge bcast/ogm packets on
* *
......
...@@ -77,7 +77,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb, ...@@ -77,7 +77,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb,
unsigned short vid); unsigned short vid);
/** /**
* batadv_send_skb_via_tt - send an skb via TT lookup * batadv_send_skb_via_tt() - send an skb via TT lookup
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the payload to send * @skb: the payload to send
* @dst_hint: can be used to override the destination contained in the skb * @dst_hint: can be used to override the destination contained in the skb
...@@ -98,7 +98,7 @@ static inline int batadv_send_skb_via_tt(struct batadv_priv *bat_priv, ...@@ -98,7 +98,7 @@ static inline int batadv_send_skb_via_tt(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_send_skb_via_tt_4addr - send an skb via TT lookup * batadv_send_skb_via_tt_4addr() - send an skb via TT lookup
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @skb: the payload to send * @skb: the payload to send
* @packet_subtype: the unicast 4addr packet subtype to use * @packet_subtype: the unicast 4addr packet subtype to use
......
...@@ -97,7 +97,7 @@ static int batadv_interface_release(struct net_device *dev) ...@@ -97,7 +97,7 @@ static int batadv_interface_release(struct net_device *dev)
} }
/** /**
* batadv_sum_counter - Sum the cpu-local counters for index 'idx' * batadv_sum_counter() - Sum the cpu-local counters for index 'idx'
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @idx: index of counter to sum up * @idx: index of counter to sum up
* *
...@@ -170,7 +170,7 @@ static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu) ...@@ -170,7 +170,7 @@ static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu)
} }
/** /**
* batadv_interface_set_rx_mode - set the rx mode of a device * batadv_interface_set_rx_mode() - set the rx mode of a device
* @dev: registered network device to modify * @dev: registered network device to modify
* *
* We do not actually need to set any rx filters for the virtual batman * We do not actually need to set any rx filters for the virtual batman
...@@ -390,7 +390,7 @@ static int batadv_interface_tx(struct sk_buff *skb, ...@@ -390,7 +390,7 @@ static int batadv_interface_tx(struct sk_buff *skb,
} }
/** /**
* batadv_interface_rx - receive ethernet frame on local batman-adv interface * batadv_interface_rx() - receive ethernet frame on local batman-adv interface
* @soft_iface: local interface which will receive the ethernet frame * @soft_iface: local interface which will receive the ethernet frame
* @skb: ethernet frame for @soft_iface * @skb: ethernet frame for @soft_iface
* @hdr_size: size of already parsed batman-adv header * @hdr_size: size of already parsed batman-adv header
...@@ -502,8 +502,8 @@ void batadv_interface_rx(struct net_device *soft_iface, ...@@ -502,8 +502,8 @@ void batadv_interface_rx(struct net_device *soft_iface,
} }
/** /**
* batadv_softif_vlan_release - release vlan from lists and queue for free after * batadv_softif_vlan_release() - release vlan from lists and queue for free
* rcu grace period * after rcu grace period
* @ref: kref pointer of the vlan object * @ref: kref pointer of the vlan object
*/ */
static void batadv_softif_vlan_release(struct kref *ref) static void batadv_softif_vlan_release(struct kref *ref)
...@@ -520,7 +520,7 @@ static void batadv_softif_vlan_release(struct kref *ref) ...@@ -520,7 +520,7 @@ static void batadv_softif_vlan_release(struct kref *ref)
} }
/** /**
* batadv_softif_vlan_put - decrease the vlan object refcounter and * batadv_softif_vlan_put() - decrease the vlan object refcounter and
* possibly release it * possibly release it
* @vlan: the vlan object to release * @vlan: the vlan object to release
*/ */
...@@ -533,7 +533,7 @@ void batadv_softif_vlan_put(struct batadv_softif_vlan *vlan) ...@@ -533,7 +533,7 @@ void batadv_softif_vlan_put(struct batadv_softif_vlan *vlan)
} }
/** /**
* batadv_softif_vlan_get - get the vlan object for a specific vid * batadv_softif_vlan_get() - get the vlan object for a specific vid
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: the identifier of the vlan object to retrieve * @vid: the identifier of the vlan object to retrieve
* *
...@@ -562,7 +562,7 @@ struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv, ...@@ -562,7 +562,7 @@ struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_softif_create_vlan - allocate the needed resources for a new vlan * batadv_softif_create_vlan() - allocate the needed resources for a new vlan
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vid: the VLAN identifier * @vid: the VLAN identifier
* *
...@@ -614,7 +614,7 @@ int batadv_softif_create_vlan(struct batadv_priv *bat_priv, unsigned short vid) ...@@ -614,7 +614,7 @@ int batadv_softif_create_vlan(struct batadv_priv *bat_priv, unsigned short vid)
} }
/** /**
* batadv_softif_destroy_vlan - remove and destroy a softif_vlan object * batadv_softif_destroy_vlan() - remove and destroy a softif_vlan object
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vlan: the object to remove * @vlan: the object to remove
*/ */
...@@ -632,7 +632,7 @@ static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv, ...@@ -632,7 +632,7 @@ static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_interface_add_vid - ndo_add_vid API implementation * batadv_interface_add_vid() - ndo_add_vid API implementation
* @dev: the netdev of the mesh interface * @dev: the netdev of the mesh interface
* @proto: protocol of the the vlan id * @proto: protocol of the the vlan id
* @vid: identifier of the new vlan * @vid: identifier of the new vlan
...@@ -690,7 +690,7 @@ static int batadv_interface_add_vid(struct net_device *dev, __be16 proto, ...@@ -690,7 +690,7 @@ static int batadv_interface_add_vid(struct net_device *dev, __be16 proto,
} }
/** /**
* batadv_interface_kill_vid - ndo_kill_vid API implementation * batadv_interface_kill_vid() - ndo_kill_vid API implementation
* @dev: the netdev of the mesh interface * @dev: the netdev of the mesh interface
* @proto: protocol of the the vlan id * @proto: protocol of the the vlan id
* @vid: identifier of the deleted vlan * @vid: identifier of the deleted vlan
...@@ -733,7 +733,7 @@ static struct lock_class_key batadv_netdev_xmit_lock_key; ...@@ -733,7 +733,7 @@ static struct lock_class_key batadv_netdev_xmit_lock_key;
static struct lock_class_key batadv_netdev_addr_lock_key; static struct lock_class_key batadv_netdev_addr_lock_key;
/** /**
* batadv_set_lockdep_class_one - Set lockdep class for a single tx queue * batadv_set_lockdep_class_one() - Set lockdep class for a single tx queue
* @dev: device which owns the tx queue * @dev: device which owns the tx queue
* @txq: tx queue to modify * @txq: tx queue to modify
* @_unused: always NULL * @_unused: always NULL
...@@ -746,7 +746,7 @@ static void batadv_set_lockdep_class_one(struct net_device *dev, ...@@ -746,7 +746,7 @@ static void batadv_set_lockdep_class_one(struct net_device *dev,
} }
/** /**
* batadv_set_lockdep_class - Set txq and addr_list lockdep class * batadv_set_lockdep_class() - Set txq and addr_list lockdep class
* @dev: network device to modify * @dev: network device to modify
*/ */
static void batadv_set_lockdep_class(struct net_device *dev) static void batadv_set_lockdep_class(struct net_device *dev)
...@@ -756,7 +756,7 @@ static void batadv_set_lockdep_class(struct net_device *dev) ...@@ -756,7 +756,7 @@ static void batadv_set_lockdep_class(struct net_device *dev)
} }
/** /**
* batadv_softif_init_late - late stage initialization of soft interface * batadv_softif_init_late() - late stage initialization of soft interface
* @dev: registered network device to modify * @dev: registered network device to modify
* *
* Return: error code on failures * Return: error code on failures
...@@ -861,7 +861,7 @@ static int batadv_softif_init_late(struct net_device *dev) ...@@ -861,7 +861,7 @@ static int batadv_softif_init_late(struct net_device *dev)
} }
/** /**
* batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface * batadv_softif_slave_add() - Add a slave interface to a batadv_soft_interface
* @dev: batadv_soft_interface used as master interface * @dev: batadv_soft_interface used as master interface
* @slave_dev: net_device which should become the slave interface * @slave_dev: net_device which should become the slave interface
* @extack: extended ACK report struct * @extack: extended ACK report struct
...@@ -889,7 +889,7 @@ static int batadv_softif_slave_add(struct net_device *dev, ...@@ -889,7 +889,7 @@ static int batadv_softif_slave_add(struct net_device *dev,
} }
/** /**
* batadv_softif_slave_del - Delete a slave iface from a batadv_soft_interface * batadv_softif_slave_del() - Delete a slave iface from a batadv_soft_interface
* @dev: batadv_soft_interface used as master interface * @dev: batadv_soft_interface used as master interface
* @slave_dev: net_device which should be removed from the master interface * @slave_dev: net_device which should be removed from the master interface
* *
...@@ -1024,7 +1024,7 @@ static const struct ethtool_ops batadv_ethtool_ops = { ...@@ -1024,7 +1024,7 @@ static const struct ethtool_ops batadv_ethtool_ops = {
}; };
/** /**
* batadv_softif_free - Deconstructor of batadv_soft_interface * batadv_softif_free() - Deconstructor of batadv_soft_interface
* @dev: Device to cleanup and remove * @dev: Device to cleanup and remove
*/ */
static void batadv_softif_free(struct net_device *dev) static void batadv_softif_free(struct net_device *dev)
...@@ -1040,7 +1040,7 @@ static void batadv_softif_free(struct net_device *dev) ...@@ -1040,7 +1040,7 @@ static void batadv_softif_free(struct net_device *dev)
} }
/** /**
* batadv_softif_init_early - early stage initialization of soft interface * batadv_softif_init_early() - early stage initialization of soft interface
* @dev: registered network device to modify * @dev: registered network device to modify
*/ */
static void batadv_softif_init_early(struct net_device *dev) static void batadv_softif_init_early(struct net_device *dev)
...@@ -1090,7 +1090,7 @@ struct net_device *batadv_softif_create(struct net *net, const char *name) ...@@ -1090,7 +1090,7 @@ struct net_device *batadv_softif_create(struct net *net, const char *name)
} }
/** /**
* batadv_softif_destroy_sysfs - deletion of batadv_soft_interface via sysfs * batadv_softif_destroy_sysfs() - deletion of batadv_soft_interface via sysfs
* @soft_iface: the to-be-removed batman-adv interface * @soft_iface: the to-be-removed batman-adv interface
*/ */
void batadv_softif_destroy_sysfs(struct net_device *soft_iface) void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
...@@ -1112,7 +1112,8 @@ void batadv_softif_destroy_sysfs(struct net_device *soft_iface) ...@@ -1112,7 +1112,8 @@ void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
} }
/** /**
* batadv_softif_destroy_netlink - deletion of batadv_soft_interface via netlink * batadv_softif_destroy_netlink() - deletion of batadv_soft_interface via
* netlink
* @soft_iface: the to-be-removed batman-adv interface * @soft_iface: the to-be-removed batman-adv interface
* @head: list pointer * @head: list pointer
*/ */
......
...@@ -65,7 +65,7 @@ static struct batadv_priv *batadv_kobj_to_batpriv(struct kobject *obj) ...@@ -65,7 +65,7 @@ static struct batadv_priv *batadv_kobj_to_batpriv(struct kobject *obj)
} }
/** /**
* batadv_vlan_kobj_to_batpriv - convert a vlan kobj in the associated batpriv * batadv_vlan_kobj_to_batpriv() - convert a vlan kobj in the associated batpriv
* @obj: kobject to covert * @obj: kobject to covert
* *
* Return: the associated batadv_priv struct. * Return: the associated batadv_priv struct.
...@@ -85,7 +85,7 @@ static struct batadv_priv *batadv_vlan_kobj_to_batpriv(struct kobject *obj) ...@@ -85,7 +85,7 @@ static struct batadv_priv *batadv_vlan_kobj_to_batpriv(struct kobject *obj)
} }
/** /**
* batadv_kobj_to_vlan - convert a kobj in the associated softif_vlan struct * batadv_kobj_to_vlan() - convert a kobj in the associated softif_vlan struct
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @obj: kobject to covert * @obj: kobject to covert
* *
...@@ -600,7 +600,7 @@ static ssize_t batadv_store_gw_bwidth(struct kobject *kobj, ...@@ -600,7 +600,7 @@ static ssize_t batadv_store_gw_bwidth(struct kobject *kobj,
} }
/** /**
* batadv_show_isolation_mark - print the current isolation mark/mask * batadv_show_isolation_mark() - print the current isolation mark/mask
* @kobj: kobject representing the private mesh sysfs directory * @kobj: kobject representing the private mesh sysfs directory
* @attr: the batman-adv attribute the user is interacting with * @attr: the batman-adv attribute the user is interacting with
* @buff: the buffer that will contain the data to send back to the user * @buff: the buffer that will contain the data to send back to the user
...@@ -618,8 +618,8 @@ static ssize_t batadv_show_isolation_mark(struct kobject *kobj, ...@@ -618,8 +618,8 @@ static ssize_t batadv_show_isolation_mark(struct kobject *kobj,
} }
/** /**
* batadv_store_isolation_mark - parse and store the isolation mark/mask entered * batadv_store_isolation_mark() - parse and store the isolation mark/mask
* by the user * entered by the user
* @kobj: kobject representing the private mesh sysfs directory * @kobj: kobject representing the private mesh sysfs directory
* @attr: the batman-adv attribute the user is interacting with * @attr: the batman-adv attribute the user is interacting with
* @buff: the buffer containing the user data * @buff: the buffer containing the user data
...@@ -790,7 +790,7 @@ void batadv_sysfs_del_meshif(struct net_device *dev) ...@@ -790,7 +790,7 @@ void batadv_sysfs_del_meshif(struct net_device *dev)
} }
/** /**
* batadv_sysfs_add_vlan - add all the needed sysfs objects for the new vlan * batadv_sysfs_add_vlan() - add all the needed sysfs objects for the new vlan
* @dev: netdev of the mesh interface * @dev: netdev of the mesh interface
* @vlan: private data of the newly added VLAN interface * @vlan: private data of the newly added VLAN interface
* *
...@@ -851,7 +851,7 @@ int batadv_sysfs_add_vlan(struct net_device *dev, ...@@ -851,7 +851,7 @@ int batadv_sysfs_add_vlan(struct net_device *dev,
} }
/** /**
* batadv_sysfs_del_vlan - remove all the sysfs objects for a given VLAN * batadv_sysfs_del_vlan() - remove all the sysfs objects for a given VLAN
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @vlan: the private data of the VLAN to destroy * @vlan: the private data of the VLAN to destroy
*/ */
...@@ -896,7 +896,7 @@ static ssize_t batadv_show_mesh_iface(struct kobject *kobj, ...@@ -896,7 +896,7 @@ static ssize_t batadv_show_mesh_iface(struct kobject *kobj,
} }
/** /**
* batadv_store_mesh_iface_finish - store new hardif mesh_iface state * batadv_store_mesh_iface_finish() - store new hardif mesh_iface state
* @net_dev: netdevice to add/remove to/from batman-adv soft-interface * @net_dev: netdevice to add/remove to/from batman-adv soft-interface
* @ifname: name of soft-interface to modify * @ifname: name of soft-interface to modify
* *
...@@ -949,7 +949,7 @@ static int batadv_store_mesh_iface_finish(struct net_device *net_dev, ...@@ -949,7 +949,7 @@ static int batadv_store_mesh_iface_finish(struct net_device *net_dev,
} }
/** /**
* batadv_store_mesh_iface_work - store new hardif mesh_iface state * batadv_store_mesh_iface_work() - store new hardif mesh_iface state
* @work: work queue item * @work: work queue item
* *
* Changes the parts of the hard+soft interface which can not be modified under * Changes the parts of the hard+soft interface which can not be modified under
...@@ -1045,7 +1045,7 @@ static ssize_t batadv_show_iface_status(struct kobject *kobj, ...@@ -1045,7 +1045,7 @@ static ssize_t batadv_show_iface_status(struct kobject *kobj,
#ifdef CONFIG_BATMAN_ADV_BATMAN_V #ifdef CONFIG_BATMAN_ADV_BATMAN_V
/** /**
* batadv_store_throughput_override - parse and store throughput override * batadv_store_throughput_override() - parse and store throughput override
* entered by the user * entered by the user
* @kobj: kobject representing the private mesh sysfs directory * @kobj: kobject representing the private mesh sysfs directory
* @attr: the batman-adv attribute the user is interacting with * @attr: the batman-adv attribute the user is interacting with
......
This diff is collapsed.
This diff is collapsed.
...@@ -43,7 +43,7 @@ ...@@ -43,7 +43,7 @@
#include "tvlv.h" #include "tvlv.h"
/** /**
* batadv_tvlv_handler_release - release tvlv handler from lists and queue for * batadv_tvlv_handler_release() - release tvlv handler from lists and queue for
* free after rcu grace period * free after rcu grace period
* @ref: kref pointer of the tvlv * @ref: kref pointer of the tvlv
*/ */
...@@ -56,7 +56,7 @@ static void batadv_tvlv_handler_release(struct kref *ref) ...@@ -56,7 +56,7 @@ static void batadv_tvlv_handler_release(struct kref *ref)
} }
/** /**
* batadv_tvlv_handler_put - decrement the tvlv container refcounter and * batadv_tvlv_handler_put() - decrement the tvlv container refcounter and
* possibly release it * possibly release it
* @tvlv_handler: the tvlv handler to free * @tvlv_handler: the tvlv handler to free
*/ */
...@@ -66,7 +66,7 @@ static void batadv_tvlv_handler_put(struct batadv_tvlv_handler *tvlv_handler) ...@@ -66,7 +66,7 @@ static void batadv_tvlv_handler_put(struct batadv_tvlv_handler *tvlv_handler)
} }
/** /**
* batadv_tvlv_handler_get - retrieve tvlv handler from the tvlv handler list * batadv_tvlv_handler_get() - retrieve tvlv handler from the tvlv handler list
* based on the provided type and version (both need to match) * based on the provided type and version (both need to match)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv handler type to look for * @type: tvlv handler type to look for
...@@ -100,7 +100,7 @@ batadv_tvlv_handler_get(struct batadv_priv *bat_priv, u8 type, u8 version) ...@@ -100,7 +100,7 @@ batadv_tvlv_handler_get(struct batadv_priv *bat_priv, u8 type, u8 version)
} }
/** /**
* batadv_tvlv_container_release - release tvlv from lists and free * batadv_tvlv_container_release() - release tvlv from lists and free
* @ref: kref pointer of the tvlv * @ref: kref pointer of the tvlv
*/ */
static void batadv_tvlv_container_release(struct kref *ref) static void batadv_tvlv_container_release(struct kref *ref)
...@@ -112,7 +112,7 @@ static void batadv_tvlv_container_release(struct kref *ref) ...@@ -112,7 +112,7 @@ static void batadv_tvlv_container_release(struct kref *ref)
} }
/** /**
* batadv_tvlv_container_put - decrement the tvlv container refcounter and * batadv_tvlv_container_put() - decrement the tvlv container refcounter and
* possibly release it * possibly release it
* @tvlv: the tvlv container to free * @tvlv: the tvlv container to free
*/ */
...@@ -122,7 +122,7 @@ static void batadv_tvlv_container_put(struct batadv_tvlv_container *tvlv) ...@@ -122,7 +122,7 @@ static void batadv_tvlv_container_put(struct batadv_tvlv_container *tvlv)
} }
/** /**
* batadv_tvlv_container_get - retrieve tvlv container from the tvlv container * batadv_tvlv_container_get() - retrieve tvlv container from the tvlv container
* list based on the provided type and version (both need to match) * list based on the provided type and version (both need to match)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv container type to look for * @type: tvlv container type to look for
...@@ -156,7 +156,7 @@ batadv_tvlv_container_get(struct batadv_priv *bat_priv, u8 type, u8 version) ...@@ -156,7 +156,7 @@ batadv_tvlv_container_get(struct batadv_priv *bat_priv, u8 type, u8 version)
} }
/** /**
* batadv_tvlv_container_list_size - calculate the size of the tvlv container * batadv_tvlv_container_list_size() - calculate the size of the tvlv container
* list entries * list entries
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* *
...@@ -181,8 +181,8 @@ static u16 batadv_tvlv_container_list_size(struct batadv_priv *bat_priv) ...@@ -181,8 +181,8 @@ static u16 batadv_tvlv_container_list_size(struct batadv_priv *bat_priv)
} }
/** /**
* batadv_tvlv_container_remove - remove tvlv container from the tvlv container * batadv_tvlv_container_remove() - remove tvlv container from the tvlv
* list * container list
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tvlv: the to be removed tvlv container * @tvlv: the to be removed tvlv container
* *
...@@ -205,7 +205,7 @@ static void batadv_tvlv_container_remove(struct batadv_priv *bat_priv, ...@@ -205,7 +205,7 @@ static void batadv_tvlv_container_remove(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_container_unregister - unregister tvlv container based on the * batadv_tvlv_container_unregister() - unregister tvlv container based on the
* provided type and version (both need to match) * provided type and version (both need to match)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv container type to unregister * @type: tvlv container type to unregister
...@@ -223,7 +223,7 @@ void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv, ...@@ -223,7 +223,7 @@ void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_container_register - register tvlv type, version and content * batadv_tvlv_container_register() - register tvlv type, version and content
* to be propagated with each (primary interface) OGM * to be propagated with each (primary interface) OGM
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv container type * @type: tvlv container type
...@@ -268,7 +268,7 @@ void batadv_tvlv_container_register(struct batadv_priv *bat_priv, ...@@ -268,7 +268,7 @@ void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_realloc_packet_buff - reallocate packet buffer to accommodate * batadv_tvlv_realloc_packet_buff() - reallocate packet buffer to accommodate
* requested packet size * requested packet size
* @packet_buff: packet buffer * @packet_buff: packet buffer
* @packet_buff_len: packet buffer size * @packet_buff_len: packet buffer size
...@@ -301,7 +301,7 @@ static bool batadv_tvlv_realloc_packet_buff(unsigned char **packet_buff, ...@@ -301,7 +301,7 @@ static bool batadv_tvlv_realloc_packet_buff(unsigned char **packet_buff,
} }
/** /**
* batadv_tvlv_container_ogm_append - append tvlv container content to given * batadv_tvlv_container_ogm_append() - append tvlv container content to given
* OGM packet buffer * OGM packet buffer
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @packet_buff: ogm packet buffer * @packet_buff: ogm packet buffer
...@@ -354,7 +354,7 @@ u16 batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv, ...@@ -354,7 +354,7 @@ u16 batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_call_handler - parse the given tvlv buffer to call the * batadv_tvlv_call_handler() - parse the given tvlv buffer to call the
* appropriate handlers * appropriate handlers
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @tvlv_handler: tvlv callback function handling the tvlv content * @tvlv_handler: tvlv callback function handling the tvlv content
...@@ -408,7 +408,7 @@ static int batadv_tvlv_call_handler(struct batadv_priv *bat_priv, ...@@ -408,7 +408,7 @@ static int batadv_tvlv_call_handler(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_containers_process - parse the given tvlv buffer to call the * batadv_tvlv_containers_process() - parse the given tvlv buffer to call the
* appropriate handlers * appropriate handlers
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @ogm_source: flag indicating whether the tvlv is an ogm or a unicast packet * @ogm_source: flag indicating whether the tvlv is an ogm or a unicast packet
...@@ -475,7 +475,7 @@ int batadv_tvlv_containers_process(struct batadv_priv *bat_priv, ...@@ -475,7 +475,7 @@ int batadv_tvlv_containers_process(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_ogm_receive - process an incoming ogm and call the appropriate * batadv_tvlv_ogm_receive() - process an incoming ogm and call the appropriate
* handlers * handlers
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @batadv_ogm_packet: ogm packet containing the tvlv containers * @batadv_ogm_packet: ogm packet containing the tvlv containers
...@@ -502,7 +502,7 @@ void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv, ...@@ -502,7 +502,7 @@ void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_handler_register - register tvlv handler based on the provided * batadv_tvlv_handler_register() - register tvlv handler based on the provided
* type and version (both need to match) for ogm tvlv payload and/or unicast * type and version (both need to match) for ogm tvlv payload and/or unicast
* payload * payload
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
...@@ -557,7 +557,7 @@ void batadv_tvlv_handler_register(struct batadv_priv *bat_priv, ...@@ -557,7 +557,7 @@ void batadv_tvlv_handler_register(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_handler_unregister - unregister tvlv handler based on the * batadv_tvlv_handler_unregister() - unregister tvlv handler based on the
* provided type and version (both need to match) * provided type and version (both need to match)
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @type: tvlv handler type to be unregistered * @type: tvlv handler type to be unregistered
...@@ -580,7 +580,7 @@ void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv, ...@@ -580,7 +580,7 @@ void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv,
} }
/** /**
* batadv_tvlv_unicast_send - send a unicast packet with tvlv payload to the * batadv_tvlv_unicast_send() - send a unicast packet with tvlv payload to the
* specified host * specified host
* @bat_priv: the bat priv with all the soft interface information * @bat_priv: the bat priv with all the soft interface information
* @src: source mac address of the unicast packet * @src: source mac address of the unicast packet
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment