net/wireless/core.h

   1 /*
   2  * Wireless configuration interface internals.
   3  *
   4  * Copyright 2006-2010  Johannes Berg <johannes@sipsolutions.net>
   5  */
   6 #ifndef __NET_WIRELESS_CORE_H
   7 #define __NET_WIRELESS_CORE_H
   8 #include <linux/list.h>
   9 #include <linux/netdevice.h>
  10 #include <linux/rbtree.h>
  11 #include <linux/debugfs.h>
  12 #include <linux/rfkill.h>
  13 #include <linux/workqueue.h>
  14 #include <linux/rtnetlink.h>
  15 #include <net/genetlink.h>
  16 #include <net/cfg80211.h>
  17 #include "reg.h"
  18
  19
  20 #define WIPHY_IDX_INVALID       -1
  21
  22 struct cfg80211_registered_device {
  23         const struct cfg80211_ops *ops;
  24         struct list_head list;
  25
  26         /* rfkill support */
  27         struct rfkill_ops rfkill_ops;
  28         struct rfkill *rfkill;
  29         struct work_struct rfkill_sync;
  30
  31         /* ISO / IEC 3166 alpha2 for which this device is receiving
  32          * country IEs on, this can help disregard country IEs from APs
  33          * on the same alpha2 quickly. The alpha2 may differ from
  34          * cfg80211_regdomain's alpha2 when an intersection has occurred.
  35          * If the AP is reconfigured this can also be used to tell us if
  36          * the country on the country IE changed. */
  37         char country_ie_alpha2[2];
  38
  39         /*
  40          * the driver requests the regulatory core to set this regulatory
  41          * domain as the wiphy's. Only used for %REGULATORY_WIPHY_SELF_MANAGED
  42          * devices using the regulatory_set_wiphy_regd() API
  43          */
  44         const struct ieee80211_regdomain *requested_regd;
  45
  46         /* If a Country IE has been received this tells us the environment
  47          * which its telling us its in. This defaults to ENVIRON_ANY */
  48         enum environment_cap env;
  49
  50         /* wiphy index, internal only */
  51         int wiphy_idx;
  52
  53         /* protected by RTNL */
  54         int devlist_generation, wdev_id;
  55         int opencount;
  56         wait_queue_head_t dev_wait;
  57
  58         struct list_head beacon_registrations;
  59         spinlock_t beacon_registrations_lock;
  60
  61         struct list_head mlme_unreg;
  62         spinlock_t mlme_unreg_lock;
  63         struct work_struct mlme_unreg_wk;
  64
  65         /* protected by RTNL only */
  66         int num_running_ifaces;
  67         int num_running_monitor_ifaces;
  68
  69         /* BSSes/scanning */
  70         spinlock_t bss_lock;
  71         struct list_head bss_list;
  72         struct rb_root bss_tree;
  73         u32 bss_generation;
  74         u32 bss_entries;
  75         struct cfg80211_scan_request *scan_req; /* protected by RTNL */
  76         struct sk_buff *scan_msg;
  77         struct cfg80211_sched_scan_request __rcu *sched_scan_req;
  78         unsigned long suspend_at;
  79         struct work_struct scan_done_wk;
  80         struct work_struct sched_scan_results_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         spinlock_t destroy_list_lock;
  95         struct list_head destroy_list;
  96         struct work_struct destroy_work;
  97
  98         struct work_struct sched_scan_stop_wk;
  99
 100         /* must be last because of the way we do wiphy_priv(),
 101          * and it should at least be aligned to NETDEV_ALIGN */
 102         struct wiphy wiphy __aligned(NETDEV_ALIGN);
 103 };
 104
 105 static inline
 106 struct cfg80211_registered_device *wiphy_to_rdev(struct wiphy *wiphy)
 107 {
 108         BUG_ON(!wiphy);
 109         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
 110 }
 111
 112 static inline void
 113 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
 114 {
 115 #ifdef CONFIG_PM
 116         int i;
 117
 118         if (!rdev->wiphy.wowlan_config)
 119                 return;
 120         for (i = 0; i < rdev->wiphy.wowlan_config->n_patterns; i++)
 121                 kfree(rdev->wiphy.wowlan_config->patterns[i].mask);
 122         kfree(rdev->wiphy.wowlan_config->patterns);
 123         if (rdev->wiphy.wowlan_config->tcp &&
 124             rdev->wiphy.wowlan_config->tcp->sock)
 125                 sock_release(rdev->wiphy.wowlan_config->tcp->sock);
 126         kfree(rdev->wiphy.wowlan_config->tcp);
 127         kfree(rdev->wiphy.wowlan_config->nd_config);
 128         kfree(rdev->wiphy.wowlan_config);
 129 #endif
 130 }
 131
 132 extern struct workqueue_struct *cfg80211_wq;
 133 extern struct list_head cfg80211_rdev_list;
 134 extern int cfg80211_rdev_list_generation;
 135
 136 struct cfg80211_internal_bss {
 137         struct list_head list;
 138         struct list_head hidden_list;
 139         struct rb_node rbn;
 140         u64 ts_boottime;
 141         unsigned long ts;
 142         unsigned long refcount;
 143         atomic_t hold;
 144
 145         /* time at the start of the reception of the first octet of the
 146          * timestamp field of the last beacon/probe received for this BSS.
 147          * The time is the TSF of the BSS specified by %parent_bssid.
 148          */
 149         u64 parent_tsf;
 150
 151         /* the BSS according to which %parent_tsf is set. This is set to
 152          * the BSS that the interface that requested the scan was connected to
 153          * when the beacon/probe was received.
 154          */
 155         u8 parent_bssid[ETH_ALEN] __aligned(2);
 156
 157         /* must be last because of priv member */
 158         struct cfg80211_bss pub;
 159 };
 160
 161 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
 162 {
 163         return container_of(pub, struct cfg80211_internal_bss, pub);
 164 }
 165
 166 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 167 {
 168         atomic_inc(&bss->hold);
 169 }
 170
 171 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
 172 {
 173         int r = atomic_dec_return(&bss->hold);
 174         WARN_ON(r < 0);
 175 }
 176
 177
 178 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
 179 int get_wiphy_idx(struct wiphy *wiphy);
 180
 181 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 182
 183 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 184                           struct net *net);
 185
 186 static inline void wdev_lock(struct wireless_dev *wdev)
 187         __acquires(wdev)
 188 {
 189         mutex_lock(&wdev->mtx);
 190         __acquire(wdev->mtx);
 191 }
 192
 193 static inline void wdev_unlock(struct wireless_dev *wdev)
 194         __releases(wdev)
 195 {
 196         __release(wdev->mtx);
 197         mutex_unlock(&wdev->mtx);
 198 }
 199
 200 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
 201
 202 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
 203 {
 204         ASSERT_RTNL();
 205
 206         return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
 207                rdev->num_running_ifaces > 0;
 208 }
 209
 210 enum cfg80211_event_type {
 211         EVENT_CONNECT_RESULT,
 212         EVENT_ROAMED,
 213         EVENT_DISCONNECTED,
 214         EVENT_IBSS_JOINED,
 215         EVENT_STOPPED,
 216 };
 217
 218 struct cfg80211_event {
 219         struct list_head list;
 220         enum cfg80211_event_type type;
 221
 222         union {
 223                 struct {
 224                         u8 bssid[ETH_ALEN];
 225                         const u8 *req_ie;
 226                         const u8 *resp_ie;
 227                         size_t req_ie_len;
 228                         size_t resp_ie_len;
 229                         struct cfg80211_bss *bss;
 230                         int status; /* -1 = failed; 0..65535 = status code */
 231                 } cr;
 232                 struct {
 233                         const u8 *req_ie;
 234                         const u8 *resp_ie;
 235                         size_t req_ie_len;
 236                         size_t resp_ie_len;
 237                         struct cfg80211_bss *bss;
 238                 } rm;
 239                 struct {
 240                         const u8 *ie;
 241                         size_t ie_len;
 242                         u16 reason;
 243                         bool locally_generated;
 244                 } dc;
 245                 struct {
 246                         u8 bssid[ETH_ALEN];
 247                         struct ieee80211_channel *channel;
 248                 } ij;
 249         };
 250 };
 251
 252 struct cfg80211_cached_keys {
 253         struct key_params params[CFG80211_MAX_WEP_KEYS];
 254         u8 data[CFG80211_MAX_WEP_KEYS][WLAN_KEY_LEN_WEP104];
 255         int def;
 256 };
 257
 258 enum cfg80211_chan_mode {
 259         CHAN_MODE_UNDEFINED,
 260         CHAN_MODE_SHARED,
 261         CHAN_MODE_EXCLUSIVE,
 262 };
 263
 264 struct cfg80211_beacon_registration {
 265         struct list_head list;
 266         u32 nlportid;
 267 };
 268
 269 struct cfg80211_iface_destroy {
 270         struct list_head list;
 271         u32 nlportid;
 272 };
 273
 274 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
 275
 276 /* free object */
 277 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
 278
 279 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
 280                         char *newname);
 281
 282 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 283
 284 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
 285 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
 286                       unsigned long age_secs);
 287
 288 /* IBSS */
 289 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 290                        struct net_device *dev,
 291                        struct cfg80211_ibss_params *params,
 292                        struct cfg80211_cached_keys *connkeys);
 293 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 294 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 295                           struct net_device *dev, bool nowext);
 296 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 297                         struct net_device *dev, bool nowext);
 298 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
 299                             struct ieee80211_channel *channel);
 300 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
 301                             struct wireless_dev *wdev);
 302
 303 /* mesh */
 304 extern const struct mesh_config default_mesh_config;
 305 extern const struct mesh_setup default_mesh_setup;
 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_join_mesh(struct cfg80211_registered_device *rdev,
 311                        struct net_device *dev,
 312                        struct mesh_setup *setup,
 313                        const struct mesh_config *conf);
 314 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 315                           struct net_device *dev);
 316 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 317                         struct net_device *dev);
 318 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
 319                               struct wireless_dev *wdev,
 320                               struct cfg80211_chan_def *chandef);
 321
 322 /* OCB */
 323 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
 324                         struct net_device *dev,
 325                         struct ocb_setup *setup);
 326 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
 327                       struct net_device *dev,
 328                       struct ocb_setup *setup);
 329 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
 330                          struct net_device *dev);
 331 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
 332                        struct net_device *dev);
 333
 334 /* AP */
 335 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 336                        struct net_device *dev, bool notify);
 337 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 338                      struct net_device *dev, bool notify);
 339
 340 /* MLME */
 341 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 342                        struct net_device *dev,
 343                        struct ieee80211_channel *chan,
 344                        enum nl80211_auth_type auth_type,
 345                        const u8 *bssid,
 346                        const u8 *ssid, int ssid_len,
 347                        const u8 *ie, int ie_len,
 348                        const u8 *key, int key_len, int key_idx,
 349                        const u8 *sae_data, int sae_data_len);
 350 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 351                         struct net_device *dev,
 352                         struct ieee80211_channel *chan,
 353                         const u8 *bssid,
 354                         const u8 *ssid, int ssid_len,
 355                         struct cfg80211_assoc_request *req);
 356 int cfg80211_mlme_deauth(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 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
 361                            struct net_device *dev, const u8 *bssid,
 362                            const u8 *ie, int ie_len, u16 reason,
 363                            bool local_state_change);
 364 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
 365                         struct net_device *dev);
 366 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
 367                                 u16 frame_type, const u8 *match_data,
 368                                 int match_len);
 369 void cfg80211_mlme_unreg_wk(struct work_struct *wk);
 370 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
 371 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
 372 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
 373                           struct wireless_dev *wdev,
 374                           struct cfg80211_mgmt_tx_params *params,
 375                           u64 *cookie);
 376 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
 377                                const struct ieee80211_ht_cap *ht_capa_mask);
 378 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
 379                                 const struct ieee80211_vht_cap *vht_capa_mask);
 380
 381 /* SME events */
 382 int cfg80211_connect(struct cfg80211_registered_device *rdev,
 383                      struct net_device *dev,
 384                      struct cfg80211_connect_params *connect,
 385                      struct cfg80211_cached_keys *connkeys,
 386                      const u8 *prev_bssid);
 387 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
 388                                const u8 *req_ie, size_t req_ie_len,
 389                                const u8 *resp_ie, size_t resp_ie_len,
 390                                int status, bool wextev,
 391                                struct cfg80211_bss *bss);
 392 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
 393                              size_t ie_len, u16 reason, bool from_ap);
 394 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 395                         struct net_device *dev, u16 reason,
 396                         bool wextev);
 397 void __cfg80211_roamed(struct wireless_dev *wdev,
 398                        struct cfg80211_bss *bss,
 399                        const u8 *req_ie, size_t req_ie_len,
 400                        const u8 *resp_ie, size_t resp_ie_len);
 401 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
 402                               struct wireless_dev *wdev);
 403
 404 /* SME implementation */
 405 void cfg80211_conn_work(struct work_struct *work);
 406 void cfg80211_sme_scan_done(struct net_device *dev);
 407 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
 408 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
 409 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
 410 void cfg80211_sme_deauth(struct wireless_dev *wdev);
 411 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
 412 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
 413 void cfg80211_sme_abandon_assoc(struct wireless_dev *wdev);
 414
 415 /* internal helpers */
 416 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
 417 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
 418                                    struct key_params *params, int key_idx,
 419                                    bool pairwise, const u8 *mac_addr);
 420 void __cfg80211_scan_done(struct work_struct *wk);
 421 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
 422                            bool send_message);
 423 void __cfg80211_sched_scan_results(struct work_struct *wk);
 424 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
 425                                bool driver_initiated);
 426 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
 427 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
 428                           struct net_device *dev, enum nl80211_iftype ntype,
 429                           u32 *flags, struct vif_params *params);
 430 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
 431 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
 432
 433 /**
 434  * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable
 435  * @wiphy: the wiphy to validate against
 436  * @chandef: the channel definition to check
 437  *
 438  * Checks if chandef is usable and we can/need start CAC on such channel.
 439  *
 440  * Return: Return true if all channels available and at least
 441  *         one channel require CAC (NL80211_DFS_USABLE)
 442  */
 443 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
 444                                  const struct cfg80211_chan_def *chandef);
 445
 446 void cfg80211_set_dfs_state(struct wiphy *wiphy,
 447                             const struct cfg80211_chan_def *chandef,
 448                             enum nl80211_dfs_state dfs_state);
 449
 450 void cfg80211_dfs_channels_update_work(struct work_struct *work);
 451
 452 unsigned int
 453 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
 454                               const struct cfg80211_chan_def *chandef);
 455
 456 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
 457 {
 458         unsigned long end = jiffies;
 459
 460         if (end >= start)
 461                 return jiffies_to_msecs(end - start);
 462
 463         return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
 464 }
 465
 466 void
 467 cfg80211_get_chan_state(struct wireless_dev *wdev,
 468                         struct ieee80211_channel **chan,
 469                         enum cfg80211_chan_mode *chanmode,
 470                         u8 *radar_detect);
 471
 472 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
 473                                  struct cfg80211_chan_def *chandef);
 474
 475 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 476                            const u8 *rates, unsigned int n_rates,
 477                            u32 *mask);
 478
 479 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 480                                  u32 beacon_int);
 481
 482 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
 483                                enum nl80211_iftype iftype, int num);
 484
 485 void __cfg80211_leave(struct cfg80211_registered_device *rdev,
 486                       struct wireless_dev *wdev);
 487 void cfg80211_leave(struct cfg80211_registered_device *rdev,
 488                     struct wireless_dev *wdev);
 489
 490 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
 491                               struct wireless_dev *wdev);
 492
 493 void cfg80211_stop_nan(struct cfg80211_registered_device *rdev,
 494                        struct wireless_dev *wdev);
 495
 496 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
 497
 498 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 499 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 500 #else
 501 /*
 502  * Trick to enable using it as a condition,
 503  * and also not give a warning when it's
 504  * not used that way.
 505  */
 506 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 507 #endif
 508
 509 #endif /* __NET_WIRELESS_CORE_H */