xref: /openbmc/linux/net/wireless/core.h (revision ab73b751)
1 /*
2  * Wireless configuration interface internals.
3  *
4  * Copyright 2006-2010	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 	/* protected by devlist_mtx or RCU */
52 	struct list_head netdev_list;
53 	int devlist_generation;
54 	int opencount; /* also protected by devlist_mtx */
55 	wait_queue_head_t dev_wait;
56 
57 	u32 ap_beacons_nlpid;
58 
59 	/* BSSes/scanning */
60 	spinlock_t bss_lock;
61 	struct list_head bss_list;
62 	struct rb_root bss_tree;
63 	u32 bss_generation;
64 	struct cfg80211_scan_request *scan_req; /* protected by RTNL */
65 	struct cfg80211_sched_scan_request *sched_scan_req;
66 	unsigned long suspend_at;
67 	struct work_struct scan_done_wk;
68 	struct work_struct sched_scan_results_wk;
69 
70 	struct mutex sched_scan_mtx;
71 
72 #ifdef CONFIG_NL80211_TESTMODE
73 	struct genl_info *testmode_info;
74 #endif
75 
76 	struct work_struct conn_work;
77 	struct work_struct event_work;
78 
79 	struct cfg80211_wowlan *wowlan;
80 
81 	/* must be last because of the way we do wiphy_priv(),
82 	 * and it should at least be aligned to NETDEV_ALIGN */
83 	struct wiphy wiphy __attribute__((__aligned__(NETDEV_ALIGN)));
84 };
85 
86 static inline
87 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
88 {
89 	BUG_ON(!wiphy);
90 	return container_of(wiphy, struct cfg80211_registered_device, wiphy);
91 }
92 
93 /* Note 0 is valid, hence phy0 */
94 static inline
95 bool wiphy_idx_valid(int wiphy_idx)
96 {
97 	return wiphy_idx >= 0;
98 }
99 
100 static inline void
101 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
102 {
103 	int i;
104 
105 	if (!rdev->wowlan)
106 		return;
107 	for (i = 0; i < rdev->wowlan->n_patterns; i++)
108 		kfree(rdev->wowlan->patterns[i].mask);
109 	kfree(rdev->wowlan->patterns);
110 	kfree(rdev->wowlan);
111 }
112 
113 extern struct workqueue_struct *cfg80211_wq;
114 extern struct mutex cfg80211_mutex;
115 extern struct list_head cfg80211_rdev_list;
116 extern int cfg80211_rdev_list_generation;
117 
118 static inline void assert_cfg80211_lock(void)
119 {
120 	lockdep_assert_held(&cfg80211_mutex);
121 }
122 
123 /*
124  * You can use this to mark a wiphy_idx as not having an associated wiphy.
125  * It guarantees cfg80211_rdev_by_wiphy_idx(wiphy_idx) will return NULL
126  */
127 #define WIPHY_IDX_STALE -1
128 
129 struct cfg80211_internal_bss {
130 	struct list_head list;
131 	struct rb_node rbn;
132 	unsigned long ts;
133 	struct kref ref;
134 	atomic_t hold;
135 	bool beacon_ies_allocated;
136 	bool proberesp_ies_allocated;
137 
138 	/* must be last because of priv member */
139 	struct cfg80211_bss pub;
140 };
141 
142 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
143 {
144 	return container_of(pub, struct cfg80211_internal_bss, pub);
145 }
146 
147 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
148 {
149 	atomic_inc(&bss->hold);
150 }
151 
152 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
153 {
154 	int r = atomic_dec_return(&bss->hold);
155 	WARN_ON(r < 0);
156 }
157 
158 
159 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
160 int get_wiphy_idx(struct wiphy *wiphy);
161 
162 struct cfg80211_registered_device *
163 __cfg80211_rdev_from_info(struct genl_info *info);
164 
165 /*
166  * This function returns a pointer to the driver
167  * that the genl_info item that is passed refers to.
168  * If successful, it returns non-NULL and also locks
169  * the driver's mutex!
170  *
171  * This means that you need to call cfg80211_unlock_rdev()
172  * before being allowed to acquire &cfg80211_mutex!
173  *
174  * This is necessary because we need to lock the global
175  * mutex to get an item off the list safely, and then
176  * we lock the rdev mutex so it doesn't go away under us.
177  *
178  * We don't want to keep cfg80211_mutex locked
179  * for all the time in order to allow requests on
180  * other interfaces to go through at the same time.
181  *
182  * The result of this can be a PTR_ERR and hence must
183  * be checked with IS_ERR() for errors.
184  */
185 extern struct cfg80211_registered_device *
186 cfg80211_get_dev_from_info(struct genl_info *info);
187 
188 /* requires cfg80211_rdev_mutex to be held! */
189 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
190 
191 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
192 extern struct cfg80211_registered_device *
193 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
194 
195 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
196 			  struct net *net);
197 
198 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
199 {
200 	mutex_lock(&rdev->mtx);
201 }
202 
203 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
204 {
205 	BUG_ON(IS_ERR(rdev) || !rdev);
206 	mutex_unlock(&rdev->mtx);
207 }
208 
209 static inline void wdev_lock(struct wireless_dev *wdev)
210 	__acquires(wdev)
211 {
212 	mutex_lock(&wdev->mtx);
213 	__acquire(wdev->mtx);
214 }
215 
216 static inline void wdev_unlock(struct wireless_dev *wdev)
217 	__releases(wdev)
218 {
219 	__release(wdev->mtx);
220 	mutex_unlock(&wdev->mtx);
221 }
222 
223 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
224 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
225 
226 enum cfg80211_event_type {
227 	EVENT_CONNECT_RESULT,
228 	EVENT_ROAMED,
229 	EVENT_DISCONNECTED,
230 	EVENT_IBSS_JOINED,
231 };
232 
233 struct cfg80211_event {
234 	struct list_head list;
235 	enum cfg80211_event_type type;
236 
237 	union {
238 		struct {
239 			u8 bssid[ETH_ALEN];
240 			const u8 *req_ie;
241 			const u8 *resp_ie;
242 			size_t req_ie_len;
243 			size_t resp_ie_len;
244 			u16 status;
245 		} cr;
246 		struct {
247 			const u8 *req_ie;
248 			const u8 *resp_ie;
249 			size_t req_ie_len;
250 			size_t resp_ie_len;
251 			struct cfg80211_bss *bss;
252 		} rm;
253 		struct {
254 			const u8 *ie;
255 			size_t ie_len;
256 			u16 reason;
257 		} dc;
258 		struct {
259 			u8 bssid[ETH_ALEN];
260 		} ij;
261 	};
262 };
263 
264 struct cfg80211_cached_keys {
265 	struct key_params params[6];
266 	u8 data[6][WLAN_MAX_KEY_LEN];
267 	int def, defmgmt;
268 };
269 
270 
271 /* free object */
272 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
273 
274 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
275 			       char *newname);
276 
277 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
278 
279 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
280 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
281                       unsigned long age_secs);
282 
283 /* IBSS */
284 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
285 			 struct net_device *dev,
286 			 struct cfg80211_ibss_params *params,
287 			 struct cfg80211_cached_keys *connkeys);
288 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
289 		       struct net_device *dev,
290 		       struct cfg80211_ibss_params *params,
291 		       struct cfg80211_cached_keys *connkeys);
292 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
293 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
294 			  struct net_device *dev, bool nowext);
295 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
296 			struct net_device *dev, bool nowext);
297 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
298 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
299 			    struct wireless_dev *wdev);
300 
301 /* mesh */
302 extern const struct mesh_config default_mesh_config;
303 extern const struct mesh_setup default_mesh_setup;
304 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
305 			 struct net_device *dev,
306 			 const struct mesh_setup *setup,
307 			 const struct mesh_config *conf);
308 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
309 		       struct net_device *dev,
310 		       const struct mesh_setup *setup,
311 		       const struct mesh_config *conf);
312 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
313 			struct net_device *dev);
314 
315 /* MLME */
316 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
317 			 struct net_device *dev,
318 			 struct ieee80211_channel *chan,
319 			 enum nl80211_auth_type auth_type,
320 			 const u8 *bssid,
321 			 const u8 *ssid, int ssid_len,
322 			 const u8 *ie, int ie_len,
323 			 const u8 *key, int key_len, int key_idx);
324 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
325 		       struct net_device *dev, struct ieee80211_channel *chan,
326 		       enum nl80211_auth_type auth_type, const u8 *bssid,
327 		       const u8 *ssid, int ssid_len,
328 		       const u8 *ie, int ie_len,
329 		       const u8 *key, int key_len, int key_idx);
330 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
331 			  struct net_device *dev,
332 			  struct ieee80211_channel *chan,
333 			  const u8 *bssid, const u8 *prev_bssid,
334 			  const u8 *ssid, int ssid_len,
335 			  const u8 *ie, int ie_len, bool use_mfp,
336 			  struct cfg80211_crypto_settings *crypt,
337 			  u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
338 			  struct ieee80211_ht_cap *ht_capa_mask);
339 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
340 			struct net_device *dev, struct ieee80211_channel *chan,
341 			const u8 *bssid, const u8 *prev_bssid,
342 			const u8 *ssid, int ssid_len,
343 			const u8 *ie, int ie_len, bool use_mfp,
344 			struct cfg80211_crypto_settings *crypt,
345 			u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
346 			struct ieee80211_ht_cap *ht_capa_mask);
347 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
348 			   struct net_device *dev, const u8 *bssid,
349 			   const u8 *ie, int ie_len, u16 reason,
350 			   bool local_state_change);
351 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
352 			 struct net_device *dev, const u8 *bssid,
353 			 const u8 *ie, int ie_len, u16 reason,
354 			 bool local_state_change);
355 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
356 			   struct net_device *dev, const u8 *bssid,
357 			   const u8 *ie, int ie_len, u16 reason,
358 			   bool local_state_change);
359 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
360 			struct net_device *dev);
361 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
362 			       const u8 *req_ie, size_t req_ie_len,
363 			       const u8 *resp_ie, size_t resp_ie_len,
364 			       u16 status, bool wextev,
365 			       struct cfg80211_bss *bss);
366 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
367 				u16 frame_type, const u8 *match_data,
368 				int match_len);
369 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
370 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
371 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
372 			  struct net_device *dev,
373 			  struct ieee80211_channel *chan, bool offchan,
374 			  enum nl80211_channel_type channel_type,
375 			  bool channel_type_valid, unsigned int wait,
376 			  const u8 *buf, size_t len, bool no_cck,
377 			  bool dont_wait_for_ack, u64 *cookie);
378 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
379 			       const struct ieee80211_ht_cap *ht_capa_mask);
380 
381 /* SME */
382 int __cfg80211_connect(struct cfg80211_registered_device *rdev,
383 		       struct net_device *dev,
384 		       struct cfg80211_connect_params *connect,
385 		       struct cfg80211_cached_keys *connkeys,
386 		       const u8 *prev_bssid);
387 int cfg80211_connect(struct cfg80211_registered_device *rdev,
388 		     struct net_device *dev,
389 		     struct cfg80211_connect_params *connect,
390 		     struct cfg80211_cached_keys *connkeys);
391 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
392 			  struct net_device *dev, u16 reason,
393 			  bool wextev);
394 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
395 			struct net_device *dev, u16 reason,
396 			bool wextev);
397 void __cfg80211_roamed(struct wireless_dev *wdev,
398 		       struct cfg80211_bss *bss,
399 		       const u8 *req_ie, size_t req_ie_len,
400 		       const u8 *resp_ie, size_t resp_ie_len);
401 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
402 			      struct wireless_dev *wdev);
403 
404 void cfg80211_conn_work(struct work_struct *work);
405 void cfg80211_sme_failed_assoc(struct wireless_dev *wdev);
406 bool cfg80211_sme_failed_reassoc(struct wireless_dev *wdev);
407 
408 /* internal helpers */
409 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
410 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
411 				   struct key_params *params, int key_idx,
412 				   bool pairwise, const u8 *mac_addr);
413 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
414 			     size_t ie_len, u16 reason, bool from_ap);
415 void cfg80211_sme_scan_done(struct net_device *dev);
416 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
417 void cfg80211_sme_disassoc(struct net_device *dev,
418 			   struct cfg80211_internal_bss *bss);
419 void __cfg80211_scan_done(struct work_struct *wk);
420 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
421 void __cfg80211_sched_scan_results(struct work_struct *wk);
422 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
423 			       bool driver_initiated);
424 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
425 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
426 			  struct net_device *dev, enum nl80211_iftype ntype,
427 			  u32 *flags, struct vif_params *params);
428 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
429 
430 int cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
431 				  struct wireless_dev *wdev,
432 				  enum nl80211_iftype iftype);
433 
434 static inline int
435 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
436 			   enum nl80211_iftype iftype)
437 {
438 	return cfg80211_can_change_interface(rdev, NULL, iftype);
439 }
440 
441 struct ieee80211_channel *
442 rdev_freq_to_chan(struct cfg80211_registered_device *rdev,
443 		  int freq, enum nl80211_channel_type channel_type);
444 int cfg80211_set_freq(struct cfg80211_registered_device *rdev,
445 		      struct wireless_dev *wdev, int freq,
446 		      enum nl80211_channel_type channel_type);
447 
448 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
449 			   const u8 *rates, unsigned int n_rates,
450 			   u32 *mask);
451 
452 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
453 				 u32 beacon_int);
454 
455 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
456 #define CFG80211_DEV_WARN_ON(cond)	WARN_ON(cond)
457 #else
458 /*
459  * Trick to enable using it as a condition,
460  * and also not give a warning when it's
461  * not used that way.
462  */
463 #define CFG80211_DEV_WARN_ON(cond)	({bool __r = (cond); __r; })
464 #endif
465 
466 #endif /* __NET_WIRELESS_CORE_H */
467