Home | History | Annotate | Line # | Download | only in wpa_supplicant 
      1 /*
      2  * WPA Supplicant - Scanning
      3  * Copyright (c) 2003-2014, Jouni Malinen <j (at) 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 /*
     34  * IEEE Sts 802.11ax-2021, 9.4.2.161 (Transmit Power Envelope element) indicates
     35  * no max TX power limit if Maximum Transmit Power field is 63.5 dBm.
     36  * The default TX power if it is not constrained by Transmit Power Envelope
     37  * element.
     38  */
     39 #define TX_POWER_NO_CONSTRAINT 64
     40 
     41 int wpa_supplicant_enabled_networks(struct wpa_supplicant *wpa_s);
     42 void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec);
     43 int wpa_supplicant_delayed_sched_scan(struct wpa_supplicant *wpa_s,
     44 				      int sec, int usec);
     45 int wpa_supplicant_req_sched_scan(struct wpa_supplicant *wpa_s);
     46 void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s);
     47 void wpa_supplicant_cancel_delayed_sched_scan(struct wpa_supplicant *wpa_s);
     48 void wpa_supplicant_cancel_sched_scan(struct wpa_supplicant *wpa_s);
     49 void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
     50 				    int scanning);
     51 struct wpa_driver_scan_params;
     52 int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
     53 				struct wpa_driver_scan_params *params,
     54 				bool default_ies, bool next);
     55 struct wpa_scan_results *
     56 wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s,
     57 				struct scan_info *info, int new_scan,
     58 				const u8 *bssid);
     59 int wpa_supplicant_update_scan_results(struct wpa_supplicant *wpa_s,
     60 				       const u8 *bssid);
     61 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
     62 const u8 * wpa_scan_get_ml_ie(const struct wpa_scan_res *res, u8 type);
     63 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
     64 				  u32 vendor_type);
     65 const u8 * wpa_scan_get_vendor_ie_beacon(const struct wpa_scan_res *res,
     66 					 u32 vendor_type);
     67 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
     68 					     u32 vendor_type);
     69 int wpa_supplicant_filter_bssid_match(struct wpa_supplicant *wpa_s,
     70 				      const u8 *bssid);
     71 void wpa_supplicant_update_scan_int(struct wpa_supplicant *wpa_s, int sec);
     72 void scan_only_handler(struct wpa_supplicant *wpa_s,
     73 		       struct wpa_scan_results *scan_res);
     74 int wpas_scan_scheduled(struct wpa_supplicant *wpa_s);
     75 struct wpa_driver_scan_params *
     76 wpa_scan_clone_params(const struct wpa_driver_scan_params *src);
     77 void wpa_scan_free_params(struct wpa_driver_scan_params *params);
     78 int wpas_start_pno(struct wpa_supplicant *wpa_s);
     79 int wpas_stop_pno(struct wpa_supplicant *wpa_s);
     80 void wpas_scan_reset_sched_scan(struct wpa_supplicant *wpa_s);
     81 void wpas_scan_restart_sched_scan(struct wpa_supplicant *wpa_s);
     82 
     83 void wpas_mac_addr_rand_scan_clear(struct wpa_supplicant *wpa_s,
     84 				   unsigned int type);
     85 int wpas_mac_addr_rand_scan_set(struct wpa_supplicant *wpa_s,
     86 				unsigned int type, const u8 *addr,
     87 				const u8 *mask);
     88 int wpas_mac_addr_rand_scan_get_mask(struct wpa_supplicant *wpa_s,
     89 				     unsigned int type, u8 *mask);
     90 int wpas_abort_ongoing_scan(struct wpa_supplicant *wpa_s);
     91 void scan_snr(struct wpa_scan_res *res);
     92 void scan_est_throughput(struct wpa_supplicant *wpa_s,
     93 			 struct wpa_scan_res *res);
     94 unsigned int wpas_get_est_tpt(const struct wpa_supplicant *wpa_s,
     95 			      const u8 *ies, size_t ies_len, int rate,
     96 			      int snr, int freq, enum chan_width *max_cw);
     97 void wpa_supplicant_set_default_scan_ies(struct wpa_supplicant *wpa_s);
     98 int wpa_add_scan_freqs_list(struct wpa_supplicant *wpa_s,
     99 			    enum hostapd_hw_mode band,
    100 			    struct wpa_driver_scan_params *params,
    101 			    bool is_6ghz, bool only_6ghz_psc,
    102 			    bool exclude_radar);
    103 int wpas_channel_width_rssi_bump(const u8 *ies, size_t ies_len,
    104 				 enum chan_width cw);
    105 int wpas_adjust_snr_by_chanwidth(const u8 *ies, size_t ies_len,
    106 				 enum chan_width max_cw, int snr);
    107 
    108 #endif /* SCAN_H */
    109