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