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/rbtree.h>
  12 #include <linux/debugfs.h>
  13 #include <linux/rfkill.h>
  14 #include <linux/workqueue.h>
  15 #include <linux/rtnetlink.h>
  16 #include <net/genetlink.h>
  17 #include <net/cfg80211.h>
  18 #include "reg.h"
  19
  20
  21 #define WIPHY_IDX_INVALID       -1
  22
  23 struct cfg80211_registered_device {
  24         const struct cfg80211_ops *ops;
  25         struct list_head list;
  26         /* we hold this mutex during any call so that
  27          * we cannot do multiple calls at once, and also
  28          * to avoid the deregister call to proceed while
  29          * any call is in progress */
  30         struct mutex mtx;
  31
  32         /* rfkill support */
  33         struct rfkill_ops rfkill_ops;
  34         struct rfkill *rfkill;
  35         struct work_struct rfkill_sync;
  36
  37         /* ISO / IEC 3166 alpha2 for which this device is receiving
  38          * country IEs on, this can help disregard country IEs from APs
  39          * on the same alpha2 quickly. The alpha2 may differ from
  40          * cfg80211_regdomain's alpha2 when an intersection has occurred.
  41          * If the AP is reconfigured this can also be used to tell us if
  42          * the country on the country IE changed. */
  43         char country_ie_alpha2[2];
  44
  45         /* If a Country IE has been received this tells us the environment
  46          * which its telling us its in. This defaults to ENVIRON_ANY */
  47         enum environment_cap env;
  48
  49         /* wiphy index, internal only */
  50         int wiphy_idx;
  51
  52         /* associated wireless interfaces */
  53         struct mutex devlist_mtx;
  54         /* protected by devlist_mtx or RCU */
  55         struct list_head wdev_list;
  56         int devlist_generation, wdev_id;
  57         int opencount; /* also protected by devlist_mtx */
  58         wait_queue_head_t dev_wait;
  59
  60         struct list_head beacon_registrations;
  61         spinlock_t beacon_registrations_lock;
  62
  63         /* protected by RTNL only */
  64         int num_running_ifaces;
  65         int num_running_monitor_ifaces;
  66
  67         /* BSSes/scanning */
  68         spinlock_t bss_lock;
  69         struct list_head bss_list;
  70         struct rb_root bss_tree;
  71         u32 bss_generation;
  72         u32 bss_entries;
  73         struct cfg80211_scan_request *scan_req; /* protected by RTNL */
  74         struct cfg80211_sched_scan_request *sched_scan_req;
  75         unsigned long suspend_at;
  76         struct work_struct scan_done_wk;
  77         struct work_struct sched_scan_results_wk;
  78
  79         struct mutex sched_scan_mtx;
  80
  81         struct genl_info *cur_cmd_info;
  82
  83         struct work_struct conn_work;
  84         struct work_struct event_work;
  85
  86         struct cfg80211_wowlan *wowlan;
  87
  88         struct delayed_work dfs_update_channels_wk;
  89
  90         /* netlink port which started critical protocol (0 means not started) */
  91         u32 crit_proto_nlportid;
  92
  93         /* must be last because of the way we do wiphy_priv(),
  94          * and it should at least be aligned to NETDEV_ALIGN */
  95         struct wiphy wiphy __aligned(NETDEV_ALIGN);
  96 };
  97
  98 static inline
  99 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
 100 {
 101         BUG_ON(!wiphy);
 102         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
 103 }
 104
 105 static inline void
 106 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
 107 {
 108         int i;
 109
 110         if (!rdev->wowlan)
 111                 return;
 112         for (i = 0; i < rdev->wowlan->n_patterns; i++)
 113                 kfree(rdev->wowlan->patterns[i].mask);
 114         kfree(rdev->wowlan->patterns);
 115         if (rdev->wowlan->tcp && rdev->wowlan->tcp->sock)
 116                 sock_release(rdev->wowlan->tcp->sock);
 117         kfree(rdev->wowlan->tcp);
 118         kfree(rdev->wowlan);
 119 }
 120
 121 extern struct workqueue_struct *cfg80211_wq;
 122 extern struct mutex cfg80211_mutex;
 123 extern struct list_head cfg80211_rdev_list;
 124 extern int cfg80211_rdev_list_generation;
 125
 126 static inline void assert_cfg80211_lock(void)
 127 {
 128         lockdep_assert_held(&cfg80211_mutex);
 129 }
 130
 131 struct cfg80211_internal_bss {
 132         struct list_head list;
 133         struct list_head hidden_list;
 134         struct rb_node rbn;
 135         unsigned long ts;
 136         unsigned long refcount;
 137         atomic_t hold;
 138
 139         /* must be last because of priv member */
 140         struct cfg80211_bss pub;
 141 };
 142
 143 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
 144 {
 145         return container_of(pub, struct cfg80211_internal_bss, pub);
 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 /* requires cfg80211_rdev_mutex to be held! */
 164 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
 165
 166 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
 167 extern struct cfg80211_registered_device *
 168 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
 169
 170 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
 171                           struct net *net);
 172
 173 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
 174 {
 175         mutex_lock(&rdev->mtx);
 176 }
 177
 178 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
 179 {
 180         BUG_ON(IS_ERR(rdev) || !rdev);
 181         mutex_unlock(&rdev->mtx);
 182 }
 183
 184 static inline void wdev_lock(struct wireless_dev *wdev)
 185         __acquires(wdev)
 186 {
 187         mutex_lock(&wdev->mtx);
 188         __acquire(wdev->mtx);
 189 }
 190
 191 static inline void wdev_unlock(struct wireless_dev *wdev)
 192         __releases(wdev)
 193 {
 194         __release(wdev->mtx);
 195         mutex_unlock(&wdev->mtx);
 196 }
 197
 198 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
 199 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
 200
 201 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
 202 {
 203         ASSERT_RTNL();
 204
 205         return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
 206                rdev->num_running_ifaces > 0;
 207 }
 208
 209 enum cfg80211_event_type {
 210         EVENT_CONNECT_RESULT,
 211         EVENT_ROAMED,
 212         EVENT_DISCONNECTED,
 213         EVENT_IBSS_JOINED,
 214 };
 215
 216 struct cfg80211_event {
 217         struct list_head list;
 218         enum cfg80211_event_type type;
 219
 220         union {
 221                 struct {
 222                         u8 bssid[ETH_ALEN];
 223                         const u8 *req_ie;
 224                         const u8 *resp_ie;
 225                         size_t req_ie_len;
 226                         size_t resp_ie_len;
 227                         u16 status;
 228                 } cr;
 229                 struct {
 230                         const u8 *req_ie;
 231                         const u8 *resp_ie;
 232                         size_t req_ie_len;
 233                         size_t resp_ie_len;
 234                         struct cfg80211_bss *bss;
 235                 } rm;
 236                 struct {
 237                         const u8 *ie;
 238                         size_t ie_len;
 239                         u16 reason;
 240                 } dc;
 241                 struct {
 242                         u8 bssid[ETH_ALEN];
 243                 } ij;
 244         };
 245 };
 246
 247 struct cfg80211_cached_keys {
 248         struct key_params params[6];
 249         u8 data[6][WLAN_MAX_KEY_LEN];
 250         int def, defmgmt;
 251 };
 252
 253 enum cfg80211_chan_mode {
 254         CHAN_MODE_UNDEFINED,
 255         CHAN_MODE_SHARED,
 256         CHAN_MODE_EXCLUSIVE,
 257 };
 258
 259 struct cfg80211_beacon_registration {
 260         struct list_head list;
 261         u32 nlportid;
 262 };
 263
 264 /* free object */
 265 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
 266
 267 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
 268                                char *newname);
 269
 270 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
 271
 272 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
 273 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
 274                       unsigned long age_secs);
 275
 276 /* IBSS */
 277 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 278                          struct net_device *dev,
 279                          struct cfg80211_ibss_params *params,
 280                          struct cfg80211_cached_keys *connkeys);
 281 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
 282                        struct net_device *dev,
 283                        struct cfg80211_ibss_params *params,
 284                        struct cfg80211_cached_keys *connkeys);
 285 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
 286 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 287                           struct net_device *dev, bool nowext);
 288 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
 289                         struct net_device *dev, bool nowext);
 290 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
 291 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
 292                             struct wireless_dev *wdev);
 293
 294 /* mesh */
 295 extern const struct mesh_config default_mesh_config;
 296 extern const struct mesh_setup default_mesh_setup;
 297 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 298                          struct net_device *dev,
 299                          struct mesh_setup *setup,
 300                          const struct mesh_config *conf);
 301 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
 302                        struct net_device *dev,
 303                        struct mesh_setup *setup,
 304                        const struct mesh_config *conf);
 305 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
 306                         struct net_device *dev);
 307 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
 308                               struct wireless_dev *wdev,
 309                               struct cfg80211_chan_def *chandef);
 310
 311 /* AP */
 312 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
 313                      struct net_device *dev);
 314
 315 /* MLME */
 316 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 317                          struct net_device *dev,
 318                          struct ieee80211_channel *chan,
 319                          enum nl80211_auth_type auth_type,
 320                          const u8 *bssid,
 321                          const u8 *ssid, int ssid_len,
 322                          const u8 *ie, int ie_len,
 323                          const u8 *key, int key_len, int key_idx,
 324                          const u8 *sae_data, int sae_data_len);
 325 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
 326                        struct net_device *dev, struct ieee80211_channel *chan,
 327                        enum nl80211_auth_type auth_type, const u8 *bssid,
 328                        const u8 *ssid, int ssid_len,
 329                        const u8 *ie, int ie_len,
 330                        const u8 *key, int key_len, int key_idx,
 331                        const u8 *sae_data, int sae_data_len);
 332 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 333                           struct net_device *dev,
 334                           struct ieee80211_channel *chan,
 335                           const u8 *bssid,
 336                           const u8 *ssid, int ssid_len,
 337                           struct cfg80211_assoc_request *req);
 338 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
 339                         struct net_device *dev,
 340                         struct ieee80211_channel *chan,
 341                         const u8 *bssid,
 342                         const u8 *ssid, int ssid_len,
 343                         struct cfg80211_assoc_request *req);
 344 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
 345                            struct net_device *dev, const u8 *bssid,
 346                            const u8 *ie, int ie_len, u16 reason,
 347                            bool local_state_change);
 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_disassoc(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 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
 357                         struct net_device *dev);
 358 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
 359                                const u8 *req_ie, size_t req_ie_len,
 360                                const u8 *resp_ie, size_t resp_ie_len,
 361                                u16 status, bool wextev,
 362                                struct cfg80211_bss *bss);
 363 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
 364                                 u16 frame_type, const u8 *match_data,
 365                                 int match_len);
 366 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
 367 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
 368 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
 369                           struct wireless_dev *wdev,
 370                           struct ieee80211_channel *chan, bool offchan,
 371                           unsigned int wait, const u8 *buf, size_t len,
 372                           bool no_cck, bool dont_wait_for_ack, u64 *cookie);
 373 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
 374                                const struct ieee80211_ht_cap *ht_capa_mask);
 375 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
 376                                 const struct ieee80211_vht_cap *vht_capa_mask);
 377
 378 /* SME */
 379 int __cfg80211_connect(struct cfg80211_registered_device *rdev,
 380                        struct net_device *dev,
 381                        struct cfg80211_connect_params *connect,
 382                        struct cfg80211_cached_keys *connkeys,
 383                        const u8 *prev_bssid);
 384 int cfg80211_connect(struct cfg80211_registered_device *rdev,
 385                      struct net_device *dev,
 386                      struct cfg80211_connect_params *connect,
 387                      struct cfg80211_cached_keys *connkeys);
 388 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 389                           struct net_device *dev, u16 reason,
 390                           bool wextev);
 391 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
 392                         struct net_device *dev, u16 reason,
 393                         bool wextev);
 394 void __cfg80211_roamed(struct wireless_dev *wdev,
 395                        struct cfg80211_bss *bss,
 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 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
 407 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
 408                                    struct key_params *params, int key_idx,
 409                                    bool pairwise, const u8 *mac_addr);
 410 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
 411                              size_t ie_len, u16 reason, bool from_ap);
 412 void cfg80211_sme_scan_done(struct net_device *dev);
 413 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
 414 void cfg80211_sme_disassoc(struct net_device *dev,
 415                            struct cfg80211_internal_bss *bss);
 416 void __cfg80211_scan_done(struct work_struct *wk);
 417 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
 418 void __cfg80211_sched_scan_results(struct work_struct *wk);
 419 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
 420                                bool driver_initiated);
 421 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
 422 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
 423                           struct net_device *dev, enum nl80211_iftype ntype,
 424                           u32 *flags, struct vif_params *params);
 425 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
 426 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
 427
 428 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
 429                                  struct wireless_dev *wdev,
 430                                  enum nl80211_iftype iftype,
 431                                  struct ieee80211_channel *chan,
 432                                  enum cfg80211_chan_mode chanmode,
 433                                  u8 radar_detect);
 434
 435 /**
 436  * cfg80211_chandef_dfs_required - checks if radar detection is required
 437  * @wiphy: the wiphy to validate against
 438  * @chandef: the channel definition to check
 439  * Return: 1 if radar detection is required, 0 if it is not, < 0 on error
 440  */
 441 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
 442                                   const struct cfg80211_chan_def *c);
 443
 444 void cfg80211_set_dfs_state(struct wiphy *wiphy,
 445                             const struct cfg80211_chan_def *chandef,
 446                             enum nl80211_dfs_state dfs_state);
 447
 448 void cfg80211_dfs_channels_update_work(struct work_struct *work);
 449
 450
 451 static inline int
 452 cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
 453                               struct wireless_dev *wdev,
 454                               enum nl80211_iftype iftype)
 455 {
 456         return cfg80211_can_use_iftype_chan(rdev, wdev, iftype, NULL,
 457                                             CHAN_MODE_UNDEFINED, 0);
 458 }
 459
 460 static inline int
 461 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
 462                            enum nl80211_iftype iftype)
 463 {
 464         return cfg80211_can_change_interface(rdev, NULL, iftype);
 465 }
 466
 467 static inline int
 468 cfg80211_can_use_chan(struct cfg80211_registered_device *rdev,
 469                       struct wireless_dev *wdev,
 470                       struct ieee80211_channel *chan,
 471                       enum cfg80211_chan_mode chanmode)
 472 {
 473         return cfg80211_can_use_iftype_chan(rdev, wdev, wdev->iftype,
 474                                             chan, chanmode, 0);
 475 }
 476
 477 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
 478 {
 479         unsigned long end = jiffies;
 480
 481         if (end >= start)
 482                 return jiffies_to_msecs(end - start);
 483
 484         return jiffies_to_msecs(end + (MAX_JIFFY_OFFSET - start) + 1);
 485 }
 486
 487 void
 488 cfg80211_get_chan_state(struct wireless_dev *wdev,
 489                         struct ieee80211_channel **chan,
 490                         enum cfg80211_chan_mode *chanmode);
 491
 492 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
 493                                  struct cfg80211_chan_def *chandef);
 494
 495 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
 496                            const u8 *rates, unsigned int n_rates,
 497                            u32 *mask);
 498
 499 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
 500                                  u32 beacon_int);
 501
 502 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
 503                                enum nl80211_iftype iftype, int num);
 504
 505 void cfg80211_leave(struct cfg80211_registered_device *rdev,
 506                     struct wireless_dev *wdev);
 507
 508 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
 509                               struct wireless_dev *wdev);
 510
 511 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
 512
 513 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
 514 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
 515 #else
 516 /*
 517  * Trick to enable using it as a condition,
 518  * and also not give a warning when it's
 519  * not used that way.
 520  */
 521 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
 522 #endif
 523
 524 #endif /* __NET_WIRELESS_CORE_H */