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
163/* This is constructed like this so it can be used in if/else */
164static inline int for_each_rdev_check_rtnl(void)
165{
166 ASSERT_RTNL();
167 return 0;
168}
169#define for_each_rdev(rdev) \
170 if (for_each_rdev_check_rtnl()) {} else \
171 list_for_each_entry(rdev, &cfg80211_rdev_list, list)
172
173struct cfg80211_internal_bss {
174 struct list_head list;
175 struct list_head hidden_list;
176 struct rb_node rbn;
177 u64 ts_boottime;
178 unsigned long ts;
179 unsigned long refcount;
180 atomic_t hold;
181
182 /* time at the start of the reception of the first octet of the
183 * timestamp field of the last beacon/probe received for this BSS.
184 * The time is the TSF of the BSS specified by %parent_bssid.
185 */
186 u64 parent_tsf;
187
188 /* the BSS according to which %parent_tsf is set. This is set to
189 * the BSS that the interface that requested the scan was connected to
190 * when the beacon/probe was received.
191 */
192 u8 parent_bssid[ETH_ALEN] __aligned(2);
193
194 /* must be last because of priv member */
195 struct cfg80211_bss pub;
196};
197
198static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
199{
200 return container_of(pub, struct cfg80211_internal_bss, pub);
201}
202
203static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
204{
205 atomic_inc(&bss->hold);
206 if (bss->pub.transmitted_bss) {
207 bss = container_of(bss->pub.transmitted_bss,
208 struct cfg80211_internal_bss, pub);
209 atomic_inc(&bss->hold);
210 }
211}
212
213static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
214{
215 int r = atomic_dec_return(&bss->hold);
216 WARN_ON(r < 0);
217 if (bss->pub.transmitted_bss) {
218 bss = container_of(bss->pub.transmitted_bss,
219 struct cfg80211_internal_bss, pub);
220 r = atomic_dec_return(&bss->hold);
221 WARN_ON(r < 0);
222 }
223}
224
225
226struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
227int get_wiphy_idx(struct wiphy *wiphy);
228
229struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
230
231int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
232 struct net *net);
233
234void cfg80211_init_wdev(struct wireless_dev *wdev);
235void cfg80211_register_wdev(struct cfg80211_registered_device *rdev,
236 struct wireless_dev *wdev);
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 peer_addr[ETH_ALEN];
274 const u8 *td_bitmap;
275 u8 td_bitmap_len;
276 } pa;
277 };
278};
279
280struct cfg80211_cached_keys {
281 struct key_params params[4];
282 u8 data[4][WLAN_KEY_LEN_WEP104];
283 int def;
284};
285
286struct cfg80211_beacon_registration {
287 struct list_head list;
288 u32 nlportid;
289};
290
291struct cfg80211_cqm_config {
292 struct rcu_head rcu_head;
293 u32 rssi_hyst;
294 s32 last_rssi_event_value;
295 enum nl80211_cqm_rssi_threshold_event last_rssi_event_type;
296 bool use_range_api;
297 int n_rssi_thresholds;
298 s32 rssi_thresholds[] __counted_by(n_rssi_thresholds);
299};
300
301void cfg80211_cqm_rssi_notify_work(struct wiphy *wiphy,
302 struct wiphy_work *work);
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);
329void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
330 struct ieee80211_channel *channel);
331int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
332 struct wireless_dev *wdev);
333
334/* mesh */
335extern const struct mesh_config default_mesh_config;
336extern const struct mesh_setup default_mesh_setup;
337int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
338 struct net_device *dev,
339 struct mesh_setup *setup,
340 const struct mesh_config *conf);
341int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
342 struct net_device *dev);
343int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
344 struct wireless_dev *wdev,
345 struct cfg80211_chan_def *chandef);
346
347/* OCB */
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);
353
354/* AP */
355int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
356 struct net_device *dev, int link,
357 bool notify);
358
359/* MLME */
360int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
361 struct net_device *dev,
362 struct cfg80211_auth_request *req);
363int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
364 struct net_device *dev,
365 struct cfg80211_assoc_request *req);
366int cfg80211_mlme_deauth(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);
370int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
371 struct net_device *dev, const u8 *ap_addr,
372 const u8 *ie, int ie_len, u16 reason,
373 bool local_state_change);
374void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
375 struct net_device *dev);
376int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
377 u16 frame_type, const u8 *match_data,
378 int match_len, bool multicast_rx,
379 struct netlink_ext_ack *extack);
380void cfg80211_mgmt_registrations_update_wk(struct work_struct *wk);
381void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
382void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
383int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
384 struct wireless_dev *wdev,
385 struct cfg80211_mgmt_tx_params *params,
386 u64 *cookie);
387void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
388 const struct ieee80211_ht_cap *ht_capa_mask);
389void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
390 const struct ieee80211_vht_cap *vht_capa_mask);
391
392/* SME events */
393int cfg80211_connect(struct cfg80211_registered_device *rdev,
394 struct net_device *dev,
395 struct cfg80211_connect_params *connect,
396 struct cfg80211_cached_keys *connkeys,
397 const u8 *prev_bssid);
398void __cfg80211_connect_result(struct net_device *dev,
399 struct cfg80211_connect_resp_params *params,
400 bool wextev);
401void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
402 size_t ie_len, u16 reason, bool from_ap);
403int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
404 struct net_device *dev, u16 reason,
405 bool wextev);
406void __cfg80211_roamed(struct wireless_dev *wdev,
407 struct cfg80211_roam_info *info);
408void __cfg80211_port_authorized(struct wireless_dev *wdev, const u8 *peer_addr,
409 const u8 *td_bitmap, u8 td_bitmap_len);
410int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
411 struct wireless_dev *wdev);
412void cfg80211_autodisconnect_wk(struct work_struct *work);
413
414/* SME implementation */
415void cfg80211_conn_work(struct work_struct *work);
416void cfg80211_sme_scan_done(struct net_device *dev);
417bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
418void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
419void cfg80211_sme_disassoc(struct wireless_dev *wdev);
420void cfg80211_sme_deauth(struct wireless_dev *wdev);
421void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
422void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
423void cfg80211_sme_abandon_assoc(struct wireless_dev *wdev);
424
425/* internal helpers */
426bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
427bool cfg80211_valid_key_idx(struct cfg80211_registered_device *rdev,
428 int key_idx, bool pairwise);
429int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
430 struct key_params *params, int key_idx,
431 bool pairwise, const u8 *mac_addr);
432void __cfg80211_scan_done(struct wiphy *wiphy, struct wiphy_work *wk);
433void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
434 bool send_message);
435void cfg80211_add_sched_scan_req(struct cfg80211_registered_device *rdev,
436 struct cfg80211_sched_scan_request *req);
437int cfg80211_sched_scan_req_possible(struct cfg80211_registered_device *rdev,
438 bool want_multi);
439void cfg80211_sched_scan_results_wk(struct work_struct *work);
440int cfg80211_stop_sched_scan_req(struct cfg80211_registered_device *rdev,
441 struct cfg80211_sched_scan_request *req,
442 bool driver_initiated);
443int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
444 u64 reqid, bool driver_initiated);
445void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
446int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
447 struct net_device *dev, enum nl80211_iftype ntype,
448 struct vif_params *params);
449void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
450void cfg80211_process_wiphy_works(struct cfg80211_registered_device *rdev,
451 struct wiphy_work *end);
452void cfg80211_process_wdev_events(struct wireless_dev *wdev);
453
454bool cfg80211_does_bw_fit_range(const struct ieee80211_freq_range *freq_range,
455 u32 center_freq_khz, u32 bw_khz);
456
457int cfg80211_scan(struct cfg80211_registered_device *rdev);
458
459extern struct work_struct cfg80211_disconnect_work;
460
461void cfg80211_set_dfs_state(struct wiphy *wiphy,
462 const struct cfg80211_chan_def *chandef,
463 enum nl80211_dfs_state dfs_state);
464
465void cfg80211_dfs_channels_update_work(struct work_struct *work);
466
467void cfg80211_sched_dfs_chan_update(struct cfg80211_registered_device *rdev);
468
469int
470cfg80211_start_background_radar_detection(struct cfg80211_registered_device *rdev,
471 struct wireless_dev *wdev,
472 struct cfg80211_chan_def *chandef);
473
474void cfg80211_stop_background_radar_detection(struct wireless_dev *wdev);
475
476void cfg80211_background_cac_done_wk(struct work_struct *work);
477
478void cfg80211_background_cac_abort_wk(struct work_struct *work);
479
480bool cfg80211_any_wiphy_oper_chan(struct wiphy *wiphy,
481 struct ieee80211_channel *chan);
482
483bool cfg80211_beaconing_iface_active(struct wireless_dev *wdev);
484
485bool cfg80211_is_sub_chan(struct cfg80211_chan_def *chandef,
486 struct ieee80211_channel *chan,
487 bool primary_only);
488bool cfg80211_wdev_on_sub_chan(struct wireless_dev *wdev,
489 struct ieee80211_channel *chan,
490 bool primary_only);
491
492static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
493{
494 unsigned long end = jiffies;
495
496 if (end >= start)
497 return jiffies_to_msecs(end - start);
498
499 return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
500}
501
502int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
503 struct cfg80211_chan_def *chandef);
504
505int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
506 const u8 *rates, unsigned int n_rates,
507 u32 *mask);
508
509int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
510 enum nl80211_iftype iftype, u32 beacon_int);
511
512void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
513 enum nl80211_iftype iftype, int num);
514
515void cfg80211_leave(struct cfg80211_registered_device *rdev,
516 struct wireless_dev *wdev);
517
518void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
519 struct wireless_dev *wdev);
520
521void cfg80211_stop_nan(struct cfg80211_registered_device *rdev,
522 struct wireless_dev *wdev);
523
524struct cfg80211_internal_bss *
525cfg80211_bss_update(struct cfg80211_registered_device *rdev,
526 struct cfg80211_internal_bss *tmp,
527 bool signal_valid, unsigned long ts);
528#ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
529#define CFG80211_DEV_WARN_ON(cond) WARN_ON(cond)
530#else
531/*
532 * Trick to enable using it as a condition,
533 * and also not give a warning when it's
534 * not used that way.
535 */
536#define CFG80211_DEV_WARN_ON(cond) ({bool __r = (cond); __r; })
537#endif
538
539void cfg80211_release_pmsr(struct wireless_dev *wdev, u32 portid);
540void cfg80211_pmsr_wdev_down(struct wireless_dev *wdev);
541void cfg80211_pmsr_free_wk(struct work_struct *work);
542
543void cfg80211_remove_link(struct wireless_dev *wdev, unsigned int link_id);
544void cfg80211_remove_links(struct wireless_dev *wdev);
545int cfg80211_remove_virtual_intf(struct cfg80211_registered_device *rdev,
546 struct wireless_dev *wdev);
547void cfg80211_wdev_release_link_bsses(struct wireless_dev *wdev, u16 link_mask);
548
549#endif /* __NET_WIRELESS_CORE_H */