xref: /freebsd/contrib/wpa/wpa_supplicant/scan.h (revision 81ad6265)
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 /*
22  * Channels with a great SNR can operate at full rate. What is a great SNR?
23  * This doc https://supportforums.cisco.com/docs/DOC-12954 says, "the general
24  * rule of thumb is that any SNR above 20 is good." This one
25  * http://www.cisco.com/en/US/tech/tk722/tk809/technologies_q_and_a_item09186a00805e9a96.shtml#qa23
26  * recommends 25 as a minimum SNR for 54 Mbps data rate. The estimates used in
27  * scan_est_throughput() allow even smaller SNR values for the maximum rates
28  * (21 for 54 Mbps, 22 for VHT80 MCS9, 24 for HT40 and HT20 MCS7). Use 25 as a
29  * somewhat conservative value here.
30  */
31 #define GREAT_SNR 25
32 
33 #define IS_2P4GHZ(n) (n >= 2412 && n <= 2484)
34 #define IS_5GHZ(n) (n > 4000 && n < 5895)
35 
36 int wpa_supplicant_enabled_networks(struct wpa_supplicant *wpa_s);
37 void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec);
38 int wpa_supplicant_delayed_sched_scan(struct wpa_supplicant *wpa_s,
39 				      int sec, int usec);
40 int wpa_supplicant_req_sched_scan(struct wpa_supplicant *wpa_s);
41 void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s);
42 void wpa_supplicant_cancel_delayed_sched_scan(struct wpa_supplicant *wpa_s);
43 void wpa_supplicant_cancel_sched_scan(struct wpa_supplicant *wpa_s);
44 void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
45 				    int scanning);
46 struct wpa_driver_scan_params;
47 int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
48 				struct wpa_driver_scan_params *params);
49 struct wpa_scan_results *
50 wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s,
51 				struct scan_info *info, int new_scan);
52 int wpa_supplicant_update_scan_results(struct wpa_supplicant *wpa_s);
53 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
54 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
55 				  u32 vendor_type);
56 const u8 * wpa_scan_get_vendor_ie_beacon(const struct wpa_scan_res *res,
57 					 u32 vendor_type);
58 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
59 					     u32 vendor_type);
60 int wpa_supplicant_filter_bssid_match(struct wpa_supplicant *wpa_s,
61 				      const u8 *bssid);
62 void wpa_supplicant_update_scan_int(struct wpa_supplicant *wpa_s, int sec);
63 void scan_only_handler(struct wpa_supplicant *wpa_s,
64 		       struct wpa_scan_results *scan_res);
65 int wpas_scan_scheduled(struct wpa_supplicant *wpa_s);
66 struct wpa_driver_scan_params *
67 wpa_scan_clone_params(const struct wpa_driver_scan_params *src);
68 void wpa_scan_free_params(struct wpa_driver_scan_params *params);
69 int wpas_start_pno(struct wpa_supplicant *wpa_s);
70 int wpas_stop_pno(struct wpa_supplicant *wpa_s);
71 void wpas_scan_reset_sched_scan(struct wpa_supplicant *wpa_s);
72 void wpas_scan_restart_sched_scan(struct wpa_supplicant *wpa_s);
73 
74 void wpas_mac_addr_rand_scan_clear(struct wpa_supplicant *wpa_s,
75 				   unsigned int type);
76 int wpas_mac_addr_rand_scan_set(struct wpa_supplicant *wpa_s,
77 				unsigned int type, const u8 *addr,
78 				const u8 *mask);
79 int wpas_mac_addr_rand_scan_get_mask(struct wpa_supplicant *wpa_s,
80 				     unsigned int type, u8 *mask);
81 int wpas_abort_ongoing_scan(struct wpa_supplicant *wpa_s);
82 void filter_scan_res(struct wpa_supplicant *wpa_s,
83 		     struct wpa_scan_results *res);
84 void scan_snr(struct wpa_scan_res *res);
85 void scan_est_throughput(struct wpa_supplicant *wpa_s,
86 			 struct wpa_scan_res *res);
87 unsigned int wpas_get_est_tpt(const struct wpa_supplicant *wpa_s,
88 			      const u8 *ies, size_t ies_len, int rate,
89 			      int snr, int freq);
90 void wpa_supplicant_set_default_scan_ies(struct wpa_supplicant *wpa_s);
91 int wpa_add_scan_freqs_list(struct wpa_supplicant *wpa_s,
92 			    enum hostapd_hw_mode band,
93 			    struct wpa_driver_scan_params *params,
94 			    bool is_6ghz);
95 
96 #endif /* SCAN_H */
97