xref: /wlan-dirver/qca-wifi-host-cmn/umac/scan/core/src/wlan_scan_main.h (revision dd4dc88b837a295134aa9869114a2efee0f4894b)
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 #ifndef CONFIG_MCL
116 #define MAX_SCAN_CACHE_SIZE 1024
117 #define SCAN_MAX_REST_TIME 0
118 #define SCAN_MIN_REST_TIME 50
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 50000
123 #define SCAN_NETWORK_IDLE_TIMEOUT 200
124 #define HIDDEN_SSID_TIME (0xFFFFFFFF)
125 #define SCAN_CHAN_STATS_EVENT_ENAB (true)
126 #endif
127 
128 #define SCAN_TIMEOUT_GRACE_PERIOD 10
129 #define SCAN_MAX_BSS_PDEV 100
130 #define SCAN_PRIORITY SCAN_PRIORITY_LOW
131 
132 /* DBS Scan policy selection ext flags */
133 #define SCAN_FLAG_EXT_DBS_SCAN_POLICY_MASK  0x00000003
134 #define SCAN_FLAG_EXT_DBS_SCAN_POLICY_BIT   0
135 #define SCAN_DBS_POLICY_DEFAULT             0x0
136 #define SCAN_DBS_POLICY_FORCE_NONDBS        0x1
137 #define SCAN_DBS_POLICY_IGNORE_DUTY         0x2
138 #define SCAN_DBS_POLICY_MAX                 0x3
139 /* Minimum number of channels for enabling DBS Scan */
140 #define SCAN_MIN_CHAN_DBS_SCAN_THRESHOLD         8
141 /*
142  * Enable Reception of Public Action frame with this flag
143  */
144 #define SCAN_FLAG_EXT_FILTER_PUBLIC_ACTION_FRAME 0x4
145 
146 /* Passive dwell time if bt_a2dp is enabled. Time in msecs*/
147 #define PASSIVE_DWELL_TIME_BT_A2DP_ENABLED 28
148 
149 /**
150  * struct cb_handler - defines scan event handler
151  * call back function and arguments
152  * @func: handler function pointer
153  * @arg: argument to handler function
154  */
155 struct cb_handler {
156 	scan_event_handler func;
157 	void *arg;
158 };
159 
160 /**
161  * struct pdev_scan_ev_handler - pdev scan event handlers
162  * @cb_handler: array of registered scan handlers
163  */
164 struct pdev_scan_ev_handler {
165 	uint32_t handler_cnt;
166 	struct cb_handler cb_handlers[MAX_SCAN_EVENT_HANDLERS_PER_PDEV];
167 };
168 
169 /**
170  * struct global_scan_ev_handlers - per pdev registered scan event handlers
171  * @pdev_scan_ev_handler: per pdev registered scan event handlers
172  */
173 struct global_scan_ev_handlers {
174 	struct pdev_scan_ev_handler pdev_ev_handlers[WLAN_UMAC_MAX_PDEVS];
175 };
176 
177 /**
178  * struct scan_requester_info - defines scan requester id
179  * and event handler mapping
180  * @requester:   requester ID allocated
181  * @module:      module name of requester
182  * @ev_handler:  event handlerto be invoked
183  */
184 struct scan_requester_info {
185 	wlan_scan_requester requester;
186 	uint8_t module[WLAN_MAX_MODULE_NAME];
187 	struct cb_handler ev_handler;
188 };
189 
190 /**
191  * struct pdev_scan_info - defines per pdev scan info
192  * @wide_band_scan: wide band scan capability
193  * @last_scan_time: time of last scan start on this pdev
194  * @custom_chan_list: scan only these channels
195  * @conf_bssid: configured bssid of the hidden AP
196  * @conf_ssid: configured desired ssid
197  */
198 struct pdev_scan_info {
199 	bool wide_band_scan;
200 	qdf_time_t last_scan_time;
201 	struct chan_list custom_chan_list;
202 	uint8_t conf_bssid[QDF_MAC_ADDR_SIZE];
203 	struct wlan_ssid conf_ssid;
204 };
205 
206 /**
207  * struct scan_vdev_obj - scan vdev obj
208  * @pno_match_evt_received: pno match received
209  * @pno_in_progress: pno in progress
210  * @scan_disabled: if scan is disabled for this vdev
211  * @first_scan_done: Whether its the first scan or not for this particular vdev.
212  */
213 struct scan_vdev_obj {
214 	bool pno_match_evt_received;
215 	bool pno_in_progress;
216 	uint32_t scan_disabled;
217 	bool first_scan_done;
218 };
219 
220 #ifdef FEATURE_WLAN_SCAN_PNO
221 /**
222  * struct pno_def_config - def configuration for PNO
223  * @pno_offload_enabled: flag to check if PNO offload is enabled/disabled
224  * @channel_prediction: config PNO channel prediction feature status
225  * @top_k_num_of_channels: def top K number of channels are used for tanimoto
226  * distance calculation.
227  * @stationary_thresh: def threshold val to determine that STA is stationary.
228  * @pnoscan_adaptive_dwell_mode: def adaptive dwelltime mode for pno scan
229  * @channel_prediction_full_scan: def periodic timer upon which full scan needs
230  * to be triggered.
231  * @dfs_chnl_scan_enable: Enable dfs channel PNO scan
232  * @scan_support_enabled: PNO scan support enabled/disabled
233  * @scan_timer_repeat_value: PNO scan timer repeat value
234  * @slow_scan_multiplier: PNO slow scan timer multiplier
235  * @max_sched_scan_plan_interval: PNO scan interval
236  * @max_sched_scan_plan_iterations: PNO scan number of iterations
237  * @scan_backoff_multiplier: Scan banckoff multiplier
238  * @pno_wake_lock: pno wake lock
239  * @pno_cb: callback to call on PNO completion
240  * @mawc_params: Configuration parameters for NLO MAWC.
241  */
242 struct pno_def_config {
243 	bool pno_offload_enabled;
244 	bool channel_prediction;
245 	uint8_t top_k_num_of_channels;
246 	uint8_t stationary_thresh;
247 	enum scan_dwelltime_adaptive_mode adaptive_dwell_mode;
248 	uint32_t channel_prediction_full_scan;
249 	bool dfs_chnl_scan_enabled;
250 	bool scan_support_enabled;
251 	uint32_t scan_timer_repeat_value;
252 	uint32_t slow_scan_multiplier;
253 	uint32_t max_sched_scan_plan_interval;
254 	uint32_t max_sched_scan_plan_iterations;
255 	uint8_t scan_backoff_multiplier;
256 	qdf_wake_lock_t pno_wake_lock;
257 	struct cb_handler pno_cb;
258 	struct nlo_mawc_params mawc_params;
259 };
260 #endif
261 
262 /**
263  * struct extscan_def_config - def configuration for EXTSCAN
264  * @extscan_enabled: enable extscan
265  * @extscan_passive_max_chn_time: max passive channel time
266  * @extscan_passive_min_chn_time: min passive channel time
267  * @extscan_active_max_chn_time: max active channel time
268  * @extscan_active_min_chn_time: min active channel time
269  */
270 struct extscan_def_config {
271 	bool     extscan_enabled;
272 	uint32_t extscan_passive_max_chn_time;
273 	uint32_t extscan_passive_min_chn_time;
274 	uint32_t extscan_active_max_chn_time;
275 	uint32_t extscan_active_min_chn_time;
276 };
277 
278 /**
279  * struct scan_default_params - default scan parameters to be used
280  * @active_dwell: default active dwell time
281  * @allow_dfs_chan_in_first_scan: first scan should contain dfs channels or not.
282  * @allow_dfs_chan_in_scan: Scan DFS channels or not.
283  * @skip_dfs_chan_in_p2p_search: Skip DFS channels in p2p search.
284  * @use_wake_lock_in_user_scan: if wake lock will be acquired during user scan
285  * @active_dwell_2g: default active dwell time for 2G channels, if it's not zero
286  * @passive_dwell:default passive dwell time
287  * @max_rest_time: default max rest time
288  * @sta_miracast_mcc_rest_time: max rest time for miracast and mcc
289  * @min_rest_time: default min rest time
290  * @idle_time: default idle time
291  * @conc_active_dwell: default concurrent active dwell time
292  * @conc_passive_dwell: default concurrent passive dwell time
293  * @conc_max_rest_time: default concurrent max rest time
294  * @conc_min_rest_time: default concurrent min rest time
295  * @conc_idle_time: default concurrent idle time
296  * @repeat_probe_time: default repeat probe time
297  * @probe_spacing_time: default probe spacing time
298  * @probe_delay: default probe delay
299  * @burst_duration: default burst duration
300  * @max_scan_time: default max scan time
301  * @num_probes: default maximum number of probes to sent
302  * @cache_aging_time: default scan cache aging time
303  * @select_5gh_margin: Prefer connecting to 5G AP even if
304  *      its RSSI is lower by select_5gh_margin dbm than 2.4G AP.
305  *      applicable if prefer_5ghz is set.
306  * @is_bssid_hint_priority: True if bssid_hint is given priority
307  * @enable_mac_spoofing: enable mac address spoof in scan
308  * @max_bss_per_pdev: maximum number of bss entries to be maintained per pdev
309  * @max_active_scans_allowed: maximum number of active parallel scan allowed
310  *                            per psoc
311  * @enable_connected_scan: enable scans after connection
312  * @scan_priority: default scan priority
313  * @adaptive_dwell_time_mode: adaptive dwell mode with connection
314  * @adaptive_dwell_time_mode_nc: adaptive dwell mode without connection
315  * @honour_nl_scan_policy_flags: honour nl80211 scan policy flags
316  * @extscan_adaptive_dwell_mode: Adaptive dwell mode during ext scan
317  * @scan_f_passive: passively scan all channels including active channels
318  * @scan_f_bcast_probe: add wild card ssid prbreq even if ssid_list is specified
319  * @scan_f_cck_rates: add cck rates to rates/xrates ie in prb req
320  * @scan_f_ofdm_rates: add ofdm rates to rates/xrates ie in prb req
321  * @scan_f_chan_stat_evnt: enable indication of chan load and noise floor
322  * @scan_f_filter_prb_req: filter Probe request frames
323  * @scan_f_bypass_dfs_chn: when set, do not scan DFS channels
324  * @scan_f_continue_on_err:continue scan even if few certain erros have occurred
325  * @scan_f_offchan_mgmt_tx: allow mgmt transmission during off channel scan
326  * @scan_f_offchan_data_tx: allow data transmission during off channel scan
327  * @scan_f_promisc_mode: scan with promiscuous mode
328  * @scan_f_capture_phy_err: enable capture ppdu with phy errrors
329  * @scan_f_strict_passive_pch: do passive scan on passive channels
330  * @scan_f_half_rate: enable HALF (10MHz) rate support
331  * @scan_f_quarter_rate: set Quarter (5MHz) rate support
332  * @scan_f_force_active_dfs_chn: allow to send probe req on DFS channel
333  * @scan_f_add_tpc_ie_in_probe: add TPC ie in probe req frame
334  * @scan_f_add_ds_ie_in_probe: add DS ie in probe req frame
335  * @scan_f_add_spoofed_mac_in_probe: use random mac address for TA in probe
336  * @scan_f_add_rand_seq_in_probe: use random sequence number in probe
337  * @scan_f_en_ie_whitelist_in_probe: enable ie whitelist in probe
338  * @scan_f_forced: force scan even in presence of data traffic
339  * @scan_f_2ghz: scan 2.4 GHz channels
340  * @scan_f_5ghz: scan 5 GHz channels
341  * @scan_f_wide_band: scan in 40 MHz or higher bandwidth
342  * @scan_flags: variable to read and set scan_f_* flags in one shot
343  *              can be used to dump all scan_f_* flags for debug
344  * @scan_ev_started: notify scan started event
345  * @scan_ev_completed: notify scan completed event
346  * @scan_ev_bss_chan: notify bss chan event
347  * @scan_ev_foreign_chan: notify foreign chan event
348  * @scan_ev_dequeued: notify scan request dequed event
349  * @scan_ev_preempted: notify scan preempted event
350  * @scan_ev_start_failed: notify scan start failed event
351  * @scan_ev_restarted: notify scan restarted event
352  * @scan_ev_foreign_chn_exit: notify foreign chan exit event
353  * @scan_ev_invalid: notify invalid scan request event
354  * @scan_ev_gpio_timeout: notify gpio timeout event
355  * @scan_ev_suspended: notify scan suspend event
356  * @scan_ev_resumed: notify scan resumed event
357  * @scan_events: variable to read and set scan_ev_* flags in one shot
358  *               can be used to dump all scan_ev_* flags for debug
359  * @roam_params: roam related params
360  */
361 struct scan_default_params {
362 	uint32_t active_dwell;
363 	bool allow_dfs_chan_in_first_scan;
364 	bool allow_dfs_chan_in_scan;
365 	bool skip_dfs_chan_in_p2p_search;
366 	bool use_wake_lock_in_user_scan;
367 	uint32_t active_dwell_2g;
368 	uint32_t passive_dwell;
369 	uint32_t max_rest_time;
370 	uint32_t sta_miracast_mcc_rest_time;
371 	uint32_t min_rest_time;
372 	uint32_t idle_time;
373 	uint32_t conc_active_dwell;
374 	uint32_t conc_passive_dwell;
375 	uint32_t conc_max_rest_time;
376 	uint32_t conc_min_rest_time;
377 	uint32_t conc_idle_time;
378 	uint32_t repeat_probe_time;
379 	uint32_t probe_spacing_time;
380 	uint32_t probe_delay;
381 	uint32_t burst_duration;
382 	uint32_t max_scan_time;
383 	uint32_t num_probes;
384 	qdf_time_t scan_cache_aging_time;
385 	uint32_t select_5ghz_margin;
386 	bool enable_mac_spoofing;
387 	bool is_bssid_hint_priority;
388 	uint32_t usr_cfg_probe_rpt_time;
389 	uint32_t usr_cfg_num_probes;
390 	uint16_t max_bss_per_pdev;
391 	uint32_t max_active_scans_allowed;
392 	uint8_t sta_scan_burst_duration;
393 	uint8_t p2p_scan_burst_duration;
394 	uint8_t go_scan_burst_duration;
395 	uint8_t ap_scan_burst_duration;
396 	bool enable_connected_scan;
397 	enum scan_priority scan_priority;
398 	enum scan_dwelltime_adaptive_mode adaptive_dwell_time_mode;
399 	enum scan_dwelltime_adaptive_mode adaptive_dwell_time_mode_nc;
400 	bool honour_nl_scan_policy_flags;
401 	enum scan_dwelltime_adaptive_mode extscan_adaptive_dwell_mode;
402 	union {
403 		struct {
404 			uint32_t scan_f_passive:1,
405 				scan_f_bcast_probe:1,
406 				scan_f_cck_rates:1,
407 				scan_f_ofdm_rates:1,
408 				scan_f_chan_stat_evnt:1,
409 				scan_f_filter_prb_req:1,
410 				scan_f_bypass_dfs_chn:1,
411 				scan_f_continue_on_err:1,
412 				scan_f_offchan_mgmt_tx:1,
413 				scan_f_offchan_data_tx:1,
414 				scan_f_promisc_mode:1,
415 				scan_f_capture_phy_err:1,
416 				scan_f_strict_passive_pch:1,
417 				scan_f_half_rate:1,
418 				scan_f_quarter_rate:1,
419 				scan_f_force_active_dfs_chn:1,
420 				scan_f_add_tpc_ie_in_probe:1,
421 				scan_f_add_ds_ie_in_probe:1,
422 				scan_f_add_spoofed_mac_in_probe:1,
423 				scan_f_add_rand_seq_in_probe:1,
424 				scan_f_en_ie_whitelist_in_probe:1,
425 				scan_f_forced:1,
426 				scan_f_2ghz:1,
427 				scan_f_5ghz:1,
428 				scan_f_wide_band:1;
429 		};
430 		uint32_t scan_flags;
431 	};
432 	union {
433 		struct {
434 			uint32_t scan_ev_started:1,
435 				scan_ev_completed:1,
436 				scan_ev_bss_chan:1,
437 				scan_ev_foreign_chan:1,
438 				scan_ev_dequeued:1,
439 				scan_ev_preempted:1,
440 				scan_ev_start_failed:1,
441 				scan_ev_restarted:1,
442 				scan_ev_foreign_chn_exit:1,
443 				scan_ev_invalid:1,
444 				scan_ev_gpio_timeout:1,
445 				scan_ev_suspended:1,
446 				scan_ev_resumed:1;
447 		};
448 		uint32_t scan_events;
449 	};
450 	struct roam_filter_params roam_params;
451 	struct scoring_config score_config;
452 };
453 
454 /**
455  * struct scan_cb - nif/sif function callbacks
456  * @inform_beacon: cb to indicate frame to OS
457  * @update_beacon: cb to indicate frame to MLME
458  * @unlink_bss: cb to unlink bss from kernel cache
459  */
460 struct scan_cb {
461 	update_beacon_cb inform_beacon;
462 	update_beacon_cb update_beacon;
463 	update_beacon_cb unlink_bss;
464 	/* Define nif/sif function callbacks here */
465 };
466 
467 /**
468  * struct wlan_scan_obj - scan object definition
469  * @scan_disabled: if scan is disabled
470  * @scan_db:    scan cache data base
471  * @cc_db:      pointer of country code data base
472  * @lock:       spin lock
473  * @scan_def:   default scan parameters
474  * @cb:         nif/sif function callbacks
475  * @requesters: requester allocation pool
476  * @scan_ids:   last allocated scan id
477  * @global_evhandlers:  registered scan event handlers
478  * @pdev_info: pointer to pdev info
479  * @pno_cfg: default pno configuration
480  * @extscan_cfg: default extscan configuration
481  * @ie_whitelist: default ie whitelist attrs
482  * @bt_a2dp_enabled: if bt a2dp is enabled
483  * @miracast_enabled: miracast enabled
484  * @disable_timeout: command timeout disabled
485  * @drop_bcn_on_chan_mismatch: drop bcn if channel mismatch
486  * @scan_start_request_buff: buffer used to pass
487  *      scan config to event handlers
488  */
489 struct wlan_scan_obj {
490 	uint32_t scan_disabled;
491 	qdf_spinlock_t lock;
492 	qdf_atomic_t scan_ids;
493 	struct scan_dbs scan_db[WLAN_UMAC_MAX_PDEVS];
494 	struct scan_country_code_db *cc_db;
495 	struct scan_default_params scan_def;
496 	struct scan_cb cb;
497 	struct scan_requester_info requesters[WLAN_MAX_REQUESTORS];
498 	struct global_scan_ev_handlers global_evhandlers;
499 	struct pdev_scan_info pdev_info[WLAN_UMAC_MAX_PDEVS];
500 #ifdef FEATURE_WLAN_SCAN_PNO
501 	struct pno_def_config pno_cfg;
502 #endif
503 #ifdef FEATURE_WLAN_EXTSCAN
504 	struct extscan_def_config extscan_cfg;
505 #endif
506 	struct probe_req_whitelist_attr ie_whitelist;
507 	bool bt_a2dp_enabled;
508 	bool miracast_enabled;
509 	bool disable_timeout;
510 	bool drop_bcn_on_chan_mismatch;
511 	struct scan_start_request scan_start_request_buff;
512 };
513 
514 /**
515  * wlan_psoc_get_scan_obj() - private API to get scan object from psoc
516  * @psoc: psoc object
517  *
518  * Return: scan object
519  */
520 #define wlan_psoc_get_scan_obj(psoc) \
521 	wlan_psoc_get_scan_obj_fl(psoc, \
522 				  __func__, __LINE__)
523 
524 static inline struct wlan_scan_obj *
525 wlan_psoc_get_scan_obj_fl(struct wlan_objmgr_psoc *psoc,
526 			  const char *func, uint32_t line)
527 {
528 	struct wlan_scan_obj *scan_obj;
529 
530 	scan_obj = (struct wlan_scan_obj *)
531 		wlan_objmgr_psoc_get_comp_private_obj(psoc,
532 				WLAN_UMAC_COMP_SCAN);
533 	if (!scan_obj) {
534 		scm_err("%s:%u, Failed to get scan object", func, line);
535 		return NULL;
536 	}
537 	return scan_obj;
538 }
539 
540 /**
541  * wlan_pdev_get_scan_obj() - private API to get scan object from pdev
542  * @psoc: pdev object
543  *
544  * Return: scan object
545  */
546 static inline struct wlan_scan_obj *
547 wlan_pdev_get_scan_obj(struct wlan_objmgr_pdev *pdev)
548 {
549 	struct wlan_objmgr_psoc *psoc;
550 
551 	psoc = wlan_pdev_get_psoc(pdev);
552 
553 	return wlan_psoc_get_scan_obj(psoc);
554 }
555 
556 /**
557  * wlan_vdev_get_scan_obj() - private API to get scan object from vdev
558  * @psoc: vdev object
559  *
560  * Return: scan object
561  */
562 static inline struct wlan_scan_obj *
563 wlan_vdev_get_scan_obj(struct wlan_objmgr_vdev *vdev)
564 {
565 	struct wlan_objmgr_pdev *pdev;
566 
567 	pdev = wlan_vdev_get_pdev(vdev);
568 
569 	return wlan_pdev_get_scan_obj(pdev);
570 }
571 
572 /**
573  * wlan_get_vdev_scan_obj() - private API to get scan object vdev
574  * @vdev: vdev object
575  *
576  * Return: scan object
577  */
578 static inline struct scan_vdev_obj *
579 wlan_get_vdev_scan_obj(struct wlan_objmgr_vdev *vdev)
580 {
581 	struct scan_vdev_obj *scan_vdev_obj;
582 
583 	scan_vdev_obj = (struct scan_vdev_obj *)
584 		wlan_objmgr_vdev_get_comp_private_obj(vdev,
585 				WLAN_UMAC_COMP_SCAN);
586 
587 	return scan_vdev_obj;
588 }
589 
590 /**
591  * wlan_scan_vdev_get_pdev_id() - private API to get pdev id from vdev object
592  * @vdev: vdev object
593  *
594  * Return: parent pdev id
595  */
596 static inline uint8_t
597 wlan_scan_vdev_get_pdev_id(struct wlan_objmgr_vdev *vdev)
598 {
599 	struct wlan_objmgr_pdev *pdev;
600 
601 	pdev = wlan_vdev_get_pdev(vdev);
602 
603 	return wlan_objmgr_pdev_get_pdev_id(pdev);
604 }
605 
606 /**
607  * wlan_pdev_get_pdev_scan_ev_handlers() - private API to get
608  * pdev scan event handlers
609  * @vdev: pdev object
610  *
611  * Return: pdev_scan_ev_handler object
612  */
613 static inline struct pdev_scan_ev_handler*
614 wlan_pdev_get_pdev_scan_ev_handlers(struct wlan_objmgr_pdev *pdev)
615 {
616 	uint8_t pdevid;
617 	struct wlan_scan_obj *scan = NULL;
618 
619 	if (!pdev)
620 		goto err;
621 
622 	pdevid = wlan_objmgr_pdev_get_pdev_id(pdev);
623 	scan = wlan_pdev_get_scan_obj(pdev);
624 	if (!scan)
625 		goto err;
626 
627 	return &scan->global_evhandlers.pdev_ev_handlers[pdevid];
628 
629 err:
630 	scm_err("NULL pointer, pdev: 0x%pK, scan_obj: 0x%pK",
631 		pdev, scan);
632 	return NULL;
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