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