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