xref: /openbmc/linux/net/wireless/core.h (revision 293d5b43)
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 	/* protected by RTNL */
54 	int devlist_generation, wdev_id;
55 	int opencount;
56 	wait_queue_head_t dev_wait;
57 
58 	struct list_head beacon_registrations;
59 	spinlock_t beacon_registrations_lock;
60 
61 	struct list_head mlme_unreg;
62 	spinlock_t mlme_unreg_lock;
63 	struct work_struct mlme_unreg_wk;
64 
65 	/* protected by RTNL only */
66 	int num_running_ifaces;
67 	int num_running_monitor_ifaces;
68 
69 	/* BSSes/scanning */
70 	spinlock_t bss_lock;
71 	struct list_head bss_list;
72 	struct rb_root bss_tree;
73 	u32 bss_generation;
74 	struct cfg80211_scan_request *scan_req; /* protected by RTNL */
75 	struct sk_buff *scan_msg;
76 	struct cfg80211_sched_scan_request __rcu *sched_scan_req;
77 	unsigned long suspend_at;
78 	struct work_struct scan_done_wk;
79 	struct work_struct sched_scan_results_wk;
80 
81 	struct genl_info *cur_cmd_info;
82 
83 	struct work_struct conn_work;
84 	struct work_struct event_work;
85 
86 	struct delayed_work dfs_update_channels_wk;
87 
88 	/* netlink port which started critical protocol (0 means not started) */
89 	u32 crit_proto_nlportid;
90 
91 	struct cfg80211_coalesce *coalesce;
92 
93 	spinlock_t destroy_list_lock;
94 	struct list_head destroy_list;
95 	struct work_struct destroy_work;
96 
97 	struct work_struct sched_scan_stop_wk;
98 
99 	/* must be last because of the way we do wiphy_priv(),
100 	 * and it should at least be aligned to NETDEV_ALIGN */
101 	struct wiphy wiphy __aligned(NETDEV_ALIGN);
102 };
103 
104 static inline
105 struct cfg80211_registered_device *wiphy_to_rdev(struct wiphy *wiphy)
106 {
107 	BUG_ON(!wiphy);
108 	return container_of(wiphy, struct cfg80211_registered_device, wiphy);
109 }
110 
111 static inline void
112 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
113 {
114 #ifdef CONFIG_PM
115 	int i;
116 
117 	if (!rdev->wiphy.wowlan_config)
118 		return;
119 	for (i = 0; i < rdev->wiphy.wowlan_config->n_patterns; i++)
120 		kfree(rdev->wiphy.wowlan_config->patterns[i].mask);
121 	kfree(rdev->wiphy.wowlan_config->patterns);
122 	if (rdev->wiphy.wowlan_config->tcp &&
123 	    rdev->wiphy.wowlan_config->tcp->sock)
124 		sock_release(rdev->wiphy.wowlan_config->tcp->sock);
125 	kfree(rdev->wiphy.wowlan_config->tcp);
126 	kfree(rdev->wiphy.wowlan_config->nd_config);
127 	kfree(rdev->wiphy.wowlan_config);
128 #endif
129 }
130 
131 extern struct workqueue_struct *cfg80211_wq;
132 extern struct list_head cfg80211_rdev_list;
133 extern int cfg80211_rdev_list_generation;
134 
135 struct cfg80211_internal_bss {
136 	struct list_head list;
137 	struct list_head hidden_list;
138 	struct rb_node rbn;
139 	u64 ts_boottime;
140 	unsigned long ts;
141 	unsigned long refcount;
142 	atomic_t hold;
143 
144 	/* time at the start of the reception of the first octet of the
145 	 * timestamp field of the last beacon/probe received for this BSS.
146 	 * The time is the TSF of the BSS specified by %parent_bssid.
147 	 */
148 	u64 parent_tsf;
149 
150 	/* the BSS according to which %parent_tsf is set. This is set to
151 	 * the BSS that the interface that requested the scan was connected to
152 	 * when the beacon/probe was received.
153 	 */
154 	u8 parent_bssid[ETH_ALEN] __aligned(2);
155 
156 	/* must be last because of priv member */
157 	struct cfg80211_bss pub;
158 };
159 
160 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
161 {
162 	return container_of(pub, struct cfg80211_internal_bss, pub);
163 }
164 
165 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
166 {
167 	atomic_inc(&bss->hold);
168 }
169 
170 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
171 {
172 	int r = atomic_dec_return(&bss->hold);
173 	WARN_ON(r < 0);
174 }
175 
176 
177 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
178 int get_wiphy_idx(struct wiphy *wiphy);
179 
180 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
181 
182 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
183 			  struct net *net);
184 
185 static inline void wdev_lock(struct wireless_dev *wdev)
186 	__acquires(wdev)
187 {
188 	mutex_lock(&wdev->mtx);
189 	__acquire(wdev->mtx);
190 }
191 
192 static inline void wdev_unlock(struct wireless_dev *wdev)
193 	__releases(wdev)
194 {
195 	__release(wdev->mtx);
196 	mutex_unlock(&wdev->mtx);
197 }
198 
199 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
200 
201 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
202 {
203 	ASSERT_RTNL();
204 
205 	return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
206 	       rdev->num_running_ifaces > 0;
207 }
208 
209 enum cfg80211_event_type {
210 	EVENT_CONNECT_RESULT,
211 	EVENT_ROAMED,
212 	EVENT_DISCONNECTED,
213 	EVENT_IBSS_JOINED,
214 	EVENT_STOPPED,
215 };
216 
217 struct cfg80211_event {
218 	struct list_head list;
219 	enum cfg80211_event_type type;
220 
221 	union {
222 		struct {
223 			u8 bssid[ETH_ALEN];
224 			const u8 *req_ie;
225 			const u8 *resp_ie;
226 			size_t req_ie_len;
227 			size_t resp_ie_len;
228 			struct cfg80211_bss *bss;
229 			int status; /* -1 = failed; 0..65535 = status code */
230 		} cr;
231 		struct {
232 			const u8 *req_ie;
233 			const u8 *resp_ie;
234 			size_t req_ie_len;
235 			size_t resp_ie_len;
236 			struct cfg80211_bss *bss;
237 		} rm;
238 		struct {
239 			const u8 *ie;
240 			size_t ie_len;
241 			u16 reason;
242 			bool locally_generated;
243 		} dc;
244 		struct {
245 			u8 bssid[ETH_ALEN];
246 			struct ieee80211_channel *channel;
247 		} ij;
248 	};
249 };
250 
251 struct cfg80211_cached_keys {
252 	struct key_params params[6];
253 	u8 data[6][WLAN_MAX_KEY_LEN];
254 	int def, defmgmt;
255 };
256 
257 enum cfg80211_chan_mode {
258 	CHAN_MODE_UNDEFINED,
259 	CHAN_MODE_SHARED,
260 	CHAN_MODE_EXCLUSIVE,
261 };
262 
263 struct cfg80211_beacon_registration {
264 	struct list_head list;
265 	u32 nlportid;
266 };
267 
268 struct cfg80211_iface_destroy {
269 	struct list_head list;
270 	u32 nlportid;
271 };
272 
273 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
274 
275 /* free object */
276 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
277 
278 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
279 			char *newname);
280 
281 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
282 
283 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
284 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
285                       unsigned long age_secs);
286 
287 /* IBSS */
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 			    struct ieee80211_channel *channel);
299 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
300 			    struct wireless_dev *wdev);
301 
302 /* mesh */
303 extern const struct mesh_config default_mesh_config;
304 extern const struct mesh_setup default_mesh_setup;
305 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
306 			 struct net_device *dev,
307 			 struct mesh_setup *setup,
308 			 const struct mesh_config *conf);
309 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
310 		       struct net_device *dev,
311 		       struct mesh_setup *setup,
312 		       const struct mesh_config *conf);
313 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
314 			  struct net_device *dev);
315 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
316 			struct net_device *dev);
317 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
318 			      struct wireless_dev *wdev,
319 			      struct cfg80211_chan_def *chandef);
320 
321 /* OCB */
322 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
323 			struct net_device *dev,
324 			struct ocb_setup *setup);
325 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
326 		      struct net_device *dev,
327 		      struct ocb_setup *setup);
328 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
329 			 struct net_device *dev);
330 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
331 		       struct net_device *dev);
332 
333 /* AP */
334 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
335 		       struct net_device *dev, bool notify);
336 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
337 		     struct net_device *dev, bool notify);
338 
339 /* MLME */
340 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
341 		       struct net_device *dev,
342 		       struct ieee80211_channel *chan,
343 		       enum nl80211_auth_type auth_type,
344 		       const u8 *bssid,
345 		       const u8 *ssid, int ssid_len,
346 		       const u8 *ie, int ie_len,
347 		       const u8 *key, int key_len, int key_idx,
348 		       const u8 *sae_data, int sae_data_len);
349 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
350 			struct net_device *dev,
351 			struct ieee80211_channel *chan,
352 			const u8 *bssid,
353 			const u8 *ssid, int ssid_len,
354 			struct cfg80211_assoc_request *req);
355 int cfg80211_mlme_deauth(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 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
360 			   struct net_device *dev, const u8 *bssid,
361 			   const u8 *ie, int ie_len, u16 reason,
362 			   bool local_state_change);
363 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
364 			struct net_device *dev);
365 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
366 				u16 frame_type, const u8 *match_data,
367 				int match_len);
368 void cfg80211_mlme_unreg_wk(struct work_struct *wk);
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 cfg80211_mgmt_tx_params *params,
374 			  u64 *cookie);
375 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
376 			       const struct ieee80211_ht_cap *ht_capa_mask);
377 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
378 				const struct ieee80211_vht_cap *vht_capa_mask);
379 
380 /* SME events */
381 int cfg80211_connect(struct cfg80211_registered_device *rdev,
382 		     struct net_device *dev,
383 		     struct cfg80211_connect_params *connect,
384 		     struct cfg80211_cached_keys *connkeys,
385 		     const u8 *prev_bssid);
386 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
387 			       const u8 *req_ie, size_t req_ie_len,
388 			       const u8 *resp_ie, size_t resp_ie_len,
389 			       int status, bool wextev,
390 			       struct cfg80211_bss *bss);
391 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
392 			     size_t ie_len, u16 reason, bool from_ap);
393 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
394 			struct net_device *dev, u16 reason,
395 			bool wextev);
396 void __cfg80211_roamed(struct wireless_dev *wdev,
397 		       struct cfg80211_bss *bss,
398 		       const u8 *req_ie, size_t req_ie_len,
399 		       const u8 *resp_ie, size_t resp_ie_len);
400 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
401 			      struct wireless_dev *wdev);
402 
403 /* SME implementation */
404 void cfg80211_conn_work(struct work_struct *work);
405 void cfg80211_sme_scan_done(struct net_device *dev);
406 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
407 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
408 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
409 void cfg80211_sme_deauth(struct wireless_dev *wdev);
410 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
411 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
412 
413 /* internal helpers */
414 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
415 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
416 				   struct key_params *params, int key_idx,
417 				   bool pairwise, const u8 *mac_addr);
418 void __cfg80211_scan_done(struct work_struct *wk);
419 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
420 			   bool send_message);
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 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
430 
431 /**
432  * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable
433  * @wiphy: the wiphy to validate against
434  * @chandef: the channel definition to check
435  *
436  * Checks if chandef is usable and we can/need start CAC on such channel.
437  *
438  * Return: Return true if all channels available and at least
439  *	   one channel require CAC (NL80211_DFS_USABLE)
440  */
441 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
442 				 const struct cfg80211_chan_def *chandef);
443 
444 void cfg80211_set_dfs_state(struct wiphy *wiphy,
445 			    const struct cfg80211_chan_def *chandef,
446 			    enum nl80211_dfs_state dfs_state);
447 
448 void cfg80211_dfs_channels_update_work(struct work_struct *work);
449 
450 unsigned int
451 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
452 			      const struct cfg80211_chan_def *chandef);
453 
454 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
455 {
456 	unsigned long end = jiffies;
457 
458 	if (end >= start)
459 		return jiffies_to_msecs(end - start);
460 
461 	return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
462 }
463 
464 void
465 cfg80211_get_chan_state(struct wireless_dev *wdev,
466 		        struct ieee80211_channel **chan,
467 		        enum cfg80211_chan_mode *chanmode,
468 		        u8 *radar_detect);
469 
470 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
471 				 struct cfg80211_chan_def *chandef);
472 
473 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
474 			   const u8 *rates, unsigned int n_rates,
475 			   u32 *mask);
476 
477 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
478 				 u32 beacon_int);
479 
480 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
481 			       enum nl80211_iftype iftype, int num);
482 
483 void __cfg80211_leave(struct cfg80211_registered_device *rdev,
484 		      struct wireless_dev *wdev);
485 void cfg80211_leave(struct cfg80211_registered_device *rdev,
486 		    struct wireless_dev *wdev);
487 
488 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
489 			      struct wireless_dev *wdev);
490 
491 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
492 
493 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
494 #define CFG80211_DEV_WARN_ON(cond)	WARN_ON(cond)
495 #else
496 /*
497  * Trick to enable using it as a condition,
498  * and also not give a warning when it's
499  * not used that way.
500  */
501 #define CFG80211_DEV_WARN_ON(cond)	({bool __r = (cond); __r; })
502 #endif
503 
504 #endif /* __NET_WIRELESS_CORE_H */
505