xref: /freebsd/contrib/wpa/src/drivers/driver_common.c (revision 71e72c9e91c4b8007a4292e09669e8b549c29e97)
1 /*
2  * Common driver-related functions
3  * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  */
8 
9 #include "includes.h"
10 #include "utils/common.h"
11 #include "driver.h"
12 
wpa_scan_results_free(struct wpa_scan_results * res)13 void wpa_scan_results_free(struct wpa_scan_results *res)
14 {
15 	size_t i;
16 
17 	if (res == NULL)
18 		return;
19 
20 	for (i = 0; i < res->num; i++)
21 		os_free(res->res[i]);
22 	os_free(res->res);
23 	os_free(res);
24 }
25 
26 
event_to_string(enum wpa_event_type event)27 const char * event_to_string(enum wpa_event_type event)
28 {
29 #define E2S(n) case EVENT_ ## n: return #n
30 	switch (event) {
31 	E2S(ASSOC);
32 	E2S(DISASSOC);
33 	E2S(MICHAEL_MIC_FAILURE);
34 	E2S(SCAN_RESULTS);
35 	E2S(ASSOCINFO);
36 	E2S(INTERFACE_STATUS);
37 	E2S(PMKID_CANDIDATE);
38 	E2S(TDLS);
39 	E2S(FT_RESPONSE);
40 	E2S(IBSS_RSN_START);
41 	E2S(AUTH);
42 	E2S(DEAUTH);
43 	E2S(ASSOC_REJECT);
44 	E2S(AUTH_TIMED_OUT);
45 	E2S(ASSOC_TIMED_OUT);
46 	E2S(WPS_BUTTON_PUSHED);
47 	E2S(TX_STATUS);
48 	E2S(RX_FROM_UNKNOWN);
49 	E2S(RX_MGMT);
50 	E2S(REMAIN_ON_CHANNEL);
51 	E2S(CANCEL_REMAIN_ON_CHANNEL);
52 	E2S(RX_PROBE_REQ);
53 	E2S(NEW_STA);
54 	E2S(EAPOL_RX);
55 	E2S(SIGNAL_CHANGE);
56 	E2S(INTERFACE_ENABLED);
57 	E2S(INTERFACE_DISABLED);
58 	E2S(CHANNEL_LIST_CHANGED);
59 	E2S(INTERFACE_UNAVAILABLE);
60 	E2S(BEST_CHANNEL);
61 	E2S(UNPROT_DEAUTH);
62 	E2S(UNPROT_DISASSOC);
63 	E2S(STATION_LOW_ACK);
64 	E2S(IBSS_PEER_LOST);
65 	E2S(DRIVER_GTK_REKEY);
66 	E2S(SCHED_SCAN_STOPPED);
67 	E2S(DRIVER_CLIENT_POLL_OK);
68 	E2S(EAPOL_TX_STATUS);
69 	E2S(CH_SWITCH);
70 	E2S(CH_SWITCH_STARTED);
71 	E2S(WNM);
72 	E2S(CONNECT_FAILED_REASON);
73 	E2S(DFS_RADAR_DETECTED);
74 	E2S(DFS_CAC_FINISHED);
75 	E2S(DFS_CAC_ABORTED);
76 	E2S(DFS_NOP_FINISHED);
77 	E2S(SURVEY);
78 	E2S(SCAN_STARTED);
79 	E2S(AVOID_FREQUENCIES);
80 	E2S(NEW_PEER_CANDIDATE);
81 	E2S(ACS_CHANNEL_SELECTED);
82 	E2S(DFS_CAC_STARTED);
83 	E2S(P2P_LO_STOP);
84 	E2S(BEACON_LOSS);
85 	E2S(DFS_PRE_CAC_EXPIRED);
86 	E2S(EXTERNAL_AUTH);
87 	E2S(PORT_AUTHORIZED);
88 	E2S(STATION_OPMODE_CHANGED);
89 	E2S(INTERFACE_MAC_CHANGED);
90 	E2S(WDS_STA_INTERFACE_STATUS);
91 	E2S(UPDATE_DH);
92 	E2S(UNPROT_BEACON);
93 	E2S(TX_WAIT_EXPIRE);
94 	E2S(BSS_COLOR_COLLISION);
95 	E2S(CCA_STARTED_NOTIFY);
96 	E2S(CCA_ABORTED_NOTIFY);
97 	E2S(CCA_NOTIFY);
98 	E2S(PASN_AUTH);
99 	E2S(LINK_CH_SWITCH);
100 	E2S(LINK_CH_SWITCH_STARTED);
101 	E2S(TID_LINK_MAP);
102 	E2S(LINK_RECONFIG);
103 	E2S(MLD_INTERFACE_FREED);
104 	E2S(SETUP_LINK_RECONFIG);
105 	E2S(NAN_CLUSTER_JOIN);
106 	E2S(NAN_NEXT_DW);
107 	E2S(INCUMBT_SIG_INTF_DETECTED);
108 	E2S(NAN_SCHED_UPDATE_DONE);
109 	E2S(NAN_ULW_UPDATE);
110 	E2S(NAN_CHAN_EVACUATION);
111 	E2S(PEER_MEASUREMENT_RESULT);
112 	E2S(PEER_MEASUREMENT_COMPLETE);
113 	}
114 
115 	return "UNKNOWN";
116 #undef E2S
117 }
118 
119 
channel_width_to_string(enum chan_width width)120 const char * channel_width_to_string(enum chan_width width)
121 {
122 	switch (width) {
123 	case CHAN_WIDTH_20_NOHT:
124 		return "20 MHz (no HT)";
125 	case CHAN_WIDTH_20:
126 		return "20 MHz";
127 	case CHAN_WIDTH_40:
128 		return "40 MHz";
129 	case CHAN_WIDTH_80:
130 		return "80 MHz";
131 	case CHAN_WIDTH_80P80:
132 		return "80+80 MHz";
133 	case CHAN_WIDTH_160:
134 		return "160 MHz";
135 	case CHAN_WIDTH_320:
136 		return "320 MHz";
137 	default:
138 		return "unknown";
139 	}
140 }
141 
142 
channel_width_to_int(enum chan_width width)143 int channel_width_to_int(enum chan_width width)
144 {
145 	switch (width) {
146 	case CHAN_WIDTH_20_NOHT:
147 	case CHAN_WIDTH_20:
148 		return 20;
149 	case CHAN_WIDTH_40:
150 		return 40;
151 	case CHAN_WIDTH_80:
152 		return 80;
153 	case CHAN_WIDTH_80P80:
154 	case CHAN_WIDTH_160:
155 		return 160;
156 	case CHAN_WIDTH_320:
157 		return 320;
158 	default:
159 		return 0;
160 	}
161 }
162 
163 
ht_supported(const struct hostapd_hw_modes * mode)164 int ht_supported(const struct hostapd_hw_modes *mode)
165 {
166 	if (!(mode->flags & HOSTAPD_MODE_FLAG_HT_INFO_KNOWN)) {
167 		/*
168 		 * The driver did not indicate whether it supports HT. Assume
169 		 * it does to avoid connection issues.
170 		 */
171 		return 1;
172 	}
173 
174 	/*
175 	 * IEEE Std 802.11n-2009 20.1.1:
176 	 * An HT non-AP STA shall support all EQM rates for one spatial stream.
177 	 */
178 	return mode->mcs_set[0] == 0xff;
179 }
180 
181 
vht_supported(const struct hostapd_hw_modes * mode)182 int vht_supported(const struct hostapd_hw_modes *mode)
183 {
184 	if (!(mode->flags & HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN)) {
185 		/*
186 		 * The driver did not indicate whether it supports VHT. Assume
187 		 * it does to avoid connection issues.
188 		 */
189 		return 1;
190 	}
191 
192 	/*
193 	 * A VHT non-AP STA shall support MCS 0-7 for one spatial stream.
194 	 * TODO: Verify if this complies with the standard
195 	 */
196 	return (mode->vht_mcs_set[0] & 0x3) != 3;
197 }
198 
199 
he_supported(const struct hostapd_hw_modes * hw_mode,enum ieee80211_op_mode op_mode)200 bool he_supported(const struct hostapd_hw_modes *hw_mode,
201 		  enum ieee80211_op_mode op_mode)
202 {
203 	if (!(hw_mode->flags & HOSTAPD_MODE_FLAG_HE_INFO_KNOWN)) {
204 		/*
205 		 * The driver did not indicate whether it supports HE. Assume
206 		 * it does to avoid connection issues.
207 		 */
208 		return true;
209 	}
210 
211 	return hw_mode->he_capab[op_mode].he_supported;
212 }
213 
214 
eht_supported(const struct hostapd_hw_modes * hw_mode,enum ieee80211_op_mode op_mode)215 bool eht_supported(const struct hostapd_hw_modes *hw_mode,
216 		   enum ieee80211_op_mode op_mode)
217 {
218 	if (!(hw_mode->flags & HOSTAPD_MODE_FLAG_EHT_INFO_KNOWN)) {
219 		/*
220 		 * The driver did not indicate whether it supports EHT. Assume
221 		 * it does to avoid connection issues.
222 		 */
223 		return true;
224 	}
225 
226 	return hw_mode->eht_capab[op_mode].eht_supported;
227 }
228 
229 
wpa_check_wowlan_trigger(const char * start,const char * trigger,int capa_trigger,u8 * param_trigger)230 static int wpa_check_wowlan_trigger(const char *start, const char *trigger,
231 				    int capa_trigger, u8 *param_trigger)
232 {
233 	if (os_strcmp(start, trigger) != 0)
234 		return 0;
235 	if (!capa_trigger)
236 		return 0;
237 
238 	*param_trigger = 1;
239 	return 1;
240 }
241 
242 
243 struct wowlan_triggers *
wpa_get_wowlan_triggers(const char * wowlan_triggers,const struct wpa_driver_capa * capa)244 wpa_get_wowlan_triggers(const char *wowlan_triggers,
245 			const struct wpa_driver_capa *capa)
246 {
247 	struct wowlan_triggers *triggers;
248 	char *start, *end, *buf;
249 	int last;
250 
251 	if (!wowlan_triggers)
252 		return NULL;
253 
254 	buf = os_strdup(wowlan_triggers);
255 	if (buf == NULL)
256 		return NULL;
257 
258 	triggers = os_zalloc(sizeof(*triggers));
259 	if (triggers == NULL)
260 		goto out;
261 
262 #define CHECK_TRIGGER(trigger) \
263 	wpa_check_wowlan_trigger(start, #trigger,			\
264 				  capa->wowlan_triggers.trigger,	\
265 				  &triggers->trigger)
266 
267 	start = buf;
268 	while (*start != '\0') {
269 		while (isblank((unsigned char) *start))
270 			start++;
271 		if (*start == '\0')
272 			break;
273 		end = start;
274 		while (!isblank((unsigned char) *end) && *end != '\0')
275 			end++;
276 		last = *end == '\0';
277 		*end = '\0';
278 
279 		if (!CHECK_TRIGGER(any) &&
280 		    !CHECK_TRIGGER(disconnect) &&
281 		    !CHECK_TRIGGER(magic_pkt) &&
282 		    !CHECK_TRIGGER(gtk_rekey_failure) &&
283 		    !CHECK_TRIGGER(eap_identity_req) &&
284 		    !CHECK_TRIGGER(four_way_handshake) &&
285 		    !CHECK_TRIGGER(rfkill_release)) {
286 			wpa_printf(MSG_DEBUG,
287 				   "Unknown/unsupported wowlan trigger '%s'",
288 				   start);
289 			os_free(triggers);
290 			triggers = NULL;
291 			goto out;
292 		}
293 
294 		if (last)
295 			break;
296 		start = end + 1;
297 	}
298 #undef CHECK_TRIGGER
299 
300 out:
301 	os_free(buf);
302 	return triggers;
303 }
304 
305 
driver_flag_to_string(u64 flag)306 const char * driver_flag_to_string(u64 flag)
307 {
308 #define DF2S(x) case WPA_DRIVER_FLAGS_ ## x: return #x
309 	switch (flag) {
310 	DF2S(DRIVER_IE);
311 	DF2S(SET_KEYS_AFTER_ASSOC);
312 	DF2S(DFS_OFFLOAD);
313 	DF2S(4WAY_HANDSHAKE_PSK);
314 	DF2S(4WAY_HANDSHAKE_8021X);
315 	DF2S(WIRED);
316 	DF2S(SME);
317 	DF2S(AP);
318 	DF2S(SET_KEYS_AFTER_ASSOC_DONE);
319 	DF2S(HT_2040_COEX);
320 	DF2S(P2P_CONCURRENT);
321 	DF2S(P2P_DEDICATED_INTERFACE);
322 	DF2S(P2P_CAPABLE);
323 	DF2S(AP_TEARDOWN_SUPPORT);
324 	DF2S(P2P_MGMT_AND_NON_P2P);
325 	DF2S(VALID_ERROR_CODES);
326 	DF2S(OFFCHANNEL_TX);
327 	DF2S(EAPOL_TX_STATUS);
328 	DF2S(DEAUTH_TX_STATUS);
329 	DF2S(BSS_SELECTION);
330 	DF2S(TDLS_SUPPORT);
331 	DF2S(TDLS_EXTERNAL_SETUP);
332 	DF2S(PROBE_RESP_OFFLOAD);
333 	DF2S(AP_UAPSD);
334 	DF2S(INACTIVITY_TIMER);
335 	DF2S(AP_MLME);
336 	DF2S(SAE);
337 	DF2S(OBSS_SCAN);
338 	DF2S(IBSS);
339 	DF2S(RADAR);
340 	DF2S(DEDICATED_P2P_DEVICE);
341 	DF2S(QOS_MAPPING);
342 	DF2S(AP_CSA);
343 	DF2S(MESH);
344 	DF2S(ACS_OFFLOAD);
345 	DF2S(KEY_MGMT_OFFLOAD);
346 	DF2S(TDLS_CHANNEL_SWITCH);
347 	DF2S(HT_IBSS);
348 	DF2S(VHT_IBSS);
349 	DF2S(SUPPORT_HW_MODE_ANY);
350 	DF2S(OFFCHANNEL_SIMULTANEOUS);
351 	DF2S(FULL_AP_CLIENT_STATE);
352 	DF2S(P2P_LISTEN_OFFLOAD);
353 	DF2S(SUPPORT_FILS);
354 	DF2S(BEACON_RATE_LEGACY);
355 	DF2S(BEACON_RATE_HT);
356 	DF2S(BEACON_RATE_VHT);
357 	DF2S(MGMT_TX_RANDOM_TA);
358 	DF2S(MGMT_TX_RANDOM_TA_CONNECTED);
359 	DF2S(SCHED_SCAN_RELATIVE_RSSI);
360 	DF2S(HE_CAPABILITIES);
361 	DF2S(FILS_SK_OFFLOAD);
362 	DF2S(OCE_STA);
363 	DF2S(OCE_AP);
364 	DF2S(OCE_STA_CFON);
365 	DF2S(MFP_OPTIONAL);
366 	DF2S(SELF_MANAGED_REGULATORY);
367 	DF2S(FTM_RESPONDER);
368 	DF2S(CONTROL_PORT);
369 	DF2S(VLAN_OFFLOAD);
370 	DF2S(UPDATE_FT_IES);
371 	DF2S(SAFE_PTK0_REKEYS);
372 	DF2S(BEACON_PROTECTION);
373 	DF2S(EXTENDED_KEY_ID);
374 	}
375 	return "UNKNOWN";
376 #undef DF2S
377 }
378 
379 
driver_flag2_to_string(u64 flag2)380 const char * driver_flag2_to_string(u64 flag2)
381 {
382 #define DF2S(x) case WPA_DRIVER_FLAGS2_ ## x: return #x
383 	switch (flag2) {
384 	DF2S(CONTROL_PORT_RX);
385 	DF2S(CONTROL_PORT_TX_STATUS);
386 	DF2S(SEC_LTF_AP);
387 	DF2S(SEC_RTT_AP);
388 	DF2S(PROT_RANGE_NEG_AP);
389 	DF2S(BEACON_RATE_HE);
390 	DF2S(BEACON_PROTECTION_CLIENT);
391 	DF2S(OCV);
392 	DF2S(AP_SME);
393 	DF2S(SA_QUERY_OFFLOAD_AP);
394 	DF2S(RADAR_BACKGROUND);
395 	DF2S(SEC_LTF_STA);
396 	DF2S(SEC_RTT_STA);
397 	DF2S(PROT_RANGE_NEG_STA);
398 	DF2S(MLO);
399 	DF2S(SCAN_MIN_PREQ);
400 	DF2S(SAE_OFFLOAD_STA);
401 	DF2S(SPP_AMSDU);
402 	}
403 	return "UNKNOWN";
404 #undef DF2S
405 }
406