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 <net/genetlink.h>
  17 #include <net/cfg80211.h>
  18 #include "reg.h"
  19
  20 struct cfg80211_registered_device {
  21         const struct cfg80211_ops *ops;
  22         struct list_head list;
  23         /* we hold this mutex during any call so that
  24          * we cannot do multiple calls at once, and also
  25          * to avoid the deregister call to proceed while
  26          * any call is in progress */
  27         struct mutex mtx;
  28
  29         /* rfkill support */
  30         struct rfkill_ops rfkill_ops;
  31         struct rfkill *rfkill;
  32         struct work_struct rfkill_sync;
  33
  34         /* ISO / IEC 3166 alpha2 for which this device is receiving
  35          * country IEs on, this can help disregard country IEs from APs
  36          * on the same alpha2 quickly. The alpha2 may differ from
  37          * cfg80211_regdomain's alpha2 when an intersection has occurred.
  38          * If the AP is reconfigured this can also be used to tell us if
  39          * the country on the country IE changed. */
  40         char country_ie_alpha2[2];
  41
  42         /* If a Country IE has been received this tells us the environment
  43          * which its telling us its in. This defaults to ENVIRON_ANY */
  44         enum environment_cap env;
  45
  46         /* wiphy index, internal only */
  47         int wiphy_idx;
  48
  49         /* associate netdev list */
  50         struct mutex devlist_mtx;
  51         /* protected by devlist_mtx or RCU */
  52         struct list_head netdev_list;
  53         int devlist_generation;
  54         int opencount; /* also protected by devlist_mtx */
  55         wait_queue_head_t dev_wait;
  56
  57         u32 ap_beacons_nlpid;
  58
  59         int num_running_ifaces;
  60         int num_running_monitor_ifaces;
  61
  62         /* BSSes/scanning */
  63         spinlock_t bss_lock;
  64         struct list_head bss_list;
  65         struct rb_root bss_tree;
  66         u32 bss_generation;
  67         struct cfg80211_scan_request *scan_req; /* protected by RTNL */
  68         struct cfg80211_sched_scan_request *sched_scan_req;
  69         unsigned long suspend_at;
  70         struct work_struct scan_done_wk;
  71         struct work_struct sched_scan_results_wk;
  72
  73         struct mutex sched_scan_mtx;
  74
  75 #ifdef CONFIG_NL80211_TESTMODE
  76         struct genl_info *testmode_info;
  77 #endif
  78
  79         struct work_struct conn_work;
  80         struct work_struct event_work;
  81
  82         struct cfg80211_wowlan *wowlan;
  83
  84         /* must be last because of the way we do wiphy_priv(),
  85          * and it should at least be aligned to NETDEV_ALIGN */
  86         struct wiphy wiphy __attribute__((__aligned__(NETDEV_ALIGN)));
  87 };
  88
  89 static inline
  90 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
  91 {
  92         BUG_ON(!wiphy);
  93         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
  94 }
  95
  96 /* Note 0 is valid, hence phy0 */
  97 static inline
  98 bool wiphy_idx_valid(int wiphy_idx)
  99 {
 100         return wiphy_idx >= 0;
 101 }
 102
 103 static inline void
 104 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
 105 {
 106         int i;
 107
 108         if (!rdev->wowlan)
 109                 return;
 110         for (i = 0; i < rdev->wowlan->n_patterns; i++)
 111                 kfree(rdev->wowlan->patterns[i].mask);
 112         kfree(rdev->wowlan->patterns);
 113         kfree(rdev->wowlan);
 114 }
 115
 116 extern struct workqueue_struct *cfg80211_wq;
 117 extern struct mutex cfg80211_mutex;
 118 extern struct list_head cfg80211_rdev_list;
 119 extern int cfg80211_rdev_list_generation;
 120
 121 static inline void assert_cfg80211_lock(void)
 122 {
 123         lockdep_assert_held(&cfg80211_mutex);
 124 }
 125
 126 /*
 127  * You can use this to mark a wiphy_idx as not having an associated wiphy.
 128  * It guarantees cfg80211_rdev_by_wiphy_idx(wiphy_idx) will return NULL
 129  */
 130 #define WIPHY_IDX_STALE -1
 131
 132 struct cfg80211_internal_bss {
 133         struct list_head list;
 134         struct rb_node rbn;
 135         unsigned long ts;
 136         struct kref ref;
 137         atomic_t hold;
 138         bool beacon_ies_allocated;
 139         bool proberesp_ies_allocated;
 140
 141         /* must be last because of priv member */
 142         struct cfg80211_bss pub;
 143 };
 144
 145 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
 146 {
 147         return container_of(pub, struct cfg80211_internal_bss, pub);
 148 }
 149
 150 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 151 {
 152         atomic_inc(&bss->hold);
 153 }
 154
 155 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
 156 {
 157         int r = atomic_dec_return(&bss->hold);
 158         WARN_ON(r < 0);
 159 }
 160
 161
 162 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
 163 int get_wiphy_idx(struct wiphy *wiphy);
 164
 165 /* requires cfg80211_rdev_mutex to be held! */
 166 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 167
 168 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
 169 extern struct cfg80211_registered_device *
 170 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
 171
 172 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 173                           struct net *net);
 174
 175 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
 176 {
 177         mutex_lock(&rdev->mtx);
 178 }
 179
 180 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
 181 {
 182         BUG_ON(IS_ERR(rdev) || !rdev);
 183         mutex_unlock(&rdev->mtx);
 184 }
 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_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
 201 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
 202
 203 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
 204 {
 205         ASSERT_RDEV_LOCK(rdev);
 206
 207         return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
 208                rdev->num_running_ifaces > 0;
 209 }
 210
 211 enum cfg80211_event_type {
 212         EVENT_CONNECT_RESULT,
 213         EVENT_ROAMED,
 214         EVENT_DISCONNECTED,
 215         EVENT_IBSS_JOINED,
 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                         u16 status;
 230                 } cr;
 231                 struct {
 232                         const u8 *req_ie;
 233                         const u8 *resp_ie;
 234                         size_t req_ie_len;
 235                         size_t resp_ie_len;
 236                         struct cfg80211_bss *bss;
 237                 } rm;
 238                 struct {
 239                         const u8 *ie;
 240                         size_t ie_len;
 241                         u16 reason;
 242                 } dc;
 243                 struct {
 244                         u8 bssid[ETH_ALEN];
 245                 } ij;
 246         };
 247 };
 248
 249 struct cfg80211_cached_keys {
 250         struct key_params params[6];
 251         u8 data[6][WLAN_MAX_KEY_LEN];
 252         int def, defmgmt;
 253 };
 254
 255 enum cfg80211_chan_mode {
 256         CHAN_MODE_UNDEFINED,
 257         CHAN_MODE_SHARED,
 258         CHAN_MODE_EXCLUSIVE,
 259 };
 260
 261
 262 /* free object */
 263 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
 264
 265 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
 266                                char *newname);
 267
 268 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 269
 270 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
 271 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
 272                       unsigned long age_secs);
 273
 274 /* IBSS */
 275 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 276                          struct net_device *dev,
 277                          struct cfg80211_ibss_params *params,
 278                          struct cfg80211_cached_keys *connkeys);
 279 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 280                        struct net_device *dev,
 281                        struct cfg80211_ibss_params *params,
 282                        struct cfg80211_cached_keys *connkeys);
 283 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 284 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 285                           struct net_device *dev, bool nowext);
 286 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 287                         struct net_device *dev, bool nowext);
 288 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
 289 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
 290                             struct wireless_dev *wdev);
 291
 292 /* mesh */
 293 extern const struct mesh_config default_mesh_config;
 294 extern const struct mesh_setup default_mesh_setup;
 295 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 296                          struct net_device *dev,
 297                          struct mesh_setup *setup,
 298                          const struct mesh_config *conf);
 299 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 300                        struct net_device *dev,
 301                        struct mesh_setup *setup,
 302                        const struct mesh_config *conf);
 303 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 304                         struct net_device *dev);
 305 int cfg80211_set_mesh_freq(struct cfg80211_registered_device *rdev,
 306                            struct wireless_dev *wdev, int freq,
 307                            enum nl80211_channel_type channel_type);
 308
 309 /* AP */
 310 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 311                      struct net_device *dev);
 312
 313 /* MLME */
 314 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 315                          struct net_device *dev,
 316                          struct ieee80211_channel *chan,
 317                          enum nl80211_auth_type auth_type,
 318                          const u8 *bssid,
 319                          const u8 *ssid, int ssid_len,
 320                          const u8 *ie, int ie_len,
 321                          const u8 *key, int key_len, int key_idx);
 322 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 323                        struct net_device *dev, struct ieee80211_channel *chan,
 324                        enum nl80211_auth_type auth_type, const u8 *bssid,
 325                        const u8 *ssid, int ssid_len,
 326                        const u8 *ie, int ie_len,
 327                        const u8 *key, int key_len, int key_idx);
 328 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 329                           struct net_device *dev,
 330                           struct ieee80211_channel *chan,
 331                           const u8 *bssid, const u8 *prev_bssid,
 332                           const u8 *ssid, int ssid_len,
 333                           const u8 *ie, int ie_len, bool use_mfp,
 334                           struct cfg80211_crypto_settings *crypt,
 335                           u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
 336                           struct ieee80211_ht_cap *ht_capa_mask);
 337 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 338                         struct net_device *dev, struct ieee80211_channel *chan,
 339                         const u8 *bssid, const u8 *prev_bssid,
 340                         const u8 *ssid, int ssid_len,
 341                         const u8 *ie, int ie_len, bool use_mfp,
 342                         struct cfg80211_crypto_settings *crypt,
 343                         u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
 344                         struct ieee80211_ht_cap *ht_capa_mask);
 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 net_device *dev,
 371                           struct ieee80211_channel *chan, bool offchan,
 372                           enum nl80211_channel_type channel_type,
 373                           bool channel_type_valid, unsigned int wait,
 374                           const u8 *buf, size_t len, bool no_cck,
 375                           bool dont_wait_for_ack, 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
 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
 428 int cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
 429                                   struct wireless_dev *wdev,
 430                                   enum nl80211_iftype iftype);
 431
 432 static inline int
 433 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
 434                            enum nl80211_iftype iftype)
 435 {
 436         return cfg80211_can_change_interface(rdev, NULL, iftype);
 437 }
 438
 439 void
 440 cfg80211_get_chan_state(struct cfg80211_registered_device *rdev,
 441                         struct wireless_dev *wdev,
 442                         struct ieee80211_channel **chan,
 443                         enum cfg80211_chan_mode *chanmode);
 444
 445 struct ieee80211_channel *
 446 rdev_freq_to_chan(struct cfg80211_registered_device *rdev,
 447                   int freq, enum nl80211_channel_type channel_type);
 448 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
 449                                  int freq, enum nl80211_channel_type chantype);
 450
 451 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 452                            const u8 *rates, unsigned int n_rates,
 453                            u32 *mask);
 454
 455 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 456                                  u32 beacon_int);
 457
 458 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
 459                                enum nl80211_iftype iftype, int num);
 460
 461 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 462 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 463 #else
 464 /*
 465  * Trick to enable using it as a condition,
 466  * and also not give a warning when it's
 467  * not used that way.
 468  */
 469 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 470 #endif
 471
 472 #endif /* __NET_WIRELESS_CORE_H */