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/kref.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 struct cfg80211_registered_device {
  22         const struct cfg80211_ops *ops;
  23         struct list_head list;
  24         /* we hold this mutex during any call so that
  25          * we cannot do multiple calls at once, and also
  26          * to avoid the deregister call to proceed while
  27          * any call is in progress */
  28         struct mutex mtx;
  29
  30         /* rfkill support */
  31         struct rfkill_ops rfkill_ops;
  32         struct rfkill *rfkill;
  33         struct work_struct rfkill_sync;
  34
  35         /* ISO / IEC 3166 alpha2 for which this device is receiving
  36          * country IEs on, this can help disregard country IEs from APs
  37          * on the same alpha2 quickly. The alpha2 may differ from
  38          * cfg80211_regdomain's alpha2 when an intersection has occurred.
  39          * If the AP is reconfigured this can also be used to tell us if
  40          * the country on the country IE changed. */
  41         char country_ie_alpha2[2];
  42
  43         /* If a Country IE has been received this tells us the environment
  44          * which its telling us its in. This defaults to ENVIRON_ANY */
  45         enum environment_cap env;
  46
  47         /* wiphy index, internal only */
  48         int wiphy_idx;
  49
  50         /* associated wireless interfaces */
  51         struct mutex devlist_mtx;
  52         /* protected by devlist_mtx or RCU */
  53         struct list_head wdev_list;
  54         int devlist_generation, wdev_id;
  55         int opencount; /* also protected by devlist_mtx */
  56         wait_queue_head_t dev_wait;
  57
  58         u32 ap_beacons_nlpid;
  59
  60         /* protected by RTNL only */
  61         int num_running_ifaces;
  62         int num_running_monitor_ifaces;
  63
  64         struct ieee80211_channel *monitor_channel;
  65         enum nl80211_channel_type monitor_channel_type;
  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         /* must be last because of the way we do wiphy_priv(),
  90          * and it should at least be aligned to NETDEV_ALIGN */
  91         struct wiphy wiphy __attribute__((__aligned__(NETDEV_ALIGN)));
  92 };
  93
  94 static inline
  95 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
  96 {
  97         BUG_ON(!wiphy);
  98         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
  99 }
 100
 101 /* Note 0 is valid, hence phy0 */
 102 static inline
 103 bool wiphy_idx_valid(int wiphy_idx)
 104 {
 105         return wiphy_idx >= 0;
 106 }
 107
 108 static inline void
 109 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
 110 {
 111         int i;
 112
 113         if (!rdev->wowlan)
 114                 return;
 115         for (i = 0; i < rdev->wowlan->n_patterns; i++)
 116                 kfree(rdev->wowlan->patterns[i].mask);
 117         kfree(rdev->wowlan->patterns);
 118         kfree(rdev->wowlan);
 119 }
 120
 121 extern struct workqueue_struct *cfg80211_wq;
 122 extern struct mutex cfg80211_mutex;
 123 extern struct list_head cfg80211_rdev_list;
 124 extern int cfg80211_rdev_list_generation;
 125
 126 static inline void assert_cfg80211_lock(void)
 127 {
 128         lockdep_assert_held(&cfg80211_mutex);
 129 }
 130
 131 /*
 132  * You can use this to mark a wiphy_idx as not having an associated wiphy.
 133  * It guarantees cfg80211_rdev_by_wiphy_idx(wiphy_idx) will return NULL
 134  */
 135 #define WIPHY_IDX_STALE -1
 136
 137 struct cfg80211_internal_bss {
 138         struct list_head list;
 139         struct rb_node rbn;
 140         unsigned long ts;
 141         struct kref ref;
 142         atomic_t hold;
 143         bool beacon_ies_allocated;
 144         bool proberesp_ies_allocated;
 145
 146         /* must be last because of priv member */
 147         struct cfg80211_bss pub;
 148 };
 149
 150 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
 151 {
 152         return container_of(pub, struct cfg80211_internal_bss, pub);
 153 }
 154
 155 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 156 {
 157         atomic_inc(&bss->hold);
 158 }
 159
 160 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
 161 {
 162         int r = atomic_dec_return(&bss->hold);
 163         WARN_ON(r < 0);
 164 }
 165
 166
 167 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
 168 int get_wiphy_idx(struct wiphy *wiphy);
 169
 170 /* requires cfg80211_rdev_mutex to be held! */
 171 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 172
 173 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
 174 extern struct cfg80211_registered_device *
 175 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
 176
 177 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 178                           struct net *net);
 179
 180 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
 181 {
 182         mutex_lock(&rdev->mtx);
 183 }
 184
 185 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
 186 {
 187         BUG_ON(IS_ERR(rdev) || !rdev);
 188         mutex_unlock(&rdev->mtx);
 189 }
 190
 191 static inline void wdev_lock(struct wireless_dev *wdev)
 192         __acquires(wdev)
 193 {
 194         mutex_lock(&wdev->mtx);
 195         __acquire(wdev->mtx);
 196 }
 197
 198 static inline void wdev_unlock(struct wireless_dev *wdev)
 199         __releases(wdev)
 200 {
 201         __release(wdev->mtx);
 202         mutex_unlock(&wdev->mtx);
 203 }
 204
 205 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
 206 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
 207
 208 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
 209 {
 210         ASSERT_RTNL();
 211
 212         return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
 213                rdev->num_running_ifaces > 0;
 214 }
 215
 216 enum cfg80211_event_type {
 217         EVENT_CONNECT_RESULT,
 218         EVENT_ROAMED,
 219         EVENT_DISCONNECTED,
 220         EVENT_IBSS_JOINED,
 221 };
 222
 223 struct cfg80211_event {
 224         struct list_head list;
 225         enum cfg80211_event_type type;
 226
 227         union {
 228                 struct {
 229                         u8 bssid[ETH_ALEN];
 230                         const u8 *req_ie;
 231                         const u8 *resp_ie;
 232                         size_t req_ie_len;
 233                         size_t resp_ie_len;
 234                         u16 status;
 235                 } cr;
 236                 struct {
 237                         const u8 *req_ie;
 238                         const u8 *resp_ie;
 239                         size_t req_ie_len;
 240                         size_t resp_ie_len;
 241                         struct cfg80211_bss *bss;
 242                 } rm;
 243                 struct {
 244                         const u8 *ie;
 245                         size_t ie_len;
 246                         u16 reason;
 247                 } dc;
 248                 struct {
 249                         u8 bssid[ETH_ALEN];
 250                 } ij;
 251         };
 252 };
 253
 254 struct cfg80211_cached_keys {
 255         struct key_params params[6];
 256         u8 data[6][WLAN_MAX_KEY_LEN];
 257         int def, defmgmt;
 258 };
 259
 260 enum cfg80211_chan_mode {
 261         CHAN_MODE_UNDEFINED,
 262         CHAN_MODE_SHARED,
 263         CHAN_MODE_EXCLUSIVE,
 264 };
 265
 266
 267 /* free object */
 268 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
 269
 270 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
 271                                char *newname);
 272
 273 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 274
 275 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
 276 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
 277                       unsigned long age_secs);
 278
 279 /* IBSS */
 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 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 285                        struct net_device *dev,
 286                        struct cfg80211_ibss_params *params,
 287                        struct cfg80211_cached_keys *connkeys);
 288 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 289 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 290                           struct net_device *dev, bool nowext);
 291 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 292                         struct net_device *dev, bool nowext);
 293 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
 294 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
 295                             struct wireless_dev *wdev);
 296
 297 /* mesh */
 298 extern const struct mesh_config default_mesh_config;
 299 extern const struct mesh_setup default_mesh_setup;
 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_join_mesh(struct cfg80211_registered_device *rdev,
 305                        struct net_device *dev,
 306                        struct mesh_setup *setup,
 307                        const struct mesh_config *conf);
 308 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 309                         struct net_device *dev);
 310 int cfg80211_set_mesh_freq(struct cfg80211_registered_device *rdev,
 311                            struct wireless_dev *wdev, int freq,
 312                            enum nl80211_channel_type channel_type);
 313
 314 /* AP */
 315 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 316                      struct net_device *dev);
 317
 318 /* MLME */
 319 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 320                          struct net_device *dev,
 321                          struct ieee80211_channel *chan,
 322                          enum nl80211_auth_type auth_type,
 323                          const u8 *bssid,
 324                          const u8 *ssid, int ssid_len,
 325                          const u8 *ie, int ie_len,
 326                          const u8 *key, int key_len, int key_idx);
 327 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 328                        struct net_device *dev, struct ieee80211_channel *chan,
 329                        enum nl80211_auth_type auth_type, const u8 *bssid,
 330                        const u8 *ssid, int ssid_len,
 331                        const u8 *ie, int ie_len,
 332                        const u8 *key, int key_len, int key_idx);
 333 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 334                           struct net_device *dev,
 335                           struct ieee80211_channel *chan,
 336                           const u8 *bssid, const u8 *prev_bssid,
 337                           const u8 *ssid, int ssid_len,
 338                           const u8 *ie, int ie_len, bool use_mfp,
 339                           struct cfg80211_crypto_settings *crypt,
 340                           u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
 341                           struct ieee80211_ht_cap *ht_capa_mask);
 342 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 343                         struct net_device *dev, struct ieee80211_channel *chan,
 344                         const u8 *bssid, const u8 *prev_bssid,
 345                         const u8 *ssid, int ssid_len,
 346                         const u8 *ie, int ie_len, bool use_mfp,
 347                         struct cfg80211_crypto_settings *crypt,
 348                         u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
 349                         struct ieee80211_ht_cap *ht_capa_mask);
 350 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 351                            struct net_device *dev, const u8 *bssid,
 352                            const u8 *ie, int ie_len, u16 reason,
 353                            bool local_state_change);
 354 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 355                          struct net_device *dev, const u8 *bssid,
 356                          const u8 *ie, int ie_len, u16 reason,
 357                          bool local_state_change);
 358 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
 359                            struct net_device *dev, const u8 *bssid,
 360                            const u8 *ie, int ie_len, u16 reason,
 361                            bool local_state_change);
 362 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
 363                         struct net_device *dev);
 364 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
 365                                const u8 *req_ie, size_t req_ie_len,
 366                                const u8 *resp_ie, size_t resp_ie_len,
 367                                u16 status, bool wextev,
 368                                struct cfg80211_bss *bss);
 369 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
 370                                 u16 frame_type, const u8 *match_data,
 371                                 int match_len);
 372 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
 373 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
 374 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
 375                           struct wireless_dev *wdev,
 376                           struct ieee80211_channel *chan, bool offchan,
 377                           enum nl80211_channel_type channel_type,
 378                           bool channel_type_valid, unsigned int wait,
 379                           const u8 *buf, size_t len, bool no_cck,
 380                           bool dont_wait_for_ack, u64 *cookie);
 381 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
 382                                const struct ieee80211_ht_cap *ht_capa_mask);
 383
 384 /* SME */
 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                        const u8 *prev_bssid);
 390 int cfg80211_connect(struct cfg80211_registered_device *rdev,
 391                      struct net_device *dev,
 392                      struct cfg80211_connect_params *connect,
 393                      struct cfg80211_cached_keys *connkeys);
 394 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 395                           struct net_device *dev, u16 reason,
 396                           bool wextev);
 397 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 398                         struct net_device *dev, u16 reason,
 399                         bool wextev);
 400 void __cfg80211_roamed(struct wireless_dev *wdev,
 401                        struct cfg80211_bss *bss,
 402                        const u8 *req_ie, size_t req_ie_len,
 403                        const u8 *resp_ie, size_t resp_ie_len);
 404 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
 405                               struct wireless_dev *wdev);
 406
 407 void cfg80211_conn_work(struct work_struct *work);
 408 void cfg80211_sme_failed_assoc(struct wireless_dev *wdev);
 409 bool cfg80211_sme_failed_reassoc(struct wireless_dev *wdev);
 410
 411 /* internal helpers */
 412 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
 413 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
 414                                    struct key_params *params, int key_idx,
 415                                    bool pairwise, const u8 *mac_addr);
 416 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
 417                              size_t ie_len, u16 reason, bool from_ap);
 418 void cfg80211_sme_scan_done(struct net_device *dev);
 419 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
 420 void cfg80211_sme_disassoc(struct net_device *dev,
 421                            struct cfg80211_internal_bss *bss);
 422 void __cfg80211_scan_done(struct work_struct *wk);
 423 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
 424 void __cfg80211_sched_scan_results(struct work_struct *wk);
 425 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
 426                                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                           u32 *flags, struct vif_params *params);
 431 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
 432
 433 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
 434                                  struct wireless_dev *wdev,
 435                                  enum nl80211_iftype iftype,
 436                                  struct ieee80211_channel *chan,
 437                                  enum cfg80211_chan_mode chanmode);
 438
 439 static inline int
 440 cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
 441                               struct wireless_dev *wdev,
 442                               enum nl80211_iftype iftype)
 443 {
 444         return cfg80211_can_use_iftype_chan(rdev, wdev, iftype, NULL,
 445                                             CHAN_MODE_UNDEFINED);
 446 }
 447
 448 static inline int
 449 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
 450                            enum nl80211_iftype iftype)
 451 {
 452         return cfg80211_can_change_interface(rdev, NULL, iftype);
 453 }
 454
 455 static inline int
 456 cfg80211_can_use_chan(struct cfg80211_registered_device *rdev,
 457                       struct wireless_dev *wdev,
 458                       struct ieee80211_channel *chan,
 459                       enum cfg80211_chan_mode chanmode)
 460 {
 461         return cfg80211_can_use_iftype_chan(rdev, wdev, wdev->iftype,
 462                                             chan, chanmode);
 463 }
 464
 465 void
 466 cfg80211_get_chan_state(struct cfg80211_registered_device *rdev,
 467                         struct wireless_dev *wdev,
 468                         struct ieee80211_channel **chan,
 469                         enum cfg80211_chan_mode *chanmode);
 470
 471 struct ieee80211_channel *
 472 rdev_freq_to_chan(struct cfg80211_registered_device *rdev,
 473                   int freq, enum nl80211_channel_type channel_type);
 474 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
 475                                  int freq, enum nl80211_channel_type chantype);
 476
 477 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 478                            const u8 *rates, unsigned int n_rates,
 479                            u32 *mask);
 480
 481 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 482                                  u32 beacon_int);
 483
 484 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
 485                                enum nl80211_iftype iftype, int num);
 486
 487 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
 488
 489 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 490 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 491 #else
 492 /*
 493  * Trick to enable using it as a condition,
 494  * and also not give a warning when it's
 495  * not used that way.
 496  */
 497 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 498 #endif
 499
 500 #endif /* __NET_WIRELESS_CORE_H */