net/wireless/core.h

   1 /*
   2  * Wireless configuration interface internals.
   3  *
   4  * Copyright 2006-2009  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         struct list_head netdev_list;
  52         int devlist_generation;
  53
  54         /* BSSes/scanning */
  55         spinlock_t bss_lock;
  56         struct list_head bss_list;
  57         struct rb_root bss_tree;
  58         u32 bss_generation;
  59         struct cfg80211_scan_request *scan_req; /* protected by RTNL */
  60         unsigned long suspend_at;
  61         struct work_struct scan_done_wk;
  62
  63 #ifdef CONFIG_NL80211_TESTMODE
  64         struct genl_info *testmode_info;
  65 #endif
  66
  67         struct work_struct conn_work;
  68         struct work_struct event_work;
  69
  70         /* current channel */
  71         struct ieee80211_channel *channel;
  72
  73 #ifdef CONFIG_CFG80211_DEBUGFS
  74         /* Debugfs entries */
  75         struct wiphy_debugfsdentries {
  76                 struct dentry *rts_threshold;
  77                 struct dentry *fragmentation_threshold;
  78                 struct dentry *short_retry_limit;
  79                 struct dentry *long_retry_limit;
  80                 struct dentry *ht40allow_map;
  81         } debugfs;
  82 #endif
  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 extern struct mutex cfg80211_mutex;
 104 extern struct list_head cfg80211_rdev_list;
 105 extern int cfg80211_rdev_list_generation;
 106
 107 #define assert_cfg80211_lock() WARN_ON(!mutex_is_locked(&cfg80211_mutex))
 108
 109 /*
 110  * You can use this to mark a wiphy_idx as not having an associated wiphy.
 111  * It guarantees cfg80211_rdev_by_wiphy_idx(wiphy_idx) will return NULL
 112  */
 113 #define WIPHY_IDX_STALE -1
 114
 115 struct cfg80211_internal_bss {
 116         struct list_head list;
 117         struct rb_node rbn;
 118         unsigned long ts;
 119         struct kref ref;
 120         atomic_t hold;
 121         bool ies_allocated;
 122
 123         /* must be last because of priv member */
 124         struct cfg80211_bss pub;
 125 };
 126
 127 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
 128 {
 129         return container_of(pub, struct cfg80211_internal_bss, pub);
 130 }
 131
 132 static inline void cfg80211_ref_bss(struct cfg80211_internal_bss *bss)
 133 {
 134         kref_get(&bss->ref);
 135 }
 136
 137 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
 138 {
 139         atomic_inc(&bss->hold);
 140 }
 141
 142 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
 143 {
 144         int r = atomic_dec_return(&bss->hold);
 145         WARN_ON(r < 0);
 146 }
 147
 148
 149 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
 150 int get_wiphy_idx(struct wiphy *wiphy);
 151
 152 struct cfg80211_registered_device *
 153 __cfg80211_rdev_from_info(struct genl_info *info);
 154
 155 /*
 156  * This function returns a pointer to the driver
 157  * that the genl_info item that is passed refers to.
 158  * If successful, it returns non-NULL and also locks
 159  * the driver's mutex!
 160  *
 161  * This means that you need to call cfg80211_unlock_rdev()
 162  * before being allowed to acquire &cfg80211_mutex!
 163  *
 164  * This is necessary because we need to lock the global
 165  * mutex to get an item off the list safely, and then
 166  * we lock the rdev mutex so it doesn't go away under us.
 167  *
 168  * We don't want to keep cfg80211_mutex locked
 169  * for all the time in order to allow requests on
 170  * other interfaces to go through at the same time.
 171  *
 172  * The result of this can be a PTR_ERR and hence must
 173  * be checked with IS_ERR() for errors.
 174  */
 175 extern struct cfg80211_registered_device *
 176 cfg80211_get_dev_from_info(struct genl_info *info);
 177
 178 /* requires cfg80211_rdev_mutex to be held! */
 179 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 180
 181 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
 182 extern struct cfg80211_registered_device *
 183 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
 184
 185 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 186                           struct net *net);
 187
 188 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
 189 {
 190         mutex_lock(&rdev->mtx);
 191 }
 192
 193 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
 194 {
 195         BUG_ON(IS_ERR(rdev) || !rdev);
 196         mutex_unlock(&rdev->mtx);
 197 }
 198
 199 static inline void wdev_lock(struct wireless_dev *wdev)
 200         __acquires(wdev)
 201 {
 202         mutex_lock(&wdev->mtx);
 203         __acquire(wdev->mtx);
 204 }
 205
 206 static inline void wdev_unlock(struct wireless_dev *wdev)
 207         __releases(wdev)
 208 {
 209         __release(wdev->mtx);
 210         mutex_unlock(&wdev->mtx);
 211 }
 212
 213 #define ASSERT_RDEV_LOCK(rdev) WARN_ON(!mutex_is_locked(&(rdev)->mtx));
 214 #define ASSERT_WDEV_LOCK(wdev) WARN_ON(!mutex_is_locked(&(wdev)->mtx));
 215
 216 enum cfg80211_event_type {
 217         EVENT_CONNECT_RESULT,
 218         EVENT_ROAMED,
 219         EVENT_DISCONNECTED,
 220         EVENT_IBSS_JOINED,
 221 };
 222
 223 struct cfg80211_event {
 224         struct list_head list;
 225         enum cfg80211_event_type type;
 226
 227         union {
 228                 struct {
 229                         u8 bssid[ETH_ALEN];
 230                         const u8 *req_ie;
 231                         const u8 *resp_ie;
 232                         size_t req_ie_len;
 233                         size_t resp_ie_len;
 234                         u16 status;
 235                 } cr;
 236                 struct {
 237                         u8 bssid[ETH_ALEN];
 238                         const u8 *req_ie;
 239                         const u8 *resp_ie;
 240                         size_t req_ie_len;
 241                         size_t resp_ie_len;
 242                 } rm;
 243                 struct {
 244                         const u8 *ie;
 245                         size_t ie_len;
 246                         u16 reason;
 247                 } dc;
 248                 struct {
 249                         u8 bssid[ETH_ALEN];
 250                 } ij;
 251         };
 252 };
 253
 254 struct cfg80211_cached_keys {
 255         struct key_params params[6];
 256         u8 data[6][WLAN_MAX_KEY_LEN];
 257         int def, defmgmt;
 258 };
 259
 260
 261 /* free object */
 262 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
 263
 264 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
 265                                char *newname);
 266
 267 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 268 void wiphy_update_regulatory(struct wiphy *wiphy,
 269                              enum nl80211_reg_initiator setby);
 270
 271 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
 272 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
 273                       unsigned long age_secs);
 274
 275 /* IBSS */
 276 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 277                          struct net_device *dev,
 278                          struct cfg80211_ibss_params *params,
 279                          struct cfg80211_cached_keys *connkeys);
 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 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 285 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 286                         struct net_device *dev, bool nowext);
 287 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
 288 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
 289                             struct wireless_dev *wdev);
 290
 291 /* MLME */
 292 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 293                          struct net_device *dev,
 294                          struct ieee80211_channel *chan,
 295                          enum nl80211_auth_type auth_type,
 296                          const u8 *bssid,
 297                          const u8 *ssid, int ssid_len,
 298                          const u8 *ie, int ie_len,
 299                          const u8 *key, int key_len, int key_idx);
 300 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 301                        struct net_device *dev, struct ieee80211_channel *chan,
 302                        enum nl80211_auth_type auth_type, const u8 *bssid,
 303                        const u8 *ssid, int ssid_len,
 304                        const u8 *ie, int ie_len,
 305                        const u8 *key, int key_len, int key_idx);
 306 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 307                           struct net_device *dev,
 308                           struct ieee80211_channel *chan,
 309                           const u8 *bssid, const u8 *prev_bssid,
 310                           const u8 *ssid, int ssid_len,
 311                           const u8 *ie, int ie_len, bool use_mfp,
 312                           struct cfg80211_crypto_settings *crypt);
 313 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 314                         struct net_device *dev, struct ieee80211_channel *chan,
 315                         const u8 *bssid, const u8 *prev_bssid,
 316                         const u8 *ssid, int ssid_len,
 317                         const u8 *ie, int ie_len, bool use_mfp,
 318                         struct cfg80211_crypto_settings *crypt);
 319 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 320                            struct net_device *dev, const u8 *bssid,
 321                            const u8 *ie, int ie_len, u16 reason);
 322 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 323                          struct net_device *dev, const u8 *bssid,
 324                          const u8 *ie, int ie_len, u16 reason);
 325 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
 326                            struct net_device *dev, const u8 *bssid,
 327                            const u8 *ie, int ie_len, u16 reason);
 328 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
 329                         struct net_device *dev);
 330 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
 331                                const u8 *req_ie, size_t req_ie_len,
 332                                const u8 *resp_ie, size_t resp_ie_len,
 333                                u16 status, bool wextev,
 334                                struct cfg80211_bss *bss);
 335
 336 /* SME */
 337 int __cfg80211_connect(struct cfg80211_registered_device *rdev,
 338                        struct net_device *dev,
 339                        struct cfg80211_connect_params *connect,
 340                        struct cfg80211_cached_keys *connkeys,
 341                        const u8 *prev_bssid);
 342 int cfg80211_connect(struct cfg80211_registered_device *rdev,
 343                      struct net_device *dev,
 344                      struct cfg80211_connect_params *connect,
 345                      struct cfg80211_cached_keys *connkeys);
 346 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 347                           struct net_device *dev, u16 reason,
 348                           bool wextev);
 349 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 350                         struct net_device *dev, u16 reason,
 351                         bool wextev);
 352 void __cfg80211_roamed(struct wireless_dev *wdev, const u8 *bssid,
 353                        const u8 *req_ie, size_t req_ie_len,
 354                        const u8 *resp_ie, size_t resp_ie_len);
 355 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
 356                               struct wireless_dev *wdev);
 357
 358 void cfg80211_conn_work(struct work_struct *work);
 359 bool cfg80211_sme_failed_reassoc(struct wireless_dev *wdev);
 360
 361 /* internal helpers */
 362 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
 363                                    struct key_params *params, int key_idx,
 364                                    const u8 *mac_addr);
 365 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
 366                              size_t ie_len, u16 reason, bool from_ap);
 367 void cfg80211_sme_scan_done(struct net_device *dev);
 368 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
 369 void cfg80211_sme_disassoc(struct net_device *dev, int idx);
 370 void __cfg80211_scan_done(struct work_struct *wk);
 371 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev);
 372 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
 373
 374 struct ieee80211_channel *
 375 rdev_fixed_channel(struct cfg80211_registered_device *rdev,
 376                    struct wireless_dev *for_wdev);
 377 int rdev_set_freq(struct cfg80211_registered_device *rdev,
 378                   struct wireless_dev *for_wdev,
 379                   int freq, enum nl80211_channel_type channel_type);
 380
 381 #endif /* __NET_WIRELESS_CORE_H */