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