1 /*
2  * WPA Supplicant - Scanning
3  * Copyright (c) 2003-2014, Jouni Malinen <j@w1.fi>
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  */
8 
9 #ifndef SCAN_H
10 #define SCAN_H
11 
12 /*
13  * Noise floor values to use when we have signal strength
14  * measurements, but no noise floor measurements. These values were
15  * measured in an office environment with many APs.
16  */
17 #define DEFAULT_NOISE_FLOOR_2GHZ (-89)
18 #define DEFAULT_NOISE_FLOOR_5GHZ (-92)
19 #define DEFAULT_NOISE_FLOOR_6GHZ (-92)
20 
21 #ifdef CONFIG_NW_SEL_RELIABILITY
22 /*
23  * This basically disables capping the SNR when choosing the best BSS. This
24  * means that the BSS with the highest SNR will be chosen, independent of the
25  * band. This is useful for scenarios where reliability is more important than
26  * throughput.
27  */
28 #define GREAT_SNR 999
29 #else
30 /*
31  * Channels with a great SNR can operate at full rate. What is a great SNR?
32  * This doc https://supportforums.cisco.com/docs/DOC-12954 says, "the general
33  * rule of thumb is that any SNR above 20 is good." This one
34  * http://www.cisco.com/en/US/tech/tk722/tk809/technologies_q_and_a_item09186a00805e9a96.shtml#qa23
35  * recommends 25 as a minimum SNR for 54 Mbps data rate. The estimates used in
36  * scan_est_throughput() allow even smaller SNR values for the maximum rates
37  * (21 for 54 Mbps, 22 for VHT80 MCS9, 24 for HT40 and HT20 MCS7). Use 25 as a
38  * somewhat conservative value here.
39  */
40 #define GREAT_SNR 25
41 #endif /* CONFIG_NW_SEL_RELIABILITY */
42 
43 #define IS_2P4GHZ(n) (n >= 2412 && n <= 2484)
44 #define IS_5GHZ(n) (n > 4000 && n < 5895)
45 
46 int wpa_supplicant_enabled_networks(struct wpa_supplicant *wpa_s);
47 void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec);
48 int wpa_supplicant_delayed_sched_scan(struct wpa_supplicant *wpa_s,
49 				      int sec, int usec);
50 int wpa_supplicant_req_sched_scan(struct wpa_supplicant *wpa_s);
51 void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s);
52 void wpa_supplicant_cancel_delayed_sched_scan(struct wpa_supplicant *wpa_s);
53 void wpa_supplicant_cancel_sched_scan(struct wpa_supplicant *wpa_s);
54 void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
55 				    int scanning);
56 struct wpa_driver_scan_params;
57 int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
58 				struct wpa_driver_scan_params *params);
59 struct wpa_scan_results *
60 wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s,
61 				struct scan_info *info, int new_scan);
62 int wpa_supplicant_update_scan_results(struct wpa_supplicant *wpa_s);
63 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
64 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
65 				  u32 vendor_type);
66 const u8 * wpa_scan_get_vendor_ie_beacon(const struct wpa_scan_res *res,
67 					 u32 vendor_type);
68 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
69 					     u32 vendor_type);
70 int wpa_supplicant_filter_bssid_match(struct wpa_supplicant *wpa_s,
71 				      const u8 *bssid);
72 void wpa_supplicant_update_scan_int(struct wpa_supplicant *wpa_s, int sec);
73 void scan_only_handler(struct wpa_supplicant *wpa_s,
74 		       struct wpa_scan_results *scan_res);
75 int wpas_scan_scheduled(struct wpa_supplicant *wpa_s);
76 struct wpa_driver_scan_params *
77 wpa_scan_clone_params(const struct wpa_driver_scan_params *src);
78 void wpa_scan_free_params(struct wpa_driver_scan_params *params);
79 int wpas_start_pno(struct wpa_supplicant *wpa_s);
80 int wpas_stop_pno(struct wpa_supplicant *wpa_s);
81 void wpas_scan_reset_sched_scan(struct wpa_supplicant *wpa_s);
82 void wpas_scan_restart_sched_scan(struct wpa_supplicant *wpa_s);
83 
84 void wpas_mac_addr_rand_scan_clear(struct wpa_supplicant *wpa_s,
85 				   unsigned int type);
86 int wpas_mac_addr_rand_scan_set(struct wpa_supplicant *wpa_s,
87 				unsigned int type, const u8 *addr,
88 				const u8 *mask);
89 int wpas_mac_addr_rand_scan_get_mask(struct wpa_supplicant *wpa_s,
90 				     unsigned int type, u8 *mask);
91 int wpas_abort_ongoing_scan(struct wpa_supplicant *wpa_s);
92 void filter_scan_res(struct wpa_supplicant *wpa_s,
93 		     struct wpa_scan_results *res);
94 void scan_snr(struct wpa_scan_res *res);
95 void scan_est_throughput(struct wpa_supplicant *wpa_s,
96 			 struct wpa_scan_res *res);
97 unsigned int wpas_get_est_tpt(const struct wpa_supplicant *wpa_s,
98 			      const u8 *ies, size_t ies_len, int rate,
99 			      int snr, int freq);
100 void wpa_supplicant_set_default_scan_ies(struct wpa_supplicant *wpa_s);
101 int wpa_add_scan_freqs_list(struct wpa_supplicant *wpa_s,
102 			    enum hostapd_hw_mode band,
103 			    struct wpa_driver_scan_params *params,
104 			    bool is_6ghz);
105 
106 #endif /* SCAN_H */
107