xref: /openbmc/linux/net/wireless/core.h (revision 1a59d1b8)
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_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 	if (bss->pub.transmitted_bss) {
186 		bss = container_of(bss->pub.transmitted_bss,
187 				   struct cfg80211_internal_bss, pub);
188 		atomic_inc(&bss->hold);
189 	}
190 }
191 
192 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
193 {
194 	int r = atomic_dec_return(&bss->hold);
195 	WARN_ON(r < 0);
196 	if (bss->pub.transmitted_bss) {
197 		bss = container_of(bss->pub.transmitted_bss,
198 				   struct cfg80211_internal_bss, pub);
199 		r = atomic_dec_return(&bss->hold);
200 		WARN_ON(r < 0);
201 	}
202 }
203 
204 
205 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
206 int get_wiphy_idx(struct wiphy *wiphy);
207 
208 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
209 
210 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
211 			  struct net *net);
212 
213 void cfg80211_init_wdev(struct cfg80211_registered_device *rdev,
214 			struct wireless_dev *wdev);
215 
216 static inline void wdev_lock(struct wireless_dev *wdev)
217 	__acquires(wdev)
218 {
219 	mutex_lock(&wdev->mtx);
220 	__acquire(wdev->mtx);
221 }
222 
223 static inline void wdev_unlock(struct wireless_dev *wdev)
224 	__releases(wdev)
225 {
226 	__release(wdev->mtx);
227 	mutex_unlock(&wdev->mtx);
228 }
229 
230 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
231 
232 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
233 {
234 	ASSERT_RTNL();
235 
236 	return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
237 	       rdev->num_running_ifaces > 0;
238 }
239 
240 enum cfg80211_event_type {
241 	EVENT_CONNECT_RESULT,
242 	EVENT_ROAMED,
243 	EVENT_DISCONNECTED,
244 	EVENT_IBSS_JOINED,
245 	EVENT_STOPPED,
246 	EVENT_PORT_AUTHORIZED,
247 };
248 
249 struct cfg80211_event {
250 	struct list_head list;
251 	enum cfg80211_event_type type;
252 
253 	union {
254 		struct cfg80211_connect_resp_params cr;
255 		struct cfg80211_roam_info rm;
256 		struct {
257 			const u8 *ie;
258 			size_t ie_len;
259 			u16 reason;
260 			bool locally_generated;
261 		} dc;
262 		struct {
263 			u8 bssid[ETH_ALEN];
264 			struct ieee80211_channel *channel;
265 		} ij;
266 		struct {
267 			u8 bssid[ETH_ALEN];
268 		} pa;
269 	};
270 };
271 
272 struct cfg80211_cached_keys {
273 	struct key_params params[CFG80211_MAX_WEP_KEYS];
274 	u8 data[CFG80211_MAX_WEP_KEYS][WLAN_KEY_LEN_WEP104];
275 	int def;
276 };
277 
278 enum cfg80211_chan_mode {
279 	CHAN_MODE_UNDEFINED,
280 	CHAN_MODE_SHARED,
281 	CHAN_MODE_EXCLUSIVE,
282 };
283 
284 struct cfg80211_beacon_registration {
285 	struct list_head list;
286 	u32 nlportid;
287 };
288 
289 struct cfg80211_cqm_config {
290 	u32 rssi_hyst;
291 	s32 last_rssi_event_value;
292 	int n_rssi_thresholds;
293 	s32 rssi_thresholds[0];
294 };
295 
296 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
297 
298 /* free object */
299 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
300 
301 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
302 			char *newname);
303 
304 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
305 
306 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
307 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
308                       unsigned long age_secs);
309 
310 /* IBSS */
311 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
312 			 struct net_device *dev,
313 			 struct cfg80211_ibss_params *params,
314 			 struct cfg80211_cached_keys *connkeys);
315 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
316 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
317 			  struct net_device *dev, bool nowext);
318 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
319 			struct net_device *dev, bool nowext);
320 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
321 			    struct ieee80211_channel *channel);
322 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
323 			    struct wireless_dev *wdev);
324 
325 /* mesh */
326 extern const struct mesh_config default_mesh_config;
327 extern const struct mesh_setup default_mesh_setup;
328 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
329 			 struct net_device *dev,
330 			 struct mesh_setup *setup,
331 			 const struct mesh_config *conf);
332 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
333 			  struct net_device *dev);
334 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
335 			struct net_device *dev);
336 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
337 			      struct wireless_dev *wdev,
338 			      struct cfg80211_chan_def *chandef);
339 
340 /* OCB */
341 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
342 			struct net_device *dev,
343 			struct ocb_setup *setup);
344 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
345 		      struct net_device *dev,
346 		      struct ocb_setup *setup);
347 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
348 			 struct net_device *dev);
349 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
350 		       struct net_device *dev);
351 
352 /* AP */
353 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
354 		       struct net_device *dev, bool notify);
355 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
356 		     struct net_device *dev, bool notify);
357 
358 /* MLME */
359 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
360 		       struct net_device *dev,
361 		       struct ieee80211_channel *chan,
362 		       enum nl80211_auth_type auth_type,
363 		       const u8 *bssid,
364 		       const u8 *ssid, int ssid_len,
365 		       const u8 *ie, int ie_len,
366 		       const u8 *key, int key_len, int key_idx,
367 		       const u8 *auth_data, int auth_data_len);
368 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
369 			struct net_device *dev,
370 			struct ieee80211_channel *chan,
371 			const u8 *bssid,
372 			const u8 *ssid, int ssid_len,
373 			struct cfg80211_assoc_request *req);
374 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
375 			 struct net_device *dev, const u8 *bssid,
376 			 const u8 *ie, int ie_len, u16 reason,
377 			 bool local_state_change);
378 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
379 			   struct net_device *dev, const u8 *bssid,
380 			   const u8 *ie, int ie_len, u16 reason,
381 			   bool local_state_change);
382 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
383 			struct net_device *dev);
384 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
385 				u16 frame_type, const u8 *match_data,
386 				int match_len);
387 void cfg80211_mlme_unreg_wk(struct work_struct *wk);
388 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
389 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
390 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
391 			  struct wireless_dev *wdev,
392 			  struct cfg80211_mgmt_tx_params *params,
393 			  u64 *cookie);
394 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
395 			       const struct ieee80211_ht_cap *ht_capa_mask);
396 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
397 				const struct ieee80211_vht_cap *vht_capa_mask);
398 
399 /* SME events */
400 int cfg80211_connect(struct cfg80211_registered_device *rdev,
401 		     struct net_device *dev,
402 		     struct cfg80211_connect_params *connect,
403 		     struct cfg80211_cached_keys *connkeys,
404 		     const u8 *prev_bssid);
405 void __cfg80211_connect_result(struct net_device *dev,
406 			       struct cfg80211_connect_resp_params *params,
407 			       bool wextev);
408 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
409 			     size_t ie_len, u16 reason, bool from_ap);
410 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
411 			struct net_device *dev, u16 reason,
412 			bool wextev);
413 void __cfg80211_roamed(struct wireless_dev *wdev,
414 		       struct cfg80211_roam_info *info);
415 void __cfg80211_port_authorized(struct wireless_dev *wdev, const u8 *bssid);
416 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
417 			      struct wireless_dev *wdev);
418 void cfg80211_autodisconnect_wk(struct work_struct *work);
419 
420 /* SME implementation */
421 void cfg80211_conn_work(struct work_struct *work);
422 void cfg80211_sme_scan_done(struct net_device *dev);
423 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
424 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
425 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
426 void cfg80211_sme_deauth(struct wireless_dev *wdev);
427 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
428 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
429 void cfg80211_sme_abandon_assoc(struct wireless_dev *wdev);
430 
431 /* internal helpers */
432 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
433 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
434 				   struct key_params *params, int key_idx,
435 				   bool pairwise, const u8 *mac_addr);
436 void __cfg80211_scan_done(struct work_struct *wk);
437 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
438 			   bool send_message);
439 void cfg80211_add_sched_scan_req(struct cfg80211_registered_device *rdev,
440 				 struct cfg80211_sched_scan_request *req);
441 int cfg80211_sched_scan_req_possible(struct cfg80211_registered_device *rdev,
442 				     bool want_multi);
443 void cfg80211_sched_scan_results_wk(struct work_struct *work);
444 int cfg80211_stop_sched_scan_req(struct cfg80211_registered_device *rdev,
445 				 struct cfg80211_sched_scan_request *req,
446 				 bool driver_initiated);
447 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
448 			       u64 reqid, bool driver_initiated);
449 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
450 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
451 			  struct net_device *dev, enum nl80211_iftype ntype,
452 			  struct vif_params *params);
453 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
454 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
455 
456 bool cfg80211_does_bw_fit_range(const struct ieee80211_freq_range *freq_range,
457 				u32 center_freq_khz, u32 bw_khz);
458 
459 extern struct work_struct cfg80211_disconnect_work;
460 
461 /**
462  * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable
463  * @wiphy: the wiphy to validate against
464  * @chandef: the channel definition to check
465  *
466  * Checks if chandef is usable and we can/need start CAC on such channel.
467  *
468  * Return: Return true if all channels available and at least
469  *	   one channel require CAC (NL80211_DFS_USABLE)
470  */
471 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
472 				 const struct cfg80211_chan_def *chandef);
473 
474 void cfg80211_set_dfs_state(struct wiphy *wiphy,
475 			    const struct cfg80211_chan_def *chandef,
476 			    enum nl80211_dfs_state dfs_state);
477 
478 void cfg80211_dfs_channels_update_work(struct work_struct *work);
479 
480 unsigned int
481 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
482 			      const struct cfg80211_chan_def *chandef);
483 
484 void cfg80211_sched_dfs_chan_update(struct cfg80211_registered_device *rdev);
485 
486 bool cfg80211_any_wiphy_oper_chan(struct wiphy *wiphy,
487 				  struct ieee80211_channel *chan);
488 
489 bool cfg80211_beaconing_iface_active(struct wireless_dev *wdev);
490 
491 bool cfg80211_is_sub_chan(struct cfg80211_chan_def *chandef,
492 			  struct ieee80211_channel *chan);
493 
494 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
495 {
496 	unsigned long end = jiffies;
497 
498 	if (end >= start)
499 		return jiffies_to_msecs(end - start);
500 
501 	return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
502 }
503 
504 void
505 cfg80211_get_chan_state(struct wireless_dev *wdev,
506 		        struct ieee80211_channel **chan,
507 		        enum cfg80211_chan_mode *chanmode,
508 		        u8 *radar_detect);
509 
510 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
511 				 struct cfg80211_chan_def *chandef);
512 
513 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
514 			   const u8 *rates, unsigned int n_rates,
515 			   u32 *mask);
516 
517 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
518 				 enum nl80211_iftype iftype, u32 beacon_int);
519 
520 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
521 			       enum nl80211_iftype iftype, int num);
522 
523 void __cfg80211_leave(struct cfg80211_registered_device *rdev,
524 		      struct wireless_dev *wdev);
525 void cfg80211_leave(struct cfg80211_registered_device *rdev,
526 		    struct wireless_dev *wdev);
527 
528 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
529 			      struct wireless_dev *wdev);
530 
531 void cfg80211_stop_nan(struct cfg80211_registered_device *rdev,
532 		       struct wireless_dev *wdev);
533 
534 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
535 #define CFG80211_DEV_WARN_ON(cond)	WARN_ON(cond)
536 #else
537 /*
538  * Trick to enable using it as a condition,
539  * and also not give a warning when it's
540  * not used that way.
541  */
542 #define CFG80211_DEV_WARN_ON(cond)	({bool __r = (cond); __r; })
543 #endif
544 
545 void cfg80211_cqm_config_free(struct wireless_dev *wdev);
546 
547 void cfg80211_release_pmsr(struct wireless_dev *wdev, u32 portid);
548 void cfg80211_pmsr_wdev_down(struct wireless_dev *wdev);
549 void cfg80211_pmsr_free_wk(struct work_struct *work);
550 
551 #endif /* __NET_WIRELESS_CORE_H */
552