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