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