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-2019 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 rfkill *rfkill;
31 struct work_struct rfkill_sync;
33 /* ISO / IEC 3166 alpha2 for which this device is receiving
34 * country IEs on, this can help disregard country IEs from APs
35 * on the same alpha2 quickly. The alpha2 may differ from
36 * cfg80211_regdomain's alpha2 when an intersection has occurred.
37 * If the AP is reconfigured this can also be used to tell us if
38 * the country on the country IE changed. */
39 char country_ie_alpha2[2];
42 * the driver requests the regulatory core to set this regulatory
43 * domain as the wiphy's. Only used for %REGULATORY_WIPHY_SELF_MANAGED
44 * devices using the regulatory_set_wiphy_regd() API
46 const struct ieee80211_regdomain *requested_regd;
48 /* If a Country IE has been received this tells us the environment
49 * which its telling us its in. This defaults to ENVIRON_ANY */
50 enum environment_cap env;
52 /* wiphy index, internal only */
55 /* protected by RTNL */
56 int devlist_generation, wdev_id;
58 wait_queue_head_t dev_wait;
60 struct list_head beacon_registrations;
61 spinlock_t beacon_registrations_lock;
63 struct list_head mlme_unreg;
64 spinlock_t mlme_unreg_lock;
65 struct work_struct mlme_unreg_wk;
67 /* protected by RTNL only */
68 int num_running_ifaces;
69 int num_running_monitor_ifaces;
74 struct list_head bss_list;
75 struct rb_root bss_tree;
78 struct cfg80211_scan_request *scan_req; /* protected by RTNL */
79 struct sk_buff *scan_msg;
80 struct list_head sched_scan_req_list;
82 struct work_struct scan_done_wk;
84 struct genl_info *cur_cmd_info;
86 struct work_struct conn_work;
87 struct work_struct event_work;
89 struct delayed_work dfs_update_channels_wk;
91 /* netlink port which started critical protocol (0 means not started) */
92 u32 crit_proto_nlportid;
94 struct cfg80211_coalesce *coalesce;
96 struct work_struct destroy_work;
97 struct work_struct sched_scan_stop_wk;
98 struct work_struct sched_scan_res_wk;
100 struct cfg80211_chan_def radar_chandef;
101 struct work_struct propagate_radar_detect_wk;
103 struct cfg80211_chan_def cac_done_chandef;
104 struct work_struct propagate_cac_done_wk;
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);
112 struct cfg80211_registered_device *wiphy_to_rdev(struct wiphy *wiphy)
115 return container_of(wiphy, struct cfg80211_registered_device, wiphy);
119 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
124 if (!rdev->wiphy.wowlan_config)
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);
138 static inline u64 cfg80211_assign_cookie(struct cfg80211_registered_device *rdev)
140 u64 r = ++rdev->cookie_counter;
143 r = ++rdev->cookie_counter;
148 extern struct workqueue_struct *cfg80211_wq;
149 extern struct list_head cfg80211_rdev_list;
150 extern int cfg80211_rdev_list_generation;
152 struct cfg80211_internal_bss {
153 struct list_head list;
154 struct list_head hidden_list;
155 struct list_head nontrans_list;
159 unsigned long refcount;
162 /* time at the start of the reception of the first octet of the
163 * timestamp field of the last beacon/probe received for this BSS.
164 * The time is the TSF of the BSS specified by %parent_bssid.
168 /* the BSS according to which %parent_tsf is set. This is set to
169 * the BSS that the interface that requested the scan was connected to
170 * when the beacon/probe was received.
172 u8 parent_bssid[ETH_ALEN] __aligned(2);
174 /* must be last because of priv member */
175 struct cfg80211_bss pub;
178 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
180 return container_of(pub, struct cfg80211_internal_bss, pub);
183 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
185 atomic_inc(&bss->hold);
188 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
190 int r = atomic_dec_return(&bss->hold);
195 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
196 int get_wiphy_idx(struct wiphy *wiphy);
198 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
200 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
203 void cfg80211_init_wdev(struct cfg80211_registered_device *rdev,
204 struct wireless_dev *wdev);
206 static inline void wdev_lock(struct wireless_dev *wdev)
209 mutex_lock(&wdev->mtx);
210 __acquire(wdev->mtx);
213 static inline void wdev_unlock(struct wireless_dev *wdev)
216 __release(wdev->mtx);
217 mutex_unlock(&wdev->mtx);
220 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
222 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
226 return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
227 rdev->num_running_ifaces > 0;
230 enum cfg80211_event_type {
231 EVENT_CONNECT_RESULT,
236 EVENT_PORT_AUTHORIZED,
239 struct cfg80211_event {
240 struct list_head list;
241 enum cfg80211_event_type type;
244 struct cfg80211_connect_resp_params cr;
245 struct cfg80211_roam_info rm;
250 bool locally_generated;
254 struct ieee80211_channel *channel;
262 struct cfg80211_cached_keys {
263 struct key_params params[CFG80211_MAX_WEP_KEYS];
264 u8 data[CFG80211_MAX_WEP_KEYS][WLAN_KEY_LEN_WEP104];
268 enum cfg80211_chan_mode {
274 struct cfg80211_beacon_registration {
275 struct list_head list;
279 struct cfg80211_cqm_config {
281 s32 last_rssi_event_value;
282 int n_rssi_thresholds;
283 s32 rssi_thresholds[0];
286 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
289 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
291 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
294 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
296 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
297 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
298 unsigned long age_secs);
301 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
302 struct net_device *dev,
303 struct cfg80211_ibss_params *params,
304 struct cfg80211_cached_keys *connkeys);
305 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
306 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
307 struct net_device *dev, bool nowext);
308 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
309 struct net_device *dev, bool nowext);
310 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
311 struct ieee80211_channel *channel);
312 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
313 struct wireless_dev *wdev);
316 extern const struct mesh_config default_mesh_config;
317 extern const struct mesh_setup default_mesh_setup;
318 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
319 struct net_device *dev,
320 struct mesh_setup *setup,
321 const struct mesh_config *conf);
322 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
323 struct net_device *dev);
324 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
325 struct net_device *dev);
326 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
327 struct wireless_dev *wdev,
328 struct cfg80211_chan_def *chandef);
331 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
332 struct net_device *dev,
333 struct ocb_setup *setup);
334 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
335 struct net_device *dev,
336 struct ocb_setup *setup);
337 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
338 struct net_device *dev);
339 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
340 struct net_device *dev);
343 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
344 struct net_device *dev, bool notify);
345 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
346 struct net_device *dev, bool notify);
349 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
350 struct net_device *dev,
351 struct ieee80211_channel *chan,
352 enum nl80211_auth_type auth_type,
354 const u8 *ssid, int ssid_len,
355 const u8 *ie, int ie_len,
356 const u8 *key, int key_len, int key_idx,
357 const u8 *auth_data, int auth_data_len);
358 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
359 struct net_device *dev,
360 struct ieee80211_channel *chan,
362 const u8 *ssid, int ssid_len,
363 struct cfg80211_assoc_request *req);
364 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
365 struct net_device *dev, const u8 *bssid,
366 const u8 *ie, int ie_len, u16 reason,
367 bool local_state_change);
368 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
369 struct net_device *dev, const u8 *bssid,
370 const u8 *ie, int ie_len, u16 reason,
371 bool local_state_change);
372 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
373 struct net_device *dev);
374 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
375 u16 frame_type, const u8 *match_data,
377 void cfg80211_mlme_unreg_wk(struct work_struct *wk);
378 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
379 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
380 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
381 struct wireless_dev *wdev,
382 struct cfg80211_mgmt_tx_params *params,
384 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
385 const struct ieee80211_ht_cap *ht_capa_mask);
386 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
387 const struct ieee80211_vht_cap *vht_capa_mask);
390 int cfg80211_connect(struct cfg80211_registered_device *rdev,
391 struct net_device *dev,
392 struct cfg80211_connect_params *connect,
393 struct cfg80211_cached_keys *connkeys,
394 const u8 *prev_bssid);
395 void __cfg80211_connect_result(struct net_device *dev,
396 struct cfg80211_connect_resp_params *params,
398 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
399 size_t ie_len, u16 reason, bool from_ap);
400 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
401 struct net_device *dev, u16 reason,
403 void __cfg80211_roamed(struct wireless_dev *wdev,
404 struct cfg80211_roam_info *info);
405 void __cfg80211_port_authorized(struct wireless_dev *wdev, const u8 *bssid);
406 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
407 struct wireless_dev *wdev);
408 void cfg80211_autodisconnect_wk(struct work_struct *work);
410 /* SME implementation */
411 void cfg80211_conn_work(struct work_struct *work);
412 void cfg80211_sme_scan_done(struct net_device *dev);
413 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
414 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
415 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
416 void cfg80211_sme_deauth(struct wireless_dev *wdev);
417 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
418 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
419 void cfg80211_sme_abandon_assoc(struct wireless_dev *wdev);
421 /* internal helpers */
422 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
423 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
424 struct key_params *params, int key_idx,
425 bool pairwise, const u8 *mac_addr);
426 void __cfg80211_scan_done(struct work_struct *wk);
427 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
429 void cfg80211_add_sched_scan_req(struct cfg80211_registered_device *rdev,
430 struct cfg80211_sched_scan_request *req);
431 int cfg80211_sched_scan_req_possible(struct cfg80211_registered_device *rdev,
433 void cfg80211_sched_scan_results_wk(struct work_struct *work);
434 int cfg80211_stop_sched_scan_req(struct cfg80211_registered_device *rdev,
435 struct cfg80211_sched_scan_request *req,
436 bool driver_initiated);
437 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
438 u64 reqid, bool driver_initiated);
439 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
440 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
441 struct net_device *dev, enum nl80211_iftype ntype,
442 struct vif_params *params);
443 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
444 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
446 bool cfg80211_does_bw_fit_range(const struct ieee80211_freq_range *freq_range,
447 u32 center_freq_khz, u32 bw_khz);
450 * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable
451 * @wiphy: the wiphy to validate against
452 * @chandef: the channel definition to check
454 * Checks if chandef is usable and we can/need start CAC on such channel.
456 * Return: Return true if all channels available and at least
457 * one channel require CAC (NL80211_DFS_USABLE)
459 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
460 const struct cfg80211_chan_def *chandef);
462 void cfg80211_set_dfs_state(struct wiphy *wiphy,
463 const struct cfg80211_chan_def *chandef,
464 enum nl80211_dfs_state dfs_state);
466 void cfg80211_dfs_channels_update_work(struct work_struct *work);
469 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
470 const struct cfg80211_chan_def *chandef);
472 void cfg80211_sched_dfs_chan_update(struct cfg80211_registered_device *rdev);
474 bool cfg80211_any_wiphy_oper_chan(struct wiphy *wiphy,
475 struct ieee80211_channel *chan);
477 bool cfg80211_beaconing_iface_active(struct wireless_dev *wdev);
479 bool cfg80211_is_sub_chan(struct cfg80211_chan_def *chandef,
480 struct ieee80211_channel *chan);
482 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
484 unsigned long end = jiffies;
487 return jiffies_to_msecs(end - start);
489 return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
493 cfg80211_get_chan_state(struct wireless_dev *wdev,
494 struct ieee80211_channel **chan,
495 enum cfg80211_chan_mode *chanmode,
498 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
499 struct cfg80211_chan_def *chandef);
501 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
502 const u8 *rates, unsigned int n_rates,
505 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
506 enum nl80211_iftype iftype, u32 beacon_int);
508 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
509 enum nl80211_iftype iftype, int num);
511 void __cfg80211_leave(struct cfg80211_registered_device *rdev,
512 struct wireless_dev *wdev);
513 void cfg80211_leave(struct cfg80211_registered_device *rdev,
514 struct wireless_dev *wdev);
516 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
517 struct wireless_dev *wdev);
519 void cfg80211_stop_nan(struct cfg80211_registered_device *rdev,
520 struct wireless_dev *wdev);
522 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
523 #define CFG80211_DEV_WARN_ON(cond) WARN_ON(cond)
526 * Trick to enable using it as a condition,
527 * and also not give a warning when it's
530 #define CFG80211_DEV_WARN_ON(cond) ({bool __r = (cond); __r; })
533 void cfg80211_cqm_config_free(struct wireless_dev *wdev);
535 void cfg80211_release_pmsr(struct wireless_dev *wdev, u32 portid);
536 void cfg80211_pmsr_wdev_down(struct wireless_dev *wdev);
537 void cfg80211_pmsr_free_wk(struct work_struct *work);
539 #endif /* __NET_WIRELESS_CORE_H */