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