Merge tag 'kvmarm-fixes-5.10-2' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.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-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
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
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
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
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
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
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 cfg80211_registered_device *rdev,
213                         struct wireless_dev *wdev);
214
215 static inline void wdev_lock(struct wireless_dev *wdev)
216         __acquires(wdev)
217 {
218         mutex_lock(&wdev->mtx);
219         __acquire(wdev->mtx);
220 }
221
222 static inline void wdev_unlock(struct wireless_dev *wdev)
223         __releases(wdev)
224 {
225         __release(wdev->mtx);
226         mutex_unlock(&wdev->mtx);
227 }
228
229 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
230
231 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
232 {
233         ASSERT_RTNL();
234
235         return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
236                rdev->num_running_ifaces > 0;
237 }
238
239 enum cfg80211_event_type {
240         EVENT_CONNECT_RESULT,
241         EVENT_ROAMED,
242         EVENT_DISCONNECTED,
243         EVENT_IBSS_JOINED,
244         EVENT_STOPPED,
245         EVENT_PORT_AUTHORIZED,
246 };
247
248 struct cfg80211_event {
249         struct list_head list;
250         enum cfg80211_event_type type;
251
252         union {
253                 struct cfg80211_connect_resp_params cr;
254                 struct cfg80211_roam_info rm;
255                 struct {
256                         const u8 *ie;
257                         size_t ie_len;
258                         u16 reason;
259                         bool locally_generated;
260                 } dc;
261                 struct {
262                         u8 bssid[ETH_ALEN];
263                         struct ieee80211_channel *channel;
264                 } ij;
265                 struct {
266                         u8 bssid[ETH_ALEN];
267                 } pa;
268         };
269 };
270
271 struct cfg80211_cached_keys {
272         struct key_params params[CFG80211_MAX_WEP_KEYS];
273         u8 data[CFG80211_MAX_WEP_KEYS][WLAN_KEY_LEN_WEP104];
274         int def;
275 };
276
277 enum cfg80211_chan_mode {
278         CHAN_MODE_UNDEFINED,
279         CHAN_MODE_SHARED,
280         CHAN_MODE_EXCLUSIVE,
281 };
282
283 struct cfg80211_beacon_registration {
284         struct list_head list;
285         u32 nlportid;
286 };
287
288 struct cfg80211_cqm_config {
289         u32 rssi_hyst;
290         s32 last_rssi_event_value;
291         int n_rssi_thresholds;
292         s32 rssi_thresholds[];
293 };
294
295 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
296
297 /* free object */
298 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
299
300 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
301                         char *newname);
302
303 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
304
305 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
306 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
307                       unsigned long age_secs);
308 void cfg80211_update_assoc_bss_entry(struct wireless_dev *wdev,
309                                      struct ieee80211_channel *channel);
310
311 /* IBSS */
312 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
313                          struct net_device *dev,
314                          struct cfg80211_ibss_params *params,
315                          struct cfg80211_cached_keys *connkeys);
316 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
317 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
318                           struct net_device *dev, bool nowext);
319 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
320                         struct net_device *dev, bool nowext);
321 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
322                             struct ieee80211_channel *channel);
323 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
324                             struct wireless_dev *wdev);
325
326 /* mesh */
327 extern const struct mesh_config default_mesh_config;
328 extern const struct mesh_setup default_mesh_setup;
329 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
330                          struct net_device *dev,
331                          struct mesh_setup *setup,
332                          const struct mesh_config *conf);
333 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
334                           struct net_device *dev);
335 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
336                         struct net_device *dev);
337 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
338                               struct wireless_dev *wdev,
339                               struct cfg80211_chan_def *chandef);
340
341 /* OCB */
342 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
343                         struct net_device *dev,
344                         struct ocb_setup *setup);
345 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
346                       struct net_device *dev,
347                       struct ocb_setup *setup);
348 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
349                          struct net_device *dev);
350 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
351                        struct net_device *dev);
352
353 /* AP */
354 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
355                        struct net_device *dev, bool notify);
356 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
357                      struct net_device *dev, bool notify);
358
359 /* MLME */
360 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
361                        struct net_device *dev,
362                        struct ieee80211_channel *chan,
363                        enum nl80211_auth_type auth_type,
364                        const u8 *bssid,
365                        const u8 *ssid, int ssid_len,
366                        const u8 *ie, int ie_len,
367                        const u8 *key, int key_len, int key_idx,
368                        const u8 *auth_data, int auth_data_len);
369 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
370                         struct net_device *dev,
371                         struct ieee80211_channel *chan,
372                         const u8 *bssid,
373                         const u8 *ssid, int ssid_len,
374                         struct cfg80211_assoc_request *req);
375 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
376                          struct net_device *dev, const u8 *bssid,
377                          const u8 *ie, int ie_len, u16 reason,
378                          bool local_state_change);
379 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
380                            struct net_device *dev, const u8 *bssid,
381                            const u8 *ie, int ie_len, u16 reason,
382                            bool local_state_change);
383 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
384                         struct net_device *dev);
385 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
386                                 u16 frame_type, const u8 *match_data,
387                                 int match_len, bool multicast_rx,
388                                 struct netlink_ext_ack *extack);
389 void cfg80211_mgmt_registrations_update_wk(struct work_struct *wk);
390 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
391 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
392 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
393                           struct wireless_dev *wdev,
394                           struct cfg80211_mgmt_tx_params *params,
395                           u64 *cookie);
396 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
397                                const struct ieee80211_ht_cap *ht_capa_mask);
398 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
399                                 const struct ieee80211_vht_cap *vht_capa_mask);
400
401 /* SME events */
402 int cfg80211_connect(struct cfg80211_registered_device *rdev,
403                      struct net_device *dev,
404                      struct cfg80211_connect_params *connect,
405                      struct cfg80211_cached_keys *connkeys,
406                      const u8 *prev_bssid);
407 void __cfg80211_connect_result(struct net_device *dev,
408                                struct cfg80211_connect_resp_params *params,
409                                bool wextev);
410 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
411                              size_t ie_len, u16 reason, bool from_ap);
412 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
413                         struct net_device *dev, u16 reason,
414                         bool wextev);
415 void __cfg80211_roamed(struct wireless_dev *wdev,
416                        struct cfg80211_roam_info *info);
417 void __cfg80211_port_authorized(struct wireless_dev *wdev, const u8 *bssid);
418 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
419                               struct wireless_dev *wdev);
420 void cfg80211_autodisconnect_wk(struct work_struct *work);
421
422 /* SME implementation */
423 void cfg80211_conn_work(struct work_struct *work);
424 void cfg80211_sme_scan_done(struct net_device *dev);
425 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
426 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
427 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
428 void cfg80211_sme_deauth(struct wireless_dev *wdev);
429 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
430 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
431 void cfg80211_sme_abandon_assoc(struct wireless_dev *wdev);
432
433 /* internal helpers */
434 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
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 bool cfg80211_any_wiphy_oper_chan(struct wiphy *wiphy,
491                                   struct ieee80211_channel *chan);
492
493 bool cfg80211_beaconing_iface_active(struct wireless_dev *wdev);
494
495 bool cfg80211_is_sub_chan(struct cfg80211_chan_def *chandef,
496                           struct ieee80211_channel *chan);
497
498 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
499 {
500         unsigned long end = jiffies;
501
502         if (end >= start)
503                 return jiffies_to_msecs(end - start);
504
505         return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
506 }
507
508 void
509 cfg80211_get_chan_state(struct wireless_dev *wdev,
510                         struct ieee80211_channel **chan,
511                         enum cfg80211_chan_mode *chanmode,
512                         u8 *radar_detect);
513
514 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
515                                  struct cfg80211_chan_def *chandef);
516
517 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
518                            const u8 *rates, unsigned int n_rates,
519                            u32 *mask);
520
521 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
522                                  enum nl80211_iftype iftype, u32 beacon_int);
523
524 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
525                                enum nl80211_iftype iftype, int num);
526
527 void __cfg80211_leave(struct cfg80211_registered_device *rdev,
528                       struct wireless_dev *wdev);
529 void cfg80211_leave(struct cfg80211_registered_device *rdev,
530                     struct wireless_dev *wdev);
531
532 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
533                               struct wireless_dev *wdev);
534
535 void cfg80211_stop_nan(struct cfg80211_registered_device *rdev,
536                        struct wireless_dev *wdev);
537
538 struct cfg80211_internal_bss *
539 cfg80211_bss_update(struct cfg80211_registered_device *rdev,
540                     struct cfg80211_internal_bss *tmp,
541                     bool signal_valid, unsigned long ts);
542 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
543 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
544 #else
545 /*
546  * Trick to enable using it as a condition,
547  * and also not give a warning when it's
548  * not used that way.
549  */
550 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
551 #endif
552
553 void cfg80211_cqm_config_free(struct wireless_dev *wdev);
554
555 void cfg80211_release_pmsr(struct wireless_dev *wdev, u32 portid);
556 void cfg80211_pmsr_wdev_down(struct wireless_dev *wdev);
557 void cfg80211_pmsr_free_wk(struct work_struct *work);
558
559 #endif /* __NET_WIRELESS_CORE_H */