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-2019 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 struct list_head mlme_unreg;
64 spinlock_t mlme_unreg_lock;
65 struct work_struct mlme_unreg_wk;
66
67 /* protected by RTNL only */
68 int num_running_ifaces;
69 int num_running_monitor_ifaces;
70 u64 cookie_counter;
71
72 /* BSSes/scanning */
73 spinlock_t bss_lock;
74 struct list_head bss_list;
75 struct rb_root bss_tree;
76 u32 bss_generation;
77 u32 bss_entries;
78 struct cfg80211_scan_request *scan_req; /* protected by RTNL */
79 struct sk_buff *scan_msg;
80 struct list_head sched_scan_req_list;
81 time64_t suspend_at;
82 struct work_struct scan_done_wk;
83
84 struct genl_info *cur_cmd_info;
85
86 struct work_struct conn_work;
87 struct work_struct event_work;
88
89 struct delayed_work dfs_update_channels_wk;
90
91 /* netlink port which started critical protocol (0 means not started) */
92 u32 crit_proto_nlportid;
93
94 struct cfg80211_coalesce *coalesce;
95
96 struct work_struct destroy_work;
97 struct work_struct sched_scan_stop_wk;
98 struct work_struct sched_scan_res_wk;
99
100 struct cfg80211_chan_def radar_chandef;
101 struct work_struct propagate_radar_detect_wk;
102
103 struct cfg80211_chan_def cac_done_chandef;
104 struct work_struct propagate_cac_done_wk;
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
111 static inline
wiphy_to_rdev(struct wiphy * wiphy)112 struct 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
118 static inline void
cfg80211_rdev_free_wowlan(struct cfg80211_registered_device * rdev)119 cfg80211_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
cfg80211_assign_cookie(struct cfg80211_registered_device * rdev)138 static 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
148 extern struct workqueue_struct *cfg80211_wq;
149 extern struct list_head cfg80211_rdev_list;
150 extern int cfg80211_rdev_list_generation;
151
152 struct 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
bss_from_pub(struct cfg80211_bss * pub)177 static 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
cfg80211_hold_bss(struct cfg80211_internal_bss * bss)182 static 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
cfg80211_unhold_bss(struct cfg80211_internal_bss * bss)192 static 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
205 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
206 int get_wiphy_idx(struct wiphy *wiphy);
207
208 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
209
210 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
211 struct net *net);
212
213 void cfg80211_init_wdev(struct wireless_dev *wdev);
214 void cfg80211_register_wdev(struct cfg80211_registered_device *rdev,
215 struct wireless_dev *wdev);
216
wdev_lock(struct wireless_dev * wdev)217 static inline void wdev_lock(struct wireless_dev *wdev)
218 __acquires(wdev)
219 {
220 mutex_lock(&wdev->mtx);
221 __acquire(wdev->mtx);
222 }
223
wdev_unlock(struct wireless_dev * wdev)224 static 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
cfg80211_has_monitors_only(struct cfg80211_registered_device * rdev)233 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
234 {
235 ASSERT_RTNL();
236
237 return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
238 rdev->num_running_ifaces > 0;
239 }
240
241 enum 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
250 struct 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
273 struct 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
279 enum cfg80211_chan_mode {
280 CHAN_MODE_UNDEFINED,
281 CHAN_MODE_SHARED,
282 CHAN_MODE_EXCLUSIVE,
283 };
284
285 struct cfg80211_beacon_registration {
286 struct list_head list;
287 u32 nlportid;
288 };
289
290 struct cfg80211_cqm_config {
291 u32 rssi_hyst;
292 s32 last_rssi_event_value;
293 int n_rssi_thresholds;
294 s32 rssi_thresholds[0];
295 };
296
297 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
298
299 /* free object */
300 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
301
302 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
303 char *newname);
304
305 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
306
307 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
308 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
309 unsigned long age_secs);
310 void cfg80211_update_assoc_bss_entry(struct wireless_dev *wdev,
311 struct ieee80211_channel *channel);
312
313 /* IBSS */
314 int __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);
318 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
319 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
320 struct net_device *dev, bool nowext);
321 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
322 struct net_device *dev, bool nowext);
323 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
324 struct ieee80211_channel *channel);
325 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
326 struct wireless_dev *wdev);
327
328 /* mesh */
329 extern const struct mesh_config default_mesh_config;
330 extern const struct mesh_setup default_mesh_setup;
331 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
332 struct net_device *dev,
333 struct mesh_setup *setup,
334 const struct mesh_config *conf);
335 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
336 struct net_device *dev);
337 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
338 struct net_device *dev);
339 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
340 struct wireless_dev *wdev,
341 struct cfg80211_chan_def *chandef);
342
343 /* OCB */
344 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
345 struct net_device *dev,
346 struct ocb_setup *setup);
347 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
348 struct net_device *dev,
349 struct ocb_setup *setup);
350 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
351 struct net_device *dev);
352 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
353 struct net_device *dev);
354
355 /* AP */
356 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
357 struct net_device *dev, bool notify);
358 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
359 struct net_device *dev, bool notify);
360
361 /* MLME */
362 int 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);
371 int 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);
377 int 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);
381 int 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);
385 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
386 struct net_device *dev);
387 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
388 u16 frame_type, const u8 *match_data,
389 int match_len);
390 void cfg80211_mlme_unreg_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 bool cfg80211_valid_key_idx(struct cfg80211_registered_device *rdev,
437 int key_idx, bool pairwise);
438 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
439 struct key_params *params, int key_idx,
440 bool pairwise, const u8 *mac_addr);
441 void __cfg80211_scan_done(struct work_struct *wk);
442 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
443 bool send_message);
444 void cfg80211_add_sched_scan_req(struct cfg80211_registered_device *rdev,
445 struct cfg80211_sched_scan_request *req);
446 int cfg80211_sched_scan_req_possible(struct cfg80211_registered_device *rdev,
447 bool want_multi);
448 void cfg80211_sched_scan_results_wk(struct work_struct *work);
449 int cfg80211_stop_sched_scan_req(struct cfg80211_registered_device *rdev,
450 struct cfg80211_sched_scan_request *req,
451 bool driver_initiated);
452 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
453 u64 reqid, bool driver_initiated);
454 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
455 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
456 struct net_device *dev, enum nl80211_iftype ntype,
457 struct vif_params *params);
458 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
459 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
460
461 bool cfg80211_does_bw_fit_range(const struct ieee80211_freq_range *freq_range,
462 u32 center_freq_khz, u32 bw_khz);
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: Return true if all channels available and at least
474 * one channel require 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