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