xref: /linux/net/batman-adv/hard-interface.h (revision 90e63d5354951d37fa2b3b91e6f17b95d2bf9bee)
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/init.h>
14 #include <linux/kref.h>
15 #include <linux/netdevice.h>
16 #include <linux/rcupdate.h>
17 #include <linux/stddef.h>
18 #include <linux/types.h>
19 
20 /**
21  * enum batadv_hard_if_state - State of a hard interface
22  */
23 enum batadv_hard_if_state {
24 	/**
25 	 * @BATADV_IF_NOT_IN_USE: interface is not used as slave interface of a
26 	 * batman-adv mesh interface
27 	 */
28 	BATADV_IF_NOT_IN_USE,
29 
30 	/**
31 	 * @BATADV_IF_TO_BE_REMOVED: interface will be removed from mesh
32 	 * interface
33 	 */
34 	BATADV_IF_TO_BE_REMOVED,
35 
36 	/** @BATADV_IF_INACTIVE: interface is deactivated */
37 	BATADV_IF_INACTIVE,
38 
39 	/** @BATADV_IF_ACTIVE: interface is used */
40 	BATADV_IF_ACTIVE,
41 
42 	/** @BATADV_IF_TO_BE_ACTIVATED: interface is getting activated */
43 	BATADV_IF_TO_BE_ACTIVATED,
44 };
45 
46 /**
47  * enum batadv_hard_if_bcast - broadcast avoidance options
48  */
49 enum batadv_hard_if_bcast {
50 	/** @BATADV_HARDIF_BCAST_OK: Do broadcast on according hard interface */
51 	BATADV_HARDIF_BCAST_OK = 0,
52 
53 	/**
54 	 * @BATADV_HARDIF_BCAST_NORECIPIENT: Broadcast not needed, there is no
55 	 *  recipient
56 	 */
57 	BATADV_HARDIF_BCAST_NORECIPIENT,
58 
59 	/**
60 	 * @BATADV_HARDIF_BCAST_DUPFWD: There is just the neighbor we got it
61 	 *  from
62 	 */
63 	BATADV_HARDIF_BCAST_DUPFWD,
64 
65 	/** @BATADV_HARDIF_BCAST_DUPORIG: There is just the originator */
66 	BATADV_HARDIF_BCAST_DUPORIG,
67 };
68 
69 extern struct notifier_block batadv_hard_if_notifier;
70 
71 struct net_device *__batadv_get_real_netdev(struct net_device *net_device);
72 struct net_device *batadv_get_real_netdev(struct net_device *net_device);
73 u32 batadv_netdev_get_wifi_flags(struct net_device *net_dev);
74 u32 batadv_hardif_get_wifi_flags(struct batadv_hard_iface *hard_iface);
75 bool batadv_is_wifi_hardif(struct batadv_hard_iface *hard_iface);
76 struct batadv_hard_iface*
77 batadv_hardif_get_by_netdev(const struct net_device *net_dev);
78 int batadv_hardif_enable_interface(struct batadv_hard_iface *hard_iface,
79 				   struct net_device *mesh_iface);
80 void batadv_hardif_disable_interface(struct batadv_hard_iface *hard_iface);
81 int batadv_hardif_min_mtu(struct net_device *mesh_iface);
82 void batadv_update_min_mtu(struct net_device *mesh_iface);
83 void batadv_hardif_release(struct kref *ref);
84 int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing,
85 			       u8 *orig_addr, u8 *orig_neigh);
86 int __init batadv_wifi_net_devices_init(void);
87 void batadv_wifi_net_devices_deinit(void);
88 
89 /**
90  * batadv_hardif_put() - decrement the hard interface refcounter and possibly
91  *  release it
92  * @hard_iface: the hard interface to free
93  */
94 static inline void batadv_hardif_put(struct batadv_hard_iface *hard_iface)
95 {
96 	if (!hard_iface)
97 		return;
98 
99 	kref_put(&hard_iface->refcount, batadv_hardif_release);
100 }
101 
102 /**
103  * batadv_primary_if_get_selected() - Get reference to primary interface
104  * @bat_priv: the bat priv with all the mesh interface information
105  *
106  * Return: primary interface (with increased refcnt), otherwise NULL
107  */
108 static inline struct batadv_hard_iface *
109 batadv_primary_if_get_selected(struct batadv_priv *bat_priv)
110 {
111 	struct batadv_hard_iface *hard_iface;
112 
113 	rcu_read_lock();
114 	hard_iface = rcu_dereference(bat_priv->primary_if);
115 	if (!hard_iface)
116 		goto out;
117 
118 	if (!kref_get_unless_zero(&hard_iface->refcount))
119 		hard_iface = NULL;
120 
121 out:
122 	rcu_read_unlock();
123 	return hard_iface;
124 }
125 
126 /**
127  * batadv_is_cfg80211() - check if the given hardif is a cfg80211
128  *  wifi interface
129  * @wifi_flags: extracted batadv_hard_iface_wifi_flags of a net_device
130  *
131  * Return: true if the net device is a cfg80211 wireless device, false
132  *  otherwise.
133  */
134 static inline bool batadv_is_cfg80211(u32 wifi_flags)
135 {
136 	u32 allowed_flags = 0;
137 
138 	allowed_flags |= BATADV_HARDIF_WIFI_CFG80211_DIRECT;
139 	allowed_flags |= BATADV_HARDIF_WIFI_CFG80211_INDIRECT;
140 
141 	return !!(wifi_flags & allowed_flags);
142 }
143 
144 /**
145  * batadv_is_wifi() - check if flags belong to wifi interface
146  * @wifi_flags: extracted batadv_hard_iface_wifi_flags of a net_device
147  *
148  * Return: true if the net device is a 802.11 wireless device, false otherwise.
149  */
150 static inline bool batadv_is_wifi(u32 wifi_flags)
151 {
152 	return wifi_flags != 0;
153 }
154 
155 #endif /* _NET_BATMAN_ADV_HARD_INTERFACE_H_ */
156