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