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