net/wireless/core.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Wireless configuration interface internals.
   4  *
   5  * Copyright 2006-2010  Johannes Berg <[email protected]>
   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 wiphy_work 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 wiphy_work 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         struct work_struct wiphy_work;
 112         struct list_head wiphy_work_list;
 113         /* protects the list above */
 114         spinlock_t wiphy_work_lock;
 115         bool suspended;
 116
 117         /* must be last because of the way we do wiphy_priv(),
 118          * and it should at least be aligned to NETDEV_ALIGN */
 119         struct wiphy wiphy __aligned(NETDEV_ALIGN);
 120 };
 121
 122 static inline
 123 struct cfg80211_registered_device *wiphy_to_rdev(struct wiphy *wiphy)
 124 {
 125         BUG_ON(!wiphy);
 126         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
 127 }
 128
 129 static inline void
 130 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
 131 {
 132 #ifdef CONFIG_PM
 133         int i;
 134
 135         if (!rdev->wiphy.wowlan_config)
 136                 return;
 137         for (i = 0; i < rdev->wiphy.wowlan_config->n_patterns; i++)
 138                 kfree(rdev->wiphy.wowlan_config->patterns[i].mask);
 139         kfree(rdev->wiphy.wowlan_config->patterns);
 140         if (rdev->wiphy.wowlan_config->tcp &&
 141             rdev->wiphy.wowlan_config->tcp->sock)
 142                 sock_release(rdev->wiphy.wowlan_config->tcp->sock);
 143         kfree(rdev->wiphy.wowlan_config->tcp);
 144         kfree(rdev->wiphy.wowlan_config->nd_config);
 145         kfree(rdev->wiphy.wowlan_config);
 146 #endif
 147 }
 148
 149 static inline u64 cfg80211_assign_cookie(struct cfg80211_registered_device *rdev)
 150 {
 151         u64 r = ++rdev->cookie_counter;
 152
 153         if (WARN_ON(r == 0))
 154                 r = ++rdev->cookie_counter;
 155
 156         return r;
 157 }
 158
 159 extern struct workqueue_struct *cfg80211_wq;
 160 extern struct list_head cfg80211_rdev_list;
 161 extern int cfg80211_rdev_list_generation;
 162
 163 /* This is constructed like this so it can be used in if/else */
 164 static inline int for_each_rdev_check_rtnl(void)
 165 {
 166         ASSERT_RTNL();
 167         return 0;
 168 }
 169 #define for_each_rdev(rdev)                                             \
 170         if (for_each_rdev_check_rtnl()) {} else                         \
 171                 list_for_each_entry(rdev, &cfg80211_rdev_list, list)
 172
 173 struct cfg80211_internal_bss {
 174         struct list_head list;
 175         struct list_head hidden_list;
 176         struct rb_node rbn;
 177         u64 ts_boottime;
 178         unsigned long ts;
 179         unsigned long refcount;
 180         atomic_t hold;
 181
 182         /* time at the start of the reception of the first octet of the
 183          * timestamp field of the last beacon/probe received for this BSS.
 184          * The time is the TSF of the BSS specified by %parent_bssid.
 185          */
 186         u64 parent_tsf;
 187
 188         /* the BSS according to which %parent_tsf is set. This is set to
 189          * the BSS that the interface that requested the scan was connected to
 190          * when the beacon/probe was received.
 191          */
 192         u8 parent_bssid[ETH_ALEN] __aligned(2);
 193
 194         /* must be last because of priv member */
 195         struct cfg80211_bss pub;
 196 };
 197
 198 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
 199 {
 200         return container_of(pub, struct cfg80211_internal_bss, pub);
 201 }
 202
 203 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 204 {
 205         atomic_inc(&bss->hold);
 206         if (bss->pub.transmitted_bss) {
 207                 bss = container_of(bss->pub.transmitted_bss,
 208                                    struct cfg80211_internal_bss, pub);
 209                 atomic_inc(&bss->hold);
 210         }
 211 }
 212
 213 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
 214 {
 215         int r = atomic_dec_return(&bss->hold);
 216         WARN_ON(r < 0);
 217         if (bss->pub.transmitted_bss) {
 218                 bss = container_of(bss->pub.transmitted_bss,
 219                                    struct cfg80211_internal_bss, pub);
 220                 r = atomic_dec_return(&bss->hold);
 221                 WARN_ON(r < 0);
 222         }
 223 }
 224
 225
 226 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
 227 int get_wiphy_idx(struct wiphy *wiphy);
 228
 229 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 230
 231 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 232                           struct net *net);
 233
 234 void cfg80211_init_wdev(struct wireless_dev *wdev);
 235 void cfg80211_register_wdev(struct cfg80211_registered_device *rdev,
 236                             struct wireless_dev *wdev);
 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[4];
 282         u8 data[4][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         struct rcu_head rcu_head;
 293         u32 rssi_hyst;
 294         s32 last_rssi_event_value;
 295         enum nl80211_cqm_rssi_threshold_event last_rssi_event_type;
 296         int n_rssi_thresholds;
 297         s32 rssi_thresholds[] __counted_by(n_rssi_thresholds);
 298 };
 299
 300 void cfg80211_cqm_rssi_notify_work(struct wiphy *wiphy,
 301                                    struct wiphy_work *work);
 302
 303 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
 304
 305 /* free object */
 306 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
 307
 308 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
 309                         char *newname);
 310
 311 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 312
 313 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
 314 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
 315                       unsigned long age_secs);
 316 void cfg80211_update_assoc_bss_entry(struct wireless_dev *wdev,
 317                                      unsigned int link,
 318                                      struct ieee80211_channel *channel);
 319
 320 /* IBSS */
 321 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 322                          struct net_device *dev,
 323                          struct cfg80211_ibss_params *params,
 324                          struct cfg80211_cached_keys *connkeys);
 325 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 326 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 327                         struct net_device *dev, bool nowext);
 328 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
 329                             struct ieee80211_channel *channel);
 330 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
 331                             struct wireless_dev *wdev);
 332
 333 /* mesh */
 334 extern const struct mesh_config default_mesh_config;
 335 extern const struct mesh_setup default_mesh_setup;
 336 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 337                          struct net_device *dev,
 338                          struct mesh_setup *setup,
 339                          const struct mesh_config *conf);
 340 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 341                         struct net_device *dev);
 342 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
 343                               struct wireless_dev *wdev,
 344                               struct cfg80211_chan_def *chandef);
 345
 346 /* OCB */
 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
 353 /* AP */
 354 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 355                      struct net_device *dev, int link,
 356                      bool notify);
 357
 358 /* MLME */
 359 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 360                        struct net_device *dev,
 361                        struct cfg80211_auth_request *req);
 362 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 363                         struct net_device *dev,
 364                         struct cfg80211_assoc_request *req);
 365 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 366                          struct net_device *dev, const u8 *bssid,
 367                          const u8 *ie, int ie_len, u16 reason,
 368                          bool local_state_change);
 369 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
 370                            struct net_device *dev, const u8 *ap_addr,
 371                            const u8 *ie, int ie_len, u16 reason,
 372                            bool local_state_change);
 373 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
 374                         struct net_device *dev);
 375 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
 376                                 u16 frame_type, const u8 *match_data,
 377                                 int match_len, bool multicast_rx,
 378                                 struct netlink_ext_ack *extack);
 379 void cfg80211_mgmt_registrations_update_wk(struct work_struct *wk);
 380 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
 381 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
 382 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
 383                           struct wireless_dev *wdev,
 384                           struct cfg80211_mgmt_tx_params *params,
 385                           u64 *cookie);
 386 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
 387                                const struct ieee80211_ht_cap *ht_capa_mask);
 388 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
 389                                 const struct ieee80211_vht_cap *vht_capa_mask);
 390
 391 /* SME events */
 392 int cfg80211_connect(struct cfg80211_registered_device *rdev,
 393                      struct net_device *dev,
 394                      struct cfg80211_connect_params *connect,
 395                      struct cfg80211_cached_keys *connkeys,
 396                      const u8 *prev_bssid);
 397 void __cfg80211_connect_result(struct net_device *dev,
 398                                struct cfg80211_connect_resp_params *params,
 399                                bool wextev);
 400 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
 401                              size_t ie_len, u16 reason, bool from_ap);
 402 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 403                         struct net_device *dev, u16 reason,
 404                         bool wextev);
 405 void __cfg80211_roamed(struct wireless_dev *wdev,
 406                        struct cfg80211_roam_info *info);
 407 void __cfg80211_port_authorized(struct wireless_dev *wdev, const u8 *bssid,
 408                                 const u8 *td_bitmap, u8 td_bitmap_len);
 409 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
 410                               struct wireless_dev *wdev);
 411 void cfg80211_autodisconnect_wk(struct work_struct *work);
 412
 413 /* SME implementation */
 414 void cfg80211_conn_work(struct work_struct *work);
 415 void cfg80211_sme_scan_done(struct net_device *dev);
 416 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
 417 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
 418 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
 419 void cfg80211_sme_deauth(struct wireless_dev *wdev);
 420 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
 421 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
 422 void cfg80211_sme_abandon_assoc(struct wireless_dev *wdev);
 423
 424 /* internal helpers */
 425 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
 426 bool cfg80211_valid_key_idx(struct cfg80211_registered_device *rdev,
 427                             int key_idx, bool pairwise);
 428 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
 429                                    struct key_params *params, int key_idx,
 430                                    bool pairwise, const u8 *mac_addr);
 431 void __cfg80211_scan_done(struct wiphy *wiphy, struct wiphy_work *wk);
 432 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
 433                            bool send_message);
 434 void cfg80211_add_sched_scan_req(struct cfg80211_registered_device *rdev,
 435                                  struct cfg80211_sched_scan_request *req);
 436 int cfg80211_sched_scan_req_possible(struct cfg80211_registered_device *rdev,
 437                                      bool want_multi);
 438 void cfg80211_sched_scan_results_wk(struct work_struct *work);
 439 int cfg80211_stop_sched_scan_req(struct cfg80211_registered_device *rdev,
 440                                  struct cfg80211_sched_scan_request *req,
 441                                  bool driver_initiated);
 442 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
 443                                u64 reqid, bool driver_initiated);
 444 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
 445 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
 446                           struct net_device *dev, enum nl80211_iftype ntype,
 447                           struct vif_params *params);
 448 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
 449 void cfg80211_process_wiphy_works(struct cfg80211_registered_device *rdev,
 450                                   struct wiphy_work *end);
 451 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
 452
 453 bool cfg80211_does_bw_fit_range(const struct ieee80211_freq_range *freq_range,
 454                                 u32 center_freq_khz, u32 bw_khz);
 455
 456 int cfg80211_scan(struct cfg80211_registered_device *rdev);
 457
 458 extern struct work_struct cfg80211_disconnect_work;
 459
 460 void cfg80211_set_dfs_state(struct wiphy *wiphy,
 461                             const struct cfg80211_chan_def *chandef,
 462                             enum nl80211_dfs_state dfs_state);
 463
 464 void cfg80211_dfs_channels_update_work(struct work_struct *work);
 465
 466 void cfg80211_sched_dfs_chan_update(struct cfg80211_registered_device *rdev);
 467
 468 int
 469 cfg80211_start_background_radar_detection(struct cfg80211_registered_device *rdev,
 470                                           struct wireless_dev *wdev,
 471                                           struct cfg80211_chan_def *chandef);
 472
 473 void cfg80211_stop_background_radar_detection(struct wireless_dev *wdev);
 474
 475 void cfg80211_background_cac_done_wk(struct work_struct *work);
 476
 477 void cfg80211_background_cac_abort_wk(struct work_struct *work);
 478
 479 bool cfg80211_any_wiphy_oper_chan(struct wiphy *wiphy,
 480                                   struct ieee80211_channel *chan);
 481
 482 bool cfg80211_beaconing_iface_active(struct wireless_dev *wdev);
 483
 484 bool cfg80211_is_sub_chan(struct cfg80211_chan_def *chandef,
 485                           struct ieee80211_channel *chan,
 486                           bool primary_only);
 487 bool cfg80211_wdev_on_sub_chan(struct wireless_dev *wdev,
 488                                struct ieee80211_channel *chan,
 489                                bool primary_only);
 490
 491 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
 492 {
 493         unsigned long end = jiffies;
 494
 495         if (end >= start)
 496                 return jiffies_to_msecs(end - start);
 497
 498         return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
 499 }
 500
 501 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
 502                                  struct cfg80211_chan_def *chandef);
 503
 504 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 505                            const u8 *rates, unsigned int n_rates,
 506                            u32 *mask);
 507
 508 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 509                                  enum nl80211_iftype iftype, u32 beacon_int);
 510
 511 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
 512                                enum nl80211_iftype iftype, int num);
 513
 514 void cfg80211_leave(struct cfg80211_registered_device *rdev,
 515                     struct wireless_dev *wdev);
 516
 517 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
 518                               struct wireless_dev *wdev);
 519
 520 void cfg80211_stop_nan(struct cfg80211_registered_device *rdev,
 521                        struct wireless_dev *wdev);
 522
 523 struct cfg80211_internal_bss *
 524 cfg80211_bss_update(struct cfg80211_registered_device *rdev,
 525                     struct cfg80211_internal_bss *tmp,
 526                     bool signal_valid, unsigned long ts);
 527 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 528 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 529 #else
 530 /*
 531  * Trick to enable using it as a condition,
 532  * and also not give a warning when it's
 533  * not used that way.
 534  */
 535 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 536 #endif
 537
 538 void cfg80211_release_pmsr(struct wireless_dev *wdev, u32 portid);
 539 void cfg80211_pmsr_wdev_down(struct wireless_dev *wdev);
 540 void cfg80211_pmsr_free_wk(struct work_struct *work);
 541
 542 void cfg80211_remove_link(struct wireless_dev *wdev, unsigned int link_id);
 543 void cfg80211_remove_links(struct wireless_dev *wdev);
 544 int cfg80211_remove_virtual_intf(struct cfg80211_registered_device *rdev,
 545                                  struct wireless_dev *wdev);
 546 void cfg80211_wdev_release_link_bsses(struct wireless_dev *wdev, u16 link_mask);
 547
 548 #endif /* __NET_WIRELESS_CORE_H */