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