xref: /openbmc/linux/net/wireless/core.h (revision 179dd8c0)
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; /* also protected by devlist_mtx */
57 	wait_queue_head_t dev_wait;
58 
59 	struct list_head beacon_registrations;
60 	spinlock_t beacon_registrations_lock;
61 
62 	/* protected by RTNL only */
63 	int num_running_ifaces;
64 	int num_running_monitor_ifaces;
65 
66 	/* BSSes/scanning */
67 	spinlock_t bss_lock;
68 	struct list_head bss_list;
69 	struct rb_root bss_tree;
70 	u32 bss_generation;
71 	struct cfg80211_scan_request *scan_req; /* protected by RTNL */
72 	struct sk_buff *scan_msg;
73 	struct cfg80211_sched_scan_request __rcu *sched_scan_req;
74 	unsigned long suspend_at;
75 	struct work_struct scan_done_wk;
76 	struct work_struct sched_scan_results_wk;
77 
78 	struct genl_info *cur_cmd_info;
79 
80 	struct work_struct conn_work;
81 	struct work_struct event_work;
82 
83 	struct delayed_work dfs_update_channels_wk;
84 
85 	/* netlink port which started critical protocol (0 means not started) */
86 	u32 crit_proto_nlportid;
87 
88 	struct cfg80211_coalesce *coalesce;
89 
90 	spinlock_t destroy_list_lock;
91 	struct list_head destroy_list;
92 	struct work_struct destroy_work;
93 
94 	struct work_struct sched_scan_stop_wk;
95 
96 	/* must be last because of the way we do wiphy_priv(),
97 	 * and it should at least be aligned to NETDEV_ALIGN */
98 	struct wiphy wiphy __aligned(NETDEV_ALIGN);
99 };
100 
101 static inline
102 struct cfg80211_registered_device *wiphy_to_rdev(struct wiphy *wiphy)
103 {
104 	BUG_ON(!wiphy);
105 	return container_of(wiphy, struct cfg80211_registered_device, wiphy);
106 }
107 
108 static inline void
109 cfg80211_rdev_free_wowlan(struct cfg80211_registered_device *rdev)
110 {
111 #ifdef CONFIG_PM
112 	int i;
113 
114 	if (!rdev->wiphy.wowlan_config)
115 		return;
116 	for (i = 0; i < rdev->wiphy.wowlan_config->n_patterns; i++)
117 		kfree(rdev->wiphy.wowlan_config->patterns[i].mask);
118 	kfree(rdev->wiphy.wowlan_config->patterns);
119 	if (rdev->wiphy.wowlan_config->tcp &&
120 	    rdev->wiphy.wowlan_config->tcp->sock)
121 		sock_release(rdev->wiphy.wowlan_config->tcp->sock);
122 	kfree(rdev->wiphy.wowlan_config->tcp);
123 	kfree(rdev->wiphy.wowlan_config->nd_config);
124 	kfree(rdev->wiphy.wowlan_config);
125 #endif
126 }
127 
128 extern struct workqueue_struct *cfg80211_wq;
129 extern struct list_head cfg80211_rdev_list;
130 extern int cfg80211_rdev_list_generation;
131 
132 struct cfg80211_internal_bss {
133 	struct list_head list;
134 	struct list_head hidden_list;
135 	struct rb_node rbn;
136 	unsigned long ts;
137 	unsigned long refcount;
138 	atomic_t hold;
139 
140 	/* must be last because of priv member */
141 	struct cfg80211_bss pub;
142 };
143 
144 static inline struct cfg80211_internal_bss *bss_from_pub(struct cfg80211_bss *pub)
145 {
146 	return container_of(pub, struct cfg80211_internal_bss, pub);
147 }
148 
149 static inline void cfg80211_hold_bss(struct cfg80211_internal_bss *bss)
150 {
151 	atomic_inc(&bss->hold);
152 }
153 
154 static inline void cfg80211_unhold_bss(struct cfg80211_internal_bss *bss)
155 {
156 	int r = atomic_dec_return(&bss->hold);
157 	WARN_ON(r < 0);
158 }
159 
160 
161 struct cfg80211_registered_device *cfg80211_rdev_by_wiphy_idx(int wiphy_idx);
162 int get_wiphy_idx(struct wiphy *wiphy);
163 
164 struct wiphy *wiphy_idx_to_wiphy(int wiphy_idx);
165 
166 int cfg80211_switch_netns(struct cfg80211_registered_device *rdev,
167 			  struct net *net);
168 
169 static inline void wdev_lock(struct wireless_dev *wdev)
170 	__acquires(wdev)
171 {
172 	mutex_lock(&wdev->mtx);
173 	__acquire(wdev->mtx);
174 }
175 
176 static inline void wdev_unlock(struct wireless_dev *wdev)
177 	__releases(wdev)
178 {
179 	__release(wdev->mtx);
180 	mutex_unlock(&wdev->mtx);
181 }
182 
183 #define ASSERT_WDEV_LOCK(wdev) lockdep_assert_held(&(wdev)->mtx)
184 
185 static inline bool cfg80211_has_monitors_only(struct cfg80211_registered_device *rdev)
186 {
187 	ASSERT_RTNL();
188 
189 	return rdev->num_running_ifaces == rdev->num_running_monitor_ifaces &&
190 	       rdev->num_running_ifaces > 0;
191 }
192 
193 enum cfg80211_event_type {
194 	EVENT_CONNECT_RESULT,
195 	EVENT_ROAMED,
196 	EVENT_DISCONNECTED,
197 	EVENT_IBSS_JOINED,
198 	EVENT_STOPPED,
199 };
200 
201 struct cfg80211_event {
202 	struct list_head list;
203 	enum cfg80211_event_type type;
204 
205 	union {
206 		struct {
207 			u8 bssid[ETH_ALEN];
208 			const u8 *req_ie;
209 			const u8 *resp_ie;
210 			size_t req_ie_len;
211 			size_t resp_ie_len;
212 			u16 status;
213 		} cr;
214 		struct {
215 			const u8 *req_ie;
216 			const u8 *resp_ie;
217 			size_t req_ie_len;
218 			size_t resp_ie_len;
219 			struct cfg80211_bss *bss;
220 		} rm;
221 		struct {
222 			const u8 *ie;
223 			size_t ie_len;
224 			u16 reason;
225 			bool locally_generated;
226 		} dc;
227 		struct {
228 			u8 bssid[ETH_ALEN];
229 			struct ieee80211_channel *channel;
230 		} ij;
231 	};
232 };
233 
234 struct cfg80211_cached_keys {
235 	struct key_params params[6];
236 	u8 data[6][WLAN_MAX_KEY_LEN];
237 	int def, defmgmt;
238 };
239 
240 enum cfg80211_chan_mode {
241 	CHAN_MODE_UNDEFINED,
242 	CHAN_MODE_SHARED,
243 	CHAN_MODE_EXCLUSIVE,
244 };
245 
246 struct cfg80211_beacon_registration {
247 	struct list_head list;
248 	u32 nlportid;
249 };
250 
251 struct cfg80211_iface_destroy {
252 	struct list_head list;
253 	u32 nlportid;
254 };
255 
256 void cfg80211_destroy_ifaces(struct cfg80211_registered_device *rdev);
257 
258 /* free object */
259 void cfg80211_dev_free(struct cfg80211_registered_device *rdev);
260 
261 int cfg80211_dev_rename(struct cfg80211_registered_device *rdev,
262 			char *newname);
263 
264 void ieee80211_set_bitrate_flags(struct wiphy *wiphy);
265 
266 void cfg80211_bss_expire(struct cfg80211_registered_device *rdev);
267 void cfg80211_bss_age(struct cfg80211_registered_device *rdev,
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 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
276 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
277 			  struct net_device *dev, bool nowext);
278 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
279 			struct net_device *dev, bool nowext);
280 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
281 			    struct ieee80211_channel *channel);
282 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
283 			    struct wireless_dev *wdev);
284 
285 /* mesh */
286 extern const struct mesh_config default_mesh_config;
287 extern const struct mesh_setup default_mesh_setup;
288 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
289 			 struct net_device *dev,
290 			 struct mesh_setup *setup,
291 			 const struct mesh_config *conf);
292 int cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
293 		       struct net_device *dev,
294 		       struct mesh_setup *setup,
295 		       const struct mesh_config *conf);
296 int __cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
297 			  struct net_device *dev);
298 int cfg80211_leave_mesh(struct cfg80211_registered_device *rdev,
299 			struct net_device *dev);
300 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
301 			      struct wireless_dev *wdev,
302 			      struct cfg80211_chan_def *chandef);
303 
304 /* OCB */
305 int __cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
306 			struct net_device *dev,
307 			struct ocb_setup *setup);
308 int cfg80211_join_ocb(struct cfg80211_registered_device *rdev,
309 		      struct net_device *dev,
310 		      struct ocb_setup *setup);
311 int __cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
312 			 struct net_device *dev);
313 int cfg80211_leave_ocb(struct cfg80211_registered_device *rdev,
314 		       struct net_device *dev);
315 
316 /* AP */
317 int __cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
318 		       struct net_device *dev, bool notify);
319 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
320 		     struct net_device *dev, bool notify);
321 
322 /* MLME */
323 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
324 		       struct net_device *dev,
325 		       struct ieee80211_channel *chan,
326 		       enum nl80211_auth_type auth_type,
327 		       const u8 *bssid,
328 		       const u8 *ssid, int ssid_len,
329 		       const u8 *ie, int ie_len,
330 		       const u8 *key, int key_len, int key_idx,
331 		       const u8 *sae_data, int sae_data_len);
332 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
333 			struct net_device *dev,
334 			struct ieee80211_channel *chan,
335 			const u8 *bssid,
336 			const u8 *ssid, int ssid_len,
337 			struct cfg80211_assoc_request *req);
338 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
339 			 struct net_device *dev, const u8 *bssid,
340 			 const u8 *ie, int ie_len, u16 reason,
341 			 bool local_state_change);
342 int cfg80211_mlme_disassoc(struct cfg80211_registered_device *rdev,
343 			   struct net_device *dev, const u8 *bssid,
344 			   const u8 *ie, int ie_len, u16 reason,
345 			   bool local_state_change);
346 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
347 			struct net_device *dev);
348 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
349 				u16 frame_type, const u8 *match_data,
350 				int match_len);
351 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
352 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
353 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
354 			  struct wireless_dev *wdev,
355 			  struct cfg80211_mgmt_tx_params *params,
356 			  u64 *cookie);
357 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
358 			       const struct ieee80211_ht_cap *ht_capa_mask);
359 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
360 				const struct ieee80211_vht_cap *vht_capa_mask);
361 
362 /* SME events */
363 int cfg80211_connect(struct cfg80211_registered_device *rdev,
364 		     struct net_device *dev,
365 		     struct cfg80211_connect_params *connect,
366 		     struct cfg80211_cached_keys *connkeys,
367 		     const u8 *prev_bssid);
368 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
369 			       const u8 *req_ie, size_t req_ie_len,
370 			       const u8 *resp_ie, size_t resp_ie_len,
371 			       u16 status, bool wextev,
372 			       struct cfg80211_bss *bss);
373 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
374 			     size_t ie_len, u16 reason, bool from_ap);
375 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
376 			struct net_device *dev, u16 reason,
377 			bool wextev);
378 void __cfg80211_roamed(struct wireless_dev *wdev,
379 		       struct cfg80211_bss *bss,
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 /* SME implementation */
386 void cfg80211_conn_work(struct work_struct *work);
387 void cfg80211_sme_scan_done(struct net_device *dev);
388 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
389 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
390 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
391 void cfg80211_sme_deauth(struct wireless_dev *wdev);
392 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
393 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
394 
395 /* internal helpers */
396 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
397 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
398 				   struct key_params *params, int key_idx,
399 				   bool pairwise, const u8 *mac_addr);
400 void __cfg80211_scan_done(struct work_struct *wk);
401 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
402 			   bool send_message);
403 void __cfg80211_sched_scan_results(struct work_struct *wk);
404 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
405 			       bool driver_initiated);
406 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
407 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
408 			  struct net_device *dev, enum nl80211_iftype ntype,
409 			  u32 *flags, struct vif_params *params);
410 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
411 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
412 
413 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
414 				 struct wireless_dev *wdev,
415 				 enum nl80211_iftype iftype,
416 				 struct ieee80211_channel *chan,
417 				 enum cfg80211_chan_mode chanmode,
418 				 u8 radar_detect);
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 */
494