libeap/wpa_supplicant/bss.h

   1 /*
   2  * BSS table
   3  * Copyright (c) 2009-2015, 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 BSS_H
  10 #define BSS_H
  11
  12 struct wpa_scan_res;
  13
  14 #define WPA_BSS_QUAL_INVALID            BIT(0)
  15 #define WPA_BSS_NOISE_INVALID           BIT(1)
  16 #define WPA_BSS_LEVEL_INVALID           BIT(2)
  17 #define WPA_BSS_LEVEL_DBM               BIT(3)
  18 #define WPA_BSS_AUTHENTICATED           BIT(4)
  19 #define WPA_BSS_ASSOCIATED              BIT(5)
  20 #define WPA_BSS_ANQP_FETCH_TRIED        BIT(6)
  21
  22 /**
  23  * struct wpa_bss_anqp - ANQP data for a BSS entry (struct wpa_bss)
  24  */
  25 struct wpa_bss_anqp {
  26         /** Number of BSS entries referring to this ANQP data instance */
  27         unsigned int users;
  28 #ifdef CONFIG_INTERWORKING
  29         struct wpabuf *capability_list;
  30         struct wpabuf *venue_name;
  31         struct wpabuf *network_auth_type;
  32         struct wpabuf *roaming_consortium;
  33         struct wpabuf *ip_addr_type_availability;
  34         struct wpabuf *nai_realm;
  35         struct wpabuf *anqp_3gpp;
  36         struct wpabuf *domain_name;
  37 #endif /* CONFIG_INTERWORKING */
  38 #ifdef CONFIG_HS20
  39         struct wpabuf *hs20_capability_list;
  40         struct wpabuf *hs20_operator_friendly_name;
  41         struct wpabuf *hs20_wan_metrics;
  42         struct wpabuf *hs20_connection_capability;
  43         struct wpabuf *hs20_operating_class;
  44         struct wpabuf *hs20_osu_providers_list;
  45 #endif /* CONFIG_HS20 */
  46 };
  47
  48 /**
  49  * struct wpa_bss - BSS table
  50  *
  51  * This structure is used to store information about neighboring BSSes in
  52  * generic format. It is mainly updated based on scan results from the driver.
  53  */
  54 struct wpa_bss {
  55         /** List entry for struct wpa_supplicant::bss */
  56         struct dl_list list;
  57         /** List entry for struct wpa_supplicant::bss_id */
  58         struct dl_list list_id;
  59         /** Unique identifier for this BSS entry */
  60         unsigned int id;
  61         /** Number of counts without seeing this BSS */
  62         unsigned int scan_miss_count;
  63         /** Index of the last scan update */
  64         unsigned int last_update_idx;
  65         /** Information flags about the BSS/IBSS (WPA_BSS_*) */
  66         unsigned int flags;
  67         /** BSSID */
  68         u8 bssid[ETH_ALEN];
  69         /** HESSID */
  70         u8 hessid[ETH_ALEN];
  71         /** SSID */
  72         u8 ssid[SSID_MAX_LEN];
  73         /** Length of SSID */
  74         size_t ssid_len;
  75         /** Frequency of the channel in MHz (e.g., 2412 = channel 1) */
  76         int freq;
  77         /** Beacon interval in TUs (host byte order) */
  78         u16 beacon_int;
  79         /** Capability information field in host byte order */
  80         u16 caps;
  81         /** Signal quality */
  82         int qual;
  83         /** Noise level */
  84         int noise;
  85         /** Signal level */
  86         int level;
  87         /** Timestamp of last Beacon/Probe Response frame */
  88         u64 tsf;
  89         /** Time of the last update (i.e., Beacon or Probe Response RX) */
  90         struct os_reltime last_update;
  91         /** Estimated throughput in kbps */
  92         unsigned int est_throughput;
  93         /** Signal-to-noise ratio in dB */
  94         int snr;
  95         /** ANQP data */
  96         struct wpa_bss_anqp *anqp;
  97         /** Length of the following IE field in octets (from Probe Response) */
  98         size_t ie_len;
  99         /** Length of the following Beacon IE field in octets */
 100         size_t beacon_ie_len;
 101         /* followed by ie_len octets of IEs */
 102         /* followed by beacon_ie_len octets of IEs */
 103 };
 104
 105 void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
 106 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
 107                              struct wpa_scan_res *res,
 108                              struct os_reltime *fetch_time);
 109 void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
 110                         int new_scan);
 111 int wpa_bss_init(struct wpa_supplicant *wpa_s);
 112 void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
 113 void wpa_bss_flush(struct wpa_supplicant *wpa_s);
 114 void wpa_bss_flush_by_age(struct wpa_supplicant *wpa_s, int age);
 115 struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
 116                              const u8 *ssid, size_t ssid_len);
 117 struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
 118                                    const u8 *bssid);
 119 struct wpa_bss * wpa_bss_get_bssid_latest(struct wpa_supplicant *wpa_s,
 120                                           const u8 *bssid);
 121 struct wpa_bss * wpa_bss_get_p2p_dev_addr(struct wpa_supplicant *wpa_s,
 122                                           const u8 *dev_addr);
 123 struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id);
 124 struct wpa_bss * wpa_bss_get_id_range(struct wpa_supplicant *wpa_s,
 125                                       unsigned int idf, unsigned int idl);
 126 const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie);
 127 const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type);
 128 const u8 * wpa_bss_get_vendor_ie_beacon(const struct wpa_bss *bss,
 129                                         u32 vendor_type);
 130 struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
 131                                             u32 vendor_type);
 132 struct wpabuf * wpa_bss_get_vendor_ie_multi_beacon(const struct wpa_bss *bss,
 133                                                    u32 vendor_type);
 134 int wpa_bss_get_max_rate(const struct wpa_bss *bss);
 135 int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates);
 136 struct wpa_bss_anqp * wpa_bss_anqp_alloc(void);
 137 int wpa_bss_anqp_unshare_alloc(struct wpa_bss *bss);
 138
 139 static inline int bss_is_dmg(const struct wpa_bss *bss)
 140 {
 141         return bss->freq > 45000;
 142 }
 143
 144 static inline void wpa_bss_update_level(struct wpa_bss *bss, int new_level)
 145 {
 146         if (bss != NULL && new_level < 0)
 147                 bss->level = new_level;
 148 }
 149
 150 #endif /* BSS_H */