xref: /openbmc/linux/net/wireless/core.h (revision 32981ea5)
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 	/* protected by RTNL */
54 	int devlist_generation, wdev_id;
55 	int opencount;
56 	wait_queue_head_t dev_wait;
57 
58 	struct list_head beacon_registrations;
59 	spinlock_t beacon_registrations_lock;
60 
61 	struct list_head mlme_unreg;
62 	spinlock_t mlme_unreg_lock;
63 	struct work_struct mlme_unreg_wk;
64 
65 	/* protected by RTNL only */
66 	int num_running_ifaces;
67 	int num_running_monitor_ifaces;
68 
69 	/* BSSes/scanning */
70 	spinlock_t bss_lock;
71 	struct list_head bss_list;
72 	struct rb_root bss_tree;
73 	u32 bss_generation;
74 	struct cfg80211_scan_request *scan_req; /* protected by RTNL */
75 	struct sk_buff *scan_msg;
76 	struct cfg80211_sched_scan_request __rcu *sched_scan_req;
77 	unsigned long suspend_at;
78 	struct work_struct scan_done_wk;
79 	struct work_struct sched_scan_results_wk;
80 
81 	struct genl_info *cur_cmd_info;
82 
83 	struct work_struct conn_work;
84 	struct work_struct event_work;
85 
86 	struct delayed_work dfs_update_channels_wk;
87 
88 	/* netlink port which started critical protocol (0 means not started) */
89 	u32 crit_proto_nlportid;
90 
91 	struct cfg80211_coalesce *coalesce;
92 
93 	spinlock_t destroy_list_lock;
94 	struct list_head destroy_list;
95 	struct work_struct destroy_work;
96 
97 	struct work_struct sched_scan_stop_wk;
98 
99 	/* must be last because of the way we do wiphy_priv(),
100 	 * and it should at least be aligned to NETDEV_ALIGN */
101 	struct wiphy wiphy __aligned(NETDEV_ALIGN);
102 };
103 
104 static inline
105 struct cfg80211_registered_device *wiphy_to_rdev(struct wiphy *wiphy)
106 {
107 	BUG_ON(!wiphy);
108 	return container_of(wiphy, struct cfg80211_registered_device, wiphy);
109 }
110 
111 static inline void
112 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
113 {
114 #ifdef CONFIG_PM
115 	int i;
116 
117 	if (!rdev->wiphy.wowlan_config)
118 		return;
119 	for (i = 0; i < rdev->wiphy.wowlan_config->n_patterns; i++)
120 		kfree(rdev->wiphy.wowlan_config->patterns[i].mask);
121 	kfree(rdev->wiphy.wowlan_config->patterns);
122 	if (rdev->wiphy.wowlan_config->tcp &&
123 	    rdev->wiphy.wowlan_config->tcp->sock)
124 		sock_release(rdev->wiphy.wowlan_config->tcp->sock);
125 	kfree(rdev->wiphy.wowlan_config->tcp);
126 	kfree(rdev->wiphy.wowlan_config->nd_config);
127 	kfree(rdev->wiphy.wowlan_config);
128 #endif
129 }
130 
131 extern struct workqueue_struct *cfg80211_wq;
132 extern struct list_head cfg80211_rdev_list;
133 extern int cfg80211_rdev_list_generation;
134 
135 struct cfg80211_internal_bss {
136 	struct list_head list;
137 	struct list_head hidden_list;
138 	struct rb_node rbn;
139 	u64 ts_boottime;
140 	unsigned long ts;
141 	unsigned long refcount;
142 	atomic_t hold;
143 
144 	/* must be last because of priv member */
145 	struct cfg80211_bss pub;
146 };
147 
148 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
149 {
150 	return container_of(pub, struct cfg80211_internal_bss, pub);
151 }
152 
153 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
154 {
155 	atomic_inc(&bss->hold);
156 }
157 
158 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
159 {
160 	int r = atomic_dec_return(&bss->hold);
161 	WARN_ON(r < 0);
162 }
163 
164 
165 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
166 int get_wiphy_idx(struct wiphy *wiphy);
167 
168 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
169 
170 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
171 			  struct net *net);
172 
173 static inline void wdev_lock(struct wireless_dev *wdev)
174 	__acquires(wdev)
175 {
176 	mutex_lock(&wdev->mtx);
177 	__acquire(wdev->mtx);
178 }
179 
180 static inline void wdev_unlock(struct wireless_dev *wdev)
181 	__releases(wdev)
182 {
183 	__release(wdev->mtx);
184 	mutex_unlock(&wdev->mtx);
185 }
186 
187 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
188 
189 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
190 {
191 	ASSERT_RTNL();
192 
193 	return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
194 	       rdev->num_running_ifaces > 0;
195 }
196 
197 enum cfg80211_event_type {
198 	EVENT_CONNECT_RESULT,
199 	EVENT_ROAMED,
200 	EVENT_DISCONNECTED,
201 	EVENT_IBSS_JOINED,
202 	EVENT_STOPPED,
203 };
204 
205 struct cfg80211_event {
206 	struct list_head list;
207 	enum cfg80211_event_type type;
208 
209 	union {
210 		struct {
211 			u8 bssid[ETH_ALEN];
212 			const u8 *req_ie;
213 			const u8 *resp_ie;
214 			size_t req_ie_len;
215 			size_t resp_ie_len;
216 			struct cfg80211_bss *bss;
217 			u16 status;
218 		} cr;
219 		struct {
220 			const u8 *req_ie;
221 			const u8 *resp_ie;
222 			size_t req_ie_len;
223 			size_t resp_ie_len;
224 			struct cfg80211_bss *bss;
225 		} rm;
226 		struct {
227 			const u8 *ie;
228 			size_t ie_len;
229 			u16 reason;
230 			bool locally_generated;
231 		} dc;
232 		struct {
233 			u8 bssid[ETH_ALEN];
234 			struct ieee80211_channel *channel;
235 		} ij;
236 	};
237 };
238 
239 struct cfg80211_cached_keys {
240 	struct key_params params[6];
241 	u8 data[6][WLAN_MAX_KEY_LEN];
242 	int def, defmgmt;
243 };
244 
245 enum cfg80211_chan_mode {
246 	CHAN_MODE_UNDEFINED,
247 	CHAN_MODE_SHARED,
248 	CHAN_MODE_EXCLUSIVE,
249 };
250 
251 struct cfg80211_beacon_registration {
252 	struct list_head list;
253 	u32 nlportid;
254 };
255 
256 struct cfg80211_iface_destroy {
257 	struct list_head list;
258 	u32 nlportid;
259 };
260 
261 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
262 
263 /* free object */
264 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
265 
266 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
267 			char *newname);
268 
269 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
270 
271 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
272 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
273                       unsigned long age_secs);
274 
275 /* IBSS */
276 int cfg80211_join_ibss(struct cfg80211_registered_device *rdev,
277 		       struct net_device *dev,
278 		       struct cfg80211_ibss_params *params,
279 		       struct cfg80211_cached_keys *connkeys);
280 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
281 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
282 			  struct net_device *dev, bool nowext);
283 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
284 			struct net_device *dev, bool nowext);
285 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
286 			    struct ieee80211_channel *channel);
287 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
288 			    struct wireless_dev *wdev);
289 
290 /* mesh */
291 extern const struct mesh_config default_mesh_config;
292 extern const struct mesh_setup default_mesh_setup;
293 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
294 			 struct net_device *dev,
295 			 struct mesh_setup *setup,
296 			 const struct mesh_config *conf);
297 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
298 		       struct net_device *dev,
299 		       struct mesh_setup *setup,
300 		       const struct mesh_config *conf);
301 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
302 			  struct net_device *dev);
303 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
304 			struct net_device *dev);
305 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
306 			      struct wireless_dev *wdev,
307 			      struct cfg80211_chan_def *chandef);
308 
309 /* OCB */
310 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
311 			struct net_device *dev,
312 			struct ocb_setup *setup);
313 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
314 		      struct net_device *dev,
315 		      struct ocb_setup *setup);
316 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
317 			 struct net_device *dev);
318 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
319 		       struct net_device *dev);
320 
321 /* AP */
322 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
323 		       struct net_device *dev, bool notify);
324 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
325 		     struct net_device *dev, bool notify);
326 
327 /* MLME */
328 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
329 		       struct net_device *dev,
330 		       struct ieee80211_channel *chan,
331 		       enum nl80211_auth_type auth_type,
332 		       const u8 *bssid,
333 		       const u8 *ssid, int ssid_len,
334 		       const u8 *ie, int ie_len,
335 		       const u8 *key, int key_len, int key_idx,
336 		       const u8 *sae_data, int sae_data_len);
337 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
338 			struct net_device *dev,
339 			struct ieee80211_channel *chan,
340 			const u8 *bssid,
341 			const u8 *ssid, int ssid_len,
342 			struct cfg80211_assoc_request *req);
343 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
344 			 struct net_device *dev, const u8 *bssid,
345 			 const u8 *ie, int ie_len, u16 reason,
346 			 bool local_state_change);
347 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
348 			   struct net_device *dev, const u8 *bssid,
349 			   const u8 *ie, int ie_len, u16 reason,
350 			   bool local_state_change);
351 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
352 			struct net_device *dev);
353 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
354 				u16 frame_type, const u8 *match_data,
355 				int match_len);
356 void cfg80211_mlme_unreg_wk(struct work_struct *wk);
357 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
358 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
359 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
360 			  struct wireless_dev *wdev,
361 			  struct cfg80211_mgmt_tx_params *params,
362 			  u64 *cookie);
363 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
364 			       const struct ieee80211_ht_cap *ht_capa_mask);
365 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
366 				const struct ieee80211_vht_cap *vht_capa_mask);
367 
368 /* SME events */
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 		     const u8 *prev_bssid);
374 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
375 			       const u8 *req_ie, size_t req_ie_len,
376 			       const u8 *resp_ie, size_t resp_ie_len,
377 			       u16 status, bool wextev,
378 			       struct cfg80211_bss *bss);
379 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
380 			     size_t ie_len, u16 reason, bool from_ap);
381 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
382 			struct net_device *dev, u16 reason,
383 			bool wextev);
384 void __cfg80211_roamed(struct wireless_dev *wdev,
385 		       struct cfg80211_bss *bss,
386 		       const u8 *req_ie, size_t req_ie_len,
387 		       const u8 *resp_ie, size_t resp_ie_len);
388 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
389 			      struct wireless_dev *wdev);
390 
391 /* SME implementation */
392 void cfg80211_conn_work(struct work_struct *work);
393 void cfg80211_sme_scan_done(struct net_device *dev);
394 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
395 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
396 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
397 void cfg80211_sme_deauth(struct wireless_dev *wdev);
398 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
399 void cfg80211_sme_assoc_timeout(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_scan_done(struct work_struct *wk);
407 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
408 			   bool send_message);
409 void __cfg80211_sched_scan_results(struct work_struct *wk);
410 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
411 			       bool driver_initiated);
412 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
413 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
414 			  struct net_device *dev, enum nl80211_iftype ntype,
415 			  u32 *flags, struct vif_params *params);
416 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
417 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
418 
419 /**
420  * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable
421  * @wiphy: the wiphy to validate against
422  * @chandef: the channel definition to check
423  *
424  * Checks if chandef is usable and we can/need start CAC on such channel.
425  *
426  * Return: Return true if all channels available and at least
427  *	   one channel require CAC (NL80211_DFS_USABLE)
428  */
429 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
430 				 const struct cfg80211_chan_def *chandef);
431 
432 void cfg80211_set_dfs_state(struct wiphy *wiphy,
433 			    const struct cfg80211_chan_def *chandef,
434 			    enum nl80211_dfs_state dfs_state);
435 
436 void cfg80211_dfs_channels_update_work(struct work_struct *work);
437 
438 unsigned int
439 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
440 			      const struct cfg80211_chan_def *chandef);
441 
442 static inline unsigned int elapsed_jiffies_msecs(unsigned long start)
443 {
444 	unsigned long end = jiffies;
445 
446 	if (end >= start)
447 		return jiffies_to_msecs(end - start);
448 
449 	return jiffies_to_msecs(end + (ULONG_MAX - start) + 1);
450 }
451 
452 void
453 cfg80211_get_chan_state(struct wireless_dev *wdev,
454 		        struct ieee80211_channel **chan,
455 		        enum cfg80211_chan_mode *chanmode,
456 		        u8 *radar_detect);
457 
458 int cfg80211_set_monitor_channel(struct cfg80211_registered_device *rdev,
459 				 struct cfg80211_chan_def *chandef);
460 
461 int ieee80211_get_ratemask(struct ieee80211_supported_band *sband,
462 			   const u8 *rates, unsigned int n_rates,
463 			   u32 *mask);
464 
465 int cfg80211_validate_beacon_int(struct cfg80211_registered_device *rdev,
466 				 u32 beacon_int);
467 
468 void cfg80211_update_iface_num(struct cfg80211_registered_device *rdev,
469 			       enum nl80211_iftype iftype, int num);
470 
471 void __cfg80211_leave(struct cfg80211_registered_device *rdev,
472 		      struct wireless_dev *wdev);
473 void cfg80211_leave(struct cfg80211_registered_device *rdev,
474 		    struct wireless_dev *wdev);
475 
476 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
477 			      struct wireless_dev *wdev);
478 
479 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
480 
481 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
482 #define CFG80211_DEV_WARN_ON(cond)	WARN_ON(cond)
483 #else
484 /*
485  * Trick to enable using it as a condition,
486  * and also not give a warning when it's
487  * not used that way.
488  */
489 #define CFG80211_DEV_WARN_ON(cond)	({bool __r = (cond); __r; })
490 #endif
491 
492 #endif /* __NET_WIRELESS_CORE_H */
493