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