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