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

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

batman-adv: Add kernel-doc to externally visible functions 



According to the kernel-doc documentation, externally visible functions
should be documented. This refers to all all non-static function which can
(and will) be used by functions in other sources files.

Signed-off-by: default avatarSven Eckelmann <sven@narfation.org>
Signed-off-by: default avatarSimon Wunderlich <sw@simonwunderlich.de>
parent e57acf8e

net/batman-adv/bat_algo.c

+27 −0
Original line number Diff line number Diff line
@@ -61,6 +61,12 @@ static struct batadv_algo_ops *batadv_algo_get(char *name) 
	return bat_algo_ops;

}



/**

 * batadv_algo_register() - Register callbacks for a mesh algorithm

 * @bat_algo_ops: mesh algorithm callbacks to add

 *

 * Return: 0 on success or negative error number in case of failure

 */

int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops)

{

	struct batadv_algo_ops *bat_algo_ops_tmp;
@@ -90,6 +96,19 @@ int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops) 
	return 0;

}



/**

 * batadv_algo_select() - Select algorithm of soft interface

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

 * @name: name of the algorithm to select

 *

 * The algorithm callbacks for the soft interface will be set when the algorithm

 * with the correct name was found. Any previous selected algorithm will not be

 * deinitialized and the new selected algorithm will also not be initialized.

 * It is therefore not allowed to call batadv_algo_select outside the creation

 * function of the soft interface.

 *

 * Return: 0 on success or negative error number in case of failure

 */

int batadv_algo_select(struct batadv_priv *bat_priv, char *name)

{

	struct batadv_algo_ops *bat_algo_ops;
@@ -104,6 +123,14 @@ int batadv_algo_select(struct batadv_priv *bat_priv, char *name) 
}



#ifdef CONFIG_BATMAN_ADV_DEBUGFS



/**

 * batadv_algo_seq_print_text() - Print the supported algorithms in a seq file

 * @seq: seq file to print on

 * @offset: not used

 *

 * Return: always 0

 */

int batadv_algo_seq_print_text(struct seq_file *seq, void *offset)

{

	struct batadv_algo_ops *bat_algo_ops;

net/batman-adv/bat_iv_ogm.c

+5 −0
Original line number Diff line number Diff line
@@ -2853,6 +2853,11 @@ static struct batadv_algo_ops batadv_batman_iv __read_mostly = { 
	},

};



/**

 * batadv_iv_init() - B.A.T.M.A.N. IV initialization function

 *

 * Return: 0 on success or negative error number in case of failure

 */

int __init batadv_iv_init(void)

{

	int ret;

net/batman-adv/debugfs.c

+16 −0
Original line number Diff line number Diff line
@@ -259,6 +259,9 @@ static struct batadv_debuginfo *batadv_hardif_debuginfos[] = { 
	NULL,

};



/**

 * batadv_debugfs_init() - Initialize soft interface independent debugfs entries

 */

void batadv_debugfs_init(void)

{

	struct batadv_debuginfo **bat_debug;
@@ -289,6 +292,9 @@ void batadv_debugfs_init(void) 
	batadv_debugfs = NULL;

}



/**

 * batadv_debugfs_destroy() - Remove all debugfs entries

 */

void batadv_debugfs_destroy(void)

{

	debugfs_remove_recursive(batadv_debugfs);
@@ -355,6 +361,12 @@ void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface) 
	}

}



/**

 * batadv_debugfs_add_meshif() - Initialize interface dependent debugfs entries

 * @dev: netdev struct of the soft interface

 *

 * Return: 0 on success or negative error number in case of failure

 */

int batadv_debugfs_add_meshif(struct net_device *dev)

{

	struct batadv_priv *bat_priv = netdev_priv(dev);
@@ -401,6 +413,10 @@ int batadv_debugfs_add_meshif(struct net_device *dev) 
	return -ENOMEM;

}



/**

 * batadv_debugfs_del_meshif() - Remove interface dependent debugfs entries

 * @dev: netdev struct of the soft interface

 */

