xref: /freebsd/contrib/wpa/src/drivers/driver_common.c (revision 18054d0220cfc8df9c9568c437bd6fbb59d53c3c)
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 
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 
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 	}
94 
95 	return "UNKNOWN";
96 #undef E2S
97 }
98 
99 
100 const char * channel_width_to_string(enum chan_width width)
101 {
102 	switch (width) {
103 	case CHAN_WIDTH_20_NOHT:
104 		return "20 MHz (no HT)";
105 	case CHAN_WIDTH_20:
106 		return "20 MHz";
107 	case CHAN_WIDTH_40:
108 		return "40 MHz";
109 	case CHAN_WIDTH_80:
110 		return "80 MHz";
111 	case CHAN_WIDTH_80P80:
112 		return "80+80 MHz";
113 	case CHAN_WIDTH_160:
114 		return "160 MHz";
115 	default:
116 		return "unknown";
117 	}
118 }
119 
120 
121 int channel_width_to_int(enum chan_width width)
122 {
123 	switch (width) {
124 	case CHAN_WIDTH_20_NOHT:
125 	case CHAN_WIDTH_20:
126 		return 20;
127 	case CHAN_WIDTH_40:
128 		return 40;
129 	case CHAN_WIDTH_80:
130 		return 80;
131 	case CHAN_WIDTH_80P80:
132 	case CHAN_WIDTH_160:
133 		return 160;
134 	default:
135 		return 0;
136 	}
137 }
138 
139 
140 int ht_supported(const struct hostapd_hw_modes *mode)
141 {
142 	if (!(mode->flags & HOSTAPD_MODE_FLAG_HT_INFO_KNOWN)) {
143 		/*
144 		 * The driver did not indicate whether it supports HT. Assume
145 		 * it does to avoid connection issues.
146 		 */
147 		return 1;
148 	}
149 
150 	/*
151 	 * IEEE Std 802.11n-2009 20.1.1:
152 	 * An HT non-AP STA shall support all EQM rates for one spatial stream.
153 	 */
154 	return mode->mcs_set[0] == 0xff;
155 }
156 
157 
158 int vht_supported(const struct hostapd_hw_modes *mode)
159 {
160 	if (!(mode->flags & HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN)) {
161 		/*
162 		 * The driver did not indicate whether it supports VHT. Assume
163 		 * it does to avoid connection issues.
164 		 */
165 		return 1;
166 	}
167 
168 	/*
169 	 * A VHT non-AP STA shall support MCS 0-7 for one spatial stream.
170 	 * TODO: Verify if this complies with the standard
171 	 */
172 	return (mode->vht_mcs_set[0] & 0x3) != 3;
173 }
174 
175 
176 static int wpa_check_wowlan_trigger(const char *start, const char *trigger,
177 				    int capa_trigger, u8 *param_trigger)
178 {
179 	if (os_strcmp(start, trigger) != 0)
180 		return 0;
181 	if (!capa_trigger)
182 		return 0;
183 
184 	*param_trigger = 1;
185 	return 1;
186 }
187 
188 
189 struct wowlan_triggers *
190 wpa_get_wowlan_triggers(const char *wowlan_triggers,
191 			const struct wpa_driver_capa *capa)
192 {
193 	struct wowlan_triggers *triggers;
194 	char *start, *end, *buf;
195 	int last;
196 
197 	if (!wowlan_triggers)
198 		return NULL;
199 
200 	buf = os_strdup(wowlan_triggers);
201 	if (buf == NULL)
202 		return NULL;
203 
204 	triggers = os_zalloc(sizeof(*triggers));
205 	if (triggers == NULL)
206 		goto out;
207 
208 #define CHECK_TRIGGER(trigger) \
209 	wpa_check_wowlan_trigger(start, #trigger,			\
210 				  capa->wowlan_triggers.trigger,	\
211 				  &triggers->trigger)
212 
213 	start = buf;
214 	while (*start != '\0') {
215 		while (isblank((unsigned char) *start))
216 			start++;
217 		if (*start == '\0')
218 			break;
219 		end = start;
220 		while (!isblank((unsigned char) *end) && *end != '\0')
221 			end++;
222 		last = *end == '\0';
223 		*end = '\0';
224 
225 		if (!CHECK_TRIGGER(any) &&
226 		    !CHECK_TRIGGER(disconnect) &&
227 		    !CHECK_TRIGGER(magic_pkt) &&
228 		    !CHECK_TRIGGER(gtk_rekey_failure) &&
229 		    !CHECK_TRIGGER(eap_identity_req) &&
230 		    !CHECK_TRIGGER(four_way_handshake) &&
231 		    !CHECK_TRIGGER(rfkill_release)) {
232 			wpa_printf(MSG_DEBUG,
233 				   "Unknown/unsupported wowlan trigger '%s'",
234 				   start);
235 			os_free(triggers);
236 			triggers = NULL;
237 			goto out;
238 		}
239 
240 		if (last)
241 			break;
242 		start = end + 1;
243 	}
244 #undef CHECK_TRIGGER
245 
246 out:
247 	os_free(buf);
248 	return triggers;
249 }
250 
251 
252 const char * driver_flag_to_string(u64 flag)
253 {
254 #define DF2S(x) case WPA_DRIVER_FLAGS_ ## x: return #x
255 	switch (flag) {
256 	DF2S(DRIVER_IE);
257 	DF2S(SET_KEYS_AFTER_ASSOC);
258 	DF2S(DFS_OFFLOAD);
259 	DF2S(4WAY_HANDSHAKE_PSK);
260 	DF2S(4WAY_HANDSHAKE_8021X);
261 	DF2S(WIRED);
262 	DF2S(SME);
263 	DF2S(AP);
264 	DF2S(SET_KEYS_AFTER_ASSOC_DONE);
265 	DF2S(HT_2040_COEX);
266 	DF2S(P2P_CONCURRENT);
267 	DF2S(P2P_DEDICATED_INTERFACE);
268 	DF2S(P2P_CAPABLE);
269 	DF2S(AP_TEARDOWN_SUPPORT);
270 	DF2S(P2P_MGMT_AND_NON_P2P);
271 	DF2S(VALID_ERROR_CODES);
272 	DF2S(OFFCHANNEL_TX);
273 	DF2S(EAPOL_TX_STATUS);
274 	DF2S(DEAUTH_TX_STATUS);
275 	DF2S(BSS_SELECTION);
276 	DF2S(TDLS_SUPPORT);
277 	DF2S(TDLS_EXTERNAL_SETUP);
278 	DF2S(PROBE_RESP_OFFLOAD);
279 	DF2S(AP_UAPSD);
280 	DF2S(INACTIVITY_TIMER);
281 	DF2S(AP_MLME);
282 	DF2S(SAE);
283 	DF2S(OBSS_SCAN);
284 	DF2S(IBSS);
285 	DF2S(RADAR);
286 	DF2S(DEDICATED_P2P_DEVICE);
287 	DF2S(QOS_MAPPING);
288 	DF2S(AP_CSA);
289 	DF2S(MESH);
290 	DF2S(ACS_OFFLOAD);
291 	DF2S(KEY_MGMT_OFFLOAD);
292 	DF2S(TDLS_CHANNEL_SWITCH);
293 	DF2S(HT_IBSS);
294 	DF2S(VHT_IBSS);
295 	DF2S(SUPPORT_HW_MODE_ANY);
296 	DF2S(OFFCHANNEL_SIMULTANEOUS);
297 	DF2S(FULL_AP_CLIENT_STATE);
298 	DF2S(P2P_LISTEN_OFFLOAD);
299 	DF2S(SUPPORT_FILS);
300 	DF2S(BEACON_RATE_LEGACY);
301 	DF2S(BEACON_RATE_HT);
302 	DF2S(BEACON_RATE_VHT);
303 	DF2S(MGMT_TX_RANDOM_TA);
304 	DF2S(MGMT_TX_RANDOM_TA_CONNECTED);
305 	DF2S(SCHED_SCAN_RELATIVE_RSSI);
306 	DF2S(HE_CAPABILITIES);
307 	DF2S(FILS_SK_OFFLOAD);
308 	DF2S(OCE_STA);
309 	DF2S(OCE_AP);
310 	DF2S(OCE_STA_CFON);
311 	DF2S(MFP_OPTIONAL);
312 	DF2S(SELF_MANAGED_REGULATORY);
313 	DF2S(FTM_RESPONDER);
314 	DF2S(CONTROL_PORT);
315 	DF2S(VLAN_OFFLOAD);
316 	DF2S(UPDATE_FT_IES);
317 	DF2S(SAFE_PTK0_REKEYS);
318 	DF2S(BEACON_PROTECTION);
319 	DF2S(EXTENDED_KEY_ID);
320 	}
321 	return "UNKNOWN";
322 #undef DF2S
323 }
324 
325 
326 const char * driver_flag2_to_string(u64 flag2)
327 {
328 #define DF2S(x) case WPA_DRIVER_FLAGS2_ ## x: return #x
329 	switch (flag2) {
330 	DF2S(CONTROL_PORT_RX);
331 	DF2S(CONTROL_PORT_TX_STATUS);
332 	}
333 	return "UNKNOWN";
334 #undef DF2S
335 }
336