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