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