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  */
   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         unsigned long 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
 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
 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
 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
 170 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 171 {
 172         atomic_inc(&bss->hold);
 173 }
 174
 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
 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
 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
 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_join_mesh(struct cfg80211_registered_device *rdev,
 307                        struct net_device *dev,
 308                        struct mesh_setup *setup,
 309                        const struct mesh_config *conf);
 310 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 311                           struct net_device *dev);
 312 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 313                         struct net_device *dev);
 314 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
 315                               struct wireless_dev *wdev,
 316                               struct cfg80211_chan_def *chandef);
 317
 318 /* OCB */
 319 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
 320                         struct net_device *dev,
 321                         struct ocb_setup *setup);
 322 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
 323                       struct net_device *dev,
 324                       struct ocb_setup *setup);
 325 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
 326                          struct net_device *dev);
 327 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
 328                        struct net_device *dev);
 329
 330 /* AP */
 331 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 332                        struct net_device *dev, bool notify);
 333 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 334                      struct net_device *dev, bool notify);
 335
 336 /* MLME */
 337 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 338                        struct net_device *dev,
 339                        struct ieee80211_channel *chan,
 340                        enum nl80211_auth_type auth_type,
 341                        const u8 *bssid,
 342                        const u8 *ssid, int ssid_len,
 343                        const u8 *ie, int ie_len,
 344                        const u8 *key, int key_len, int key_idx,
 345                        const u8 *auth_data, int auth_data_len);
 346 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 347                         struct net_device *dev,
 348                         struct ieee80211_channel *chan,
 349                         const u8 *bssid,
 350                         const u8 *ssid, int ssid_len,
 351                         struct cfg80211_assoc_request *req);
 352 int cfg80211_mlme_deauth(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 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
 357                            struct net_device *dev, const u8 *bssid,
 358                            const u8 *ie, int ie_len, u16 reason,
 359                            bool local_state_change);
 360 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
 361                         struct net_device *dev);
 362 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
 363                                 u16 frame_type, const u8 *match_data,
 364                                 int match_len);
 365 void cfg80211_mlme_unreg_wk(struct work_struct *wk);
 366 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
 367 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
 368 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
 369                           struct wireless_dev *wdev,
 370                           struct cfg80211_mgmt_tx_params *params,
 371                           u64 *cookie);
 372 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
 373                                const struct ieee80211_ht_cap *ht_capa_mask);
 374 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
 375                                 const struct ieee80211_vht_cap *vht_capa_mask);
 376
 377 /* SME events */
 378 int cfg80211_connect(struct cfg80211_registered_device *rdev,
 379                      struct net_device *dev,
 380                      struct cfg80211_connect_params *connect,
 381                      struct cfg80211_cached_keys *connkeys,
 382                      const u8 *prev_bssid);
 383 void __cfg80211_connect_result(struct net_device *dev,
 384                                struct cfg80211_connect_resp_params *params,
 385                                bool wextev);
 386 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
 387                              size_t ie_len, u16 reason, bool from_ap);
 388 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 389                         struct net_device *dev, u16 reason,
 390                         bool wextev);
 391 void __cfg80211_roamed(struct wireless_dev *wdev,
 392                        struct cfg80211_roam_info *info);
 393 void __cfg80211_port_authorized(struct wireless_dev *wdev, const u8 *bssid);
 394 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
 395                               struct wireless_dev *wdev);
 396 void cfg80211_autodisconnect_wk(struct work_struct *work);
 397
 398 /* SME implementation */
 399 void cfg80211_conn_work(struct work_struct *work);
 400 void cfg80211_sme_scan_done(struct net_device *dev);
 401 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
 402 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
 403 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
 404 void cfg80211_sme_deauth(struct wireless_dev *wdev);
 405 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
 406 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
 407 void cfg80211_sme_abandon_assoc(struct wireless_dev *wdev);
 408
 409 /* internal helpers */
 410 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
 411 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
 412                                    struct key_params *params, int key_idx,
 413                                    bool pairwise, const u8 *mac_addr);
 414 void __cfg80211_scan_done(struct work_struct *wk);
 415 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
 416                            bool send_message);
 417 void cfg80211_add_sched_scan_req(struct cfg80211_registered_device *rdev,
 418                                  struct cfg80211_sched_scan_request *req);
 419 int cfg80211_sched_scan_req_possible(struct cfg80211_registered_device *rdev,
 420                                      bool want_multi);
 421 void cfg80211_sched_scan_results_wk(struct work_struct *work);
 422 int cfg80211_stop_sched_scan_req(struct cfg80211_registered_device *rdev,
 423                                  struct cfg80211_sched_scan_request *req,
 424                                  bool driver_initiated);
 425 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
 426                                u64 reqid, bool driver_initiated);
 427 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
 428 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
 429                           struct net_device *dev, enum nl80211_iftype ntype,
 430                           struct vif_params *params);
 431 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
 432 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
 433
 434 bool cfg80211_does_bw_fit_range(const struct ieee80211_freq_range *freq_range,
 435                                 u32 center_freq_khz, u32 bw_khz);
 436
 437 /**
 438  * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable
 439  * @wiphy: the wiphy to validate against
 440  * @chandef: the channel definition to check
 441  *
 442  * Checks if chandef is usable and we can/need start CAC on such channel.
 443  *
 444  * Return: Return true if all channels available and at least
 445  *         one channel require CAC (NL80211_DFS_USABLE)
 446  */
 447 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
 448                                  const struct cfg80211_chan_def *chandef);
 449
 450 void cfg80211_set_dfs_state(struct wiphy *wiphy,
 451                             const struct cfg80211_chan_def *chandef,
 452                             enum nl80211_dfs_state dfs_state);
 453
 454 void cfg80211_dfs_channels_update_work(struct work_struct *work);
 455
 456 unsigned int
 457 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
 458                               const struct cfg80211_chan_def *chandef);
 459
 460 void cfg80211_sched_dfs_chan_update(struct cfg80211_registered_device *rdev);
 461
 462 bool cfg80211_any_wiphy_oper_chan(struct wiphy *wiphy,
 463                                   struct ieee80211_channel *chan);
 464
 465 bool cfg80211_beaconing_iface_active(struct wireless_dev *wdev);
 466
 467 bool cfg80211_is_sub_chan(struct cfg80211_chan_def *chandef,
 468                           struct ieee80211_channel *chan);
 469
 470 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
 471 {
 472         unsigned long end = jiffies;
 473
 474         if (end >= start)
 475                 return jiffies_to_msecs(end - start);
 476
 477         return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
 478 }
 479
 480 void
 481 cfg80211_get_chan_state(struct wireless_dev *wdev,
 482                         struct ieee80211_channel **chan,
 483                         enum cfg80211_chan_mode *chanmode,
 484                         u8 *radar_detect);
 485
 486 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
 487                                  struct cfg80211_chan_def *chandef);
 488
 489 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 490                            const u8 *rates, unsigned int n_rates,
 491                            u32 *mask);
 492
 493 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 494                                  enum nl80211_iftype iftype, u32 beacon_int);
 495
 496 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
 497                                enum nl80211_iftype iftype, int num);
 498
 499 void __cfg80211_leave(struct cfg80211_registered_device *rdev,
 500                       struct wireless_dev *wdev);
 501 void cfg80211_leave(struct cfg80211_registered_device *rdev,
 502                     struct wireless_dev *wdev);
 503
 504 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
 505                               struct wireless_dev *wdev);
 506
 507 void cfg80211_stop_nan(struct cfg80211_registered_device *rdev,
 508                        struct wireless_dev *wdev);
 509
 510 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 511 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 512 #else
 513 /*
 514  * Trick to enable using it as a condition,
 515  * and also not give a warning when it's
 516  * not used that way.
 517  */
 518 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 519 #endif
 520
 521 void cfg80211_cqm_config_free(struct wireless_dev *wdev);
 522
 523 #endif /* __NET_WIRELESS_CORE_H */