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