xref: /openbmc/linux/net/wireless/core.h (revision 8b235f2f)
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/list.h>
9 #include <linux/netdevice.h>
10 #include <linux/rbtree.h>
11 #include <linux/debugfs.h>
12 #include <linux/rfkill.h>
13 #include <linux/workqueue.h>
14 #include <linux/rtnetlink.h>
15 #include <net/genetlink.h>
16 #include <net/cfg80211.h>
17 #include "reg.h"
18 
19 
20 #define WIPHY_IDX_INVALID	-1
21 
22 struct cfg80211_registered_device {
23 	const struct cfg80211_ops *ops;
24 	struct list_head list;
25 
26 	/* rfkill support */
27 	struct rfkill_ops rfkill_ops;
28 	struct rfkill *rfkill;
29 	struct work_struct rfkill_sync;
30 
31 	/* ISO / IEC 3166 alpha2 for which this device is receiving
32 	 * country IEs on, this can help disregard country IEs from APs
33 	 * on the same alpha2 quickly. The alpha2 may differ from
34 	 * cfg80211_regdomain's alpha2 when an intersection has occurred.
35 	 * If the AP is reconfigured this can also be used to tell us if
36 	 * the country on the country IE changed. */
37 	char country_ie_alpha2[2];
38 
39 	/*
40 	 * the driver requests the regulatory core to set this regulatory
41 	 * domain as the wiphy's. Only used for %REGULATORY_WIPHY_SELF_MANAGED
42 	 * devices using the regulatory_set_wiphy_regd() API
43 	 */
44 	const struct ieee80211_regdomain *requested_regd;
45 
46 	/* If a Country IE has been received this tells us the environment
47 	 * which its telling us its in. This defaults to ENVIRON_ANY */
48 	enum environment_cap env;
49 
50 	/* wiphy index, internal only */
51 	int wiphy_idx;
52 
53 	/* associated wireless interfaces, protected by rtnl or RCU */
54 	struct list_head wdev_list;
55 	int devlist_generation, wdev_id;
56 	int opencount; /* also protected by devlist_mtx */
57 	wait_queue_head_t dev_wait;
58 
59 	struct list_head beacon_registrations;
60 	spinlock_t beacon_registrations_lock;
61 
62 	struct list_head mlme_unreg;
63 	spinlock_t mlme_unreg_lock;
64 	struct work_struct mlme_unreg_wk;
65 
66 	/* protected by RTNL only */
67 	int num_running_ifaces;
68 	int num_running_monitor_ifaces;
69 
70 	/* BSSes/scanning */
71 	spinlock_t bss_lock;
72 	struct list_head bss_list;
73 	struct rb_root bss_tree;
74 	u32 bss_generation;
75 	struct cfg80211_scan_request *scan_req; /* protected by RTNL */
76 	struct sk_buff *scan_msg;
77 	struct cfg80211_sched_scan_request __rcu *sched_scan_req;
78 	unsigned long suspend_at;
79 	struct work_struct scan_done_wk;
80 	struct work_struct sched_scan_results_wk;
81 
82 	struct genl_info *cur_cmd_info;
83 
84 	struct work_struct conn_work;
85 	struct work_struct event_work;
86 
87 	struct delayed_work dfs_update_channels_wk;
88 
89 	/* netlink port which started critical protocol (0 means not started) */
90 	u32 crit_proto_nlportid;
91 
92 	struct cfg80211_coalesce *coalesce;
93 
94 	spinlock_t destroy_list_lock;
95 	struct list_head destroy_list;
96 	struct work_struct destroy_work;
97 
98 	struct work_struct sched_scan_stop_wk;
99 
100 	/* must be last because of the way we do wiphy_priv(),
101 	 * and it should at least be aligned to NETDEV_ALIGN */
102 	struct wiphy wiphy __aligned(NETDEV_ALIGN);
103 };
104 
105 static inline
106 struct cfg80211_registered_device *wiphy_to_rdev(struct wiphy *wiphy)
107 {
108 	BUG_ON(!wiphy);
109 	return container_of(wiphy, struct cfg80211_registered_device, wiphy);
110 }
111 
112 static inline void
113 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
114 {
115 #ifdef CONFIG_PM
116 	int i;
117 
118 	if (!rdev->wiphy.wowlan_config)
119 		return;
120 	for (i = 0; i < rdev->wiphy.wowlan_config->n_patterns; i++)
121 		kfree(rdev->wiphy.wowlan_config->patterns[i].mask);
122 	kfree(rdev->wiphy.wowlan_config->patterns);
123 	if (rdev->wiphy.wowlan_config->tcp &&
124 	    rdev->wiphy.wowlan_config->tcp->sock)
125 		sock_release(rdev->wiphy.wowlan_config->tcp->sock);
126 	kfree(rdev->wiphy.wowlan_config->tcp);
127 	kfree(rdev->wiphy.wowlan_config->nd_config);
128 	kfree(rdev->wiphy.wowlan_config);
129 #endif
130 }
131 
132 extern struct workqueue_struct *cfg80211_wq;
133 extern struct list_head cfg80211_rdev_list;
134 extern int cfg80211_rdev_list_generation;
135 
136 struct cfg80211_internal_bss {
137 	struct list_head list;
138 	struct list_head hidden_list;
139 	struct rb_node rbn;
140 	unsigned long ts;
141 	unsigned long refcount;
142 	atomic_t hold;
143 
144 	/* must be last because of priv member */
145 	struct cfg80211_bss pub;
146 };
147 
148 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
149 {
150 	return container_of(pub, struct cfg80211_internal_bss, pub);
151 }
152 
153 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
154 {
155 	atomic_inc(&bss->hold);
156 }
157 
158 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
159 {
160 	int r = atomic_dec_return(&bss->hold);
161 	WARN_ON(r < 0);
162 }
163 
164 
165 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
166 int get_wiphy_idx(struct wiphy *wiphy);
167 
168 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
169 
170 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
171 			  struct net *net);
172 
173 static inline void wdev_lock(struct wireless_dev *wdev)
174 	__acquires(wdev)
175 {
176 	mutex_lock(&wdev->mtx);
177 	__acquire(wdev->mtx);
178 }
179 
180 static inline void wdev_unlock(struct wireless_dev *wdev)
181 	__releases(wdev)
182 {
183 	__release(wdev->mtx);
184 	mutex_unlock(&wdev->mtx);
185 }
186 
187 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
188 
189 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
190 {
191 	ASSERT_RTNL();
192 
193 	return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
194 	       rdev->num_running_ifaces > 0;
195 }
196 
197 enum cfg80211_event_type {
198 	EVENT_CONNECT_RESULT,
199 	EVENT_ROAMED,
200 	EVENT_DISCONNECTED,
201 	EVENT_IBSS_JOINED,
202 	EVENT_STOPPED,
203 };
204 
205 struct cfg80211_event {
206 	struct list_head list;
207 	enum cfg80211_event_type type;
208 
209 	union {
210 		struct {
211 			u8 bssid[ETH_ALEN];
212 			const u8 *req_ie;
213 			const u8 *resp_ie;
214 			size_t req_ie_len;
215 			size_t resp_ie_len;
216 			u16 status;
217 		} cr;
218 		struct {
219 			const u8 *req_ie;
220 			const u8 *resp_ie;
221 			size_t req_ie_len;
222 			size_t resp_ie_len;
223 			struct cfg80211_bss *bss;
224 		} rm;
225 		struct {
226 			const u8 *ie;
227 			size_t ie_len;
228 			u16 reason;
229 			bool locally_generated;
230 		} dc;
231 		struct {
232 			u8 bssid[ETH_ALEN];
233 			struct ieee80211_channel *channel;
234 		} ij;
235 	};
236 };
237 
238 struct cfg80211_cached_keys {
239 	struct key_params params[6];
240 	u8 data[6][WLAN_MAX_KEY_LEN];
241 	int def, defmgmt;
242 };
243 
244 enum cfg80211_chan_mode {
245 	CHAN_MODE_UNDEFINED,
246 	CHAN_MODE_SHARED,
247 	CHAN_MODE_EXCLUSIVE,
248 };
249 
250 struct cfg80211_beacon_registration {
251 	struct list_head list;
252 	u32 nlportid;
253 };
254 
255 struct cfg80211_iface_destroy {
256 	struct list_head list;
257 	u32 nlportid;
258 };
259 
260 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
261 
262 /* free object */
263 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
264 
265 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 *rdev);
271 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
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 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
280 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
281 			  struct net_device *dev, bool nowext);
282 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
283 			struct net_device *dev, bool nowext);
284 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
285 			    struct ieee80211_channel *channel);
286 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
287 			    struct wireless_dev *wdev);
288 
289 /* mesh */
290 extern const struct mesh_config default_mesh_config;
291 extern const struct mesh_setup default_mesh_setup;
292 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
293 			 struct net_device *dev,
294 			 struct mesh_setup *setup,
295 			 const struct mesh_config *conf);
296 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
297 		       struct net_device *dev,
298 		       struct mesh_setup *setup,
299 		       const struct mesh_config *conf);
300 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
301 			  struct net_device *dev);
302 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
303 			struct net_device *dev);
304 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
305 			      struct wireless_dev *wdev,
306 			      struct cfg80211_chan_def *chandef);
307 
308 /* OCB */
309 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
310 			struct net_device *dev,
311 			struct ocb_setup *setup);
312 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
313 		      struct net_device *dev,
314 		      struct ocb_setup *setup);
315 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
316 			 struct net_device *dev);
317 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
318 		       struct net_device *dev);
319 
320 /* AP */
321 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
322 		       struct net_device *dev, bool notify);
323 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
324 		     struct net_device *dev, bool notify);
325 
326 /* MLME */
327 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
328 		       struct net_device *dev,
329 		       struct ieee80211_channel *chan,
330 		       enum nl80211_auth_type auth_type,
331 		       const u8 *bssid,
332 		       const u8 *ssid, int ssid_len,
333 		       const u8 *ie, int ie_len,
334 		       const u8 *key, int key_len, int key_idx,
335 		       const u8 *sae_data, int sae_data_len);
336 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
337 			struct net_device *dev,
338 			struct ieee80211_channel *chan,
339 			const u8 *bssid,
340 			const u8 *ssid, int ssid_len,
341 			struct cfg80211_assoc_request *req);
342 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
343 			 struct net_device *dev, const u8 *bssid,
344 			 const u8 *ie, int ie_len, u16 reason,
345 			 bool local_state_change);
346 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
347 			   struct net_device *dev, const u8 *bssid,
348 			   const u8 *ie, int ie_len, u16 reason,
349 			   bool local_state_change);
350 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
351 			struct net_device *dev);
352 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
353 				u16 frame_type, const u8 *match_data,
354 				int match_len);
355 void cfg80211_mlme_unreg_wk(struct work_struct *wk);
356 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
357 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
358 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
359 			  struct wireless_dev *wdev,
360 			  struct cfg80211_mgmt_tx_params *params,
361 			  u64 *cookie);
362 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
363 			       const struct ieee80211_ht_cap *ht_capa_mask);
364 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
365 				const struct ieee80211_vht_cap *vht_capa_mask);
366 
367 /* SME events */
368 int cfg80211_connect(struct cfg80211_registered_device *rdev,
369 		     struct net_device *dev,
370 		     struct cfg80211_connect_params *connect,
371 		     struct cfg80211_cached_keys *connkeys,
372 		     const u8 *prev_bssid);
373 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
374 			       const u8 *req_ie, size_t req_ie_len,
375 			       const u8 *resp_ie, size_t resp_ie_len,
376 			       u16 status, bool wextev,
377 			       struct cfg80211_bss *bss);
378 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
379 			     size_t ie_len, u16 reason, bool from_ap);
380 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
381 			struct net_device *dev, u16 reason,
382 			bool wextev);
383 void __cfg80211_roamed(struct wireless_dev *wdev,
384 		       struct cfg80211_bss *bss,
385 		       const u8 *req_ie, size_t req_ie_len,
386 		       const u8 *resp_ie, size_t resp_ie_len);
387 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
388 			      struct wireless_dev *wdev);
389 
390 /* SME implementation */
391 void cfg80211_conn_work(struct work_struct *work);
392 void cfg80211_sme_scan_done(struct net_device *dev);
393 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
394 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
395 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
396 void cfg80211_sme_deauth(struct wireless_dev *wdev);
397 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
398 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
399 
400 /* internal helpers */
401 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
402 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
403 				   struct key_params *params, int key_idx,
404 				   bool pairwise, const u8 *mac_addr);
405 void __cfg80211_scan_done(struct work_struct *wk);
406 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
407 			   bool send_message);
408 void __cfg80211_sched_scan_results(struct work_struct *wk);
409 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
410 			       bool driver_initiated);
411 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
412 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
413 			  struct net_device *dev, enum nl80211_iftype ntype,
414 			  u32 *flags, struct vif_params *params);
415 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
416 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
417 
418 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
419 				 struct wireless_dev *wdev,
420 				 enum nl80211_iftype iftype,
421 				 struct ieee80211_channel *chan,
422 				 enum cfg80211_chan_mode chanmode,
423 				 u8 radar_detect);
424 
425 /**
426  * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable
427  * @wiphy: the wiphy to validate against
428  * @chandef: the channel definition to check
429  *
430  * Checks if chandef is usable and we can/need start CAC on such channel.
431  *
432  * Return: Return true if all channels available and at least
433  *	   one channel require CAC (NL80211_DFS_USABLE)
434  */
435 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
436 				 const struct cfg80211_chan_def *chandef);
437 
438 void cfg80211_set_dfs_state(struct wiphy *wiphy,
439 			    const struct cfg80211_chan_def *chandef,
440 			    enum nl80211_dfs_state dfs_state);
441 
442 void cfg80211_dfs_channels_update_work(struct work_struct *work);
443 
444 unsigned int
445 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
446 			      const struct cfg80211_chan_def *chandef);
447 
448 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
449 {
450 	unsigned long end = jiffies;
451 
452 	if (end >= start)
453 		return jiffies_to_msecs(end - start);
454 
455 	return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
456 }
457 
458 void
459 cfg80211_get_chan_state(struct wireless_dev *wdev,
460 		        struct ieee80211_channel **chan,
461 		        enum cfg80211_chan_mode *chanmode,
462 		        u8 *radar_detect);
463 
464 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
465 				 struct cfg80211_chan_def *chandef);
466 
467 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
468 			   const u8 *rates, unsigned int n_rates,
469 			   u32 *mask);
470 
471 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
472 				 u32 beacon_int);
473 
474 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
475 			       enum nl80211_iftype iftype, int num);
476 
477 void __cfg80211_leave(struct cfg80211_registered_device *rdev,
478 		      struct wireless_dev *wdev);
479 void cfg80211_leave(struct cfg80211_registered_device *rdev,
480 		    struct wireless_dev *wdev);
481 
482 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
483 			      struct wireless_dev *wdev);
484 
485 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
486 
487 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
488 #define CFG80211_DEV_WARN_ON(cond)	WARN_ON(cond)
489 #else
490 /*
491  * Trick to enable using it as a condition,
492  * and also not give a warning when it's
493  * not used that way.
494  */
495 #define CFG80211_DEV_WARN_ON(cond)	({bool __r = (cond); __r; })
496 #endif
497 
498 #endif /* __NET_WIRELESS_CORE_H */
499