b8f4630c6ada34cae35ddad13ef45a96a7a30af9
[cascardo/linux.git] / 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 <linux/rtnetlink.h>
17 #include <net/genetlink.h>
18 #include <net/cfg80211.h>
19 #include "reg.h"
20
21
22 #define WIPHY_IDX_INVALID       -1
23
24 struct cfg80211_registered_device {
25         const struct cfg80211_ops *ops;
26         struct list_head list;
27         /* we hold this mutex during any call so that
28          * we cannot do multiple calls at once, and also
29          * to avoid the deregister call to proceed while
30          * any call is in progress */
31         struct mutex mtx;
32
33         /* rfkill support */
34         struct rfkill_ops rfkill_ops;
35         struct rfkill *rfkill;
36         struct work_struct rfkill_sync;
37
38         /* ISO / IEC 3166 alpha2 for which this device is receiving
39          * country IEs on, this can help disregard country IEs from APs
40          * on the same alpha2 quickly. The alpha2 may differ from
41          * cfg80211_regdomain's alpha2 when an intersection has occurred.
42          * If the AP is reconfigured this can also be used to tell us if
43          * the country on the country IE changed. */
44         char country_ie_alpha2[2];
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 */
54         struct mutex devlist_mtx;
55         /* protected by devlist_mtx or RCU */
56         struct list_head wdev_list;
57         int devlist_generation, wdev_id;
58         int opencount; /* also protected by devlist_mtx */
59         wait_queue_head_t dev_wait;
60
61         struct list_head beacon_registrations;
62         spinlock_t beacon_registrations_lock;
63
64         /* protected by RTNL only */
65         int num_running_ifaces;
66         int num_running_monitor_ifaces;
67
68         /* BSSes/scanning */
69         spinlock_t bss_lock;
70         struct list_head bss_list;
71         struct rb_root bss_tree;
72         u32 bss_generation;
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 #ifdef CONFIG_NL80211_TESTMODE
82         struct genl_info *testmode_info;
83 #endif
84
85         struct work_struct conn_work;
86         struct work_struct event_work;
87
88         struct cfg80211_wowlan *wowlan;
89
90         /* must be last because of the way we do wiphy_priv(),
91          * and it should at least be aligned to NETDEV_ALIGN */
92         struct wiphy wiphy __attribute__((__aligned__(NETDEV_ALIGN)));
93 };
94
95 static inline
96 struct cfg80211_registered_device *wiphy_to_dev(struct wiphy *wiphy)
97 {
98         BUG_ON(!wiphy);
99         return container_of(wiphy, struct cfg80211_registered_device, wiphy);
100 }
101
102 static inline void
103 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
104 {
105         int i;
106
107         if (!rdev->wowlan)
108                 return;
109         for (i = 0; i < rdev->wowlan->n_patterns; i++)
110                 kfree(rdev->wowlan->patterns[i].mask);
111         kfree(rdev->wowlan->patterns);
112         kfree(rdev->wowlan);
113 }
114
115 extern struct workqueue_struct *cfg80211_wq;
116 extern struct mutex cfg80211_mutex;
117 extern struct list_head cfg80211_rdev_list;
118 extern int cfg80211_rdev_list_generation;
119
120 static inline void assert_cfg80211_lock(void)
121 {
122         lockdep_assert_held(&cfg80211_mutex);
123 }
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
132         /* must be last because of priv member */
133         struct cfg80211_bss pub;
134 };
135
136 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
137 {
138         return container_of(pub, struct cfg80211_internal_bss, pub);
139 }
140
141 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
142 {
143         atomic_inc(&bss->hold);
144 }
145
146 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
147 {
148         int r = atomic_dec_return(&bss->hold);
149         WARN_ON(r < 0);
150 }
151
152
153 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
154 int get_wiphy_idx(struct wiphy *wiphy);
155
156 /* requires cfg80211_rdev_mutex to be held! */
157 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
158
159 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
160 extern struct cfg80211_registered_device *
161 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
162
163 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
164                           struct net *net);
165
166 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
167 {
168         mutex_lock(&rdev->mtx);
169 }
170
171 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
172 {
173         BUG_ON(IS_ERR(rdev) || !rdev);
174         mutex_unlock(&rdev->mtx);
175 }
176
177 static inline void wdev_lock(struct wireless_dev *wdev)
178         __acquires(wdev)
179 {
180         mutex_lock(&wdev->mtx);
181         __acquire(wdev->mtx);
182 }
183
184 static inline void wdev_unlock(struct wireless_dev *wdev)
185         __releases(wdev)
186 {
187         __release(wdev->mtx);
188         mutex_unlock(&wdev->mtx);
189 }
190
191 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
192 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
193
194 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
195 {
196         ASSERT_RTNL();
197
198         return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
199                rdev->num_running_ifaces > 0;
200 }
201
202 enum cfg80211_event_type {
203         EVENT_CONNECT_RESULT,
204         EVENT_ROAMED,
205         EVENT_DISCONNECTED,
206         EVENT_IBSS_JOINED,
207 };
208
209 struct cfg80211_event {
210         struct list_head list;
211         enum cfg80211_event_type type;
212
213         union {
214                 struct {
215                         u8 bssid[ETH_ALEN];
216                         const u8 *req_ie;
217                         const u8 *resp_ie;
218                         size_t req_ie_len;
219                         size_t resp_ie_len;
220                         u16 status;
221                 } cr;
222                 struct {
223                         const u8 *req_ie;
224                         const u8 *resp_ie;
225                         size_t req_ie_len;
226                         size_t resp_ie_len;
227                         struct cfg80211_bss *bss;
228                 } rm;
229                 struct {
230                         const u8 *ie;
231                         size_t ie_len;
232                         u16 reason;
233                 } dc;
234                 struct {
235                         u8 bssid[ETH_ALEN];
236                 } ij;
237         };
238 };
239
240 struct cfg80211_cached_keys {
241         struct key_params params[6];
242         u8 data[6][WLAN_MAX_KEY_LEN];
243         int def, defmgmt;
244 };
245
246 enum cfg80211_chan_mode {
247         CHAN_MODE_UNDEFINED,
248         CHAN_MODE_SHARED,
249         CHAN_MODE_EXCLUSIVE,
250 };
251
252 struct cfg80211_beacon_registration {
253         struct list_head list;
254         u32 nlportid;
255 };
256
257 /* free object */
258 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
259
260 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
261                                char *newname);
262
263 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
264
265 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
266 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
267                       unsigned long age_secs);
268
269 /* IBSS */
270 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
271                          struct net_device *dev,
272                          struct cfg80211_ibss_params *params,
273                          struct cfg80211_cached_keys *connkeys);
274 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
275                        struct net_device *dev,
276                        struct cfg80211_ibss_params *params,
277                        struct cfg80211_cached_keys *connkeys);
278 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
279 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
280                           struct net_device *dev, bool nowext);
281 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
282                         struct net_device *dev, bool nowext);
283 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
284 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
285                             struct wireless_dev *wdev);
286
287 /* mesh */
288 extern const struct mesh_config default_mesh_config;
289 extern const struct mesh_setup default_mesh_setup;
290 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
291                          struct net_device *dev,
292                          struct mesh_setup *setup,
293                          const struct mesh_config *conf);
294 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
295                        struct net_device *dev,
296                        struct mesh_setup *setup,
297                        const struct mesh_config *conf);
298 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
299                         struct net_device *dev);
300 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
301                               struct wireless_dev *wdev,
302                               struct cfg80211_chan_def *chandef);
303
304 /* AP */
305 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
306                      struct net_device *dev);
307
308 /* MLME */
309 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
310                          struct net_device *dev,
311                          struct ieee80211_channel *chan,
312                          enum nl80211_auth_type auth_type,
313                          const u8 *bssid,
314                          const u8 *ssid, int ssid_len,
315                          const u8 *ie, int ie_len,
316                          const u8 *key, int key_len, int key_idx,
317                          const u8 *sae_data, int sae_data_len);
318 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
319                        struct net_device *dev, struct ieee80211_channel *chan,
320                        enum nl80211_auth_type auth_type, 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_assoc(struct cfg80211_registered_device *rdev,
326                           struct net_device *dev,
327                           struct ieee80211_channel *chan,
328                           const u8 *bssid, const u8 *prev_bssid,
329                           const u8 *ssid, int ssid_len,
330                           const u8 *ie, int ie_len, bool use_mfp,
331                           struct cfg80211_crypto_settings *crypt,
332                           u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
333                           struct ieee80211_ht_cap *ht_capa_mask);
334 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
335                         struct net_device *dev, struct ieee80211_channel *chan,
336                         const u8 *bssid, const u8 *prev_bssid,
337                         const u8 *ssid, int ssid_len,
338                         const u8 *ie, int ie_len, bool use_mfp,
339                         struct cfg80211_crypto_settings *crypt,
340                         u32 assoc_flags, struct ieee80211_ht_cap *ht_capa,
341                         struct ieee80211_ht_cap *ht_capa_mask);
342 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
343                            struct net_device *dev, const u8 *bssid,
344                            const u8 *ie, int ie_len, u16 reason,
345                            bool local_state_change);
346 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
347                          struct net_device *dev, const u8 *bssid,
348                          const u8 *ie, int ie_len, u16 reason,
349                          bool local_state_change);
350 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
351                            struct net_device *dev, const u8 *bssid,
352                            const u8 *ie, int ie_len, u16 reason,
353                            bool local_state_change);
354 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
355                         struct net_device *dev);
356 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
357                                const u8 *req_ie, size_t req_ie_len,
358                                const u8 *resp_ie, size_t resp_ie_len,
359                                u16 status, bool wextev,
360                                struct cfg80211_bss *bss);
361 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
362                                 u16 frame_type, const u8 *match_data,
363                                 int match_len);
364 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
365 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
366 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
367                           struct wireless_dev *wdev,
368                           struct ieee80211_channel *chan, bool offchan,
369                           unsigned int wait, const u8 *buf, size_t len,
370                           bool no_cck, bool dont_wait_for_ack, u64 *cookie);
371 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
372                                const struct ieee80211_ht_cap *ht_capa_mask);
373
374 /* SME */
375 int __cfg80211_connect(struct cfg80211_registered_device *rdev,
376                        struct net_device *dev,
377                        struct cfg80211_connect_params *connect,
378                        struct cfg80211_cached_keys *connkeys,
379                        const u8 *prev_bssid);
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 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
385                           struct net_device *dev, u16 reason,
386                           bool wextev);
387 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
388                         struct net_device *dev, u16 reason,
389                         bool wextev);
390 void __cfg80211_roamed(struct wireless_dev *wdev,
391                        struct cfg80211_bss *bss,
392                        const u8 *req_ie, size_t req_ie_len,
393                        const u8 *resp_ie, size_t resp_ie_len);
394 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
395                               struct wireless_dev *wdev);
396
397 void cfg80211_conn_work(struct work_struct *work);
398 void cfg80211_sme_failed_assoc(struct wireless_dev *wdev);
399 bool cfg80211_sme_failed_reassoc(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_disconnected(struct net_device *dev, const u8 *ie,
407                              size_t ie_len, u16 reason, bool from_ap);
408 void cfg80211_sme_scan_done(struct net_device *dev);
409 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
410 void cfg80211_sme_disassoc(struct net_device *dev,
411                            struct cfg80211_internal_bss *bss);
412 void __cfg80211_scan_done(struct work_struct *wk);
413 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
414 void __cfg80211_sched_scan_results(struct work_struct *wk);
415 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
416                                bool driver_initiated);
417 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
418 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
419                           struct net_device *dev, enum nl80211_iftype ntype,
420                           u32 *flags, struct vif_params *params);
421 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
422 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
423
424 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
425                                  struct wireless_dev *wdev,
426                                  enum nl80211_iftype iftype,
427                                  struct ieee80211_channel *chan,
428                                  enum cfg80211_chan_mode chanmode);
429
430 static inline int
431 cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
432                               struct wireless_dev *wdev,
433                               enum nl80211_iftype iftype)
434 {
435         return cfg80211_can_use_iftype_chan(rdev, wdev, iftype, NULL,
436                                             CHAN_MODE_UNDEFINED);
437 }
438
439 static inline int
440 cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
441                            enum nl80211_iftype iftype)
442 {
443         return cfg80211_can_change_interface(rdev, NULL, iftype);
444 }
445
446 static inline int
447 cfg80211_can_use_chan(struct cfg80211_registered_device *rdev,
448                       struct wireless_dev *wdev,
449                       struct ieee80211_channel *chan,
450                       enum cfg80211_chan_mode chanmode)
451 {
452         return cfg80211_can_use_iftype_chan(rdev, wdev, wdev->iftype,
453                                             chan, chanmode);
454 }
455
456 void
457 cfg80211_get_chan_state(struct wireless_dev *wdev,
458                         struct ieee80211_channel **chan,
459                         enum cfg80211_chan_mode *chanmode);
460
461 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
462                                  struct cfg80211_chan_def *chandef);
463
464 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
465                            const u8 *rates, unsigned int n_rates,
466                            u32 *mask);
467
468 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
469                                  u32 beacon_int);
470
471 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
472                                enum nl80211_iftype iftype, int num);
473
474 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
475
476 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
477 #define CFG80211_DEV_WARN_ON(cond)      WARN_ON(cond)
478 #else
479 /*
480  * Trick to enable using it as a condition,
481  * and also not give a warning when it's
482  * not used that way.
483  */
484 #define CFG80211_DEV_WARN_ON(cond)      ({bool __r = (cond); __r; })
485 #endif
486
487 #endif /* __NET_WIRELESS_CORE_H */