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 <net/genetlink.h>
17 #include <net/cfg80211.h>
18 #include "reg.h"
19
20 struct cfg80211_registered_device {
21 const struct cfg80211_ops *ops;
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
29 /* rfkill support */
30 struct rfkill_ops rfkill_ops;
31 struct rfkill *rfkill;
32 struct work_struct rfkill_sync;
33
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
46 /* wiphy index, internal only */
47 int wiphy_idx;
48
49 /* associate netdev list */
50 struct mutex devlist_mtx;
51 /* protected by devlist_mtx or RCU */
52 struct list_head netdev_list;
53 int devlist_generation;
54 int opencount; /* also protected by devlist_mtx */
55 wait_queue_head_t dev_wait;
56
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 */
63 unsigned long suspend_at;
64 struct work_struct scan_done_wk;
65
66 #ifdef CONFIG_NL80211_TESTMODE
67 struct genl_info *testmode_info;
68 #endif
69
70 struct work_struct conn_work;
71 struct work_struct event_work;
72
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
78 static inline
wiphy_to_dev(struct wiphy * wiphy)79 struct 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
85 /* Note 0 is valid, hence phy0 */
86 static inline
wiphy_idx_valid(int wiphy_idx)87 bool wiphy_idx_valid(int wiphy_idx)
88 {
89 return wiphy_idx >= 0;
90 }
91
92
93 extern struct workqueue_struct *cfg80211_wq;
94 extern struct mutex cfg80211_mutex;
95 extern struct list_head cfg80211_rdev_list;
96 extern int cfg80211_rdev_list_generation;
97
assert_cfg80211_lock(void)98 static inline void assert_cfg80211_lock(void)
99 {
100 lockdep_assert_held(&cfg80211_mutex);
101 }
102
103 /*
104 * You can use this to mark a wiphy_idx as not having an associated wiphy.
105 * It guarantees cfg80211_rdev_by_wiphy_idx(wiphy_idx) will return NULL
106 */
107 #define WIPHY_IDX_STALE -1
108
109 struct cfg80211_internal_bss {
110 struct list_head list;
111 struct rb_node rbn;
112 unsigned long ts;
113 struct kref ref;
114 atomic_t hold;
115 bool beacon_ies_allocated;
116 bool proberesp_ies_allocated;
117
118 /* must be last because of priv member */
119 struct cfg80211_bss pub;
120 };
121
bss_from_pub(struct cfg80211_bss * pub)122 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
123 {
124 return container_of(pub, struct cfg80211_internal_bss, pub);
125 }
126
cfg80211_ref_bss(struct cfg80211_internal_bss * bss)127 static inline void cfg80211_ref_bss(struct cfg80211_internal_bss *bss)
128 {
129 kref_get(&bss->ref);
130 }
131
cfg80211_hold_bss(struct cfg80211_internal_bss * bss)132 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
133 {
134 atomic_inc(&bss->hold);
135 }
136
cfg80211_unhold_bss(struct cfg80211_internal_bss * bss)137 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
138 {
139 int r = atomic_dec_return(&bss->hold);
140 WARN_ON(r < 0);
141 }
142
143
144 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
145 int get_wiphy_idx(struct wiphy *wiphy);
146
147 struct cfg80211_registered_device *
148 __cfg80211_rdev_from_info(struct genl_info *info);
149
150 /*
151 * This function returns a pointer to the driver
152 * that the genl_info item that is passed refers to.
153 * If successful, it returns non-NULL and also locks
154 * the driver's mutex!
155 *
156 * This means that you need to call cfg80211_unlock_rdev()
157 * before being allowed to acquire &cfg80211_mutex!
158 *
159 * This is necessary because we need to lock the global
160 * mutex to get an item off the list safely, and then
161 * we lock the rdev mutex so it doesn't go away under us.
162 *
163 * We don't want to keep cfg80211_mutex locked
164 * for all the time in order to allow requests on
165 * other interfaces to go through at the same time.
166 *
167 * The result of this can be a PTR_ERR and hence must
168 * be checked with IS_ERR() for errors.
169 */
170 extern struct cfg80211_registered_device *
171 cfg80211_get_dev_from_info(struct genl_info *info);
172
173 /* requires cfg80211_rdev_mutex to be held! */
174 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
175
176 /* identical to cfg80211_get_dev_from_info but only operate on ifindex */
177 extern struct cfg80211_registered_device *
178 cfg80211_get_dev_from_ifindex(struct net *net, int ifindex);
179
180 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
181 struct net *net);
182
cfg80211_lock_rdev(struct cfg80211_registered_device * rdev)183 static inline void cfg80211_lock_rdev(struct cfg80211_registered_device *rdev)
184 {
185 mutex_lock(&rdev->mtx);
186 }
187
cfg80211_unlock_rdev(struct cfg80211_registered_device * rdev)188 static inline void cfg80211_unlock_rdev(struct cfg80211_registered_device *rdev)
189 {
190 BUG_ON(IS_ERR(rdev) || !rdev);
191 mutex_unlock(&rdev->mtx);
192 }
193
wdev_lock(struct wireless_dev * wdev)194 static inline void wdev_lock(struct wireless_dev *wdev)
195 __acquires(wdev)
196 {
197 mutex_lock(&wdev->mtx);
198 __acquire(wdev->mtx);
199 }
200
wdev_unlock(struct wireless_dev * wdev)201 static inline void wdev_unlock(struct wireless_dev *wdev)
202 __releases(wdev)
203 {
204 __release(wdev->mtx);
205 mutex_unlock(&wdev->mtx);
206 }
207
208 #define ASSERT_RDEV_LOCK(rdev) lockdep_assert_held(&(rdev)->mtx)
209 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
210
211 enum cfg80211_event_type {
212 EVENT_CONNECT_RESULT,
213 EVENT_ROAMED,
214 EVENT_DISCONNECTED,
215 EVENT_IBSS_JOINED,
216 };
217
218 struct cfg80211_event {
219 struct list_head list;
220 enum cfg80211_event_type type;
221
222 union {
223 struct {
224 u8 bssid[ETH_ALEN];
225 const u8 *req_ie;
226 const u8 *resp_ie;
227 size_t req_ie_len;
228 size_t resp_ie_len;
229 u16 status;
230 } cr;
231 struct {
232 u8 bssid[ETH_ALEN];
233 const u8 *req_ie;
234 const u8 *resp_ie;
235 size_t req_ie_len;
236 size_t resp_ie_len;
237 } rm;
238 struct {
239 const u8 *ie;
240 size_t ie_len;
241 u16 reason;
242 } dc;
243 struct {
244 u8 bssid[ETH_ALEN];
245 } ij;
246 };
247 };
248
249 struct cfg80211_cached_keys {
250 struct key_params params[6];
251 u8 data[6][WLAN_MAX_KEY_LEN];
252 int def, defmgmt;
253 };
254
255
256 /* free object */
257 extern void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
258
259 extern int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
260 char *newname);
261
262 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
263 void wiphy_update_regulatory(struct wiphy *wiphy,
264 enum nl80211_reg_initiator setby);
265
266 void cfg80211_bss_expire(struct cfg80211_registered_device *dev);
267 void cfg80211_bss_age(struct cfg80211_registered_device *dev,
268 unsigned long age_secs);
269
270 /* IBSS */
271 int __cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
272 struct net_device *dev,
273 struct cfg80211_ibss_params *params,
274 struct cfg80211_cached_keys *connkeys);
275 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
276 struct net_device *dev,
277 struct cfg80211_ibss_params *params,
278 struct cfg80211_cached_keys *connkeys);
279 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
280 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
281 struct net_device *dev, bool nowext);
282 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
283 struct net_device *dev, bool nowext);
284 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid);
285 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
286 struct wireless_dev *wdev);
287
288 /* mesh */
289 extern const struct mesh_config default_mesh_config;
290 extern const struct mesh_setup default_mesh_setup;
291 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
292 struct net_device *dev,
293 const struct mesh_setup *setup,
294 const struct mesh_config *conf);
295 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
296 struct net_device *dev,
297 const struct mesh_setup *setup,
298 const struct mesh_config *conf);
299 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
300 struct net_device *dev);
301
302 /* MLME */
303 int __cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
304 struct net_device *dev,
305 struct ieee80211_channel *chan,
306 enum nl80211_auth_type auth_type,
307 const u8 *bssid,
308 const u8 *ssid, int ssid_len,
309 const u8 *ie, int ie_len,
310 const u8 *key, int key_len, int key_idx,
311 bool local_state_change);
312 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
313 struct net_device *dev, struct ieee80211_channel *chan,
314 enum nl80211_auth_type auth_type, const u8 *bssid,
315 const u8 *ssid, int ssid_len,
316 const u8 *ie, int ie_len,
317 const u8 *key, int key_len, int key_idx,
318 bool local_state_change);
319 int __cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
320 struct net_device *dev,
321 struct ieee80211_channel *chan,
322 const u8 *bssid, const u8 *prev_bssid,
323 const u8 *ssid, int ssid_len,
324 const u8 *ie, int ie_len, bool use_mfp,
325 struct cfg80211_crypto_settings *crypt);
326 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
327 struct net_device *dev, 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 int __cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
333 struct net_device *dev, const u8 *bssid,
334 const u8 *ie, int ie_len, u16 reason,
335 bool local_state_change);
336 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
337 struct net_device *dev, const u8 *bssid,
338 const u8 *ie, int ie_len, u16 reason,
339 bool local_state_change);
340 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
341 struct net_device *dev, const u8 *bssid,
342 const u8 *ie, int ie_len, u16 reason,
343 bool local_state_change);
344 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
345 struct net_device *dev);
346 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
347 const u8 *req_ie, size_t req_ie_len,
348 const u8 *resp_ie, size_t resp_ie_len,
349 u16 status, bool wextev,
350 struct cfg80211_bss *bss);
351 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
352 u16 frame_type, const u8 *match_data,
353 int match_len);
354 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
355 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
356 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
357 struct net_device *dev,
358 struct ieee80211_channel *chan, bool offchan,
359 enum nl80211_channel_type channel_type,
360 bool channel_type_valid, unsigned int wait,
361 const u8 *buf, size_t len, u64 *cookie);
362
363 /* SME */
364 int __cfg80211_connect(struct cfg80211_registered_device *rdev,
365 struct net_device *dev,
366 struct cfg80211_connect_params *connect,
367 struct cfg80211_cached_keys *connkeys,
368 const u8 *prev_bssid);
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 int __cfg80211_disconnect(struct cfg80211_registered_device *rdev,
374 struct net_device *dev, u16 reason,
375 bool wextev);
376 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
377 struct net_device *dev, u16 reason,
378 bool wextev);
379 void __cfg80211_roamed(struct wireless_dev *wdev, const u8 *bssid,
380 const u8 *req_ie, size_t req_ie_len,
381 const u8 *resp_ie, size_t resp_ie_len);
382 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
383 struct wireless_dev *wdev);
384
385 void cfg80211_conn_work(struct work_struct *work);
386 void cfg80211_sme_failed_assoc(struct wireless_dev *wdev);
387 bool cfg80211_sme_failed_reassoc(struct wireless_dev *wdev);
388
389 /* internal helpers */
390 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
391 struct key_params *params, int key_idx,
392 bool pairwise, const u8 *mac_addr);
393 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
394 size_t ie_len, u16 reason, bool from_ap);
395 void cfg80211_sme_scan_done(struct net_device *dev);
396 void cfg80211_sme_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
397 void cfg80211_sme_disassoc(struct net_device *dev, int idx);
398 void __cfg80211_scan_done(struct work_struct *wk);
399 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev, bool leak);
400 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
401 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
402 struct net_device *dev, enum nl80211_iftype ntype,
403 u32 *flags, struct vif_params *params);
404 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
405
406 struct ieee80211_channel *
407 rdev_freq_to_chan(struct cfg80211_registered_device *rdev,
408 int freq, enum nl80211_channel_type channel_type);
409 int cfg80211_set_freq(struct cfg80211_registered_device *rdev,
410 struct wireless_dev *wdev, int freq,
411 enum nl80211_channel_type channel_type);
412
413 u16 cfg80211_calculate_bitrate(struct rate_info *rate);
414
415 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
416 #define CFG80211_DEV_WARN_ON(cond) WARN_ON(cond)
417 #else
418 /*
419 * Trick to enable using it as a condition,
420 * and also not give a warning when it's
421 * not used that way.
422 */
423 #define CFG80211_DEV_WARN_ON(cond) ({bool __r = (cond); __r; })
424 #endif
425
426 #endif /* __NET_WIRELESS_CORE_H */
427