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