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