xref: /wlan-dirver/qca-wifi-host-cmn/umac/scan/dispatcher/src/wlan_scan_utils_api.c (revision 92d87f51612f6c3b2285266215edee8911647c2f)
1 /*
2  * Copyright (c) 2017-2018 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /*
20  * DOC: Defines scan utility functions
21  */
22 
23 #include <wlan_cmn.h>
24 #include <wlan_scan_ucfg_api.h>
25 #include <wlan_scan_utils_api.h>
26 #include <../../core/src/wlan_scan_cache_db.h>
27 #include <../../core/src/wlan_scan_main.h>
28 #include <wlan_reg_services_api.h>
29 
30 const char*
31 util_scan_get_ev_type_name(enum scan_event_type type)
32 {
33 	static const char * const event_name[] = {
34 		[SCAN_EVENT_TYPE_STARTED] = "STARTED",
35 		[SCAN_EVENT_TYPE_COMPLETED] = "COMPLETED",
36 		[SCAN_EVENT_TYPE_BSS_CHANNEL] = "HOME_CHANNEL",
37 		[SCAN_EVENT_TYPE_FOREIGN_CHANNEL] = "FOREIGN_CHANNEL",
38 		[SCAN_EVENT_TYPE_DEQUEUED] = "DEQUEUED",
39 		[SCAN_EVENT_TYPE_PREEMPTED] = "PREEMPTED",
40 		[SCAN_EVENT_TYPE_START_FAILED] = "START_FAILED",
41 		[SCAN_EVENT_TYPE_RESTARTED] = "RESTARTED",
42 		[SCAN_EVENT_TYPE_FOREIGN_CHANNEL_EXIT] = "FOREIGN_CHANNEL_EXIT",
43 		[SCAN_EVENT_TYPE_SUSPENDED] = "SUSPENDED",
44 		[SCAN_EVENT_TYPE_RESUMED] = "RESUMED",
45 		[SCAN_EVENT_TYPE_NLO_COMPLETE] = "NLO_COMPLETE",
46 		[SCAN_EVENT_TYPE_NLO_MATCH] = "NLO_MATCH",
47 		[SCAN_EVENT_TYPE_INVALID] = "INVALID",
48 		[SCAN_EVENT_TYPE_GPIO_TIMEOUT] = "GPIO_TIMEOUT",
49 		[SCAN_EVENT_TYPE_RADIO_MEASUREMENT_START] =
50 			"RADIO_MEASUREMENT_START",
51 		[SCAN_EVENT_TYPE_RADIO_MEASUREMENT_END] =
52 			"RADIO_MEASUREMENT_END",
53 		[SCAN_EVENT_TYPE_BSSID_MATCH] = "BSSID_MATCH",
54 		[SCAN_EVENT_TYPE_FOREIGN_CHANNEL_GET_NF] =
55 			"FOREIGN_CHANNEL_GET_NF",
56 	};
57 
58 	if (type >= SCAN_EVENT_TYPE_MAX)
59 		return "UNKNOWN";
60 
61 	return event_name[type];
62 }
63 
64 
65 const char*
66 util_scan_get_ev_reason_name(enum scan_completion_reason reason)
67 {
68 	static const char * const reason_name[] = {
69 		[SCAN_REASON_NONE] = "NONE",
70 		[SCAN_REASON_COMPLETED] = "COMPLETED",
71 		[SCAN_REASON_CANCELLED] = "CANCELLED",
72 		[SCAN_REASON_PREEMPTED] = "PREEMPTED",
73 		[SCAN_REASON_TIMEDOUT] = "TIMEDOUT",
74 		[SCAN_REASON_INTERNAL_FAILURE] = "INTERNAL_FAILURE",
75 		[SCAN_REASON_SUSPENDED] = "SUSPENDED",
76 		[SCAN_REASON_RUN_FAILED] = "RUN_FAILED",
77 		[SCAN_REASON_TERMINATION_FUNCTION] = "TERMINATION_FUNCTION",
78 		[SCAN_REASON_MAX_OFFCHAN_RETRIES] = "MAX_OFFCHAN_RETRIES",
79 	};
80 
81 	if (reason >= SCAN_REASON_MAX)
82 		return "UNKNOWN";
83 
84 	return reason_name[reason];
85 }
86 
87 qdf_time_t
88 util_get_last_scan_time(struct wlan_objmgr_vdev *vdev)
89 {
90 	uint8_t pdev_id;
91 	struct wlan_scan_obj *scan_obj;
92 
93 	if (!vdev) {
94 		scm_warn("null vdev");
95 		QDF_ASSERT(0);
96 		return 0;
97 	}
98 	pdev_id = wlan_scan_vdev_get_pdev_id(vdev);
99 	scan_obj = wlan_vdev_get_scan_obj(vdev);
100 
101 	return scan_obj->pdev_info[pdev_id].last_scan_time;
102 }
103 
104 enum wlan_band util_scan_scm_chan_to_band(uint32_t chan)
105 {
106 	if (WLAN_CHAN_IS_2GHZ(chan))
107 		return WLAN_BAND_2_4_GHZ;
108 
109 	return WLAN_BAND_5_GHZ;
110 }
111 
112 enum wlan_band util_scan_scm_freq_to_band(uint16_t freq)
113 {
114 	if (WLAN_REG_IS_24GHZ_CH_FREQ(freq))
115 		return WLAN_BAND_2_4_GHZ;
116 
117 	return WLAN_BAND_5_GHZ;
118 }
119 
120 bool util_is_scan_entry_match(
121 	struct scan_cache_entry *entry1,
122 	struct scan_cache_entry *entry2)
123 {
124 
125 	if (entry1->cap_info.wlan_caps.ess !=
126 	   entry2->cap_info.wlan_caps.ess)
127 		return false;
128 
129 	if (entry1->cap_info.wlan_caps.ess &&
130 	   !qdf_mem_cmp(entry1->bssid.bytes,
131 	   entry2->bssid.bytes, QDF_MAC_ADDR_SIZE) &&
132 	   util_scan_scm_chan_to_band(
133 	   entry1->channel.chan_idx) ==
134 	   util_scan_scm_chan_to_band(entry2->channel.chan_idx)) {
135 		/* Check for BSS */
136 		if (util_is_ssid_match(
137 		   &entry1->ssid, &entry2->ssid))
138 			return true;
139 	} else if (entry1->cap_info.wlan_caps.ibss &&
140 	   (entry1->channel.chan_idx ==
141 	   entry2->channel.chan_idx)) {
142 		/*
143 		 * Same channel cannot have same SSID for
144 		 * different IBSS, so no need to check BSSID
145 		 */
146 		if (util_is_ssid_match(
147 		   &entry1->ssid, &entry2->ssid))
148 			return true;
149 	} else if (!entry1->cap_info.wlan_caps.ibss &&
150 	   !entry1->cap_info.wlan_caps.ess &&
151 	   !qdf_mem_cmp(entry1->bssid.bytes,
152 	   entry2->bssid.bytes, QDF_MAC_ADDR_SIZE)) {
153 		/* In case of P2P devices, ess and ibss will be set to zero */
154 		return true;
155 	}
156 
157 	return false;
158 }
159 
160 static bool util_is_pureg_rate(uint8_t *rates, uint8_t nrates)
161 {
162 	static const uint8_t g_rates[] = {12, 18, 24, 36, 48, 72, 96, 108};
163 	bool pureg = false;
164 	uint8_t i, j;
165 
166 	for (i = 0; i < nrates; i++) {
167 		for (j = 0; j < QDF_ARRAY_SIZE(g_rates); j++) {
168 			if (WLAN_RV(rates[i]) == g_rates[j]) {
169 				pureg = true;
170 				break;
171 			}
172 		}
173 		if (pureg)
174 			break;
175 	}
176 
177 	return pureg;
178 }
179 static enum wlan_phymode
180 util_scan_get_phymode_5g(struct scan_cache_entry *scan_params)
181 {
182 	enum wlan_phymode phymode = WLAN_PHYMODE_AUTO;
183 	uint16_t ht_cap = 0;
184 	struct htcap_cmn_ie *htcap;
185 	struct wlan_ie_htinfo_cmn *htinfo;
186 	struct wlan_ie_vhtop *vhtop;
187 
188 	htcap = (struct htcap_cmn_ie *)
189 		util_scan_entry_htcap(scan_params);
190 	htinfo = (struct wlan_ie_htinfo_cmn *)
191 		util_scan_entry_htinfo(scan_params);
192 	vhtop = (struct wlan_ie_vhtop *)
193 		util_scan_entry_vhtop(scan_params);
194 
195 	if (!(htcap && htinfo))
196 		return WLAN_PHYMODE_11A;
197 
198 	if (htcap)
199 		ht_cap = le16toh(htcap->hc_cap);
200 
201 	if (util_scan_entry_vhtcap(scan_params) && vhtop) {
202 		switch (vhtop->vht_op_chwidth) {
203 		case WLAN_VHTOP_CHWIDTH_2040:
204 			if ((ht_cap & WLAN_HTCAP_C_CHWIDTH40) &&
205 			   (htinfo->hi_extchoff ==
206 			   WLAN_HTINFO_EXTOFFSET_ABOVE))
207 				phymode = WLAN_PHYMODE_11AC_VHT40PLUS;
208 			else if ((ht_cap & WLAN_HTCAP_C_CHWIDTH40) &&
209 			   (htinfo->hi_extchoff ==
210 			   WLAN_HTINFO_EXTOFFSET_BELOW))
211 				phymode = WLAN_PHYMODE_11AC_VHT40MINUS;
212 			else
213 				phymode = WLAN_PHYMODE_11AC_VHT20;
214 			break;
215 		case WLAN_VHTOP_CHWIDTH_80:
216 			if (WLAN_IS_REVSIG_VHT80_80(vhtop))
217 				phymode = WLAN_PHYMODE_11AC_VHT80_80;
218 			else if (WLAN_IS_REVSIG_VHT160(vhtop))
219 				phymode = WLAN_PHYMODE_11AC_VHT160;
220 			else
221 				phymode = WLAN_PHYMODE_11AC_VHT80;
222 			break;
223 		case WLAN_VHTOP_CHWIDTH_160:
224 			phymode = WLAN_PHYMODE_11AC_VHT160;
225 			break;
226 		case WLAN_VHTOP_CHWIDTH_80_80:
227 			phymode = WLAN_PHYMODE_11AC_VHT80_80;
228 			break;
229 		default:
230 			scm_err("bad channel: %d",
231 					vhtop->vht_op_chwidth);
232 			break;
233 		}
234 	} else if ((ht_cap & WLAN_HTCAP_C_CHWIDTH40) &&
235 	   (htinfo->hi_extchoff == WLAN_HTINFO_EXTOFFSET_ABOVE))
236 		phymode = WLAN_PHYMODE_11NA_HT40PLUS;
237 	else if ((ht_cap & WLAN_HTCAP_C_CHWIDTH40) &&
238 	   (htinfo->hi_extchoff == WLAN_HTINFO_EXTOFFSET_BELOW))
239 		phymode = WLAN_PHYMODE_11NA_HT40MINUS;
240 	else
241 		phymode = WLAN_PHYMODE_11NA_HT20;
242 
243 	return phymode;
244 }
245 
246 static enum wlan_phymode
247 util_scan_get_phymode_2g(struct scan_cache_entry *scan_params)
248 {
249 	enum wlan_phymode phymode = WLAN_PHYMODE_AUTO;
250 	uint16_t ht_cap = 0;
251 	struct htcap_cmn_ie *htcap;
252 	struct wlan_ie_htinfo_cmn *htinfo;
253 	struct wlan_ie_vhtop *vhtop;
254 
255 	htcap = (struct htcap_cmn_ie *)
256 		util_scan_entry_htcap(scan_params);
257 	htinfo = (struct wlan_ie_htinfo_cmn *)
258 		util_scan_entry_htinfo(scan_params);
259 	vhtop = (struct wlan_ie_vhtop *)
260 		util_scan_entry_vhtop(scan_params);
261 
262 	if (htcap)
263 		ht_cap = le16toh(htcap->hc_cap);
264 
265 	if (htcap && htinfo) {
266 		if ((ht_cap & WLAN_HTCAP_C_CHWIDTH40) &&
267 		   (htinfo->hi_extchoff == WLAN_HTINFO_EXTOFFSET_ABOVE))
268 			phymode = WLAN_PHYMODE_11NG_HT40PLUS;
269 		else if ((ht_cap & WLAN_HTCAP_C_CHWIDTH40) &&
270 		   (htinfo->hi_extchoff == WLAN_HTINFO_EXTOFFSET_BELOW))
271 			phymode = WLAN_PHYMODE_11NG_HT40MINUS;
272 		else
273 			phymode = WLAN_PHYMODE_11NG_HT20;
274 	} else if (util_scan_entry_xrates(scan_params)) {
275 		/* only 11G stations will have more than 8 rates */
276 		phymode = WLAN_PHYMODE_11G;
277 	} else {
278 		/* Some mischievous g-only APs do not set extended rates */
279 		if (util_scan_entry_rates(scan_params)) {
280 			if (util_is_pureg_rate(&scan_params->ie_list.rates[2],
281 			   scan_params->ie_list.rates[1]))
282 				phymode = WLAN_PHYMODE_11G;
283 			else
284 				phymode = WLAN_PHYMODE_11B;
285 		} else {
286 			phymode = WLAN_PHYMODE_11B;
287 		}
288 	}
289 
290 	return phymode;
291 }
292 
293 static QDF_STATUS
294 util_scan_parse_chan_switch_wrapper_ie(struct scan_cache_entry *scan_params,
295 	struct ie_header *sub_ie, qdf_size_t sub_ie_len)
296 {
297 	/* Walk through to check nothing is malformed */
298 	while (sub_ie_len >= sizeof(struct ie_header)) {
299 		/* At least one more header is present */
300 		sub_ie_len -= sizeof(struct ie_header);
301 
302 		if (sub_ie->ie_len == 0) {
303 			sub_ie += 1;
304 			continue;
305 		}
306 		if (sub_ie_len < sub_ie->ie_len) {
307 			scm_err("Incomplete corrupted IE:%x",
308 				WLAN_ELEMID_CHAN_SWITCH_WRAP);
309 			return QDF_STATUS_E_INVAL;
310 		}
311 		switch (sub_ie->ie_id) {
312 		case WLAN_ELEMID_COUNTRY:
313 			scan_params->ie_list.country = (uint8_t *)sub_ie;
314 			break;
315 		case WLAN_ELEMID_WIDE_BAND_CHAN_SWITCH:
316 			scan_params->ie_list.widebw = (uint8_t *)sub_ie;
317 			break;
318 		case WLAN_ELEMID_VHT_TX_PWR_ENVLP:
319 			scan_params->ie_list.txpwrenvlp = (uint8_t *)sub_ie;
320 			break;
321 		}
322 		/* Consume sub info element */
323 		sub_ie_len -= sub_ie->ie_len;
324 		/* go to next Sub IE */
325 		sub_ie = (struct ie_header *)
326 			(((uint8_t *) sub_ie) +
327 			sizeof(struct ie_header) + sub_ie->ie_len);
328 	}
329 
330 	return QDF_STATUS_SUCCESS;
331 }
332 
333 bool
334 util_scan_is_hidden_ssid(struct ie_ssid *ssid)
335 {
336 	uint8_t i;
337 
338 	/*
339 	 * We flag this as Hidden SSID if the Length is 0
340 	 * of the SSID only contains 0's
341 	 */
342 	if (!ssid || !ssid->ssid_len)
343 		return true;
344 
345 	for (i = 0; i < ssid->ssid_len; i++)
346 		if (ssid->ssid[i] != 0)
347 			return false;
348 
349 	/* All 0's */
350 	return true;
351 }
352 
353 static QDF_STATUS
354 util_scan_parse_extn_ie(struct scan_cache_entry *scan_params,
355 	struct ie_header *ie)
356 {
357 	struct extn_ie_header *extn_ie = (struct extn_ie_header *) ie;
358 
359 	switch (extn_ie->ie_extn_id) {
360 	case WLAN_EXTN_ELEMID_SRP:
361 		scan_params->ie_list.srp   = (uint8_t *)ie;
362 		break;
363 	case WLAN_EXTN_ELEMID_HECAP:
364 		scan_params->ie_list.hecap = (uint8_t *)ie;
365 		break;
366 	case WLAN_EXTN_ELEMID_HEOP:
367 		scan_params->ie_list.heop  = (uint8_t *)ie;
368 		break;
369 	case WLAN_EXTN_ELEMID_ESP:
370 		scan_params->ie_list.esp = (uint8_t *)ie;
371 		break;
372 	case WLAN_EXTN_ELEMID_MUEDCA:
373 		scan_params->ie_list.muedca = (uint8_t *)ie;
374 		break;
375 	default:
376 		break;
377 	}
378 	return QDF_STATUS_SUCCESS;
379 }
380 
381 static QDF_STATUS
382 util_scan_parse_vendor_ie(struct scan_cache_entry *scan_params,
383 	struct ie_header *ie)
384 {
385 	if (scan_params->ie_list.vendor == NULL)
386 		scan_params->ie_list.vendor = (uint8_t *)ie;
387 
388 	if (is_wpa_oui((uint8_t *)ie)) {
389 		scan_params->ie_list.wpa = (uint8_t *)ie;
390 	} else if (is_wps_oui((uint8_t *)ie)) {
391 		scan_params->ie_list.wps = (uint8_t *)ie;
392 		/* WCN IE should be a subset of WPS IE */
393 		if (is_wcn_oui((uint8_t *)ie))
394 			scan_params->ie_list.wcn = (uint8_t *)ie;
395 	} else if (is_wme_param((uint8_t *)ie)) {
396 		scan_params->ie_list.wmeparam = (uint8_t *)ie;
397 	} else if (is_wme_info((uint8_t *)ie)) {
398 		scan_params->ie_list.wmeinfo = (uint8_t *)ie;
399 	} else if (is_atheros_oui((uint8_t *)ie)) {
400 		scan_params->ie_list.athcaps = (uint8_t *)ie;
401 	} else if (is_atheros_extcap_oui((uint8_t *)ie)) {
402 		scan_params->ie_list.athextcaps = (uint8_t *)ie;
403 	} else if (is_sfa_oui((uint8_t *)ie)) {
404 		scan_params->ie_list.sfa = (uint8_t *)ie;
405 	} else if (is_p2p_oui((uint8_t *)ie)) {
406 		scan_params->ie_list.p2p = (uint8_t *)ie;
407 	} else if (is_qca_son_oui((uint8_t *)ie,
408 				  QCA_OUI_WHC_AP_INFO_SUBTYPE)) {
409 		scan_params->ie_list.sonadv = (uint8_t *)ie;
410 	} else if (is_ht_cap((uint8_t *)ie)) {
411 		/* we only care if there isn't already an HT IE (ANA) */
412 		if (scan_params->ie_list.htcap == NULL) {
413 			if (ie->ie_len != (WLAN_VENDOR_HT_IE_OFFSET_LEN +
414 					   sizeof(struct htcap_cmn_ie)))
415 				return QDF_STATUS_E_INVAL;
416 			scan_params->ie_list.htcap =
417 			 (uint8_t *)&(((struct wlan_vendor_ie_htcap *)ie)->ie);
418 		}
419 	} else if (is_ht_info((uint8_t *)ie)) {
420 		/* we only care if there isn't already an HT IE (ANA) */
421 		if (scan_params->ie_list.htinfo == NULL) {
422 			if (ie->ie_len != WLAN_VENDOR_HT_IE_OFFSET_LEN +
423 					  sizeof(struct wlan_ie_htinfo_cmn))
424 				return QDF_STATUS_E_INVAL;
425 			scan_params->ie_list.htinfo =
426 			  (uint8_t *)&(((struct wlan_vendor_ie_htinfo *)
427 			  ie)->hi_ie);
428 		}
429 	} else if (is_interop_vht((uint8_t *)ie) &&
430 	    !(scan_params->ie_list.vhtop)) {
431 		uint8_t *vendor_ie = (uint8_t *)(ie);
432 
433 		if (ie->ie_len < ((WLAN_VENDOR_VHTCAP_IE_OFFSET +
434 				 sizeof(struct wlan_ie_vhtcaps)) -
435 				 sizeof(struct ie_header)))
436 			return QDF_STATUS_E_INVAL;
437 		vendor_ie = ((uint8_t *)(ie)) + WLAN_VENDOR_VHTCAP_IE_OFFSET;
438 		if (vendor_ie[1] != (sizeof(struct wlan_ie_vhtcaps)) -
439 				      sizeof(struct ie_header))
440 			return QDF_STATUS_E_INVAL;
441 		/* location where Interop Vht Cap IE and VHT OP IE Present */
442 		scan_params->ie_list.vhtcap = (((uint8_t *)(ie)) +
443 						WLAN_VENDOR_VHTCAP_IE_OFFSET);
444 		if (ie->ie_len > ((WLAN_VENDOR_VHTCAP_IE_OFFSET +
445 				 sizeof(struct wlan_ie_vhtcaps)) -
446 				 sizeof(struct ie_header)) &&
447 		    ie->ie_len < ((WLAN_VENDOR_VHTOP_IE_OFFSET +
448 				  sizeof(struct wlan_ie_vhtop)) -
449 				  sizeof(struct ie_header)))
450 			return QDF_STATUS_E_INVAL;
451 		vendor_ie = ((uint8_t *)(ie)) + WLAN_VENDOR_VHTOP_IE_OFFSET;
452 		if (vendor_ie[1] != (sizeof(struct wlan_ie_vhtop) -
453 				     sizeof(struct ie_header)))
454 			return QDF_STATUS_E_INVAL;
455 		scan_params->ie_list.vhtop = (((uint8_t *)(ie)) +
456 						WLAN_VENDOR_VHTOP_IE_OFFSET);
457 	} else if (is_bwnss_oui((uint8_t *)ie)) {
458 		/*
459 		 * Bandwidth-NSS map has sub-type & version.
460 		 * hence copy data just after version byte
461 		 */
462 		scan_params->ie_list.bwnss_map = (((uint8_t *)ie) + 8);
463 	} else if (is_mbo_oce_oui((uint8_t *)ie)) {
464 		scan_params->ie_list.mbo_oce = (uint8_t *)ie;
465 	}
466 	return QDF_STATUS_SUCCESS;
467 }
468 
469 static QDF_STATUS
470 util_scan_populate_bcn_ie_list(struct scan_cache_entry *scan_params)
471 {
472 	struct ie_header *ie, *sub_ie;
473 	uint32_t ie_len, sub_ie_len;
474 	QDF_STATUS status;
475 
476 	ie_len = util_scan_entry_ie_len(scan_params);
477 	ie = (struct ie_header *)
478 		  util_scan_entry_ie_data(scan_params);
479 
480 	while (ie_len >= sizeof(struct ie_header)) {
481 		ie_len -= sizeof(struct ie_header);
482 
483 		if (!ie->ie_len) {
484 			ie += 1;
485 			continue;
486 		}
487 
488 		if (ie_len < ie->ie_len) {
489 			scm_debug("Incomplete corrupted IE:%x",
490 				ie->ie_id);
491 			return QDF_STATUS_E_INVAL;
492 		}
493 
494 		switch (ie->ie_id) {
495 		case WLAN_ELEMID_SSID:
496 			if (ie->ie_len > (sizeof(struct ie_ssid) -
497 					  sizeof(struct ie_header)))
498 				return QDF_STATUS_E_INVAL;
499 			scan_params->ie_list.ssid = (uint8_t *)ie;
500 			break;
501 		case WLAN_ELEMID_RATES:
502 			if (ie->ie_len > WLAN_SUPPORTED_RATES_IE_MAX_LEN)
503 				return QDF_STATUS_E_INVAL;
504 			scan_params->ie_list.rates = (uint8_t *)ie;
505 			break;
506 		case WLAN_ELEMID_DSPARMS:
507 			if (ie->ie_len != WLAN_DS_PARAM_IE_MAX_LEN)
508 				return QDF_STATUS_E_INVAL;
509 			scan_params->ie_list.ds_param = (uint8_t *)ie;
510 			scan_params->channel.chan_idx =
511 				((struct ds_ie *)ie)->cur_chan;
512 			break;
513 		case WLAN_ELEMID_TIM:
514 			if (ie->ie_len < WLAN_TIM_IE_MIN_LENGTH)
515 				return QDF_STATUS_E_INVAL;
516 			scan_params->ie_list.tim = (uint8_t *)ie;
517 			scan_params->dtim_period =
518 				((struct wlan_tim_ie *)ie)->tim_period;
519 			break;
520 		case WLAN_ELEMID_COUNTRY:
521 			if (ie->ie_len < WLAN_COUNTRY_IE_MIN_LEN)
522 				return QDF_STATUS_E_INVAL;
523 			scan_params->ie_list.country = (uint8_t *)ie;
524 			break;
525 		case WLAN_ELEMID_QBSS_LOAD:
526 			if (ie->ie_len != sizeof(struct qbss_load_ie) -
527 					  sizeof(struct ie_header))
528 				return QDF_STATUS_E_INVAL;
529 			scan_params->ie_list.qbssload = (uint8_t *)ie;
530 			break;
531 		case WLAN_ELEMID_CHANSWITCHANN:
532 			if (ie->ie_len != WLAN_CSA_IE_MAX_LEN)
533 				return QDF_STATUS_E_INVAL;
534 			scan_params->ie_list.csa = (uint8_t *)ie;
535 			break;
536 		case WLAN_ELEMID_IBSSDFS:
537 			if (ie->ie_len < WLAN_IBSSDFS_IE_MIN_LEN)
538 				return QDF_STATUS_E_INVAL;
539 			scan_params->ie_list.ibssdfs = (uint8_t *)ie;
540 			break;
541 		case WLAN_ELEMID_QUIET:
542 			if (ie->ie_len != WLAN_QUIET_IE_MAX_LEN)
543 				return QDF_STATUS_E_INVAL;
544 			scan_params->ie_list.quiet = (uint8_t *)ie;
545 			break;
546 		case WLAN_ELEMID_ERP:
547 			if (ie->ie_len != (sizeof(struct erp_ie) -
548 					    sizeof(struct ie_header)))
549 				return QDF_STATUS_E_INVAL;
550 			scan_params->erp = ((struct erp_ie *)ie)->value;
551 			break;
552 		case WLAN_ELEMID_HTCAP_ANA:
553 			if (ie->ie_len != sizeof(struct htcap_cmn_ie))
554 				return QDF_STATUS_E_INVAL;
555 			scan_params->ie_list.htcap =
556 				(uint8_t *)&(((struct htcap_ie *)ie)->ie);
557 			break;
558 		case WLAN_ELEMID_RSN:
559 			if (ie->ie_len < WLAN_RSN_IE_MIN_LEN)
560 				return QDF_STATUS_E_INVAL;
561 			scan_params->ie_list.rsn = (uint8_t *)ie;
562 			break;
563 		case WLAN_ELEMID_XRATES:
564 			scan_params->ie_list.xrates = (uint8_t *)ie;
565 			break;
566 		case WLAN_ELEMID_EXTCHANSWITCHANN:
567 			if (ie->ie_len != WLAN_XCSA_IE_MAX_LEN)
568 				return QDF_STATUS_E_INVAL;
569 			scan_params->ie_list.xcsa = (uint8_t *)ie;
570 			break;
571 		case WLAN_ELEMID_SECCHANOFFSET:
572 			if (ie->ie_len != WLAN_SECCHANOFF_IE_MAX_LEN)
573 				return QDF_STATUS_E_INVAL;
574 			scan_params->ie_list.secchanoff = (uint8_t *)ie;
575 			break;
576 		case WLAN_ELEMID_HTINFO_ANA:
577 			if (ie->ie_len != sizeof(struct wlan_ie_htinfo_cmn))
578 				return QDF_STATUS_E_INVAL;
579 			scan_params->ie_list.htinfo =
580 			  (uint8_t *)&(((struct wlan_ie_htinfo *) ie)->hi_ie);
581 			scan_params->channel.chan_idx =
582 			  ((struct wlan_ie_htinfo_cmn *)
583 			  (scan_params->ie_list.htinfo))->hi_ctrlchannel;
584 			break;
585 		case WLAN_ELEMID_WAPI:
586 			if (ie->ie_len < WLAN_WAPI_IE_MIN_LEN)
587 				return QDF_STATUS_E_INVAL;
588 			scan_params->ie_list.wapi = (uint8_t *)ie;
589 			break;
590 		case WLAN_ELEMID_XCAPS:
591 			if (ie->ie_len > WLAN_EXTCAP_IE_MAX_LEN)
592 				return QDF_STATUS_E_INVAL;
593 			scan_params->ie_list.extcaps = (uint8_t *)ie;
594 			break;
595 		case WLAN_ELEMID_VHTCAP:
596 			if (ie->ie_len != (sizeof(struct wlan_ie_vhtcaps) -
597 					   sizeof(struct ie_header)))
598 				return QDF_STATUS_E_INVAL;
599 			scan_params->ie_list.vhtcap = (uint8_t *)ie;
600 			break;
601 		case WLAN_ELEMID_VHTOP:
602 			if (ie->ie_len != (sizeof(struct wlan_ie_vhtop) -
603 					   sizeof(struct ie_header)))
604 				return QDF_STATUS_E_INVAL;
605 			scan_params->ie_list.vhtop = (uint8_t *)ie;
606 			break;
607 		case WLAN_ELEMID_OP_MODE_NOTIFY:
608 			if (ie->ie_len != WLAN_OPMODE_IE_MAX_LEN)
609 				return QDF_STATUS_E_INVAL;
610 				scan_params->ie_list.opmode = (uint8_t *)ie;
611 			break;
612 		case WLAN_ELEMID_MOBILITY_DOMAIN:
613 			if (ie->ie_len != WLAN_MOBILITY_DOMAIN_IE_MAX_LEN)
614 				return QDF_STATUS_E_INVAL;
615 			scan_params->ie_list.mdie = (uint8_t *)ie;
616 			break;
617 		case WLAN_ELEMID_VENDOR:
618 			status = util_scan_parse_vendor_ie(scan_params,
619 							   ie);
620 			if (QDF_IS_STATUS_ERROR(status))
621 				return status;
622 			break;
623 		case WLAN_ELEMID_CHAN_SWITCH_WRAP:
624 			scan_params->ie_list.cswrp = (uint8_t *)ie;
625 			/* Go to next sub IE */
626 			sub_ie = (struct ie_header *)
627 			(((uint8_t *)ie) + sizeof(struct ie_header));
628 			sub_ie_len = ie->ie_len;
629 			status =
630 				util_scan_parse_chan_switch_wrapper_ie(
631 					scan_params, sub_ie, sub_ie_len);
632 			if (QDF_IS_STATUS_ERROR(status)) {
633 				scm_err("failed to parse chan_switch_wrapper_ie");
634 				return status;
635 			}
636 			break;
637 		case WLAN_ELEMID_FILS_INDICATION:
638 			if (ie->ie_len < WLAN_FILS_INDICATION_IE_MIN_LEN)
639 				return QDF_STATUS_E_INVAL;
640 			scan_params->ie_list.fils_indication = (uint8_t *)ie;
641 			break;
642 		case WLAN_ELEMID_EXTN_ELEM:
643 			status = util_scan_parse_extn_ie(scan_params, ie);
644 			if (QDF_IS_STATUS_ERROR(status))
645 				return status;
646 			break;
647 		default:
648 			break;
649 		}
650 
651 		/* Consume info element */
652 		ie_len -= ie->ie_len;
653 		/* Go to next IE */
654 		ie = (struct ie_header *)
655 			(((uint8_t *) ie) +
656 			sizeof(struct ie_header) +
657 			ie->ie_len);
658 	}
659 
660 	return QDF_STATUS_SUCCESS;
661 }
662 
663 /**
664  * util_scan_update_esp_data: update ESP params from beacon/probe response
665  * @esp_information: pointer to wlan_esp_information
666  * @scan_entry: new received entry
667  *
668  * The Estimated Service Parameters element is
669  * used by a AP to provide information to another STA which
670  * can then use the information as input to an algorithm to
671  * generate an estimate of throughput between the two STAs.
672  * The ESP Information List field contains from 1 to 4 ESP
673  * Information fields(each field 24 bits), each corresponding
674  * to an access category for which estimated service parameters
675  * information is provided.
676  *
677  * Return: None
678  */
679 static void util_scan_update_esp_data(struct wlan_esp_ie *esp_information,
680 		struct scan_cache_entry *scan_entry)
681 {
682 
683 	uint8_t *data;
684 	int i = 0;
685 	uint64_t total_elements;
686 	struct wlan_esp_info *esp_info;
687 	struct wlan_esp_ie *esp_ie;
688 
689 	esp_ie = (struct wlan_esp_ie *)
690 		util_scan_entry_esp_info(scan_entry);
691 
692 	total_elements  = esp_ie->esp_len;
693 	data = (uint8_t *)esp_ie + 3;
694 	do_div(total_elements, ESP_INFORMATION_LIST_LENGTH);
695 
696 	if (total_elements > MAX_ESP_INFORMATION_FIELD) {
697 		scm_err("No of Air time fractions are greater than supported");
698 		return;
699 	}
700 
701 	for (i = 0; i < total_elements; i++) {
702 		esp_info = (struct wlan_esp_info *)data;
703 		if (esp_info->access_category == ESP_AC_BK) {
704 			qdf_mem_copy(&esp_information->esp_info_AC_BK,
705 					data, 3);
706 			data = data + ESP_INFORMATION_LIST_LENGTH;
707 			continue;
708 		}
709 		if (esp_info->access_category == ESP_AC_BE) {
710 			qdf_mem_copy(&esp_information->esp_info_AC_BE,
711 					data, 3);
712 			data = data + ESP_INFORMATION_LIST_LENGTH;
713 			continue;
714 		}
715 		if (esp_info->access_category == ESP_AC_VI) {
716 			qdf_mem_copy(&esp_information->esp_info_AC_VI,
717 					data, 3);
718 			data = data + ESP_INFORMATION_LIST_LENGTH;
719 			continue;
720 		}
721 		if (esp_info->access_category == ESP_AC_VO) {
722 			qdf_mem_copy(&esp_information->esp_info_AC_VO,
723 					data, 3);
724 			data = data + ESP_INFORMATION_LIST_LENGTH;
725 			break;
726 		}
727 	}
728 }
729 
730 /**
731  * util_scan_scm_update_bss_with_esp_dataa: calculate estimated air time
732  * fraction
733  * @scan_entry: new received entry
734  *
735  * This function process all Access category ESP params and provide
736  * best effort air time fraction.
737  * If best effort is not available, it will choose VI, VO and BK in sequence
738  *
739  */
740 static void util_scan_scm_update_bss_with_esp_data(
741 		struct scan_cache_entry *scan_entry)
742 {
743 	uint8_t air_time_fraction = 0;
744 	struct wlan_esp_ie esp_information;
745 
746 	if (!scan_entry->ie_list.esp)
747 		return;
748 
749 	util_scan_update_esp_data(&esp_information, scan_entry);
750 
751 	/*
752 	 * If the ESP metric is transmitting multiple airtime fractions, then
753 	 * follow the sequence AC_BE, AC_VI, AC_VO, AC_BK and pick whichever is
754 	 * the first one available
755 	 */
756 	if (esp_information.esp_info_AC_BE.access_category
757 			== ESP_AC_BE)
758 		air_time_fraction =
759 			esp_information.esp_info_AC_BE.
760 			estimated_air_fraction;
761 	else if (esp_information.esp_info_AC_VI.access_category
762 			== ESP_AC_VI)
763 		air_time_fraction =
764 			esp_information.esp_info_AC_VI.
765 			estimated_air_fraction;
766 	else if (esp_information.esp_info_AC_VO.access_category
767 			== ESP_AC_VO)
768 		air_time_fraction =
769 			esp_information.esp_info_AC_VO.
770 			estimated_air_fraction;
771 	else if (esp_information.esp_info_AC_BK.access_category
772 			== ESP_AC_BK)
773 		air_time_fraction =
774 			esp_information.esp_info_AC_BK.
775 				estimated_air_fraction;
776 	scan_entry->air_time_fraction = air_time_fraction;
777 }
778 
779 /**
780  * util_scan_scm_calc_nss_supported_by_ap() - finds out nss from AP
781  * @scan_entry: new received entry
782  *
783  * Return: number of nss advertised by AP
784  */
785 static int util_scan_scm_calc_nss_supported_by_ap(
786 		struct scan_cache_entry *scan_params)
787 {
788 	struct htcap_cmn_ie *htcap;
789 	struct wlan_ie_vhtcaps *vhtcaps;
790 	uint8_t rx_mcs_map;
791 
792 	htcap = (struct htcap_cmn_ie *)
793 		util_scan_entry_htcap(scan_params);
794 	vhtcaps = (struct wlan_ie_vhtcaps *)
795 		util_scan_entry_vhtcap(scan_params);
796 	if (vhtcaps) {
797 		rx_mcs_map = vhtcaps->rx_mcs_map;
798 		if ((rx_mcs_map & 0xC0) != 0xC0)
799 			return 4;
800 
801 		if ((rx_mcs_map & 0x30) != 0x30)
802 			return 3;
803 
804 		if ((rx_mcs_map & 0x0C) != 0x0C)
805 			return 2;
806 	} else if (htcap) {
807 		if (htcap->mcsset[3])
808 			return 4;
809 
810 		if (htcap->mcsset[2])
811 			return 3;
812 
813 		if (htcap->mcsset[1])
814 			return 2;
815 
816 	}
817 	return 1;
818 }
819 
820 qdf_list_t *
821 util_scan_unpack_beacon_frame(struct wlan_objmgr_pdev *pdev, uint8_t *frame,
822 	qdf_size_t frame_len, uint32_t frm_subtype,
823 	struct mgmt_rx_event_params *rx_param)
824 {
825 	struct wlan_frame_hdr *hdr;
826 	struct wlan_bcn_frame *bcn;
827 	QDF_STATUS status;
828 	struct ie_ssid *ssid;
829 	struct scan_cache_entry *scan_entry;
830 	struct qbss_load_ie *qbss_load;
831 	qdf_list_t *scan_list;
832 	struct scan_cache_node *scan_node;
833 
834 	scan_list = qdf_mem_malloc(sizeof(*scan_list));
835 	if (!scan_list) {
836 		scm_err("failed to allocate scan_list");
837 		return NULL;
838 	}
839 	qdf_list_create(scan_list, MAX_SCAN_CACHE_SIZE);
840 
841 	scan_entry = qdf_mem_malloc(sizeof(*scan_entry));
842 	if (!scan_entry) {
843 		scm_err("failed to allocate memory for scan_entry");
844 		qdf_mem_free(scan_list);
845 		return NULL;
846 	}
847 	scan_entry->raw_frame.ptr =
848 			qdf_mem_malloc(frame_len);
849 	if (!scan_entry->raw_frame.ptr) {
850 		scm_err("failed to allocate memory for frame");
851 		qdf_mem_free(scan_entry);
852 		qdf_mem_free(scan_list);
853 		return NULL;
854 	}
855 
856 	bcn = (struct wlan_bcn_frame *)
857 			   (frame + sizeof(*hdr));
858 	hdr = (struct wlan_frame_hdr *)frame;
859 
860 	/* update timestamp in nanoseconds needed by kernel layers */
861 	scan_entry->boottime_ns = qdf_get_bootbased_boottime_ns();
862 
863 	scan_entry->frm_subtype = frm_subtype;
864 	qdf_mem_copy(scan_entry->bssid.bytes,
865 		hdr->i_addr3, QDF_MAC_ADDR_SIZE);
866 	/* Scr addr */
867 	qdf_mem_copy(scan_entry->mac_addr.bytes,
868 		hdr->i_addr2, QDF_MAC_ADDR_SIZE);
869 	scan_entry->seq_num =
870 		(le16toh(*(uint16_t *)hdr->i_seq) >> WLAN_SEQ_SEQ_SHIFT);
871 
872 	scan_entry->rssi_raw = rx_param->rssi;
873 	scan_entry->avg_rssi = WLAN_RSSI_IN(scan_entry->rssi_raw);
874 	scan_entry->tsf_delta = rx_param->tsf_delta;
875 
876 	/* Copy per chain rssi to scan entry */
877 	qdf_mem_copy(scan_entry->per_chain_snr, rx_param->rssi_ctl,
878 		     WLAN_MGMT_TXRX_HOST_MAX_ANTENNA);
879 
880 	/* store jiffies */
881 	scan_entry->rrm_parent_tsf = (u_int32_t) qdf_system_ticks();
882 
883 	scan_entry->bcn_int = le16toh(bcn->beacon_interval);
884 
885 	/*
886 	 * In case if the beacon dosnt have
887 	 * valid beacon interval falback to def
888 	 */
889 	if (!scan_entry->bcn_int)
890 		scan_entry->bcn_int = 100;
891 	scan_entry->cap_info.value = le16toh(bcn->capability.value);
892 	qdf_mem_copy(scan_entry->tsf_info.data,
893 		bcn->timestamp, 8);
894 	scan_entry->erp = ERP_NON_ERP_PRESENT;
895 
896 	scan_entry->scan_entry_time =
897 		qdf_mc_timer_get_system_time();
898 
899 	scan_entry->raw_frame.len = frame_len;
900 	qdf_mem_copy(scan_entry->raw_frame.ptr,
901 		frame, frame_len);
902 	status = util_scan_populate_bcn_ie_list(scan_entry);
903 	if (QDF_IS_STATUS_ERROR(status)) {
904 		scm_debug("failed to parse beacon IE");
905 		qdf_mem_free(scan_entry->raw_frame.ptr);
906 		qdf_mem_free(scan_entry);
907 		qdf_mem_free(scan_list);
908 		return NULL;
909 	}
910 
911 	if (!scan_entry->ie_list.rates) {
912 		qdf_mem_free(scan_entry->raw_frame.ptr);
913 		qdf_mem_free(scan_entry);
914 		qdf_mem_free(scan_list);
915 		return NULL;
916 	}
917 
918 	ssid = (struct ie_ssid *)
919 		scan_entry->ie_list.ssid;
920 
921 	if (ssid && (ssid->ssid_len > WLAN_SSID_MAX_LEN)) {
922 		qdf_mem_free(scan_entry->raw_frame.ptr);
923 		qdf_mem_free(scan_entry);
924 		qdf_mem_free(scan_list);
925 		return NULL;
926 	}
927 
928 	if (scan_entry->ie_list.p2p)
929 		scan_entry->is_p2p = true;
930 
931 	/* If no channel info is present in beacon use meta channel */
932 	if (!scan_entry->channel.chan_idx) {
933 		scan_entry->channel.chan_idx =
934 				rx_param->channel;
935 	} else if (rx_param->channel !=
936 	   scan_entry->channel.chan_idx) {
937 		if (!wlan_reg_chan_is_49ghz(pdev, scan_entry->channel.chan_idx))
938 			scan_entry->channel_mismatch = true;
939 	}
940 
941 	if (util_scan_is_hidden_ssid(ssid)) {
942 		scan_entry->ie_list.ssid = NULL;
943 	} else {
944 		qdf_mem_copy(scan_entry->ssid.ssid,
945 				ssid->ssid, WLAN_SSID_MAX_LEN);
946 		scan_entry->ssid.length = ssid->ssid_len;
947 		scan_entry->hidden_ssid_timestamp =
948 			scan_entry->scan_entry_time;
949 	}
950 
951 	if (WLAN_CHAN_IS_5GHZ(scan_entry->channel.chan_idx))
952 		scan_entry->phy_mode = util_scan_get_phymode_5g(scan_entry);
953 	else
954 		scan_entry->phy_mode = util_scan_get_phymode_2g(scan_entry);
955 
956 	scan_entry->nss = util_scan_scm_calc_nss_supported_by_ap(scan_entry);
957 	util_scan_scm_update_bss_with_esp_data(scan_entry);
958 	qbss_load = (struct qbss_load_ie *)
959 			util_scan_entry_qbssload(scan_entry);
960 	if (qbss_load)
961 		scan_entry->qbss_chan_load = qbss_load->qbss_chan_load;
962 
963 	scan_node = qdf_mem_malloc(sizeof(*scan_node));
964 	if (!scan_node) {
965 		qdf_mem_free(scan_entry->raw_frame.ptr);
966 		qdf_mem_free(scan_entry);
967 		qdf_mem_free(scan_list);
968 		return NULL;
969 	}
970 
971 	scan_node->entry = scan_entry;
972 	qdf_list_insert_front(scan_list, &scan_node->node);
973 
974 	/* TODO calculate channel struct */
975 	return scan_list;
976 }
977 
978 QDF_STATUS
979 util_scan_entry_update_mlme_info(struct wlan_objmgr_pdev *pdev,
980 	struct scan_cache_entry *scan_entry)
981 {
982 
983 	if (!pdev || !scan_entry) {
984 		scm_err("pdev 0x%pK, scan_entry: 0x%pK", pdev, scan_entry);
985 		return QDF_STATUS_E_INVAL;
986 	}
987 
988 	return scm_update_scan_mlme_info(pdev, scan_entry);
989 }
990