1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) 2007-2019  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/notifier.h>
15 #include <linux/rcupdate.h>
16 #include <linux/stddef.h>
17 #include <linux/types.h>
18 
19 struct net_device;
20 struct net;
21 
22 /**
23  * enum batadv_hard_if_state - State of a hard interface
24  */
25 enum batadv_hard_if_state {
26 	/**
27 	 * @BATADV_IF_NOT_IN_USE: interface is not used as slave interface of a
28 	 * batman-adv soft interface
29 	 */
30 	BATADV_IF_NOT_IN_USE,
31 
32 	/**
33 	 * @BATADV_IF_TO_BE_REMOVED: interface will be removed from soft
34 	 * interface
35 	 */
36 	BATADV_IF_TO_BE_REMOVED,
37 
38 	/** @BATADV_IF_INACTIVE: interface is deactivated */
39 	BATADV_IF_INACTIVE,
40 
41 	/** @BATADV_IF_ACTIVE: interface is used */
42 	BATADV_IF_ACTIVE,
43 
44 	/** @BATADV_IF_TO_BE_ACTIVATED: interface is getting activated */
45 	BATADV_IF_TO_BE_ACTIVATED,
46 
47 	/**
48 	 * @BATADV_IF_I_WANT_YOU: interface is queued up (using sysfs) for being
49 	 * added as slave interface of a batman-adv soft interface
50 	 */
51 	BATADV_IF_I_WANT_YOU,
52 };
53 
54 /**
55  * enum batadv_hard_if_bcast - broadcast avoidance options
56  */
57 enum batadv_hard_if_bcast {
58 	/** @BATADV_HARDIF_BCAST_OK: Do broadcast on according hard interface */
59 	BATADV_HARDIF_BCAST_OK = 0,
60 
61 	/**
62 	 * @BATADV_HARDIF_BCAST_NORECIPIENT: Broadcast not needed, there is no
63 	 *  recipient
64 	 */
65 	BATADV_HARDIF_BCAST_NORECIPIENT,
66 
67 	/**
68 	 * @BATADV_HARDIF_BCAST_DUPFWD: There is just the neighbor we got it
69 	 *  from
70 	 */
71 	BATADV_HARDIF_BCAST_DUPFWD,
72 
73 	/** @BATADV_HARDIF_BCAST_DUPORIG: There is just the originator */
74 	BATADV_HARDIF_BCAST_DUPORIG,
75 };
76 
77 /**
78  * enum batadv_hard_if_cleanup - Cleanup modi for soft_iface after slave removal
79  */
80 enum batadv_hard_if_cleanup {
81 	/**
82 	 * @BATADV_IF_CLEANUP_KEEP: Don't automatically delete soft-interface
83 	 */
84 	BATADV_IF_CLEANUP_KEEP,
85 
86 	/**
87 	 * @BATADV_IF_CLEANUP_AUTO: Delete soft-interface after last slave was
88 	 *  removed
89 	 */
90 	BATADV_IF_CLEANUP_AUTO,
91 };
92 
93 extern struct notifier_block batadv_hard_if_notifier;
94 
95 struct net_device *batadv_get_real_netdev(struct net_device *net_device);
96 bool batadv_is_cfg80211_hardif(struct batadv_hard_iface *hard_iface);
97 bool batadv_is_wifi_hardif(struct batadv_hard_iface *hard_iface);
98 struct batadv_hard_iface*
99 batadv_hardif_get_by_netdev(const struct net_device *net_dev);
100 int batadv_hardif_enable_interface(struct batadv_hard_iface *hard_iface,
101 				   struct net *net, const char *iface_name);
102 void batadv_hardif_disable_interface(struct batadv_hard_iface *hard_iface,
103 				     enum batadv_hard_if_cleanup autodel);
104 void batadv_hardif_remove_interfaces(void);
105 int batadv_hardif_min_mtu(struct net_device *soft_iface);
106 void batadv_update_min_mtu(struct net_device *soft_iface);
107 void batadv_hardif_release(struct kref *ref);
108 int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing,
109 			       u8 *orig_addr, u8 *orig_neigh);
110 
111 /**
112  * batadv_hardif_put() - decrement the hard interface refcounter and possibly
113  *  release it
114  * @hard_iface: the hard interface to free
115  */
116 static inline void batadv_hardif_put(struct batadv_hard_iface *hard_iface)
117 {
118 	kref_put(&hard_iface->refcount, batadv_hardif_release);
119 }
120 
121 /**
122  * batadv_primary_if_get_selected() - Get reference to primary interface
123  * @bat_priv: the bat priv with all the soft interface information
124  *
125  * Return: primary interface (with increased refcnt), otherwise NULL
126  */
127 static inline struct batadv_hard_iface *
128 batadv_primary_if_get_selected(struct batadv_priv *bat_priv)
129 {
130 	struct batadv_hard_iface *hard_iface;
131 
132 	rcu_read_lock();
133 	hard_iface = rcu_dereference(bat_priv->primary_if);
134 	if (!hard_iface)
135 		goto out;
136 
137 	if (!kref_get_unless_zero(&hard_iface->refcount))
138 		hard_iface = NULL;
139 
140 out:
141 	rcu_read_unlock();
142 	return hard_iface;
143 }
144 
145 #endif /* _NET_BATMAN_ADV_HARD_INTERFACE_H_ */
146