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