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 #ifdef CONFIG_NL80211_TESTMODE
  81         struct genl_info *testmode_info;
  82 #endif
  83
  84         struct work_struct conn_work;
  85         struct work_struct event_work;
  86
  87         struct cfg80211_wowlan *wowlan;
  88
  89         struct delayed_work dfs_update_channels_wk;
  90
  91         /* netlink port which started critical protocol (0 means not started) */
  92         u32 crit_proto_nlportid;
  93
  94         /* must be last because of the way we do wiphy_priv(),
  95          * and it should at least be aligned to NETDEV_ALIGN */
  96         struct wiphy wiphy __aligned(NETDEV_ALIGN);
  97 };
  98
  99 static inline
 100 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
 101 {
 102         BUG_ON(!wiphy);
 103         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
 104 }
 105
 106 static inline void
 107 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
 108 {
 109         int i;
 110
 111         if (!rdev->wowlan)
 112                 return;
 113         for (i = 0; i < rdev->wowlan->n_patterns; i++)
 114                 kfree(rdev->wowlan->patterns[i].mask);
 115         kfree(rdev->wowlan->patterns);
 116         if (rdev->wowlan->tcp && rdev->wowlan->tcp->sock)
 117                 sock_release(rdev->wowlan->tcp->sock);
 118         kfree(rdev->wowlan->tcp);
 119         kfree(rdev->wowlan);
 120 }
 121
 122 extern struct workqueue_struct *cfg80211_wq;
 123 extern struct mutex cfg80211_mutex;
 124 extern struct list_head cfg80211_rdev_list;
 125 extern int cfg80211_rdev_list_generation;
 126
 127 static inline void assert_cfg80211_lock(void)
 128 {
 129         lockdep_assert_held(&cfg80211_mutex);
 130 }
 131
 132 struct cfg80211_internal_bss {
 133         struct list_head list;
 134         struct list_head hidden_list;
 135         struct rb_node rbn;
 136         unsigned long ts;
 137         unsigned long refcount;
 138         atomic_t hold;
 139
 140         /* must be last because of priv member */
 141         struct cfg80211_bss pub;
 142 };
 143
 144 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
 145 {
 146         return container_of(pub, struct cfg80211_internal_bss, pub);
 147 }
 148
 149 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 150 {
 151         atomic_inc(&bss->hold);
 152 }
 153
 154 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
 155 {
 156         int r = atomic_dec_return(&bss->hold);
 157         WARN_ON(r < 0);
 158 }
 159
 160
 161 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
 162 int get_wiphy_idx(struct wiphy *wiphy);
 163
 164 /* requires cfg80211_rdev_mutex to be held! */
 165 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 166
 167 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
 168 extern struct cfg80211_registered_device *
 169 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
 170
 171 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 172                           struct net *net);
 173
 174 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
 175 {
 176         mutex_lock(&rdev->mtx);
 177 }
 178
 179 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
 180 {
 181         BUG_ON(IS_ERR(rdev) || !rdev);
 182         mutex_unlock(&rdev->mtx);
 183 }
 184
 185 static inline void wdev_lock(struct wireless_dev *wdev)
 186         __acquires(wdev)
 187 {
 188         mutex_lock(&wdev->mtx);
 189         __acquire(wdev->mtx);
 190 }
 191
 192 static inline void wdev_unlock(struct wireless_dev *wdev)
 193         __releases(wdev)
 194 {
 195         __release(wdev->mtx);
 196         mutex_unlock(&wdev->mtx);
 197 }
 198
 199 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
 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 };
 216
 217 struct cfg80211_event {
 218         struct list_head list;
 219         enum cfg80211_event_type type;
 220
 221         union {
 222                 struct {
 223                         u8 bssid[ETH_ALEN];
 224                         const u8 *req_ie;
 225                         const u8 *resp_ie;
 226                         size_t req_ie_len;
 227                         size_t resp_ie_len;
 228                         u16 status;
 229                 } cr;
 230                 struct {
 231                         const u8 *req_ie;
 232                         const u8 *resp_ie;
 233                         size_t req_ie_len;
 234                         size_t resp_ie_len;
 235                         struct cfg80211_bss *bss;
 236                 } rm;
 237                 struct {
 238                         const u8 *ie;
 239                         size_t ie_len;
 240                         u16 reason;
 241                 } dc;
 242                 struct {
 243                         u8 bssid[ETH_ALEN];
 244                 } ij;
 245         };
 246 };
 247
 248 struct cfg80211_cached_keys {
 249         struct key_params params[6];
 250         u8 data[6][WLAN_MAX_KEY_LEN];
 251         int def, defmgmt;
 252 };
 253
 254 enum cfg80211_chan_mode {
 255         CHAN_MODE_UNDEFINED,
 256         CHAN_MODE_SHARED,
 257         CHAN_MODE_EXCLUSIVE,
 258 };
 259
 260 struct cfg80211_beacon_registration {
 261         struct list_head list;
 262         u32 nlportid;
 263 };
 264
 265 /* free object */
 266 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
 267
 268 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
 269                                char *newname);
 270
 271 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 272
 273 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
 274 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
 275                       unsigned long age_secs);
 276
 277 /* IBSS */
 278 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 279                          struct net_device *dev,
 280                          struct cfg80211_ibss_params *params,
 281                          struct cfg80211_cached_keys *connkeys);
 282 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 283                        struct net_device *dev,
 284                        struct cfg80211_ibss_params *params,
 285                        struct cfg80211_cached_keys *connkeys);
 286 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 287 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 288                           struct net_device *dev, bool nowext);
 289 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 290                         struct net_device *dev, bool nowext);
 291 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
 292 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
 293                             struct wireless_dev *wdev);
 294
 295 /* mesh */
 296 extern const struct mesh_config default_mesh_config;
 297 extern const struct mesh_setup default_mesh_setup;
 298 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 299                          struct net_device *dev,
 300                          struct mesh_setup *setup,
 301                          const struct mesh_config *conf);
 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_leave_mesh(struct cfg80211_registered_device *rdev,
 307                         struct net_device *dev);
 308 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
 309                               struct wireless_dev *wdev,
 310                               struct cfg80211_chan_def *chandef);
 311
 312 /* AP */
 313 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 314                      struct net_device *dev);
 315
 316 /* MLME */
 317 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 318                          struct net_device *dev,
 319                          struct ieee80211_channel *chan,
 320                          enum nl80211_auth_type auth_type,
 321                          const u8 *bssid,
 322                          const u8 *ssid, int ssid_len,
 323                          const u8 *ie, int ie_len,
 324                          const u8 *key, int key_len, int key_idx,
 325                          const u8 *sae_data, int sae_data_len);
 326 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 327                        struct net_device *dev, struct ieee80211_channel *chan,
 328                        enum nl80211_auth_type auth_type, const u8 *bssid,
 329                        const u8 *ssid, int ssid_len,
 330                        const u8 *ie, int ie_len,
 331                        const u8 *key, int key_len, int key_idx,
 332                        const u8 *sae_data, int sae_data_len);
 333 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 334                           struct net_device *dev,
 335                           struct ieee80211_channel *chan,
 336                           const u8 *bssid,
 337                           const u8 *ssid, int ssid_len,
 338                           struct cfg80211_assoc_request *req);
 339 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 340                         struct net_device *dev,
 341                         struct ieee80211_channel *chan,
 342                         const u8 *bssid,
 343                         const u8 *ssid, int ssid_len,
 344                         struct cfg80211_assoc_request *req);
 345 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 346                            struct net_device *dev, const u8 *bssid,
 347                            const u8 *ie, int ie_len, u16 reason,
 348                            bool local_state_change);
 349 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 350                          struct net_device *dev, const u8 *bssid,
 351                          const u8 *ie, int ie_len, u16 reason,
 352                          bool local_state_change);
 353 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
 354                            struct net_device *dev, const u8 *bssid,
 355                            const u8 *ie, int ie_len, u16 reason,
 356                            bool local_state_change);
 357 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
 358                         struct net_device *dev);
 359 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
 360                                const u8 *req_ie, size_t req_ie_len,
 361                                const u8 *resp_ie, size_t resp_ie_len,
 362                                u16 status, bool wextev,
 363                                struct cfg80211_bss *bss);
 364 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
 365                                 u16 frame_type, const u8 *match_data,
 366                                 int match_len);
 367 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
 368 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
 369 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
 370                           struct wireless_dev *wdev,
 371                           struct ieee80211_channel *chan, bool offchan,
 372                           unsigned int wait, const u8 *buf, size_t len,
 373                           bool no_cck, bool dont_wait_for_ack, u64 *cookie);
 374 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
 375                                const struct ieee80211_ht_cap *ht_capa_mask);
 376 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
 377                                 const struct ieee80211_vht_cap *vht_capa_mask);
 378
 379 /* SME */
 380 int __cfg80211_connect(struct cfg80211_registered_device *rdev,
 381                        struct net_device *dev,
 382                        struct cfg80211_connect_params *connect,
 383                        struct cfg80211_cached_keys *connkeys,
 384                        const u8 *prev_bssid);
 385 int cfg80211_connect(struct cfg80211_registered_device *rdev,
 386                      struct net_device *dev,
 387                      struct cfg80211_connect_params *connect,
 388                      struct cfg80211_cached_keys *connkeys);
 389 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 390                           struct net_device *dev, u16 reason,
 391                           bool wextev);
 392 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 393                         struct net_device *dev, u16 reason,
 394                         bool wextev);
 395 void __cfg80211_roamed(struct wireless_dev *wdev,
 396                        struct cfg80211_bss *bss,
 397                        const u8 *req_ie, size_t req_ie_len,
 398                        const u8 *resp_ie, size_t resp_ie_len);
 399 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
 400                               struct wireless_dev *wdev);
 401
 402 void cfg80211_conn_work(struct work_struct *work);
 403 void cfg80211_sme_failed_assoc(struct wireless_dev *wdev);
 404 bool cfg80211_sme_failed_reassoc(struct wireless_dev *wdev);
 405
 406 /* internal helpers */
 407 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
 408 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
 409                                    struct key_params *params, int key_idx,
 410                                    bool pairwise, const u8 *mac_addr);
 411 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
 412                              size_t ie_len, u16 reason, bool from_ap);
 413 void cfg80211_sme_scan_done(struct net_device *dev);
 414 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
 415 void cfg80211_sme_disassoc(struct net_device *dev,
 416                            struct cfg80211_internal_bss *bss);
 417 void __cfg80211_scan_done(struct work_struct *wk);
 418 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
 419 void __cfg80211_sched_scan_results(struct work_struct *wk);
 420 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
 421                                bool driver_initiated);
 422 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
 423 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
 424                           struct net_device *dev, enum nl80211_iftype ntype,
 425                           u32 *flags, struct vif_params *params);
 426 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
 427 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
 428
 429 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
 430                                  struct wireless_dev *wdev,
 431                                  enum nl80211_iftype iftype,
 432                                  struct ieee80211_channel *chan,
 433                                  enum cfg80211_chan_mode chanmode,
 434                                  u8 radar_detect);
 435
 436 /**
 437  * cfg80211_chandef_dfs_required - checks if radar detection is required
 438  * @wiphy: the wiphy to validate against
 439  * @chandef: the channel definition to check
 440  * Return: 1 if radar detection is required, 0 if it is not, < 0 on error
 441  */
 442 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
 443                                   const struct cfg80211_chan_def *c);
 444
 445 void cfg80211_set_dfs_state(struct wiphy *wiphy,
 446                             const struct cfg80211_chan_def *chandef,
 447                             enum nl80211_dfs_state dfs_state);
 448
 449 void cfg80211_dfs_channels_update_work(struct work_struct *work);
 450
 451
 452 static inline int
 453 cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
 454                               struct wireless_dev *wdev,
 455                               enum nl80211_iftype iftype)
 456 {
 457         return cfg80211_can_use_iftype_chan(rdev, wdev, iftype, NULL,
 458                                             CHAN_MODE_UNDEFINED, 0);
 459 }
 460
 461 static inline int
 462 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
 463                            enum nl80211_iftype iftype)
 464 {
 465         return cfg80211_can_change_interface(rdev, NULL, iftype);
 466 }
 467
 468 static inline int
 469 cfg80211_can_use_chan(struct cfg80211_registered_device *rdev,
 470                       struct wireless_dev *wdev,
 471                       struct ieee80211_channel *chan,
 472                       enum cfg80211_chan_mode chanmode)
 473 {
 474         return cfg80211_can_use_iftype_chan(rdev, wdev, wdev->iftype,
 475                                             chan, chanmode, 0);
 476 }
 477
 478 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
 479 {
 480         unsigned long end = jiffies;
 481
 482         if (end >= start)
 483                 return jiffies_to_msecs(end - start);
 484
 485         return jiffies_to_msecs(end + (MAX_JIFFY_OFFSET - start) + 1);
 486 }
 487
 488 void
 489 cfg80211_get_chan_state(struct wireless_dev *wdev,
 490                         struct ieee80211_channel **chan,
 491                         enum cfg80211_chan_mode *chanmode);
 492
 493 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
 494                                  struct cfg80211_chan_def *chandef);
 495
 496 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 497                            const u8 *rates, unsigned int n_rates,
 498                            u32 *mask);
 499
 500 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 501                                  u32 beacon_int);
 502
 503 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
 504                                enum nl80211_iftype iftype, int num);
 505
 506 void cfg80211_leave(struct cfg80211_registered_device *rdev,
 507                     struct wireless_dev *wdev);
 508
 509 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
 510                               struct wireless_dev *wdev);
 511
 512 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
 513
 514 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 515 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 516 #else
 517 /*
 518  * Trick to enable using it as a condition,
 519  * and also not give a warning when it's
 520  * not used that way.
 521  */
 522 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 523 #endif
 524
 525 #endif /* __NET_WIRELESS_CORE_H */