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