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