xref: /linux/net/batman-adv/hard-interface.h (revision 07fdad3a93756b872da7b53647715c48d0f4a2d0)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) B.A.T.M.A.N. contributors:
3  *
4  * Marek Lindner, Simon Wunderlich
5  */
6 
7 #ifndef _NET_BATMAN_ADV_HARD_INTERFACE_H_
8 #define _NET_BATMAN_ADV_HARD_INTERFACE_H_
9 
10 #include "main.h"
11 
12 #include <linux/compiler.h>
13 #include <linux/kref.h>
14 #include <linux/netdevice.h>
15 #include <linux/rcupdate.h>
16 #include <linux/stddef.h>
17 #include <linux/types.h>
18 
19 /**
20  * enum batadv_hard_if_state - State of a hard interface
21  */
22 enum batadv_hard_if_state {
23 	/**
24 	 * @BATADV_IF_NOT_IN_USE: interface is not used as slave interface of a
25 	 * batman-adv mesh interface
26 	 */
27 	BATADV_IF_NOT_IN_USE,
28 
29 	/**
30 	 * @BATADV_IF_TO_BE_REMOVED: interface will be removed from mesh
31 	 * interface
32 	 */
33 	BATADV_IF_TO_BE_REMOVED,
34 
35 	/** @BATADV_IF_INACTIVE: interface is deactivated */
36 	BATADV_IF_INACTIVE,
37 
38 	/** @BATADV_IF_ACTIVE: interface is used */
39 	BATADV_IF_ACTIVE,
40 
41 	/** @BATADV_IF_TO_BE_ACTIVATED: interface is getting activated */
42 	BATADV_IF_TO_BE_ACTIVATED,
43 };
44 
45 /**
46  * enum batadv_hard_if_bcast - broadcast avoidance options
47  */
48 enum batadv_hard_if_bcast {
49 	/** @BATADV_HARDIF_BCAST_OK: Do broadcast on according hard interface */
50 	BATADV_HARDIF_BCAST_OK = 0,
51 
52 	/**
53 	 * @BATADV_HARDIF_BCAST_NORECIPIENT: Broadcast not needed, there is no
54 	 *  recipient
55 	 */
56 	BATADV_HARDIF_BCAST_NORECIPIENT,
57 
58 	/**
59 	 * @BATADV_HARDIF_BCAST_DUPFWD: There is just the neighbor we got it
60 	 *  from
61 	 */
62 	BATADV_HARDIF_BCAST_DUPFWD,
63 
64 	/** @BATADV_HARDIF_BCAST_DUPORIG: There is just the originator */
65 	BATADV_HARDIF_BCAST_DUPORIG,
66 };
67 
68 extern struct notifier_block batadv_hard_if_notifier;
69 
70 struct net_device *batadv_get_real_netdev(struct net_device *net_device);
71 bool batadv_is_cfg80211_hardif(struct batadv_hard_iface *hard_iface);
72 bool batadv_is_wifi_hardif(struct batadv_hard_iface *hard_iface);
73 struct batadv_hard_iface*
74 batadv_hardif_get_by_netdev(const struct net_device *net_dev);
75 int batadv_hardif_enable_interface(struct batadv_hard_iface *hard_iface,
76 				   struct net_device *mesh_iface);
77 void batadv_hardif_disable_interface(struct batadv_hard_iface *hard_iface);
78 int batadv_hardif_min_mtu(struct net_device *mesh_iface);
79 void batadv_update_min_mtu(struct net_device *mesh_iface);
80 void batadv_hardif_release(struct kref *ref);
81 int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing,
82 			       u8 *orig_addr, u8 *orig_neigh);
83 
84 /**
85  * batadv_hardif_put() - decrement the hard interface refcounter and possibly
86  *  release it
87  * @hard_iface: the hard interface to free
88  */
89 static inline void batadv_hardif_put(struct batadv_hard_iface *hard_iface)
90 {
91 	if (!hard_iface)
92 		return;
93 
94 	kref_put(&hard_iface->refcount, batadv_hardif_release);
95 }
96 
97 /**
98  * batadv_primary_if_get_selected() - Get reference to primary interface
99  * @bat_priv: the bat priv with all the mesh interface information
100  *
101  * Return: primary interface (with increased refcnt), otherwise NULL
102  */
103 static inline struct batadv_hard_iface *
104 batadv_primary_if_get_selected(struct batadv_priv *bat_priv)
105 {
106 	struct batadv_hard_iface *hard_iface;
107 
108 	rcu_read_lock();
109 	hard_iface = rcu_dereference(bat_priv->primary_if);
110 	if (!hard_iface)
111 		goto out;
112 
113 	if (!kref_get_unless_zero(&hard_iface->refcount))
114 		hard_iface = NULL;
115 
116 out:
117 	rcu_read_unlock();
118 	return hard_iface;
119 }
120 
121 #endif /* _NET_BATMAN_ADV_HARD_INTERFACE_H_ */
122