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         struct list_head beacon_registrations;
  59         spinlock_t beacon_registrations_lock;
  60
  61         /* protected by RTNL only */
  62         int num_running_ifaces;
  63         int num_running_monitor_ifaces;
  64
  65         /* BSSes/scanning */
  66         spinlock_t bss_lock;
  67         struct list_head bss_list;
  68         struct rb_root bss_tree;
  69         u32 bss_generation;
  70         struct cfg80211_scan_request *scan_req; /* protected by RTNL */
  71         struct cfg80211_sched_scan_request *sched_scan_req;
  72         unsigned long suspend_at;
  73         struct work_struct scan_done_wk;
  74         struct work_struct sched_scan_results_wk;
  75
  76         struct mutex sched_scan_mtx;
  77
  78 #ifdef CONFIG_NL80211_TESTMODE
  79         struct genl_info *testmode_info;
  80 #endif
  81
  82         struct work_struct conn_work;
  83         struct work_struct event_work;
  84
  85         struct cfg80211_wowlan *wowlan;
  86
  87         /* must be last because of the way we do wiphy_priv(),
  88          * and it should at least be aligned to NETDEV_ALIGN */
  89         struct wiphy wiphy __attribute__((__aligned__(NETDEV_ALIGN)));
  90 };
  91
  92 static inline
  93 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
  94 {
  95         BUG_ON(!wiphy);
  96         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
  97 }
  98
  99 /* Note 0 is valid, hence phy0 */
 100 static inline
 101 bool wiphy_idx_valid(int wiphy_idx)
 102 {
 103         return wiphy_idx >= 0;
 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         kfree(rdev->wowlan);
 117 }
 118
 119 extern struct workqueue_struct *cfg80211_wq;
 120 extern struct mutex cfg80211_mutex;
 121 extern struct list_head cfg80211_rdev_list;
 122 extern int cfg80211_rdev_list_generation;
 123
 124 static inline void assert_cfg80211_lock(void)
 125 {
 126         lockdep_assert_held(&cfg80211_mutex);
 127 }
 128
 129 /*
 130  * You can use this to mark a wiphy_idx as not having an associated wiphy.
 131  * It guarantees cfg80211_rdev_by_wiphy_idx(wiphy_idx) will return NULL
 132  */
 133 #define WIPHY_IDX_STALE -1
 134
 135 struct cfg80211_internal_bss {
 136         struct list_head list;
 137         struct rb_node rbn;
 138         unsigned long ts;
 139         struct kref ref;
 140         atomic_t hold;
 141
 142         /* must be last because of priv member */
 143         struct cfg80211_bss pub;
 144 };
 145
 146 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
 147 {
 148         return container_of(pub, struct cfg80211_internal_bss, pub);
 149 }
 150
 151 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 152 {
 153         atomic_inc(&bss->hold);
 154 }
 155
 156 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
 157 {
 158         int r = atomic_dec_return(&bss->hold);
 159         WARN_ON(r < 0);
 160 }
 161
 162
 163 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
 164 int get_wiphy_idx(struct wiphy *wiphy);
 165
 166 /* requires cfg80211_rdev_mutex to be held! */
 167 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 168
 169 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
 170 extern struct cfg80211_registered_device *
 171 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
 172
 173 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 174                           struct net *net);
 175
 176 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
 177 {
 178         mutex_lock(&rdev->mtx);
 179 }
 180
 181 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
 182 {
 183         BUG_ON(IS_ERR(rdev) || !rdev);
 184         mutex_unlock(&rdev->mtx);
 185 }
 186
 187 static inline void wdev_lock(struct wireless_dev *wdev)
 188         __acquires(wdev)
 189 {
 190         mutex_lock(&wdev->mtx);
 191         __acquire(wdev->mtx);
 192 }
 193
 194 static inline void wdev_unlock(struct wireless_dev *wdev)
 195         __releases(wdev)
 196 {
 197         __release(wdev->mtx);
 198         mutex_unlock(&wdev->mtx);
 199 }
 200
 201 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
 202 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
 203
 204 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
 205 {
 206         ASSERT_RTNL();
 207
 208         return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
 209                rdev->num_running_ifaces > 0;
 210 }
 211
 212 enum cfg80211_event_type {
 213         EVENT_CONNECT_RESULT,
 214         EVENT_ROAMED,
 215         EVENT_DISCONNECTED,
 216         EVENT_IBSS_JOINED,
 217 };
 218
 219 struct cfg80211_event {
 220         struct list_head list;
 221         enum cfg80211_event_type type;
 222
 223         union {
 224                 struct {
 225                         u8 bssid[ETH_ALEN];
 226                         const u8 *req_ie;
 227                         const u8 *resp_ie;
 228                         size_t req_ie_len;
 229                         size_t resp_ie_len;
 230                         u16 status;
 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                 } dc;
 244                 struct {
 245                         u8 bssid[ETH_ALEN];
 246                 } ij;
 247         };
 248 };
 249
 250 struct cfg80211_cached_keys {
 251         struct key_params params[6];
 252         u8 data[6][WLAN_MAX_KEY_LEN];
 253         int def, defmgmt;
 254 };
 255
 256 enum cfg80211_chan_mode {
 257         CHAN_MODE_UNDEFINED,
 258         CHAN_MODE_SHARED,
 259         CHAN_MODE_EXCLUSIVE,
 260 };
 261
 262 struct cfg80211_beacon_registration {
 263         struct list_head list;
 264         u32 nlportid;
 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_channel(struct cfg80211_registered_device *rdev,
 311                               struct wireless_dev *wdev,
 312                               struct cfg80211_chan_def *chandef);
 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                          const u8 *sae_data, int sae_data_len);
 328 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 329                        struct net_device *dev, struct ieee80211_channel *chan,
 330                        enum nl80211_auth_type auth_type, const u8 *bssid,
 331                        const u8 *ssid, int ssid_len,
 332                        const u8 *ie, int ie_len,
 333                        const u8 *key, int key_len, int key_idx,
 334                        const u8 *sae_data, int sae_data_len);
 335 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 336                           struct net_device *dev,
 337                           struct ieee80211_channel *chan,
 338                           const u8 *bssid, const u8 *prev_bssid,
 339                           const u8 *ssid, int ssid_len,
 340                           const u8 *ie, int ie_len, bool use_mfp,
 341                           struct cfg80211_crypto_settings *crypt,
 342                           u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
 343                           struct ieee80211_ht_cap *ht_capa_mask);
 344 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 345                         struct net_device *dev, struct ieee80211_channel *chan,
 346                         const u8 *bssid, const u8 *prev_bssid,
 347                         const u8 *ssid, int ssid_len,
 348                         const u8 *ie, int ie_len, bool use_mfp,
 349                         struct cfg80211_crypto_settings *crypt,
 350                         u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
 351                         struct ieee80211_ht_cap *ht_capa_mask);
 352 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 353                            struct net_device *dev, const u8 *bssid,
 354                            const u8 *ie, int ie_len, u16 reason,
 355                            bool local_state_change);
 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 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
 367                                const u8 *req_ie, size_t req_ie_len,
 368                                const u8 *resp_ie, size_t resp_ie_len,
 369                                u16 status, bool wextev,
 370                                struct cfg80211_bss *bss);
 371 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
 372                                 u16 frame_type, const u8 *match_data,
 373                                 int match_len);
 374 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
 375 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
 376 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
 377                           struct wireless_dev *wdev,
 378                           struct ieee80211_channel *chan, bool offchan,
 379                           unsigned int wait, const u8 *buf, size_t len,
 380                           bool no_cck, 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 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
 433
 434 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
 435                                  struct wireless_dev *wdev,
 436                                  enum nl80211_iftype iftype,
 437                                  struct ieee80211_channel *chan,
 438                                  enum cfg80211_chan_mode chanmode);
 439
 440 static inline int
 441 cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
 442                               struct wireless_dev *wdev,
 443                               enum nl80211_iftype iftype)
 444 {
 445         return cfg80211_can_use_iftype_chan(rdev, wdev, iftype, NULL,
 446                                             CHAN_MODE_UNDEFINED);
 447 }
 448
 449 static inline int
 450 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
 451                            enum nl80211_iftype iftype)
 452 {
 453         return cfg80211_can_change_interface(rdev, NULL, iftype);
 454 }
 455
 456 static inline int
 457 cfg80211_can_use_chan(struct cfg80211_registered_device *rdev,
 458                       struct wireless_dev *wdev,
 459                       struct ieee80211_channel *chan,
 460                       enum cfg80211_chan_mode chanmode)
 461 {
 462         return cfg80211_can_use_iftype_chan(rdev, wdev, wdev->iftype,
 463                                             chan, chanmode);
 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
 471 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
 472                                  struct cfg80211_chan_def *chandef);
 473
 474 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 475                            const u8 *rates, unsigned int n_rates,
 476                            u32 *mask);
 477
 478 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 479                                  u32 beacon_int);
 480
 481 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
 482                                enum nl80211_iftype iftype, int num);
 483
 484 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
 485
 486 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 487 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 488 #else
 489 /*
 490  * Trick to enable using it as a condition,
 491  * and also not give a warning when it's
 492  * not used that way.
 493  */
 494 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 495 #endif
 496
 497 #endif /* __NET_WIRELESS_CORE_H */