xref: /openbmc/linux/net/wireless/core.h (revision 06d352f2)
1 /*
2  * Wireless configuration interface internals.
3  *
4  * Copyright 2006-2009	Johannes Berg <johannes@sipsolutions.net>
5  */
6 #ifndef __NET_WIRELESS_CORE_H
7 #define __NET_WIRELESS_CORE_H
8 #include <linux/mutex.h>
9 #include <linux/list.h>
10 #include <linux/netdevice.h>
11 #include <linux/kref.h>
12 #include <linux/rbtree.h>
13 #include <linux/debugfs.h>
14 #include <linux/rfkill.h>
15 #include <linux/workqueue.h>
16 #include <net/genetlink.h>
17 #include <net/cfg80211.h>
18 #include "reg.h"
19 
20 struct cfg80211_registered_device {
21 	const struct cfg80211_ops *ops;
22 	struct list_head list;
23 	/* we hold this mutex during any call so that
24 	 * we cannot do multiple calls at once, and also
25 	 * to avoid the deregister call to proceed while
26 	 * any call is in progress */
27 	struct mutex mtx;
28 
29 	/* rfkill support */
30 	struct rfkill_ops rfkill_ops;
31 	struct rfkill *rfkill;
32 	struct work_struct rfkill_sync;
33 
34 	/* ISO / IEC 3166 alpha2 for which this device is receiving
35 	 * country IEs on, this can help disregard country IEs from APs
36 	 * on the same alpha2 quickly. The alpha2 may differ from
37 	 * cfg80211_regdomain's alpha2 when an intersection has occurred.
38 	 * If the AP is reconfigured this can also be used to tell us if
39 	 * the country on the country IE changed. */
40 	char country_ie_alpha2[2];
41 
42 	/* If a Country IE has been received this tells us the environment
43 	 * which its telling us its in. This defaults to ENVIRON_ANY */
44 	enum environment_cap env;
45 
46 	/* wiphy index, internal only */
47 	int wiphy_idx;
48 
49 	/* associate netdev list */
50 	struct mutex devlist_mtx;
51 	struct list_head netdev_list;
52 	int devlist_generation;
53 	int opencount; /* also protected by devlist_mtx */
54 	wait_queue_head_t dev_wait;
55 
56 	/* BSSes/scanning */
57 	spinlock_t bss_lock;
58 	struct list_head bss_list;
59 	struct rb_root bss_tree;
60 	u32 bss_generation;
61 	struct cfg80211_scan_request *scan_req; /* protected by RTNL */
62 	unsigned long suspend_at;
63 	struct work_struct scan_done_wk;
64 
65 #ifdef CONFIG_NL80211_TESTMODE
66 	struct genl_info *testmode_info;
67 #endif
68 
69 	struct work_struct conn_work;
70 	struct work_struct event_work;
71 
72 	/* current channel */
73 	struct ieee80211_channel *channel;
74 
75 	/* must be last because of the way we do wiphy_priv(),
76 	 * and it should at least be aligned to NETDEV_ALIGN */
77 	struct wiphy wiphy __attribute__((__aligned__(NETDEV_ALIGN)));
78 };
79 
80 static inline
81 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
82 {
83 	BUG_ON(!wiphy);
84 	return container_of(wiphy, struct cfg80211_registered_device, wiphy);
85 }
86 
87 /* Note 0 is valid, hence phy0 */
88 static inline
89 bool wiphy_idx_valid(int wiphy_idx)
90 {
91 	return (wiphy_idx >= 0);
92 }
93 
94 
95 extern struct workqueue_struct *cfg80211_wq;
96 extern struct mutex cfg80211_mutex;
97 extern struct list_head cfg80211_rdev_list;
98 extern int cfg80211_rdev_list_generation;
99 
100 #define assert_cfg80211_lock() WARN_ON(!mutex_is_locked(&cfg80211_mutex))
101 
102 /*
103  * You can use this to mark a wiphy_idx as not having an associated wiphy.
104  * It guarantees cfg80211_rdev_by_wiphy_idx(wiphy_idx) will return NULL
105  */
106 #define WIPHY_IDX_STALE -1
107 
108 struct cfg80211_internal_bss {
109 	struct list_head list;
110 	struct rb_node rbn;
111 	unsigned long ts;
112 	struct kref ref;
113 	atomic_t hold;
114 	bool ies_allocated;
115 
116 	/* must be last because of priv member */
117 	struct cfg80211_bss pub;
118 };
119 
120 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
121 {
122 	return container_of(pub, struct cfg80211_internal_bss, pub);
123 }
124 
125 static inline void cfg80211_ref_bss(struct cfg80211_internal_bss *bss)
126 {
127 	kref_get(&bss->ref);
128 }
129 
130 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
131 {
132 	atomic_inc(&bss->hold);
133 }
134 
135 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
136 {
137 	int r = atomic_dec_return(&bss->hold);
138 	WARN_ON(r < 0);
139 }
140 
141 
142 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
143 int get_wiphy_idx(struct wiphy *wiphy);
144 
145 struct cfg80211_registered_device *
146 __cfg80211_rdev_from_info(struct genl_info *info);
147 
148 /*
149  * This function returns a pointer to the driver
150  * that the genl_info item that is passed refers to.
151  * If successful, it returns non-NULL and also locks
152  * the driver's mutex!
153  *
154  * This means that you need to call cfg80211_unlock_rdev()
155  * before being allowed to acquire &cfg80211_mutex!
156  *
157  * This is necessary because we need to lock the global
158  * mutex to get an item off the list safely, and then
159  * we lock the rdev mutex so it doesn't go away under us.
160  *
161  * We don't want to keep cfg80211_mutex locked
162  * for all the time in order to allow requests on
163  * other interfaces to go through at the same time.
164  *
165  * The result of this can be a PTR_ERR and hence must
166  * be checked with IS_ERR() for errors.
167  */
168 extern struct cfg80211_registered_device *
169 cfg80211_get_dev_from_info(struct genl_info *info);
170 
171 /* requires cfg80211_rdev_mutex to be held! */
172 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
173 
174 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
175 extern struct cfg80211_registered_device *
176 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
177 
178 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
179 			  struct net *net);
180 
181 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
182 {
183 	mutex_lock(&rdev->mtx);
184 }
185 
186 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
187 {
188 	BUG_ON(IS_ERR(rdev) || !rdev);
189 	mutex_unlock(&rdev->mtx);
190 }
191 
192 static inline void wdev_lock(struct wireless_dev *wdev)
193 	__acquires(wdev)
194 {
195 	mutex_lock(&wdev->mtx);
196 	__acquire(wdev->mtx);
197 }
198 
199 static inline void wdev_unlock(struct wireless_dev *wdev)
200 	__releases(wdev)
201 {
202 	__release(wdev->mtx);
203 	mutex_unlock(&wdev->mtx);
204 }
205 
206 #define ASSERT_RDEV_LOCK(rdev) WARN_ON(!mutex_is_locked(&(rdev)->mtx));
207 #define ASSERT_WDEV_LOCK(wdev) WARN_ON(!mutex_is_locked(&(wdev)->mtx));
208 
209 enum cfg80211_event_type {
210 	EVENT_CONNECT_RESULT,
211 	EVENT_ROAMED,
212 	EVENT_DISCONNECTED,
213 	EVENT_IBSS_JOINED,
214 };
215 
216 struct cfg80211_event {
217 	struct list_head list;
218 	enum cfg80211_event_type type;
219 
220 	union {
221 		struct {
222 			u8 bssid[ETH_ALEN];
223 			const u8 *req_ie;
224 			const u8 *resp_ie;
225 			size_t req_ie_len;
226 			size_t resp_ie_len;
227 			u16 status;
228 		} cr;
229 		struct {
230 			u8 bssid[ETH_ALEN];
231 			const u8 *req_ie;
232 			const u8 *resp_ie;
233 			size_t req_ie_len;
234 			size_t resp_ie_len;
235 		} rm;
236 		struct {
237 			const u8 *ie;
238 			size_t ie_len;
239 			u16 reason;
240 		} dc;
241 		struct {
242 			u8 bssid[ETH_ALEN];
243 		} ij;
244 	};
245 };
246 
247 struct cfg80211_cached_keys {
248 	struct key_params params[6];
249 	u8 data[6][WLAN_MAX_KEY_LEN];
250 	int def, defmgmt;
251 };
252 
253 
254 /* free object */
255 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
256 
257 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
258 			       char *newname);
259 
260 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
261 void wiphy_update_regulatory(struct wiphy *wiphy,
262 			     enum nl80211_reg_initiator setby);
263 
264 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
265 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
266                       unsigned long age_secs);
267 
268 /* IBSS */
269 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
270 			 struct net_device *dev,
271 			 struct cfg80211_ibss_params *params,
272 			 struct cfg80211_cached_keys *connkeys);
273 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
274 		       struct net_device *dev,
275 		       struct cfg80211_ibss_params *params,
276 		       struct cfg80211_cached_keys *connkeys);
277 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
278 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
279 			  struct net_device *dev, bool nowext);
280 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
281 			struct net_device *dev, bool nowext);
282 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
283 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
284 			    struct wireless_dev *wdev);
285 
286 /* MLME */
287 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
288 			 struct net_device *dev,
289 			 struct ieee80211_channel *chan,
290 			 enum nl80211_auth_type auth_type,
291 			 const u8 *bssid,
292 			 const u8 *ssid, int ssid_len,
293 			 const u8 *ie, int ie_len,
294 			 const u8 *key, int key_len, int key_idx);
295 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
296 		       struct net_device *dev, struct ieee80211_channel *chan,
297 		       enum nl80211_auth_type auth_type, const u8 *bssid,
298 		       const u8 *ssid, int ssid_len,
299 		       const u8 *ie, int ie_len,
300 		       const u8 *key, int key_len, int key_idx);
301 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
302 			  struct net_device *dev,
303 			  struct ieee80211_channel *chan,
304 			  const u8 *bssid, const u8 *prev_bssid,
305 			  const u8 *ssid, int ssid_len,
306 			  const u8 *ie, int ie_len, bool use_mfp,
307 			  struct cfg80211_crypto_settings *crypt);
308 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
309 			struct net_device *dev, struct ieee80211_channel *chan,
310 			const u8 *bssid, const u8 *prev_bssid,
311 			const u8 *ssid, int ssid_len,
312 			const u8 *ie, int ie_len, bool use_mfp,
313 			struct cfg80211_crypto_settings *crypt);
314 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
315 			   struct net_device *dev, const u8 *bssid,
316 			   const u8 *ie, int ie_len, u16 reason);
317 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
318 			 struct net_device *dev, const u8 *bssid,
319 			 const u8 *ie, int ie_len, u16 reason);
320 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
321 			   struct net_device *dev, const u8 *bssid,
322 			   const u8 *ie, int ie_len, u16 reason);
323 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
324 			struct net_device *dev);
325 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
326 			       const u8 *req_ie, size_t req_ie_len,
327 			       const u8 *resp_ie, size_t resp_ie_len,
328 			       u16 status, bool wextev,
329 			       struct cfg80211_bss *bss);
330 
331 /* SME */
332 int __cfg80211_connect(struct cfg80211_registered_device *rdev,
333 		       struct net_device *dev,
334 		       struct cfg80211_connect_params *connect,
335 		       struct cfg80211_cached_keys *connkeys,
336 		       const u8 *prev_bssid);
337 int cfg80211_connect(struct cfg80211_registered_device *rdev,
338 		     struct net_device *dev,
339 		     struct cfg80211_connect_params *connect,
340 		     struct cfg80211_cached_keys *connkeys);
341 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
342 			  struct net_device *dev, u16 reason,
343 			  bool wextev);
344 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
345 			struct net_device *dev, u16 reason,
346 			bool wextev);
347 void __cfg80211_roamed(struct wireless_dev *wdev, const u8 *bssid,
348 		       const u8 *req_ie, size_t req_ie_len,
349 		       const u8 *resp_ie, size_t resp_ie_len);
350 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
351 			      struct wireless_dev *wdev);
352 
353 void cfg80211_conn_work(struct work_struct *work);
354 void cfg80211_sme_failed_assoc(struct wireless_dev *wdev);
355 bool cfg80211_sme_failed_reassoc(struct wireless_dev *wdev);
356 
357 /* internal helpers */
358 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
359 				   struct key_params *params, int key_idx,
360 				   const u8 *mac_addr);
361 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
362 			     size_t ie_len, u16 reason, bool from_ap);
363 void cfg80211_sme_scan_done(struct net_device *dev);
364 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
365 void cfg80211_sme_disassoc(struct net_device *dev, int idx);
366 void __cfg80211_scan_done(struct work_struct *wk);
367 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
368 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
369 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
370 			  struct net_device *dev, enum nl80211_iftype ntype,
371 			  u32 *flags, struct vif_params *params);
372 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
373 
374 struct ieee80211_channel *
375 rdev_fixed_channel(struct cfg80211_registered_device *rdev,
376 		   struct wireless_dev *for_wdev);
377 int rdev_set_freq(struct cfg80211_registered_device *rdev,
378 		  struct wireless_dev *for_wdev,
379 		  int freq, enum nl80211_channel_type channel_type);
380 
381 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
382 #define CFG80211_DEV_WARN_ON(cond)	WARN_ON(cond)
383 #else
384 /*
385  * Trick to enable using it as a condition,
386  * and also not give a warning when it's
387  * not used that way.
388  */
389 #define CFG80211_DEV_WARN_ON(cond)	({bool __r = (cond); __r; })
390 #endif
391 
392 #endif /* __NET_WIRELESS_CORE_H */
393