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         /* BSSes/scanning */
  60         spinlock_t bss_lock;
  61         struct list_head bss_list;
  62         struct rb_root bss_tree;
  63         u32 bss_generation;
  64         struct cfg80211_scan_request *scan_req; /* protected by RTNL */
  65         struct cfg80211_sched_scan_request *sched_scan_req;
  66         unsigned long suspend_at;
  67         struct work_struct scan_done_wk;
  68         struct work_struct sched_scan_results_wk;
  69
  70         struct mutex sched_scan_mtx;
  71
  72 #ifdef CONFIG_NL80211_TESTMODE
  73         struct genl_info *testmode_info;
  74 #endif
  75
  76         struct work_struct conn_work;
  77         struct work_struct event_work;
  78
  79         struct cfg80211_wowlan *wowlan;
  80
  81         /* must be last because of the way we do wiphy_priv(),
  82          * and it should at least be aligned to NETDEV_ALIGN */
  83         struct wiphy wiphy __attribute__((__aligned__(NETDEV_ALIGN)));
  84 };
  85
  86 static inline
  87 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
  88 {
  89         BUG_ON(!wiphy);
  90         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
  91 }
  92
  93 /* Note 0 is valid, hence phy0 */
  94 static inline
  95 bool wiphy_idx_valid(int wiphy_idx)
  96 {
  97         return wiphy_idx >= 0;
  98 }
  99
 100 static inline void
 101 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
 102 {
 103         int i;
 104
 105         if (!rdev->wowlan)
 106                 return;
 107         for (i = 0; i < rdev->wowlan->n_patterns; i++)
 108                 kfree(rdev->wowlan->patterns[i].mask);
 109         kfree(rdev->wowlan->patterns);
 110         kfree(rdev->wowlan);
 111 }
 112
 113 extern struct workqueue_struct *cfg80211_wq;
 114 extern struct mutex cfg80211_mutex;
 115 extern struct list_head cfg80211_rdev_list;
 116 extern int cfg80211_rdev_list_generation;
 117
 118 static inline void assert_cfg80211_lock(void)
 119 {
 120         lockdep_assert_held(&cfg80211_mutex);
 121 }
 122
 123 /*
 124  * You can use this to mark a wiphy_idx as not having an associated wiphy.
 125  * It guarantees cfg80211_rdev_by_wiphy_idx(wiphy_idx) will return NULL
 126  */
 127 #define WIPHY_IDX_STALE -1
 128
 129 struct cfg80211_internal_bss {
 130         struct list_head list;
 131         struct rb_node rbn;
 132         unsigned long ts;
 133         struct kref ref;
 134         atomic_t hold;
 135         bool beacon_ies_allocated;
 136         bool proberesp_ies_allocated;
 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_ref_bss(struct cfg80211_internal_bss *bss)
 148 {
 149         kref_get(&bss->ref);
 150 }
 151
 152 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 153 {
 154         atomic_inc(&bss->hold);
 155 }
 156
 157 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
 158 {
 159         int r = atomic_dec_return(&bss->hold);
 160         WARN_ON(r < 0);
 161 }
 162
 163
 164 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
 165 int get_wiphy_idx(struct wiphy *wiphy);
 166
 167 struct cfg80211_registered_device *
 168 __cfg80211_rdev_from_info(struct genl_info *info);
 169
 170 /*
 171  * This function returns a pointer to the driver
 172  * that the genl_info item that is passed refers to.
 173  * If successful, it returns non-NULL and also locks
 174  * the driver's mutex!
 175  *
 176  * This means that you need to call cfg80211_unlock_rdev()
 177  * before being allowed to acquire &cfg80211_mutex!
 178  *
 179  * This is necessary because we need to lock the global
 180  * mutex to get an item off the list safely, and then
 181  * we lock the rdev mutex so it doesn't go away under us.
 182  *
 183  * We don't want to keep cfg80211_mutex locked
 184  * for all the time in order to allow requests on
 185  * other interfaces to go through at the same time.
 186  *
 187  * The result of this can be a PTR_ERR and hence must
 188  * be checked with IS_ERR() for errors.
 189  */
 190 extern struct cfg80211_registered_device *
 191 cfg80211_get_dev_from_info(struct genl_info *info);
 192
 193 /* requires cfg80211_rdev_mutex to be held! */
 194 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 195
 196 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
 197 extern struct cfg80211_registered_device *
 198 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
 199
 200 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 201                           struct net *net);
 202
 203 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
 204 {
 205         mutex_lock(&rdev->mtx);
 206 }
 207
 208 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
 209 {
 210         BUG_ON(IS_ERR(rdev) || !rdev);
 211         mutex_unlock(&rdev->mtx);
 212 }
 213
 214 static inline void wdev_lock(struct wireless_dev *wdev)
 215         __acquires(wdev)
 216 {
 217         mutex_lock(&wdev->mtx);
 218         __acquire(wdev->mtx);
 219 }
 220
 221 static inline void wdev_unlock(struct wireless_dev *wdev)
 222         __releases(wdev)
 223 {
 224         __release(wdev->mtx);
 225         mutex_unlock(&wdev->mtx);
 226 }
 227
 228 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
 229 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
 230
 231 enum cfg80211_event_type {
 232         EVENT_CONNECT_RESULT,
 233         EVENT_ROAMED,
 234         EVENT_DISCONNECTED,
 235         EVENT_IBSS_JOINED,
 236 };
 237
 238 struct cfg80211_event {
 239         struct list_head list;
 240         enum cfg80211_event_type type;
 241
 242         union {
 243                 struct {
 244                         u8 bssid[ETH_ALEN];
 245                         const u8 *req_ie;
 246                         const u8 *resp_ie;
 247                         size_t req_ie_len;
 248                         size_t resp_ie_len;
 249                         u16 status;
 250                 } cr;
 251                 struct {
 252                         struct ieee80211_channel *channel;
 253                         u8 bssid[ETH_ALEN];
 254                         const u8 *req_ie;
 255                         const u8 *resp_ie;
 256                         size_t req_ie_len;
 257                         size_t resp_ie_len;
 258                 } rm;
 259                 struct {
 260                         const u8 *ie;
 261                         size_t ie_len;
 262                         u16 reason;
 263                 } dc;
 264                 struct {
 265                         u8 bssid[ETH_ALEN];
 266                 } ij;
 267         };
 268 };
 269
 270 struct cfg80211_cached_keys {
 271         struct key_params params[6];
 272         u8 data[6][WLAN_MAX_KEY_LEN];
 273         int def, defmgmt;
 274 };
 275
 276
 277 /* free object */
 278 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
 279
 280 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
 281                                char *newname);
 282
 283 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 284
 285 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
 286 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
 287                       unsigned long age_secs);
 288
 289 /* IBSS */
 290 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 291                          struct net_device *dev,
 292                          struct cfg80211_ibss_params *params,
 293                          struct cfg80211_cached_keys *connkeys);
 294 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 295                        struct net_device *dev,
 296                        struct cfg80211_ibss_params *params,
 297                        struct cfg80211_cached_keys *connkeys);
 298 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 299 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 300                           struct net_device *dev, bool nowext);
 301 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 302                         struct net_device *dev, bool nowext);
 303 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
 304 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
 305                             struct wireless_dev *wdev);
 306
 307 /* mesh */
 308 extern const struct mesh_config default_mesh_config;
 309 extern const struct mesh_setup default_mesh_setup;
 310 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 311                          struct net_device *dev,
 312                          const struct mesh_setup *setup,
 313                          const struct mesh_config *conf);
 314 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 315                        struct net_device *dev,
 316                        const struct mesh_setup *setup,
 317                        const struct mesh_config *conf);
 318 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 319                         struct net_device *dev);
 320
 321 /* MLME */
 322 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 323                          struct net_device *dev,
 324                          struct ieee80211_channel *chan,
 325                          enum nl80211_auth_type auth_type,
 326                          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                          bool local_state_change);
 331 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 332                        struct net_device *dev, struct ieee80211_channel *chan,
 333                        enum nl80211_auth_type auth_type, const u8 *bssid,
 334                        const u8 *ssid, int ssid_len,
 335                        const u8 *ie, int ie_len,
 336                        const u8 *key, int key_len, int key_idx,
 337                        bool local_state_change);
 338 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 339                           struct net_device *dev,
 340                           struct ieee80211_channel *chan,
 341                           const u8 *bssid, const u8 *prev_bssid,
 342                           const u8 *ssid, int ssid_len,
 343                           const u8 *ie, int ie_len, bool use_mfp,
 344                           struct cfg80211_crypto_settings *crypt);
 345 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 346                         struct net_device *dev, struct ieee80211_channel *chan,
 347                         const u8 *bssid, const u8 *prev_bssid,
 348                         const u8 *ssid, int ssid_len,
 349                         const u8 *ie, int ie_len, bool use_mfp,
 350                         struct cfg80211_crypto_settings *crypt);
 351 int __cfg80211_mlme_deauth(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 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 356                          struct net_device *dev, const u8 *bssid,
 357                          const u8 *ie, int ie_len, u16 reason,
 358                          bool local_state_change);
 359 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
 360                            struct net_device *dev, const u8 *bssid,
 361                            const u8 *ie, int ie_len, u16 reason,
 362                            bool local_state_change);
 363 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
 364                         struct net_device *dev);
 365 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
 366                                const u8 *req_ie, size_t req_ie_len,
 367                                const u8 *resp_ie, size_t resp_ie_len,
 368                                u16 status, bool wextev,
 369                                struct cfg80211_bss *bss);
 370 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
 371                                 u16 frame_type, const u8 *match_data,
 372                                 int match_len);
 373 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
 374 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
 375 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
 376                           struct net_device *dev,
 377                           struct ieee80211_channel *chan, bool offchan,
 378                           enum nl80211_channel_type channel_type,
 379                           bool channel_type_valid, unsigned int wait,
 380                           const u8 *buf, size_t len, bool no_cck,
 381                           bool dont_wait_for_ack, u64 *cookie);
 382
 383 /* SME */
 384 int __cfg80211_connect(struct cfg80211_registered_device *rdev,
 385                        struct net_device *dev,
 386                        struct cfg80211_connect_params *connect,
 387                        struct cfg80211_cached_keys *connkeys,
 388                        const u8 *prev_bssid);
 389 int cfg80211_connect(struct cfg80211_registered_device *rdev,
 390                      struct net_device *dev,
 391                      struct cfg80211_connect_params *connect,
 392                      struct cfg80211_cached_keys *connkeys);
 393 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 394                           struct net_device *dev, u16 reason,
 395                           bool wextev);
 396 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 397                         struct net_device *dev, u16 reason,
 398                         bool wextev);
 399 void __cfg80211_roamed(struct wireless_dev *wdev,
 400                        struct ieee80211_channel *channel,
 401                        const u8 *bssid,
 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, int idx);
 421 void __cfg80211_scan_done(struct work_struct *wk);
 422 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
 423 void __cfg80211_sched_scan_results(struct work_struct *wk);
 424 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
 425                                bool driver_initiated);
 426 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
 427 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
 428                           struct net_device *dev, enum nl80211_iftype ntype,
 429                           u32 *flags, struct vif_params *params);
 430 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
 431
 432 int cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
 433                                   struct wireless_dev *wdev,
 434                                   enum nl80211_iftype iftype);
 435
 436 static inline int
 437 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
 438                            enum nl80211_iftype iftype)
 439 {
 440         return cfg80211_can_change_interface(rdev, NULL, iftype);
 441 }
 442
 443 struct ieee80211_channel *
 444 rdev_freq_to_chan(struct cfg80211_registered_device *rdev,
 445                   int freq, enum nl80211_channel_type channel_type);
 446 int cfg80211_set_freq(struct cfg80211_registered_device *rdev,
 447                       struct wireless_dev *wdev, int freq,
 448                       enum nl80211_channel_type channel_type);
 449
 450 u16 cfg80211_calculate_bitrate(struct rate_info *rate);
 451
 452 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 453                            const u8 *rates, unsigned int n_rates,
 454                            u32 *mask);
 455
 456 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 457                                  u32 beacon_int);
 458
 459 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 460 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 461 #else
 462 /*
 463  * Trick to enable using it as a condition,
 464  * and also not give a warning when it's
 465  * not used that way.
 466  */
 467 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 468 #endif
 469
 470 #endif /* __NET_WIRELESS_CORE_H */