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