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