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/mutex.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         /* we hold this mutex during any call so that
  27          * we cannot do multiple calls at once, and also
  28          * to avoid the deregister call to proceed while
  29          * any call is in progress */
  30         struct mutex mtx;
  31
  32         /* rfkill support */
  33         struct rfkill_ops rfkill_ops;
  34         struct rfkill *rfkill;
  35         struct work_struct rfkill_sync;
  36
  37         /* ISO / IEC 3166 alpha2 for which this device is receiving
  38          * country IEs on, this can help disregard country IEs from APs
  39          * on the same alpha2 quickly. The alpha2 may differ from
  40          * cfg80211_regdomain's alpha2 when an intersection has occurred.
  41          * If the AP is reconfigured this can also be used to tell us if
  42          * the country on the country IE changed. */
  43         char country_ie_alpha2[2];
  44
  45         /* If a Country IE has been received this tells us the environment
  46          * which its telling us its in. This defaults to ENVIRON_ANY */
  47         enum environment_cap env;
  48
  49         /* wiphy index, internal only */
  50         int wiphy_idx;
  51
  52         /* associated wireless interfaces */
  53         struct mutex devlist_mtx;
  54         /* protected by devlist_mtx or RCU */
  55         struct list_head wdev_list;
  56         int devlist_generation, wdev_id;
  57         int opencount; /* also protected by devlist_mtx */
  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
  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         struct cfg80211_scan_request *scan_req; /* protected by RTNL */
  73         struct cfg80211_sched_scan_request *sched_scan_req;
  74         unsigned long suspend_at;
  75         struct work_struct scan_done_wk;
  76         struct work_struct sched_scan_results_wk;
  77
  78         struct mutex sched_scan_mtx;
  79
  80         struct genl_info *cur_cmd_info;
  81
  82         struct work_struct conn_work;
  83         struct work_struct event_work;
  84
  85         struct cfg80211_wowlan *wowlan;
  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         /* must be last because of the way we do wiphy_priv(),
  93          * and it should at least be aligned to NETDEV_ALIGN */
  94         struct wiphy wiphy __aligned(NETDEV_ALIGN);
  95 };
  96
  97 static inline
  98 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
  99 {
 100         BUG_ON(!wiphy);
 101         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
 102 }
 103
 104 static inline void
 105 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
 106 {
 107         int i;
 108
 109         if (!rdev->wowlan)
 110                 return;
 111         for (i = 0; i < rdev->wowlan->n_patterns; i++)
 112                 kfree(rdev->wowlan->patterns[i].mask);
 113         kfree(rdev->wowlan->patterns);
 114         if (rdev->wowlan->tcp && rdev->wowlan->tcp->sock)
 115                 sock_release(rdev->wowlan->tcp->sock);
 116         kfree(rdev->wowlan->tcp);
 117         kfree(rdev->wowlan);
 118 }
 119
 120 extern struct workqueue_struct *cfg80211_wq;
 121 extern struct mutex cfg80211_mutex;
 122 extern struct list_head cfg80211_rdev_list;
 123 extern int cfg80211_rdev_list_generation;
 124
 125 static inline void assert_cfg80211_lock(void)
 126 {
 127         lockdep_assert_held(&cfg80211_mutex);
 128 }
 129
 130 struct cfg80211_internal_bss {
 131         struct list_head list;
 132         struct list_head hidden_list;
 133         struct rb_node rbn;
 134         unsigned long ts;
 135         unsigned long refcount;
 136         atomic_t hold;
 137
 138         /* must be last because of priv member */
 139         struct cfg80211_bss pub;
 140 };
 141
 142 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
 143 {
 144         return container_of(pub, struct cfg80211_internal_bss, pub);
 145 }
 146
 147 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 148 {
 149         atomic_inc(&bss->hold);
 150 }
 151
 152 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
 153 {
 154         int r = atomic_dec_return(&bss->hold);
 155         WARN_ON(r < 0);
 156 }
 157
 158
 159 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
 160 int get_wiphy_idx(struct wiphy *wiphy);
 161
 162 /* requires cfg80211_rdev_mutex to be held! */
 163 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 164
 165 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
 166 extern struct cfg80211_registered_device *
 167 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
 168
 169 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 170                           struct net *net);
 171
 172 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
 173 {
 174         mutex_lock(&rdev->mtx);
 175 }
 176
 177 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
 178 {
 179         BUG_ON(IS_ERR(rdev) || !rdev);
 180         mutex_unlock(&rdev->mtx);
 181 }
 182
 183 static inline void wdev_lock(struct wireless_dev *wdev)
 184         __acquires(wdev)
 185 {
 186         mutex_lock(&wdev->mtx);
 187         __acquire(wdev->mtx);
 188 }
 189
 190 static inline void wdev_unlock(struct wireless_dev *wdev)
 191         __releases(wdev)
 192 {
 193         __release(wdev->mtx);
 194         mutex_unlock(&wdev->mtx);
 195 }
 196
 197 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
 198 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
 199
 200 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
 201 {
 202         ASSERT_RTNL();
 203
 204         return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
 205                rdev->num_running_ifaces > 0;
 206 }
 207
 208 enum cfg80211_event_type {
 209         EVENT_CONNECT_RESULT,
 210         EVENT_ROAMED,
 211         EVENT_DISCONNECTED,
 212         EVENT_IBSS_JOINED,
 213 };
 214
 215 struct cfg80211_event {
 216         struct list_head list;
 217         enum cfg80211_event_type type;
 218
 219         union {
 220                 struct {
 221                         u8 bssid[ETH_ALEN];
 222                         const u8 *req_ie;
 223                         const u8 *resp_ie;
 224                         size_t req_ie_len;
 225                         size_t resp_ie_len;
 226                         u16 status;
 227                 } cr;
 228                 struct {
 229                         const u8 *req_ie;
 230                         const u8 *resp_ie;
 231                         size_t req_ie_len;
 232                         size_t resp_ie_len;
 233                         struct cfg80211_bss *bss;
 234                 } rm;
 235                 struct {
 236                         const u8 *ie;
 237                         size_t ie_len;
 238                         u16 reason;
 239                 } dc;
 240                 struct {
 241                         u8 bssid[ETH_ALEN];
 242                 } ij;
 243         };
 244 };
 245
 246 struct cfg80211_cached_keys {
 247         struct key_params params[6];
 248         u8 data[6][WLAN_MAX_KEY_LEN];
 249         int def, defmgmt;
 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 /* free object */
 264 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
 265
 266 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
 267                                char *newname);
 268
 269 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 270
 271 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
 272 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
 273                       unsigned long age_secs);
 274
 275 /* IBSS */
 276 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 277                          struct net_device *dev,
 278                          struct cfg80211_ibss_params *params,
 279                          struct cfg80211_cached_keys *connkeys);
 280 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 281                        struct net_device *dev,
 282                        struct cfg80211_ibss_params *params,
 283                        struct cfg80211_cached_keys *connkeys);
 284 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 285 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 286                           struct net_device *dev, bool nowext);
 287 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 288                         struct net_device *dev, bool nowext);
 289 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
 290 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
 291                             struct wireless_dev *wdev);
 292
 293 /* mesh */
 294 extern const struct mesh_config default_mesh_config;
 295 extern const struct mesh_setup default_mesh_setup;
 296 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 297                          struct net_device *dev,
 298                          struct mesh_setup *setup,
 299                          const struct mesh_config *conf);
 300 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 301                        struct net_device *dev,
 302                        struct mesh_setup *setup,
 303                        const struct mesh_config *conf);
 304 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 305                         struct net_device *dev);
 306 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
 307                               struct wireless_dev *wdev,
 308                               struct cfg80211_chan_def *chandef);
 309
 310 /* AP */
 311 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 312                      struct net_device *dev);
 313
 314 /* MLME */
 315 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 316                          struct net_device *dev,
 317                          struct ieee80211_channel *chan,
 318                          enum nl80211_auth_type auth_type,
 319                          const u8 *bssid,
 320                          const u8 *ssid, int ssid_len,
 321                          const u8 *ie, int ie_len,
 322                          const u8 *key, int key_len, int key_idx,
 323                          const u8 *sae_data, int sae_data_len);
 324 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 325                        struct net_device *dev, struct ieee80211_channel *chan,
 326                        enum nl80211_auth_type auth_type, const u8 *bssid,
 327                        const u8 *ssid, int ssid_len,
 328                        const u8 *ie, int ie_len,
 329                        const u8 *key, int key_len, int key_idx,
 330                        const u8 *sae_data, int sae_data_len);
 331 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 332                           struct net_device *dev,
 333                           struct ieee80211_channel *chan,
 334                           const u8 *bssid,
 335                           const u8 *ssid, int ssid_len,
 336                           struct cfg80211_assoc_request *req);
 337 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 338                         struct net_device *dev,
 339                         struct ieee80211_channel *chan,
 340                         const u8 *bssid,
 341                         const u8 *ssid, int ssid_len,
 342                         struct cfg80211_assoc_request *req);
 343 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 344                            struct net_device *dev, const u8 *bssid,
 345                            const u8 *ie, int ie_len, u16 reason,
 346                            bool local_state_change);
 347 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 348                          struct net_device *dev, const u8 *bssid,
 349                          const u8 *ie, int ie_len, u16 reason,
 350                          bool local_state_change);
 351 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
 352                            struct net_device *dev, const u8 *bssid,
 353                            const u8 *ie, int ie_len, u16 reason,
 354                            bool local_state_change);
 355 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
 356                         struct net_device *dev);
 357 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
 358                                const u8 *req_ie, size_t req_ie_len,
 359                                const u8 *resp_ie, size_t resp_ie_len,
 360                                u16 status, bool wextev,
 361                                struct cfg80211_bss *bss);
 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_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
 366 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
 367 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
 368                           struct wireless_dev *wdev,
 369                           struct ieee80211_channel *chan, bool offchan,
 370                           unsigned int wait, const u8 *buf, size_t len,
 371                           bool no_cck, bool dont_wait_for_ack, 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 */
 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 int cfg80211_connect(struct cfg80211_registered_device *rdev,
 384                      struct net_device *dev,
 385                      struct cfg80211_connect_params *connect,
 386                      struct cfg80211_cached_keys *connkeys);
 387 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 388                           struct net_device *dev, u16 reason,
 389                           bool wextev);
 390 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 391                         struct net_device *dev, u16 reason,
 392                         bool wextev);
 393 void __cfg80211_roamed(struct wireless_dev *wdev,
 394                        struct cfg80211_bss *bss,
 395                        const u8 *req_ie, size_t req_ie_len,
 396                        const u8 *resp_ie, size_t resp_ie_len);
 397 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
 398                               struct wireless_dev *wdev);
 399
 400 void cfg80211_conn_work(struct work_struct *work);
 401 void cfg80211_sme_failed_assoc(struct wireless_dev *wdev);
 402 bool cfg80211_sme_failed_reassoc(struct wireless_dev *wdev);
 403
 404 /* internal helpers */
 405 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
 406 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
 407                                    struct key_params *params, int key_idx,
 408                                    bool pairwise, const u8 *mac_addr);
 409 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
 410                              size_t ie_len, u16 reason, bool from_ap);
 411 void cfg80211_sme_scan_done(struct net_device *dev);
 412 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
 413 void cfg80211_sme_disassoc(struct net_device *dev,
 414                            struct cfg80211_internal_bss *bss);
 415 void __cfg80211_scan_done(struct work_struct *wk);
 416 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
 417 void __cfg80211_sched_scan_results(struct work_struct *wk);
 418 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
 419                                bool driver_initiated);
 420 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
 421 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
 422                           struct net_device *dev, enum nl80211_iftype ntype,
 423                           u32 *flags, struct vif_params *params);
 424 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
 425 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
 426
 427 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
 428                                  struct wireless_dev *wdev,
 429                                  enum nl80211_iftype iftype,
 430                                  struct ieee80211_channel *chan,
 431                                  enum cfg80211_chan_mode chanmode,
 432                                  u8 radar_detect);
 433
 434 /**
 435  * cfg80211_chandef_dfs_required - checks if radar detection is required
 436  * @wiphy: the wiphy to validate against
 437  * @chandef: the channel definition to check
 438  * Return: 1 if radar detection is required, 0 if it is not, < 0 on error
 439  */
 440 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
 441                                   const struct cfg80211_chan_def *c);
 442
 443 void cfg80211_set_dfs_state(struct wiphy *wiphy,
 444                             const struct cfg80211_chan_def *chandef,
 445                             enum nl80211_dfs_state dfs_state);
 446
 447 void cfg80211_dfs_channels_update_work(struct work_struct *work);
 448
 449
 450 static inline int
 451 cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
 452                               struct wireless_dev *wdev,
 453                               enum nl80211_iftype iftype)
 454 {
 455         return cfg80211_can_use_iftype_chan(rdev, wdev, iftype, NULL,
 456                                             CHAN_MODE_UNDEFINED, 0);
 457 }
 458
 459 static inline int
 460 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
 461                            enum nl80211_iftype iftype)
 462 {
 463         return cfg80211_can_change_interface(rdev, NULL, iftype);
 464 }
 465
 466 static inline int
 467 cfg80211_can_use_chan(struct cfg80211_registered_device *rdev,
 468                       struct wireless_dev *wdev,
 469                       struct ieee80211_channel *chan,
 470                       enum cfg80211_chan_mode chanmode)
 471 {
 472         return cfg80211_can_use_iftype_chan(rdev, wdev, wdev->iftype,
 473                                             chan, chanmode, 0);
 474 }
 475
 476 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
 477 {
 478         unsigned long end = jiffies;
 479
 480         if (end >= start)
 481                 return jiffies_to_msecs(end - start);
 482
 483         return jiffies_to_msecs(end + (MAX_JIFFY_OFFSET - start) + 1);
 484 }
 485
 486 void
 487 cfg80211_get_chan_state(struct wireless_dev *wdev,
 488                         struct ieee80211_channel **chan,
 489                         enum cfg80211_chan_mode *chanmode);
 490
 491 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
 492                                  struct cfg80211_chan_def *chandef);
 493
 494 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 495                            const u8 *rates, unsigned int n_rates,
 496                            u32 *mask);
 497
 498 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 499                                  u32 beacon_int);
 500
 501 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
 502                                enum nl80211_iftype iftype, int num);
 503
 504 void cfg80211_leave(struct cfg80211_registered_device *rdev,
 505                     struct wireless_dev *wdev);
 506
 507 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
 508                               struct wireless_dev *wdev);
 509
 510 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
 511
 512 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 513 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 514 #else
 515 /*
 516  * Trick to enable using it as a condition,
 517  * and also not give a warning when it's
 518  * not used that way.
 519  */
 520 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 521 #endif
 522
 523 #endif /* __NET_WIRELESS_CORE_H */