cfg80211: remove erroneous comment
[deliverable/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/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;
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 struct cfg80211_bss *bss;
218 u16 status;
219 } cr;
220 struct {
221 const u8 *req_ie;
222 const u8 *resp_ie;
223 size_t req_ie_len;
224 size_t resp_ie_len;
225 struct cfg80211_bss *bss;
226 } rm;
227 struct {
228 const u8 *ie;
229 size_t ie_len;
230 u16 reason;
231 bool locally_generated;
232 } dc;
233 struct {
234 u8 bssid[ETH_ALEN];
235 struct ieee80211_channel *channel;
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 struct cfg80211_iface_destroy {
258 struct list_head list;
259 u32 nlportid;
260 };
261
262 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
263
264 /* free object */
265 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
266
267 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
268 char *newname);
269
270 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
271
272 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
273 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
274 unsigned long age_secs);
275
276 /* IBSS */
277 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
278 struct net_device *dev,
279 struct cfg80211_ibss_params *params,
280 struct cfg80211_cached_keys *connkeys);
281 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
282 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
283 struct net_device *dev, bool nowext);
284 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
285 struct net_device *dev, bool nowext);
286 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
287 struct ieee80211_channel *channel);
288 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
289 struct wireless_dev *wdev);
290
291 /* mesh */
292 extern const struct mesh_config default_mesh_config;
293 extern const struct mesh_setup default_mesh_setup;
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_join_mesh(struct cfg80211_registered_device *rdev,
299 struct net_device *dev,
300 struct mesh_setup *setup,
301 const struct mesh_config *conf);
302 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
303 struct net_device *dev);
304 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
305 struct net_device *dev);
306 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
307 struct wireless_dev *wdev,
308 struct cfg80211_chan_def *chandef);
309
310 /* OCB */
311 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
312 struct net_device *dev,
313 struct ocb_setup *setup);
314 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
315 struct net_device *dev,
316 struct ocb_setup *setup);
317 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
318 struct net_device *dev);
319 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
320 struct net_device *dev);
321
322 /* AP */
323 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
324 struct net_device *dev, bool notify);
325 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
326 struct net_device *dev, bool notify);
327
328 /* MLME */
329 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
330 struct net_device *dev,
331 struct ieee80211_channel *chan,
332 enum nl80211_auth_type auth_type,
333 const u8 *bssid,
334 const u8 *ssid, int ssid_len,
335 const u8 *ie, int ie_len,
336 const u8 *key, int key_len, int key_idx,
337 const u8 *sae_data, int sae_data_len);
338 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
339 struct net_device *dev,
340 struct ieee80211_channel *chan,
341 const u8 *bssid,
342 const u8 *ssid, int ssid_len,
343 struct cfg80211_assoc_request *req);
344 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
345 struct net_device *dev, const u8 *bssid,
346 const u8 *ie, int ie_len, u16 reason,
347 bool local_state_change);
348 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
349 struct net_device *dev, const u8 *bssid,
350 const u8 *ie, int ie_len, u16 reason,
351 bool local_state_change);
352 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
353 struct net_device *dev);
354 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
355 u16 frame_type, const u8 *match_data,
356 int match_len);
357 void cfg80211_mlme_unreg_wk(struct work_struct *wk);
358 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
359 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
360 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
361 struct wireless_dev *wdev,
362 struct cfg80211_mgmt_tx_params *params,
363 u64 *cookie);
364 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
365 const struct ieee80211_ht_cap *ht_capa_mask);
366 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
367 const struct ieee80211_vht_cap *vht_capa_mask);
368
369 /* SME events */
370 int cfg80211_connect(struct cfg80211_registered_device *rdev,
371 struct net_device *dev,
372 struct cfg80211_connect_params *connect,
373 struct cfg80211_cached_keys *connkeys,
374 const u8 *prev_bssid);
375 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
376 const u8 *req_ie, size_t req_ie_len,
377 const u8 *resp_ie, size_t resp_ie_len,
378 u16 status, bool wextev,
379 struct cfg80211_bss *bss);
380 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
381 size_t ie_len, u16 reason, bool from_ap);
382 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
383 struct net_device *dev, u16 reason,
384 bool wextev);
385 void __cfg80211_roamed(struct wireless_dev *wdev,
386 struct cfg80211_bss *bss,
387 const u8 *req_ie, size_t req_ie_len,
388 const u8 *resp_ie, size_t resp_ie_len);
389 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
390 struct wireless_dev *wdev);
391
392 /* SME implementation */
393 void cfg80211_conn_work(struct work_struct *work);
394 void cfg80211_sme_scan_done(struct net_device *dev);
395 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
396 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
397 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
398 void cfg80211_sme_deauth(struct wireless_dev *wdev);
399 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
400 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
401
402 /* internal helpers */
403 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
404 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
405 struct key_params *params, int key_idx,
406 bool pairwise, const u8 *mac_addr);
407 void __cfg80211_scan_done(struct work_struct *wk);
408 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
409 bool send_message);
410 void __cfg80211_sched_scan_results(struct work_struct *wk);
411 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
412 bool driver_initiated);
413 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
414 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
415 struct net_device *dev, enum nl80211_iftype ntype,
416 u32 *flags, struct vif_params *params);
417 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
418 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
419
420 /**
421 * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable
422 * @wiphy: the wiphy to validate against
423 * @chandef: the channel definition to check
424 *
425 * Checks if chandef is usable and we can/need start CAC on such channel.
426 *
427 * Return: Return true if all channels available and at least
428 * one channel require CAC (NL80211_DFS_USABLE)
429 */
430 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
431 const struct cfg80211_chan_def *chandef);
432
433 void cfg80211_set_dfs_state(struct wiphy *wiphy,
434 const struct cfg80211_chan_def *chandef,
435 enum nl80211_dfs_state dfs_state);
436
437 void cfg80211_dfs_channels_update_work(struct work_struct *work);
438
439 unsigned int
440 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
441 const struct cfg80211_chan_def *chandef);
442
443 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
444 {
445 unsigned long end = jiffies;
446
447 if (end >= start)
448 return jiffies_to_msecs(end - start);
449
450 return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
451 }
452
453 void
454 cfg80211_get_chan_state(struct wireless_dev *wdev,
455 struct ieee80211_channel **chan,
456 enum cfg80211_chan_mode *chanmode,
457 u8 *radar_detect);
458
459 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
460 struct cfg80211_chan_def *chandef);
461
462 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
463 const u8 *rates, unsigned int n_rates,
464 u32 *mask);
465
466 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
467 u32 beacon_int);
468
469 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
470 enum nl80211_iftype iftype, int num);
471
472 void __cfg80211_leave(struct cfg80211_registered_device *rdev,
473 struct wireless_dev *wdev);
474 void cfg80211_leave(struct cfg80211_registered_device *rdev,
475 struct wireless_dev *wdev);
476
477 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
478 struct wireless_dev *wdev);
479
480 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
481
482 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
483 #define CFG80211_DEV_WARN_ON(cond) WARN_ON(cond)
484 #else
485 /*
486 * Trick to enable using it as a condition,
487 * and also not give a warning when it's
488 * not used that way.
489 */
490 #define CFG80211_DEV_WARN_ON(cond) ({bool __r = (cond); __r; })
491 #endif
492
493 #endif /* __NET_WIRELESS_CORE_H */
This page took 0.083487 seconds and 5 git commands to generate.