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