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