void batadv_debugfs_del_meshif(struct net_device *dev)

{

	struct batadv_priv *bat_priv = netdev_priv(dev);

net/batman-adv/gateway_client.c

+38 −0
Original line number Diff line number Diff line
@@ -93,6 +93,12 @@ void batadv_gw_node_put(struct batadv_gw_node *gw_node) 
	kref_put(&gw_node->refcount, batadv_gw_node_release);

}



/**

 * batadv_gw_get_selected_gw_node() - Get currently selected gateway

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

 *

 * Return: selected gateway (with increased refcnt), NULL on errors

 */

struct batadv_gw_node *

batadv_gw_get_selected_gw_node(struct batadv_priv *bat_priv)

{
@@ -111,6 +117,12 @@ batadv_gw_get_selected_gw_node(struct batadv_priv *bat_priv) 
	return gw_node;

}



/**

 * batadv_gw_get_selected_orig() - Get originator of currently selected gateway

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

 *

 * Return: orig_node of selected gateway (with increased refcnt), NULL on errors

 */

struct batadv_orig_node *

batadv_gw_get_selected_orig(struct batadv_priv *bat_priv)

{
@@ -204,6 +216,10 @@ void batadv_gw_check_client_stop(struct batadv_priv *bat_priv) 
	batadv_gw_node_put(curr_gw);

}



/**

 * batadv_gw_election() - Elect the best gateway

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

 */

void batadv_gw_election(struct batadv_priv *bat_priv)

{

	struct batadv_gw_node *curr_gw = NULL;
@@ -292,6 +308,11 @@ void batadv_gw_election(struct batadv_priv *bat_priv) 
		batadv_neigh_ifinfo_put(router_ifinfo);

}



/**

 * batadv_gw_check_election() - Elect orig node as best gateway when eligible

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

 * @orig_node: orig node which is to be checked

 */

void batadv_gw_check_election(struct batadv_priv *bat_priv,

			      struct batadv_orig_node *orig_node)

{
@@ -460,6 +481,11 @@ void batadv_gw_node_update(struct batadv_priv *bat_priv, 
		batadv_gw_node_put(gw_node);

}



/**

 * batadv_gw_node_delete() - Remove orig_node from gateway list

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

 * @orig_node: orig node which is currently in process of being removed

 */

void batadv_gw_node_delete(struct batadv_priv *bat_priv,

			   struct batadv_orig_node *orig_node)

{
@@ -471,6 +497,10 @@ void batadv_gw_node_delete(struct batadv_priv *bat_priv, 
	batadv_gw_node_update(bat_priv, orig_node, &gateway);

}



/**

 * batadv_gw_node_free() - Free gateway information from soft interface

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

 */

void batadv_gw_node_free(struct batadv_priv *bat_priv)

{

	struct batadv_gw_node *gw_node;
@@ -486,6 +516,14 @@ void batadv_gw_node_free(struct batadv_priv *bat_priv) 
}



#ifdef CONFIG_BATMAN_ADV_DEBUGFS



/**

 * batadv_gw_client_seq_print_text() - Print the gateway table in a seq file

 * @seq: seq file to print on

 * @offset: not used

 *

 * Return: always 0

 */

int batadv_gw_client_seq_print_text(struct seq_file *seq, void *offset)

{

	struct net_device *net_dev = (struct net_device *)seq->private;

net/batman-adv/gateway_common.c

+9 −0
Original line number Diff line number Diff line
@@ -165,6 +165,15 @@ void batadv_gw_tvlv_container_update(struct batadv_priv *bat_priv) 
	}

}



/**

 * batadv_gw_bandwidth_set() - Parse and set download/upload gateway bandwidth

 *  from supplied string buffer

 * @net_dev: netdev struct of the soft interface

 * @buff: the buffer containing the user data

 * @count: number of bytes in the buffer

 *

 * Return: 'count' on success or a negative error code in case of failure

 */

ssize_t batadv_gw_bandwidth_set(struct net_device *net_dev, char *buff,

				size_t count)

{