xref: /openbmc/linux/net/wireless/core.h (revision 840ef8b7cc584a23c4f9d05352f4dbaf8e56e5ab)
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/rbtree.h>
12 #include <linux/debugfs.h>
13 #include <linux/rfkill.h>
14 #include <linux/workqueue.h>
15 #include <linux/rtnetlink.h>
16 #include <net/genetlink.h>
17 #include <net/cfg80211.h>
18 #include "reg.h"
19 
20 
21 #define WIPHY_IDX_INVALID	-1
22 
23 struct cfg80211_registered_device {
24 	const struct cfg80211_ops *ops;
25 	struct list_head list;
26 	/* we hold this mutex during any call so that
27 	 * we cannot do multiple calls at once, and also
28 	 * to avoid the deregister call to proceed while
29 	 * any call is in progress */
30 	struct mutex mtx;
31 
32 	/* rfkill support */
33 	struct rfkill_ops rfkill_ops;
34 	struct rfkill *rfkill;
35 	struct work_struct rfkill_sync;
36 
37 	/* ISO / IEC 3166 alpha2 for which this device is receiving
38 	 * country IEs on, this can help disregard country IEs from APs
39 	 * on the same alpha2 quickly. The alpha2 may differ from
40 	 * cfg80211_regdomain's alpha2 when an intersection has occurred.
41 	 * If the AP is reconfigured this can also be used to tell us if
42 	 * the country on the country IE changed. */
43 	char country_ie_alpha2[2];
44 
45 	/* If a Country IE has been received this tells us the environment
46 	 * which its telling us its in. This defaults to ENVIRON_ANY */
47 	enum environment_cap env;
48 
49 	/* wiphy index, internal only */
50 	int wiphy_idx;
51 
52 	/* associated wireless interfaces */
53 	struct mutex devlist_mtx;
54 	/* protected by devlist_mtx or RCU */
55 	struct list_head wdev_list;
56 	int devlist_generation, wdev_id;
57 	int opencount; /* also protected by devlist_mtx */
58 	wait_queue_head_t dev_wait;
59 
60 	struct list_head beacon_registrations;
61 	spinlock_t beacon_registrations_lock;
62 
63 	/* protected by RTNL only */
64 	int num_running_ifaces;
65 	int num_running_monitor_ifaces;
66 
67 	/* BSSes/scanning */
68 	spinlock_t bss_lock;
69 	struct list_head bss_list;
70 	struct rb_root bss_tree;
71 	u32 bss_generation;
72 	struct cfg80211_scan_request *scan_req; /* protected by RTNL */
73 	struct cfg80211_sched_scan_request *sched_scan_req;
74 	unsigned long suspend_at;
75 	struct work_struct scan_done_wk;
76 	struct work_struct sched_scan_results_wk;
77 
78 	struct mutex sched_scan_mtx;
79 
80 #ifdef CONFIG_NL80211_TESTMODE
81 	struct genl_info *testmode_info;
82 #endif
83 
84 	struct work_struct conn_work;
85 	struct work_struct event_work;
86 
87 	struct cfg80211_wowlan *wowlan;
88 
89 	struct delayed_work dfs_update_channels_wk;
90 
91 	/* must be last because of the way we do wiphy_priv(),
92 	 * and it should at least be aligned to NETDEV_ALIGN */
93 	struct wiphy wiphy __aligned(NETDEV_ALIGN);
94 };
95 
96 static inline
97 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
98 {
99 	BUG_ON(!wiphy);
100 	return container_of(wiphy, struct cfg80211_registered_device, wiphy);
101 }
102 
103 static inline void
104 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
105 {
106 	int i;
107 
108 	if (!rdev->wowlan)
109 		return;
110 	for (i = 0; i < rdev->wowlan->n_patterns; i++)
111 		kfree(rdev->wowlan->patterns[i].mask);
112 	kfree(rdev->wowlan->patterns);
113 	if (rdev->wowlan->tcp && rdev->wowlan->tcp->sock)
114 		sock_release(rdev->wowlan->tcp->sock);
115 	kfree(rdev->wowlan->tcp);
116 	kfree(rdev->wowlan);
117 }
118 
119 extern struct workqueue_struct *cfg80211_wq;
120 extern struct mutex cfg80211_mutex;
121 extern struct list_head cfg80211_rdev_list;
122 extern int cfg80211_rdev_list_generation;
123 
124 static inline void assert_cfg80211_lock(void)
125 {
126 	lockdep_assert_held(&cfg80211_mutex);
127 }
128 
129 struct cfg80211_internal_bss {
130 	struct list_head list;
131 	struct list_head hidden_list;
132 	struct rb_node rbn;
133 	unsigned long ts;
134 	unsigned long refcount;
135 	atomic_t hold;
136 
137 	/* must be last because of priv member */
138 	struct cfg80211_bss pub;
139 };
140 
141 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
142 {
143 	return container_of(pub, struct cfg80211_internal_bss, pub);
144 }
145 
146 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
147 {
148 	atomic_inc(&bss->hold);
149 }
150 
151 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
152 {
153 	int r = atomic_dec_return(&bss->hold);
154 	WARN_ON(r < 0);
155 }
156 
157 
158 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
159 int get_wiphy_idx(struct wiphy *wiphy);
160 
161 /* requires cfg80211_rdev_mutex to be held! */
162 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
163 
164 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
165 extern struct cfg80211_registered_device *
166 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
167 
168 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
169 			  struct net *net);
170 
171 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
172 {
173 	mutex_lock(&rdev->mtx);
174 }
175 
176 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
177 {
178 	BUG_ON(IS_ERR(rdev) || !rdev);
179 	mutex_unlock(&rdev->mtx);
180 }
181 
182 static inline void wdev_lock(struct wireless_dev *wdev)
183 	__acquires(wdev)
184 {
185 	mutex_lock(&wdev->mtx);
186 	__acquire(wdev->mtx);
187 }
188 
189 static inline void wdev_unlock(struct wireless_dev *wdev)
190 	__releases(wdev)
191 {
192 	__release(wdev->mtx);
193 	mutex_unlock(&wdev->mtx);
194 }
195 
196 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
197 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
198 
199 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
200 {
201 	ASSERT_RTNL();
202 
203 	return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
204 	       rdev->num_running_ifaces > 0;
205 }
206 
207 enum cfg80211_event_type {
208 	EVENT_CONNECT_RESULT,
209 	EVENT_ROAMED,
210 	EVENT_DISCONNECTED,
211 	EVENT_IBSS_JOINED,
212 };
213 
214 struct cfg80211_event {
215 	struct list_head list;
216 	enum cfg80211_event_type type;
217 
218 	union {
219 		struct {
220 			u8 bssid[ETH_ALEN];
221 			const u8 *req_ie;
222 			const u8 *resp_ie;
223 			size_t req_ie_len;
224 			size_t resp_ie_len;
225 			u16 status;
226 		} cr;
227 		struct {
228 			const u8 *req_ie;
229 			const u8 *resp_ie;
230 			size_t req_ie_len;
231 			size_t resp_ie_len;
232 			struct cfg80211_bss *bss;
233 		} rm;
234 		struct {
235 			const u8 *ie;
236 			size_t ie_len;
237 			u16 reason;
238 		} dc;
239 		struct {
240 			u8 bssid[ETH_ALEN];
241 		} ij;
242 	};
243 };
244 
245 struct cfg80211_cached_keys {
246 	struct key_params params[6];
247 	u8 data[6][WLAN_MAX_KEY_LEN];
248 	int def, defmgmt;
249 };
250 
251 enum cfg80211_chan_mode {
252 	CHAN_MODE_UNDEFINED,
253 	CHAN_MODE_SHARED,
254 	CHAN_MODE_EXCLUSIVE,
255 };
256 
257 struct cfg80211_beacon_registration {
258 	struct list_head list;
259 	u32 nlportid;
260 };
261 
262 /* free object */
263 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
264 
265 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
266 			       char *newname);
267 
268 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
269 
270 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
271 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
272                       unsigned long age_secs);
273 
274 /* IBSS */
275 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
276 			 struct net_device *dev,
277 			 struct cfg80211_ibss_params *params,
278 			 struct cfg80211_cached_keys *connkeys);
279 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
280 		       struct net_device *dev,
281 		       struct cfg80211_ibss_params *params,
282 		       struct cfg80211_cached_keys *connkeys);
283 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
284 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
285 			  struct net_device *dev, bool nowext);
286 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
287 			struct net_device *dev, bool nowext);
288 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
289 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
290 			    struct wireless_dev *wdev);
291 
292 /* mesh */
293 extern const struct mesh_config default_mesh_config;
294 extern const struct mesh_setup default_mesh_setup;
295 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
296 			 struct net_device *dev,
297 			 struct mesh_setup *setup,
298 			 const struct mesh_config *conf);
299 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
300 		       struct net_device *dev,
301 		       struct mesh_setup *setup,
302 		       const struct mesh_config *conf);
303 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
304 			struct net_device *dev);
305 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
306 			      struct wireless_dev *wdev,
307 			      struct cfg80211_chan_def *chandef);
308 
309 /* AP */
310 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
311 		     struct net_device *dev);
312 
313 /* MLME */
314 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
315 			 struct net_device *dev,
316 			 struct ieee80211_channel *chan,
317 			 enum nl80211_auth_type auth_type,
318 			 const u8 *bssid,
319 			 const u8 *ssid, int ssid_len,
320 			 const u8 *ie, int ie_len,
321 			 const u8 *key, int key_len, int key_idx,
322 			 const u8 *sae_data, int sae_data_len);
323 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
324 		       struct net_device *dev, struct ieee80211_channel *chan,
325 		       enum nl80211_auth_type auth_type, const u8 *bssid,
326 		       const u8 *ssid, int ssid_len,
327 		       const u8 *ie, int ie_len,
328 		       const u8 *key, int key_len, int key_idx,
329 		       const u8 *sae_data, int sae_data_len);
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 wireless_dev *wdev,
373 			  struct ieee80211_channel *chan, bool offchan,
374 			  unsigned int wait, const u8 *buf, size_t len,
375 			  bool no_cck, bool dont_wait_for_ack, u64 *cookie);
376 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
377 			       const struct ieee80211_ht_cap *ht_capa_mask);
378 
379 /* SME */
380 int __cfg80211_connect(struct cfg80211_registered_device *rdev,
381 		       struct net_device *dev,
382 		       struct cfg80211_connect_params *connect,
383 		       struct cfg80211_cached_keys *connkeys,
384 		       const u8 *prev_bssid);
385 int cfg80211_connect(struct cfg80211_registered_device *rdev,
386 		     struct net_device *dev,
387 		     struct cfg80211_connect_params *connect,
388 		     struct cfg80211_cached_keys *connkeys);
389 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
390 			  struct net_device *dev, u16 reason,
391 			  bool wextev);
392 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
393 			struct net_device *dev, u16 reason,
394 			bool wextev);
395 void __cfg80211_roamed(struct wireless_dev *wdev,
396 		       struct cfg80211_bss *bss,
397 		       const u8 *req_ie, size_t req_ie_len,
398 		       const u8 *resp_ie, size_t resp_ie_len);
399 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
400 			      struct wireless_dev *wdev);
401 
402 void cfg80211_conn_work(struct work_struct *work);
403 void cfg80211_sme_failed_assoc(struct wireless_dev *wdev);
404 bool cfg80211_sme_failed_reassoc(struct wireless_dev *wdev);
405 
406 /* internal helpers */
407 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
408 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
409 				   struct key_params *params, int key_idx,
410 				   bool pairwise, const u8 *mac_addr);
411 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
412 			     size_t ie_len, u16 reason, bool from_ap);
413 void cfg80211_sme_scan_done(struct net_device *dev);
414 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
415 void cfg80211_sme_disassoc(struct net_device *dev,
416 			   struct cfg80211_internal_bss *bss);
417 void __cfg80211_scan_done(struct work_struct *wk);
418 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
419 void __cfg80211_sched_scan_results(struct work_struct *wk);
420 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
421 			       bool driver_initiated);
422 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
423 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
424 			  struct net_device *dev, enum nl80211_iftype ntype,
425 			  u32 *flags, struct vif_params *params);
426 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
427 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
428 
429 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
430 				 struct wireless_dev *wdev,
431 				 enum nl80211_iftype iftype,
432 				 struct ieee80211_channel *chan,
433 				 enum cfg80211_chan_mode chanmode,
434 				 u8 radar_detect);
435 
436 /**
437  * cfg80211_chandef_dfs_required - checks if radar detection is required
438  * @wiphy: the wiphy to validate against
439  * @chandef: the channel definition to check
440  * Return: 1 if radar detection is required, 0 if it is not, < 0 on error
441  */
442 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
443 				  const struct cfg80211_chan_def *c);
444 
445 void cfg80211_set_dfs_state(struct wiphy *wiphy,
446 			    const struct cfg80211_chan_def *chandef,
447 			    enum nl80211_dfs_state dfs_state);
448 
449 void cfg80211_dfs_channels_update_work(struct work_struct *work);
450 
451 
452 static inline int
453 cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
454 			      struct wireless_dev *wdev,
455 			      enum nl80211_iftype iftype)
456 {
457 	return cfg80211_can_use_iftype_chan(rdev, wdev, iftype, NULL,
458 					    CHAN_MODE_UNDEFINED, 0);
459 }
460 
461 static inline int
462 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
463 			   enum nl80211_iftype iftype)
464 {
465 	return cfg80211_can_change_interface(rdev, NULL, iftype);
466 }
467 
468 static inline int
469 cfg80211_can_use_chan(struct cfg80211_registered_device *rdev,
470 		      struct wireless_dev *wdev,
471 		      struct ieee80211_channel *chan,
472 		      enum cfg80211_chan_mode chanmode)
473 {
474 	return cfg80211_can_use_iftype_chan(rdev, wdev, wdev->iftype,
475 					    chan, chanmode, 0);
476 }
477 
478 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
479 {
480 	unsigned long end = jiffies;
481 
482 	if (end >= start)
483 		return jiffies_to_msecs(end - start);
484 
485 	return jiffies_to_msecs(end + (MAX_JIFFY_OFFSET - start) + 1);
486 }
487 
488 void
489 cfg80211_get_chan_state(struct wireless_dev *wdev,
490 		        struct ieee80211_channel **chan,
491 		        enum cfg80211_chan_mode *chanmode);
492 
493 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
494 				 struct cfg80211_chan_def *chandef);
495 
496 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
497 			   const u8 *rates, unsigned int n_rates,
498 			   u32 *mask);
499 
500 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
501 				 u32 beacon_int);
502 
503 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
504 			       enum nl80211_iftype iftype, int num);
505 
506 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
507 
508 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
509 #define CFG80211_DEV_WARN_ON(cond)	WARN_ON(cond)
510 #else
511 /*
512  * Trick to enable using it as a condition,
513  * and also not give a warning when it's
514  * not used that way.
515  */
516 #define CFG80211_DEV_WARN_ON(cond)	({bool __r = (cond); __r; })
517 #endif
518 
519 #endif /* __NET_WIRELESS_CORE_H */
520