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