xref: /openbmc/linux/net/wireless/core.h (revision afb46f79)
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_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 			struct ieee80211_channel *channel;
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 void cfg80211_clear_ibss(struct net_device *dev, bool nowext);
253 int __cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
254 			  struct net_device *dev, bool nowext);
255 int cfg80211_leave_ibss(struct cfg80211_registered_device *rdev,
256 			struct net_device *dev, bool nowext);
257 void __cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
258 			    struct ieee80211_channel *channel);
259 int cfg80211_ibss_wext_join(struct cfg80211_registered_device *rdev,
260 			    struct wireless_dev *wdev);
261 
262 /* mesh */
263 extern const struct mesh_config default_mesh_config;
264 extern const struct mesh_setup default_mesh_setup;
265 int __cfg80211_join_mesh(struct cfg80211_registered_device *rdev,
266 			 struct net_device *dev,
267 			 struct mesh_setup *setup,
268 			 const struct mesh_config *conf);
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_leave_mesh(struct cfg80211_registered_device *rdev,
274 			struct net_device *dev);
275 int cfg80211_set_mesh_channel(struct cfg80211_registered_device *rdev,
276 			      struct wireless_dev *wdev,
277 			      struct cfg80211_chan_def *chandef);
278 
279 /* AP */
280 int cfg80211_stop_ap(struct cfg80211_registered_device *rdev,
281 		     struct net_device *dev, bool notify);
282 
283 /* MLME */
284 int cfg80211_mlme_auth(struct cfg80211_registered_device *rdev,
285 		       struct net_device *dev,
286 		       struct ieee80211_channel *chan,
287 		       enum nl80211_auth_type auth_type,
288 		       const u8 *bssid,
289 		       const u8 *ssid, int ssid_len,
290 		       const u8 *ie, int ie_len,
291 		       const u8 *key, int key_len, int key_idx,
292 		       const u8 *sae_data, int sae_data_len);
293 int cfg80211_mlme_assoc(struct cfg80211_registered_device *rdev,
294 			struct net_device *dev,
295 			struct ieee80211_channel *chan,
296 			const u8 *bssid,
297 			const u8 *ssid, int ssid_len,
298 			struct cfg80211_assoc_request *req);
299 int cfg80211_mlme_deauth(struct cfg80211_registered_device *rdev,
300 			 struct net_device *dev, const u8 *bssid,
301 			 const u8 *ie, int ie_len, u16 reason,
302 			 bool local_state_change);
303 int cfg80211_mlme_disassoc(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 void cfg80211_mlme_down(struct cfg80211_registered_device *rdev,
308 			struct net_device *dev);
309 int cfg80211_mlme_register_mgmt(struct wireless_dev *wdev, u32 snd_pid,
310 				u16 frame_type, const u8 *match_data,
311 				int match_len);
312 void cfg80211_mlme_unregister_socket(struct wireless_dev *wdev, u32 nlpid);
313 void cfg80211_mlme_purge_registrations(struct wireless_dev *wdev);
314 int cfg80211_mlme_mgmt_tx(struct cfg80211_registered_device *rdev,
315 			  struct wireless_dev *wdev,
316 			  struct cfg80211_mgmt_tx_params *params,
317 			  u64 *cookie);
318 void cfg80211_oper_and_ht_capa(struct ieee80211_ht_cap *ht_capa,
319 			       const struct ieee80211_ht_cap *ht_capa_mask);
320 void cfg80211_oper_and_vht_capa(struct ieee80211_vht_cap *vht_capa,
321 				const struct ieee80211_vht_cap *vht_capa_mask);
322 
323 /* SME events */
324 int cfg80211_connect(struct cfg80211_registered_device *rdev,
325 		     struct net_device *dev,
326 		     struct cfg80211_connect_params *connect,
327 		     struct cfg80211_cached_keys *connkeys,
328 		     const u8 *prev_bssid);
329 void __cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
330 			       const u8 *req_ie, size_t req_ie_len,
331 			       const u8 *resp_ie, size_t resp_ie_len,
332 			       u16 status, bool wextev,
333 			       struct cfg80211_bss *bss);
334 void __cfg80211_disconnected(struct net_device *dev, const u8 *ie,
335 			     size_t ie_len, u16 reason, bool from_ap);
336 int cfg80211_disconnect(struct cfg80211_registered_device *rdev,
337 			struct net_device *dev, u16 reason,
338 			bool wextev);
339 void __cfg80211_roamed(struct wireless_dev *wdev,
340 		       struct cfg80211_bss *bss,
341 		       const u8 *req_ie, size_t req_ie_len,
342 		       const u8 *resp_ie, size_t resp_ie_len);
343 int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
344 			      struct wireless_dev *wdev);
345 
346 /* SME implementation */
347 void cfg80211_conn_work(struct work_struct *work);
348 void cfg80211_sme_scan_done(struct net_device *dev);
349 bool cfg80211_sme_rx_assoc_resp(struct wireless_dev *wdev, u16 status);
350 void cfg80211_sme_rx_auth(struct wireless_dev *wdev, const u8 *buf, size_t len);
351 void cfg80211_sme_disassoc(struct wireless_dev *wdev);
352 void cfg80211_sme_deauth(struct wireless_dev *wdev);
353 void cfg80211_sme_auth_timeout(struct wireless_dev *wdev);
354 void cfg80211_sme_assoc_timeout(struct wireless_dev *wdev);
355 
356 /* internal helpers */
357 bool cfg80211_supported_cipher_suite(struct wiphy *wiphy, u32 cipher);
358 int cfg80211_validate_key_settings(struct cfg80211_registered_device *rdev,
359 				   struct key_params *params, int key_idx,
360 				   bool pairwise, const u8 *mac_addr);
361 void __cfg80211_scan_done(struct work_struct *wk);
362 void ___cfg80211_scan_done(struct cfg80211_registered_device *rdev,
363 			   bool send_message);
364 void __cfg80211_sched_scan_results(struct work_struct *wk);
365 int __cfg80211_stop_sched_scan(struct cfg80211_registered_device *rdev,
366 			       bool driver_initiated);
367 void cfg80211_upload_connect_keys(struct wireless_dev *wdev);
368 int cfg80211_change_iface(struct cfg80211_registered_device *rdev,
369 			  struct net_device *dev, enum nl80211_iftype ntype,
370 			  u32 *flags, struct vif_params *params);
371 void cfg80211_process_rdev_events(struct cfg80211_registered_device *rdev);
372 void cfg80211_process_wdev_events(struct wireless_dev *wdev);
373 
374 int cfg80211_can_use_iftype_chan(struct cfg80211_registered_device *rdev,
375 				 struct wireless_dev *wdev,
376 				 enum nl80211_iftype iftype,
377 				 struct ieee80211_channel *chan,
378 				 enum cfg80211_chan_mode chanmode,
379 				 u8 radar_detect);
380 
381 /**
382  * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable
383  * @wiphy: the wiphy to validate against
384  * @chandef: the channel definition to check
385  *
386  * Checks if chandef is usable and we can/need start CAC on such channel.
387  *
388  * Return: Return true if all channels available and at least
389  *	   one channel require CAC (NL80211_DFS_USABLE)
390  */
391 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy,
392 				 const struct cfg80211_chan_def *chandef);
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 unsigned int
401 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy,
402 			      const struct cfg80211_chan_def *chandef);
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 		        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 
465 void cfg80211_stop_p2p_device(struct cfg80211_registered_device *rdev,
466 			      struct wireless_dev *wdev);
467 
468 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
469 
470 #ifdef CONFIG_CFG80211_DEVELOPER_WARNINGS
471 #define CFG80211_DEV_WARN_ON(cond)	WARN_ON(cond)
472 #else
473 /*
474  * Trick to enable using it as a condition,
475  * and also not give a warning when it's
476  * not used that way.
477  */
478 #define CFG80211_DEV_WARN_ON(cond)	({bool __r = (cond); __r; })
479 #endif
480 
481 #endif /* __NET_WIRELESS_CORE_H */
482