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