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