1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Wireless configuration interface internals.
5 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
6 * Copyright (C) 2018-2024 Intel Corporation
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>
22 #define WIPHY_IDX_INVALID -1
24 struct cfg80211_registered_device {
25 const struct cfg80211_ops *ops;
26 struct list_head list;
29 struct rfkill_ops rfkill_ops;
30 struct work_struct rfkill_block;
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];
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
45 const struct ieee80211_regdomain *requested_regd;
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;
51 /* wiphy index, internal only */
54 /* protected by RTNL */
55 int devlist_generation, wdev_id;
57 wait_queue_head_t dev_wait;
59 struct list_head beacon_registrations;
60 spinlock_t beacon_registrations_lock;
62 /* protected by RTNL only */
63 int num_running_ifaces;
64 int num_running_monitor_ifaces;
69 struct list_head bss_list;
70 struct rb_root bss_tree;
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;
78 struct wiphy_work scan_done_wk;
80 struct genl_info *cur_cmd_info;
82 struct work_struct conn_work;
83 struct work_struct event_work;
85 struct delayed_work dfs_update_channels_wk;
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;
92 /* netlink port which started critical protocol (0 means not started) */
93 u32 crit_proto_nlportid;
95 struct cfg80211_coalesce *coalesce;
97 struct work_struct destroy_work;
98 struct wiphy_work sched_scan_stop_wk;
99 struct work_struct sched_scan_res_wk;
101 struct cfg80211_chan_def radar_chandef;
102 struct work_struct propagate_radar_detect_wk;
104 struct cfg80211_chan_def cac_done_chandef;
105 struct work_struct propagate_cac_done_wk;
107 struct work_struct mgmt_registrations_update_wk;
108 /* lock for all wdev lists */
109 spinlock_t mgmt_registrations_lock;
111 struct work_struct wiphy_work;
112 struct list_head wiphy_work_list;
113 /* protects the list above */
114 spinlock_t wiphy_work_lock;
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);
123 struct cfg80211_registered_device *wiphy_to_rdev(struct wiphy *wiphy)
126 return container_of(wiphy, struct cfg80211_registered_device, wiphy);
130 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
135 if (!rdev->wiphy.wowlan_config)
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);
149 static inline u64 cfg80211_assign_cookie(struct cfg80211_registered_device *rdev)
151 u64 r = ++rdev->cookie_counter;
154 r = ++rdev->cookie_counter;
159 extern struct workqueue_struct *cfg80211_wq;
160 extern struct list_head cfg80211_rdev_list;
161 extern int cfg80211_rdev_list_generation;
163 /* This is constructed like this so it can be used in if/else */
164 static inline int for_each_rdev_check_rtnl(void)
169 #define for_each_rdev(rdev) \
170 if (for_each_rdev_check_rtnl()) {} else \
171 list_for_each_entry(rdev, &cfg80211_rdev_list, list)
173 struct cfg80211_internal_bss {
174 struct list_head list;
175 struct list_head hidden_list;
179 unsigned long refcount;
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.
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.
192 u8 parent_bssid[ETH_ALEN] __aligned(2);
194 /* must be last because of priv member */
195 struct cfg80211_bss pub;
198 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
200 return container_of(pub, struct cfg80211_internal_bss, pub);
203 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
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);
213 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
215 int r = atomic_dec_return(&bss->hold);
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);
226 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
227 int get_wiphy_idx(struct wiphy *wiphy);
229 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
231 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
234 void cfg80211_init_wdev(struct wireless_dev *wdev);
235 void cfg80211_register_wdev(struct cfg80211_registered_device *rdev,
236 struct wireless_dev *wdev);
238 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
240 lockdep_assert_held(&rdev->wiphy.mtx);
242 return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
243 rdev->num_running_ifaces > 0;
246 enum cfg80211_event_type {
247 EVENT_CONNECT_RESULT,
252 EVENT_PORT_AUTHORIZED,
255 struct cfg80211_event {
256 struct list_head list;
257 enum cfg80211_event_type type;
260 struct cfg80211_connect_resp_params cr;
261 struct cfg80211_roam_info rm;
266 bool locally_generated;
270 struct ieee80211_channel *channel;
273 u8 peer_addr[ETH_ALEN];
280 struct cfg80211_cached_keys {
281 struct key_params params[4];
282 u8 data[4][WLAN_KEY_LEN_WEP104];
286 struct cfg80211_beacon_registration {
287 struct list_head list;
291 struct cfg80211_cqm_config {
292 struct rcu_head rcu_head;
294 s32 last_rssi_event_value;
295 enum nl80211_cqm_rssi_threshold_event last_rssi_event_type;
297 int n_rssi_thresholds;
298 s32 rssi_thresholds[] __counted_by(n_rssi_thresholds);
301 void cfg80211_cqm_rssi_notify_work(struct wiphy *wiphy,
302 struct wiphy_work *work);
304 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
307 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
309 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
312 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
314 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
315 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
316 unsigned long age_secs);
317 void cfg80211_update_assoc_bss_entry(struct wireless_dev *wdev,
319 struct ieee80211_channel *channel);
322 int __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);
326 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
327 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
328 struct net_device *dev, bool nowext);
329 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
330 struct ieee80211_channel *channel);
331 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
332 struct wireless_dev *wdev);
335 extern const struct mesh_config default_mesh_config;
336 extern const struct mesh_setup default_mesh_setup;
337 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
338 struct net_device *dev,
339 struct mesh_setup *setup,
340 const struct mesh_config *conf);
341 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
342 struct net_device *dev);
343 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
344 struct wireless_dev *wdev,
345 struct cfg80211_chan_def *chandef);
348 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
349 struct net_device *dev,
350 struct ocb_setup *setup);
351 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
352 struct net_device *dev);
355 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
356 struct net_device *dev, int link,
360 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
361 struct net_device *dev,
362 struct cfg80211_auth_request *req);
363 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
364 struct net_device *dev,
365 struct cfg80211_assoc_request *req,
366 struct netlink_ext_ack *extack);
367 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
368 struct net_device *dev, const u8 *bssid,
369 const u8 *ie, int ie_len, u16 reason,
370 bool local_state_change);
371 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
372 struct net_device *dev, const u8 *ap_addr,
373 const u8 *ie, int ie_len, u16 reason,
374 bool local_state_change);
375 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
376 struct net_device *dev);
377 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
378 u16 frame_type, const u8 *match_data,
379 int match_len, bool multicast_rx,
380 struct netlink_ext_ack *extack);
381 void cfg80211_mgmt_registrations_update_wk(struct work_struct *wk);
382 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
383 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
384 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
385 struct wireless_dev *wdev,
386 struct cfg80211_mgmt_tx_params *params,
388 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
389 const struct ieee80211_ht_cap *ht_capa_mask);
390 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
391 const struct ieee80211_vht_cap *vht_capa_mask);
394 int cfg80211_connect(struct cfg80211_registered_device *rdev,
395 struct net_device *dev,
396 struct cfg80211_connect_params *connect,
397 struct cfg80211_cached_keys *connkeys,
398 const u8 *prev_bssid);
399 void __cfg80211_connect_result(struct net_device *dev,
400 struct cfg80211_connect_resp_params *params,
402 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
403 size_t ie_len, u16 reason, bool from_ap);
404 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
405 struct net_device *dev, u16 reason,
407 void __cfg80211_roamed(struct wireless_dev *wdev,
408 struct cfg80211_roam_info *info);
409 void __cfg80211_port_authorized(struct wireless_dev *wdev, const u8 *peer_addr,
410 const u8 *td_bitmap, u8 td_bitmap_len);
411 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
412 struct wireless_dev *wdev);
413 void cfg80211_autodisconnect_wk(struct work_struct *work);
415 /* SME implementation */
416 void cfg80211_conn_work(struct work_struct *work);
417 void cfg80211_sme_scan_done(struct net_device *dev);
418 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
419 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
420 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
421 void cfg80211_sme_deauth(struct wireless_dev *wdev);
422 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
423 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
424 void cfg80211_sme_abandon_assoc(struct wireless_dev *wdev);
426 /* internal helpers */
427 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
428 bool cfg80211_valid_key_idx(struct cfg80211_registered_device *rdev,
429 int key_idx, bool pairwise);
430 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
431 struct key_params *params, int key_idx,
432 bool pairwise, const u8 *mac_addr);
433 void __cfg80211_scan_done(struct wiphy *wiphy, struct wiphy_work *wk);
434 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
436 void cfg80211_add_sched_scan_req(struct cfg80211_registered_device *rdev,
437 struct cfg80211_sched_scan_request *req);
438 int cfg80211_sched_scan_req_possible(struct cfg80211_registered_device *rdev,
440 void cfg80211_sched_scan_results_wk(struct work_struct *work);
441 int cfg80211_stop_sched_scan_req(struct cfg80211_registered_device *rdev,
442 struct cfg80211_sched_scan_request *req,
443 bool driver_initiated);
444 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
445 u64 reqid, bool driver_initiated);
446 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
447 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
448 struct net_device *dev, enum nl80211_iftype ntype,
449 struct vif_params *params);
450 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
451 void cfg80211_process_wiphy_works(struct cfg80211_registered_device *rdev,
452 struct wiphy_work *end);
453 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
455 bool cfg80211_does_bw_fit_range(const struct ieee80211_freq_range *freq_range,
456 u32 center_freq_khz, u32 bw_khz);
458 int cfg80211_scan(struct cfg80211_registered_device *rdev);
460 extern struct work_struct cfg80211_disconnect_work;
462 #define NL80211_BSS_USE_FOR_ALL (NL80211_BSS_USE_FOR_NORMAL | \
463 NL80211_BSS_USE_FOR_MLD_LINK)
465 void cfg80211_set_dfs_state(struct wiphy *wiphy,
466 const struct cfg80211_chan_def *chandef,
467 enum nl80211_dfs_state dfs_state);
469 void cfg80211_dfs_channels_update_work(struct work_struct *work);
471 void cfg80211_sched_dfs_chan_update(struct cfg80211_registered_device *rdev);
474 cfg80211_start_background_radar_detection(struct cfg80211_registered_device *rdev,
475 struct wireless_dev *wdev,
476 struct cfg80211_chan_def *chandef);
478 void cfg80211_stop_background_radar_detection(struct wireless_dev *wdev);
480 void cfg80211_background_cac_done_wk(struct work_struct *work);
482 void cfg80211_background_cac_abort_wk(struct work_struct *work);
484 bool cfg80211_any_wiphy_oper_chan(struct wiphy *wiphy,
485 struct ieee80211_channel *chan);
487 bool cfg80211_beaconing_iface_active(struct wireless_dev *wdev);
489 bool cfg80211_is_sub_chan(struct cfg80211_chan_def *chandef,
490 struct ieee80211_channel *chan,
492 bool cfg80211_wdev_on_sub_chan(struct wireless_dev *wdev,
493 struct ieee80211_channel *chan,
495 bool _cfg80211_chandef_usable(struct wiphy *wiphy,
496 const struct cfg80211_chan_def *chandef,
497 u32 prohibited_flags, bool monitor);
499 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
501 unsigned long end = jiffies;
504 return jiffies_to_msecs(end - start);
506 return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
509 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
510 struct cfg80211_chan_def *chandef);
512 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
513 const u8 *rates, unsigned int n_rates,
516 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
517 enum nl80211_iftype iftype, u32 beacon_int);
519 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
520 enum nl80211_iftype iftype, int num);
522 void cfg80211_leave(struct cfg80211_registered_device *rdev,
523 struct wireless_dev *wdev);
525 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
526 struct wireless_dev *wdev);
528 void cfg80211_stop_nan(struct cfg80211_registered_device *rdev,
529 struct wireless_dev *wdev);
531 struct cfg80211_internal_bss *
532 cfg80211_bss_update(struct cfg80211_registered_device *rdev,
533 struct cfg80211_internal_bss *tmp,
534 bool signal_valid, unsigned long ts);
535 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
536 #define CFG80211_DEV_WARN_ON(cond) WARN_ON(cond)
539 * Trick to enable using it as a condition,
540 * and also not give a warning when it's
543 #define CFG80211_DEV_WARN_ON(cond) ({bool __r = (cond); __r; })
546 void cfg80211_release_pmsr(struct wireless_dev *wdev, u32 portid);
547 void cfg80211_pmsr_wdev_down(struct wireless_dev *wdev);
548 void cfg80211_pmsr_free_wk(struct work_struct *work);
550 void cfg80211_remove_link(struct wireless_dev *wdev, unsigned int link_id);
551 void cfg80211_remove_links(struct wireless_dev *wdev);
552 int cfg80211_remove_virtual_intf(struct cfg80211_registered_device *rdev,
553 struct wireless_dev *wdev);
554 void cfg80211_wdev_release_link_bsses(struct wireless_dev *wdev, u16 link_mask);
557 * struct cfg80211_colocated_ap - colocated AP information
559 * @list: linked list to all colocated APs
560 * @bssid: BSSID of the reported AP
561 * @ssid: SSID of the reported AP
562 * @ssid_len: length of the ssid
563 * @center_freq: frequency the reported AP is on
564 * @unsolicited_probe: the reported AP is part of an ESS, where all the APs
565 * that operate in the same channel as the reported AP and that might be
566 * detected by a STA receiving this frame, are transmitting unsolicited
567 * Probe Response frames every 20 TUs
568 * @oct_recommended: OCT is recommended to exchange MMPDUs with the reported AP
569 * @same_ssid: the reported AP has the same SSID as the reporting AP
570 * @multi_bss: the reported AP is part of a multiple BSSID set
571 * @transmitted_bssid: the reported AP is the transmitting BSSID
572 * @colocated_ess: all the APs that share the same ESS as the reported AP are
573 * colocated and can be discovered via legacy bands.
574 * @short_ssid_valid: short_ssid is valid and can be used
575 * @short_ssid: the short SSID for this SSID
576 * @psd_20: The 20MHz PSD EIRP of the primary 20MHz channel for the reported AP
578 struct cfg80211_colocated_ap {
579 struct list_head list;
581 u8 ssid[IEEE80211_MAX_SSID_LEN];
585 u8 unsolicited_probe:1,
595 #if IS_ENABLED(CONFIG_CFG80211_KUNIT_TEST)
596 #define EXPORT_SYMBOL_IF_CFG80211_KUNIT(sym) EXPORT_SYMBOL_IF_KUNIT(sym)
597 #define VISIBLE_IF_CFG80211_KUNIT
598 void cfg80211_free_coloc_ap_list(struct list_head *coloc_ap_list);
600 int cfg80211_parse_colocated_ap(const struct cfg80211_bss_ies *ies,
601 struct list_head *list);
603 size_t cfg80211_gen_new_ie(const u8 *ie, size_t ielen,
604 const u8 *subie, size_t subie_len,
605 u8 *new_ie, size_t new_ie_len);
607 #define EXPORT_SYMBOL_IF_CFG80211_KUNIT(sym)
608 #define VISIBLE_IF_CFG80211_KUNIT static
609 #endif /* IS_ENABLED(CONFIG_CFG80211_KUNIT_TEST) */
611 #endif /* __NET_WIRELESS_CORE_H */