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