mirror of
https://github.com/torvalds/linux.git
synced 2024-12-14 23:25:54 +00:00
e57acf8e93
Externally visible functions should be documented with kernel-doc. This usually refers to non-static functions but also static inline files in headers are visible in other files and should therefore be documented. Signed-off-by: Sven Eckelmann <sven@narfation.org> Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
107 lines
4.0 KiB
C
107 lines
4.0 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/* Copyright (C) 2007-2017 B.A.T.M.A.N. contributors:
|
|
*
|
|
* Marek Lindner, Simon Wunderlich
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of version 2 of the GNU General Public
|
|
* License as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef _NET_BATMAN_ADV_ORIGINATOR_H_
|
|
#define _NET_BATMAN_ADV_ORIGINATOR_H_
|
|
|
|
#include "main.h"
|
|
|
|
#include <linux/compiler.h>
|
|
#include <linux/if_ether.h>
|
|
#include <linux/jhash.h>
|
|
#include <linux/types.h>
|
|
|
|
struct netlink_callback;
|
|
struct seq_file;
|
|
struct sk_buff;
|
|
|
|
bool batadv_compare_orig(const struct hlist_node *node, const void *data2);
|
|
int batadv_originator_init(struct batadv_priv *bat_priv);
|
|
void batadv_originator_free(struct batadv_priv *bat_priv);
|
|
void batadv_purge_orig_ref(struct batadv_priv *bat_priv);
|
|
void batadv_orig_node_put(struct batadv_orig_node *orig_node);
|
|
struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
|
|
const u8 *addr);
|
|
struct batadv_hardif_neigh_node *
|
|
batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
|
|
const u8 *neigh_addr);
|
|
void
|
|
batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh);
|
|
struct batadv_neigh_node *
|
|
batadv_neigh_node_get_or_create(struct batadv_orig_node *orig_node,
|
|
struct batadv_hard_iface *hard_iface,
|
|
const u8 *neigh_addr);
|
|
void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node);
|
|
struct batadv_neigh_node *
|
|
batadv_orig_router_get(struct batadv_orig_node *orig_node,
|
|
const struct batadv_hard_iface *if_outgoing);
|
|
struct batadv_neigh_ifinfo *
|
|
batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
|
|
struct batadv_hard_iface *if_outgoing);
|
|
struct batadv_neigh_ifinfo *
|
|
batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
|
|
struct batadv_hard_iface *if_outgoing);
|
|
void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo);
|
|
|
|
int batadv_hardif_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb);
|
|
int batadv_hardif_neigh_seq_print_text(struct seq_file *seq, void *offset);
|
|
|
|
struct batadv_orig_ifinfo *
|
|
batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
|
|
struct batadv_hard_iface *if_outgoing);
|
|
struct batadv_orig_ifinfo *
|
|
batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
|
|
struct batadv_hard_iface *if_outgoing);
|
|
void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo);
|
|
|
|
int batadv_orig_seq_print_text(struct seq_file *seq, void *offset);
|
|
int batadv_orig_dump(struct sk_buff *msg, struct netlink_callback *cb);
|
|
int batadv_orig_hardif_seq_print_text(struct seq_file *seq, void *offset);
|
|
int batadv_orig_hash_add_if(struct batadv_hard_iface *hard_iface,
|
|
int max_if_num);
|
|
int batadv_orig_hash_del_if(struct batadv_hard_iface *hard_iface,
|
|
int max_if_num);
|
|
struct batadv_orig_node_vlan *
|
|
batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
|
|
unsigned short vid);
|
|
struct batadv_orig_node_vlan *
|
|
batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
|
|
unsigned short vid);
|
|
void batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan);
|
|
|
|
/**
|
|
* batadv_choose_orig() - Return the index of the orig entry in the hash table
|
|
* @data: mac address of the originator node
|
|
* @size: the size of the hash table
|
|
*
|
|
* Return: the hash index where the object represented by @data should be
|
|
* stored at.
|
|
*/
|
|
static inline u32 batadv_choose_orig(const void *data, u32 size)
|
|
{
|
|
u32 hash = 0;
|
|
|
|
hash = jhash(data, ETH_ALEN, hash);
|
|
return hash % size;
|
|
}
|
|
|
|
struct batadv_orig_node *
|
|
batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data);
|
|
|
|
#endif /* _NET_BATMAN_ADV_ORIGINATOR_H_ */
|