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