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