ath5k: fix incorrect use of drvdata in PCI suspend/resume code
[linux-2.6-block.git] / net / wireless / core.h
CommitLineData
704232c2
JB
1/*
2 * Wireless configuration interface internals.
3 *
5f2aa25e 4 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
704232c2
JB
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>
2a519311
JB
11#include <linux/kref.h>
12#include <linux/rbtree.h>
1ac61302 13#include <linux/debugfs.h>
1f87f7d3
JB
14#include <linux/rfkill.h>
15#include <linux/workqueue.h>
704232c2 16#include <net/genetlink.h>
704232c2 17#include <net/cfg80211.h>
3f2355cb 18#include "reg.h"
704232c2
JB
19
20struct cfg80211_registered_device {
3dcf670b 21 const struct cfg80211_ops *ops;
704232c2
JB
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
1f87f7d3
JB
29 /* rfkill support */
30 struct rfkill_ops rfkill_ops;
31 struct rfkill *rfkill;
32 struct work_struct rfkill_sync;
33
3f2355cb
LR
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
704232c2 46 /* wiphy index, internal only */
b5850a7a 47 int wiphy_idx;
704232c2
JB
48
49 /* associate netdev list */
50 struct mutex devlist_mtx;
5f2aa25e 51 /* protected by devlist_mtx or RCU */
704232c2 52 struct list_head netdev_list;
f5ea9120 53 int devlist_generation;
ad002395
JB
54 int opencount; /* also protected by devlist_mtx */
55 wait_queue_head_t dev_wait;
704232c2 56
2a519311
JB
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 */
807f8a8c 63 struct cfg80211_sched_scan_request *sched_scan_req;
cb3a8eec 64 unsigned long suspend_at;
667503dd 65 struct work_struct scan_done_wk;
807f8a8c 66 struct work_struct sched_scan_results_wk;
2a519311 67
aff89a9b
JB
68#ifdef CONFIG_NL80211_TESTMODE
69 struct genl_info *testmode_info;
70#endif
71
6829c878 72 struct work_struct conn_work;
667503dd 73 struct work_struct event_work;
6829c878 74
ff1b6e69
JB
75 struct cfg80211_wowlan *wowlan;
76
704232c2
JB
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
82static inline
83struct 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
85fd129a
LR
89/* Note 0 is valid, hence phy0 */
90static inline
91bool wiphy_idx_valid(int wiphy_idx)
92{
a02cec21 93 return wiphy_idx >= 0;
85fd129a
LR
94}
95
ff1b6e69
JB
96static inline void
97cfg80211_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}
e60d7443
AB
108
109extern struct workqueue_struct *cfg80211_wq;
a1794390 110extern struct mutex cfg80211_mutex;
79c97e97 111extern struct list_head cfg80211_rdev_list;
f5ea9120 112extern int cfg80211_rdev_list_generation;
704232c2 113
46a5ebaf
JB
114static inline void assert_cfg80211_lock(void)
115{
116 lockdep_assert_held(&cfg80211_mutex);
117}
761cf7ec 118
806a9e39
LR
119/*
120 * You can use this to mark a wiphy_idx as not having an associated wiphy.
79c97e97 121 * It guarantees cfg80211_rdev_by_wiphy_idx(wiphy_idx) will return NULL
806a9e39
LR
122 */
123#define WIPHY_IDX_STALE -1
124
2a519311
JB
125struct cfg80211_internal_bss {
126 struct list_head list;
127 struct rb_node rbn;
128 unsigned long ts;
129 struct kref ref;
19957bb3 130 atomic_t hold;
34a6eddb
JM
131 bool beacon_ies_allocated;
132 bool proberesp_ies_allocated;
a08c1c1a 133
2a519311
JB
134 /* must be last because of priv member */
135 struct cfg80211_bss pub;
136};
137
19957bb3
JB
138static 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
df7fc0f9
JB
143static inline void cfg80211_ref_bss(struct cfg80211_internal_bss *bss)
144{
145 kref_get(&bss->ref);
146}
147
19957bb3
JB
148static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
149{
150 atomic_inc(&bss->hold);
151}
152
153static 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
79c97e97 160struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
806a9e39
LR
161int get_wiphy_idx(struct wiphy *wiphy);
162
4bbf4d56 163struct cfg80211_registered_device *
79c97e97 164__cfg80211_rdev_from_info(struct genl_info *info);
4bbf4d56 165
55682965
JB
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 *
4d0c8aea 172 * This means that you need to call cfg80211_unlock_rdev()
a1794390 173 * before being allowed to acquire &cfg80211_mutex!
55682965
JB
174 *
175 * This is necessary because we need to lock the global
176 * mutex to get an item off the list safely, and then
79c97e97 177 * we lock the rdev mutex so it doesn't go away under us.
55682965 178 *
a1794390 179 * We don't want to keep cfg80211_mutex locked
55682965
JB
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 */
186extern struct cfg80211_registered_device *
187cfg80211_get_dev_from_info(struct genl_info *info);
188
79c97e97 189/* requires cfg80211_rdev_mutex to be held! */
806a9e39
LR
190struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
191
55682965
JB
192/* identical to cfg80211_get_dev_from_info but only operate on ifindex */
193extern struct cfg80211_registered_device *
463d0183
JB
194cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
195
196int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
197 struct net *net);
55682965 198
79c97e97 199static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
667503dd 200{
79c97e97 201 mutex_lock(&rdev->mtx);
667503dd
JB
202}
203
79c97e97 204static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
4d0c8aea 205{
79c97e97
JB
206 BUG_ON(IS_ERR(rdev) || !rdev);
207 mutex_unlock(&rdev->mtx);
4d0c8aea 208}
55682965 209
667503dd
JB
210static inline void wdev_lock(struct wireless_dev *wdev)
211 __acquires(wdev)
212{
213 mutex_lock(&wdev->mtx);
214 __acquire(wdev->mtx);
215}
216
217static inline void wdev_unlock(struct wireless_dev *wdev)
218 __releases(wdev)
219{
220 __release(wdev->mtx);
221 mutex_unlock(&wdev->mtx);
222}
223
46a5ebaf
JB
224#define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
225#define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
667503dd
JB
226
227enum cfg80211_event_type {
228 EVENT_CONNECT_RESULT,
229 EVENT_ROAMED,
230 EVENT_DISCONNECTED,
231 EVENT_IBSS_JOINED,
232};
233
234struct 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 {
ed9d0102 248 struct ieee80211_channel *channel;
667503dd
JB
249 u8 bssid[ETH_ALEN];
250 const u8 *req_ie;
251 const u8 *resp_ie;
252 size_t req_ie_len;
253 size_t resp_ie_len;
254 } rm;
255 struct {
256 const u8 *ie;
257 size_t ie_len;
258 u16 reason;
259 } dc;
260 struct {
261 u8 bssid[ETH_ALEN];
262 } ij;
263 };
264};
265
fffd0934
JB
266struct cfg80211_cached_keys {
267 struct key_params params[6];
268 u8 data[6][WLAN_MAX_KEY_LEN];
269 int def, defmgmt;
270};
271
667503dd 272
704232c2 273/* free object */
79c97e97 274extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
704232c2 275
79c97e97 276extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
55682965
JB
277 char *newname);
278
8318d78a 279void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
7db90f4a
LR
280void wiphy_update_regulatory(struct wiphy *wiphy,
281 enum nl80211_reg_initiator setby);
8318d78a 282
2a519311 283void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
cb3a8eec
DW
284void cfg80211_bss_age(struct cfg80211_registered_device *dev,
285 unsigned long age_secs);
2a519311 286
04a773ad 287/* IBSS */
667503dd
JB
288int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
289 struct net_device *dev,
fffd0934
JB
290 struct cfg80211_ibss_params *params,
291 struct cfg80211_cached_keys *connkeys);
04a773ad
JB
292int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
293 struct net_device *dev,
fffd0934
JB
294 struct cfg80211_ibss_params *params,
295 struct cfg80211_cached_keys *connkeys);
9d308429 296void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
98d3a7ca
JB
297int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
298 struct net_device *dev, bool nowext);
04a773ad 299int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
9d308429 300 struct net_device *dev, bool nowext);
667503dd 301void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
fffd0934
JB
302int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
303 struct wireless_dev *wdev);
04a773ad 304
29cbe68c
JB
305/* mesh */
306extern const struct mesh_config default_mesh_config;
c80d545d 307extern const struct mesh_setup default_mesh_setup;
29cbe68c
JB
308int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
309 struct net_device *dev,
c80d545d 310 const struct mesh_setup *setup,
29cbe68c
JB
311 const struct mesh_config *conf);
312int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
313 struct net_device *dev,
c80d545d 314 const struct mesh_setup *setup,
29cbe68c
JB
315 const struct mesh_config *conf);
316int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
317 struct net_device *dev);
318
19957bb3 319/* MLME */
667503dd
JB
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,
fffd0934 326 const u8 *ie, int ie_len,
d5cdfacb
JM
327 const u8 *key, int key_len, int key_idx,
328 bool local_state_change);
19957bb3
JB
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,
fffd0934 333 const u8 *ie, int ie_len,
d5cdfacb
JM
334 const u8 *key, int key_len, int key_idx,
335 bool local_state_change);
667503dd
JB
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);
19957bb3
JB
343int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
344 struct net_device *dev, struct ieee80211_channel *chan,
3e5d7649
JB
345 const u8 *bssid, const u8 *prev_bssid,
346 const u8 *ssid, int ssid_len,
19957bb3
JB
347 const u8 *ie, int ie_len, bool use_mfp,
348 struct cfg80211_crypto_settings *crypt);
667503dd
JB
349int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
350 struct net_device *dev, const u8 *bssid,
d5cdfacb
JM
351 const u8 *ie, int ie_len, u16 reason,
352 bool local_state_change);
19957bb3
JB
353int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
354 struct net_device *dev, const u8 *bssid,
d5cdfacb
JM
355 const u8 *ie, int ie_len, u16 reason,
356 bool local_state_change);
19957bb3
JB
357int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
358 struct net_device *dev, const u8 *bssid,
d5cdfacb
JM
359 const u8 *ie, int ie_len, u16 reason,
360 bool local_state_change);
19957bb3
JB
361void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
362 struct net_device *dev);
667503dd
JB
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,
df7fc0f9
JB
366 u16 status, bool wextev,
367 struct cfg80211_bss *bss);
2e161f78
JB
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,
f7ca38df 375 struct ieee80211_channel *chan, bool offchan,
2e161f78 376 enum nl80211_channel_type channel_type,
f7ca38df 377 bool channel_type_valid, unsigned int wait,
2e161f78 378 const u8 *buf, size_t len, u64 *cookie);
19957bb3 379
b23aa676 380/* SME */
667503dd
JB
381int __cfg80211_connect(struct cfg80211_registered_device *rdev,
382 struct net_device *dev,
fffd0934 383 struct cfg80211_connect_params *connect,
f401a6f7
JB
384 struct cfg80211_cached_keys *connkeys,
385 const u8 *prev_bssid);
b23aa676
SO
386int cfg80211_connect(struct cfg80211_registered_device *rdev,
387 struct net_device *dev,
fffd0934
JB
388 struct cfg80211_connect_params *connect,
389 struct cfg80211_cached_keys *connkeys);
667503dd
JB
390int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
391 struct net_device *dev, u16 reason,
392 bool wextev);
b23aa676 393int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
f2129354
JB
394 struct net_device *dev, u16 reason,
395 bool wextev);
ed9d0102
JM
396void __cfg80211_roamed(struct wireless_dev *wdev,
397 struct ieee80211_channel *channel,
398 const u8 *bssid,
667503dd
JB
399 const u8 *req_ie, size_t req_ie_len,
400 const u8 *resp_ie, size_t resp_ie_len);
fffd0934
JB
401int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
402 struct wireless_dev *wdev);
b23aa676 403
6829c878 404void cfg80211_conn_work(struct work_struct *work);
7d930bc3 405void cfg80211_sme_failed_assoc(struct wireless_dev *wdev);
f401a6f7 406bool cfg80211_sme_failed_reassoc(struct wireless_dev *wdev);
6829c878 407
08645126 408/* internal helpers */
fffd0934
JB
409int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
410 struct key_params *params, int key_idx,
e31b8213 411 bool pairwise, const u8 *mac_addr);
667503dd 412void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
6829c878
JB
413 size_t ie_len, u16 reason, bool from_ap);
414void cfg80211_sme_scan_done(struct net_device *dev);
415void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
19957bb3 416void cfg80211_sme_disassoc(struct net_device *dev, int idx);
667503dd 417void __cfg80211_scan_done(struct work_struct *wk);
01a0ac41 418void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
807f8a8c
LC
419void __cfg80211_sched_scan_results(struct work_struct *wk);
420int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
421 bool driver_initiated);
fffd0934 422void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
3d54d255
JB
423int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
424 struct net_device *dev, enum nl80211_iftype ntype,
425 u32 *flags, struct vif_params *params);
426void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
08645126 427
7527a782
JB
428int cfg80211_can_change_interface(struct cfg80211_registered_device *rdev,
429 struct wireless_dev *wdev,
430 enum nl80211_iftype iftype);
431
432static inline int
433cfg80211_can_add_interface(struct cfg80211_registered_device *rdev,
434 enum nl80211_iftype iftype)
435{
436 return cfg80211_can_change_interface(rdev, NULL, iftype);
437}
438
9588bbd5
JM
439struct ieee80211_channel *
440rdev_freq_to_chan(struct cfg80211_registered_device *rdev,
441 int freq, enum nl80211_channel_type channel_type);
f444de05
JB
442int cfg80211_set_freq(struct cfg80211_registered_device *rdev,
443 struct wireless_dev *wdev, int freq,
444 enum nl80211_channel_type channel_type);
59bbb6f7 445
254416aa
JL
446u16 cfg80211_calculate_bitrate(struct rate_info *rate);
447
56d1893d
JB
448int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
449 u32 beacon_int);
450
f7969969
JB
451#ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
452#define CFG80211_DEV_WARN_ON(cond) WARN_ON(cond)
453#else
454/*
455 * Trick to enable using it as a condition,
456 * and also not give a warning when it's
457 * not used that way.
458 */
459#define CFG80211_DEV_WARN_ON(cond) ({bool __r = (cond); __r; })
460#endif
461
704232c2 462#endif /* __NET_WIRELESS_CORE_H */