xref: /wlan-dirver/qca-wifi-host-cmn/umac/scan/core/src/wlan_scan_main.h (revision 8ddef7dd9a290d4a9b1efd5d3efacf51d78a1a0d)
1 /*
2  * Copyright (c) 2017-2019 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: contains scan init/deinit public api
21  */
22 
23 #ifndef _WLAN_SCAN_MAIN_API_H_
24 #define _WLAN_SCAN_MAIN_API_H_
25 
26 #include <qdf_atomic.h>
27 #include <wlan_objmgr_psoc_obj.h>
28 #include <wlan_objmgr_pdev_obj.h>
29 #include <wlan_objmgr_vdev_obj.h>
30 #include <wlan_scan_public_structs.h>
31 #include "wlan_scan_cache_db.h"
32 #include "wlan_scan_11d.h"
33 
34 #define scm_alert(params...) \
35 	QDF_TRACE_FATAL(QDF_MODULE_ID_SCAN, params)
36 #define scm_err(params...) \
37 	QDF_TRACE_ERROR(QDF_MODULE_ID_SCAN, params)
38 #define scm_warn(params...) \
39 	QDF_TRACE_WARN(QDF_MODULE_ID_SCAN, params)
40 #define scm_notice(params...) \
41 	QDF_TRACE_INFO(QDF_MODULE_ID_SCAN, params)
42 #define scm_info(params...) \
43 	QDF_TRACE_INFO(QDF_MODULE_ID_SCAN, params)
44 #define scm_debug(params...) \
45 	QDF_TRACE_DEBUG(QDF_MODULE_ID_SCAN, params)
46 
47 /* Rate Limited Logs */
48 #define scm_alert_rl(params...) \
49 	QDF_TRACE_FATAL_RL(QDF_MODULE_ID_SCAN, params)
50 #define scm_err_rl(params...) \
51 	QDF_TRACE_ERROR_RL(QDF_MODULE_ID_SCAN, params)
52 #define scm_warn_rl(params...) \
53 	QDF_TRACE_WARN_RL(QDF_MODULE_ID_SCAN, params)
54 #define scm_info_rl(params...) \
55 	QDF_TRACE_INFO_RL(QDF_MODULE_ID_SCAN, params)
56 #define scm_debug_rl(params...) \
57 	QDF_TRACE_DEBUG_RL(QDF_MODULE_ID_SCAN, params)
58 
59 #define scm_nofl_alert(params...) \
60 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_SCAN, params)
61 #define scm_nofl_err(params...) \
62 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_SCAN, params)
63 #define scm_nofl_warn(params...) \
64 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_SCAN, params)
65 #define scm_nofl_info(params...) \
66 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_SCAN, params)
67 #define scm_nofl_debug(params...) \
68 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_SCAN, params)
69 
70 #define scm_hex_dump(level, data, buf_len) \
71 		qdf_trace_hex_dump(QDF_MODULE_ID_SCAN, level, data, buf_len)
72 
73 #define MAX_SCAN_EVENT_HANDLERS_PER_PDEV   100
74 #define WLAN_MAX_MODULE_NAME    40
75 #define WLAN_MAX_REQUESTORS     200
76 #define WLAN_SCAN_ID_MASK 0x00000FFF
77 #define WLAN_HOST_SCAN_REQ_ID_PREFIX 0x0000A000
78 #define SCAN_NPROBES_DEFAULT 2
79 #define WLAN_P2P_SOCIAL_CHANNELS 3
80 
81 #define SCAN_BURST_SCAN_MAX_NUM_OFFCHANNELS  (3)
82 #define SCAN_SCAN_IDLE_TIME_DEFAULT          (25)
83 #define SCAN_3PORT_CONC_SCAN_MAX_BURST_DURATION  (25)
84 #define SCAN_CTS_DURATION_MS_MAX             (32)
85 #define SCAN_ROAM_SCAN_CHANNEL_SWITCH_TIME    (4)
86 #define SCAN_DWELL_TIME_PROBE_TIME_MAP_SIZE      (11)
87 #define SCAN_GO_MIN_ACTIVE_SCAN_BURST_DURATION   (40)
88 #define SCAN_GO_MAX_ACTIVE_SCAN_BURST_DURATION   (240)
89 #define SCAN_P2P_SCAN_MAX_BURST_DURATION     (240)
90 #define SCAN_GO_BURST_SCAN_MAX_NUM_OFFCHANNELS   (6)
91 
92 /**
93  * struct probe_time_dwell_time - probe time, dwell time map
94  * @dwell_time: dwell time
95  * @probe_time: repeat probe time
96  */
97 struct probe_time_dwell_time {
98 	uint8_t dwell_time;
99 	uint8_t probe_time;
100 };
101 
102 /*
103  * For the requestor id:
104  *     bit  0~12 is used for real requestor id.
105  *     bit 13~15 is used for requestor prefix.
106  *     bit 16~19 is used by specific user to aware it is issued by himself.
107  *     bit 20~31 is reserved.
108  */
109 #define WLAN_SCAN_REQUESTER_ID_PREFIX 0x0000A000
110 #define WLAN_SCAN_REQUESTER_ID_MASK 0x00001FFF
111 
112 #define SCM_NUM_RSSI_CAT        15
113 #define SCAN_STA_MIRACAST_MCC_REST_TIME 400
114 
115 #ifdef CONFIG_MCL
116 #define MAX_SCAN_CACHE_SIZE 300
117 #define SCAN_MAX_REST_TIME 0
118 #define SCAN_MIN_REST_TIME 0
119 #define SCAN_BURST_DURATION 0
120 #define SCAN_PROBE_SPACING_TIME 0
121 #define SCAN_PROBE_DELAY 0
122 #define SCAN_MAX_SCAN_TIME 30000
123 #define SCAN_NETWORK_IDLE_TIMEOUT 0
124 #define HIDDEN_SSID_TIME (1*60*1000)
125 #define SCAN_CHAN_STATS_EVENT_ENAB (false)
126 #else
127 #define MAX_SCAN_CACHE_SIZE 1024
128 #define SCAN_MAX_REST_TIME 0
129 #define SCAN_MIN_REST_TIME 50
130 #define SCAN_BURST_DURATION 0
131 #define SCAN_PROBE_SPACING_TIME 0
132 #define SCAN_PROBE_DELAY 0
133 #define SCAN_MAX_SCAN_TIME 50000
134 #define SCAN_NETWORK_IDLE_TIMEOUT 200
135 #define HIDDEN_SSID_TIME (0xFFFFFFFF)
136 #define SCAN_CHAN_STATS_EVENT_ENAB (true)
137 #endif
138 
139 #define SCAN_TIMEOUT_GRACE_PERIOD 10
140 #define SCAN_MAX_BSS_PDEV 100
141 #define SCAN_PRIORITY SCAN_PRIORITY_LOW
142 
143 /* DBS Scan policy selection ext flags */
144 #define SCAN_FLAG_EXT_DBS_SCAN_POLICY_MASK  0x00000003
145 #define SCAN_FLAG_EXT_DBS_SCAN_POLICY_BIT   0
146 #define SCAN_DBS_POLICY_DEFAULT             0x0
147 #define SCAN_DBS_POLICY_FORCE_NONDBS        0x1
148 #define SCAN_DBS_POLICY_IGNORE_DUTY         0x2
149 #define SCAN_DBS_POLICY_MAX                 0x3
150 /* Minimum number of channels for enabling DBS Scan */
151 #define SCAN_MIN_CHAN_DBS_SCAN_THRESHOLD         8
152 /*
153  * Enable Reception of Public Action frame with this flag
154  */
155 #define SCAN_FLAG_EXT_FILTER_PUBLIC_ACTION_FRAME 0x4
156 
157 /* Passive dwell time if bt_a2dp is enabled. Time in msecs*/
158 #define PASSIVE_DWELL_TIME_BT_A2DP_ENABLED 28
159 
160 /**
161  * struct cb_handler - defines scan event handler
162  * call back function and arguments
163  * @func: handler function pointer
164  * @arg: argument to handler function
165  */
166 struct cb_handler {
167 	scan_event_handler func;
168 	void *arg;
169 };
170 
171 /**
172  * struct pdev_scan_ev_handler - pdev scan event handlers
173  * @cb_handler: array of registered scan handlers
174  */
175 struct pdev_scan_ev_handler {
176 	uint32_t handler_cnt;
177 	struct cb_handler cb_handlers[MAX_SCAN_EVENT_HANDLERS_PER_PDEV];
178 };
179 
180 /**
181  * struct global_scan_ev_handlers - per pdev registered scan event handlers
182  * @pdev_scan_ev_handler: per pdev registered scan event handlers
183  */
184 struct global_scan_ev_handlers {
185 	struct pdev_scan_ev_handler pdev_ev_handlers[WLAN_UMAC_MAX_PDEVS];
186 };
187 
188 /**
189  * struct scan_requester_info - defines scan requester id
190  * and event handler mapping
191  * @requester:   requester ID allocated
192  * @module:      module name of requester
193  * @ev_handler:  event handlerto be invoked
194  */
195 struct scan_requester_info {
196 	wlan_scan_requester requester;
197 	uint8_t module[WLAN_MAX_MODULE_NAME];
198 	struct cb_handler ev_handler;
199 };
200 
201 /**
202  * struct pdev_scan_info - defines per pdev scan info
203  * @wide_band_scan: wide band scan capability
204  * @last_scan_time: time of last scan start on this pdev
205  * @custom_chan_list: scan only these channels
206  * @conf_bssid: configured bssid of the hidden AP
207  * @conf_ssid: configured desired ssid
208  */
209 struct pdev_scan_info {
210 	bool wide_band_scan;
211 	qdf_time_t last_scan_time;
212 	struct chan_list custom_chan_list;
213 	uint8_t conf_bssid[QDF_MAC_ADDR_SIZE];
214 	struct wlan_ssid conf_ssid;
215 };
216 
217 /**
218  * struct scan_vdev_obj - scan vdev obj
219  * @pno_match_evt_received: pno match received
220  * @pno_in_progress: pno in progress
221  * @scan_disabled: if scan is disabled for this vdev
222  * @first_scan_done: Whether its the first scan or not for this particular vdev.
223  */
224 struct scan_vdev_obj {
225 	bool pno_match_evt_received;
226 	bool pno_in_progress;
227 	uint32_t scan_disabled;
228 	bool first_scan_done;
229 };
230 
231 #ifdef FEATURE_WLAN_SCAN_PNO
232 /**
233  * struct pno_def_config - def configuration for PNO
234  * @pno_offload_enabled: flag to check if PNO offload is enabled/disabled
235  * @channel_prediction: config PNO channel prediction feature status
236  * @top_k_num_of_channels: def top K number of channels are used for tanimoto
237  * distance calculation.
238  * @stationary_thresh: def threshold val to determine that STA is stationary.
239  * @pnoscan_adaptive_dwell_mode: def adaptive dwelltime mode for pno scan
240  * @channel_prediction_full_scan: def periodic timer upon which full scan needs
241  * to be triggered.
242  * @dfs_chnl_scan_enable: Enable dfs channel PNO scan
243  * @scan_support_enabled: PNO scan support enabled/disabled
244  * @scan_timer_repeat_value: PNO scan timer repeat value
245  * @slow_scan_multiplier: PNO slow scan timer multiplier
246  * @max_sched_scan_plan_interval: PNO scan interval
247  * @max_sched_scan_plan_iterations: PNO scan number of iterations
248  * @scan_backoff_multiplier: Scan banckoff multiplier
249  * @pno_wake_lock: pno wake lock
250  * @pno_cb: callback to call on PNO completion
251  * @mawc_params: Configuration parameters for NLO MAWC.
252  */
253 struct pno_def_config {
254 	bool pno_offload_enabled;
255 	bool channel_prediction;
256 	uint8_t top_k_num_of_channels;
257 	uint8_t stationary_thresh;
258 	enum scan_dwelltime_adaptive_mode adaptive_dwell_mode;
259 	uint32_t channel_prediction_full_scan;
260 	bool dfs_chnl_scan_enabled;
261 	bool scan_support_enabled;
262 	uint32_t scan_timer_repeat_value;
263 	uint32_t slow_scan_multiplier;
264 	uint32_t max_sched_scan_plan_interval;
265 	uint32_t max_sched_scan_plan_iterations;
266 	uint8_t scan_backoff_multiplier;
267 	qdf_wake_lock_t pno_wake_lock;
268 	struct cb_handler pno_cb;
269 	struct nlo_mawc_params mawc_params;
270 };
271 #endif
272 
273 /**
274  * struct extscan_def_config - def configuration for EXTSCAN
275  * @extscan_enabled: enable extscan
276  * @extscan_passive_max_chn_time: max passive channel time
277  * @extscan_passive_min_chn_time: min passive channel time
278  * @extscan_active_max_chn_time: max active channel time
279  * @extscan_active_min_chn_time: min active channel time
280  */
281 struct extscan_def_config {
282 	bool     extscan_enabled;
283 	uint32_t extscan_passive_max_chn_time;
284 	uint32_t extscan_passive_min_chn_time;
285 	uint32_t extscan_active_max_chn_time;
286 	uint32_t extscan_active_min_chn_time;
287 };
288 
289 /**
290  * struct scan_default_params - default scan parameters to be used
291  * @active_dwell: default active dwell time
292  * @allow_dfs_chan_in_first_scan: first scan should contain dfs channels or not.
293  * @allow_dfs_chan_in_scan: Scan DFS channels or not.
294  * @skip_dfs_chan_in_p2p_search: Skip DFS channels in p2p search.
295  * @use_wake_lock_in_user_scan: if wake lock will be acquired during user scan
296  * @active_dwell_2g: default active dwell time for 2G channels, if it's not zero
297  * @passive_dwell:default passive dwell time
298  * @max_rest_time: default max rest time
299  * @sta_miracast_mcc_rest_time: max rest time for miracast and mcc
300  * @min_rest_time: default min rest time
301  * @idle_time: default idle time
302  * @conc_active_dwell: default concurrent active dwell time
303  * @conc_passive_dwell: default concurrent passive dwell time
304  * @conc_max_rest_time: default concurrent max rest time
305  * @conc_min_rest_time: default concurrent min rest time
306  * @conc_idle_time: default concurrent idle time
307  * @repeat_probe_time: default repeat probe time
308  * @probe_spacing_time: default probe spacing time
309  * @probe_delay: default probe delay
310  * @burst_duration: default burst duration
311  * @max_scan_time: default max scan time
312  * @num_probes: default maximum number of probes to sent
313  * @cache_aging_time: default scan cache aging time
314  * @select_5gh_margin: Prefer connecting to 5G AP even if
315  *      its RSSI is lower by select_5gh_margin dbm than 2.4G AP.
316  *      applicable if prefer_5ghz is set.
317  * @is_bssid_hint_priority: True if bssid_hint is given priority
318  * @enable_mac_spoofing: enable mac address spoof in scan
319  * @max_bss_per_pdev: maximum number of bss entries to be maintained per pdev
320  * @max_active_scans_allowed: maximum number of active parallel scan allowed
321  *                            per psoc
322  * @scan_priority: default scan priority
323  * @adaptive_dwell_time_mode: adaptive dwell mode with connection
324  * @adaptive_dwell_time_mode_nc: adaptive dwell mode without connection
325  * @extscan_adaptive_dwell_mode: Adaptive dwell mode during ext scan
326  * @scan_f_passive: passively scan all channels including active channels
327  * @scan_f_bcast_probe: add wild card ssid prbreq even if ssid_list is specified
328  * @scan_f_cck_rates: add cck rates to rates/xrates ie in prb req
329  * @scan_f_ofdm_rates: add ofdm rates to rates/xrates ie in prb req
330  * @scan_f_chan_stat_evnt: enable indication of chan load and noise floor
331  * @scan_f_filter_prb_req: filter Probe request frames
332  * @scan_f_bypass_dfs_chn: when set, do not scan DFS channels
333  * @scan_f_continue_on_err:continue scan even if few certain erros have occurred
334  * @scan_f_offchan_mgmt_tx: allow mgmt transmission during off channel scan
335  * @scan_f_offchan_data_tx: allow data transmission during off channel scan
336  * @scan_f_promisc_mode: scan with promiscuous mode
337  * @scan_f_capture_phy_err: enable capture ppdu with phy errrors
338  * @scan_f_strict_passive_pch: do passive scan on passive channels
339  * @scan_f_half_rate: enable HALF (10MHz) rate support
340  * @scan_f_quarter_rate: set Quarter (5MHz) rate support
341  * @scan_f_force_active_dfs_chn: allow to send probe req on DFS channel
342  * @scan_f_add_tpc_ie_in_probe: add TPC ie in probe req frame
343  * @scan_f_add_ds_ie_in_probe: add DS ie in probe req frame
344  * @scan_f_add_spoofed_mac_in_probe: use random mac address for TA in probe
345  * @scan_f_add_rand_seq_in_probe: use random sequence number in probe
346  * @scan_f_en_ie_whitelist_in_probe: enable ie whitelist in probe
347  * @scan_f_forced: force scan even in presence of data traffic
348  * @scan_f_2ghz: scan 2.4 GHz channels
349  * @scan_f_5ghz: scan 5 GHz channels
350  * @scan_f_wide_band: scan in 40 MHz or higher bandwidth
351  * @scan_flags: variable to read and set scan_f_* flags in one shot
352  *              can be used to dump all scan_f_* flags for debug
353  * @scan_ev_started: notify scan started event
354  * @scan_ev_completed: notify scan completed event
355  * @scan_ev_bss_chan: notify bss chan event
356  * @scan_ev_foreign_chan: notify foreign chan event
357  * @scan_ev_dequeued: notify scan request dequed event
358  * @scan_ev_preempted: notify scan preempted event
359  * @scan_ev_start_failed: notify scan start failed event
360  * @scan_ev_restarted: notify scan restarted event
361  * @scan_ev_foreign_chn_exit: notify foreign chan exit event
362  * @scan_ev_invalid: notify invalid scan request event
363  * @scan_ev_gpio_timeout: notify gpio timeout event
364  * @scan_ev_suspended: notify scan suspend event
365  * @scan_ev_resumed: notify scan resumed event
366  * @scan_events: variable to read and set scan_ev_* flags in one shot
367  *               can be used to dump all scan_ev_* flags for debug
368  * @roam_params: roam related params
369  */
370 struct scan_default_params {
371 	uint32_t active_dwell;
372 	bool allow_dfs_chan_in_first_scan;
373 	bool allow_dfs_chan_in_scan;
374 	bool skip_dfs_chan_in_p2p_search;
375 	bool use_wake_lock_in_user_scan;
376 	uint32_t active_dwell_2g;
377 	uint32_t passive_dwell;
378 	uint32_t max_rest_time;
379 	uint32_t sta_miracast_mcc_rest_time;
380 	uint32_t min_rest_time;
381 	uint32_t idle_time;
382 	uint32_t conc_active_dwell;
383 	uint32_t conc_passive_dwell;
384 	uint32_t conc_max_rest_time;
385 	uint32_t conc_min_rest_time;
386 	uint32_t conc_idle_time;
387 	uint32_t repeat_probe_time;
388 	uint32_t probe_spacing_time;
389 	uint32_t probe_delay;
390 	uint32_t burst_duration;
391 	uint32_t max_scan_time;
392 	uint32_t num_probes;
393 	uint32_t scan_cache_aging_time;
394 	uint32_t select_5ghz_margin;
395 	bool enable_mac_spoofing;
396 	bool is_bssid_hint_priority;
397 	uint32_t usr_cfg_probe_rpt_time;
398 	uint32_t usr_cfg_num_probes;
399 	uint16_t max_bss_per_pdev;
400 	uint32_t max_active_scans_allowed;
401 	uint8_t sta_scan_burst_duration;
402 	uint8_t p2p_scan_burst_duration;
403 	uint8_t go_scan_burst_duration;
404 	uint8_t ap_scan_burst_duration;
405 	enum scan_priority scan_priority;
406 	enum scan_dwelltime_adaptive_mode adaptive_dwell_time_mode;
407 	enum scan_dwelltime_adaptive_mode adaptive_dwell_time_mode_nc;
408 	enum scan_dwelltime_adaptive_mode extscan_adaptive_dwell_mode;
409 	union {
410 		struct {
411 			uint32_t scan_f_passive:1,
412 				scan_f_bcast_probe:1,
413 				scan_f_cck_rates:1,
414 				scan_f_ofdm_rates:1,
415 				scan_f_chan_stat_evnt:1,
416 				scan_f_filter_prb_req:1,
417 				scan_f_bypass_dfs_chn:1,
418 				scan_f_continue_on_err:1,
419 				scan_f_offchan_mgmt_tx:1,
420 				scan_f_offchan_data_tx:1,
421 				scan_f_promisc_mode:1,
422 				scan_f_capture_phy_err:1,
423 				scan_f_strict_passive_pch:1,
424 				scan_f_half_rate:1,
425 				scan_f_quarter_rate:1,
426 				scan_f_force_active_dfs_chn:1,
427 				scan_f_add_tpc_ie_in_probe:1,
428 				scan_f_add_ds_ie_in_probe:1,
429 				scan_f_add_spoofed_mac_in_probe:1,
430 				scan_f_add_rand_seq_in_probe:1,
431 				scan_f_en_ie_whitelist_in_probe:1,
432 				scan_f_forced:1,
433 				scan_f_2ghz:1,
434 				scan_f_5ghz:1,
435 				scan_f_wide_band:1;
436 		};
437 		uint32_t scan_flags;
438 	};
439 	union {
440 		struct {
441 			uint32_t scan_ev_started:1,
442 				scan_ev_completed:1,
443 				scan_ev_bss_chan:1,
444 				scan_ev_foreign_chan:1,
445 				scan_ev_dequeued:1,
446 				scan_ev_preempted:1,
447 				scan_ev_start_failed:1,
448 				scan_ev_restarted:1,
449 				scan_ev_foreign_chn_exit:1,
450 				scan_ev_invalid:1,
451 				scan_ev_gpio_timeout:1,
452 				scan_ev_suspended:1,
453 				scan_ev_resumed:1;
454 		};
455 		uint32_t scan_events;
456 	};
457 	struct roam_filter_params roam_params;
458 	struct scoring_config score_config;
459 };
460 
461 /**
462  * struct scan_cb - nif/sif function callbacks
463  * @inform_beacon: cb to indicate frame to OS
464  * @update_beacon: cb to indicate frame to MLME
465  */
466 struct scan_cb {
467 	update_beacon_cb inform_beacon;
468 	update_beacon_cb update_beacon;
469 	/* Define nif/sif function callbacks here */
470 };
471 
472 /**
473  * struct wlan_scan_obj - scan object definition
474  * @scan_disabled: if scan is disabled
475  * @scan_db:    scan cache data base
476  * @cc_db:      pointer of country code data base
477  * @lock:       spin lock
478  * @scan_def:   default scan parameters
479  * @cb:         nif/sif function callbacks
480  * @requesters: requester allocation pool
481  * @scan_ids:   last allocated scan id
482  * @global_evhandlers:  registered scan event handlers
483  * @pdev_info: pointer to pdev info
484  * @pno_cfg: default pno configuration
485  * @extscan_cfg: default extscan configuration
486  * @ie_whitelist: default ie whitelist attrs
487  * @bt_a2dp_enabled: if bt a2dp is enabled
488  * @miracast_enabled: miracast enabled
489  * @disable_timeout: command timeout disabled
490  * @drop_bcn_on_chan_mismatch: drop bcn if channel mismatch
491  * @scan_start_request_buff: buffer used to pass
492  *      scan config to event handlers
493  */
494 struct wlan_scan_obj {
495 	uint32_t scan_disabled;
496 	qdf_spinlock_t lock;
497 	qdf_atomic_t scan_ids;
498 	struct scan_dbs scan_db[WLAN_UMAC_MAX_PDEVS];
499 	struct scan_country_code_db *cc_db;
500 	struct scan_default_params scan_def;
501 	struct scan_cb cb;
502 	struct scan_requester_info requesters[WLAN_MAX_REQUESTORS];
503 	struct global_scan_ev_handlers global_evhandlers;
504 	struct pdev_scan_info pdev_info[WLAN_UMAC_MAX_PDEVS];
505 #ifdef FEATURE_WLAN_SCAN_PNO
506 	struct pno_def_config pno_cfg;
507 #endif
508 #ifdef FEATURE_WLAN_EXTSCAN
509 	struct extscan_def_config extscan_cfg;
510 #endif
511 	struct probe_req_whitelist_attr ie_whitelist;
512 	bool bt_a2dp_enabled;
513 	bool miracast_enabled;
514 	bool disable_timeout;
515 	bool drop_bcn_on_chan_mismatch;
516 	struct scan_start_request scan_start_request_buff;
517 };
518 
519 /**
520  * wlan_psoc_get_scan_obj() - private API to get scan object from psoc
521  * @psoc: psoc object
522  *
523  * Return: scan object
524  */
525 #define wlan_psoc_get_scan_obj(psoc) \
526 	wlan_psoc_get_scan_obj_fl(psoc, \
527 				  __func__, __LINE__)
528 
529 static inline struct wlan_scan_obj *
530 wlan_psoc_get_scan_obj_fl(struct wlan_objmgr_psoc *psoc,
531 			  const char *func, uint32_t line)
532 {
533 	struct wlan_scan_obj *scan_obj;
534 
535 	scan_obj = (struct wlan_scan_obj *)
536 		wlan_objmgr_psoc_get_comp_private_obj(psoc,
537 				WLAN_UMAC_COMP_SCAN);
538 	if (!scan_obj) {
539 		scm_err("%s:%u, Failed to get scan object", func, line);
540 		return NULL;
541 	}
542 	return scan_obj;
543 }
544 
545 /**
546  * wlan_pdev_get_scan_obj() - private API to get scan object from pdev
547  * @psoc: pdev object
548  *
549  * Return: scan object
550  */
551 static inline struct wlan_scan_obj *
552 wlan_pdev_get_scan_obj(struct wlan_objmgr_pdev *pdev)
553 {
554 	struct wlan_objmgr_psoc *psoc;
555 
556 	psoc = wlan_pdev_get_psoc(pdev);
557 
558 	return wlan_psoc_get_scan_obj(psoc);
559 }
560 
561 /**
562  * wlan_vdev_get_scan_obj() - private API to get scan object from vdev
563  * @psoc: vdev object
564  *
565  * Return: scan object
566  */
567 static inline struct wlan_scan_obj *
568 wlan_vdev_get_scan_obj(struct wlan_objmgr_vdev *vdev)
569 {
570 	struct wlan_objmgr_pdev *pdev;
571 
572 	pdev = wlan_vdev_get_pdev(vdev);
573 
574 	return wlan_pdev_get_scan_obj(pdev);
575 }
576 
577 /**
578  * wlan_get_vdev_scan_obj() - private API to get scan object vdev
579  * @vdev: vdev object
580  *
581  * Return: scan object
582  */
583 static inline struct scan_vdev_obj *
584 wlan_get_vdev_scan_obj(struct wlan_objmgr_vdev *vdev)
585 {
586 	struct scan_vdev_obj *scan_vdev_obj;
587 
588 	scan_vdev_obj = (struct scan_vdev_obj *)
589 		wlan_objmgr_vdev_get_comp_private_obj(vdev,
590 				WLAN_UMAC_COMP_SCAN);
591 
592 	return scan_vdev_obj;
593 }
594 
595 /**
596  * wlan_scan_vdev_get_pdev_id() - private API to get pdev id from vdev object
597  * @vdev: vdev object
598  *
599  * Return: parent pdev id
600  */
601 static inline uint8_t
602 wlan_scan_vdev_get_pdev_id(struct wlan_objmgr_vdev *vdev)
603 {
604 	struct wlan_objmgr_pdev *pdev;
605 
606 	pdev = wlan_vdev_get_pdev(vdev);
607 
608 	return wlan_objmgr_pdev_get_pdev_id(pdev);
609 }
610 
611 /**
612  * wlan_pdev_get_pdev_scan_ev_handlers() - private API to get
613  * pdev scan event handlers
614  * @vdev: pdev object
615  *
616  * Return: pdev_scan_ev_handler object
617  */
618 static inline struct pdev_scan_ev_handler*
619 wlan_pdev_get_pdev_scan_ev_handlers(struct wlan_objmgr_pdev *pdev)
620 {
621 	uint8_t pdevid;
622 	struct wlan_scan_obj *scan;
623 	struct pdev_scan_ev_handler *pdev_ev_handler;
624 
625 	pdevid = wlan_objmgr_pdev_get_pdev_id(pdev);
626 
627 	scan = wlan_pdev_get_scan_obj(pdev);
628 
629 	pdev_ev_handler =
630 		&scan->global_evhandlers.pdev_ev_handlers[pdevid];
631 
632 	return pdev_ev_handler;
633 }
634 
635 /**
636  * wlan_vdev_get_pdev_scan_ev_handlers() - private API to get
637  * pdev scan event handlers
638  * @vdev: vdev object
639  *
640  * Return: pdev_scan_ev_handler object
641  */
642 static inline struct pdev_scan_ev_handler*
643 wlan_vdev_get_pdev_scan_ev_handlers(struct wlan_objmgr_vdev *vdev)
644 {
645 	struct wlan_objmgr_pdev *pdev;
646 
647 	pdev = wlan_vdev_get_pdev(vdev);
648 
649 	return wlan_pdev_get_pdev_scan_ev_handlers(pdev);
650 }
651 
652 /**
653  * wlan_scan_psoc_get_def_params() - private API to get scan defaults
654  * @psoc: psoc object
655  *
656  * Return: scan defaults
657  */
658 static inline struct scan_default_params*
659 wlan_scan_psoc_get_def_params(struct wlan_objmgr_psoc *psoc)
660 {
661 	struct wlan_scan_obj *scan = NULL;
662 
663 	if (!psoc) {
664 		scm_err("null psoc");
665 		return NULL;
666 	}
667 	scan = wlan_psoc_get_scan_obj(psoc);
668 
669 	if (!scan)
670 		return NULL;
671 
672 	return &scan->scan_def;
673 }
674 
675 /**
676  * wlan_vdev_get_def_scan_params() - private API to get scan defaults
677  * @vdev: vdev object
678  *
679  * Return: scan defaults
680  */
681 static inline struct scan_default_params*
682 wlan_vdev_get_def_scan_params(struct wlan_objmgr_vdev *vdev)
683 {
684 	struct wlan_objmgr_psoc *psoc = NULL;
685 
686 	if (!vdev) {
687 		scm_err("null vdev");
688 		return NULL;
689 	}
690 	psoc = wlan_vdev_get_psoc(vdev);
691 
692 	return wlan_scan_psoc_get_def_params(psoc);
693 }
694 
695 /**
696  * wlan_scan_psoc_created_notification() - scan psoc create handler
697  * @psoc: psoc object
698  * @arg_list: Argument list
699  *
700  * Return: QDF_STATUS
701  */
702 QDF_STATUS wlan_scan_psoc_created_notification(struct wlan_objmgr_psoc *psoc,
703 	void *arg_list);
704 
705 /**
706  * wlan_scan_psoc_deleted_notification() - scan psoc delete handler
707  * @psoc: psoc object
708  * @arg_list: Argument list
709  *
710  * Return: QDF_STATUS
711  */
712 QDF_STATUS wlan_scan_psoc_destroyed_notification(struct wlan_objmgr_psoc *psoc,
713 	void *arg_list);
714 
715 /**
716  * wlan_scan_vdev_created_notification() - scan psoc create handler
717  * @vdev: vdev object
718  * @arg_list: Argument list
719  *
720  * Return: QDF_STATUS
721  */
722 QDF_STATUS wlan_scan_vdev_created_notification(struct wlan_objmgr_vdev *vdev,
723 	void *arg_list);
724 
725 /**
726  * wlan_scan_vdev_destroyed_notification() - scan psoc delete handler
727  * @vdev: vdev object
728  * @arg_list: Argument list
729  *
730  * Return: QDF_STATUS
731  */
732 QDF_STATUS wlan_scan_vdev_destroyed_notification(struct wlan_objmgr_vdev *vdev,
733 	void *arg_list);
734 
735 #endif
736