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