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 north bound interface api 21 */ 22 23 #ifndef _WLAN_SCAN_UCFG_API_H_ 24 #define _WLAN_SCAN_UCFG_API_H_ 25 26 #include <scheduler_api.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 32 /** 33 * ucfg_scan_register_requester() - assigns requester ID to caller and 34 * registers scan event call back handler 35 * @psoc: psoc object 36 * @module_name:name of requester module 37 * @event_cb: event callback function pointer 38 * @arg: argument to @event_cb 39 * 40 * API, allows other components to allocate requester id 41 * Normally used by modules at init time to register their callback 42 * and get one requester id. @event_cb will be invoked for 43 * all scan events whose requester id matches with @requester. 44 * 45 * Return: assigned non zero requester id for success 46 * zero (0) for failure 47 */ 48 wlan_scan_requester 49 ucfg_scan_register_requester(struct wlan_objmgr_psoc *psoc, 50 uint8_t *module_name, scan_event_handler event_cb, void *arg); 51 52 /** 53 * ucfg_scan_unregister_requester() -reclaims previously allocated requester ID 54 * @psoc: psoc object 55 * @requester: requester ID to reclaim. 56 * 57 * API, reclaims previously allocated requester id by 58 * ucfg_scan_get_req_id_reg_cb() 59 * 60 * Return: void 61 */ 62 void ucfg_scan_unregister_requester(struct wlan_objmgr_psoc *psoc, 63 wlan_scan_requester requester); 64 65 66 /** 67 * ucfg_get_scan_requester_name()- returns module name of requester ID owner 68 * @psoc: psoc object 69 * @requester: requester ID 70 * 71 * API, returns module name of requester id owner 72 * 73 * Return: pointer to module name or "unknown" if requester id not found. 74 */ 75 uint8_t *ucfg_get_scan_requester_name(struct wlan_objmgr_psoc *psoc, 76 wlan_scan_requester requester); 77 78 79 80 /** 81 * ucfg_scan_get_scan_id() - allocates scan ID 82 * @psoc: psoc object 83 * 84 * API, allocates a new scan id for caller 85 * 86 * Return: newly allocated scan ID 87 */ 88 wlan_scan_id 89 ucfg_scan_get_scan_id(struct wlan_objmgr_psoc *psoc); 90 91 #ifdef FEATURE_WLAN_SCAN_PNO 92 /** 93 * ucfg_scan_pno_start() - Public API to start PNO 94 * @vdev: vdev pointer 95 * @req: pno req params 96 * 97 * Return: 0 for success or error code. 98 */ 99 QDF_STATUS ucfg_scan_pno_start(struct wlan_objmgr_vdev *vdev, 100 struct pno_scan_req_params *req); 101 102 /** 103 * ucfg_scan_pno_stop() - Public API to stop PNO 104 * @vdev: vdev pointer 105 * @req: pno req params 106 * 107 * Return: 0 for success or error code. 108 */ 109 QDF_STATUS ucfg_scan_pno_stop(struct wlan_objmgr_vdev *vdev); 110 111 /** 112 * ucfg_scan_get_pno_in_progress() - Public API to check if pno is in progress 113 * @vdev: vdev pointer 114 * 115 * Return: true if pno in progress else false. 116 */ 117 bool ucfg_scan_get_pno_in_progress(struct wlan_objmgr_vdev *vdev); 118 119 /** 120 * ucfg_scan_get_pno_match() - Public API to check if pno matched 121 * @vdev: vdev pointer 122 * 123 * Return: true if pno matched else false. 124 */ 125 bool ucfg_scan_get_pno_match(struct wlan_objmgr_vdev *vdev); 126 127 /** 128 * ucfg_scan_register_pno_cb() - register pno cb 129 * @psoc: psoc object 130 * @event_cb: callback function pointer 131 * @arg: argument to @event_cb 132 * 133 * Return: QDF_STATUS 134 */ 135 QDF_STATUS 136 ucfg_scan_register_pno_cb(struct wlan_objmgr_psoc *psoc, 137 scan_event_handler event_cb, void *arg); 138 139 /** 140 * ucfg_scan_get_pno_def_params() - get the defaults pno params 141 * @vdev: vdev object 142 * @req: pno request object 143 * 144 * Return: QDF_STATUS_SUCCESS or error code 145 */ 146 QDF_STATUS 147 ucfg_scan_get_pno_def_params(struct wlan_objmgr_vdev *vdev, 148 struct pno_scan_req_params *req); 149 150 #else 151 152 static inline bool 153 ucfg_scan_get_pno_in_progress(struct wlan_objmgr_vdev *vdev) 154 { 155 return false; 156 } 157 158 static inline bool 159 ucfg_scan_get_pno_match(struct wlan_objmgr_vdev *vdev) 160 { 161 return false; 162 } 163 #endif /* FEATURE_WLAN_SCAN_PNO */ 164 /** 165 * ucfg_scan_start() - Public API to start a scan 166 * @req: start scan req params 167 * 168 * The Public API to start a scan. Post a msg to target_if queue 169 * 170 * Return: 0 for success or error code. 171 */ 172 QDF_STATUS 173 ucfg_scan_start(struct scan_start_request *req); 174 175 /** 176 * ucfg_scan_set_enable() - Public API to disable/enable scans 177 * @psoc: psoc on which scans need to be disabled 178 * @enable: enable scan if true disable is false 179 * 180 * Return: QDF_STATUS. 181 */ 182 QDF_STATUS ucfg_scan_set_enable(struct wlan_objmgr_psoc *psoc, bool enable); 183 184 /** 185 * ucfg_scan_get_enable() - Public API to get if scan is enabled or disabled 186 * @psoc: psoc on which scans status need to be checked 187 * 188 * Return: true if enabled else false. 189 */ 190 bool ucfg_scan_get_enable(struct wlan_objmgr_psoc *psoc); 191 192 /** 193 * ucfg_scan_set_miracast() - Public API to disable/enable miracast flag 194 * @psoc: psoc pointer 195 * @enable: enable miracast if true disable is false 196 * 197 * Return: QDF_STATUS. 198 */ 199 QDF_STATUS ucfg_scan_set_miracast( 200 struct wlan_objmgr_psoc *psoc, bool enable); 201 202 /** 203 * ucfg_scan_set_global_config() - Public API to set global scan config 204 * @psoc: psoc context 205 * @config: config to set 206 * @val: new config value 207 * 208 * Return: QDF_STATUS. 209 */ 210 QDF_STATUS 211 ucfg_scan_set_global_config(struct wlan_objmgr_psoc *psoc, 212 enum scan_config config, uint32_t val); 213 214 /** 215 * ucfg_scan_get_global_config() - Public API to get global scan config 216 * @psoc: psoc context 217 * @config: config to set 218 * @val: uint32* to hold returned config value 219 * 220 * Return: QDF_STATUS. 221 */ 222 QDF_STATUS 223 ucfg_scan_get_global_config(struct wlan_objmgr_psoc *psoc, 224 enum scan_config config, uint32_t *val); 225 226 /** 227 * ucfg_scan_set_wide_band_scan() - Public API to disable/enable wide band scan 228 * @pdev: psoc on which scans need to be disabled 229 * @enable: enable wide band scan if @enable is true, disable otherwise 230 * 231 * Return: QDF_STATUS. 232 */ 233 QDF_STATUS ucfg_scan_set_wide_band_scan( 234 struct wlan_objmgr_pdev *pdev, bool enable); 235 236 /** 237 * ucfg_scan_get_wide_band_scan() - Public API to check if 238 * wide band scan is enabled or disabled 239 * @pdev: psoc on which scans status need to be checked 240 * 241 * Return: true if enabled else false. 242 */ 243 bool ucfg_scan_get_wide_band_scan(struct wlan_objmgr_pdev *pdev); 244 245 /** 246 * ucfg_scan_set_custom_scan_chan_list() - Public API to restrict scan 247 * to few pre configured channels 248 * @pdev: psoc on which scans need to be disabled 249 * @chan_list: list of channels to scan if set 250 * 251 * Return: QDF_STATUS. 252 */ 253 QDF_STATUS ucfg_scan_set_custom_scan_chan_list( 254 struct wlan_objmgr_pdev *pdev, struct chan_list *chan_list); 255 /** 256 * ucfg_scan_set_ssid_bssid_hidden_ssid_beacon() - API to configure 257 * ssid, bssid of hidden beacon 258 * @pdev: psoc on which ssid bssid need to configure 259 * @bssid: bssid of the hidden AP 260 * @ssid: desired ssid 261 * 262 * Return: QDF_STATUS. 263 */ 264 #ifdef WLAN_DFS_CHAN_HIDDEN_SSID 265 QDF_STATUS 266 ucfg_scan_config_hidden_ssid_for_bssid(struct wlan_objmgr_pdev *pdev, 267 uint8_t *bssid, 268 struct wlan_ssid *ssid); 269 #else 270 static inline QDF_STATUS 271 ucfg_scan_config_hidden_ssid_for_bssid(struct wlan_objmgr_pdev *pdev, 272 uint8_t *bssid, 273 struct wlan_ssid *ssid) 274 { 275 return QDF_STATUS_SUCCESS; 276 } 277 #endif /* WLAN_DFS_CHAN_HIDDEN_SSID */ 278 /** 279 * ucfg_scan_cancel() - Public API to stop a scan 280 * @req: stop scan request params 281 * 282 * The Public API to stop a scan. Post a msg to target_if queue 283 * 284 * Return: 0 for success or error code. 285 */ 286 QDF_STATUS 287 ucfg_scan_cancel(struct scan_cancel_request *req); 288 289 /** 290 * ucfg_scan_cancel_sync() - Public API to stop a scan and wait 291 * till all scan are completed 292 * @req: stop scan request params 293 * 294 * The Public API to stop a scan and wait 295 * till all scan are completed 296 * 297 * Return: 0 for success or error code. 298 */ 299 QDF_STATUS 300 ucfg_scan_cancel_sync(struct scan_cancel_request *req); 301 302 /** 303 * ucfg_scan_get_result() - The Public API to get scan results 304 * @pdev: pdev info 305 * @filter: Filters 306 * 307 * This function fetches scan result 308 * 309 * Return: scan list pointer 310 */ 311 qdf_list_t *ucfg_scan_get_result(struct wlan_objmgr_pdev *pdev, 312 struct scan_filter *filter); 313 314 /** 315 * ucfg_scan_purge_results() - purge the scan list 316 * @scan_list: scan list to be purged 317 * 318 * This function purge the temp scan list 319 * 320 * Return: QDF_STATUS 321 */ 322 QDF_STATUS ucfg_scan_purge_results(qdf_list_t *scan_list); 323 324 /** 325 * ucfg_scan_flush_results() - The Public API to flush scan result 326 * @pdev: pdev object 327 * @filter: filter to flush the scan entries 328 * 329 * The Public API to flush scan result. 330 * 331 * Return: 0 for success or error code. 332 */ 333 QDF_STATUS ucfg_scan_flush_results(struct wlan_objmgr_pdev *pdev, 334 struct scan_filter *filter); 335 336 /** 337 * ucfg_scan_filter_valid_channel() - The Public API to filter scan result 338 * based on valid channel list 339 * @pdev: pdev object 340 * @chan_list: valid channel list 341 * @num_chan: number of valid channels 342 * 343 * The Public API to to filter scan result 344 * based on valid channel list. 345 * 346 * Return: void. 347 */ 348 void ucfg_scan_filter_valid_channel(struct wlan_objmgr_pdev *pdev, 349 uint8_t *chan_list, uint32_t num_chan); 350 351 /** 352 * ucfg_scan_db_iterate() - function to iterate scan table 353 * @pdev: pdev object 354 * @func: iterator function pointer 355 * @arg: argument to be passed to func() 356 * 357 * API, this API iterates scan table and invokes func 358 * on each scan enetry by passing scan entry and arg. 359 * 360 * Return: QDF_STATUS 361 */ 362 QDF_STATUS 363 ucfg_scan_db_iterate(struct wlan_objmgr_pdev *pdev, 364 scan_iterator_func func, void *arg); 365 366 /** 367 * ucfg_scan_update_mlme_by_bssinfo() - The Public API to update mlme 368 * info in the scan entry 369 * @pdev: pdev object 370 * @bssid: bssid info to find the matching scan entry 371 * @mlme_info: mlme info to be updated. 372 * 373 * The Public API to update mlme info in the scan entry. 374 * Post a msg to target_if queue 375 * 376 * Return: 0 for success or error code. 377 */ 378 QDF_STATUS 379 ucfg_scan_update_mlme_by_bssinfo(struct wlan_objmgr_pdev *pdev, 380 struct bss_info *bss_info, 381 struct mlme_info *mlme_info); 382 383 /** 384 * ucfg_scan_register_event_handler() - The Public API to register 385 * an event cb handler 386 * @pdev: pdev object 387 * @event_cb: callback function to register 388 * @arg: component specific priv argument to @event_cb callback function 389 * 390 * The Public API to register a event cb handler. This cb is called whenever 391 * any scan event is received on @pdev. 392 * 393 * Return: 0 for success or error code. 394 */ 395 396 QDF_STATUS 397 ucfg_scan_register_event_handler(struct wlan_objmgr_pdev *pdev, 398 scan_event_handler event_cb, void *arg); 399 400 /** 401 * ucfg_scan_unregister_event_handler() - Public API to unregister 402 * event cb handler 403 * @pdev: pdev object 404 * @event_cb: callback function to unregister 405 * @arg: component specific priv argument to @event_cb callback function 406 * 407 * Unregister a event cb handler. cb and arg will be used to 408 * find the calback. 409 * 410 * Return: void 411 */ 412 413 void 414 ucfg_scan_unregister_event_handler(struct wlan_objmgr_pdev *pdev, 415 scan_event_handler event_cb, void *arg); 416 417 /** 418 * ucfg_scan_init_default_params() - get the defaults scan params 419 * @vdev: vdev object 420 * @req: scan request object 421 * 422 * get the defaults scan params 423 * 424 * Return: QDF_STATUS_SUCCESS or error code 425 */ 426 QDF_STATUS 427 ucfg_scan_init_default_params(struct wlan_objmgr_vdev *vdev, 428 struct scan_start_request *req); 429 430 /** 431 * ucfg_scan_init_ssid_params() - initialize scan request ssid list 432 * 433 * @scan_req: scan request object 434 * @num_ssid: number of ssid's in ssid list 435 * @ssid_list: ssid list 436 * 437 * Return: QDF_STATUS_SUCCESS for success or error code 438 */ 439 QDF_STATUS 440 ucfg_scan_init_ssid_params(struct scan_start_request *scan_req, 441 uint32_t num_ssid, struct wlan_ssid *ssid_list); 442 443 /** 444 * ucfg_scan_init_bssid_params() - initialize scan request bssid list 445 * @scan_req: scan request object 446 * @num_ssid: number of bssid's in bssid list 447 * @bssid_list: bssid list 448 * 449 * Return: QDF_STATUS_SUCCESS for success or error code 450 */ 451 QDF_STATUS 452 ucfg_scan_init_bssid_params(struct scan_start_request *scan_req, 453 uint32_t num_ssid, struct qdf_mac_addr *bssid_list); 454 455 /** 456 * ucfg_scan_init_chanlist_params() - initialize scan request channel list 457 * @scan_req: scan request object 458 * @num_chans: number of channels in channel list 459 * @chan_list: channel list 460 * @phymode: phymode in which scan shall be done 461 * 462 * Return: QDF_STATUS_SUCCESS for success or error code 463 */ 464 QDF_STATUS 465 ucfg_scan_init_chanlist_params(struct scan_start_request *scan_req, 466 uint32_t num_chans, uint32_t *chan_list, uint32_t *phymode); 467 468 /** 469 * ucfg_scan_get_vdev_status() - API to check vdev scan status 470 * @vdev: vdev object 471 * 472 * Return: enum scm_scan_status 473 */ 474 enum scm_scan_status 475 ucfg_scan_get_vdev_status(struct wlan_objmgr_vdev *vdev); 476 477 /** 478 * ucfg_scan_get_pdev_status() - API to check pdev scan status 479 * @pdev: vdev object 480 * 481 * Return: enum scm_scan_status 482 */ 483 enum scm_scan_status 484 ucfg_scan_get_pdev_status(struct wlan_objmgr_pdev *pdev); 485 486 /** 487 * ucfg_scan_register_bcn_cb() - API to register api 488 * to inform/update bcn/probe as soon as they are received 489 * @pdev: psoc 490 * @cb: callback to be registered 491 * @type: Type of callback to be registered 492 * 493 * Return: enum scm_scan_status 494 */ 495 QDF_STATUS ucfg_scan_register_bcn_cb(struct wlan_objmgr_psoc *psoc, 496 update_beacon_cb cb, enum scan_cb_type type); 497 498 /* 499 * ucfg_scan_update_user_config() - Update scan cache user config 500 * @psoc: psoc 501 * @scan_cfg: scan user config 502 * 503 * Return: QDF_STATUS 504 */ 505 QDF_STATUS ucfg_scan_update_user_config(struct wlan_objmgr_psoc *psoc, 506 struct scan_user_cfg *scan_cfg); 507 508 /** 509 * ucfg_scan_update_roam_params() - Store/Update the roam params 510 * @psoc: psoc 511 * @roam_params: roam params 512 * 513 * Return: QDF_STATUS 514 */ 515 QDF_STATUS ucfg_scan_update_roam_params(struct wlan_objmgr_psoc *psoc, 516 struct roam_filter_params *roam_params); 517 518 /* 519 * ucfg_scan_init() - Scan module initialization API 520 * 521 * Return: QDF_STATUS 522 */ 523 QDF_STATUS ucfg_scan_init(void); 524 525 /** 526 * ucfg_scan_deinit() - Scan module deinitialization API 527 * 528 * Return: QDF_STATUS 529 */ 530 QDF_STATUS ucfg_scan_deinit(void); 531 532 /** 533 * ucfg_scan_psoc_enable() - Scan module enable API 534 * @psoc: psoc object 535 * 536 * Return: QDF_STATUS 537 */ 538 QDF_STATUS ucfg_scan_psoc_enable(struct wlan_objmgr_psoc *psoc); 539 540 /** 541 * ucfg_scan_psoc_enable() - Scan module disable API 542 * @psoc: psoc object 543 * 544 * Return: QDF_STATUS 545 */ 546 QDF_STATUS ucfg_scan_psoc_disable(struct wlan_objmgr_psoc *psoc); 547 548 /** 549 * ucfg_scan_psoc_open() - Scan module psoc open API 550 * @psoc: psoc object 551 * 552 * Return: QDF_STATUS 553 */ 554 QDF_STATUS ucfg_scan_psoc_open(struct wlan_objmgr_psoc *psoc); 555 556 /** 557 * ucfg_scan_psoc_close() - Scan module psoc close API 558 * @psoc: psoc object 559 * 560 * Return: QDF_STATUS 561 */ 562 QDF_STATUS ucfg_scan_psoc_close(struct wlan_objmgr_psoc *psoc); 563 564 /** 565 * ucfg_scan_get_max_active_scans() - API to get max active scans 566 * supported on this psoc 567 * @psoc: psoc object 568 * 569 * Return: uint32_t 570 */ 571 uint32_t ucfg_scan_get_max_active_scans(struct wlan_objmgr_psoc *psoc); 572 573 /** 574 * ucfg_ie_whitelist_enabled() - Checks for IE whitelisting enable 575 * @psoc: pointer to psoc object 576 * @vdev: pointer to vdev 577 * 578 * This function is used to check whether IE whitelisting is enabled or not 579 * 580 * Return: If enabled returns true else returns false 581 */ 582 bool ucfg_ie_whitelist_enabled(struct wlan_objmgr_psoc *psoc, 583 struct wlan_objmgr_vdev *vdev); 584 585 /** 586 * ucfg_copy_ie_whitelist_attrs() - Populate probe req IE whitelist attrs 587 * @psoc: pointer to psoc object 588 * @ie_whitelist: output parameter to hold ie whitelist attrs 589 * 590 * If IE whitelisting is enabled then invoke this function to copy 591 * IE whitelisting attrs from wlan scan object 592 * 593 * Return: true - successful copy 594 * false - copy failed 595 */ 596 bool ucfg_copy_ie_whitelist_attrs(struct wlan_objmgr_psoc *psoc, 597 struct probe_req_whitelist_attr *ie_whitelist); 598 599 /** 600 * ucfg_scan_set_bt_activity() - API to set bt activity 601 * @psoc: pointer to psoc object 602 * @bt_a2dp_active: bt activiy value 603 * 604 * Return: None 605 */ 606 void ucfg_scan_set_bt_activity(struct wlan_objmgr_psoc *psoc, 607 bool bt_a2dp_active); 608 /** 609 * ucfg_scan_get_bt_activity() - API to get bt activity 610 * @psoc: pointer to psoc object 611 * 612 * Return: true if enabled else false. 613 */ 614 bool ucfg_scan_get_bt_activity(struct wlan_objmgr_psoc *psoc); 615 616 /** 617 * ucfg_scan_set_vdev_del_in_progress() - API to mark vdev delete in progress 618 * @vdev: pointer to vdev object 619 * 620 * Return: none 621 */ 622 void ucfg_scan_set_vdev_del_in_progress(struct wlan_objmgr_vdev *vdev); 623 /** 624 * ucfg_scan_clear_vdev_del_in_progress() - API to reset vdev delete in progress 625 * @vdev: pointer to vdev object 626 * 627 * Return: none 628 */ 629 void ucfg_scan_clear_vdev_del_in_progress(struct wlan_objmgr_vdev *vdev); 630 631 /** 632 * wlan_scan_cfg_set_active_dwelltime() - API to set scan active dwelltime 633 * @psoc: pointer to psoc object 634 * @dwell_time: scan active dwell time 635 * 636 * Return: none 637 */ 638 void wlan_scan_cfg_set_active_dwelltime(struct wlan_objmgr_psoc *psoc, 639 uint32_t dwell_time); 640 /** 641 * wlan_scan_cfg_get_active_dwelltime() - API to get active dwelltime 642 * @psoc: pointer to psoc object 643 * @dwell_time: scan active dwelltime 644 * 645 * Return: scan active dwell time 646 */ 647 void wlan_scan_cfg_get_active_dwelltime(struct wlan_objmgr_psoc *psoc, 648 uint32_t *dwell_time); 649 650 /** 651 * wlan_scan_cfg_set_passive_dwelltime() - API to set scan active dwelltime 652 * @psoc: pointer to psoc object 653 * @dwell_time: scan active dwell time 654 * 655 * Return: none 656 */ 657 void wlan_scan_cfg_set_passive_dwelltime(struct wlan_objmgr_psoc *psoc, 658 uint32_t dwell_time); 659 /** 660 * wlan_scan_cfg_get_passive_dwelltime() - API to get active dwelltime 661 * @psoc: pointer to psoc object 662 * @dwell_time: scan active dwelltime 663 * 664 * Return: scan active dwell time 665 */ 666 void wlan_scan_cfg_get_passive_dwelltime(struct wlan_objmgr_psoc *psoc, 667 uint32_t *dwell_time); 668 669 #endif 670